@commercetools-uikit/view-switcher v19.2.0
ViewSwitcher
Description
ViewSwitchers allow users to toggle between two or more different views of the same, similar or related content items within the same space on screen.
When to use
ViewSwitchers are frequently used to let users toggle between different formatting's, like with a grid view and a table view.
When not to use
Do not use the ViewSwitcher as Tabs Tabs should be used when the content on the page is divided into related sections but without any overlap. See tabs as separate of content.
Do not use the ViewSwitcher as Toggle Toggles are used for “yes/no” or “on/off” binary decisions.
Do's and Don'ts“
- If you use an icon within the ViewSwitcher, each switch needs to have an icon.
- No colored icons are allowed. Only color-solid (black)
- Do not use two lines of text in one switch field.
Installation
yarn add @commercetools-uikit/view-switcher
npm --save install @commercetools-uikit/view-switcher
Additionally install the peer dependencies (if not present)
yarn add react
npm --save install react
Usage
import ViewSwitcher from '@commercetools-uikit/view-switcher';
const Example = () => (
<ViewSwitcher.Group
defaultSelected="Button 2"
onChange={(value) => console.log(value)}
>
<ViewSwitcher.Button isDisabled value="button 1">
View 1
</ViewSwitcher.Button>
<ViewSwitcher.Button value="button 2">View 2</ViewSwitcher.Button>
<ViewSwitcher.Button value="button 3">View 3</ViewSwitcher.Button>
</ViewSwitcher.Group>
);
export default Example;
Properties
ViewSwitcher.Group
Props | Type | Required | Default | Description |
---|---|---|---|---|
isCondensed | boolean | Indicates that the view switcher can be reduced to save space | ||
children | ReactNode | ✅ | Pass one or more ViewSwitcher.Button components | |
onChange | Function See signature. | Will be triggered whenever a ViewSwitcher.Button is clicked. Called with the ViewSwitcherButton value | ||
defaultSelected | string | ✅ | Indicates the default selected button |
Signatures
Signature onChange
(value: string) => void
ViewSwitcher.Button
Props | Type | Required | Default | Description |
---|---|---|---|---|
isDisabled | boolean | If true , indicates that the button is in a disabled state. | ||
children | ReactNode | ✅ | Indicates the label of the ViewSwitcher.Button . | |
onClick | Function See signature. | Will be triggered whenever a button is clicked. | ||
value | string | ✅ | The value identifying this ViewSwitcher.Button . |
Signatures
Signature onClick
(value: string) => void
Invariants
- The
ViewSwitcher.Group
must have at least oneViewSwitcher.Button
element aschildren
5 days ago
3 days ago
4 days ago
4 days ago
8 days ago
7 days ago
8 days ago
8 days ago
8 days ago
11 days ago
12 days ago
12 days ago
13 days ago
12 days ago
14 days ago
15 days ago
19 days ago
19 days ago
19 days ago
21 days ago
21 days ago
21 days ago
21 days ago
25 days ago
26 days ago
27 days ago
29 days ago
29 days ago
29 days ago
29 days ago
29 days ago
1 month ago
1 month ago
1 month ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
7 months ago
9 months ago
9 months ago
9 months ago
6 months ago
9 months ago
10 months ago
10 months ago
8 months ago
8 months ago
7 months ago
9 months ago
10 months ago
9 months ago
6 months ago
9 months ago
8 months ago
10 months ago
6 months ago
6 months ago
6 months ago
9 months ago
10 months ago
6 months ago
9 months ago
9 months ago
6 months ago
7 months ago
9 months ago
10 months ago
10 months ago
7 months ago
9 months ago
6 months ago
6 months ago
8 months ago
7 months ago
9 months ago
7 months ago
8 months ago
7 months ago
10 months ago
7 months ago
7 months ago
9 months ago
8 months ago
8 months ago
6 months ago
7 months ago
6 months ago
6 months ago
7 months ago
10 months ago
7 months ago
8 months ago
8 months ago
8 months ago
9 months ago
8 months ago
8 months ago
8 months ago
7 months ago
6 months ago
9 months ago
10 months ago
7 months ago
7 months ago
6 months ago
9 months ago
10 months ago
6 months ago
10 months ago
10 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
12 months ago
12 months ago
12 months ago
12 months ago
12 months ago
12 months ago
12 months ago
12 months ago
12 months ago
12 months ago
12 months ago
12 months ago
12 months ago
12 months ago
12 months ago
12 months ago
12 months ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
2 years ago
2 years ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
2 years ago
2 years ago
2 years ago
1 year ago
2 years ago
1 year ago
1 year ago
1 year ago
1 year ago
2 years ago
1 year ago
1 year ago
1 year ago
2 years ago
2 years ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago