README
¶
Slugger
The slugger package provides a simple and efficient way to generate URL-friendly slugs from strings. Below are the main features and methods of the package:
Slugger Constructor
New(substitutions map[string]string, withEmoji bool) *Slugger:
Creates a newSluggerinstance.substitutions: A map of string replacements to apply before generating the slug.withEmoji: If true, emojis will be included in a slug-friendly format.
Slugger Methods
-
Slug(s, separator string) string:
Generates a slugified version of the input strings. Ifseparatoris provided, it will be used to separate words in the slug; otherwise, a default separator(-) is applied. -
AddSubstitution(key, value string):
Adds a new substitution pair to theSluggerinstance. This allows you to define custom replacements that will be applied when generating slugs. -
RemoveSubstitution(key string):
Removes a substitution pair from theSluggerinstance. This is useful for cleaning up or modifying existing substitutions. -
ReplaceSubstitution(key, newValue string):
Replaces an existing substitution value with a new value. This allows you to update the slug generation rules without having to recreate theSluggerinstance. -
SetSubstitutions(substitutions map[string]string):
Sets the entire map of substitutions for theSluggerinstance. This can be used to initialize or update multiple substitutions at once.
Notes
- If a
substitutionsmap is provided, it will replace all occurrences of the specified keys with their corresponding values. For example, given a substitution pair{"the": ""}and the input stringover there, the resulting slug will beover-re.
Examples:
For examples of each function, please check out EXAMPLES.md
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Slugger ¶
type Slugger struct {
Separator string // Default character(s) used to separate words in the slug if not explicitly provided
Substitutions map[string]string // A map of string replacements to apply before generating the slug
WithEmoji bool // If true, emojis will be included in a slug-friendly format
// contains filtered or unexported fields
}
Slugger provides functionality to generate URL-friendly slugs from strings. It supports configurable substitutions, optional emoji handling, and custom separators.
func New ¶
New creates and returns a new Slugger instance with optional substitutions and emoji handling.
func (*Slugger) AddSubstitution ¶ added in v1.29.0
AddSubstitution adds a new substitution to the Slugger and resets the replacer cache.
func (*Slugger) RemoveSubstitution ¶ added in v1.29.0
RemoveSubstitution deletes a substitution by key and resets the replacer cache.
func (*Slugger) ReplaceSubstitution ¶ added in v1.29.0
ReplaceSubstitution updates the value of an existing substitution and resets the replacer cache.
func (*Slugger) SetSubstitutions ¶ added in v1.29.0
SetSubstitutions replaces all current substitutions with the provided map and resets the replacer cache.
Source Files