Boxicons (boxicons)
These options control the registration of the Boxicons library.
Boxicons uses the Creative Commons 4.0 License.
JSON Schema
Definition
{
"$id": "https://platen.io/modules/platen/config/site/features/shoelace/icon_libraries/boxicons/schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Settings for the Boxicons library.\n\nhttps://platen.io/modules/platen/config/site/features/shoelace/icon_libraries/boxicons/",
"properties": {
"aliases": {
"default": [
"box"
],
"description": "Define any number of aliases for the icon library.\n\nhttps://platen.io/modules/platen/config/site/features/shoelace/icon_libraries/boxicons/#aliases",
"items": {
"type": "string"
},
"title": "Library Aliases",
"type": "array"
},
"default_variant": {
"default": "regular",
"description": "Choose the default icon variant to use for the library.\n\nhttps://platen.io/modules/platen/config/site/features/shoelace/icon_libraries/boxicons/#default_variant",
"enum": [
"regular",
"solid",
"logos"
],
"title": "Library Default Variant",
"type": "string"
},
"enabled": {
"default": true,
"description": "Choose whether to enable the icon library\n\nhttps://platen.io/modules/platen/config/site/features/shoelace/icon_libraries/boxicons/#enabled",
"title": "Enable Library",
"type": "boolean"
},
"registration": {
"description": "Settings for how the library is registered.\n\nhttps://platen.io/modules/platen/config/site/features/shoelace/icon_libraries/boxicons/#registration",
"properties": {
"script": {
"default": "boxicons.js",
"description": "Specify the name of the registration script.\n\nhttps://platen.io/modules/platen/config/site/features/shoelace/icon_libraries/boxicons/#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/modules/platen/config/site/features/shoelace/icon_libraries/boxicons/#variants",
"properties": {
"logos": {
"default": "bxl",
"description": "Maps the variant name `logos` for boxicons.\n\nhttps://platen.io/modules/platen/config/site/features/shoelace/icon_libraries/boxicons/#logos",
"title": "Logos Variant",
"type": "string"
},
"regular": {
"default": "bx",
"description": "Maps the variant name `regular` for boxicons.\n\nhttps://platen.io/modules/platen/config/site/features/shoelace/icon_libraries/boxicons/#regular",
"title": "Regular Variant",
"type": "string"
},
"solid": {
"default": "bxs",
"description": "Maps the variant name `solid` for boxicons.\n\nhttps://platen.io/modules/platen/config/site/features/shoelace/icon_libraries/boxicons/#solid",
"title": "Solid Variant",
"type": "string"
}
},
"title": "Library Variants Map",
"type": "object"
},
"version": {
"default": "2.0.5",
"description": "Choose the version of the library to load.\n\nhttps://platen.io/modules/platen/config/site/features/shoelace/icon_libraries/boxicons/#version",
"title": "Library Version",
"type": "string"
}
},
"title": "Boxicons",
"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>
[
"box"
]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/modules/platen/config/site/features/shoelace/icon_libraries/boxicons/",
"properties": {
"logos": {
"default": "bxl",
"description": "Maps the variant name `logos` for boxicons.\n\nhttps://platen.io/modules/platen/config/site/features/shoelace/icon_libraries/boxicons/#logos",
"title": "Logos Variant",
"type": "string"
},
"regular": {
"default": "bx",
"description": "Maps the variant name `regular` for boxicons.\n\nhttps://platen.io/modules/platen/config/site/features/shoelace/icon_libraries/boxicons/#regular",
"title": "Regular Variant",
"type": "string"
},
"solid": {
"default": "bxs",
"description": "Maps the variant name `solid` for boxicons.\n\nhttps://platen.io/modules/platen/config/site/features/shoelace/icon_libraries/boxicons/#solid",
"title": "Solid Variant",
"type": "string"
}
},
"title": "Library Variants Map",
"type": "object"
}Solid Variant (solid)
Maps the variant name solid for boxicons.
Logos Variant (logos)
Maps the variant name logos for boxicons.
Regular Variant (regular)
Maps the variant name regular for boxicons.
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/modules/platen/config/site/features/shoelace/icon_libraries/boxicons/",
"properties": {
"script": {
"default": "boxicons.js",
"description": "Specify the name of the registration script.\n\nhttps://platen.io/modules/platen/config/site/features/shoelace/icon_libraries/boxicons/#script",
"title": "Registration Script",
"type": "string"
}
},
"title": "Registration Options",
"type": "object"
}Registration Script (script)
Specify the name of the registration script.