{ "$schema": "https://json.schemastore.org/web-types", "name": "@vaadin/side-nav", "version": "25.0.0-rc1", "description-markup": "markdown", "contributions": { "html": { "elements": [ { "name": "vaadin-side-nav-item", "description": "A navigation item to be used within ``. Represents a navigation target.\nNot intended to be used separately.\n\n```html\n\n Item 1\n \n Child item 1\n \n \n Child item 2\n \n\n```\n\n### Customization\n\nYou can configure the item by using `slot` names.\n\nSlot name | Description\n----------|-------------\n`prefix` | A slot for content before the label (e.g. an icon).\n`suffix` | A slot for content after the label (e.g. an icon).\n\n#### Example\n\n```html\n\n \n Item\n Suffix\n\n```\n\n### Styling\n\nThe following shadow DOM parts are available for styling:\n\nPart name | Description\n----------------|----------------\n`content` | The element that wraps link and toggle button\n`children` | The element that wraps child items\n`link` | The clickable anchor used for navigation\n`toggle-button` | The toggle button\n\nThe following state attributes are available for styling:\n\nAttribute | Description\n---------------|-------------\n`disabled` | Set when the element is disabled.\n`expanded` | Set when the element is expanded.\n`has-children` | Set when the element has child items.\n`has-tooltip` | Set when the element has a slotted tooltip.\n\nSee [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.", "attributes": [ { "name": "disabled", "description": "If true, the user cannot interact with this element.", "value": { "type": [ "boolean", "null", "undefined" ] } }, { "name": "path", "description": "The path to navigate to", "value": { "type": [ "string", "null", "undefined" ] } }, { "name": "expanded", "description": "Whether to show the child items or not", "value": { "type": [ "boolean" ] } }, { "name": "match-nested", "description": "Whether to also match nested paths / routes. `false` by default.\n\nWhen enabled, an item with the path `/path` is considered current when\nthe browser URL is `/path`, `/path/child`, `/path/child/grandchild`,\netc.\n\nNote that this only affects matching of the URLs path, not the base\norigin or query parameters.", "value": { "type": [ "boolean" ] } }, { "name": "target", "description": "The target of the link. Works only when `path` is set.", "value": { "type": [ "string", "null", "undefined" ] } }, { "name": "router-ignore", "description": "Whether to exclude the item from client-side routing. When enabled,\nthis causes the item to behave like a regular anchor, causing a full\npage reload. This only works with supported routers, such as the one\nprovided in Vaadin apps, or when using the side nav `onNavigate` hook.", "value": { "type": [ "boolean" ] } }, { "name": "theme", "description": "The theme variants to apply to the component.", "value": { "type": [ "string", "null", "undefined" ] } } ], "js": { "properties": [ { "name": "disabled", "description": "If true, the user cannot interact with this element.", "value": { "type": [ "boolean", "null", "undefined" ] } }, { "name": "i18n", "description": "The object used to localize this component. To change the default\nlocalization, replace this with an object that provides all properties, or\njust the individual properties you want to change.\n\nThe object has the following structure and default values:\n```js\n{\n toggle: 'Toggle child items'\n}\n```", "value": { "type": [ "SideNavI18n" ] } }, { "name": "path", "description": "The path to navigate to", "value": { "type": [ "string", "null", "undefined" ] } }, { "name": "pathAliases", "description": "The list of alternative paths matching this item", "value": { "type": [ "Array." ] } }, { "name": "expanded", "description": "Whether to show the child items or not", "value": { "type": [ "boolean" ] } }, { "name": "matchNested", "description": "Whether to also match nested paths / routes. `false` by default.\n\nWhen enabled, an item with the path `/path` is considered current when\nthe browser URL is `/path`, `/path/child`, `/path/child/grandchild`,\netc.\n\nNote that this only affects matching of the URLs path, not the base\norigin or query parameters.", "value": { "type": [ "boolean" ] } }, { "name": "target", "description": "The target of the link. Works only when `path` is set.", "value": { "type": [ "string", "null", "undefined" ] } }, { "name": "routerIgnore", "description": "Whether to exclude the item from client-side routing. When enabled,\nthis causes the item to behave like a regular anchor, causing a full\npage reload. This only works with supported routers, such as the one\nprovided in Vaadin apps, or when using the side nav `onNavigate` hook.", "value": { "type": [ "boolean" ] } } ], "events": [ { "name": "expanded-changed", "description": "Fired when the `expanded` property changes." } ] } }, { "name": "vaadin-side-nav", "description": "`` is a Web Component for navigation menus.\n\n```html\n\n Item 1\n Item 2\n Item 3\n Item 4\n\n```\n\n### Customization\n\nYou can configure the component by using `slot` names.\n\nSlot name | Description\n----------|-------------\n`label` | The label (text) inside the side nav.\n\n#### Example\n\n```html\n\n Main menu\n Item\n\n```\n\n### Styling\n\nThe following shadow DOM parts are available for styling:\n\nPart name | Description\n----------------|----------------\n`label` | The label element\n`children` | The element that wraps child items\n`toggle-button` | The toggle button\n\nThe following state attributes are available for styling:\n\nAttribute | Description\n-------------|-------------\n`collapsed` | Set when the element is collapsed.\n`focus-ring` | Set when the label is focused using the keyboard.\n`focused` | Set when the label is focused.\n\nSee [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.", "attributes": [ { "name": "collapsible", "description": "Whether the side nav is collapsible. When enabled, the toggle icon is shown.", "value": { "type": [ "boolean" ] } }, { "name": "collapsed", "description": "Whether the side nav is collapsed. When collapsed, the items are hidden.", "value": { "type": [ "boolean" ] } }, { "name": "on-navigate", "description": "Callback function for router integration.\n\nWhen a side nav item link is clicked, this function is called and the default click action is cancelled.\nThis delegates the responsibility of navigation to the function's logic.\n\nThe click event action is not cancelled in the following cases:\n- The click event has a modifier (e.g. `metaKey`, `shiftKey`)\n- The click event is on an external link\n- The click event is on a link with `target=\"_blank\"`\n- The function explicitly returns `false`\n\nThe function receives an object with the properties of the clicked side-nav item:\n- `path`: The path of the navigation item.\n- `target`: The target of the navigation item.\n- `current`: A boolean indicating whether the navigation item is currently selected.\n- `expanded`: A boolean indicating whether the navigation item is expanded.\n- `pathAliases`: An array of path aliases for the navigation item.\n- `originalEvent`: The original DOM event that triggered the navigation.\n\nAlso see the `location` property for updating the highlighted navigation item on route change.", "value": { "type": [ "function Object: boolean", "undefined" ] } }, { "name": "location", "description": "A change to this property triggers an update of the highlighted item in the side navigation. While it typically\ncorresponds to the browser's URL, the specific value assigned to the property is irrelevant. The component has\nits own internal logic for determining which item is highlighted.\n\nThe main use case for this property is when the side navigation is used with a client-side router. In this case,\nthe component needs to be informed about route changes so it can update the highlighted item.", "value": { "type": [ "any" ] } }, { "name": "no-auto-expand", "description": "Whether to expand parent items of the nested matching item after initial\nrendering or navigation. By default, all the parent items are expanded.\nSet to true to disable this behavior.", "value": { "type": [ "boolean", "null", "undefined" ] } }, { "name": "theme", "description": "The theme variants to apply to the component.", "value": { "type": [ "string", "null", "undefined" ] } } ], "js": { "properties": [ { "name": "i18n", "description": "The object used to localize this component. To change the default\nlocalization, replace this with an object that provides all properties, or\njust the individual properties you want to change.\n\nThe object has the following structure and default values:\n```js\n{\n toggle: 'Toggle child items'\n}\n```", "value": { "type": [ "SideNavI18n" ] } }, { "name": "collapsible", "description": "Whether the side nav is collapsible. When enabled, the toggle icon is shown.", "value": { "type": [ "boolean" ] } }, { "name": "collapsed", "description": "Whether the side nav is collapsed. When collapsed, the items are hidden.", "value": { "type": [ "boolean" ] } }, { "name": "onNavigate", "description": "Callback function for router integration.\n\nWhen a side nav item link is clicked, this function is called and the default click action is cancelled.\nThis delegates the responsibility of navigation to the function's logic.\n\nThe click event action is not cancelled in the following cases:\n- The click event has a modifier (e.g. `metaKey`, `shiftKey`)\n- The click event is on an external link\n- The click event is on a link with `target=\"_blank\"`\n- The function explicitly returns `false`\n\nThe function receives an object with the properties of the clicked side-nav item:\n- `path`: The path of the navigation item.\n- `target`: The target of the navigation item.\n- `current`: A boolean indicating whether the navigation item is currently selected.\n- `expanded`: A boolean indicating whether the navigation item is expanded.\n- `pathAliases`: An array of path aliases for the navigation item.\n- `originalEvent`: The original DOM event that triggered the navigation.\n\nAlso see the `location` property for updating the highlighted navigation item on route change.", "value": { "type": [ "function Object: boolean", "undefined" ] } }, { "name": "location", "description": "A change to this property triggers an update of the highlighted item in the side navigation. While it typically\ncorresponds to the browser's URL, the specific value assigned to the property is irrelevant. The component has\nits own internal logic for determining which item is highlighted.\n\nThe main use case for this property is when the side navigation is used with a client-side router. In this case,\nthe component needs to be informed about route changes so it can update the highlighted item.", "value": { "type": [ "any" ] } }, { "name": "noAutoExpand", "description": "Whether to expand parent items of the nested matching item after initial\nrendering or navigation. By default, all the parent items are expanded.\nSet to true to disable this behavior.", "value": { "type": [ "boolean", "null", "undefined" ] } } ], "events": [ { "name": "collapsed-changed", "description": "Fired when the `collapsed` property changes." } ] } } ] } } }