@synergy-design-system/react
Version:
React wrappers for the Synergy Design System
38 lines (37 loc) • 1.61 kB
TypeScript
import Component from '@synergy-design-system/components/components/prio-nav/prio-nav.component.js';
/**
* @summary The `<syn-prio-nav />` element provides a generic navigation bar
* that can be used to group multiple navigation items (usually horizontal `<syn-nav-item />`s)
* together. It will automatically group all items not visible in the viewport into a custom
* priority menu.
*
* @documentation https://synergy-design-system.github.io/?path=/docs/components-syn-prio-nav--docs
* @example
* <syn-prio-nav>
* <syn-nav-item current horizontal>Item 1</syn-nav-item>
* <button role="menuitem">Item 2 (custom)</button>
* <syn-nav-item horizontal>Item 3</syn-nav-item>
* </syn-prio-nav>
*
* @documentation https://synergy-design-system.github.io/?path=/docs/components-syn-prio-nav--docs
* @status stable
* @since 1.14.0
*
* @dependency syn-dropdown
* @dependency syn-icon
* @dependency syn-menu
* @dependency syn-nav-item
*
* @slot - The given navigation items. Must be horizontal `<syn-nav-item>`s
* or have a role of "menuitem"
*
* @csspart base - The component's base wrapper.
* @csspart priority-menu - The wrapper around the priority menu
* @csspart priority-menu-nav-item - The navigation item for the priority menu
* @csspart priority-menu-label - The label for the priority menu
* @csspart priority-menu-icon - The icon for the priority menu
* @csspart priority-menu-container - The container for the shifted navigation items,
* if there is not enough space.
*
*/
export declare const SynPrioNav: import("@lit/react").ReactWebComponent<Component, {}>;