Package: github.com/yuin/goldmark-emoji

package emoji Import Path github.com/yuin/goldmark-emoji (on go.dev) Dependency Relation imports 11 packages, and imported by one package Involved Source Files d➜ emoji.go package emoji is a extension for the goldmark(http://github.com/yuin/goldmark). Package-Level Type Names (total 14, in which 7 are exported) /* sort exporteds by: alphabet | popularity */ type Option (interface) Option interface sets options for this extension. Methods (only one, which is unexported) /* one unexported ... *//* one unexported: */ ( T) emojiOption() Implemented By (at least 6, in which 2 are exported) ParserOption (interface) RendererOption (interface) /* 4+ unexporteds ... *//* 4+ unexporteds: */ *withEmojis *withRendererFunc *withRenderingMethod *withTwemojiTemplate As Outputs Of (at least 4, all are exported) func WithEmojis(value definition.Emojis) Option func WithRendererFunc(f RendererFunc) Option func WithRenderingMethod(a RenderingMethod) Option func WithTwemojiTemplate(s string) Option As Inputs Of (at least one exported) func New(opts ...Option) goldmark.Extender type ParserConfig (struct) ParserConfig struct is a data structure that holds configuration of the Emoji extension. Fields (only one, which is exported) Emojis definition.Emojis Methods (only one, which is exported) (*T) SetOption(name parser.OptionName, value interface{}) SetOption implements parser.SetOptioner Implements (at least one exported) *T : github.com/yuin/goldmark/parser.SetOptioner As Inputs Of (at least one exported) func ParserOption.SetEmojiOption(*ParserConfig) type ParserOption (interface) A ParserOption interface sets options for the emoji parser. Methods (total 3, in which 2 are exported) ( T) SetEmojiOption(*ParserConfig) ( T) SetParserOption(*parser.Config) /* one unexported ... *//* one unexported: */ ( T) emojiOption() Implemented By (at least one unexported) /* at least one unexported ... *//* at least one unexported: */ *withEmojis Implements (at least 2, both are exported) T : Option T : github.com/yuin/goldmark/parser.Option As Inputs Of (at least one exported) func NewParser(opts ...ParserOption) parser.InlineParser type RendererConfig (struct) RendererConfig struct holds options for the emoji renderer. Fields (total 8, all are exported) Config html.Config Config.HardWraps bool Config.Unsafe bool Config.Writer html.Writer Config.XHTML bool Method RenderingMethod Method indicates how emojis are rendered. RendererFunc RendererFunc RendererFunc is a RendererFunc that renders emojis. This value is valid only when Method is set to Func. TwemojiTemplate string TwemojiTemplate is a printf template for twemoji. This value is valid only when Method is set to Twemoji. `printf` arguments are: 1: name (e.g. "face with tears of joy") 2: file name without an extension (e.g. 1f646-2642) 3: '/' if XHTML, otherwise '' Methods (only one, which is exported) (*T) SetOption(name renderer.OptionName, value interface{}) SetOption implements renderer.SetOptioner. Implements (at least one exported) *T : github.com/yuin/goldmark/renderer.SetOptioner As Inputs Of (at least one exported) func RendererOption.SetEmojiOption(*RendererConfig) type RendererFunc (func) RendererFunc will be used for rendering emojis. As Inputs Of (at least one exported) func WithRendererFunc(f RendererFunc) Option type RendererOption (interface) A RendererOption interface sets options for the emoji renderer. Methods (total 3, in which 2 are exported) ( T) SetConfig(*renderer.Config) ( T) SetEmojiOption(*RendererConfig) /* one unexported ... *//* one unexported: */ ( T) emojiOption() Implemented By (at least 3, none are exported) /* 3+ unexporteds ... *//* 3+ unexporteds: */ *withRendererFunc *withRenderingMethod *withTwemojiTemplate Implements (at least 2, both are exported) T : Option T : github.com/yuin/goldmark/renderer.Option As Inputs Of (at least one exported) func NewHTMLRenderer(opts ...RendererOption) renderer.NodeRenderer type RenderingMethod int (basic type) RenderingMethod indicates how emojis are rendered. As Inputs Of (at least one exported) func WithRenderingMethod(a RenderingMethod) Option As Types Of (total 4, all are exported) const Entity const Func const Twemoji const Unicode /* 7 unexporteds ... *//* 7 unexporteds: */ type emoji (struct) Fields (only one, which is unexported) /* one unexported ... *//* one unexported: */ options []Option Methods (only one, which is exported) (*T) Extend(m goldmark.Markdown) Extend implements goldmark.Extender. Implements (at least one exported) *T : github.com/yuin/goldmark.Extender As Types Of (only one, which is exported) var Emoji *emoji type emojiHTMLRenderer (struct) Fields (total 9, all are exported) RendererConfig RendererConfig RendererConfig.Config html.Config RendererConfig.Config.HardWraps bool RendererConfig.Config.Unsafe bool RendererConfig.Config.Writer html.Writer RendererConfig.Config.XHTML bool RendererConfig.Method RenderingMethod Method indicates how emojis are rendered. RendererConfig.RendererFunc RendererFunc RendererFunc is a RendererFunc that renders emojis. This value is valid only when Method is set to Func. RendererConfig.TwemojiTemplate string TwemojiTemplate is a printf template for twemoji. This value is valid only when Method is set to Twemoji. `printf` arguments are: 1: name (e.g. "face with tears of joy") 2: file name without an extension (e.g. 1f646-2642) 3: '/' if XHTML, otherwise '' Methods (total 3, in which 2 are exported) (*T) RegisterFuncs(reg renderer.NodeRendererFuncRegisterer) RegisterFuncs implements renderer.NodeRenderer.RegisterFuncs. (*T) SetOption(name renderer.OptionName, value interface{}) SetOption implements renderer.SetOptioner. /* one unexported ... *//* one unexported: */ (*T) renderEmoji(w util.BufWriter, source []byte, n ast.Node, entering bool) (ast.WalkStatus, error) Implements (at least 2, both are exported) *T : github.com/yuin/goldmark/renderer.NodeRenderer *T : github.com/yuin/goldmark/renderer.SetOptioner type emojiParser (struct) Fields (total 2, both are exported) ParserConfig ParserConfig ParserConfig.Emojis definition.Emojis Methods (total 3, all are exported) (*T) Parse(parent ast.Node, block text.Reader, pc parser.Context) ast.Node (*T) SetOption(name parser.OptionName, value interface{}) SetOption implements parser.SetOptioner (*T) Trigger() []byte Implements (at least 2, both are exported) *T : github.com/yuin/goldmark/parser.InlineParser *T : github.com/yuin/goldmark/parser.SetOptioner type withEmojis (struct) Fields (only one, which is unexported) /* one unexported ... *//* one unexported: */ value definition.Emojis Methods (total 3, in which 2 are exported) (*T) SetEmojiOption(c *ParserConfig) (*T) SetParserOption(c *parser.Config) /* one unexported ... *//* one unexported: */ (*T) emojiOption() Implements (at least 3, all are exported) *T : Option *T : ParserOption *T : github.com/yuin/goldmark/parser.Option type withRendererFunc (struct) Fields (only one, which is unexported) /* one unexported ... *//* one unexported: */ value RendererFunc Methods (total 3, in which 2 are exported) (*T) SetConfig(c *renderer.Config) SetConfig implements renderer.Option#SetConfig. (*T) SetEmojiOption(c *RendererConfig) SetEmojiOption implements RendererOption#SetEmojiOption /* one unexported ... *//* one unexported: */ (*T) emojiOption() Implements (at least 3, all are exported) *T : Option *T : RendererOption *T : github.com/yuin/goldmark/renderer.Option type withRenderingMethod (struct) Fields (only one, which is unexported) /* one unexported ... *//* one unexported: */ value RenderingMethod Methods (total 3, in which 2 are exported) (*T) SetConfig(c *renderer.Config) SetConfig implements renderer.Option#SetConfig. (*T) SetEmojiOption(c *RendererConfig) SetEmojiOption implements RendererOption#SetEmojiOption /* one unexported ... *//* one unexported: */ (*T) emojiOption() Implements (at least 3, all are exported) *T : Option *T : RendererOption *T : github.com/yuin/goldmark/renderer.Option type withTwemojiTemplate (struct) Fields (only one, which is unexported) /* one unexported ... *//* one unexported: */ value string Methods (total 3, in which 2 are exported) (*T) SetConfig(c *renderer.Config) SetConfig implements renderer.Option#SetConfig. (*T) SetEmojiOption(c *RendererConfig) SetEmojiOption implements RendererOption#SetEmojiOption /* one unexported ... *//* one unexported: */ (*T) emojiOption() Implements (at least 3, all are exported) *T : Option *T : RendererOption *T : github.com/yuin/goldmark/renderer.Option Package-Level Functions (total 7, all are exported) func New(opts ...Option) goldmark.Extender New returns a new extension with given options. func NewHTMLRenderer(opts ...RendererOption) renderer.NodeRenderer NewHTMLRenderer returns a new HTMLRenderer. func NewParser(opts ...ParserOption) parser.InlineParser NewParser returns a new parser.InlineParser that can parse emoji expressions. func WithEmojis(value definition.Emojis) Option WithMaping is a functional option that defines links names to unicode emojis. func WithRendererFunc(f RendererFunc) Option WithRendererFunc is a functional option that changes a renderer func. func WithRenderingMethod(a RenderingMethod) Option WithRenderingMethod is a functional option that indicates how emojis are rendered. func WithTwemojiTemplate(s string) Option WithTwemojiTemplate is a functional option that changes a twemoji img tag. Package-Level Variables (only one, which is exported) var Emoji *emoji Emoji is a goldmark.Extender implementation. Package-Level Constants (total 11, in which 5 are exported) const DefaultTwemojiTemplate = " DefaultTwemojiTemplate is a default value for RendererConfig.TwemojiTemplate. const Entity RenderingMethod = 0 Entity renders an emoji as an html entity. const Func RenderingMethod = 3 Func renders an emoji using RendererFunc. const Twemoji RenderingMethod = 2 Twemoji renders an emoji as an img tag with [twemoji](https://github.com/twitter/twemoji). const Unicode RenderingMethod = 1 Unicode renders an emoji as unicode character. /* 6 unexporteds ... *//* 6 unexporteds: */ const empty = "" const optEmojis parser.OptionName = "EmojiEmojis" const optRendererFunc renderer.OptionName = "EmojiRendererFunc" const optRenderingMethod renderer.OptionName = "EmojiRenderingMethod" const optTwemojiTemplate renderer.OptionName = "EmojiTwemojiTemplate" const slash = " /"

The pages are generated with Golds v0.3.2-preview. (GOOS=darwin GOARCH=amd64) Golds is a Go 101 project developed by Tapir Liu. PR and bug reports are welcome and can be submitted to the issue list. Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.