Heroicons (heroicons)
These options control the registration of the Heroicons library.
Heroicons uses the MIT License.
JSON Schema
Definition
{
"$id": "https://platen.io/schemas/platen/site/features/shoelace/icon_libraries/heroicons/schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Settings for the Heroicons library.\n\nhttps://platen.io/schemas/platen/site/features/shoelace/icon_libraries/heroicons/",
"properties": {
"aliases": {
"default": [
"hero"
],
"description": "Define any number of aliases for the icon library.\n\nhttps://platen.io/schemas/platen/site/features/shoelace/icon_libraries/heroicons/#aliases",
"items": {
"type": "string"
},
"title": "Library Aliases",
"type": "array"
},
"default_variant": {
"default": "outline",
"description": "Choose the default icon variant to use for the library.\n\nhttps://platen.io/schemas/platen/site/features/shoelace/icon_libraries/heroicons/#default_variant",
"enum": [
"outline",
"solid",
"mini"
],
"title": "Library Default Variant",
"type": "string"
},
"enabled": {
"default": true,
"description": "Choose whether to enable the icon library\n\nhttps://platen.io/schemas/platen/site/features/shoelace/icon_libraries/heroicons/#enabled",
"title": "Enable Library",
"type": "boolean"
},
"registration": {
"description": "Settings for how the library is registered.\n\nhttps://platen.io/schemas/platen/site/features/shoelace/icon_libraries/heroicons/#registration",
"properties": {
"script": {
"default": "heroicons.js",
"description": "Specify the name of the registration script.\n\nhttps://platen.io/schemas/platen/site/features/shoelace/icon_libraries/heroicons/#script",
"title": "Registration Script",
"type": "string"
}
},
"title": "Registration Options",
"type": "object"
},
"variants": {
"description": "Maps a friendly variant name to the icon's prefix.\n\nhttps://platen.io/schemas/platen/site/features/shoelace/icon_libraries/heroicons/#variants",
"properties": {
"mini": {
"default": "20/solid",
"description": "Maps the variant name `mini` for Heroicons.\n\nhttps://platen.io/schemas/platen/site/features/shoelace/icon_libraries/heroicons/#mini",
"title": "Brands Variant",
"type": "string"
},
"outline": {
"default": "24/outline",
"description": "Maps the variant name `outline` for Heroicons.\n\nhttps://platen.io/schemas/platen/site/features/shoelace/icon_libraries/heroicons/#outline",
"title": "Outline Variant",
"type": "string"
},
"solid": {
"default": "24/solid",
"description": "Maps the variant name `solid` for Heroicons.\n\nhttps://platen.io/schemas/platen/site/features/shoelace/icon_libraries/heroicons/#solid",
"title": "Solid Variant",
"type": "string"
}
},
"title": "Library Variants Map",
"type": "object"
},
"version": {
"default": "2.0.1",
"description": "Choose the version of the library to load.\n\nhttps://platen.io/schemas/platen/site/features/shoelace/icon_libraries/heroicons/#version",
"title": "Library Version",
"type": "string"
}
},
"title": "Heroicons",
"type": "object"
}Enable Library (enabled)
Use this setting to choose whether the icon library is available.
Library Aliases (aliases)
Use this setting to specify alternate short names for the library. You can use these names instead of the full library name when specifying the library in your markup or other settings.
<h3 id="aliases.default">Default Value</h3>
[
"hero"
]Library Version (version)
Choose the version of the library to load from the CDN. Platen regularly updates this version after testing. You can always use a specific released version of the library if you prefer.
Library Default Variant (default_variant)
Use this option to set the default variant for icons from this library.
Library Variants Map (variants)
Use this option to create a map of friendly names for icon variants to generate their final icon name to retrieve from the library.
JSON Schema
Definition
{
"description": "Maps a friendly variant name to the icon's prefix.\n\nhttps://platen.io/schemas/platen/site/features/shoelace/icon_libraries/heroicons/",
"properties": {
"mini": {
"default": "20/solid",
"description": "Maps the variant name `mini` for Heroicons.\n\nhttps://platen.io/schemas/platen/site/features/shoelace/icon_libraries/heroicons/#mini",
"title": "Brands Variant",
"type": "string"
},
"outline": {
"default": "24/outline",
"description": "Maps the variant name `outline` for Heroicons.\n\nhttps://platen.io/schemas/platen/site/features/shoelace/icon_libraries/heroicons/#outline",
"title": "Outline Variant",
"type": "string"
},
"solid": {
"default": "24/solid",
"description": "Maps the variant name `solid` for Heroicons.\n\nhttps://platen.io/schemas/platen/site/features/shoelace/icon_libraries/heroicons/#solid",
"title": "Solid Variant",
"type": "string"
}
},
"title": "Library Variants Map",
"type": "object"
}Brands Variant (mini)
Maps the variant name mini for Heroicons.
Solid Variant (solid)
Maps the variant name solid for Heroicons.
Outline Variant (outline)
Maps the variant name outline for Heroicons.
Registration Options (registration)
Settings for how the library is registered.
JSON Schema
Definition
{
"description": "Settings for how the library is registered.\n\nhttps://platen.io/schemas/platen/site/features/shoelace/icon_libraries/heroicons/",
"properties": {
"script": {
"default": "heroicons.js",
"description": "Specify the name of the registration script.\n\nhttps://platen.io/schemas/platen/site/features/shoelace/icon_libraries/heroicons/#script",
"title": "Registration Script",
"type": "string"
}
},
"title": "Registration Options",
"type": "object"
}Registration Script (script)
Specify the name of the registration script.