ToggleFilter

This component presents a group of options from which one can be selected. Suitable to select a single item from a list where the list is very small. Most often used for filters.

Installation

import { ToggleFilter } from 'uxp/components';

Signature

const ToggleFilter: React.FunctionComponent<IToggleFilterProps>

Properties

Name	Type	Mandatory	Default Value	Example Value
options	IToggleOption[]	Yes	-	-
value	string	Yes	-	-
onChange	(newValue: string) => void	Yes	-	-
className	string	No	-	-
backgroundColor	string	No	-	-
textColor	string	No	-	-
selectedBackgroundColor	string	No	-	-
selectedTextColor	string	No	-	-
disableShadow	boolean	No	-	-
spacingMode	SpacingMode	No	-	-
renderAsDropdown	{ minWidth: number, renderAsPill?: { minWidth?: number, maxWidth?: number } }	No	-	-

Related Types

• IToggleFilterProps

• IToggleOption

• SpacingMode