Current section

Files

Jump to
noora components breadcrumb-item.json
Raw

components/breadcrumb-item.json

{
"name": "BreadcrumbItem",
"tagName": "noora-breadcrumb-item",
"elementClassName": "NooraBreadcrumbItem",
"className": "noora-breadcrumb",
"modulePath": "./priv/static/noora-web-components.js",
"description": "Describes one declarative item inside breadcrumbs.",
"usage": "<noora-breadcrumb-item href=\"/projects\">Projects</noora-breadcrumb-item>",
"standalone": false,
"attributes": [
{
"name": "label",
"property": "label",
"type": "string",
"default": "",
"description": "Sets the label instead of using text content."
},
{
"name": "href",
"property": "href",
"type": "string",
"description": "Sets the navigation address."
},
{
"name": "icon",
"property": "icon",
"type": "string",
"description": "Shows an icon before the label."
},
{
"name": "avatar",
"property": "avatar",
"type": "boolean",
"default": false,
"description": "Shows an avatar before the label."
},
{
"name": "avatar-name",
"property": "avatarName",
"type": "string",
"description": "Sets the avatar name."
},
{
"name": "avatar-color",
"property": "avatarColor",
"type": "string",
"description": "Sets the avatar color."
},
{
"name": "avatar-image-href",
"property": "avatarImageHref",
"type": "string",
"description": "Sets the avatar image address."
},
{
"name": "badge-label",
"property": "badgeLabel",
"type": "string",
"description": "Shows a badge with this label."
},
{
"name": "badge-color",
"property": "badgeColor",
"type": "string",
"description": "Sets the badge color."
}
],
"properties": [],
"readonlyProperties": [],
"slots": [
{
"name": "",
"description": "The label followed by optional noora-dropdown-item children."
}
],
"cssParts": [],
"notes": [
"Nested noora-dropdown-item children create the optional breadcrumb menu."
],
"examples": [
{
"id": "item",
"title": "Item",
"description": "Describe one level in a breadcrumb path.",
"markup": "<noora-breadcrumb-item href=\"/projects\">Projects</noora-breadcrumb-item>"
}
]
}