@fluentui/react-switch 0.0.0-nightly-20220302-0405.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.json +1477 -0
- package/CHANGELOG.md +442 -0
- package/LICENSE +15 -0
- package/MIGRATION.md +28 -0
- package/README.md +32 -0
- package/Spec.md +134 -0
- package/dist/react-switch.d.ts +106 -0
- package/lib/Switch.d.ts +1 -0
- package/lib/Switch.js +2 -0
- package/lib/Switch.js.map +1 -0
- package/lib/components/Switch/Switch.d.ts +6 -0
- package/lib/components/Switch/Switch.js +15 -0
- package/lib/components/Switch/Switch.js.map +1 -0
- package/lib/components/Switch/Switch.types.d.ts +65 -0
- package/lib/components/Switch/Switch.types.js +2 -0
- package/lib/components/Switch/Switch.types.js.map +1 -0
- package/lib/components/Switch/index.d.ts +5 -0
- package/lib/components/Switch/index.js +6 -0
- package/lib/components/Switch/index.js.map +1 -0
- package/lib/components/Switch/renderSwitch.d.ts +5 -0
- package/lib/components/Switch/renderSwitch.js +22 -0
- package/lib/components/Switch/renderSwitch.js.map +1 -0
- package/lib/components/Switch/useSwitch.d.ts +12 -0
- package/lib/components/Switch/useSwitch.js +79 -0
- package/lib/components/Switch/useSwitch.js.map +1 -0
- package/lib/components/Switch/useSwitchStyles.d.ts +9 -0
- package/lib/components/Switch/useSwitchStyles.js +194 -0
- package/lib/components/Switch/useSwitchStyles.js.map +1 -0
- package/lib/index.d.ts +2 -0
- package/lib/index.js +2 -0
- package/lib/index.js.map +1 -0
- package/lib/tsdoc-metadata.json +11 -0
- package/lib-commonjs/Switch.d.ts +1 -0
- package/lib-commonjs/Switch.js +10 -0
- package/lib-commonjs/Switch.js.map +1 -0
- package/lib-commonjs/components/Switch/Switch.d.ts +6 -0
- package/lib-commonjs/components/Switch/Switch.js +26 -0
- package/lib-commonjs/components/Switch/Switch.js.map +1 -0
- package/lib-commonjs/components/Switch/Switch.types.d.ts +65 -0
- package/lib-commonjs/components/Switch/Switch.types.js +6 -0
- package/lib-commonjs/components/Switch/Switch.types.js.map +1 -0
- package/lib-commonjs/components/Switch/index.d.ts +5 -0
- package/lib-commonjs/components/Switch/index.js +18 -0
- package/lib-commonjs/components/Switch/index.js.map +1 -0
- package/lib-commonjs/components/Switch/renderSwitch.d.ts +5 -0
- package/lib-commonjs/components/Switch/renderSwitch.js +33 -0
- package/lib-commonjs/components/Switch/renderSwitch.js.map +1 -0
- package/lib-commonjs/components/Switch/useSwitch.d.ts +12 -0
- package/lib-commonjs/components/Switch/useSwitch.js +92 -0
- package/lib-commonjs/components/Switch/useSwitch.js.map +1 -0
- package/lib-commonjs/components/Switch/useSwitchStyles.d.ts +9 -0
- package/lib-commonjs/components/Switch/useSwitchStyles.js +206 -0
- package/lib-commonjs/components/Switch/useSwitchStyles.js.map +1 -0
- package/lib-commonjs/index.d.ts +2 -0
- package/lib-commonjs/index.js +10 -0
- package/lib-commonjs/index.js.map +1 -0
- package/package.json +66 -0
package/Spec.md
ADDED
@@ -0,0 +1,134 @@
|
|
1
|
+
# @fluentui/react-switch Spec
|
2
|
+
|
3
|
+
## Background
|
4
|
+
|
5
|
+
Previously called Toggle in OUFR and Checkbox in Stardust, the Switch component
|
6
|
+
introduces a quick way of switching between Boolean values by pressing the thumb.
|
7
|
+
|
8
|
+
## Prior Art
|
9
|
+
|
10
|
+
Upon investigating other component libraries, it was decided to:
|
11
|
+
|
12
|
+
1. Change the name to Switch
|
13
|
+
|
14
|
+
Amongst other major component libraries (`Material UI`, `Ant Design`, `Evergreen`, and `Fast`) Switch appears to be a more prominently used name.
|
15
|
+
|
16
|
+
[Open UI](https://open-ui.org/components/switch)
|
17
|
+
[Epic Issue](https://github.com/microsoft/fluentui/issues/19409)
|
18
|
+
|
19
|
+
## Sample Code
|
20
|
+
|
21
|
+
```jsx=
|
22
|
+
<Switch checked />
|
23
|
+
<Switch checked disabled/>
|
24
|
+
<Switch checked onChange={onChange}/>
|
25
|
+
```
|
26
|
+
|
27
|
+
## API
|
28
|
+
|
29
|
+
| Name | V0 | V8 | Description |
|
30
|
+
| -------------- | ------- | ------- | --------------------------------------------------------------------------- |
|
31
|
+
| checked | ✓ | ✓ | The value of the Switch. If `true` then the Switch will be enabled. |
|
32
|
+
| defaultChecked | ✓ | ✓ | The default value of the Switch. If `true` then the Switch will be enabled. |
|
33
|
+
| disabled | ✓ | ✓ | Whether the Switch should be disabled. |
|
34
|
+
| onChange | ✓ | ✓ | Callback to be called when the checked state value changes. |
|
35
|
+
|
36
|
+
## Migration
|
37
|
+
|
38
|
+
<img src="https://img.shields.io/badge/Used%20in-v0-orange" alt="drawing" width="100"/>
|
39
|
+
|
40
|
+
| Name | Description | Reason |
|
41
|
+
| ------------- | ----------------------------------------------------------------------------- | ------------------------------------------------------------------ |
|
42
|
+
| indicator | A checkbox's indicator icon can be customized. | Toggle will have a slot for the thumb. |
|
43
|
+
| label | A checkbox can render a label next to its indicator. | To be decided on how it is handled |
|
44
|
+
| labelPosition | Determines whether the label should be positioned before or after the Switch. | To be decided on how it is handled |
|
45
|
+
| onClick | Called after a checkbox is clicked. | The native input element handles onClick. |
|
46
|
+
| toggle | A checkbox can be formatted to show an "on or off" choice. | Toggle is separated from checkbox due to vast styling differences. |
|
47
|
+
|
48
|
+
<img src="https://img.shields.io/badge/Used%20in-v8-blue" alt="drawing" width="120"/>
|
49
|
+
|
50
|
+
| Name | Description | Reason |
|
51
|
+
| ------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------- |
|
52
|
+
| componentRef | Optional callback to access the IToggle interface. | Not used in converged components |
|
53
|
+
| label | A label for the toggle. | To be decided on how it is handled. |
|
54
|
+
| labelPosition | Determines whether the label should be positioned before or after the Switch. | To be decided on how it is handled |
|
55
|
+
| onText | Text to display when toggle is ON. | To be decided. |
|
56
|
+
| offText | Text to display when toggle is OFF. | To be decided. |
|
57
|
+
| ariaLabel | Text for screen-reader to announce as the name of the toggle. | Toggle has a hidden input element. |
|
58
|
+
| onAriaLabel | @deprecated Use `ariaLabel` for name, and let the metadata convey state | deprecated |
|
59
|
+
| offAriaLabel | @deprecated Use `ariaLabel` for name, and let the metadata convey state | deprecated |
|
60
|
+
| inlineLabel | Whether the label (not the onText/offText) should be positioned inline with the toggle control. | It can be manually styled |
|
61
|
+
| onChanged | @deprecated Use `onChange` instead. | deprecated |
|
62
|
+
| theme | Theme provided by HOC. | Not used in converged components |
|
63
|
+
| styles | Optional styles for the component. | Not used in converged components |
|
64
|
+
| role | Whether to use the 'switch' role (ARIA 1.1) or the 'checkbox' role (ARIA 1.0). | Toggle has a hidden input element. |
|
65
|
+
|
66
|
+
## Structure
|
67
|
+
|
68
|
+
- _**Public**_
|
69
|
+
|
70
|
+
```jsx=
|
71
|
+
<Switch checked={true}/>
|
72
|
+
```
|
73
|
+
|
74
|
+
- _**Internal**_
|
75
|
+
|
76
|
+
```jsx=
|
77
|
+
<slots.root {...slotProps.root}>
|
78
|
+
<slots.track {...slotProps.track} />
|
79
|
+
<slots.thumbWrapper {...slotProps.thumbWrapper}>
|
80
|
+
<slots.thumb {...slotProps.thumb} />
|
81
|
+
</slots.thumbWrapper>
|
82
|
+
<input type="checkbox" />
|
83
|
+
</slots.root>;
|
84
|
+
```
|
85
|
+
|
86
|
+
- _**DOM**_
|
87
|
+
|
88
|
+
```jsx=
|
89
|
+
<div className="fui-Switch">
|
90
|
+
<div className="fui-Switch-track" />
|
91
|
+
<div className="fui-Switch-thumbWrapper">
|
92
|
+
<div className="fui-Switch-thumb" />
|
93
|
+
</div>
|
94
|
+
<input type="checkbox" />
|
95
|
+
</div>;
|
96
|
+
```
|
97
|
+
|
98
|
+
## Behaviors
|
99
|
+
|
100
|
+
### Component States
|
101
|
+
|
102
|
+
- **Disabled**
|
103
|
+
- When disabled, all events are ignored, and the Switch's value never updates.
|
104
|
+
- Does not allow focus.
|
105
|
+
- The cursor changes to `not-allowed`.
|
106
|
+
- **Checked**
|
107
|
+
- Switch is off when the “thumb” is indicated on the left.
|
108
|
+
- Switch is on when the thumb is indicated on the right.
|
109
|
+
- This is switched in RTL.
|
110
|
+
- When toggling switches on and off, the on state should change using the checked state appearance styles.
|
111
|
+
|
112
|
+
### Hover
|
113
|
+
|
114
|
+
The cursor changes to the hand icon. The outline of the Switch and thumb should also darken. This helps reinforce that the area is interactive.
|
115
|
+
|
116
|
+
### Keyboard
|
117
|
+
|
118
|
+
Since the Switch is an interactive component, it must be focusable and keyboard accessible.
|
119
|
+
The expected keyboard shortcut for activating a Switch is the spacebar key.
|
120
|
+
|
121
|
+
1. Use the spacebar to switch off
|
122
|
+
2. Use the spacebar to switch on
|
123
|
+
|
124
|
+
### Cursor
|
125
|
+
|
126
|
+
Clicking triggers toggling the state change. The thumb animates from right to left [on > off] and left to right [off > on]
|
127
|
+
|
128
|
+
### Touch
|
129
|
+
|
130
|
+
Touch follows the same behavior as the cursor.
|
131
|
+
|
132
|
+
## Accessibility
|
133
|
+
|
134
|
+
Accessibility will be handled by the hidden `<input type="checkbox" />` element and follows the same pattern.
|
@@ -0,0 +1,106 @@
|
|
1
|
+
import type { ComponentProps } from '@fluentui/react-utilities';
|
2
|
+
import type { ComponentState } from '@fluentui/react-utilities';
|
3
|
+
import type { ForwardRefComponent } from '@fluentui/react-utilities';
|
4
|
+
import { Label } from '@fluentui/react-label';
|
5
|
+
import * as React_2 from 'react';
|
6
|
+
import type { Slot } from '@fluentui/react-utilities';
|
7
|
+
|
8
|
+
/**
|
9
|
+
* Render a Switch component by passing the state defined props to the appropriate slots.
|
10
|
+
*/
|
11
|
+
export declare const renderSwitch_unstable: (state: SwitchState) => JSX.Element;
|
12
|
+
|
13
|
+
/**
|
14
|
+
* Switches enable users to trigger an option on or off through pressing the component.
|
15
|
+
*/
|
16
|
+
export declare const Switch: ForwardRefComponent<SwitchProps>;
|
17
|
+
|
18
|
+
export declare const switchClassName: string;
|
19
|
+
|
20
|
+
export declare const switchClassNames: {
|
21
|
+
[SlotName in keyof SwitchSlots]-?: string;
|
22
|
+
};
|
23
|
+
|
24
|
+
declare type SwitchCommons = {
|
25
|
+
/**
|
26
|
+
* Defines the controlled checked state of the Switch.
|
27
|
+
* If passed, Switch ignores the `defaultChecked` property.
|
28
|
+
* This should only be used if the checked state is to be controlled at a higher level and there is a plan to pass the
|
29
|
+
* correct value based on handling `onChange` events and re-rendering.
|
30
|
+
* @default false
|
31
|
+
*/
|
32
|
+
checked?: boolean;
|
33
|
+
/**
|
34
|
+
* The position of the label relative to the Switch.
|
35
|
+
*
|
36
|
+
* @default after
|
37
|
+
*/
|
38
|
+
labelPosition: 'above' | 'after' | 'before';
|
39
|
+
};
|
40
|
+
|
41
|
+
export declare type SwitchOnChangeData = {
|
42
|
+
checked: boolean;
|
43
|
+
};
|
44
|
+
|
45
|
+
/**
|
46
|
+
* Switch Props
|
47
|
+
*/
|
48
|
+
export declare type SwitchProps = Omit<ComponentProps<Partial<SwitchSlots>, 'input'>, 'onChange'> & Partial<SwitchCommons> & {
|
49
|
+
/**
|
50
|
+
* Defines whether the Switch is initially in a checked state or not when rendered.
|
51
|
+
* @default false
|
52
|
+
*/
|
53
|
+
defaultChecked?: boolean;
|
54
|
+
/**
|
55
|
+
* Callback to be called when the checked state value changes.
|
56
|
+
*/
|
57
|
+
onChange?: (ev: React_2.ChangeEvent<HTMLInputElement>, data: SwitchOnChangeData) => void;
|
58
|
+
};
|
59
|
+
|
60
|
+
export declare type SwitchSlots = {
|
61
|
+
/**
|
62
|
+
* The root element of the Switch.
|
63
|
+
*
|
64
|
+
* The root slot receives the `className` and `style` specified directly on the `<Switch>` tag.
|
65
|
+
* All other native props will be applied to the primary slot: `input`.
|
66
|
+
*/
|
67
|
+
root: NonNullable<Slot<'div'>>;
|
68
|
+
/**
|
69
|
+
* The track and the thumb sliding over it indicating the on and off status of the Switch.
|
70
|
+
*/
|
71
|
+
indicator: NonNullable<Slot<'div'>>;
|
72
|
+
/**
|
73
|
+
* Hidden input that handles the Switch's functionality.
|
74
|
+
*
|
75
|
+
* This is the PRIMARY slot: all native properties specified directly on the `<Switch>` tag will be applied to this
|
76
|
+
* slot, except `className` and `style`, which remain on the root slot.
|
77
|
+
*/
|
78
|
+
input: NonNullable<Slot<'input'>>;
|
79
|
+
/**
|
80
|
+
* The Switch's label.
|
81
|
+
*/
|
82
|
+
label?: Slot<typeof Label>;
|
83
|
+
};
|
84
|
+
|
85
|
+
/**
|
86
|
+
* State used in rendering Switch
|
87
|
+
*/
|
88
|
+
export declare type SwitchState = ComponentState<SwitchSlots> & SwitchCommons;
|
89
|
+
|
90
|
+
/**
|
91
|
+
* Create the state required to render Switch.
|
92
|
+
*
|
93
|
+
* The returned state can be modified with hooks such as useSwitchStyles_unstable,
|
94
|
+
* before being passed to renderSwitch_unstable.
|
95
|
+
*
|
96
|
+
* @param props - props from this instance of Switch
|
97
|
+
* @param ref - reference to `<input>` element of Switch
|
98
|
+
*/
|
99
|
+
export declare const useSwitch_unstable: (props: SwitchProps, ref: React_2.Ref<HTMLInputElement>) => SwitchState;
|
100
|
+
|
101
|
+
/**
|
102
|
+
* Apply styling to the Switch slots based on the state
|
103
|
+
*/
|
104
|
+
export declare const useSwitchStyles_unstable: (state: SwitchState) => SwitchState;
|
105
|
+
|
106
|
+
export { }
|
package/lib/Switch.d.ts
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
export * from './components/Switch/index';
|
package/lib/Switch.js
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
{"version":3,"file":"Switch.js","sourceRoot":"../src/","sources":["Switch.ts"],"names":[],"mappings":"AAAA,cAAc,2BAA2B,CAAC","sourcesContent":["export * from './components/Switch/index';\n"]}
|
@@ -0,0 +1,6 @@
|
|
1
|
+
import type { SwitchProps } from './Switch.types';
|
2
|
+
import type { ForwardRefComponent } from '@fluentui/react-utilities';
|
3
|
+
/**
|
4
|
+
* Switches enable users to trigger an option on or off through pressing the component.
|
5
|
+
*/
|
6
|
+
export declare const Switch: ForwardRefComponent<SwitchProps>;
|
@@ -0,0 +1,15 @@
|
|
1
|
+
import * as React from 'react';
|
2
|
+
import { useSwitch_unstable } from './useSwitch';
|
3
|
+
import { renderSwitch_unstable } from './renderSwitch';
|
4
|
+
import { useSwitchStyles_unstable } from './useSwitchStyles';
|
5
|
+
/**
|
6
|
+
* Switches enable users to trigger an option on or off through pressing the component.
|
7
|
+
*/
|
8
|
+
|
9
|
+
export const Switch = /*#__PURE__*/React.forwardRef((props, ref) => {
|
10
|
+
const state = useSwitch_unstable(props, ref);
|
11
|
+
useSwitchStyles_unstable(state);
|
12
|
+
return renderSwitch_unstable(state);
|
13
|
+
});
|
14
|
+
Switch.displayName = 'Switch';
|
15
|
+
//# sourceMappingURL=Switch.js.map
|
@@ -0,0 +1 @@
|
|
1
|
+
{"version":3,"sources":["components/Switch/Switch.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAZ,MAAuB,OAAvB;AACA,SAAS,kBAAT,QAAmC,aAAnC;AACA,SAAS,qBAAT,QAAsC,gBAAtC;AACA,SAAS,wBAAT,QAAyC,mBAAzC;AAIA;;AAEG;;AACH,OAAO,MAAM,MAAM,gBAAqC,KAAK,CAAC,UAAN,CAAiB,CAAC,KAAD,EAAQ,GAAR,KAAe;AACtF,QAAM,KAAK,GAAG,kBAAkB,CAAC,KAAD,EAAQ,GAAR,CAAhC;AAEA,EAAA,wBAAwB,CAAC,KAAD,CAAxB;AAEA,SAAO,qBAAqB,CAAC,KAAD,CAA5B;AACD,CANuD,CAAjD;AAQP,MAAM,CAAC,WAAP,GAAqB,QAArB","sourcesContent":["import * as React from 'react';\nimport { useSwitch_unstable } from './useSwitch';\nimport { renderSwitch_unstable } from './renderSwitch';\nimport { useSwitchStyles_unstable } from './useSwitchStyles';\nimport type { SwitchProps } from './Switch.types';\nimport type { ForwardRefComponent } from '@fluentui/react-utilities';\n\n/**\n * Switches enable users to trigger an option on or off through pressing the component.\n */\nexport const Switch: ForwardRefComponent<SwitchProps> = React.forwardRef((props, ref) => {\n const state = useSwitch_unstable(props, ref);\n\n useSwitchStyles_unstable(state);\n\n return renderSwitch_unstable(state);\n});\n\nSwitch.displayName = 'Switch';\n"],"sourceRoot":"../src/"}
|
@@ -0,0 +1,65 @@
|
|
1
|
+
import * as React from 'react';
|
2
|
+
import { Label } from '@fluentui/react-label';
|
3
|
+
import type { ComponentProps, ComponentState, Slot } from '@fluentui/react-utilities';
|
4
|
+
export declare type SwitchSlots = {
|
5
|
+
/**
|
6
|
+
* The root element of the Switch.
|
7
|
+
*
|
8
|
+
* The root slot receives the `className` and `style` specified directly on the `<Switch>` tag.
|
9
|
+
* All other native props will be applied to the primary slot: `input`.
|
10
|
+
*/
|
11
|
+
root: NonNullable<Slot<'div'>>;
|
12
|
+
/**
|
13
|
+
* The track and the thumb sliding over it indicating the on and off status of the Switch.
|
14
|
+
*/
|
15
|
+
indicator: NonNullable<Slot<'div'>>;
|
16
|
+
/**
|
17
|
+
* Hidden input that handles the Switch's functionality.
|
18
|
+
*
|
19
|
+
* This is the PRIMARY slot: all native properties specified directly on the `<Switch>` tag will be applied to this
|
20
|
+
* slot, except `className` and `style`, which remain on the root slot.
|
21
|
+
*/
|
22
|
+
input: NonNullable<Slot<'input'>>;
|
23
|
+
/**
|
24
|
+
* The Switch's label.
|
25
|
+
*/
|
26
|
+
label?: Slot<typeof Label>;
|
27
|
+
};
|
28
|
+
declare type SwitchCommons = {
|
29
|
+
/**
|
30
|
+
* Defines the controlled checked state of the Switch.
|
31
|
+
* If passed, Switch ignores the `defaultChecked` property.
|
32
|
+
* This should only be used if the checked state is to be controlled at a higher level and there is a plan to pass the
|
33
|
+
* correct value based on handling `onChange` events and re-rendering.
|
34
|
+
* @default false
|
35
|
+
*/
|
36
|
+
checked?: boolean;
|
37
|
+
/**
|
38
|
+
* The position of the label relative to the Switch.
|
39
|
+
*
|
40
|
+
* @default after
|
41
|
+
*/
|
42
|
+
labelPosition: 'above' | 'after' | 'before';
|
43
|
+
};
|
44
|
+
export declare type SwitchOnChangeData = {
|
45
|
+
checked: boolean;
|
46
|
+
};
|
47
|
+
/**
|
48
|
+
* Switch Props
|
49
|
+
*/
|
50
|
+
export declare type SwitchProps = Omit<ComponentProps<Partial<SwitchSlots>, 'input'>, 'onChange'> & Partial<SwitchCommons> & {
|
51
|
+
/**
|
52
|
+
* Defines whether the Switch is initially in a checked state or not when rendered.
|
53
|
+
* @default false
|
54
|
+
*/
|
55
|
+
defaultChecked?: boolean;
|
56
|
+
/**
|
57
|
+
* Callback to be called when the checked state value changes.
|
58
|
+
*/
|
59
|
+
onChange?: (ev: React.ChangeEvent<HTMLInputElement>, data: SwitchOnChangeData) => void;
|
60
|
+
};
|
61
|
+
/**
|
62
|
+
* State used in rendering Switch
|
63
|
+
*/
|
64
|
+
export declare type SwitchState = ComponentState<SwitchSlots> & SwitchCommons;
|
65
|
+
export {};
|
@@ -0,0 +1 @@
|
|
1
|
+
{"version":3,"file":"Switch.types.js","sourceRoot":"../src/","sources":["components/Switch/Switch.types.ts"],"names":[],"mappings":"","sourcesContent":["import * as React from 'react';\nimport { Label } from '@fluentui/react-label';\nimport type { ComponentProps, ComponentState, Slot } from '@fluentui/react-utilities';\n\nexport type SwitchSlots = {\n /**\n * The root element of the Switch.\n *\n * The root slot receives the `className` and `style` specified directly on the `<Switch>` tag.\n * All other native props will be applied to the primary slot: `input`.\n */\n root: NonNullable<Slot<'div'>>;\n\n /**\n * The track and the thumb sliding over it indicating the on and off status of the Switch.\n */\n indicator: NonNullable<Slot<'div'>>;\n\n /**\n * Hidden input that handles the Switch's functionality.\n *\n * This is the PRIMARY slot: all native properties specified directly on the `<Switch>` tag will be applied to this\n * slot, except `className` and `style`, which remain on the root slot.\n */\n input: NonNullable<Slot<'input'>>;\n\n /**\n * The Switch's label.\n */\n label?: Slot<typeof Label>;\n};\n\ntype SwitchCommons = {\n /**\n * Defines the controlled checked state of the Switch.\n * If passed, Switch ignores the `defaultChecked` property.\n * This should only be used if the checked state is to be controlled at a higher level and there is a plan to pass the\n * correct value based on handling `onChange` events and re-rendering.\n * @default false\n */\n checked?: boolean;\n\n /**\n * The position of the label relative to the Switch.\n *\n * @default after\n */\n labelPosition: 'above' | 'after' | 'before';\n};\n\nexport type SwitchOnChangeData = {\n checked: boolean;\n};\n\n/**\n * Switch Props\n */\nexport type SwitchProps = Omit<ComponentProps<Partial<SwitchSlots>, 'input'>, 'onChange'> &\n Partial<SwitchCommons> & {\n /**\n * Defines whether the Switch is initially in a checked state or not when rendered.\n * @default false\n */\n defaultChecked?: boolean;\n\n /**\n * Callback to be called when the checked state value changes.\n */\n onChange?: (ev: React.ChangeEvent<HTMLInputElement>, data: SwitchOnChangeData) => void;\n };\n\n/**\n * State used in rendering Switch\n */\nexport type SwitchState = ComponentState<SwitchSlots> & SwitchCommons;\n"]}
|
@@ -0,0 +1 @@
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"../src/","sources":["components/Switch/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,gBAAgB,CAAC;AAC/B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,aAAa,CAAC;AAC5B,cAAc,mBAAmB,CAAC","sourcesContent":["export * from './Switch';\nexport * from './Switch.types';\nexport * from './renderSwitch';\nexport * from './useSwitch';\nexport * from './useSwitchStyles';\n"]}
|
@@ -0,0 +1,22 @@
|
|
1
|
+
import * as React from 'react';
|
2
|
+
import { getSlots } from '@fluentui/react-utilities';
|
3
|
+
/**
|
4
|
+
* Render a Switch component by passing the state defined props to the appropriate slots.
|
5
|
+
*/
|
6
|
+
|
7
|
+
export const renderSwitch_unstable = state => {
|
8
|
+
const {
|
9
|
+
slots,
|
10
|
+
slotProps
|
11
|
+
} = getSlots(state);
|
12
|
+
const {
|
13
|
+
labelPosition
|
14
|
+
} = state;
|
15
|
+
return /*#__PURE__*/React.createElement(slots.root, { ...slotProps.root
|
16
|
+
}, /*#__PURE__*/React.createElement(slots.input, { ...slotProps.input
|
17
|
+
}), labelPosition !== 'after' && slots.label && /*#__PURE__*/React.createElement(slots.label, { ...slotProps.label
|
18
|
+
}), /*#__PURE__*/React.createElement(slots.indicator, { ...slotProps.indicator
|
19
|
+
}), labelPosition === 'after' && slots.label && /*#__PURE__*/React.createElement(slots.label, { ...slotProps.label
|
20
|
+
}));
|
21
|
+
};
|
22
|
+
//# sourceMappingURL=renderSwitch.js.map
|
@@ -0,0 +1 @@
|
|
1
|
+
{"version":3,"sources":["components/Switch/renderSwitch.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAZ,MAAuB,OAAvB;AACA,SAAS,QAAT,QAAyB,2BAAzB;AAGA;;AAEG;;AACH,OAAO,MAAM,qBAAqB,GAAI,KAAD,IAAuB;AAC1D,QAAM;AAAE,IAAA,KAAF;AAAS,IAAA;AAAT,MAAuB,QAAQ,CAAc,KAAd,CAArC;AACA,QAAM;AAAE,IAAA;AAAF,MAAoB,KAA1B;AAEA,sBACE,KAAA,CAAA,aAAA,CAAC,KAAK,CAAC,IAAP,EAAW,EAAA,GAAK,SAAS,CAAC;AAAf,GAAX,eACE,KAAA,CAAA,aAAA,CAAC,KAAK,CAAC,KAAP,EAAY,EAAA,GAAK,SAAS,CAAC;AAAf,GAAZ,CADF,EAEG,aAAa,KAAK,OAAlB,IAA6B,KAAK,CAAC,KAAnC,iBAA4C,KAAA,CAAA,aAAA,CAAC,KAAK,CAAC,KAAP,EAAY,EAAA,GAAK,SAAS,CAAC;AAAf,GAAZ,CAF/C,eAGE,KAAA,CAAA,aAAA,CAAC,KAAK,CAAC,SAAP,EAAgB,EAAA,GAAK,SAAS,CAAC;AAAf,GAAhB,CAHF,EAIG,aAAa,KAAK,OAAlB,IAA6B,KAAK,CAAC,KAAnC,iBAA4C,KAAA,CAAA,aAAA,CAAC,KAAK,CAAC,KAAP,EAAY,EAAA,GAAK,SAAS,CAAC;AAAf,GAAZ,CAJ/C,CADF;AAQD,CAZM","sourcesContent":["import * as React from 'react';\nimport { getSlots } from '@fluentui/react-utilities';\nimport type { SwitchState, SwitchSlots } from './Switch.types';\n\n/**\n * Render a Switch component by passing the state defined props to the appropriate slots.\n */\nexport const renderSwitch_unstable = (state: SwitchState) => {\n const { slots, slotProps } = getSlots<SwitchSlots>(state);\n const { labelPosition } = state;\n\n return (\n <slots.root {...slotProps.root}>\n <slots.input {...slotProps.input} />\n {labelPosition !== 'after' && slots.label && <slots.label {...slotProps.label} />}\n <slots.indicator {...slotProps.indicator} />\n {labelPosition === 'after' && slots.label && <slots.label {...slotProps.label} />}\n </slots.root>\n );\n};\n"],"sourceRoot":"../src/"}
|
@@ -0,0 +1,12 @@
|
|
1
|
+
import * as React from 'react';
|
2
|
+
import type { SwitchProps, SwitchState } from './Switch.types';
|
3
|
+
/**
|
4
|
+
* Create the state required to render Switch.
|
5
|
+
*
|
6
|
+
* The returned state can be modified with hooks such as useSwitchStyles_unstable,
|
7
|
+
* before being passed to renderSwitch_unstable.
|
8
|
+
*
|
9
|
+
* @param props - props from this instance of Switch
|
10
|
+
* @param ref - reference to `<input>` element of Switch
|
11
|
+
*/
|
12
|
+
export declare const useSwitch_unstable: (props: SwitchProps, ref: React.Ref<HTMLInputElement>) => SwitchState;
|
@@ -0,0 +1,79 @@
|
|
1
|
+
import * as React from 'react';
|
2
|
+
import { CircleFilled } from '@fluentui/react-icons';
|
3
|
+
import { Label } from '@fluentui/react-label';
|
4
|
+
import { getPartitionedNativeProps, resolveShorthand, useId, useMergedEventCallbacks } from '@fluentui/react-utilities';
|
5
|
+
/**
|
6
|
+
* Create the state required to render Switch.
|
7
|
+
*
|
8
|
+
* The returned state can be modified with hooks such as useSwitchStyles_unstable,
|
9
|
+
* before being passed to renderSwitch_unstable.
|
10
|
+
*
|
11
|
+
* @param props - props from this instance of Switch
|
12
|
+
* @param ref - reference to `<input>` element of Switch
|
13
|
+
*/
|
14
|
+
|
15
|
+
export const useSwitch_unstable = (props, ref) => {
|
16
|
+
const {
|
17
|
+
checked,
|
18
|
+
defaultChecked,
|
19
|
+
disabled,
|
20
|
+
labelPosition = 'after',
|
21
|
+
onChange,
|
22
|
+
required
|
23
|
+
} = props;
|
24
|
+
const nativeProps = getPartitionedNativeProps({
|
25
|
+
props,
|
26
|
+
primarySlotTagName: 'input',
|
27
|
+
excludedPropNames: ['checked', 'defaultChecked', 'onChange']
|
28
|
+
});
|
29
|
+
const id = useId('switch-', nativeProps.primary.id);
|
30
|
+
const root = resolveShorthand(props.root, {
|
31
|
+
defaultProps: nativeProps.root,
|
32
|
+
required: true
|
33
|
+
});
|
34
|
+
const indicator = resolveShorthand(props.indicator, {
|
35
|
+
defaultProps: {
|
36
|
+
'aria-hidden': true,
|
37
|
+
children: /*#__PURE__*/React.createElement(CircleFilled, null)
|
38
|
+
},
|
39
|
+
required: true
|
40
|
+
});
|
41
|
+
const input = resolveShorthand(props.input, {
|
42
|
+
defaultProps: {
|
43
|
+
checked,
|
44
|
+
defaultChecked,
|
45
|
+
id,
|
46
|
+
ref,
|
47
|
+
role: 'switch',
|
48
|
+
type: 'checkbox',
|
49
|
+
...nativeProps.primary
|
50
|
+
},
|
51
|
+
required: true
|
52
|
+
});
|
53
|
+
input.onChange = useMergedEventCallbacks(input.onChange, ev => onChange === null || onChange === void 0 ? void 0 : onChange(ev, {
|
54
|
+
checked: ev.currentTarget.checked
|
55
|
+
}));
|
56
|
+
const label = resolveShorthand(props.label, {
|
57
|
+
defaultProps: {
|
58
|
+
disabled,
|
59
|
+
htmlFor: id,
|
60
|
+
required,
|
61
|
+
size: 'medium'
|
62
|
+
}
|
63
|
+
});
|
64
|
+
return {
|
65
|
+
labelPosition,
|
66
|
+
//Slots definition
|
67
|
+
components: {
|
68
|
+
root: 'div',
|
69
|
+
indicator: 'div',
|
70
|
+
input: 'input',
|
71
|
+
label: Label
|
72
|
+
},
|
73
|
+
root,
|
74
|
+
indicator,
|
75
|
+
input,
|
76
|
+
label
|
77
|
+
};
|
78
|
+
};
|
79
|
+
//# sourceMappingURL=useSwitch.js.map
|
@@ -0,0 +1 @@
|
|
1
|
+
{"version":3,"sources":["components/Switch/useSwitch.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAZ,MAAuB,OAAvB;AACA,SAAS,YAAT,QAA6B,uBAA7B;AACA,SAAS,KAAT,QAAsB,uBAAtB;AACA,SAAS,yBAAT,EAAoC,gBAApC,EAAsD,KAAtD,EAA6D,uBAA7D,QAA4F,2BAA5F;AAGA;;;;;;;;AAQG;;AACH,OAAO,MAAM,kBAAkB,GAAG,CAAC,KAAD,EAAqB,GAArB,KAAsE;AACtG,QAAM;AAAE,IAAA,OAAF;AAAW,IAAA,cAAX;AAA2B,IAAA,QAA3B;AAAqC,IAAA,aAAa,GAAG,OAArD;AAA8D,IAAA,QAA9D;AAAwE,IAAA;AAAxE,MAAqF,KAA3F;AAEA,QAAM,WAAW,GAAG,yBAAyB,CAAC;AAC5C,IAAA,KAD4C;AAE5C,IAAA,kBAAkB,EAAE,OAFwB;AAG5C,IAAA,iBAAiB,EAAE,CAAC,SAAD,EAAY,gBAAZ,EAA8B,UAA9B;AAHyB,GAAD,CAA7C;AAMA,QAAM,EAAE,GAAG,KAAK,CAAC,SAAD,EAAY,WAAW,CAAC,OAAZ,CAAoB,EAAhC,CAAhB;AAEA,QAAM,IAAI,GAAG,gBAAgB,CAAC,KAAK,CAAC,IAAP,EAAa;AACxC,IAAA,YAAY,EAAE,WAAW,CAAC,IADc;AAExC,IAAA,QAAQ,EAAE;AAF8B,GAAb,CAA7B;AAKA,QAAM,SAAS,GAAG,gBAAgB,CAAC,KAAK,CAAC,SAAP,EAAkB;AAClD,IAAA,YAAY,EAAE;AACZ,qBAAe,IADH;AAEZ,MAAA,QAAQ,eAAE,KAAA,CAAA,aAAA,CAAC,YAAD,EAAa,IAAb;AAFE,KADoC;AAKlD,IAAA,QAAQ,EAAE;AALwC,GAAlB,CAAlC;AAQA,QAAM,KAAK,GAAG,gBAAgB,CAAC,KAAK,CAAC,KAAP,EAAc;AAC1C,IAAA,YAAY,EAAE;AACZ,MAAA,OADY;AAEZ,MAAA,cAFY;AAGZ,MAAA,EAHY;AAIZ,MAAA,GAJY;AAKZ,MAAA,IAAI,EAAE,QALM;AAMZ,MAAA,IAAI,EAAE,UANM;AAOZ,SAAG,WAAW,CAAC;AAPH,KAD4B;AAU1C,IAAA,QAAQ,EAAE;AAVgC,GAAd,CAA9B;AAYA,EAAA,KAAK,CAAC,QAAN,GAAiB,uBAAuB,CAAC,KAAK,CAAC,QAAP,EAAiB,EAAE,IAAI,QAAQ,KAAA,IAAR,IAAA,QAAQ,KAAA,KAAA,CAAR,GAAQ,KAAA,CAAR,GAAA,QAAQ,CAAG,EAAH,EAAO;AAAE,IAAA,OAAO,EAAE,EAAE,CAAC,aAAH,CAAiB;AAA5B,GAAP,CAA/B,CAAxC;AAEA,QAAM,KAAK,GAAG,gBAAgB,CAAC,KAAK,CAAC,KAAP,EAAc;AAC1C,IAAA,YAAY,EAAE;AACZ,MAAA,QADY;AAEZ,MAAA,OAAO,EAAE,EAFG;AAGZ,MAAA,QAHY;AAIZ,MAAA,IAAI,EAAE;AAJM;AAD4B,GAAd,CAA9B;AASA,SAAO;AACL,IAAA,aADK;AAGL;AACA,IAAA,UAAU,EAAE;AACV,MAAA,IAAI,EAAE,KADI;AAEV,MAAA,SAAS,EAAE,KAFD;AAGV,MAAA,KAAK,EAAE,OAHG;AAIV,MAAA,KAAK,EAAE;AAJG,KAJP;AAWL,IAAA,IAXK;AAYL,IAAA,SAZK;AAaL,IAAA,KAbK;AAcL,IAAA;AAdK,GAAP;AAgBD,CA/DM","sourcesContent":["import * as React from 'react';\nimport { CircleFilled } from '@fluentui/react-icons';\nimport { Label } from '@fluentui/react-label';\nimport { getPartitionedNativeProps, resolveShorthand, useId, useMergedEventCallbacks } from '@fluentui/react-utilities';\nimport type { SwitchProps, SwitchState } from './Switch.types';\n\n/**\n * Create the state required to render Switch.\n *\n * The returned state can be modified with hooks such as useSwitchStyles_unstable,\n * before being passed to renderSwitch_unstable.\n *\n * @param props - props from this instance of Switch\n * @param ref - reference to `<input>` element of Switch\n */\nexport const useSwitch_unstable = (props: SwitchProps, ref: React.Ref<HTMLInputElement>): SwitchState => {\n const { checked, defaultChecked, disabled, labelPosition = 'after', onChange, required } = props;\n\n const nativeProps = getPartitionedNativeProps({\n props,\n primarySlotTagName: 'input',\n excludedPropNames: ['checked', 'defaultChecked', 'onChange'],\n });\n\n const id = useId('switch-', nativeProps.primary.id);\n\n const root = resolveShorthand(props.root, {\n defaultProps: nativeProps.root,\n required: true,\n });\n\n const indicator = resolveShorthand(props.indicator, {\n defaultProps: {\n 'aria-hidden': true,\n children: <CircleFilled />,\n },\n required: true,\n });\n\n const input = resolveShorthand(props.input, {\n defaultProps: {\n checked,\n defaultChecked,\n id,\n ref,\n role: 'switch',\n type: 'checkbox',\n ...nativeProps.primary,\n },\n required: true,\n });\n input.onChange = useMergedEventCallbacks(input.onChange, ev => onChange?.(ev, { checked: ev.currentTarget.checked }));\n\n const label = resolveShorthand(props.label, {\n defaultProps: {\n disabled,\n htmlFor: id,\n required,\n size: 'medium',\n },\n });\n\n return {\n labelPosition,\n\n //Slots definition\n components: {\n root: 'div',\n indicator: 'div',\n input: 'input',\n label: Label,\n },\n\n root,\n indicator,\n input,\n label,\n };\n};\n"],"sourceRoot":"../src/"}
|
@@ -0,0 +1,9 @@
|
|
1
|
+
import type { SwitchSlots, SwitchState } from './Switch.types';
|
2
|
+
export declare const switchClassNames: {
|
3
|
+
[SlotName in keyof SwitchSlots]-?: string;
|
4
|
+
};
|
5
|
+
export declare const switchClassName: string;
|
6
|
+
/**
|
7
|
+
* Apply styling to the Switch slots based on the state
|
8
|
+
*/
|
9
|
+
export declare const useSwitchStyles_unstable: (state: SwitchState) => SwitchState;
|