@wix/design-system
Version:
@wix/design-system
36 lines (33 loc) • 1.37 kB
Markdown
### dataHook
- type: string
- description: Applies a data-hook HTML attribute to be used in the tests
### items
- type: BreadcrumbsItem[]
- description: Describes each breadcrumbs item:
- `id` (required) - gives an item numeric identifier
- `value` (required) - sets the item label to be shown on breadcrumbs
- `link` - stores a link which user is directed to after clicking on an item
- `customElement` - contains and renders a custom component or `<a>` link instead of an item value
- `disabled` - disables an item
### onClick
- type: (item: BreadcrumbsItem, event: MouseEvent<HTMLElement, MouseEvent>) => any
- description: Defines a function which is called when a user clicks on an item
### activeId
- type: string | number
- description: Defines which breadcrumbs item is currently active
### size
- type: "small" | "medium" | "large"
- description: Controls the component size
- default: 'medium'
### itemMaxWidth
- type: string | number | string & {}
- description: Sets the maximum width of each item value in px. Longer items get truncated with ellipsis.
- default: '240px'
### theme
- type: "onWhiteBackground" | "onGrayBackground" | "onDarkBackground"
- description: use `skin` instead
- default: 'onGrayBackground'
- deprecated
### skin
- type: "onWhiteBackground" | "onGrayBackground" | "onDarkBackground"
- description: Controls the component appearance