| Name | \r\nType | \r\nRequired | \r\nDefault | \r\nDescription | \r\n
|---|---|---|---|---|
| exclusive | \r\nboolean | \r\n false | \r\n- | \r\n - | \r\n
| spacing | \r\n\"normal\" , \"small\" | \r\n false | \r\nnormal | \r\n - | \r\n
| id | \r\nstring | \r\n false | \r\n- | \r\n The identifier that will be passed through to the underlying HTML element | \r\n
| Name | \r\nType | \r\nRequired | \r\nDefault | \r\nDescription | \r\n
|---|---|---|---|---|
| breadcrumbs | \r\nT[] | \r\n true | \r\n- | \r\n Array of breadcrumb items that will be displayed | \r\n
| keyExtractor | \r\nKeyExtractor | \r\n false | \r\n- | \r\n A function that should be used to return a unique key for each item if the breadcrumbs prop contains non-primitive or duplicate entries | \r\n
| labelExtractor | \r\nContentExtractor | \r\n false | \r\n- | \r\n A function that should be used to return a display value for each item if the breadcrumbs prop contains non-primitive entries | \r\n
| onClick | \r\n(crumb: string) => void | \r\n true | \r\n- | \r\n A handler that will be invoked each time a breadcrumb item is clicked on\r\n@param crumb The breadcrumb item interacted with\r\n@returns void | \r\n
| showCurrent | \r\nboolean | \r\n false | \r\ntrue | \r\n Determines whether to show the current page in the breadcrumb list | \r\n
| ariaCurrent | \r\n\"page\" , \"step\" | \r\n false | \r\n- | \r\n - | \r\n
| id | \r\nstring | \r\n false | \r\n- | \r\n The identifier that will be passed through to the underlying HTML element | \r\n
| Name | \r\nType | \r\nRequired | \r\nDefault | \r\nDescription | \r\n
|---|---|---|---|---|
| accessibility | \r\nButtonAccessibilityProps | \r\n false | \r\n- | \r\n - | \r\n
| buttonType | \r\n\"submit\" , \"reset\" , \"button\" | \r\n false | \r\nbutton | \r\n Determines the behavior of the Button when used in an HTML form | \r\n
| disabled | \r\nboolean | \r\n false | \r\nfalse | \r\n Determines whether the Button is subject to user interaction | \r\n
| icon | \r\n(props: SVGProps | \r\n false | \r\n- | \r\n An SVG component that will be rendered as the Button's icon. An icon must be provided if no label is provided | \r\n
| iconPosition | \r\n\"left\" , \"right\" | \r\n false | \r\nleft | \r\n Determines which side of the Button the SVG icon component is positioned in relation to the Button's label text | \r\n
| loading | \r\nboolean | \r\n false | \r\n- | \r\n Determines whether the Button should render a loading animation to indicate activity | \r\n
| loadingProgress | \r\nnumber | \r\n false | \r\n- | \r\n Determines the progress % to be represented by the loading animation. If no value is provided, the loading animation will loop in an infinite, indeterminate state | \r\n
| onPress | \r\n() => void | \r\n false | \r\n- | \r\n A handler that will be called when the Button is pressed | \r\n
| label | \r\nFormattedString | \r\n false | \r\n- | \r\n Text that will be displayed as the Button's label (Note: a more complex label can be achieved by instead providing the label as the Button's children). A label must be provided if no icon is provided | \r\n
| activeColor | \r\nColor | \r\n false | \r\n- | \r\n Determines the color of the Button's background when active | \r\n
| borderColor | \r\nColor | \r\n false | \r\n\"transparent\" | \r\n Determines the color of the Button's border | \r\n
| color | \r\nColor | \r\n false | \r\nColorPalette.neutral | \r\n Determines the color of the Button's background | \r\n
| focusColor | \r\nColor | \r\n false | \r\n- | \r\n Determines the color of the Button's background when focused. If undefined, this will default to the value of color | \r\n
| hoverColor | \r\nColor | \r\n false | \r\nColorPalette.border | \r\n Determines the color of the Button's background when hovered | \r\n
| iconColor | \r\nColor | \r\n false | \r\n- | \r\n Determines the color of the provided SVG icon component. If undefined, this will default to the value of labelColor | \r\n
| iconColorActive | \r\nColor | \r\n false | \r\n- | \r\n Determines the color of the provided SVG icon component when the Button is active. The specified color should have sufficient contrast with the active background color for accessibility purposes. If undefined, this will default to the value of labelColorActive | \r\n
| labelColor | \r\nColor | \r\n false | \r\nColorPalette.neutralDark | \r\n Determines the color of the Button's label text (and icon, unless otherwise specified) | \r\n
| labelColorActive | \r\nColor | \r\n false | \r\n#FFFFFF | \r\n Determines the colour of the Button's label text when active. The specified color should have sufficient contrast with the active background color for accessibility purposes | \r\n
| outlineColor | \r\nColor | \r\n false | \r\nColorPalette.primary | \r\n Determines the color of the Button's outline when focused. The specified color should have sufficient contrast with the background color for accessibility purposes | \r\n
| size | \r\n\"small\" , \"normal\" , \"large\" | \r\n false | \r\nnormal | \r\n Determines the rendered size of the Button but adjusting the amount of padding | \r\n
| ariaLabel | \r\nstring | \r\n false | \r\n- | \r\n - | \r\n
| id | \r\nstring | \r\n false | \r\n- | \r\n The identifier that will be passed through to the underlying HTML element | \r\n
| Name | \r\nType | \r\nRequired | \r\nDefault | \r\nDescription | \r\n
|---|---|---|---|---|
| ariaLabel | \r\nstring | \r\n false | \r\n- | \r\n - | \r\n
| accessibility | \r\nButtonAccessibilityProps | \r\n false | \r\n- | \r\n - | \r\n
| buttonType | \r\n\"submit\" , \"reset\" , \"button\" | \r\n false | \r\n\"button\" | \r\n Determines the behavior of the Button when used in an HTML form | \r\n
| disabled | \r\nboolean | \r\n false | \r\nfalse | \r\n Determines whether the Button is subject to user interaction | \r\n
| icon | \r\n(props: SVGProps | \r\n false | \r\n- | \r\n An SVG component that will be rendered as the Button's icon. An icon must be provided if no label is provided | \r\n
| iconPosition | \r\n\"left\" , \"right\" | \r\n false | \r\n\"left\" | \r\n Determines which side of the Button the SVG icon component is positioned in relation to the Button's label text | \r\n
| loading | \r\nboolean | \r\n false | \r\n- | \r\n Determines whether the Button should render a loading animation to indicate activity | \r\n
| loadingProgress | \r\nnumber | \r\n false | \r\n- | \r\n Determines the progress % to be represented by the loading animation. If no value is provided, the loading animation will loop in an infinite, indeterminate state | \r\n
| onPress | \r\n() => void | \r\n false | \r\n- | \r\n A handler that will be called when the Button is pressed | \r\n
| label | \r\nFormattedString | \r\n false | \r\n- | \r\n Text that will be displayed as the Button's label (Note: a more complex label can be achieved by instead providing the label as the Button's children). A label must be provided if no icon is provided | \r\n
| size | \r\n\"small\" , \"normal\" , \"large\" | \r\n false | \r\n\"normal\" | \r\n Determines the rendered size of the Button but adjusting the amount of padding | \r\n
| id | \r\nstring | \r\n false | \r\n- | \r\n The identifier that will be passed through to the underlying HTML element | \r\n
| Name | \r\nType | \r\nRequired | \r\nDefault | \r\nDescription | \r\n
|---|---|---|---|---|
| icon | \r\n(props: SVGProps | \r\n true | \r\n- | \r\n An SVG component that will be rendered as the Button's icon. An icon must be provided if no label is provided | \r\n
| ariaLabel | \r\nstring | \r\n false | \r\n- | \r\n - | \r\n
| accessibility | \r\nButtonAccessibilityProps | \r\n false | \r\n- | \r\n - | \r\n
| buttonType | \r\n\"submit\" , \"reset\" , \"button\" | \r\n false | \r\n\"button\" | \r\n Determines the behavior of the Button when used in an HTML form | \r\n
| disabled | \r\nboolean | \r\n false | \r\nfalse | \r\n Determines whether the Button is subject to user interaction | \r\n
| loading | \r\nboolean | \r\n false | \r\n- | \r\n Determines whether the Button should render a loading animation to indicate activity | \r\n
| loadingProgress | \r\nnumber | \r\n false | \r\n- | \r\n Determines the progress % to be represented by the loading animation. If no value is provided, the loading animation will loop in an infinite, indeterminate state | \r\n
| onPress | \r\n() => void | \r\n false | \r\n- | \r\n A handler that will be called when the Button is pressed | \r\n
| borderColor | \r\nColor | \r\n false | \r\n\"transparent\" | \r\n Determines the color of the Button's border | \r\n
| focusColor | \r\nColor | \r\n false | \r\n- | \r\n Determines the color of the Button's background when focused. If undefined, this will default to the value of color | \r\n
| iconColor | \r\nColor | \r\n false | \r\n- | \r\n Determines the color of the provided SVG icon component. If undefined, this will default to the value of labelColor | \r\n
| iconColorActive | \r\nColor | \r\n false | \r\n- | \r\n Determines the color of the provided SVG icon component when the Button is active. The specified color should have sufficient contrast with the active background color for accessibility purposes. If undefined, this will default to the value of labelColorActive | \r\n
| labelColor | \r\nColor | \r\n false | \r\nColorPalette.neutralDark | \r\n Determines the color of the Button's label text (and icon, unless otherwise specified) | \r\n
| labelColorActive | \r\nColor | \r\n false | \r\n#FFFFFF | \r\n Determines the colour of the Button's label text when active. The specified color should have sufficient contrast with the active background color for accessibility purposes | \r\n
| outlineColor | \r\nColor | \r\n false | \r\nColorPalette.primary | \r\n Determines the color of the Button's outline when focused. The specified color should have sufficient contrast with the background color for accessibility purposes | \r\n
| size | \r\n\"small\" , \"normal\" , \"large\" | \r\n false | \r\n\"normal\" | \r\n Determines the rendered size of the Button but adjusting the amount of padding | \r\n
| id | \r\nstring | \r\n false | \r\n- | \r\n The identifier that will be passed through to the underlying HTML element | \r\n
| Name | \r\nType | \r\nRequired | \r\nDefault | \r\nDescription | \r\n
|---|---|---|---|---|
| ariaLabel | \r\nstring | \r\n false | \r\n- | \r\n - | \r\n
| accessibility | \r\nButtonAccessibilityProps | \r\n false | \r\n- | \r\n - | \r\n
| disabled | \r\nboolean | \r\n false | \r\nfalse | \r\n Determines whether the Button is subject to user interaction | \r\n
| icon | \r\n(props: SVGProps | \r\n false | \r\n- | \r\n An SVG component that will be rendered as the Button's icon. An icon must be provided if no label is provided | \r\n
| loading | \r\nboolean | \r\n false | \r\n- | \r\n Determines whether the Button should render a loading animation to indicate activity | \r\n
| loadingProgress | \r\nnumber | \r\n false | \r\n- | \r\n Determines the progress % to be represented by the loading animation. If no value is provided, the loading animation will loop in an infinite, indeterminate state | \r\n
| onPress | \r\n() => void | \r\n false | \r\n- | \r\n A handler that will be called when the Button is pressed | \r\n
| label | \r\nFormattedString | \r\n false | \r\n- | \r\n Text that will be displayed as the Button's label (Note: a more complex label can be achieved by instead providing the label as the Button's children). A label must be provided if no icon is provided | \r\n
| borderColor | \r\nColor | \r\n false | \r\n\"transparent\" | \r\n Determines the color of the Button's border | \r\n
| focusColor | \r\nColor | \r\n false | \r\n- | \r\n Determines the color of the Button's background when focused. If undefined, this will default to the value of color | \r\n
| iconColor | \r\nColor | \r\n false | \r\n- | \r\n Determines the color of the provided SVG icon component. If undefined, this will default to the value of labelColor | \r\n
| iconColorActive | \r\nColor | \r\n false | \r\n- | \r\n Determines the color of the provided SVG icon component when the Button is active. The specified color should have sufficient contrast with the active background color for accessibility purposes. If undefined, this will default to the value of labelColorActive | \r\n
| labelColor | \r\nColor | \r\n false | \r\nColorPalette.neutralDark | \r\n Determines the color of the Button's label text (and icon, unless otherwise specified) | \r\n
| labelColorActive | \r\nColor | \r\n false | \r\n#FFFFFF | \r\n Determines the colour of the Button's label text when active. The specified color should have sufficient contrast with the active background color for accessibility purposes | \r\n
| outlineColor | \r\nColor | \r\n false | \r\nColorPalette.primary | \r\n Determines the color of the Button's outline when focused. The specified color should have sufficient contrast with the background color for accessibility purposes | \r\n
| size | \r\n\"small\" , \"normal\" , \"large\" | \r\n false | \r\n\"normal\" | \r\n Determines the rendered size of the Button but adjusting the amount of padding | \r\n
| id | \r\nstring | \r\n false | \r\n- | \r\n The identifier that will be passed through to the underlying HTML element | \r\n
| Name | \r\nType | \r\nRequired | \r\nDefault | \r\nDescription | \r\n
|---|---|---|---|---|
| ariaLabel | \r\nstring | \r\n false | \r\n- | \r\n - | \r\n
| accessibility | \r\nButtonAccessibilityProps | \r\n false | \r\n- | \r\n - | \r\n
| buttonType | \r\n\"submit\" , \"reset\" , \"button\" | \r\n false | \r\n\"button\" | \r\n Determines the behavior of the Button when used in an HTML form | \r\n
| disabled | \r\nboolean | \r\n false | \r\nfalse | \r\n Determines whether the Button is subject to user interaction | \r\n
| icon | \r\n(props: SVGProps | \r\n false | \r\n- | \r\n An SVG component that will be rendered as the Button's icon. An icon must be provided if no label is provided | \r\n
| iconPosition | \r\n\"left\" , \"right\" | \r\n false | \r\n\"left\" | \r\n Determines which side of the Button the SVG icon component is positioned in relation to the Button's label text | \r\n
| loading | \r\nboolean | \r\n false | \r\n- | \r\n Determines whether the Button should render a loading animation to indicate activity | \r\n
| loadingProgress | \r\nnumber | \r\n false | \r\n- | \r\n Determines the progress % to be represented by the loading animation. If no value is provided, the loading animation will loop in an infinite, indeterminate state | \r\n
| onPress | \r\n() => void | \r\n false | \r\n- | \r\n A handler that will be called when the Button is pressed | \r\n
| label | \r\nFormattedString | \r\n false | \r\n- | \r\n Text that will be displayed as the Button's label (Note: a more complex label can be achieved by instead providing the label as the Button's children). A label must be provided if no icon is provided | \r\n
| size | \r\n\"small\" , \"normal\" , \"large\" | \r\n false | \r\n\"normal\" | \r\n Determines the rendered size of the Button but adjusting the amount of padding | \r\n
| id | \r\nstring | \r\n false | \r\n- | \r\n The identifier that will be passed through to the underlying HTML element | \r\n
| Name | \r\nType | \r\nRequired | \r\nDefault | \r\nDescription | \r\n
|---|---|---|---|---|
| ariaLabel | \r\nstring | \r\n false | \r\n- | \r\n - | \r\n
| accessibility | \r\nButtonAccessibilityProps | \r\n false | \r\n- | \r\n - | \r\n
| buttonType | \r\n\"submit\" , \"reset\" , \"button\" | \r\n false | \r\n\"button\" | \r\n Determines the behavior of the Button when used in an HTML form | \r\n
| disabled | \r\nboolean | \r\n false | \r\nfalse | \r\n Determines whether the Button is subject to user interaction | \r\n
| icon | \r\n(props: SVGProps | \r\n false | \r\n- | \r\n An SVG component that will be rendered as the Button's icon. An icon must be provided if no label is provided | \r\n
| iconPosition | \r\n\"left\" , \"right\" | \r\n false | \r\n\"left\" | \r\n Determines which side of the Button the SVG icon component is positioned in relation to the Button's label text | \r\n
| loading | \r\nboolean | \r\n false | \r\n- | \r\n Determines whether the Button should render a loading animation to indicate activity | \r\n
| loadingProgress | \r\nnumber | \r\n false | \r\n- | \r\n Determines the progress % to be represented by the loading animation. If no value is provided, the loading animation will loop in an infinite, indeterminate state | \r\n
| onPress | \r\n() => void | \r\n false | \r\n- | \r\n A handler that will be called when the Button is pressed | \r\n
| label | \r\nFormattedString | \r\n false | \r\n- | \r\n Text that will be displayed as the Button's label (Note: a more complex label can be achieved by instead providing the label as the Button's children). A label must be provided if no icon is provided | \r\n
| size | \r\n\"small\" , \"normal\" , \"large\" | \r\n false | \r\n\"normal\" | \r\n Determines the rendered size of the Button but adjusting the amount of padding | \r\n
| id | \r\nstring | \r\n false | \r\n- | \r\n The identifier that will be passed through to the underlying HTML element | \r\n
| Name | \r\nType | \r\nRequired | \r\nDefault | \r\nDescription | \r\n
|---|---|---|---|---|
| borderColor | \r\nColor | \r\n false | \r\n- | \r\n - | \r\n
| padding | \r\nPadding | \r\n false | \r\n- | \r\n - | \r\n
| ariaDescription | \r\nstring | \r\n false | \r\n- | \r\n - | \r\n
| id | \r\nstring | \r\n false | \r\n- | \r\n The identifier that will be passed through to the underlying HTML element | \r\n
| Name | \r\nType | \r\nRequired | \r\nDefault | \r\nDescription | \r\n
|---|---|---|---|---|
| ariaControlLabels | \r\n{ dot: string; next: string; previous: string; } | \r\n false | \r\n{\r\n dot: 'Go to slide {index}',\r\n next: 'Go to next slide',\r\n previous: 'Go to previous slide'\r\n } | \r\n Accessibility labels for slide controls | \r\n
| buffer | \r\nnumber | \r\n false | \r\n1 | \r\n The number of extra slides to render at either end of the Carousel when using infinite rotation | \r\n
| infinite | \r\nboolean | \r\n false | \r\n- | \r\n Determines whether the Carousel should loop around to the start/end when navigating beyond the first/last slides | \r\n
| onChange | \r\n(slideIndex: number) => void | \r\n false | \r\n- | \r\n A handler that is called when the active slide index is changed | \r\n
| showNavigationButtons | \r\nboolean | \r\n false | \r\ntrue | \r\n Determines whether to display the built-in next/previous slide navigation button controls | \r\n
| showNavigationDots | \r\nboolean | \r\n false | \r\ntrue | \r\n Determines whether to display the built-in controls to indicate/select the active slide | \r\n
| simulateMouseSwipe | \r\nboolean | \r\n false | \r\n- | \r\n Determines whether a point-and-click device can be used to simulate the touch swipe gesture to navigate between slides | \r\n
| slideIndex | \r\nnumber | \r\n false | \r\n0 | \r\n The index of the active slide | \r\n
| slideTransitionDuration | \r\nnumber | \r\n false | \r\n200 | \r\n The duration (in milliseconds) of the transition between slides | \r\n
| slideWidth | \r\nWidth | \r\n false | \r\n100% | \r\n The width of each slide relative to the container | \r\n
| id | \r\nstring | \r\n false | \r\n- | \r\n The identifier that will be passed through to the underlying HTML element | \r\n
| ref | \r\nLegacyRef | \r\n false | \r\n- | \r\n Allows getting a ref to the component instance.\r\nOnce the component unmounts, React will set `ref.current` to `null`\r\n(or call the ref with `null` if you passed a callback ref).\r\n@see {@link https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom React Docs} | \r\n
| key | \r\nKey | \r\n false | \r\n- | \r\n - | \r\n
| Name | \r\nType | \r\nRequired | \r\nDefault | \r\nDescription | \r\n
|---|---|---|---|---|
| color | \r\nColor | \r\n false | \r\n- | \r\n Determines the color of the circular progress | \r\n
| progress | \r\nnumber | \r\n false | \r\n- | \r\n The value for the current progress | \r\n
| size | \r\n\"default\" , \"extraSmall\" , \"large\" , \"small\" | \r\n false | \r\ndefault | \r\n Determines the size of the stroke width | \r\n
| ariaLabel | \r\nstring | \r\n false | \r\n- | \r\n - | \r\n
| id | \r\nstring | \r\n false | \r\n- | \r\n The identifier that will be passed through to the underlying HTML element | \r\n
| Name | \r\nType | \r\nRequired | \r\nDefault | \r\nDescription | \r\n
|---|---|---|---|---|
| ariaDescription | \r\nstring | \r\n false | \r\n- | \r\n - | \r\n
| ariaLabel | \r\nstring | \r\n false | \r\n- | \r\n - | \r\n
| border | \r\nBorder | \r\n false | \r\n0.5px solid #b9c2c6 | \r\n The border applied to the popupbox | \r\n
| maxWidth | \r\nMaxWidth | \r\n false | \r\n\"300px\" | \r\n Determines the maximum permitted width of the Popup | \r\n
| onHide | \r\n() => void | \r\n false | \r\n- | \r\n A handler that is called whenever the Popup is hidden from view | \r\n
| onShow | \r\n() => void | \r\n false | \r\n- | \r\n A handler that is called whenever the Popup becomes visible | \r\n
| open | \r\nboolean | \r\n false | \r\n- | \r\n Determines whether the Popup should be visible | \r\n
| placement | \r\nPlacement | \r\n false | \r\nbottom-start | \r\n Determines the position of the Popup in relation to the toggle | \r\n
| toggle | \r\nstring , ReactElement | \r\n false | \r\n | \r\n The string or component to use as the Popup's toggle | \r\n
| trigger | \r\nTrigger | \r\n false | \r\nhover | \r\n Determines the type of user interaction that will cause the Popup to show/hide (note: the \"click\" option has been deprecated in favor of \"press\", which maintains the same behavior) | \r\n
| id | \r\nstring | \r\n false | \r\n- | \r\n The identifier that will be passed through to the underlying HTML element | \r\n
| Name | \r\nType | \r\nRequired | \r\nDefault | \r\nDescription | \r\n
|---|---|---|---|---|
| description | \r\nstring | \r\n false | \r\n- | \r\n - | \r\n
| onHide | \r\n() => void | \r\n false | \r\n- | \r\n - | \r\n
| onShow | \r\n() => void | \r\n false | \r\n- | \r\n - | \r\n
| open | \r\nboolean | \r\n false | \r\n- | \r\n - | \r\n
| options | \r\nContextMenuOption[] , ContextMenuSection[] | \r\n true | \r\n- | \r\n - | \r\n
| position | \r\nPosition | \r\n false | \r\n- | \r\n - | \r\n
| positionType | \r\n\"absolute\" , \"relative\" , \"fixed\" | \r\n false | \r\n- | \r\n - | \r\n
| title | \r\nstring | \r\n false | \r\n- | \r\n - | \r\n
| toggle | \r\nstring , ReactElement | \r\n false | \r\n | \r\n - | \r\n
| ariaLabel | \r\nstring | \r\n false | \r\n- | \r\n - | \r\n
| id | \r\nstring | \r\n false | \r\n- | \r\n The identifier that will be passed through to the underlying HTML element | \r\n
| Name | \r\nType | \r\nRequired | \r\nDefault | \r\nDescription | \r\n
|---|---|---|---|---|
| color | \r\nColor | \r\n false | \r\n- | \r\n - | \r\n
| id | \r\nstring | \r\n false | \r\n- | \r\n The identifier that will be passed through to the underlying HTML element | \r\n
| Name | \r\nType | \r\nRequired | \r\nDefault | \r\nDescription | \r\n
|---|---|---|---|---|
| icon | \r\n(props: SVGProps | \r\n false | \r\n- | \r\n An SVG component that will be rendered to the left of the Input's content. Usually used to denote the purpose of the input field (for example, an envelope icon for \"email address\") | \r\n
| label | \r\nFormattedString | \r\n false | \r\n- | \r\n The text that will be displayed as the Input's label | \r\n
| onChange | \r\n(value: string) => void | \r\n false | \r\n- | \r\n A handler that will be invoked each time the content of the Input is changed. Provides the latest value as the only argument\r\n@param value The updated value of the Input\r\n@returns void | \r\n
| placeholder | \r\nstring | \r\n false | \r\n- | \r\n The text that will be displayed as the Input's placeholder when no value is present | \r\n
| value | \r\nstring | \r\n false | \r\n- | \r\n A string that will be used as the value of the Input | \r\n
| clearButtonBehaviour | \r\n\"clear\" , \"clearAndClose\" , \"close\" | \r\n false | \r\nclear | \r\n - | \r\n
| expanded | \r\nboolean | \r\n false | \r\n- | \r\n - | \r\n
| filter | \r\nboolean | \r\n false | \r\ntrue | \r\n - | \r\n
| floatingList | \r\nboolean | \r\n false | \r\n- | \r\n - | \r\n
| floatingListPosition | \r\n{ bottom?: number; left?: number; right?: number; top?: number; } | \r\n false | \r\n{\r\n top: 10\r\n } | \r\n - | \r\n
| loading | \r\nboolean | \r\n false | \r\n- | \r\n - | \r\n
| maxHeight | \r\nnumber | \r\n false | \r\n150 | \r\n - | \r\n
| noMatchesMessage | \r\nFormattedString | \r\n false | \r\nNo matches were found | \r\n - | \r\n
| onFilter | \r\n(filteredOptions: T[]) => void | \r\n false | \r\n- | \r\n - | \r\n
| optionKeyExtractor | \r\nKeyExtractor | \r\n false | \r\n- | \r\n - | \r\n
| optionTemplate | \r\nFC<{ option: T; index: number; filteredOptions: T[]; }> | \r\n false | \r\n({ option }) => | \r\n - | \r\n
| options | \r\nT[] | \r\n true | \r\n- | \r\n - | \r\n
| ariaLabel | \r\nstring | \r\n false | \r\nformattedStringToPlainText(label) | \r\n - | \r\n
| ariaCloseLabel | \r\nstring | \r\n false | \r\nclearButtonBehaviour === 'clear'\r\n ? 'Clear filter'\r\n : clearButtonBehaviour === 'clearAndClose'\r\n ? 'Clear filter and close list'\r\n : 'Close list' | \r\n - | \r\n
| ariaMultiselectable | \r\nboolean | \r\n false | \r\n- | \r\n - | \r\n
| id | \r\nstring | \r\n false | \r\n- | \r\n The identifier that will be passed through to the underlying HTML element | \r\n
| Name | \r\nType | \r\nRequired | \r\nDefault | \r\nDescription | \r\n
|---|---|---|---|---|
| clearButton | \r\nstring , false | \r\n false | \r\nClear | \r\n - | \r\n
| clearId | \r\nstring | \r\n false | \r\n- | \r\n - | \r\n
| onClear | \r\n() => void | \r\n false | \r\n- | \r\n - | \r\n
| onSubmit | \r\n() => void | \r\n false | \r\n- | \r\n - | \r\n
| otherActions | \r\nContextMenuOption[] , ContextMenuSection[] | \r\n false | \r\n- | \r\n - | \r\n
| submitButton | \r\nstring , false | \r\n false | \r\nSubmit | \r\n - | \r\n
| submitId | \r\nstring | \r\n false | \r\n- | \r\n - | \r\n
| width | \r\nWidth | \r\n false | \r\n- | \r\n - | \r\n
| ariaDescription | \r\nstring | \r\n false | \r\n- | \r\n - | \r\n
| ariaLabel | \r\nstring | \r\n false | \r\n- | \r\n - | \r\n
| id | \r\nstring | \r\n false | \r\n- | \r\n The identifier that will be passed through to the underlying HTML element | \r\n
| Name | \r\nType | \r\nRequired | \r\nDefault | \r\nDescription | \r\n
|---|---|---|---|---|
| ariaLabel | \r\nAriaProperties & string | \r\n false | \r\n- | \r\n - | \r\n
| checked | \r\nboolean | \r\n false | \r\nfalse | \r\n Determines whether the CheckBox is rendered in a checked state | \r\n
| description | \r\nFormattedString | \r\n false | \r\n- | \r\n Description for the checkbox | \r\n
| disabled | \r\nboolean | \r\n false | \r\n- | \r\n Determines whether the CheckBox is subject to user interaction | \r\n
| icon | \r\n(props: SVGProps | \r\n false | \r\n- | \r\n An SVG component that will be rendered to the left of the Checkbox's content. Usually used to denote the purpose of the input field (for example, an envelope icon for \"email address\") | \r\n
| id | \r\nstring | \r\n false | \r\n- | \r\n The identifier that will be pass through to the underlying HTML element\r\nThe identifier that will be passed through to the underlying HTML element | \r\n
| label | \r\nFormattedString | \r\n false | \r\n- | \r\n Text that will be displayed as the CheckBox's label (Note: a more complex label can be achieved by instead providing the label as the CheckBox's children) | \r\n
| labelOverflow | \r\n\"ellipsis\" , \"wrap\" | \r\n false | \r\nwrap | \r\n Determines whether the label is allowed to wrap, or if it will be truncated instead | \r\n
| loading | \r\nboolean | \r\n false | \r\n- | \r\n Determines whether the CheckBox should render a loading animation to indicate activity | \r\n
| onChange | \r\n(checked: boolean) => void | \r\n false | \r\n- | \r\n A handler that will be called when the checked state of the CheckBox is changed | \r\n
| size | \r\n\"default\" , \"small\" | \r\n false | \r\ndefault | \r\n Determines the size of the checkbox | \r\n
| status | \r\n\"error\" , \"success\" , \"warning\" | \r\n false | \r\n- | \r\n Determines the state in which the Input should be rendered | \r\n
| statusMessage | \r\nstring | \r\n false | \r\n- | \r\n The text that, if provided, will be displayed beneath the Checkbox, relating to the `status` | \r\n
| Name | \r\nType | \r\nRequired | \r\nDefault | \r\nDescription | \r\n
|---|---|---|---|---|
| date | \r\nDate | \r\n false | \r\n- | \r\n -","readmeFilename":"README.md"} |