BreadcrumbItemButton

How to get BreadcrumbItemButton

import { BreadcrumbItemButton } from 'fds/components';

Type: Component

A button to be used as a breadcrumb item inside Breadcrumbs#renderBreadcrumbItem.

Props

# Name Type Description
1. [hasDrop] Boolean

Whether or not this item should render a separate toggle Drop button.


  Default value
false
2. label String

The human readable label displayed in the component.

3. [isDisabled] Boolean

Whether or not the component should be rendered in a disabled state.

  Default value
false
4. [isDropOpened] Boolean

Whether or not the Drop corresponding to the component is opened.

  Default value
false
5. [isFirstItem] Boolean

Whether or not this is the first item in the specified set of items.

  Default value
false
6. [isLastItem] Boolean

Whether or not this is the last item in the specified set of items.

  Default value
false
7. [isSelected] Boolean

Whether or not the component should be rendered in a selected state.

  Default value
false
8. [onClick] Function

A callback that is called whenever the component is clicked and is not in a disabled state.

For more information about React and "events", check the React documentation


  Arguments
# Name Type Description
1. event ReactSyntheticEvent
9. [onMouseEnter] Function

A callback that is called whenever the pointer is moved over the component. This callback is only fired when the pointer enters the component.

For more information about React and "events", check the React documentation


  Arguments
# Name Type Description
1. event ReactSyntheticEvent
10. [onMouseLeave] Function

A callback that is called whenever the pointer is moved off the component. This callback is only fired when the pointer leaves the component.

For more information about React and "events", check the React documentation


  Arguments
# Name Type Description
1. event ReactSyntheticEvent
11. [onRef] Function

A callback that is called whenever a component's ref changes.

Use this callback to get a ref to (the domNode of) a component. There shouldn't be many usecases for using this prop yourself, but you might have to implement it with a given argument from a render callback somewhere.

For more information about React and "refs", check the React documentation


  Arguments
# Name Type Description
1. domNode HTMLElement

The domNode on which the component placed its ref callback attribute.

  Returns

Type: void

12. [toggleDrop] Function

A function that can be called to toggle the Drop that corresponds to the component.

Was this page helpful?