@telus-uds/components-base 1.7.1 → 1.8.2
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.md +41 -2
- package/component-docs.json +944 -691
- package/lib/A11yInfoProvider/index.js +4 -3
- package/lib/A11yText/index.js +6 -5
- package/lib/ActivityIndicator/Spinner.js +7 -6
- package/lib/ActivityIndicator/Spinner.native.js +8 -6
- package/lib/ActivityIndicator/index.js +6 -5
- package/lib/ActivityIndicator/shared.js +1 -1
- package/lib/BaseProvider/index.js +13 -10
- package/lib/Box/Box.js +20 -19
- package/lib/Button/Button.js +7 -6
- package/lib/Button/ButtonBase.js +95 -77
- package/lib/Button/ButtonGroup.js +140 -65
- package/lib/Button/ButtonLink.js +9 -7
- package/lib/Button/index.js +4 -4
- package/lib/Button/propTypes.js +1 -1
- package/lib/Card/Card.js +8 -7
- package/lib/Card/CardBase.js +35 -31
- package/lib/Card/PressableCardBase.js +14 -12
- package/lib/Checkbox/Checkbox.js +96 -82
- package/lib/Checkbox/CheckboxGroup.js +30 -28
- package/lib/Checkbox/CheckboxInput.js +12 -10
- package/lib/Divider/Divider.js +8 -7
- package/lib/ExpandCollapse/Control.js +42 -36
- package/lib/ExpandCollapse/ExpandCollapse.js +11 -10
- package/lib/ExpandCollapse/Panel.js +29 -24
- package/lib/Feedback/Feedback.js +48 -35
- package/lib/Fieldset/Fieldset.js +22 -14
- package/lib/Fieldset/FieldsetContainer.js +16 -13
- package/lib/Fieldset/FieldsetContainer.native.js +11 -8
- package/lib/Fieldset/Legend.js +10 -7
- package/lib/Fieldset/Legend.native.js +10 -7
- package/lib/FlexGrid/Col/Col.js +17 -16
- package/lib/FlexGrid/FlexGrid.js +15 -14
- package/lib/FlexGrid/Row/Row.js +13 -12
- package/lib/HorizontalScroll/HorizontalScroll.js +25 -20
- package/lib/HorizontalScroll/HorizontalScrollButton.js +18 -14
- package/lib/HorizontalScroll/ScrollViewEnd.js +6 -5
- package/lib/HorizontalScroll/ScrollViewEnd.native.js +12 -9
- package/lib/HorizontalScroll/itemPositions.js +19 -13
- package/lib/Icon/Icon.js +10 -9
- package/lib/Icon/IconText.js +8 -7
- package/lib/Icon/index.js +5 -5
- package/lib/IconButton/IconButton.js +50 -42
- package/lib/InputLabel/InputLabel.js +44 -30
- package/lib/InputLabel/LabelContent.js +12 -9
- package/lib/InputLabel/LabelContent.native.js +9 -6
- package/lib/InputSupports/InputSupports.js +17 -9
- package/lib/InputSupports/useInputSupports.js +7 -6
- package/lib/Link/ChevronLink.js +9 -8
- package/lib/Link/InlinePressable.js +13 -10
- package/lib/Link/InlinePressable.native.js +20 -16
- package/lib/Link/Link.js +10 -9
- package/lib/Link/LinkBase.js +96 -78
- package/lib/Link/TextButton.js +9 -8
- package/lib/List/List.js +9 -7
- package/lib/List/ListItem.js +99 -74
- package/lib/Modal/Modal.js +72 -59
- package/lib/Notification/Notification.js +47 -34
- package/lib/Pagination/PageButton.js +11 -10
- package/lib/Pagination/Pagination.js +39 -28
- package/lib/Pagination/SideButton.js +21 -18
- package/lib/Pagination/usePagination.js +5 -4
- package/lib/Progress/Progress.js +23 -19
- package/lib/Progress/ProgressBar.js +23 -19
- package/lib/Progress/ProgressBarBackground.js +4 -3
- package/lib/Radio/Radio.js +79 -68
- package/lib/Radio/RadioButton.js +63 -53
- package/lib/Radio/RadioGroup.js +39 -30
- package/lib/Radio/RadioInput.js +12 -10
- package/lib/RadioCard/RadioCard.js +15 -14
- package/lib/RadioCard/RadioCardGroup.js +34 -25
- package/lib/Search/Search.js +52 -32
- package/lib/Select/Group.js +5 -4
- package/lib/Select/Group.native.js +4 -3
- package/lib/Select/Item.js +10 -7
- package/lib/Select/Item.native.js +1 -9
- package/lib/Select/Picker.js +16 -15
- package/lib/Select/Picker.native.js +49 -38
- package/lib/Select/Select.js +134 -113
- package/lib/SideNav/Item.js +39 -33
- package/lib/SideNav/ItemContent.js +15 -12
- package/lib/SideNav/ItemsGroup.js +13 -11
- package/lib/SideNav/SideNav.js +19 -16
- package/lib/Skeleton/Skeleton.js +106 -44
- package/lib/Skeleton/skeleton.constant.js +1 -1
- package/lib/Spacer/Spacer.js +6 -5
- package/lib/StackView/StackView.js +12 -11
- package/lib/StackView/StackWrap.js +2 -2
- package/lib/StackView/StackWrapBox.js +12 -11
- package/lib/StackView/StackWrapGap.js +11 -10
- package/lib/StackView/common.js +14 -11
- package/lib/StackView/getStackedContent.js +8 -7
- package/lib/StackView/index.js +1 -1
- package/lib/StepTracker/Step.js +122 -103
- package/lib/StepTracker/StepTracker.js +48 -38
- package/lib/Tabs/Tabs.js +29 -24
- package/lib/Tabs/TabsItem.js +79 -68
- package/lib/Tags/Tags.js +67 -61
- package/lib/TextInput/TextArea.js +26 -20
- package/lib/TextInput/TextInput.js +20 -15
- package/lib/TextInput/TextInputBase.js +74 -62
- package/lib/TextInput/index.js +4 -4
- package/lib/ThemeProvider/ThemeProvider.js +6 -5
- package/lib/ThemeProvider/index.js +5 -5
- package/lib/ThemeProvider/useSetTheme.js +6 -3
- package/lib/ThemeProvider/useThemeTokens.js +7 -2
- package/lib/ThemeProvider/utils/styles.js +48 -41
- package/lib/ThemeProvider/utils/theme-tokens.js +26 -12
- package/lib/ToggleSwitch/ToggleSwitch.js +95 -72
- package/lib/ToggleSwitch/ToggleSwitchGroup.js +42 -33
- package/lib/Tooltip/Backdrop.js +4 -3
- package/lib/Tooltip/Backdrop.native.js +5 -4
- package/lib/Tooltip/Tooltip.js +82 -66
- package/lib/Tooltip/getTooltipPosition.js +29 -18
- package/lib/TooltipButton/TooltipButton.js +28 -21
- package/lib/Typography/Typography.js +37 -33
- package/lib/ViewportProvider/ViewportProvider.js +4 -3
- package/lib/ViewportProvider/useViewportListener.js +6 -3
- package/lib/index.js +54 -54
- package/lib/utils/a11y/semantics.js +5 -2
- package/lib/utils/a11y/textSize.js +8 -6
- package/lib/utils/animation/useVerticalExpandAnimation.js +32 -18
- package/lib/utils/children.js +2 -1
- package/lib/utils/index.js +10 -10
- package/lib/utils/input.js +22 -17
- package/lib/utils/pressability.js +36 -22
- package/lib/utils/props/clickProps.js +2 -1
- package/lib/utils/props/getPropSelector.js +6 -3
- package/lib/utils/props/handlerProps.js +25 -19
- package/lib/utils/props/hrefAttrsProp.js +14 -11
- package/lib/utils/props/index.js +12 -12
- package/lib/utils/props/inputSupportsProps.js +21 -11
- package/lib/utils/props/linkProps.js +7 -6
- package/lib/utils/props/pressProps.js +1 -1
- package/lib/utils/props/tokens.js +27 -13
- package/lib/utils/ssr.js +6 -2
- package/lib/utils/useCopy.js +6 -4
- package/lib/utils/useHash.js +2 -1
- package/lib/utils/useResponsiveProp.js +1 -1
- package/lib/utils/useUniqueId.js +2 -1
- package/lib/utils/withLinkRouter.js +6 -5
- package/package.json +18 -12
- package/src/Button/ButtonGroup.jsx +106 -41
- package/src/Checkbox/Checkbox.jsx +7 -4
- package/src/Checkbox/CheckboxGroup.jsx +3 -3
- package/src/ExpandCollapse/Panel.jsx +3 -1
- package/src/Fieldset/Fieldset.jsx +6 -0
- package/src/InputLabel/InputLabel.jsx +17 -2
- package/src/InputSupports/InputSupports.jsx +9 -1
- package/src/Notification/Notification.jsx +1 -1
- package/src/Pagination/Pagination.jsx +3 -0
- package/src/Radio/Radio.jsx +5 -1
- package/src/Radio/RadioGroup.jsx +11 -5
- package/src/RadioCard/RadioCard.jsx +5 -1
- package/src/RadioCard/RadioCardGroup.jsx +6 -0
- package/src/Search/Search.jsx +12 -1
- package/src/Select/Item.native.jsx +0 -7
- package/src/Skeleton/Skeleton.jsx +56 -3
- package/src/ToggleSwitch/ToggleSwitch.jsx +6 -0
- package/src/ToggleSwitch/ToggleSwitchGroup.jsx +6 -0
- package/src/Tooltip/Tooltip.jsx +1 -1
- package/src/utils/animation/useVerticalExpandAnimation.js +25 -12
- package/src/utils/props/inputSupportsProps.js +6 -1
- package/src/utils/props/tokens.js +21 -19
- package/.storybook/main.js +0 -4
- package/.storybook/preview.js +0 -37
- package/.turbo/turbo-build.log +0 -8
- package/.turbo/turbo-lint.log +0 -13
- package/CHANGELOG.json +0 -250
- package/__fixtures__/Accessible.js +0 -35
- package/__fixtures__/Accessible.native.js +0 -35
- package/__fixtures__/Theme.jsx +0 -13
- package/__fixtures__/Viewport.jsx +0 -17
- package/__fixtures__/test-utils.js +0 -25
- package/__fixtures__/testTheme.js +0 -1830
- package/__tests__/A11yText/A11yText.test.jsx +0 -34
- package/__tests__/ActivityIndicator/ActivityIndicator.test.jsx +0 -68
- package/__tests__/ActivityIndicator/__snapshots__/ActivityIndicator.test.jsx.snap +0 -287
- package/__tests__/Box/Box.test.jsx +0 -111
- package/__tests__/Button/Button.test.jsx +0 -86
- package/__tests__/Button/ButtonBase.test.jsx +0 -82
- package/__tests__/Button/ButtonGroup.test.jsx +0 -347
- package/__tests__/Button/ButtonLink.test.jsx +0 -61
- package/__tests__/Card/Card.test.jsx +0 -63
- package/__tests__/Checkbox/Checkbox.test.jsx +0 -94
- package/__tests__/Checkbox/CheckboxGroup.test.jsx +0 -246
- package/__tests__/Divider/Divider.test.jsx +0 -91
- package/__tests__/ExpandCollapse/ExpandCollapse.test.jsx +0 -109
- package/__tests__/Feedback/Feedback.test.jsx +0 -42
- package/__tests__/FlexGrid/Col.test.jsx +0 -256
- package/__tests__/FlexGrid/FlexGrid.test.jsx +0 -136
- package/__tests__/FlexGrid/Row.test.jsx +0 -273
- package/__tests__/HorizontalScroll/HorizontalScroll.test.jsx +0 -165
- package/__tests__/Icon/Icon.test.jsx +0 -61
- package/__tests__/IconButton/IconButton.test.jsx +0 -52
- package/__tests__/InputSupports/InputSupports.test.jsx +0 -50
- package/__tests__/Link/Link.test.jsx +0 -63
- package/__tests__/Link/TextButton.test.jsx +0 -35
- package/__tests__/List/List.test.jsx +0 -60
- package/__tests__/Modal/Modal.test.jsx +0 -47
- package/__tests__/Notification/Notification.test.jsx +0 -20
- package/__tests__/Pagination/Pagination.test.jsx +0 -160
- package/__tests__/Progress/Progress.test.jsx +0 -79
- package/__tests__/Radio/Radio.test.jsx +0 -87
- package/__tests__/Radio/RadioGroup.test.jsx +0 -220
- package/__tests__/RadioCard/RadioCard.test.jsx +0 -87
- package/__tests__/RadioCard/RadioCardGroup.test.jsx +0 -246
- package/__tests__/Search/Search.test.jsx +0 -73
- package/__tests__/Select/Select.test.jsx +0 -94
- package/__tests__/SideNav/SideNav.test.jsx +0 -110
- package/__tests__/Skeleton/Skeleton.test.jsx +0 -61
- package/__tests__/Spacer/Spacer.test.jsx +0 -63
- package/__tests__/StackView/StackView.test.jsx +0 -216
- package/__tests__/StackView/StackWrap.test.jsx +0 -47
- package/__tests__/StackView/getStackedContent.test.jsx +0 -295
- package/__tests__/StepTracker/StepTracker.test.jsx +0 -94
- package/__tests__/Tabs/Tabs.test.jsx +0 -40
- package/__tests__/Tags/Tags.test.jsx +0 -327
- package/__tests__/TextInput/TextArea.test.jsx +0 -35
- package/__tests__/TextInput/TextInputBase.test.jsx +0 -125
- package/__tests__/ThemeProvider/ThemeProvider.test.jsx +0 -77
- package/__tests__/ThemeProvider/useThemeTokens.test.jsx +0 -514
- package/__tests__/ThemeProvider/utils/theme-tokens.test.js +0 -41
- package/__tests__/ToggleSwitch/ToggleSwitch.test.jsx +0 -82
- package/__tests__/ToggleSwitch/ToggleSwitchGroup.test.jsx +0 -192
- package/__tests__/Tooltip/Tooltip.test.jsx +0 -65
- package/__tests__/Tooltip/getTooltipPosition.test.js +0 -79
- package/__tests__/Typography/typography.test.jsx +0 -90
- package/__tests__/utils/children.test.jsx +0 -128
- package/__tests__/utils/containUniqueFields.test.js +0 -25
- package/__tests__/utils/input.test.js +0 -375
- package/__tests__/utils/props.test.js +0 -36
- package/__tests__/utils/semantics.test.jsx +0 -34
- package/__tests__/utils/useCopy.test.js +0 -42
- package/__tests__/utils/useResponsiveProp.test.jsx +0 -202
- package/__tests__/utils/useSpacingScale.test.jsx +0 -273
- package/__tests__/utils/useUniqueId.test.js +0 -31
- package/babel.config.js +0 -35
- package/generate-component-docs.js +0 -72
- package/jest.config.js +0 -32
- package/lib-module/A11yInfoProvider/index.js +0 -62
- package/lib-module/A11yText/index.js +0 -55
- package/lib-module/ActivityIndicator/Spinner.js +0 -76
- package/lib-module/ActivityIndicator/Spinner.native.js +0 -143
- package/lib-module/ActivityIndicator/index.js +0 -40
- package/lib-module/ActivityIndicator/shared.js +0 -12
- package/lib-module/BaseProvider/index.js +0 -26
- package/lib-module/Box/Box.js +0 -243
- package/lib-module/Box/index.js +0 -2
- package/lib-module/Button/Button.js +0 -25
- package/lib-module/Button/ButtonBase.js +0 -254
- package/lib-module/Button/ButtonGroup.js +0 -173
- package/lib-module/Button/ButtonLink.js +0 -39
- package/lib-module/Button/index.js +0 -4
- package/lib-module/Button/propTypes.js +0 -36
- package/lib-module/Card/Card.js +0 -83
- package/lib-module/Card/CardBase.js +0 -62
- package/lib-module/Card/PressableCardBase.js +0 -113
- package/lib-module/Card/index.js +0 -4
- package/lib-module/Checkbox/Checkbox.js +0 -332
- package/lib-module/Checkbox/CheckboxGroup.js +0 -231
- package/lib-module/Checkbox/CheckboxInput.js +0 -58
- package/lib-module/Checkbox/CheckboxInput.native.js +0 -6
- package/lib-module/Checkbox/index.js +0 -3
- package/lib-module/Divider/Divider.js +0 -123
- package/lib-module/Divider/index.js +0 -2
- package/lib-module/ExpandCollapse/Accordion.js +0 -15
- package/lib-module/ExpandCollapse/Control.js +0 -130
- package/lib-module/ExpandCollapse/ExpandCollapse.js +0 -94
- package/lib-module/ExpandCollapse/Panel.js +0 -158
- package/lib-module/ExpandCollapse/index.js +0 -7
- package/lib-module/Feedback/Feedback.js +0 -144
- package/lib-module/Feedback/index.js +0 -2
- package/lib-module/Fieldset/Fieldset.js +0 -145
- package/lib-module/Fieldset/FieldsetContainer.js +0 -29
- package/lib-module/Fieldset/FieldsetContainer.native.js +0 -20
- package/lib-module/Fieldset/Legend.js +0 -21
- package/lib-module/Fieldset/Legend.native.js +0 -28
- package/lib-module/Fieldset/cssReset.js +0 -14
- package/lib-module/Fieldset/index.js +0 -2
- package/lib-module/FlexGrid/Col/Col.js +0 -275
- package/lib-module/FlexGrid/Col/index.js +0 -2
- package/lib-module/FlexGrid/FlexGrid.js +0 -147
- package/lib-module/FlexGrid/Row/Row.js +0 -183
- package/lib-module/FlexGrid/Row/index.js +0 -2
- package/lib-module/FlexGrid/helpers/index.js +0 -18
- package/lib-module/FlexGrid/index.js +0 -2
- package/lib-module/FlexGrid/providers/GutterContext.js +0 -3
- package/lib-module/HorizontalScroll/HorizontalScroll.js +0 -170
- package/lib-module/HorizontalScroll/HorizontalScrollButton.js +0 -77
- package/lib-module/HorizontalScroll/ScrollViewEnd.js +0 -47
- package/lib-module/HorizontalScroll/ScrollViewEnd.native.js +0 -24
- package/lib-module/HorizontalScroll/dictionary.js +0 -11
- package/lib-module/HorizontalScroll/index.js +0 -11
- package/lib-module/HorizontalScroll/itemPositions.js +0 -106
- package/lib-module/Icon/Icon.js +0 -61
- package/lib-module/Icon/IconText.js +0 -81
- package/lib-module/Icon/index.js +0 -4
- package/lib-module/IconButton/IconButton.js +0 -115
- package/lib-module/IconButton/index.js +0 -2
- package/lib-module/InputLabel/InputLabel.js +0 -134
- package/lib-module/InputLabel/LabelContent.js +0 -24
- package/lib-module/InputLabel/LabelContent.native.js +0 -16
- package/lib-module/InputLabel/index.js +0 -2
- package/lib-module/InputSupports/InputSupports.js +0 -88
- package/lib-module/InputSupports/index.js +0 -2
- package/lib-module/InputSupports/useInputSupports.js +0 -31
- package/lib-module/Link/ChevronLink.js +0 -51
- package/lib-module/Link/InlinePressable.js +0 -37
- package/lib-module/Link/InlinePressable.native.js +0 -85
- package/lib-module/Link/Link.js +0 -27
- package/lib-module/Link/LinkBase.js +0 -223
- package/lib-module/Link/TextButton.js +0 -34
- package/lib-module/Link/index.js +0 -5
- package/lib-module/List/List.js +0 -55
- package/lib-module/List/ListItem.js +0 -223
- package/lib-module/List/index.js +0 -5
- package/lib-module/Modal/Modal.js +0 -208
- package/lib-module/Modal/dictionary.js +0 -9
- package/lib-module/Modal/index.js +0 -2
- package/lib-module/Notification/Notification.js +0 -196
- package/lib-module/Notification/dictionary.js +0 -8
- package/lib-module/Notification/index.js +0 -2
- package/lib-module/Pagination/PageButton.js +0 -65
- package/lib-module/Pagination/Pagination.js +0 -140
- package/lib-module/Pagination/SideButton.js +0 -103
- package/lib-module/Pagination/dictionary.js +0 -18
- package/lib-module/Pagination/index.js +0 -2
- package/lib-module/Pagination/usePagination.js +0 -72
- package/lib-module/Progress/Progress.js +0 -85
- package/lib-module/Progress/ProgressBar.js +0 -134
- package/lib-module/Progress/ProgressBarBackground.js +0 -41
- package/lib-module/Progress/index.js +0 -4
- package/lib-module/Radio/Radio.js +0 -274
- package/lib-module/Radio/RadioButton.js +0 -128
- package/lib-module/Radio/RadioGroup.js +0 -234
- package/lib-module/Radio/RadioInput.js +0 -60
- package/lib-module/Radio/RadioInput.native.js +0 -6
- package/lib-module/Radio/index.js +0 -3
- package/lib-module/RadioCard/RadioCard.js +0 -218
- package/lib-module/RadioCard/RadioCardGroup.js +0 -241
- package/lib-module/RadioCard/index.js +0 -3
- package/lib-module/Search/Search.js +0 -241
- package/lib-module/Search/dictionary.js +0 -12
- package/lib-module/Search/index.js +0 -2
- package/lib-module/Select/Group.js +0 -20
- package/lib-module/Select/Group.native.js +0 -14
- package/lib-module/Select/Item.js +0 -17
- package/lib-module/Select/Item.native.js +0 -9
- package/lib-module/Select/Picker.js +0 -67
- package/lib-module/Select/Picker.native.js +0 -110
- package/lib-module/Select/Select.js +0 -316
- package/lib-module/Select/index.js +0 -6
- package/lib-module/SideNav/Item.js +0 -139
- package/lib-module/SideNav/ItemContent.js +0 -45
- package/lib-module/SideNav/ItemsGroup.js +0 -115
- package/lib-module/SideNav/SideNav.js +0 -133
- package/lib-module/SideNav/index.js +0 -1
- package/lib-module/Skeleton/Skeleton.js +0 -117
- package/lib-module/Skeleton/index.js +0 -2
- package/lib-module/Skeleton/skeleton.constant.js +0 -3
- package/lib-module/Skeleton/skeletonWebAnimation.js +0 -18
- package/lib-module/Skeleton/useSkeletonNativeAnimation.js +0 -24
- package/lib-module/Spacer/Spacer.js +0 -97
- package/lib-module/Spacer/index.js +0 -2
- package/lib-module/StackView/StackView.js +0 -124
- package/lib-module/StackView/StackWrap.js +0 -48
- package/lib-module/StackView/StackWrap.native.js +0 -3
- package/lib-module/StackView/StackWrapBox.js +0 -114
- package/lib-module/StackView/StackWrapGap.js +0 -58
- package/lib-module/StackView/common.js +0 -32
- package/lib-module/StackView/getStackedContent.js +0 -123
- package/lib-module/StackView/index.js +0 -5
- package/lib-module/StepTracker/Step.js +0 -229
- package/lib-module/StepTracker/StepTracker.js +0 -175
- package/lib-module/StepTracker/dictionary.js +0 -10
- package/lib-module/StepTracker/index.js +0 -2
- package/lib-module/Tabs/Tabs.js +0 -113
- package/lib-module/Tabs/TabsItem.js +0 -215
- package/lib-module/Tabs/index.js +0 -2
- package/lib-module/Tags/Tags.js +0 -245
- package/lib-module/Tags/index.js +0 -2
- package/lib-module/TextInput/TextArea.js +0 -88
- package/lib-module/TextInput/TextInput.js +0 -68
- package/lib-module/TextInput/TextInputBase.js +0 -233
- package/lib-module/TextInput/index.js +0 -3
- package/lib-module/TextInput/propTypes.js +0 -37
- package/lib-module/ThemeProvider/ThemeProvider.js +0 -35
- package/lib-module/ThemeProvider/index.js +0 -6
- package/lib-module/ThemeProvider/useSetTheme.js +0 -22
- package/lib-module/ThemeProvider/useTheme.js +0 -14
- package/lib-module/ThemeProvider/useThemeTokens.js +0 -105
- package/lib-module/ThemeProvider/utils/index.js +0 -2
- package/lib-module/ThemeProvider/utils/styles.js +0 -174
- package/lib-module/ThemeProvider/utils/theme-tokens.js +0 -151
- package/lib-module/ToggleSwitch/ToggleSwitch.js +0 -227
- package/lib-module/ToggleSwitch/ToggleSwitchGroup.js +0 -211
- package/lib-module/ToggleSwitch/index.js +0 -3
- package/lib-module/Tooltip/Backdrop.js +0 -52
- package/lib-module/Tooltip/Backdrop.native.js +0 -43
- package/lib-module/Tooltip/Tooltip.js +0 -332
- package/lib-module/Tooltip/dictionary.js +0 -8
- package/lib-module/Tooltip/getTooltipPosition.js +0 -164
- package/lib-module/Tooltip/index.js +0 -2
- package/lib-module/TooltipButton/TooltipButton.js +0 -71
- package/lib-module/TooltipButton/index.js +0 -2
- package/lib-module/Typography/Typography.js +0 -120
- package/lib-module/Typography/index.js +0 -2
- package/lib-module/ViewportProvider/ViewportProvider.js +0 -28
- package/lib-module/ViewportProvider/index.js +0 -3
- package/lib-module/ViewportProvider/useViewport.js +0 -3
- package/lib-module/ViewportProvider/useViewportListener.js +0 -43
- package/lib-module/index.js +0 -48
- package/lib-module/utils/a11y/index.js +0 -2
- package/lib-module/utils/a11y/semantics.js +0 -154
- package/lib-module/utils/a11y/textSize.js +0 -34
- package/lib-module/utils/animation/index.js +0 -2
- package/lib-module/utils/animation/useVerticalExpandAnimation.js +0 -49
- package/lib-module/utils/children.js +0 -118
- package/lib-module/utils/containUniqueFields.js +0 -26
- package/lib-module/utils/index.js +0 -16
- package/lib-module/utils/info/index.js +0 -7
- package/lib-module/utils/info/platform/index.js +0 -11
- package/lib-module/utils/info/platform/platform.android.js +0 -1
- package/lib-module/utils/info/platform/platform.ios.js +0 -1
- package/lib-module/utils/info/platform/platform.js +0 -1
- package/lib-module/utils/info/platform/platform.native.js +0 -4
- package/lib-module/utils/info/versions.js +0 -5
- package/lib-module/utils/input.js +0 -180
- package/lib-module/utils/pressability.js +0 -97
- package/lib-module/utils/props/a11yProps.js +0 -140
- package/lib-module/utils/props/clickProps.js +0 -25
- package/lib-module/utils/props/componentPropType.js +0 -63
- package/lib-module/utils/props/copyPropTypes.js +0 -2
- package/lib-module/utils/props/getPropSelector.js +0 -6
- package/lib-module/utils/props/handlerProps.js +0 -59
- package/lib-module/utils/props/hrefAttrsProp.js +0 -30
- package/lib-module/utils/props/index.js +0 -19
- package/lib-module/utils/props/inputSupportsProps.js +0 -52
- package/lib-module/utils/props/linkProps.js +0 -43
- package/lib-module/utils/props/paddingProp.js +0 -9
- package/lib-module/utils/props/pressProps.js +0 -42
- package/lib-module/utils/props/rectProp.js +0 -9
- package/lib-module/utils/props/responsiveProps.js +0 -30
- package/lib-module/utils/props/selectSystemProps.js +0 -24
- package/lib-module/utils/props/spacingProps.js +0 -56
- package/lib-module/utils/props/textInputProps.js +0 -194
- package/lib-module/utils/props/textProps.js +0 -59
- package/lib-module/utils/props/tokens.js +0 -120
- package/lib-module/utils/props/variantProp.js +0 -18
- package/lib-module/utils/props/viewProps.js +0 -22
- package/lib-module/utils/ssr.js +0 -35
- package/lib-module/utils/useCopy.js +0 -42
- package/lib-module/utils/useHash.js +0 -44
- package/lib-module/utils/useHash.native.js +0 -7
- package/lib-module/utils/useResponsiveProp.js +0 -47
- package/lib-module/utils/useSpacingScale.js +0 -123
- package/lib-module/utils/useUniqueId.js +0 -12
- package/lib-module/utils/withLinkRouter.js +0 -82
- package/stories/A11yText/A11yText.stories.jsx +0 -71
- package/stories/ActivityIndicator/ActivityIndicator.stories.jsx +0 -22
- package/stories/Box/Box.stories.jsx +0 -143
- package/stories/Button/Button.stories.jsx +0 -72
- package/stories/Button/ButtonGroup.stories.jsx +0 -81
- package/stories/Button/ButtonLink.stories.jsx +0 -30
- package/stories/Card/Card.stories.jsx +0 -62
- package/stories/Checkbox/Checkbox.stories.jsx +0 -94
- package/stories/Divider/Divider.stories.jsx +0 -68
- package/stories/ExpandCollapse/ExpandCollapse.stories.jsx +0 -112
- package/stories/Feedback/Feedback.stories.jsx +0 -96
- package/stories/FlexGrid/01 FlexGrid.stories.jsx +0 -54
- package/stories/FlexGrid/02 Row.stories.jsx +0 -41
- package/stories/FlexGrid/03 Col.stories.jsx +0 -141
- package/stories/Icon/Icon.stories.jsx +0 -79
- package/stories/IconButton/IconButton.stories.jsx +0 -50
- package/stories/InputLabel/InputLabel.stories.jsx +0 -39
- package/stories/Link/ChevronLink.stories.jsx +0 -48
- package/stories/Link/Link.stories.jsx +0 -90
- package/stories/Link/TextButton.stories.jsx +0 -79
- package/stories/List/List.stories.jsx +0 -117
- package/stories/Modal/Modal.stories.jsx +0 -54
- package/stories/Notification/Notification.stories.jsx +0 -82
- package/stories/Pagination/Pagination.stories.jsx +0 -64
- package/stories/Progress/Progress.stories.jsx +0 -93
- package/stories/Radio/Radio.stories.jsx +0 -100
- package/stories/RadioCard/RadioCard.stories.jsx +0 -98
- package/stories/Search/Search.stories.jsx +0 -66
- package/stories/Select/Select.stories.jsx +0 -55
- package/stories/SideNav/SideNav.stories.jsx +0 -42
- package/stories/SideNav/SideNavItem.stories.jsx +0 -9
- package/stories/SideNav/SideNavItemsGroup.stories.jsx +0 -17
- package/stories/Skeleton/Skeleton.stories.jsx +0 -36
- package/stories/Spacer/Spacer.stories.jsx +0 -38
- package/stories/StackView/StackView.stories.jsx +0 -75
- package/stories/StackView/StackWrap.stories.jsx +0 -64
- package/stories/StepTracker/StepTracker.stories.jsx +0 -71
- package/stories/Tabs/Tabs.stories.jsx +0 -97
- package/stories/Tags/Tags.stories.jsx +0 -69
- package/stories/TextInput/TextArea.stories.jsx +0 -101
- package/stories/TextInput/TextInput.stories.jsx +0 -141
- package/stories/ToggleSwitch/ToggleSwitch.stories.jsx +0 -64
- package/stories/ToggleSwitch/ToggleSwitchGroup.stories.jsx +0 -81
- package/stories/Tooltip/Tooltip.stories.jsx +0 -81
- package/stories/TooltipButton/TooltipButton.stories.jsx +0 -11
- package/stories/Typography/Typography.stories.jsx +0 -49
- package/stories/platform-supports.jsx +0 -32
- package/stories/platform-supports.native.jsx +0 -3
- package/stories/supports.jsx +0 -236
package/component-docs.json
CHANGED
|
@@ -36,6 +36,7 @@
|
|
|
36
36
|
},
|
|
37
37
|
"ButtonGroup": {
|
|
38
38
|
"space": "integer",
|
|
39
|
+
"fieldSpace": "integer",
|
|
39
40
|
"direction": "direction",
|
|
40
41
|
"alignItems": "flexAlign",
|
|
41
42
|
"justifyContent": "flexJustifyContent",
|
|
@@ -748,6 +749,7 @@
|
|
|
748
749
|
},
|
|
749
750
|
"ToggleSwitchGroup": {
|
|
750
751
|
"space": "integer",
|
|
752
|
+
"fieldSpace": "integer",
|
|
751
753
|
"direction": "direction",
|
|
752
754
|
"alignItems": "flexAlign",
|
|
753
755
|
"justifyContent": "flexJustifyContent",
|
|
@@ -1548,6 +1550,23 @@
|
|
|
1548
1550
|
}
|
|
1549
1551
|
},
|
|
1550
1552
|
"components": {
|
|
1553
|
+
"A11yInfoProvider": {
|
|
1554
|
+
"docs": {
|
|
1555
|
+
"description": "",
|
|
1556
|
+
"props": {
|
|
1557
|
+
"children": {
|
|
1558
|
+
"type": {
|
|
1559
|
+
"name": "node"
|
|
1560
|
+
},
|
|
1561
|
+
"required": true,
|
|
1562
|
+
"description": ""
|
|
1563
|
+
}
|
|
1564
|
+
},
|
|
1565
|
+
"attributes": {
|
|
1566
|
+
"acceptsRNA11yProps": false
|
|
1567
|
+
}
|
|
1568
|
+
}
|
|
1569
|
+
},
|
|
1551
1570
|
"A11yText": {
|
|
1552
1571
|
"docs": {
|
|
1553
1572
|
"description": "A11yText is a zero-size invisible element that adds text to be read by screen readers.\n\nIt should be used to add selectable screen-reader-only text to the main document flow,\nas a sibling to blocks of text like paragraphs and interactive elements like buttons.",
|
|
@@ -1572,6 +1591,233 @@
|
|
|
1572
1591
|
}
|
|
1573
1592
|
}
|
|
1574
1593
|
},
|
|
1594
|
+
"Accordion": {
|
|
1595
|
+
"docs": {
|
|
1596
|
+
"description": "'Accordion' is a shorthand for an ExpandCollapse where only one item may be open at a time",
|
|
1597
|
+
"props": {
|
|
1598
|
+
"variant": {
|
|
1599
|
+
"type": {
|
|
1600
|
+
"name": "objectOf",
|
|
1601
|
+
"value": {
|
|
1602
|
+
"name": "union",
|
|
1603
|
+
"value": [
|
|
1604
|
+
{
|
|
1605
|
+
"name": "string"
|
|
1606
|
+
},
|
|
1607
|
+
{
|
|
1608
|
+
"name": "number"
|
|
1609
|
+
},
|
|
1610
|
+
{
|
|
1611
|
+
"name": "bool"
|
|
1612
|
+
}
|
|
1613
|
+
]
|
|
1614
|
+
}
|
|
1615
|
+
},
|
|
1616
|
+
"required": false,
|
|
1617
|
+
"description": ""
|
|
1618
|
+
},
|
|
1619
|
+
"tokens": {
|
|
1620
|
+
"type": {
|
|
1621
|
+
"name": "custom",
|
|
1622
|
+
"raw": {
|
|
1623
|
+
"borderColor": "color",
|
|
1624
|
+
"borderWidth": "border",
|
|
1625
|
+
"borderStyle": "borderStyle"
|
|
1626
|
+
}
|
|
1627
|
+
},
|
|
1628
|
+
"required": false,
|
|
1629
|
+
"description": ""
|
|
1630
|
+
},
|
|
1631
|
+
"children": {
|
|
1632
|
+
"type": {
|
|
1633
|
+
"name": "union",
|
|
1634
|
+
"value": [
|
|
1635
|
+
{
|
|
1636
|
+
"name": "func"
|
|
1637
|
+
},
|
|
1638
|
+
{
|
|
1639
|
+
"name": "node"
|
|
1640
|
+
}
|
|
1641
|
+
]
|
|
1642
|
+
},
|
|
1643
|
+
"required": true,
|
|
1644
|
+
"description": "ExpandCollapse usually takes a render function to which it passes an object with properties\n{ openIds, onToggle, resetValues, setValues, unsetValues }. openIds (array of ids) and\nonToggle (function) will usually be passed to `<ExpandCollapse.Panel>`"
|
|
1645
|
+
},
|
|
1646
|
+
"maxOpen": {
|
|
1647
|
+
"type": {
|
|
1648
|
+
"name": "number"
|
|
1649
|
+
},
|
|
1650
|
+
"required": false,
|
|
1651
|
+
"description": "If set, enforces a specific maximum number of open items, closing already-open items when new\nitems are opened. By default, any number of items may be open at once."
|
|
1652
|
+
},
|
|
1653
|
+
"open": {
|
|
1654
|
+
"type": {
|
|
1655
|
+
"name": "arrayOf",
|
|
1656
|
+
"value": {
|
|
1657
|
+
"name": "string"
|
|
1658
|
+
}
|
|
1659
|
+
},
|
|
1660
|
+
"required": false,
|
|
1661
|
+
"description": "If passed, the item or items that are expanded will be controlled by a parent component"
|
|
1662
|
+
},
|
|
1663
|
+
"onChange": {
|
|
1664
|
+
"type": {
|
|
1665
|
+
"name": "func"
|
|
1666
|
+
},
|
|
1667
|
+
"required": false,
|
|
1668
|
+
"description": "Function called when which panels are currently open changes. Necessary if `open` is passed."
|
|
1669
|
+
},
|
|
1670
|
+
"initialOpen": {
|
|
1671
|
+
"type": {
|
|
1672
|
+
"name": "arrayOf",
|
|
1673
|
+
"value": {
|
|
1674
|
+
"name": "string"
|
|
1675
|
+
}
|
|
1676
|
+
},
|
|
1677
|
+
"required": false,
|
|
1678
|
+
"description": "Allows items with specified ids to be open by default on first load. Should not be used with `open`."
|
|
1679
|
+
}
|
|
1680
|
+
},
|
|
1681
|
+
"attributes": {
|
|
1682
|
+
"acceptsRNA11yProps": false
|
|
1683
|
+
}
|
|
1684
|
+
},
|
|
1685
|
+
"Panel": {
|
|
1686
|
+
"docs": {
|
|
1687
|
+
"description": "An item in an `ExpandCollapse` which contains collapsible `children` and a `control` that opens\nand closes the collapsible children when pressed.\n\nExpects `openIds` and `onToggle` props from the `ExpandCollapse` render function and a unique\n`panelId` that matches the ids passed to the `<ExpandCollapse>`.\n\nThe panel does not need to be a direct child of the `<ExpandCollapse>` (unless this is required\nby the chosen accessibility props for a particular accessibility tools).",
|
|
1688
|
+
"props": {
|
|
1689
|
+
"openIds": {
|
|
1690
|
+
"defaultValue": {
|
|
1691
|
+
"value": "[]",
|
|
1692
|
+
"computed": false
|
|
1693
|
+
},
|
|
1694
|
+
"type": {
|
|
1695
|
+
"name": "arrayOf",
|
|
1696
|
+
"value": {
|
|
1697
|
+
"name": "union",
|
|
1698
|
+
"value": [
|
|
1699
|
+
{
|
|
1700
|
+
"name": "number"
|
|
1701
|
+
},
|
|
1702
|
+
{
|
|
1703
|
+
"name": "string"
|
|
1704
|
+
}
|
|
1705
|
+
]
|
|
1706
|
+
}
|
|
1707
|
+
},
|
|
1708
|
+
"required": false,
|
|
1709
|
+
"description": "Array of the ids of currently open groups"
|
|
1710
|
+
},
|
|
1711
|
+
"variant": {
|
|
1712
|
+
"type": {
|
|
1713
|
+
"name": "objectOf",
|
|
1714
|
+
"value": {
|
|
1715
|
+
"name": "union",
|
|
1716
|
+
"value": [
|
|
1717
|
+
{
|
|
1718
|
+
"name": "string"
|
|
1719
|
+
},
|
|
1720
|
+
{
|
|
1721
|
+
"name": "number"
|
|
1722
|
+
},
|
|
1723
|
+
{
|
|
1724
|
+
"name": "bool"
|
|
1725
|
+
}
|
|
1726
|
+
]
|
|
1727
|
+
}
|
|
1728
|
+
},
|
|
1729
|
+
"required": false,
|
|
1730
|
+
"description": ""
|
|
1731
|
+
},
|
|
1732
|
+
"tokens": {
|
|
1733
|
+
"type": {
|
|
1734
|
+
"name": "custom",
|
|
1735
|
+
"raw": {
|
|
1736
|
+
"expandDuration": "duration",
|
|
1737
|
+
"collapseDuration": "duration",
|
|
1738
|
+
"contentPaddingLeft": "size",
|
|
1739
|
+
"contentPaddingRight": "size",
|
|
1740
|
+
"contentPaddingTop": "size",
|
|
1741
|
+
"contentPaddingBottom": "size"
|
|
1742
|
+
}
|
|
1743
|
+
},
|
|
1744
|
+
"required": false,
|
|
1745
|
+
"description": ""
|
|
1746
|
+
},
|
|
1747
|
+
"panelId": {
|
|
1748
|
+
"type": {
|
|
1749
|
+
"name": "string"
|
|
1750
|
+
},
|
|
1751
|
+
"required": true,
|
|
1752
|
+
"description": "Unique name by which the ExpandCollapse controls this element."
|
|
1753
|
+
},
|
|
1754
|
+
"onToggle": {
|
|
1755
|
+
"type": {
|
|
1756
|
+
"name": "func"
|
|
1757
|
+
},
|
|
1758
|
+
"required": true,
|
|
1759
|
+
"description": "Function to call on pressing the panel's control, which should open or close the panel.\nIf Panel is a direct child of `ExpandCollapse`, this prop will be provided by the ExpandCollapse parent."
|
|
1760
|
+
},
|
|
1761
|
+
"onPress": {
|
|
1762
|
+
"type": {
|
|
1763
|
+
"name": "func"
|
|
1764
|
+
},
|
|
1765
|
+
"required": false,
|
|
1766
|
+
"description": "Optional function to call on pressing the panel's control, in addition to opening or closing the panel."
|
|
1767
|
+
},
|
|
1768
|
+
"children": {
|
|
1769
|
+
"type": {
|
|
1770
|
+
"name": "union",
|
|
1771
|
+
"value": [
|
|
1772
|
+
{
|
|
1773
|
+
"name": "func"
|
|
1774
|
+
},
|
|
1775
|
+
{
|
|
1776
|
+
"name": "node"
|
|
1777
|
+
}
|
|
1778
|
+
]
|
|
1779
|
+
},
|
|
1780
|
+
"required": false,
|
|
1781
|
+
"description": "ExpandCollapsePanel's children are the content that is hidden or revealed on open or close, and may be any\nsingle React element or a render function which takes this group's isExpanded state, onToggle function and panelId"
|
|
1782
|
+
},
|
|
1783
|
+
"control": {
|
|
1784
|
+
"type": {
|
|
1785
|
+
"name": "custom",
|
|
1786
|
+
"raw": "ExpandCollapseControl.propTypes.children.isRequired"
|
|
1787
|
+
},
|
|
1788
|
+
"required": false,
|
|
1789
|
+
"description": "The content inside the always-visible control element that opens and closes the ExpandCollapse when pressed."
|
|
1790
|
+
},
|
|
1791
|
+
"controlTokens": {
|
|
1792
|
+
"type": {
|
|
1793
|
+
"name": "custom",
|
|
1794
|
+
"raw": {
|
|
1795
|
+
"icon": "icon",
|
|
1796
|
+
"iconColor": "color",
|
|
1797
|
+
"iconSize": "size",
|
|
1798
|
+
"iconGap": "size",
|
|
1799
|
+
"iconPosition": "position",
|
|
1800
|
+
"verticalAlign": "verticalAlign",
|
|
1801
|
+
"justifyContent": "flexJustifyContent",
|
|
1802
|
+
"paddingLeft": "size",
|
|
1803
|
+
"paddingRight": "size",
|
|
1804
|
+
"paddingTop": "size",
|
|
1805
|
+
"paddingBottom": "size",
|
|
1806
|
+
"borderWidth": "border",
|
|
1807
|
+
"borderColor": "color",
|
|
1808
|
+
"backgroundColor": "color"
|
|
1809
|
+
}
|
|
1810
|
+
},
|
|
1811
|
+
"required": false,
|
|
1812
|
+
"description": "Optional theme token overrides that may be passed to the ExpandCollapseControl element."
|
|
1813
|
+
}
|
|
1814
|
+
},
|
|
1815
|
+
"attributes": {
|
|
1816
|
+
"acceptsRNA11yProps": false
|
|
1817
|
+
}
|
|
1818
|
+
}
|
|
1819
|
+
}
|
|
1820
|
+
},
|
|
1575
1821
|
"ActivityIndicator": {
|
|
1576
1822
|
"docs": {
|
|
1577
1823
|
"description": "`ActivityIndicator` renders a visual loading state.\nIt does not handle positioning or layout of that visual loader.",
|
|
@@ -1622,6 +1868,31 @@
|
|
|
1622
1868
|
}
|
|
1623
1869
|
}
|
|
1624
1870
|
},
|
|
1871
|
+
"BaseProvider": {
|
|
1872
|
+
"docs": {
|
|
1873
|
+
"description": "",
|
|
1874
|
+
"props": {
|
|
1875
|
+
"defaultTheme": {
|
|
1876
|
+
"type": {
|
|
1877
|
+
"name": "custom",
|
|
1878
|
+
"raw": "ThemeProvider.propTypes?.defaultTheme"
|
|
1879
|
+
},
|
|
1880
|
+
"required": false,
|
|
1881
|
+
"description": ""
|
|
1882
|
+
},
|
|
1883
|
+
"children": {
|
|
1884
|
+
"type": {
|
|
1885
|
+
"name": "node"
|
|
1886
|
+
},
|
|
1887
|
+
"required": true,
|
|
1888
|
+
"description": ""
|
|
1889
|
+
}
|
|
1890
|
+
},
|
|
1891
|
+
"attributes": {
|
|
1892
|
+
"acceptsRNA11yProps": false
|
|
1893
|
+
}
|
|
1894
|
+
}
|
|
1895
|
+
},
|
|
1625
1896
|
"Box": {
|
|
1626
1897
|
"docs": {
|
|
1627
1898
|
"description": "A layout utility component. Use Box to create space (padding) around content.\n\n## Spacing\n\nFor most simple uses, pass a number to Box's `space` prop referring to an index in the theme's\nspacing scale. For example, for a box with the theme's smallest non-zero amount of padding on all sides:\n\n```jsx\n<Box space={1}>\n```\n\n#### Targetting specific sides\n\nBox allows spacing value props to be assigned to any side or all sides using the following props:\n\n- `space` sets the default for all sides, which is overridden by other props below\n- `horizontal` sets defaults for `left` and `right` (overriding `space` there if it is set)\n- `vertical` sets defaults for `top` and `bottom` (overriding `space` there if it is set)\n- `left` sets the left side padding, inside the box's bounds\n- `right` sets the right side padding, inside the box's bounds\n- `top` sets the top side padding, inside the box's bounds\n- `bottom` sets the bottom side padding, inside the box's bounds\n\nBox only controls spacing within its bounds. If space is needed around a box outside of its bounds,\nuse `Spacer`, `StackView` or wrap the `Box` inside another `Box`.\n\n#### Viewport-specific spacing\n\nResponsive behaviours may be set by passing any of the above props an object keyed by viewports.\n\nFor example, if a theme's spacing scale is [0, 4, 8...], this below will have padding of 4px on top,\nbottom, and right, and its left padding will be 0px on xs, sm and md viewports and 8px on lg and xl viewports:\n\n```jsx\n<Box space={1} left={{ xs: 0, lg: 2 }} />`\n```\n\n#### Subtracting from spacing\n\nA parent may sometimes need to reduce the spacing size on one or more sides of a `Box` by some variable.\nFor example, the parent may have a border on one side and want to reduce the spacing of a child box\nby the width of that border on that side. This can be achieved using the `subtract` option of the\nspacing object, for example:\n\n```jsx\n<Box space={2} left={{ space: 2, options: { subtract: themeTokens.borderWidthLeft } }} />`\n```\n\nSee `useSpacingScale` hook for other spacing value options and documentation.\n\n## Theming\n\nBox is intended for layout, so minimal theming is supported. Use components like `Card` for\nmore sophisticated theming.\n\n## Scroll\n\nIf passed, the box will be scrollable. If an object is passed, it will be passed to React Native's\n`ScrollView` component as props.\n\nWhen building native iOS and Android apps, it is important to remember to ensure any screen containing\ntext content is inside a scrollable box, as screens are not scrollable by default and even very\nshort text will require scrolling on small devices at the highest accessibility text scaling settings.",
|
|
@@ -1915,70 +2186,12 @@
|
|
|
1915
2186
|
"required": false,
|
|
1916
2187
|
"description": "Use in tests if the box itself needs to be targetted and no other way of selecting the\nbox is available (e.g. it cannot be targetted using an appropriate `accessibilityRole`)."
|
|
1917
2188
|
},
|
|
1918
|
-
"children": {
|
|
1919
|
-
"type": {
|
|
1920
|
-
"name": "node"
|
|
1921
|
-
},
|
|
1922
|
-
"required": true,
|
|
1923
|
-
"description": "Box accepts any content as children."
|
|
1924
|
-
}
|
|
1925
|
-
},
|
|
1926
|
-
"attributes": {
|
|
1927
|
-
"acceptsRNA11yProps": false
|
|
1928
|
-
}
|
|
1929
|
-
}
|
|
1930
|
-
},
|
|
1931
|
-
"Card": {
|
|
1932
|
-
"docs": {
|
|
1933
|
-
"description": "A basic card component, unstyled by default.\n\n## Component API\n\n### Background\n\nIn order to control the background of a card, the following tokens are currently\nsupported:\n\n- `backgroundColor`\n\n### Border\n\nThe following border tokens can be used:\n\n- `borderColor`\n- `borderRadius`\n- `borderWidth`\n\n### Padding\n\nPlease use the following tokens to control the padding:\n\n- `paddingBottom`\n- `paddingLeft`\n- `paddingRight`\n- `paddingTop`\n\nNote that various viewport sizes are supported as well.\n\n### Shadow\n\nFeel free to use the following properties within the `shadow` token:\n\n- `inset`: boolean\n- `color`: string\n- `offsetX`: number\n- `offsetY`: number\n- `blur`: number\n- `spread`: number\n\n## Accessibility\n\nCard supports all the common a11y props. Please remember that by marking a card as `accessible`\nyou automatically make inaccessible its children, which may or may not be appropriate\ndepending on what you are trying to achieve.",
|
|
1934
|
-
"props": {
|
|
1935
|
-
"children": {
|
|
1936
|
-
"type": {
|
|
1937
|
-
"name": "node"
|
|
1938
|
-
},
|
|
1939
|
-
"required": false,
|
|
1940
|
-
"description": ""
|
|
1941
|
-
},
|
|
1942
|
-
"tokens": {
|
|
1943
|
-
"type": {
|
|
1944
|
-
"name": "custom",
|
|
1945
|
-
"raw": {
|
|
1946
|
-
"flex": "integer",
|
|
1947
|
-
"backgroundColor": "color",
|
|
1948
|
-
"borderColor": "color",
|
|
1949
|
-
"borderRadius": "radius",
|
|
1950
|
-
"borderWidth": "border",
|
|
1951
|
-
"paddingBottom": "size",
|
|
1952
|
-
"paddingLeft": "size",
|
|
1953
|
-
"paddingRight": "size",
|
|
1954
|
-
"paddingTop": "size",
|
|
1955
|
-
"minWidth": "size",
|
|
1956
|
-
"shadow": "shadow"
|
|
1957
|
-
}
|
|
1958
|
-
},
|
|
1959
|
-
"required": false,
|
|
1960
|
-
"description": ""
|
|
1961
|
-
},
|
|
1962
|
-
"variant": {
|
|
2189
|
+
"children": {
|
|
1963
2190
|
"type": {
|
|
1964
|
-
"name": "
|
|
1965
|
-
"value": {
|
|
1966
|
-
"name": "union",
|
|
1967
|
-
"value": [
|
|
1968
|
-
{
|
|
1969
|
-
"name": "string"
|
|
1970
|
-
},
|
|
1971
|
-
{
|
|
1972
|
-
"name": "number"
|
|
1973
|
-
},
|
|
1974
|
-
{
|
|
1975
|
-
"name": "bool"
|
|
1976
|
-
}
|
|
1977
|
-
]
|
|
1978
|
-
}
|
|
2191
|
+
"name": "node"
|
|
1979
2192
|
},
|
|
1980
|
-
"required":
|
|
1981
|
-
"description": ""
|
|
2193
|
+
"required": true,
|
|
2194
|
+
"description": "Box accepts any content as children."
|
|
1982
2195
|
}
|
|
1983
2196
|
},
|
|
1984
2197
|
"attributes": {
|
|
@@ -1986,28 +2199,13 @@
|
|
|
1986
2199
|
}
|
|
1987
2200
|
}
|
|
1988
2201
|
},
|
|
1989
|
-
"
|
|
2202
|
+
"Card": {
|
|
1990
2203
|
"docs": {
|
|
1991
|
-
"description": "A
|
|
2204
|
+
"description": "A basic card component, unstyled by default.\n\n## Component API\n\n### Background\n\nIn order to control the background of a card, the following tokens are currently\nsupported:\n\n- `backgroundColor`\n\n### Border\n\nThe following border tokens can be used:\n\n- `borderColor`\n- `borderRadius`\n- `borderWidth`\n\n### Padding\n\nPlease use the following tokens to control the padding:\n\n- `paddingBottom`\n- `paddingLeft`\n- `paddingRight`\n- `paddingTop`\n\nNote that various viewport sizes are supported as well.\n\n### Shadow\n\nFeel free to use the following properties within the `shadow` token:\n\n- `inset`: boolean\n- `color`: string\n- `offsetX`: number\n- `offsetY`: number\n- `blur`: number\n- `spread`: number\n\n## Accessibility\n\nCard supports all the common a11y props. Please remember that by marking a card as `accessible`\nyou automatically make inaccessible its children, which may or may not be appropriate\ndepending on what you are trying to achieve.",
|
|
1992
2205
|
"props": {
|
|
1993
|
-
"accessibilityRole": {
|
|
1994
|
-
"defaultValue": {
|
|
1995
|
-
"value": "href ? 'link' : undefined",
|
|
1996
|
-
"computed": false
|
|
1997
|
-
},
|
|
1998
|
-
"required": false
|
|
1999
|
-
},
|
|
2000
2206
|
"children": {
|
|
2001
2207
|
"type": {
|
|
2002
|
-
"name": "
|
|
2003
|
-
"value": [
|
|
2004
|
-
{
|
|
2005
|
-
"name": "func"
|
|
2006
|
-
},
|
|
2007
|
-
{
|
|
2008
|
-
"name": "node"
|
|
2009
|
-
}
|
|
2010
|
-
]
|
|
2208
|
+
"name": "node"
|
|
2011
2209
|
},
|
|
2012
2210
|
"required": false,
|
|
2013
2211
|
"description": ""
|
|
@@ -2015,7 +2213,19 @@
|
|
|
2015
2213
|
"tokens": {
|
|
2016
2214
|
"type": {
|
|
2017
2215
|
"name": "custom",
|
|
2018
|
-
"raw":
|
|
2216
|
+
"raw": {
|
|
2217
|
+
"flex": "integer",
|
|
2218
|
+
"backgroundColor": "color",
|
|
2219
|
+
"borderColor": "color",
|
|
2220
|
+
"borderRadius": "radius",
|
|
2221
|
+
"borderWidth": "border",
|
|
2222
|
+
"paddingBottom": "size",
|
|
2223
|
+
"paddingLeft": "size",
|
|
2224
|
+
"paddingRight": "size",
|
|
2225
|
+
"paddingTop": "size",
|
|
2226
|
+
"minWidth": "size",
|
|
2227
|
+
"shadow": "shadow"
|
|
2228
|
+
}
|
|
2019
2229
|
},
|
|
2020
2230
|
"required": false,
|
|
2021
2231
|
"description": ""
|
|
@@ -2245,256 +2455,29 @@
|
|
|
2245
2455
|
"name": "union",
|
|
2246
2456
|
"value": [
|
|
2247
2457
|
{
|
|
2248
|
-
"name": "string"
|
|
2249
|
-
},
|
|
2250
|
-
{
|
|
2251
|
-
"name": "number"
|
|
2252
|
-
},
|
|
2253
|
-
{
|
|
2254
|
-
"name": "bool"
|
|
2255
|
-
}
|
|
2256
|
-
]
|
|
2257
|
-
}
|
|
2258
|
-
},
|
|
2259
|
-
"required": false,
|
|
2260
|
-
"description": ""
|
|
2261
|
-
}
|
|
2262
|
-
},
|
|
2263
|
-
"attributes": {
|
|
2264
|
-
"acceptsRNA11yProps": false
|
|
2265
|
-
}
|
|
2266
|
-
}
|
|
2267
|
-
},
|
|
2268
|
-
"ExpandCollapse": {
|
|
2269
|
-
"docs": {
|
|
2270
|
-
"description": "Flexible base component for lists where some or all items are collapsible headers.\n\nPass a render function as `children` which takes and passes `openIds` and `onToggle` props to\n<ExpandCollapse.Panel> children, and assign the panels explicit `panelId` props. The panels may be\nnested (they do not need to be direct children), and non-interactive items may be included too.",
|
|
2271
|
-
"props": {
|
|
2272
|
-
"variant": {
|
|
2273
|
-
"type": {
|
|
2274
|
-
"name": "objectOf",
|
|
2275
|
-
"value": {
|
|
2276
|
-
"name": "union",
|
|
2277
|
-
"value": [
|
|
2278
|
-
{
|
|
2279
|
-
"name": "string"
|
|
2280
|
-
},
|
|
2281
|
-
{
|
|
2282
|
-
"name": "number"
|
|
2283
|
-
},
|
|
2284
|
-
{
|
|
2285
|
-
"name": "bool"
|
|
2286
|
-
}
|
|
2287
|
-
]
|
|
2288
|
-
}
|
|
2289
|
-
},
|
|
2290
|
-
"required": false,
|
|
2291
|
-
"description": ""
|
|
2292
|
-
},
|
|
2293
|
-
"tokens": {
|
|
2294
|
-
"type": {
|
|
2295
|
-
"name": "custom",
|
|
2296
|
-
"raw": {
|
|
2297
|
-
"borderColor": "color",
|
|
2298
|
-
"borderWidth": "border",
|
|
2299
|
-
"borderStyle": "borderStyle"
|
|
2300
|
-
}
|
|
2301
|
-
},
|
|
2302
|
-
"required": false,
|
|
2303
|
-
"description": ""
|
|
2304
|
-
},
|
|
2305
|
-
"children": {
|
|
2306
|
-
"type": {
|
|
2307
|
-
"name": "union",
|
|
2308
|
-
"value": [
|
|
2309
|
-
{
|
|
2310
|
-
"name": "func"
|
|
2311
|
-
},
|
|
2312
|
-
{
|
|
2313
|
-
"name": "node"
|
|
2314
|
-
}
|
|
2315
|
-
]
|
|
2316
|
-
},
|
|
2317
|
-
"required": true,
|
|
2318
|
-
"description": "ExpandCollapse usually takes a render function to which it passes an object with properties\n{ openIds, onToggle, resetValues, setValues, unsetValues }. openIds (array of ids) and\nonToggle (function) will usually be passed to `<ExpandCollapse.Panel>`"
|
|
2319
|
-
},
|
|
2320
|
-
"maxOpen": {
|
|
2321
|
-
"type": {
|
|
2322
|
-
"name": "number"
|
|
2323
|
-
},
|
|
2324
|
-
"required": false,
|
|
2325
|
-
"description": "If set, enforces a specific maximum number of open items, closing already-open items when new\nitems are opened. By default, any number of items may be open at once."
|
|
2326
|
-
},
|
|
2327
|
-
"open": {
|
|
2328
|
-
"type": {
|
|
2329
|
-
"name": "arrayOf",
|
|
2330
|
-
"value": {
|
|
2331
|
-
"name": "string"
|
|
2332
|
-
}
|
|
2333
|
-
},
|
|
2334
|
-
"required": false,
|
|
2335
|
-
"description": "If passed, the item or items that are expanded will be controlled by a parent component"
|
|
2336
|
-
},
|
|
2337
|
-
"onChange": {
|
|
2338
|
-
"type": {
|
|
2339
|
-
"name": "func"
|
|
2340
|
-
},
|
|
2341
|
-
"required": false,
|
|
2342
|
-
"description": "Function called when which panels are currently open changes. Necessary if `open` is passed."
|
|
2343
|
-
},
|
|
2344
|
-
"initialOpen": {
|
|
2345
|
-
"type": {
|
|
2346
|
-
"name": "arrayOf",
|
|
2347
|
-
"value": {
|
|
2348
|
-
"name": "string"
|
|
2349
|
-
}
|
|
2350
|
-
},
|
|
2351
|
-
"required": false,
|
|
2352
|
-
"description": "Allows items with specified ids to be open by default on first load. Should not be used with `open`."
|
|
2353
|
-
}
|
|
2354
|
-
},
|
|
2355
|
-
"attributes": {
|
|
2356
|
-
"acceptsRNA11yProps": false
|
|
2357
|
-
}
|
|
2358
|
-
},
|
|
2359
|
-
"Panel": {
|
|
2360
|
-
"docs": {
|
|
2361
|
-
"description": "An item in an `ExpandCollapse` which contains collapsible `children` and a `control` that opens\nand closes the collapsible children when pressed.\n\nExpects `openIds` and `onToggle` props from the `ExpandCollapse` render function and a unique\n`panelId` that matches the ids passed to the `<ExpandCollapse>`.\n\nThe panel does not need to be a direct child of the `<ExpandCollapse>` (unless this is required\nby the chosen accessibility props for a particular accessibility tools).",
|
|
2362
|
-
"props": {
|
|
2363
|
-
"openIds": {
|
|
2364
|
-
"defaultValue": {
|
|
2365
|
-
"value": "[]",
|
|
2366
|
-
"computed": false
|
|
2367
|
-
},
|
|
2368
|
-
"type": {
|
|
2369
|
-
"name": "arrayOf",
|
|
2370
|
-
"value": {
|
|
2371
|
-
"name": "union",
|
|
2372
|
-
"value": [
|
|
2373
|
-
{
|
|
2374
|
-
"name": "number"
|
|
2375
|
-
},
|
|
2376
|
-
{
|
|
2377
|
-
"name": "string"
|
|
2378
|
-
}
|
|
2379
|
-
]
|
|
2380
|
-
}
|
|
2381
|
-
},
|
|
2382
|
-
"required": false,
|
|
2383
|
-
"description": "Array of the ids of currently open groups"
|
|
2384
|
-
},
|
|
2385
|
-
"variant": {
|
|
2386
|
-
"type": {
|
|
2387
|
-
"name": "objectOf",
|
|
2388
|
-
"value": {
|
|
2389
|
-
"name": "union",
|
|
2390
|
-
"value": [
|
|
2391
|
-
{
|
|
2392
|
-
"name": "string"
|
|
2393
|
-
},
|
|
2394
|
-
{
|
|
2395
|
-
"name": "number"
|
|
2396
|
-
},
|
|
2397
|
-
{
|
|
2398
|
-
"name": "bool"
|
|
2399
|
-
}
|
|
2400
|
-
]
|
|
2401
|
-
}
|
|
2402
|
-
},
|
|
2403
|
-
"required": false,
|
|
2404
|
-
"description": ""
|
|
2405
|
-
},
|
|
2406
|
-
"tokens": {
|
|
2407
|
-
"type": {
|
|
2408
|
-
"name": "custom",
|
|
2409
|
-
"raw": {
|
|
2410
|
-
"expandDuration": "duration",
|
|
2411
|
-
"collapseDuration": "duration",
|
|
2412
|
-
"contentPaddingLeft": "size",
|
|
2413
|
-
"contentPaddingRight": "size",
|
|
2414
|
-
"contentPaddingTop": "size",
|
|
2415
|
-
"contentPaddingBottom": "size"
|
|
2416
|
-
}
|
|
2417
|
-
},
|
|
2418
|
-
"required": false,
|
|
2419
|
-
"description": ""
|
|
2420
|
-
},
|
|
2421
|
-
"panelId": {
|
|
2422
|
-
"type": {
|
|
2423
|
-
"name": "string"
|
|
2424
|
-
},
|
|
2425
|
-
"required": true,
|
|
2426
|
-
"description": "Unique name by which the ExpandCollapse controls this element."
|
|
2427
|
-
},
|
|
2428
|
-
"onToggle": {
|
|
2429
|
-
"type": {
|
|
2430
|
-
"name": "func"
|
|
2431
|
-
},
|
|
2432
|
-
"required": true,
|
|
2433
|
-
"description": "Function to call on pressing the panel's control, which should open or close the panel.\nIf Panel is a direct child of `ExpandCollapse`, this prop will be provided by the ExpandCollapse parent."
|
|
2434
|
-
},
|
|
2435
|
-
"onPress": {
|
|
2436
|
-
"type": {
|
|
2437
|
-
"name": "func"
|
|
2438
|
-
},
|
|
2439
|
-
"required": false,
|
|
2440
|
-
"description": "Optional function to call on pressing the panel's control, in addition to opening or closing the panel."
|
|
2441
|
-
},
|
|
2442
|
-
"children": {
|
|
2443
|
-
"type": {
|
|
2444
|
-
"name": "union",
|
|
2445
|
-
"value": [
|
|
2446
|
-
{
|
|
2447
|
-
"name": "func"
|
|
2458
|
+
"name": "string"
|
|
2448
2459
|
},
|
|
2449
2460
|
{
|
|
2450
|
-
"name": "
|
|
2461
|
+
"name": "number"
|
|
2462
|
+
},
|
|
2463
|
+
{
|
|
2464
|
+
"name": "bool"
|
|
2451
2465
|
}
|
|
2452
2466
|
]
|
|
2453
|
-
}
|
|
2454
|
-
"required": false,
|
|
2455
|
-
"description": "ExpandCollapsePanel's children are the content that is hidden or revealed on open or close, and may be any\nsingle React element or a render function which takes this group's isExpanded state, onToggle function and panelId"
|
|
2456
|
-
},
|
|
2457
|
-
"control": {
|
|
2458
|
-
"type": {
|
|
2459
|
-
"name": "custom",
|
|
2460
|
-
"raw": "ExpandCollapseControl.propTypes.children.isRequired"
|
|
2461
|
-
},
|
|
2462
|
-
"required": false,
|
|
2463
|
-
"description": "The content inside the always-visible control element that opens and closes the ExpandCollapse when pressed."
|
|
2467
|
+
}
|
|
2464
2468
|
},
|
|
2465
|
-
"
|
|
2466
|
-
|
|
2467
|
-
"name": "custom",
|
|
2468
|
-
"raw": {
|
|
2469
|
-
"icon": "icon",
|
|
2470
|
-
"iconColor": "color",
|
|
2471
|
-
"iconSize": "size",
|
|
2472
|
-
"iconGap": "size",
|
|
2473
|
-
"iconPosition": "position",
|
|
2474
|
-
"verticalAlign": "verticalAlign",
|
|
2475
|
-
"justifyContent": "flexJustifyContent",
|
|
2476
|
-
"paddingLeft": "size",
|
|
2477
|
-
"paddingRight": "size",
|
|
2478
|
-
"paddingTop": "size",
|
|
2479
|
-
"paddingBottom": "size",
|
|
2480
|
-
"borderWidth": "border",
|
|
2481
|
-
"borderColor": "color",
|
|
2482
|
-
"backgroundColor": "color"
|
|
2483
|
-
}
|
|
2484
|
-
},
|
|
2485
|
-
"required": false,
|
|
2486
|
-
"description": "Optional theme token overrides that may be passed to the ExpandCollapseControl element."
|
|
2487
|
-
}
|
|
2488
|
-
},
|
|
2489
|
-
"attributes": {
|
|
2490
|
-
"acceptsRNA11yProps": false
|
|
2469
|
+
"required": false,
|
|
2470
|
+
"description": ""
|
|
2491
2471
|
}
|
|
2472
|
+
},
|
|
2473
|
+
"attributes": {
|
|
2474
|
+
"acceptsRNA11yProps": false
|
|
2492
2475
|
}
|
|
2493
2476
|
}
|
|
2494
2477
|
},
|
|
2495
|
-
"
|
|
2478
|
+
"ExpandCollapse": {
|
|
2496
2479
|
"docs": {
|
|
2497
|
-
"description": "
|
|
2480
|
+
"description": "Flexible base component for lists where some or all items are collapsible headers.\n\nPass a render function as `children` which takes and passes `openIds` and `onToggle` props to\n<ExpandCollapse.Panel> children, and assign the panels explicit `panelId` props. The panels may be\nnested (they do not need to be direct children), and non-interactive items may be included too.",
|
|
2498
2481
|
"props": {
|
|
2499
2482
|
"variant": {
|
|
2500
2483
|
"type": {
|
|
@@ -2824,6 +2807,27 @@
|
|
|
2824
2807
|
"docs": {
|
|
2825
2808
|
"description": "An alternative to InputSupports for groups of input elements that, on web, are to be\nwrapped in a `<fieldset>` tag, with label content displated in a `<legend>` tag.\n\nFollows the same theming and most of the same props as InputSupports.",
|
|
2826
2809
|
"props": {
|
|
2810
|
+
"copy": {
|
|
2811
|
+
"defaultValue": {
|
|
2812
|
+
"value": "'en'",
|
|
2813
|
+
"computed": false
|
|
2814
|
+
},
|
|
2815
|
+
"type": {
|
|
2816
|
+
"name": "enum",
|
|
2817
|
+
"value": [
|
|
2818
|
+
{
|
|
2819
|
+
"value": "'en'",
|
|
2820
|
+
"computed": false
|
|
2821
|
+
},
|
|
2822
|
+
{
|
|
2823
|
+
"value": "'fr'",
|
|
2824
|
+
"computed": false
|
|
2825
|
+
}
|
|
2826
|
+
]
|
|
2827
|
+
},
|
|
2828
|
+
"required": false,
|
|
2829
|
+
"description": "Whether the English or French copy will be used (e.g. for accessibility labels)."
|
|
2830
|
+
},
|
|
2827
2831
|
"feedbackPosition": {
|
|
2828
2832
|
"defaultValue": {
|
|
2829
2833
|
"value": "'top'",
|
|
@@ -4182,6 +4186,27 @@
|
|
|
4182
4186
|
"docs": {
|
|
4183
4187
|
"description": "",
|
|
4184
4188
|
"props": {
|
|
4189
|
+
"copy": {
|
|
4190
|
+
"defaultValue": {
|
|
4191
|
+
"value": "'en'",
|
|
4192
|
+
"computed": false
|
|
4193
|
+
},
|
|
4194
|
+
"type": {
|
|
4195
|
+
"name": "enum",
|
|
4196
|
+
"value": [
|
|
4197
|
+
{
|
|
4198
|
+
"value": "'en'",
|
|
4199
|
+
"computed": false
|
|
4200
|
+
},
|
|
4201
|
+
{
|
|
4202
|
+
"value": "'fr'",
|
|
4203
|
+
"computed": false
|
|
4204
|
+
}
|
|
4205
|
+
]
|
|
4206
|
+
},
|
|
4207
|
+
"required": false,
|
|
4208
|
+
"description": "Whether the English or French copy will be used (e.g. for accessibility labels)."
|
|
4209
|
+
},
|
|
4185
4210
|
"hintPosition": {
|
|
4186
4211
|
"defaultValue": {
|
|
4187
4212
|
"value": "'inline'",
|
|
@@ -4442,91 +4467,6 @@
|
|
|
4442
4467
|
}
|
|
4443
4468
|
}
|
|
4444
4469
|
},
|
|
4445
|
-
"ListItem": {
|
|
4446
|
-
"docs": {
|
|
4447
|
-
"description": "ListItem is responsible for rendering icon or a bullet as side item",
|
|
4448
|
-
"props": {
|
|
4449
|
-
"tokens": {
|
|
4450
|
-
"type": {
|
|
4451
|
-
"name": "custom",
|
|
4452
|
-
"raw": {
|
|
4453
|
-
"iconMarginTop": "size",
|
|
4454
|
-
"itemFontWeight": "fontWeight",
|
|
4455
|
-
"itemFontSize": "fontSize",
|
|
4456
|
-
"itemLineHeight": "lineHeight",
|
|
4457
|
-
"itemFontName": "fontName",
|
|
4458
|
-
"interItemMargin": "size",
|
|
4459
|
-
"interItemMarginWithDivider": "size",
|
|
4460
|
-
"dividerColor": "color",
|
|
4461
|
-
"dividerSize": "border",
|
|
4462
|
-
"itemBulletContainerWidth": "size",
|
|
4463
|
-
"itemBulletContainerAlign": "textAlign",
|
|
4464
|
-
"itemBulletWidth": "size",
|
|
4465
|
-
"itemBulletHeight": "size",
|
|
4466
|
-
"itemBulletColor": "color",
|
|
4467
|
-
"itemIconSize": "size",
|
|
4468
|
-
"itemIconColor": "color",
|
|
4469
|
-
"listGutter": "size"
|
|
4470
|
-
}
|
|
4471
|
-
},
|
|
4472
|
-
"required": false,
|
|
4473
|
-
"description": ""
|
|
4474
|
-
},
|
|
4475
|
-
"variant": {
|
|
4476
|
-
"type": {
|
|
4477
|
-
"name": "objectOf",
|
|
4478
|
-
"value": {
|
|
4479
|
-
"name": "union",
|
|
4480
|
-
"value": [
|
|
4481
|
-
{
|
|
4482
|
-
"name": "string"
|
|
4483
|
-
},
|
|
4484
|
-
{
|
|
4485
|
-
"name": "number"
|
|
4486
|
-
},
|
|
4487
|
-
{
|
|
4488
|
-
"name": "bool"
|
|
4489
|
-
}
|
|
4490
|
-
]
|
|
4491
|
-
}
|
|
4492
|
-
},
|
|
4493
|
-
"required": false,
|
|
4494
|
-
"description": ""
|
|
4495
|
-
},
|
|
4496
|
-
"children": {
|
|
4497
|
-
"type": {
|
|
4498
|
-
"name": "node"
|
|
4499
|
-
},
|
|
4500
|
-
"required": true,
|
|
4501
|
-
"description": ""
|
|
4502
|
-
},
|
|
4503
|
-
"icon": {
|
|
4504
|
-
"type": {
|
|
4505
|
-
"name": "func"
|
|
4506
|
-
},
|
|
4507
|
-
"required": false,
|
|
4508
|
-
"description": "Renders side item icon"
|
|
4509
|
-
},
|
|
4510
|
-
"iconColor": {
|
|
4511
|
-
"type": {
|
|
4512
|
-
"name": "string"
|
|
4513
|
-
},
|
|
4514
|
-
"required": false,
|
|
4515
|
-
"description": "Will set display icon color"
|
|
4516
|
-
},
|
|
4517
|
-
"iconSize": {
|
|
4518
|
-
"type": {
|
|
4519
|
-
"name": "number"
|
|
4520
|
-
},
|
|
4521
|
-
"required": false,
|
|
4522
|
-
"description": "Allow the user define the icon size if not defined the theme's file"
|
|
4523
|
-
}
|
|
4524
|
-
},
|
|
4525
|
-
"attributes": {
|
|
4526
|
-
"acceptsRNA11yProps": false
|
|
4527
|
-
}
|
|
4528
|
-
}
|
|
4529
|
-
},
|
|
4530
4470
|
"ListBase": {
|
|
4531
4471
|
"docs": {
|
|
4532
4472
|
"description": "An unordered List component has a child a ListItem that\nallows icon, dividers and customized typography",
|
|
@@ -4649,38 +4589,123 @@
|
|
|
4649
4589
|
"required": false,
|
|
4650
4590
|
"description": ""
|
|
4651
4591
|
},
|
|
4652
|
-
"children": {
|
|
4653
|
-
"type": {
|
|
4654
|
-
"name": "node"
|
|
4655
|
-
},
|
|
4656
|
-
"required": true,
|
|
4657
|
-
"description": ""
|
|
4592
|
+
"children": {
|
|
4593
|
+
"type": {
|
|
4594
|
+
"name": "node"
|
|
4595
|
+
},
|
|
4596
|
+
"required": true,
|
|
4597
|
+
"description": ""
|
|
4598
|
+
},
|
|
4599
|
+
"icon": {
|
|
4600
|
+
"type": {
|
|
4601
|
+
"name": "func"
|
|
4602
|
+
},
|
|
4603
|
+
"required": false,
|
|
4604
|
+
"description": "Renders side item icon"
|
|
4605
|
+
},
|
|
4606
|
+
"iconColor": {
|
|
4607
|
+
"type": {
|
|
4608
|
+
"name": "string"
|
|
4609
|
+
},
|
|
4610
|
+
"required": false,
|
|
4611
|
+
"description": "Will set display icon color"
|
|
4612
|
+
},
|
|
4613
|
+
"iconSize": {
|
|
4614
|
+
"type": {
|
|
4615
|
+
"name": "number"
|
|
4616
|
+
},
|
|
4617
|
+
"required": false,
|
|
4618
|
+
"description": "Allow the user define the icon size if not defined the theme's file"
|
|
4619
|
+
}
|
|
4620
|
+
},
|
|
4621
|
+
"attributes": {
|
|
4622
|
+
"acceptsRNA11yProps": false
|
|
4623
|
+
}
|
|
4624
|
+
}
|
|
4625
|
+
}
|
|
4626
|
+
},
|
|
4627
|
+
"ListItem": {
|
|
4628
|
+
"docs": {
|
|
4629
|
+
"description": "ListItem is responsible for rendering icon or a bullet as side item",
|
|
4630
|
+
"props": {
|
|
4631
|
+
"tokens": {
|
|
4632
|
+
"type": {
|
|
4633
|
+
"name": "custom",
|
|
4634
|
+
"raw": {
|
|
4635
|
+
"iconMarginTop": "size",
|
|
4636
|
+
"itemFontWeight": "fontWeight",
|
|
4637
|
+
"itemFontSize": "fontSize",
|
|
4638
|
+
"itemLineHeight": "lineHeight",
|
|
4639
|
+
"itemFontName": "fontName",
|
|
4640
|
+
"interItemMargin": "size",
|
|
4641
|
+
"interItemMarginWithDivider": "size",
|
|
4642
|
+
"dividerColor": "color",
|
|
4643
|
+
"dividerSize": "border",
|
|
4644
|
+
"itemBulletContainerWidth": "size",
|
|
4645
|
+
"itemBulletContainerAlign": "textAlign",
|
|
4646
|
+
"itemBulletWidth": "size",
|
|
4647
|
+
"itemBulletHeight": "size",
|
|
4648
|
+
"itemBulletColor": "color",
|
|
4649
|
+
"itemIconSize": "size",
|
|
4650
|
+
"itemIconColor": "color",
|
|
4651
|
+
"listGutter": "size"
|
|
4652
|
+
}
|
|
4653
|
+
},
|
|
4654
|
+
"required": false,
|
|
4655
|
+
"description": ""
|
|
4656
|
+
},
|
|
4657
|
+
"variant": {
|
|
4658
|
+
"type": {
|
|
4659
|
+
"name": "objectOf",
|
|
4660
|
+
"value": {
|
|
4661
|
+
"name": "union",
|
|
4662
|
+
"value": [
|
|
4663
|
+
{
|
|
4664
|
+
"name": "string"
|
|
4665
|
+
},
|
|
4666
|
+
{
|
|
4667
|
+
"name": "number"
|
|
4668
|
+
},
|
|
4669
|
+
{
|
|
4670
|
+
"name": "bool"
|
|
4671
|
+
}
|
|
4672
|
+
]
|
|
4673
|
+
}
|
|
4674
|
+
},
|
|
4675
|
+
"required": false,
|
|
4676
|
+
"description": ""
|
|
4677
|
+
},
|
|
4678
|
+
"children": {
|
|
4679
|
+
"type": {
|
|
4680
|
+
"name": "node"
|
|
4658
4681
|
},
|
|
4659
|
-
"
|
|
4660
|
-
|
|
4661
|
-
|
|
4662
|
-
|
|
4663
|
-
|
|
4664
|
-
"
|
|
4682
|
+
"required": true,
|
|
4683
|
+
"description": ""
|
|
4684
|
+
},
|
|
4685
|
+
"icon": {
|
|
4686
|
+
"type": {
|
|
4687
|
+
"name": "func"
|
|
4665
4688
|
},
|
|
4666
|
-
"
|
|
4667
|
-
|
|
4668
|
-
|
|
4669
|
-
|
|
4670
|
-
|
|
4671
|
-
"
|
|
4689
|
+
"required": false,
|
|
4690
|
+
"description": "Renders side item icon"
|
|
4691
|
+
},
|
|
4692
|
+
"iconColor": {
|
|
4693
|
+
"type": {
|
|
4694
|
+
"name": "string"
|
|
4672
4695
|
},
|
|
4673
|
-
"
|
|
4674
|
-
|
|
4675
|
-
"name": "number"
|
|
4676
|
-
},
|
|
4677
|
-
"required": false,
|
|
4678
|
-
"description": "Allow the user define the icon size if not defined the theme's file"
|
|
4679
|
-
}
|
|
4696
|
+
"required": false,
|
|
4697
|
+
"description": "Will set display icon color"
|
|
4680
4698
|
},
|
|
4681
|
-
"
|
|
4682
|
-
"
|
|
4699
|
+
"iconSize": {
|
|
4700
|
+
"type": {
|
|
4701
|
+
"name": "number"
|
|
4702
|
+
},
|
|
4703
|
+
"required": false,
|
|
4704
|
+
"description": "Allow the user define the icon size if not defined the theme's file"
|
|
4683
4705
|
}
|
|
4706
|
+
},
|
|
4707
|
+
"attributes": {
|
|
4708
|
+
"acceptsRNA11yProps": false
|
|
4684
4709
|
}
|
|
4685
4710
|
}
|
|
4686
4711
|
},
|
|
@@ -4843,7 +4868,7 @@
|
|
|
4843
4868
|
]
|
|
4844
4869
|
},
|
|
4845
4870
|
"required": false,
|
|
4846
|
-
"description": "Select
|
|
4871
|
+
"description": "Select English or French copy for the accessible label of the dismiss button."
|
|
4847
4872
|
},
|
|
4848
4873
|
"children": {
|
|
4849
4874
|
"type": {
|
|
@@ -5241,6 +5266,67 @@
|
|
|
5241
5266
|
}
|
|
5242
5267
|
}
|
|
5243
5268
|
},
|
|
5269
|
+
"PressableCardBase": {
|
|
5270
|
+
"docs": {
|
|
5271
|
+
"description": "A pressable themeless base component that handles pressable states and passes tokens\nbased on these to an outer border and a base Card component. Not intended to be used in\napps or sites directly: build themed components on top of this.",
|
|
5272
|
+
"props": {
|
|
5273
|
+
"accessibilityRole": {
|
|
5274
|
+
"defaultValue": {
|
|
5275
|
+
"value": "href ? 'link' : undefined",
|
|
5276
|
+
"computed": false
|
|
5277
|
+
},
|
|
5278
|
+
"required": false
|
|
5279
|
+
},
|
|
5280
|
+
"children": {
|
|
5281
|
+
"type": {
|
|
5282
|
+
"name": "union",
|
|
5283
|
+
"value": [
|
|
5284
|
+
{
|
|
5285
|
+
"name": "func"
|
|
5286
|
+
},
|
|
5287
|
+
{
|
|
5288
|
+
"name": "node"
|
|
5289
|
+
}
|
|
5290
|
+
]
|
|
5291
|
+
},
|
|
5292
|
+
"required": false,
|
|
5293
|
+
"description": ""
|
|
5294
|
+
},
|
|
5295
|
+
"tokens": {
|
|
5296
|
+
"type": {
|
|
5297
|
+
"name": "custom",
|
|
5298
|
+
"raw": "getTokensSetPropType(tokenKeys, { requireAll: true, allowFunction: true })"
|
|
5299
|
+
},
|
|
5300
|
+
"required": false,
|
|
5301
|
+
"description": ""
|
|
5302
|
+
},
|
|
5303
|
+
"variant": {
|
|
5304
|
+
"type": {
|
|
5305
|
+
"name": "objectOf",
|
|
5306
|
+
"value": {
|
|
5307
|
+
"name": "union",
|
|
5308
|
+
"value": [
|
|
5309
|
+
{
|
|
5310
|
+
"name": "string"
|
|
5311
|
+
},
|
|
5312
|
+
{
|
|
5313
|
+
"name": "number"
|
|
5314
|
+
},
|
|
5315
|
+
{
|
|
5316
|
+
"name": "bool"
|
|
5317
|
+
}
|
|
5318
|
+
]
|
|
5319
|
+
}
|
|
5320
|
+
},
|
|
5321
|
+
"required": false,
|
|
5322
|
+
"description": ""
|
|
5323
|
+
}
|
|
5324
|
+
},
|
|
5325
|
+
"attributes": {
|
|
5326
|
+
"acceptsRNA11yProps": false
|
|
5327
|
+
}
|
|
5328
|
+
}
|
|
5329
|
+
},
|
|
5244
5330
|
"Progress": {
|
|
5245
5331
|
"docs": {
|
|
5246
5332
|
"description": "The `Progress` is a container for displaying one or several `ProgressBar`s.\n\n## Props\n\n- Use `children` prop to pass one or multiple `ProgressBar`s. Note that in case of stacked progress bars\n each next will be displayed on top of the previous one.\n\n## Tokens\n\n- Use the following tokens to customize the appearance:\n - `backgroundColor` for the background color of the progress container,\n - `borderColor` to control the color of the border,\n - `borderRadius` for the rounded corners,\n - `borderWidth` to change the border width.\n - `height` to control the height of the progress bars displayed within the progress bar container.\n\n## Variants\n\n- Use the `size` variant to control the height of your progress bars: passing `'mini'` will make your\n progress bar container narrower.\n\n## Usability and A11y guidelines\n\n`Progress` component accepts the standard accessibility properties, however it's more important to make sure\nits children (instances of `ProgressBar`) receive the accessibility properties specific to the `progressbar`\nrole.",
|
|
@@ -5742,7 +5828,7 @@
|
|
|
5742
5828
|
]
|
|
5743
5829
|
},
|
|
5744
5830
|
"required": false,
|
|
5745
|
-
"description": "Select
|
|
5831
|
+
"description": "Select English or French copy for the accessible labels.\nYou may also pass in a custom dictionary object."
|
|
5746
5832
|
},
|
|
5747
5833
|
"initialValue": {
|
|
5748
5834
|
"type": {
|
|
@@ -5786,6 +5872,13 @@
|
|
|
5786
5872
|
"required": false,
|
|
5787
5873
|
"description": "Triggered when the clear button is pressed."
|
|
5788
5874
|
},
|
|
5875
|
+
"onFocus": {
|
|
5876
|
+
"type": {
|
|
5877
|
+
"name": "func"
|
|
5878
|
+
},
|
|
5879
|
+
"required": false,
|
|
5880
|
+
"description": "Triggered when the search input is focused."
|
|
5881
|
+
},
|
|
5789
5882
|
"accessibilityLabel": {
|
|
5790
5883
|
"type": {
|
|
5791
5884
|
"name": "string"
|
|
@@ -6357,6 +6450,27 @@
|
|
|
6357
6450
|
"docs": {
|
|
6358
6451
|
"description": "",
|
|
6359
6452
|
"props": {
|
|
6453
|
+
"sizeIndex": {
|
|
6454
|
+
"defaultValue": {
|
|
6455
|
+
"value": "size",
|
|
6456
|
+
"computed": true
|
|
6457
|
+
},
|
|
6458
|
+
"type": {
|
|
6459
|
+
"name": "union",
|
|
6460
|
+
"value": [
|
|
6461
|
+
{
|
|
6462
|
+
"name": "custom",
|
|
6463
|
+
"raw": "spacingIndexPropType"
|
|
6464
|
+
},
|
|
6465
|
+
{
|
|
6466
|
+
"name": "custom",
|
|
6467
|
+
"raw": "spacingObjectPropType"
|
|
6468
|
+
}
|
|
6469
|
+
]
|
|
6470
|
+
},
|
|
6471
|
+
"required": false,
|
|
6472
|
+
"description": "Sets the size of Skeleton lines or shape according to the theme's spacing scale. For example, size={1} gives the smallest non-zero theme-defined spacing size.\n\nMay also accept an object with responsive viewport keys or spacing scale options - see `useSpacingScale` for details."
|
|
6473
|
+
},
|
|
6360
6474
|
"shape": {
|
|
6361
6475
|
"defaultValue": {
|
|
6362
6476
|
"value": "'line'",
|
|
@@ -6380,7 +6494,7 @@
|
|
|
6380
6494
|
]
|
|
6381
6495
|
},
|
|
6382
6496
|
"required": false,
|
|
6383
|
-
"description": ""
|
|
6497
|
+
"description": "Determines if the skeleton should resemble lines of text (default), a circle, or a square box with themed rounded corners."
|
|
6384
6498
|
},
|
|
6385
6499
|
"tokens": {
|
|
6386
6500
|
"type": {
|
|
@@ -6421,24 +6535,42 @@
|
|
|
6421
6535
|
},
|
|
6422
6536
|
"size": {
|
|
6423
6537
|
"type": {
|
|
6424
|
-
"name": "
|
|
6538
|
+
"name": "union",
|
|
6539
|
+
"value": [
|
|
6540
|
+
{
|
|
6541
|
+
"name": "custom",
|
|
6542
|
+
"raw": "spacingIndexPropType"
|
|
6543
|
+
},
|
|
6544
|
+
{
|
|
6545
|
+
"name": "custom",
|
|
6546
|
+
"raw": "spacingObjectPropType"
|
|
6547
|
+
}
|
|
6548
|
+
]
|
|
6425
6549
|
},
|
|
6426
6550
|
"required": false,
|
|
6427
|
-
"description": ""
|
|
6551
|
+
"description": "@deprecated alias for `sizeIndex`"
|
|
6552
|
+
},
|
|
6553
|
+
"sizePixels": {
|
|
6554
|
+
"type": {
|
|
6555
|
+
"name": "custom",
|
|
6556
|
+
"raw": "responsiveProps.getTypeOptionallyByViewport(propTypes.number)"
|
|
6557
|
+
},
|
|
6558
|
+
"required": false,
|
|
6559
|
+
"description": "Sets the size of Skeleton lines or shape to an exact number of pixels. Use when it's necessary to exactly match sizes of images or other boxes.\n\nAccepts a number or an object with responsive viewport keys, e.g. { xs: 32, lg: 64 } would be 32px at xs, sm and md and 64 at lg and xl viewports."
|
|
6428
6560
|
},
|
|
6429
6561
|
"characters": {
|
|
6430
6562
|
"type": {
|
|
6431
6563
|
"name": "number"
|
|
6432
6564
|
},
|
|
6433
6565
|
"required": false,
|
|
6434
|
-
"description": ""
|
|
6566
|
+
"description": "Determines the width of simulated lines of text if the Skeleton's shape is 'line' (the default shape).\n\nOnly has any affect if shape is line (the default). If unset, takes a default value from the theme."
|
|
6435
6567
|
},
|
|
6436
6568
|
"lines": {
|
|
6437
6569
|
"type": {
|
|
6438
6570
|
"name": "number"
|
|
6439
6571
|
},
|
|
6440
6572
|
"required": false,
|
|
6441
|
-
"description": ""
|
|
6573
|
+
"description": "Determines how many Skeleton items are rendered (default 1).\n\nRecommended usage is to simulate paragraphs of text when Skeleton's shape is 'line' (the default shape).\n\nThe amount of spacing between multiple lines is controlled by theme tokens."
|
|
6442
6574
|
}
|
|
6443
6575
|
},
|
|
6444
6576
|
"attributes": {
|
|
@@ -7167,6 +7299,42 @@
|
|
|
7167
7299
|
}
|
|
7168
7300
|
}
|
|
7169
7301
|
},
|
|
7302
|
+
"ThemeProvider": {
|
|
7303
|
+
"docs": {
|
|
7304
|
+
"description": "",
|
|
7305
|
+
"props": {
|
|
7306
|
+
"children": {
|
|
7307
|
+
"type": {
|
|
7308
|
+
"name": "node"
|
|
7309
|
+
},
|
|
7310
|
+
"required": true,
|
|
7311
|
+
"description": ""
|
|
7312
|
+
},
|
|
7313
|
+
"defaultTheme": {
|
|
7314
|
+
"type": {
|
|
7315
|
+
"name": "shape",
|
|
7316
|
+
"value": {
|
|
7317
|
+
"metadata": {
|
|
7318
|
+
"name": "shape",
|
|
7319
|
+
"value": {
|
|
7320
|
+
"themeTokensVersion": {
|
|
7321
|
+
"name": "string",
|
|
7322
|
+
"required": true
|
|
7323
|
+
}
|
|
7324
|
+
},
|
|
7325
|
+
"required": true
|
|
7326
|
+
}
|
|
7327
|
+
}
|
|
7328
|
+
},
|
|
7329
|
+
"required": true,
|
|
7330
|
+
"description": ""
|
|
7331
|
+
}
|
|
7332
|
+
},
|
|
7333
|
+
"attributes": {
|
|
7334
|
+
"acceptsRNA11yProps": false
|
|
7335
|
+
}
|
|
7336
|
+
}
|
|
7337
|
+
},
|
|
7170
7338
|
"Tooltip": {
|
|
7171
7339
|
"docs": {
|
|
7172
7340
|
"description": "Tooltip provides a descriptive and detailed explanation or instructions. It can be used next to an input label\nto help a user fill it in, or as a standalone component.\n\nBy default the TooltipButton component will be used as a control for triggering the tooltip, but you may attach\na tooltip to any other component. A render function can be used to adjust the control's styling on state changes (hover, focus, etc.).\n\n### Positioning\nBy default a Tooltip will be automatically positioned in a way that ensures it fits within the viewport.\nYou may suggest a position with a prop - it will be used, unless the tooltip would end up outside the viewport.\n\n### Usage criteria\n- You may use one when the information is useful only to a small percentage of users (ie. tech savvy people wouldn't need this info).\n- Tooltips may also be useful when vertical space is an issue.",
|
|
@@ -7223,7 +7391,7 @@
|
|
|
7223
7391
|
]
|
|
7224
7392
|
},
|
|
7225
7393
|
"required": false,
|
|
7226
|
-
"description": "Select
|
|
7394
|
+
"description": "Select English or French copy for the accessible label."
|
|
7227
7395
|
},
|
|
7228
7396
|
"children": {
|
|
7229
7397
|
"type": {
|
|
@@ -7560,69 +7728,27 @@
|
|
|
7560
7728
|
},
|
|
7561
7729
|
{
|
|
7562
7730
|
"value": "'h5'",
|
|
7563
|
-
"computed": false
|
|
7564
|
-
},
|
|
7565
|
-
{
|
|
7566
|
-
"value": "'h6'",
|
|
7567
|
-
"computed": false
|
|
7568
|
-
},
|
|
7569
|
-
{
|
|
7570
|
-
"value": "true",
|
|
7571
|
-
"computed": false
|
|
7572
|
-
}
|
|
7573
|
-
]
|
|
7574
|
-
},
|
|
7575
|
-
"required": false,
|
|
7576
|
-
"description": "Renders the text as a semantic heading. If a html heading tag is provided, uses that tag on Web.\n\nDoes not affect styling: <Typography heading=\"h2\"> will render a <h2> that looks like plain text.\nUse both `heading` and `variant` props to render semantic headings that look like headings.\n\nIn native apps, if this is `true` or any html heading tag string and accessibilityRole prop\nis not defined, the accessibilityRole will default to \"heading\"."
|
|
7577
|
-
},
|
|
7578
|
-
"children": {
|
|
7579
|
-
"type": {
|
|
7580
|
-
"name": "node"
|
|
7581
|
-
},
|
|
7582
|
-
"required": false,
|
|
7583
|
-
"description": "Same children allowed as a React Native <Text> node"
|
|
7584
|
-
}
|
|
7585
|
-
},
|
|
7586
|
-
"attributes": {
|
|
7587
|
-
"acceptsRNA11yProps": false
|
|
7588
|
-
}
|
|
7589
|
-
}
|
|
7590
|
-
},
|
|
7591
|
-
"A11yInfoProvider": {
|
|
7592
|
-
"docs": {
|
|
7593
|
-
"description": "",
|
|
7594
|
-
"props": {
|
|
7595
|
-
"children": {
|
|
7596
|
-
"type": {
|
|
7597
|
-
"name": "node"
|
|
7598
|
-
},
|
|
7599
|
-
"required": true,
|
|
7600
|
-
"description": ""
|
|
7601
|
-
}
|
|
7602
|
-
},
|
|
7603
|
-
"attributes": {
|
|
7604
|
-
"acceptsRNA11yProps": false
|
|
7605
|
-
}
|
|
7606
|
-
}
|
|
7607
|
-
},
|
|
7608
|
-
"BaseProvider": {
|
|
7609
|
-
"docs": {
|
|
7610
|
-
"description": "",
|
|
7611
|
-
"props": {
|
|
7612
|
-
"defaultTheme": {
|
|
7613
|
-
"type": {
|
|
7614
|
-
"name": "custom",
|
|
7615
|
-
"raw": "ThemeProvider.propTypes?.defaultTheme"
|
|
7731
|
+
"computed": false
|
|
7732
|
+
},
|
|
7733
|
+
{
|
|
7734
|
+
"value": "'h6'",
|
|
7735
|
+
"computed": false
|
|
7736
|
+
},
|
|
7737
|
+
{
|
|
7738
|
+
"value": "true",
|
|
7739
|
+
"computed": false
|
|
7740
|
+
}
|
|
7741
|
+
]
|
|
7616
7742
|
},
|
|
7617
7743
|
"required": false,
|
|
7618
|
-
"description": ""
|
|
7744
|
+
"description": "Renders the text as a semantic heading. If a html heading tag is provided, uses that tag on Web.\n\nDoes not affect styling: <Typography heading=\"h2\"> will render a <h2> that looks like plain text.\nUse both `heading` and `variant` props to render semantic headings that look like headings.\n\nIn native apps, if this is `true` or any html heading tag string and accessibilityRole prop\nis not defined, the accessibilityRole will default to \"heading\"."
|
|
7619
7745
|
},
|
|
7620
7746
|
"children": {
|
|
7621
7747
|
"type": {
|
|
7622
7748
|
"name": "node"
|
|
7623
7749
|
},
|
|
7624
|
-
"required":
|
|
7625
|
-
"description": ""
|
|
7750
|
+
"required": false,
|
|
7751
|
+
"description": "Same children allowed as a React Native <Text> node"
|
|
7626
7752
|
}
|
|
7627
7753
|
},
|
|
7628
7754
|
"attributes": {
|
|
@@ -7647,42 +7773,6 @@
|
|
|
7647
7773
|
}
|
|
7648
7774
|
}
|
|
7649
7775
|
},
|
|
7650
|
-
"ThemeProvider": {
|
|
7651
|
-
"docs": {
|
|
7652
|
-
"description": "",
|
|
7653
|
-
"props": {
|
|
7654
|
-
"children": {
|
|
7655
|
-
"type": {
|
|
7656
|
-
"name": "node"
|
|
7657
|
-
},
|
|
7658
|
-
"required": true,
|
|
7659
|
-
"description": ""
|
|
7660
|
-
},
|
|
7661
|
-
"defaultTheme": {
|
|
7662
|
-
"type": {
|
|
7663
|
-
"name": "shape",
|
|
7664
|
-
"value": {
|
|
7665
|
-
"metadata": {
|
|
7666
|
-
"name": "shape",
|
|
7667
|
-
"value": {
|
|
7668
|
-
"themeTokensVersion": {
|
|
7669
|
-
"name": "string",
|
|
7670
|
-
"required": true
|
|
7671
|
-
}
|
|
7672
|
-
},
|
|
7673
|
-
"required": true
|
|
7674
|
-
}
|
|
7675
|
-
}
|
|
7676
|
-
},
|
|
7677
|
-
"required": true,
|
|
7678
|
-
"description": ""
|
|
7679
|
-
}
|
|
7680
|
-
},
|
|
7681
|
-
"attributes": {
|
|
7682
|
-
"acceptsRNA11yProps": false
|
|
7683
|
-
}
|
|
7684
|
-
}
|
|
7685
|
-
},
|
|
7686
7776
|
"Button": {
|
|
7687
7777
|
"docs": {
|
|
7688
7778
|
"description": "",
|
|
@@ -7767,11 +7857,231 @@
|
|
|
7767
7857
|
}
|
|
7768
7858
|
},
|
|
7769
7859
|
"required": false,
|
|
7770
|
-
"description": ""
|
|
7860
|
+
"description": ""
|
|
7861
|
+
}
|
|
7862
|
+
},
|
|
7863
|
+
"attributes": {
|
|
7864
|
+
"acceptsRNA11yProps": true
|
|
7865
|
+
}
|
|
7866
|
+
}
|
|
7867
|
+
},
|
|
7868
|
+
"ButtonGroup": {
|
|
7869
|
+
"docs": {
|
|
7870
|
+
"description": "",
|
|
7871
|
+
"props": {
|
|
7872
|
+
"items": {
|
|
7873
|
+
"defaultValue": {
|
|
7874
|
+
"value": "[]",
|
|
7875
|
+
"computed": false
|
|
7876
|
+
},
|
|
7877
|
+
"type": {
|
|
7878
|
+
"name": "arrayOf",
|
|
7879
|
+
"value": {
|
|
7880
|
+
"name": "shape",
|
|
7881
|
+
"value": {
|
|
7882
|
+
"label": {
|
|
7883
|
+
"name": "string",
|
|
7884
|
+
"description": "The text displayed to the user in the button, describing this option,\npassed to the button as its child.",
|
|
7885
|
+
"required": true
|
|
7886
|
+
},
|
|
7887
|
+
"accessibilityLabel": {
|
|
7888
|
+
"name": "string",
|
|
7889
|
+
"description": "An optional accessibility label may be passed to ButtonGroup Buttons\nwhich is applied as normal for a React Native accessibilityLabel prop.",
|
|
7890
|
+
"required": false
|
|
7891
|
+
},
|
|
7892
|
+
"id": {
|
|
7893
|
+
"name": "string",
|
|
7894
|
+
"description": "An optional unique string may be provided to identify this option,\nwhich will be used in code and passed to any onChange function.\nIf not provided, the label is used.",
|
|
7895
|
+
"required": false
|
|
7896
|
+
},
|
|
7897
|
+
"ref": {
|
|
7898
|
+
"name": "custom",
|
|
7899
|
+
"raw": "ABBPropTypes.ref()",
|
|
7900
|
+
"description": "An optional ref for one individual button in the ButtonGroup",
|
|
7901
|
+
"required": false
|
|
7902
|
+
}
|
|
7903
|
+
}
|
|
7904
|
+
}
|
|
7905
|
+
},
|
|
7906
|
+
"required": false,
|
|
7907
|
+
"description": "The options a user may select"
|
|
7908
|
+
},
|
|
7909
|
+
"maxValues": {
|
|
7910
|
+
"defaultValue": {
|
|
7911
|
+
"value": "1",
|
|
7912
|
+
"computed": false
|
|
7913
|
+
},
|
|
7914
|
+
"type": {
|
|
7915
|
+
"name": "number"
|
|
7916
|
+
},
|
|
7917
|
+
"required": false,
|
|
7918
|
+
"description": "The maximum number of items a user may select at once. Defaults to 1 and behaves\nlike radio buttons. To have no limit and allow any number of selections, pass `null`."
|
|
7919
|
+
},
|
|
7920
|
+
"readOnly": {
|
|
7921
|
+
"defaultValue": {
|
|
7922
|
+
"value": "false",
|
|
7923
|
+
"computed": false
|
|
7924
|
+
},
|
|
7925
|
+
"type": {
|
|
7926
|
+
"name": "bool"
|
|
7927
|
+
},
|
|
7928
|
+
"required": false,
|
|
7929
|
+
"description": "If true, the buttons cannot be selected by the user and simply show their current state."
|
|
7930
|
+
},
|
|
7931
|
+
"inactive": {
|
|
7932
|
+
"defaultValue": {
|
|
7933
|
+
"value": "false",
|
|
7934
|
+
"computed": false
|
|
7935
|
+
},
|
|
7936
|
+
"type": {
|
|
7937
|
+
"name": "bool"
|
|
7938
|
+
},
|
|
7939
|
+
"required": false,
|
|
7940
|
+
"description": "If true, the buttons cannot be interacted with, elements are set as `disabled` and if the\ntheme supports `inactive` appearances rules, these are applied."
|
|
7941
|
+
},
|
|
7942
|
+
"accessibilityRole": {
|
|
7943
|
+
"defaultValue": {
|
|
7944
|
+
"value": "maxValues === 1\n? 'radiogroup' // radiogroup is cross-platform; only web aria has generic groups\n: Platform.select({ web: 'group', default: 'none' })",
|
|
7945
|
+
"computed": false
|
|
7946
|
+
},
|
|
7947
|
+
"required": false
|
|
7948
|
+
},
|
|
7949
|
+
"tokens": {
|
|
7950
|
+
"type": {
|
|
7951
|
+
"name": "custom",
|
|
7952
|
+
"raw": {
|
|
7953
|
+
"space": "integer",
|
|
7954
|
+
"fieldSpace": "integer",
|
|
7955
|
+
"direction": "direction",
|
|
7956
|
+
"alignItems": "flexAlign",
|
|
7957
|
+
"justifyContent": "flexJustifyContent",
|
|
7958
|
+
"flexGrow": "integer",
|
|
7959
|
+
"flexShrink": "integer"
|
|
7960
|
+
}
|
|
7961
|
+
},
|
|
7962
|
+
"required": false,
|
|
7963
|
+
"description": ""
|
|
7964
|
+
},
|
|
7965
|
+
"variant": {
|
|
7966
|
+
"type": {
|
|
7967
|
+
"name": "objectOf",
|
|
7968
|
+
"value": {
|
|
7969
|
+
"name": "union",
|
|
7970
|
+
"value": [
|
|
7971
|
+
{
|
|
7972
|
+
"name": "string"
|
|
7973
|
+
},
|
|
7974
|
+
{
|
|
7975
|
+
"name": "number"
|
|
7976
|
+
},
|
|
7977
|
+
{
|
|
7978
|
+
"name": "bool"
|
|
7979
|
+
}
|
|
7980
|
+
]
|
|
7981
|
+
}
|
|
7982
|
+
},
|
|
7983
|
+
"required": false,
|
|
7984
|
+
"description": ""
|
|
7985
|
+
},
|
|
7986
|
+
"onChange": {
|
|
7987
|
+
"type": {
|
|
7988
|
+
"name": "func"
|
|
7989
|
+
},
|
|
7990
|
+
"required": false,
|
|
7991
|
+
"description": "If provided, this function is called when the current selection is changed\nand is passed an array of the `id`s of all currently selected `items`."
|
|
7992
|
+
},
|
|
7993
|
+
"values": {
|
|
7994
|
+
"type": {
|
|
7995
|
+
"name": "arrayOf",
|
|
7996
|
+
"value": {
|
|
7997
|
+
"name": "string"
|
|
7998
|
+
}
|
|
7999
|
+
},
|
|
8000
|
+
"required": false,
|
|
8001
|
+
"description": "If the selected item(s) in the button group are to be controlled externally by\na parent component, pass an array of strings as well as an `onChange` handler.\nPassing an array for \"values\" makes the ButtonGroup a \"controlled\" component that\nexpects its state to be handled via `onChange` and so doesn't handle it itself."
|
|
8002
|
+
},
|
|
8003
|
+
"initialValues": {
|
|
8004
|
+
"type": {
|
|
8005
|
+
"name": "arrayOf",
|
|
8006
|
+
"value": {
|
|
8007
|
+
"name": "string"
|
|
8008
|
+
}
|
|
8009
|
+
},
|
|
8010
|
+
"required": false,
|
|
8011
|
+
"description": "If `values` is not passed, making the ButtonGroup an \"uncontrolled\" component\nmanaging its own selected state, a default set of selections may be provided.\nChanging the `initialValues` does not change the user's selections."
|
|
8012
|
+
},
|
|
8013
|
+
"legend": {
|
|
8014
|
+
"type": {
|
|
8015
|
+
"name": "string"
|
|
8016
|
+
},
|
|
8017
|
+
"required": false,
|
|
8018
|
+
"description": "Main text used to describe this group, used in Fieldset's Legend element."
|
|
8019
|
+
},
|
|
8020
|
+
"hint": {
|
|
8021
|
+
"type": {
|
|
8022
|
+
"name": "string"
|
|
8023
|
+
},
|
|
8024
|
+
"required": false,
|
|
8025
|
+
"description": "Optional additional text giving more detail to help a user make a choice."
|
|
8026
|
+
},
|
|
8027
|
+
"tooltip": {
|
|
8028
|
+
"type": {
|
|
8029
|
+
"name": "string"
|
|
8030
|
+
},
|
|
8031
|
+
"required": false,
|
|
8032
|
+
"description": "Optional tooltip text content to include alongside the legend and hint."
|
|
8033
|
+
},
|
|
8034
|
+
"validation": {
|
|
8035
|
+
"type": {
|
|
8036
|
+
"name": "enum",
|
|
8037
|
+
"value": [
|
|
8038
|
+
{
|
|
8039
|
+
"value": "'error'",
|
|
8040
|
+
"computed": false
|
|
8041
|
+
},
|
|
8042
|
+
{
|
|
8043
|
+
"value": "'success'",
|
|
8044
|
+
"computed": false
|
|
8045
|
+
}
|
|
8046
|
+
]
|
|
8047
|
+
},
|
|
8048
|
+
"required": false,
|
|
8049
|
+
"description": "Current validation status of the group, passed to the feedback element if there is one."
|
|
8050
|
+
},
|
|
8051
|
+
"feedback": {
|
|
8052
|
+
"type": {
|
|
8053
|
+
"name": "string"
|
|
8054
|
+
},
|
|
8055
|
+
"required": false,
|
|
8056
|
+
"description": "If provided, a Feedback element is rendered containing this text."
|
|
8057
|
+
},
|
|
8058
|
+
"name": {
|
|
8059
|
+
"type": {
|
|
8060
|
+
"name": "string"
|
|
8061
|
+
},
|
|
8062
|
+
"required": false,
|
|
8063
|
+
"description": "On Web, this is passed to the `name` attribute of the fieldset."
|
|
8064
|
+
},
|
|
8065
|
+
"copy": {
|
|
8066
|
+
"type": {
|
|
8067
|
+
"name": "enum",
|
|
8068
|
+
"value": [
|
|
8069
|
+
{
|
|
8070
|
+
"value": "'en'",
|
|
8071
|
+
"computed": false
|
|
8072
|
+
},
|
|
8073
|
+
{
|
|
8074
|
+
"value": "'fr'",
|
|
8075
|
+
"computed": false
|
|
8076
|
+
}
|
|
8077
|
+
]
|
|
8078
|
+
},
|
|
8079
|
+
"required": false,
|
|
8080
|
+
"description": "Sets the language of microcopy in subcomponents (e.g. Tooltip's default accessibility label)."
|
|
7771
8081
|
}
|
|
7772
8082
|
},
|
|
7773
8083
|
"attributes": {
|
|
7774
|
-
"acceptsRNA11yProps":
|
|
8084
|
+
"acceptsRNA11yProps": false
|
|
7775
8085
|
}
|
|
7776
8086
|
}
|
|
7777
8087
|
},
|
|
@@ -7927,148 +8237,6 @@
|
|
|
7927
8237
|
}
|
|
7928
8238
|
}
|
|
7929
8239
|
},
|
|
7930
|
-
"ButtonGroup": {
|
|
7931
|
-
"docs": {
|
|
7932
|
-
"description": "",
|
|
7933
|
-
"props": {
|
|
7934
|
-
"items": {
|
|
7935
|
-
"defaultValue": {
|
|
7936
|
-
"value": "[]",
|
|
7937
|
-
"computed": false
|
|
7938
|
-
},
|
|
7939
|
-
"type": {
|
|
7940
|
-
"name": "arrayOf",
|
|
7941
|
-
"value": {
|
|
7942
|
-
"name": "shape",
|
|
7943
|
-
"value": {
|
|
7944
|
-
"label": {
|
|
7945
|
-
"name": "string",
|
|
7946
|
-
"description": "The text displayed to the user in the button, describing this option,\npassed to the button as its child.",
|
|
7947
|
-
"required": true
|
|
7948
|
-
},
|
|
7949
|
-
"accessibilityLabel": {
|
|
7950
|
-
"name": "string",
|
|
7951
|
-
"description": "An optional accessibility label may be passed to ButtonGroup Buttons\nwhich is applied as normal for a React Native accessibilityLabel prop.",
|
|
7952
|
-
"required": false
|
|
7953
|
-
},
|
|
7954
|
-
"id": {
|
|
7955
|
-
"name": "string",
|
|
7956
|
-
"description": "An optional unique string may be provided to identify this option,\nwhich will be used in code and passed to any onChange function.\nIf not provided, the label is used.",
|
|
7957
|
-
"required": false
|
|
7958
|
-
},
|
|
7959
|
-
"ref": {
|
|
7960
|
-
"name": "custom",
|
|
7961
|
-
"raw": "ABBPropTypes.ref()",
|
|
7962
|
-
"description": "An optional ref for one individual button in the ButtonGroup",
|
|
7963
|
-
"required": false
|
|
7964
|
-
}
|
|
7965
|
-
}
|
|
7966
|
-
}
|
|
7967
|
-
},
|
|
7968
|
-
"required": false,
|
|
7969
|
-
"description": "The options a user may select"
|
|
7970
|
-
},
|
|
7971
|
-
"maxValues": {
|
|
7972
|
-
"defaultValue": {
|
|
7973
|
-
"value": "1",
|
|
7974
|
-
"computed": false
|
|
7975
|
-
},
|
|
7976
|
-
"type": {
|
|
7977
|
-
"name": "number"
|
|
7978
|
-
},
|
|
7979
|
-
"required": false,
|
|
7980
|
-
"description": "The maximum number of items a user may select at once. Defaults to 1 and behaves\nlike radio buttons. To have no limit and allow any number of selections, pass `null`."
|
|
7981
|
-
},
|
|
7982
|
-
"readOnly": {
|
|
7983
|
-
"defaultValue": {
|
|
7984
|
-
"value": "false",
|
|
7985
|
-
"computed": false
|
|
7986
|
-
},
|
|
7987
|
-
"required": false
|
|
7988
|
-
},
|
|
7989
|
-
"inactive": {
|
|
7990
|
-
"defaultValue": {
|
|
7991
|
-
"value": "false",
|
|
7992
|
-
"computed": false
|
|
7993
|
-
},
|
|
7994
|
-
"required": false
|
|
7995
|
-
},
|
|
7996
|
-
"accessibilityRole": {
|
|
7997
|
-
"defaultValue": {
|
|
7998
|
-
"value": "maxValues === 1\n? 'radiogroup' // radiogroup is cross-platform; only web aria has generic groups\n: Platform.select({ web: 'group', default: 'none' })",
|
|
7999
|
-
"computed": false
|
|
8000
|
-
},
|
|
8001
|
-
"required": false
|
|
8002
|
-
},
|
|
8003
|
-
"tokens": {
|
|
8004
|
-
"type": {
|
|
8005
|
-
"name": "custom",
|
|
8006
|
-
"raw": {
|
|
8007
|
-
"space": "integer",
|
|
8008
|
-
"direction": "direction",
|
|
8009
|
-
"alignItems": "flexAlign",
|
|
8010
|
-
"justifyContent": "flexJustifyContent",
|
|
8011
|
-
"flexGrow": "integer",
|
|
8012
|
-
"flexShrink": "integer"
|
|
8013
|
-
}
|
|
8014
|
-
},
|
|
8015
|
-
"required": false,
|
|
8016
|
-
"description": ""
|
|
8017
|
-
},
|
|
8018
|
-
"variant": {
|
|
8019
|
-
"type": {
|
|
8020
|
-
"name": "objectOf",
|
|
8021
|
-
"value": {
|
|
8022
|
-
"name": "union",
|
|
8023
|
-
"value": [
|
|
8024
|
-
{
|
|
8025
|
-
"name": "string"
|
|
8026
|
-
},
|
|
8027
|
-
{
|
|
8028
|
-
"name": "number"
|
|
8029
|
-
},
|
|
8030
|
-
{
|
|
8031
|
-
"name": "bool"
|
|
8032
|
-
}
|
|
8033
|
-
]
|
|
8034
|
-
}
|
|
8035
|
-
},
|
|
8036
|
-
"required": false,
|
|
8037
|
-
"description": ""
|
|
8038
|
-
},
|
|
8039
|
-
"onChange": {
|
|
8040
|
-
"type": {
|
|
8041
|
-
"name": "func"
|
|
8042
|
-
},
|
|
8043
|
-
"required": false,
|
|
8044
|
-
"description": "If provided, this function is called when the current selection is changed\nand is passed an array of the `id`s of all currently selected `items`."
|
|
8045
|
-
},
|
|
8046
|
-
"values": {
|
|
8047
|
-
"type": {
|
|
8048
|
-
"name": "arrayOf",
|
|
8049
|
-
"value": {
|
|
8050
|
-
"name": "string"
|
|
8051
|
-
}
|
|
8052
|
-
},
|
|
8053
|
-
"required": false,
|
|
8054
|
-
"description": "If the selected item(s) in the button group are to be controlled externally by\na parent component, pass an array of strings as well as an `onChange` handler.\nPassing an array for \"values\" makes the ButtonGroup a \"controlled\" component that\nexpects its state to be handled via `onChange` and so doesn't handle it itself."
|
|
8055
|
-
},
|
|
8056
|
-
"initialValues": {
|
|
8057
|
-
"type": {
|
|
8058
|
-
"name": "arrayOf",
|
|
8059
|
-
"value": {
|
|
8060
|
-
"name": "string"
|
|
8061
|
-
}
|
|
8062
|
-
},
|
|
8063
|
-
"required": false,
|
|
8064
|
-
"description": "If `values` is not passed, making the ButtonGroup an \"uncontrolled\" component\nmanaging its own selected state, a default set of selections may be provided.\nChanging the `initialValues` does not change the user's selections."
|
|
8065
|
-
}
|
|
8066
|
-
},
|
|
8067
|
-
"attributes": {
|
|
8068
|
-
"acceptsRNA11yProps": false
|
|
8069
|
-
}
|
|
8070
|
-
}
|
|
8071
|
-
},
|
|
8072
8240
|
"CheckboxGroup": {
|
|
8073
8241
|
"docs": {
|
|
8074
8242
|
"description": "A group of Checkboxs that behave as a fieldset. Use when users select any number of choices from options.\n\n## Component API\n\nUse the `items` prop to pass an array of objects describing each Checkbox in the group:\n\n - `label`: main text passed to CheckboxGroup's `label` prop\n - `id`: identifier used to store which CheckboxGroup is selected (uses `label` if undefinded)\n - `onChange`: optional function called on selection, in addition to updating the group's selection state\n\n### Controlled version\n\nIf the selection state is controlled from outside, it needs to receive `checkedId` and `onChange` props.\n\n### Uncontrolled version\n\nIf the CheckboxGroup manages its own state, you can use `initialCheckedId` prop to provide the initial value.\nWhenever the radio card gets toggled, it calls the `onChange` callback with the new value (string).\n\n### Use in forms\n\nFor web forms, the `name` prop may be used to define the name of the group's `fieldset` and input elements.\n\n### Validation\n\nValidation state may be set by passing 'error' or 'success' to the `validation` prop.\n\n## A11y guidelines\n\nCheckboxGroup accepts all the common accessibility props, and controls the accessibility state\nof children like Checkbox and Feedback based on current state.\n\n@example\n```jsx\n<CheckboxGroup\n initialCheckedId=\"check1\"\n items={[\n { label: 'Checkbox 1', id: 'check1' },\n { label: 'Checkbox 2', id: 'check2' },\n { label: 'Checkbox 3', id: 'check3' }\n ]}\n legend=\"Checkboxes\"\n hint=\"Choose from these options\"\n/>\n```",
|
|
@@ -8247,21 +8415,21 @@
|
|
|
8247
8415
|
"name": "bool"
|
|
8248
8416
|
},
|
|
8249
8417
|
"required": false,
|
|
8250
|
-
"description": "If true, the
|
|
8418
|
+
"description": "If true, the checkboxes cannot be selected by the user and simply show their current state."
|
|
8251
8419
|
},
|
|
8252
8420
|
"inactive": {
|
|
8253
8421
|
"type": {
|
|
8254
8422
|
"name": "bool"
|
|
8255
8423
|
},
|
|
8256
8424
|
"required": false,
|
|
8257
|
-
"description": "If true, the
|
|
8425
|
+
"description": "If true, the checkboxes cannot be interacted with, elements are set as `disabled` and if the\ntheme supports `inactive` appearances rules, these are applied."
|
|
8258
8426
|
},
|
|
8259
8427
|
"name": {
|
|
8260
8428
|
"type": {
|
|
8261
8429
|
"name": "string"
|
|
8262
8430
|
},
|
|
8263
8431
|
"required": false,
|
|
8264
|
-
"description": "On Web, this is passed to the `name` attribute of the fieldset and each
|
|
8432
|
+
"description": "On Web, this is passed to the `name` attribute of the fieldset and each checkbox input."
|
|
8265
8433
|
}
|
|
8266
8434
|
},
|
|
8267
8435
|
"attributes": {
|
|
@@ -8749,8 +8917,29 @@
|
|
|
8749
8917
|
},
|
|
8750
8918
|
"RadioGroup": {
|
|
8751
8919
|
"docs": {
|
|
8752
|
-
"description": "A group of Radios that behave as a radio group. Use when users select a single choice from mutually\nexclusive options.\n\n## Component API\n\nUse the `items` prop to pass an array of objects describing each Radio in the group:\n\n - `label`: main text passed to Radio's `label` prop\n - `id`: identifier used to store which Radio is selected (uses `label` if undefinded)\n - `onChange`: optional function called on selection, in addition to updating the group's selection state\n\n### Controlled version\n\nIf the selection state is controlled from outside, it needs to receive `checkedId` and `onChange` props.\n\n### Uncontrolled version\n\nIf the RadioGroup manages its own state, you can use `initialCheckedId` prop to provide the initial value.\nWhenever the radio
|
|
8920
|
+
"description": "A group of Radios that behave as a radio group. Use when users select a single choice from mutually\nexclusive options.\n\n## Component API\n\nUse the `items` prop to pass an array of objects describing each Radio in the group:\n\n - `label`: main text passed to Radio's `label` prop\n - `id`: identifier used to store which Radio is selected (uses `label` if undefinded)\n - `onChange`: optional function called on selection, in addition to updating the group's selection state\n\n### Controlled version\n\nIf the selection state is controlled from outside, it needs to receive `checkedId` and `onChange` props.\n\n### Uncontrolled version\n\nIf the RadioGroup manages its own state, you can use `initialCheckedId` prop to provide the initial value.\nWhenever the radio gets toggled, it calls the `onChange` callback with the new value (string).\n\n### Use in forms\n\nFor web forms, the `name` prop may be used to define the name of the group's `fieldset` and input elements.\n\n### Validation\n\nValidation state may be set by passing 'error' or 'success' to the `validation` prop.\n\n## A11y guidelines\n\nRadioGroup accepts all the common accessibility props, but also sets accessibility role `'radiogroup'`\nand controls the accessibility state of children like Radio and Feedback based on current state.\n\n@example\n```jsx\n<RadioGroup\n initialCheckedId=\"radio1\"\n items={[\n { label: 'Radio 1', id: 'radio1' },\n { label: 'Radio 2', id: 'radio2' },\n { label: 'Radio 3', id: 'radio3' }\n ]}\n legend=\"Radios\"\n hint=\"Choose one option\"\n/>\n```",
|
|
8753
8921
|
"props": {
|
|
8922
|
+
"copy": {
|
|
8923
|
+
"defaultValue": {
|
|
8924
|
+
"value": "'en'",
|
|
8925
|
+
"computed": false
|
|
8926
|
+
},
|
|
8927
|
+
"type": {
|
|
8928
|
+
"name": "enum",
|
|
8929
|
+
"value": [
|
|
8930
|
+
{
|
|
8931
|
+
"value": "'en'",
|
|
8932
|
+
"computed": false
|
|
8933
|
+
},
|
|
8934
|
+
{
|
|
8935
|
+
"value": "'fr'",
|
|
8936
|
+
"computed": false
|
|
8937
|
+
}
|
|
8938
|
+
]
|
|
8939
|
+
},
|
|
8940
|
+
"required": false,
|
|
8941
|
+
"description": "Whether the English or French copy will be used (e.g. for accessibility labels)."
|
|
8942
|
+
},
|
|
8754
8943
|
"items": {
|
|
8755
8944
|
"defaultValue": {
|
|
8756
8945
|
"value": "[]",
|
|
@@ -8903,14 +9092,14 @@
|
|
|
8903
9092
|
"name": "string"
|
|
8904
9093
|
},
|
|
8905
9094
|
"required": false,
|
|
8906
|
-
"description": "If provided, the radio
|
|
9095
|
+
"description": "If provided, the radio with this id is selected on first render."
|
|
8907
9096
|
},
|
|
8908
9097
|
"checkedId": {
|
|
8909
9098
|
"type": {
|
|
8910
9099
|
"name": "string"
|
|
8911
9100
|
},
|
|
8912
9101
|
"required": false,
|
|
8913
|
-
"description": "If not undefined, the radio
|
|
9102
|
+
"description": "If not undefined, the radio with this id is selected (or none is selected if `null`), and the\nelement's selection state will be controlled by its parent using the `onChange` function."
|
|
8914
9103
|
},
|
|
8915
9104
|
"onChange": {
|
|
8916
9105
|
"type": {
|
|
@@ -8924,14 +9113,14 @@
|
|
|
8924
9113
|
"name": "bool"
|
|
8925
9114
|
},
|
|
8926
9115
|
"required": false,
|
|
8927
|
-
"description": "If true, the
|
|
9116
|
+
"description": "If true, the radios cannot be selected by the user and simply show their current state."
|
|
8928
9117
|
},
|
|
8929
9118
|
"inactive": {
|
|
8930
9119
|
"type": {
|
|
8931
9120
|
"name": "bool"
|
|
8932
9121
|
},
|
|
8933
9122
|
"required": false,
|
|
8934
|
-
"description": "If true, the
|
|
9123
|
+
"description": "If true, the radios cannot be interacted with, elements are set as `disabled` and if the\ntheme supports `inactive` appearances rules, these are applied."
|
|
8935
9124
|
},
|
|
8936
9125
|
"name": {
|
|
8937
9126
|
"type": {
|
|
@@ -8950,6 +9139,27 @@
|
|
|
8950
9139
|
"docs": {
|
|
8951
9140
|
"description": "A group of Cards that behave as a radio button group. Use when users select a single choice from mutually\nexclusive options with need to show additional information for each option. The whole cards are each\ninteractive as one item.\n\n## Component API\n\nUse the `items` prop to pass an array of objects describing each RadioCard in the group:\n\n - `title`: main text passed to RadioCard's `title` prop\n - `content`: React content passed to RadioCard's `children` prop\n - `id`: identifier used to store which RadioCard is selected (uses `title` if undefinded)\n - `onChange`: optional function called on selection, in addition to updating the group's selection state\n\n### Controlled version\n\nIf the selection state is controlled from outside, it needs to receive `checkedId` and `onChange` props.\n\n### Uncontrolled version\n\nIf the RadioCardGroup manages its own state, you can use `initialCheckedId` prop to provide the initial value.\nWhenever the radio card gets toggled, it calls the `onChange` callback with the new value (string).\n\n### Use in forms\n\nFor web forms, the `name` prop may be used to define the name of the group's `fieldset` and input elements.\n\n### Validation\n\nValidation state may be set by passing 'error' or 'success' to the `validation` prop.\n\n## A11y guidelines\n\nRadioCardGroup accepts all the common accessibility props, but also sets accessibility role `'radiogroup'`\nand controls the accessibility state of children like RadioCard and Feedback based on current state.\n\n@example\n```jsx\n<RadioCardGroup\n initialCheckedId=\"card1\"\n items={[\n { title: 'Card 1', id: 'card1', content: <Typography>More info</Typography> },\n { title: 'Card 2', id: 'card2', content: <Typography>Extra content</Typography> },\n { title: 'Card 3', id: 'card3', content: <Typography>More content</Typography> }\n ]}\n legend=\"Cards\"\n hint=\"Choose a card to select\"\n/>\n```",
|
|
8952
9141
|
"props": {
|
|
9142
|
+
"copy": {
|
|
9143
|
+
"defaultValue": {
|
|
9144
|
+
"value": "'en'",
|
|
9145
|
+
"computed": false
|
|
9146
|
+
},
|
|
9147
|
+
"type": {
|
|
9148
|
+
"name": "enum",
|
|
9149
|
+
"value": [
|
|
9150
|
+
{
|
|
9151
|
+
"value": "'en'",
|
|
9152
|
+
"computed": false
|
|
9153
|
+
},
|
|
9154
|
+
{
|
|
9155
|
+
"value": "'fr'",
|
|
9156
|
+
"computed": false
|
|
9157
|
+
}
|
|
9158
|
+
]
|
|
9159
|
+
},
|
|
9160
|
+
"required": false,
|
|
9161
|
+
"description": "Whether the English or French copy will be used (e.g. for accessibility labels)."
|
|
9162
|
+
},
|
|
8953
9163
|
"items": {
|
|
8954
9164
|
"defaultValue": {
|
|
8955
9165
|
"value": "[]",
|
|
@@ -9308,9 +9518,9 @@
|
|
|
9308
9518
|
}
|
|
9309
9519
|
}
|
|
9310
9520
|
},
|
|
9311
|
-
"
|
|
9521
|
+
"TextArea": {
|
|
9312
9522
|
"docs": {
|
|
9313
|
-
"description": "
|
|
9523
|
+
"description": "Use to collect long-form information such as product feedback or support queries.\nDue to React Native's implementation of `TextInput` it's not possible to access the current value by passing a ref.\nThe `TextArea` height will automatically increase when new lines are added - this behavior can be limited within the theme.\n\n## Controlled component\nIf it is required that the state of the `TextArea` be controlled by the application or other external methods,\n`value` and `onChange` props must be passed to the `TextArea`.\nIf the `TextArea` value should not be changed by user input, a `readOnly` prop must be provided.\n\n## Uncontrolled component\nIf it is not necessary to control the `TextArea` state, you can create one without a value prop.\nIn this case its value can be accessed within the `onChange` callback.\n\n## Getting feedback for entered values\nUse the `feedback` prop to give the user feedback regarding their input.\nYou can affirm that the user's input was correct, or highlight errors that must be corrected, using the `validation` prop.\nKeep feedback text as brief as possible, should be limited to text and links.\n\n## Supplying a hint\nUse the `hint` prop to succinctly clarify attributes of the expected input data, such as the expected format,\nor an indicator that the field is optional.\nIt is a more usable and accessible option than the HTML `placeholder` attribute.",
|
|
9314
9524
|
"props": {
|
|
9315
9525
|
"variant": {
|
|
9316
9526
|
"defaultValue": {
|
|
@@ -9376,6 +9586,8 @@
|
|
|
9376
9586
|
"type": {
|
|
9377
9587
|
"name": "custom",
|
|
9378
9588
|
"raw": {
|
|
9589
|
+
"minLines": "integer",
|
|
9590
|
+
"maxLines": "integer",
|
|
9379
9591
|
"backgroundColor": "color",
|
|
9380
9592
|
"color": "color",
|
|
9381
9593
|
"borderWidth": "border",
|
|
@@ -9406,9 +9618,9 @@
|
|
|
9406
9618
|
}
|
|
9407
9619
|
}
|
|
9408
9620
|
},
|
|
9409
|
-
"
|
|
9621
|
+
"TextInput": {
|
|
9410
9622
|
"docs": {
|
|
9411
|
-
"description": "
|
|
9623
|
+
"description": "A basic text input component. Use in forms or individually to receive user's input.\nDue to React Native's implementation of `TextInput` it's not possible to access the current value by passing a ref.\n\n## Controlled component\nIf it is required that the state of the `TextInput` be controlled by the application or other external methods,\n`value` and `onChange` props must be passed to the `TextInput`.\nIf the `TextInput` value should not be changed by user input, a `readOnly` prop must be provided.\n\n## Uncontrolled component\nIf it is not necessary to control the `TextInput` state, you can create one without a value prop.\nIn this case its value can be accessed within the `onChange` callback.\n\nNOTE: In order to support more advanced usages all additional props will be passed down to the React Native's\n`TextInput` component. See <a href=\"https://reactnative.dev/docs/textinput\" target=\"_blank\">React Native documentation</a> for\nsupported props and <a href=\"https://reactnative.dev/docs/textinput\" target=\"_blank\">React Native Web documentation</a> for\ntheir implementation on the web.",
|
|
9412
9624
|
"props": {
|
|
9413
9625
|
"variant": {
|
|
9414
9626
|
"defaultValue": {
|
|
@@ -9474,8 +9686,6 @@
|
|
|
9474
9686
|
"type": {
|
|
9475
9687
|
"name": "custom",
|
|
9476
9688
|
"raw": {
|
|
9477
|
-
"minLines": "integer",
|
|
9478
|
-
"maxLines": "integer",
|
|
9479
9689
|
"backgroundColor": "color",
|
|
9480
9690
|
"color": "color",
|
|
9481
9691
|
"borderWidth": "border",
|
|
@@ -9510,6 +9720,27 @@
|
|
|
9510
9720
|
"docs": {
|
|
9511
9721
|
"description": "",
|
|
9512
9722
|
"props": {
|
|
9723
|
+
"copy": {
|
|
9724
|
+
"defaultValue": {
|
|
9725
|
+
"value": "'en'",
|
|
9726
|
+
"computed": false
|
|
9727
|
+
},
|
|
9728
|
+
"type": {
|
|
9729
|
+
"name": "enum",
|
|
9730
|
+
"value": [
|
|
9731
|
+
{
|
|
9732
|
+
"value": "'en'",
|
|
9733
|
+
"computed": false
|
|
9734
|
+
},
|
|
9735
|
+
{
|
|
9736
|
+
"value": "'fr'",
|
|
9737
|
+
"computed": false
|
|
9738
|
+
}
|
|
9739
|
+
]
|
|
9740
|
+
},
|
|
9741
|
+
"required": false,
|
|
9742
|
+
"description": "Whether the English or French copy will be used (e.g. for accessibility labels)."
|
|
9743
|
+
},
|
|
9513
9744
|
"accessibilityRole": {
|
|
9514
9745
|
"defaultValue": {
|
|
9515
9746
|
"value": "'switch'",
|
|
@@ -9647,6 +9878,27 @@
|
|
|
9647
9878
|
"docs": {
|
|
9648
9879
|
"description": "",
|
|
9649
9880
|
"props": {
|
|
9881
|
+
"copy": {
|
|
9882
|
+
"defaultValue": {
|
|
9883
|
+
"value": "'en'",
|
|
9884
|
+
"computed": false
|
|
9885
|
+
},
|
|
9886
|
+
"type": {
|
|
9887
|
+
"name": "enum",
|
|
9888
|
+
"value": [
|
|
9889
|
+
{
|
|
9890
|
+
"value": "'en'",
|
|
9891
|
+
"computed": false
|
|
9892
|
+
},
|
|
9893
|
+
{
|
|
9894
|
+
"value": "'fr'",
|
|
9895
|
+
"computed": false
|
|
9896
|
+
}
|
|
9897
|
+
]
|
|
9898
|
+
},
|
|
9899
|
+
"required": false,
|
|
9900
|
+
"description": "Whether the English or French copy will be used (e.g. for accessibility labels)."
|
|
9901
|
+
},
|
|
9650
9902
|
"items": {
|
|
9651
9903
|
"defaultValue": {
|
|
9652
9904
|
"value": "[]",
|
|
@@ -9721,6 +9973,7 @@
|
|
|
9721
9973
|
"name": "custom",
|
|
9722
9974
|
"raw": {
|
|
9723
9975
|
"space": "integer",
|
|
9976
|
+
"fieldSpace": "integer",
|
|
9724
9977
|
"direction": "direction",
|
|
9725
9978
|
"alignItems": "flexAlign",
|
|
9726
9979
|
"justifyContent": "flexJustifyContent",
|