@umbraco-ui/uui-breadcrumbs
Version:
This package contains two web components - uui-breadcrumb-item and uui-breadcrumbs. They can be used as an additional navigation to allow users to keep track and maintain awareness of their location.
75 lines • 2.2 kB
JSON
{
"version": "experimental",
"tags": [
{
"name": "uui-breadcrumb-item",
"path": "./lib/uui-breadcrumb-item.element.ts",
"description": "A breadcrumb-item to be used with the breadcrumbs component.",
"attributes": [
{
"name": "href",
"description": "Specifies the link href.",
"type": "String",
"default": "\"undefined\""
},
{
"name": "last-item",
"description": "Specifies if the element is the last item in the uui-breadcrumbs. Last item will not render as a link",
"type": "Boolean",
"default": "\"'false'\""
}
],
"properties": [
{
"name": "href",
"attribute": "href",
"description": "Specifies the link href.",
"type": "String",
"default": "\"undefined\""
},
{
"name": "lastItem",
"attribute": "last-item",
"description": "Specifies if the element is the last item in the uui-breadcrumbs. Last item will not render as a link",
"type": "Boolean",
"default": "\"'false'\""
},
{
"name": "styles",
"type": "CSSResult[]",
"default": "[null]"
}
],
"slots": [
{
"name": "",
"description": "This slot displays elements inside the breadcrumb"
}
],
"cssParts": [
{
"name": "separator",
"description": "change the content of the after element of this part to change the separator"
}
]
},
{
"name": "uui-breadcrumbs",
"path": "./lib/uui-breadcrumbs.element.ts",
"description": "A breadcrumbs component to be used in combination with the uui-breadcrumb-item.",
"properties": [
{
"name": "styles",
"type": "CSSResult[]",
"default": "[null]"
}
],
"slots": [
{
"name": "",
"description": "Slot to display nested breadcrumb items. It supports `<uui-breadcrumb-item>` elements or elements containing the `role=\"listitem\"` attribute"
}
]
}
]
}