@telus-uds/components-base 1.1.0 → 1.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.turbo/turbo-build.log +8 -0
- package/CHANGELOG.json +38 -0
- package/CHANGELOG.md +35 -2
- package/__fixtures__/Accessible.js +4 -2
- package/__fixtures__/Accessible.native.js +5 -2
- package/__fixtures__/testTheme.js +9 -0
- package/__tests__/ActivityIndicator/ActivityIndicator.test.jsx +35 -0
- package/__tests__/ActivityIndicator/__snapshots__/ActivityIndicator.test.jsx.snap +287 -0
- package/__tests__/FlexGrid/Col.test.jsx +6 -10
- package/__tests__/HorizontalScroll/HorizontalScroll.test.jsx +1 -0
- package/__tests__/ToggleSwitch/ToggleSwitch.test.jsx +10 -0
- package/__tests__/ToggleSwitch/ToggleSwitchGroup.test.jsx +192 -0
- package/__tests__/utils/props.test.js +36 -0
- package/__tests__/utils/semantics.test.jsx +1 -10
- package/babel.config.js +27 -5
- package/component-docs.json +638 -1145
- package/generate-component-docs.js +3 -0
- package/lib/A11yText/index.js +6 -5
- package/lib/ActivityIndicator/Spinner.js +46 -37
- package/lib/ActivityIndicator/Spinner.native.js +26 -15
- package/lib/ActivityIndicator/index.js +3 -3
- package/lib/Box/Box.js +8 -8
- package/lib/Button/Button.js +2 -2
- package/lib/Button/ButtonBase.js +25 -12
- package/lib/Button/ButtonGroup.js +10 -12
- package/lib/Button/ButtonLink.js +4 -4
- package/lib/Button/propTypes.js +4 -2
- package/lib/Card/Card.js +6 -5
- package/lib/Card/CardBase.js +6 -9
- package/lib/Card/PressableCardBase.js +15 -14
- package/lib/Checkbox/Checkbox.js +4 -8
- package/lib/Divider/Divider.js +14 -13
- package/lib/ExpandCollapse/Control.js +7 -7
- package/lib/ExpandCollapse/ExpandCollapse.js +6 -2
- package/lib/ExpandCollapse/Panel.js +6 -7
- package/lib/Feedback/Feedback.js +6 -5
- package/lib/Fieldset/Fieldset.js +1 -3
- package/lib/FlexGrid/FlexGrid.js +4 -4
- package/lib/FlexGrid/helpers/index.js +1 -4
- package/lib/HorizontalScroll/HorizontalScroll.js +5 -6
- package/lib/IconButton/IconButton.js +14 -9
- package/lib/InputLabel/InputLabel.js +7 -2
- package/lib/InputSupports/InputSupports.js +2 -2
- package/lib/Link/LinkBase.js +21 -15
- package/lib/List/List.js +4 -6
- package/lib/List/ListItem.js +6 -2
- package/lib/Modal/Modal.js +6 -2
- package/lib/Notification/Notification.js +7 -2
- package/lib/Pagination/PageButton.js +3 -1
- package/lib/Pagination/Pagination.js +22 -5
- package/lib/Pagination/SideButton.js +3 -1
- package/lib/Progress/Progress.js +5 -4
- package/lib/Progress/ProgressBar.js +8 -7
- package/lib/Radio/Radio.js +4 -8
- package/lib/Radio/RadioButton.js +6 -3
- package/lib/Radio/RadioGroup.js +7 -2
- package/lib/RadioCard/RadioCard.js +4 -4
- package/lib/RadioCard/RadioCardGroup.js +9 -6
- package/lib/Search/Search.js +7 -2
- package/lib/Select/Select.js +10 -9
- package/lib/SideNav/Item.js +7 -7
- package/lib/SideNav/SideNav.js +7 -3
- package/lib/Skeleton/Skeleton.js +6 -2
- package/lib/Spacer/Spacer.js +9 -20
- package/lib/StackView/StackView.js +7 -7
- package/lib/StackView/StackWrapBox.js +6 -7
- package/lib/StackView/StackWrapGap.js +6 -5
- package/lib/StackView/getStackedContent.js +1 -1
- package/lib/StepTracker/Step.js +7 -3
- package/lib/StepTracker/StepTracker.js +7 -7
- package/lib/Tabs/Tabs.js +16 -4
- package/lib/Tabs/TabsItem.js +18 -11
- package/lib/Tags/Tags.js +11 -12
- package/lib/TextInput/TextArea.js +13 -14
- package/lib/TextInput/TextInput.js +13 -14
- package/lib/TextInput/TextInputBase.js +5 -3
- package/lib/ThemeProvider/useThemeTokens.js +3 -3
- package/lib/ThemeProvider/utils/theme-tokens.js +3 -3
- package/lib/ToggleSwitch/ToggleSwitch.js +106 -43
- package/lib/ToggleSwitch/ToggleSwitchGroup.js +228 -0
- package/lib/ToggleSwitch/index.js +14 -4
- package/lib/Tooltip/Tooltip.js +7 -2
- package/lib/TooltipButton/TooltipButton.js +7 -2
- package/lib/Typography/Typography.js +8 -6
- package/lib/index.js +20 -8
- package/lib/utils/a11y/semantics.js +4 -3
- package/lib/utils/children.js +5 -1
- package/lib/utils/index.js +28 -5
- package/lib/utils/pressability.js +2 -2
- package/lib/utils/props/a11yProps.js +153 -0
- package/lib/utils/props/clickProps.js +36 -0
- package/lib/utils/props/componentPropType.js +70 -0
- package/lib/utils/props/copyPropTypes.js +14 -0
- package/lib/utils/props/getPropSelector.js +13 -0
- package/lib/utils/props/hrefAttrsProp.js +41 -0
- package/lib/utils/props/index.js +158 -0
- package/lib/{InputSupports/propTypes.js → utils/props/inputSupportsProps.js} +2 -3
- package/lib/utils/props/linkProps.js +64 -0
- package/lib/utils/props/paddingProp.js +20 -0
- package/lib/utils/props/pressProps.js +57 -0
- package/lib/utils/props/rectProp.js +20 -0
- package/lib/utils/props/responsiveProps.js +40 -0
- package/lib/utils/props/selectSystemProps.js +31 -0
- package/lib/utils/props/spacingProps.js +71 -0
- package/lib/utils/props/tokens.js +145 -0
- package/lib/utils/props/variantProp.js +28 -0
- package/lib/utils/props/viewProps.js +34 -0
- package/lib/utils/ssr.js +51 -0
- package/lib/utils/useResponsiveProp.js +1 -1
- package/lib/utils/useSpacingScale.js +4 -4
- package/lib/utils/withLinkRouter.js +98 -0
- package/lib-module/A11yInfoProvider/index.js +62 -0
- package/lib-module/A11yText/index.js +55 -0
- package/lib-module/ActivityIndicator/Spinner.js +76 -0
- package/lib-module/ActivityIndicator/Spinner.native.js +143 -0
- package/lib-module/ActivityIndicator/index.js +40 -0
- package/lib-module/ActivityIndicator/shared.js +12 -0
- package/lib-module/BaseProvider/index.js +26 -0
- package/lib-module/Box/Box.js +243 -0
- package/lib-module/Box/index.js +2 -0
- package/lib-module/Button/Button.js +25 -0
- package/lib-module/Button/ButtonBase.js +254 -0
- package/lib-module/Button/ButtonGroup.js +164 -0
- package/lib-module/Button/ButtonLink.js +39 -0
- package/lib-module/Button/index.js +4 -0
- package/lib-module/Button/propTypes.js +36 -0
- package/lib-module/Card/Card.js +83 -0
- package/lib-module/Card/CardBase.js +62 -0
- package/lib-module/Card/PressableCardBase.js +113 -0
- package/lib-module/Card/index.js +4 -0
- package/lib-module/Checkbox/Checkbox.js +321 -0
- package/lib-module/Checkbox/CheckboxGroup.js +218 -0
- package/lib-module/Checkbox/CheckboxInput.js +58 -0
- package/lib-module/Checkbox/CheckboxInput.native.js +6 -0
- package/lib-module/Checkbox/index.js +3 -0
- package/lib-module/Divider/Divider.js +123 -0
- package/lib-module/Divider/index.js +2 -0
- package/lib-module/ExpandCollapse/Accordion.js +15 -0
- package/lib-module/ExpandCollapse/Control.js +130 -0
- package/lib-module/ExpandCollapse/ExpandCollapse.js +94 -0
- package/lib-module/ExpandCollapse/Panel.js +158 -0
- package/lib-module/ExpandCollapse/index.js +7 -0
- package/lib-module/Feedback/Feedback.js +144 -0
- package/lib-module/Feedback/index.js +2 -0
- package/lib-module/Fieldset/Fieldset.js +145 -0
- package/lib-module/Fieldset/FieldsetContainer.js +29 -0
- package/lib-module/Fieldset/FieldsetContainer.native.js +20 -0
- package/lib-module/Fieldset/Legend.js +21 -0
- package/lib-module/Fieldset/Legend.native.js +28 -0
- package/lib-module/Fieldset/cssReset.js +14 -0
- package/lib-module/Fieldset/index.js +2 -0
- package/lib-module/FlexGrid/Col/Col.js +265 -0
- package/lib-module/FlexGrid/Col/index.js +2 -0
- package/lib-module/FlexGrid/FlexGrid.js +147 -0
- package/lib-module/FlexGrid/Row/Row.js +177 -0
- package/lib-module/FlexGrid/Row/index.js +2 -0
- package/lib-module/FlexGrid/helpers/index.js +18 -0
- package/lib-module/FlexGrid/index.js +2 -0
- package/lib-module/FlexGrid/providers/GutterContext.js +3 -0
- package/lib-module/HorizontalScroll/HorizontalScroll.js +171 -0
- package/lib-module/HorizontalScroll/HorizontalScrollButton.js +102 -0
- package/lib-module/HorizontalScroll/ScrollViewEnd.js +47 -0
- package/lib-module/HorizontalScroll/ScrollViewEnd.native.js +24 -0
- package/lib-module/HorizontalScroll/dictionary.js +11 -0
- package/lib-module/HorizontalScroll/index.js +11 -0
- package/lib-module/HorizontalScroll/itemPositions.js +106 -0
- package/lib-module/Icon/Icon.js +61 -0
- package/lib-module/Icon/IconText.js +81 -0
- package/lib-module/Icon/index.js +4 -0
- package/lib-module/IconButton/IconButton.js +115 -0
- package/lib-module/IconButton/index.js +2 -0
- package/lib-module/InputLabel/InputLabel.js +131 -0
- package/lib-module/InputLabel/LabelContent.js +24 -0
- package/lib-module/InputLabel/LabelContent.native.js +16 -0
- package/lib-module/InputLabel/index.js +2 -0
- package/lib-module/InputSupports/InputSupports.js +88 -0
- package/lib-module/InputSupports/index.js +2 -0
- package/lib-module/InputSupports/useInputSupports.js +31 -0
- package/lib-module/Link/ChevronLink.js +51 -0
- package/lib-module/Link/InlinePressable.js +37 -0
- package/lib-module/Link/InlinePressable.native.js +85 -0
- package/lib-module/Link/Link.js +27 -0
- package/lib-module/Link/LinkBase.js +210 -0
- package/lib-module/Link/TextButton.js +43 -0
- package/lib-module/Link/index.js +5 -0
- package/lib-module/List/List.js +55 -0
- package/lib-module/List/ListItem.js +213 -0
- package/lib-module/List/index.js +5 -0
- package/lib-module/Modal/Modal.js +208 -0
- package/lib-module/Modal/dictionary.js +9 -0
- package/lib-module/Modal/index.js +2 -0
- package/lib-module/Notification/Notification.js +196 -0
- package/lib-module/Notification/dictionary.js +8 -0
- package/lib-module/Notification/index.js +2 -0
- package/lib-module/Pagination/PageButton.js +65 -0
- package/lib-module/Pagination/Pagination.js +140 -0
- package/lib-module/Pagination/SideButton.js +103 -0
- package/lib-module/Pagination/dictionary.js +18 -0
- package/lib-module/Pagination/index.js +2 -0
- package/lib-module/Pagination/usePagination.js +72 -0
- package/lib-module/Progress/Progress.js +85 -0
- package/lib-module/Progress/ProgressBar.js +134 -0
- package/lib-module/Progress/ProgressBarBackground.js +41 -0
- package/lib-module/Progress/index.js +4 -0
- package/lib-module/Radio/Radio.js +263 -0
- package/lib-module/Radio/RadioButton.js +128 -0
- package/lib-module/Radio/RadioGroup.js +225 -0
- package/lib-module/Radio/RadioInput.js +60 -0
- package/lib-module/Radio/RadioInput.native.js +6 -0
- package/lib-module/Radio/index.js +3 -0
- package/lib-module/RadioCard/RadioCard.js +218 -0
- package/lib-module/RadioCard/RadioCardGroup.js +232 -0
- package/lib-module/RadioCard/index.js +3 -0
- package/lib-module/Search/Search.js +233 -0
- package/lib-module/Search/dictionary.js +12 -0
- package/lib-module/Search/index.js +2 -0
- package/lib-module/Select/Group.js +20 -0
- package/lib-module/Select/Group.native.js +14 -0
- package/lib-module/Select/Item.js +17 -0
- package/lib-module/Select/Item.native.js +9 -0
- package/lib-module/Select/Picker.js +67 -0
- package/lib-module/Select/Picker.native.js +110 -0
- package/lib-module/Select/Select.js +317 -0
- package/lib-module/Select/index.js +6 -0
- package/lib-module/SideNav/Item.js +139 -0
- package/lib-module/SideNav/ItemContent.js +45 -0
- package/lib-module/SideNav/ItemsGroup.js +115 -0
- package/lib-module/SideNav/SideNav.js +133 -0
- package/lib-module/SideNav/index.js +1 -0
- package/lib-module/Skeleton/Skeleton.js +117 -0
- package/lib-module/Skeleton/index.js +2 -0
- package/lib-module/Skeleton/skeleton.constant.js +3 -0
- package/lib-module/Skeleton/skeletonWebAnimation.js +18 -0
- package/lib-module/Skeleton/useSkeletonNativeAnimation.js +24 -0
- package/lib-module/Spacer/Spacer.js +97 -0
- package/lib-module/Spacer/index.js +2 -0
- package/lib-module/StackView/StackView.js +124 -0
- package/lib-module/StackView/StackWrap.js +48 -0
- package/lib-module/StackView/StackWrap.native.js +3 -0
- package/lib-module/StackView/StackWrapBox.js +114 -0
- package/lib-module/StackView/StackWrapGap.js +58 -0
- package/lib-module/StackView/common.js +32 -0
- package/lib-module/StackView/getStackedContent.js +123 -0
- package/lib-module/StackView/index.js +5 -0
- package/lib-module/StepTracker/Step.js +229 -0
- package/lib-module/StepTracker/StepTracker.js +175 -0
- package/lib-module/StepTracker/dictionary.js +10 -0
- package/lib-module/StepTracker/index.js +2 -0
- package/lib-module/Tabs/Tabs.js +113 -0
- package/lib-module/Tabs/TabsItem.js +215 -0
- package/lib-module/Tabs/index.js +2 -0
- package/lib-module/Tags/Tags.js +238 -0
- package/lib-module/Tags/index.js +2 -0
- package/lib-module/TextInput/TextArea.js +88 -0
- package/lib-module/TextInput/TextInput.js +60 -0
- package/lib-module/TextInput/TextInputBase.js +233 -0
- package/lib-module/TextInput/index.js +3 -0
- package/lib-module/TextInput/propTypes.js +31 -0
- package/lib-module/ThemeProvider/ThemeProvider.js +35 -0
- package/lib-module/ThemeProvider/index.js +6 -0
- package/lib-module/ThemeProvider/useSetTheme.js +22 -0
- package/lib-module/ThemeProvider/useTheme.js +14 -0
- package/lib-module/ThemeProvider/useThemeTokens.js +105 -0
- package/lib-module/ThemeProvider/utils/index.js +2 -0
- package/lib-module/ThemeProvider/utils/styles.js +174 -0
- package/lib-module/ThemeProvider/utils/theme-tokens.js +151 -0
- package/lib-module/ToggleSwitch/ToggleSwitch.js +224 -0
- package/lib-module/ToggleSwitch/ToggleSwitchGroup.js +202 -0
- package/lib-module/ToggleSwitch/index.js +3 -0
- package/lib-module/Tooltip/Backdrop.js +52 -0
- package/lib-module/Tooltip/Backdrop.native.js +43 -0
- package/lib-module/Tooltip/Tooltip.js +332 -0
- package/lib-module/Tooltip/dictionary.js +8 -0
- package/lib-module/Tooltip/getTooltipPosition.js +164 -0
- package/lib-module/Tooltip/index.js +2 -0
- package/lib-module/TooltipButton/TooltipButton.js +71 -0
- package/lib-module/TooltipButton/index.js +2 -0
- package/lib-module/Typography/Typography.js +118 -0
- package/lib-module/Typography/index.js +2 -0
- package/lib-module/ViewportProvider/ViewportProvider.js +28 -0
- package/lib-module/ViewportProvider/index.js +3 -0
- package/lib-module/ViewportProvider/useViewport.js +3 -0
- package/lib-module/ViewportProvider/useViewportListener.js +43 -0
- package/lib-module/index.js +48 -0
- package/lib-module/utils/a11y/index.js +2 -0
- package/lib-module/utils/a11y/semantics.js +154 -0
- package/lib-module/utils/a11y/textSize.js +34 -0
- package/lib-module/utils/animation/index.js +2 -0
- package/lib-module/utils/animation/useVerticalExpandAnimation.js +49 -0
- package/lib-module/utils/children.js +118 -0
- package/lib-module/utils/index.js +15 -0
- package/lib-module/utils/info/index.js +7 -0
- package/lib-module/utils/info/platform/index.js +11 -0
- package/lib-module/utils/info/platform/platform.android.js +1 -0
- package/lib-module/utils/info/platform/platform.ios.js +1 -0
- package/lib-module/utils/info/platform/platform.js +1 -0
- package/lib-module/utils/info/platform/platform.native.js +4 -0
- package/lib-module/utils/info/versions.js +5 -0
- package/lib-module/utils/input.js +180 -0
- package/lib-module/utils/pressability.js +97 -0
- package/lib-module/utils/props/a11yProps.js +140 -0
- package/lib-module/utils/props/clickProps.js +25 -0
- package/lib-module/utils/props/componentPropType.js +63 -0
- package/lib-module/utils/props/copyPropTypes.js +2 -0
- package/lib-module/utils/props/getPropSelector.js +6 -0
- package/lib-module/utils/props/hrefAttrsProp.js +30 -0
- package/lib-module/utils/props/index.js +16 -0
- package/lib-module/utils/props/inputSupportsProps.js +54 -0
- package/lib-module/utils/props/linkProps.js +47 -0
- package/lib-module/utils/props/paddingProp.js +9 -0
- package/lib-module/utils/props/pressProps.js +42 -0
- package/lib-module/utils/props/rectProp.js +9 -0
- package/lib-module/utils/props/responsiveProps.js +30 -0
- package/lib-module/utils/props/selectSystemProps.js +24 -0
- package/lib-module/utils/props/spacingProps.js +56 -0
- package/lib-module/utils/props/tokens.js +120 -0
- package/lib-module/utils/props/variantProp.js +18 -0
- package/lib-module/utils/props/viewProps.js +22 -0
- package/lib-module/utils/ssr.js +35 -0
- package/lib-module/utils/useCopy.js +42 -0
- package/lib-module/utils/useHash.js +44 -0
- package/lib-module/utils/useHash.native.js +7 -0
- package/lib-module/utils/useResponsiveProp.js +47 -0
- package/lib-module/utils/useSpacingScale.js +123 -0
- package/lib-module/utils/useUniqueId.js +12 -0
- package/lib-module/utils/withLinkRouter.js +82 -0
- package/package.json +9 -5
- package/src/A11yText/index.jsx +7 -3
- package/src/ActivityIndicator/Spinner.jsx +56 -44
- package/src/ActivityIndicator/Spinner.native.jsx +20 -12
- package/src/ActivityIndicator/index.jsx +1 -1
- package/src/Box/Box.jsx +15 -13
- package/src/Button/Button.jsx +1 -1
- package/src/Button/ButtonBase.jsx +20 -12
- package/src/Button/ButtonGroup.jsx +17 -8
- package/src/Button/ButtonLink.jsx +1 -1
- package/src/Button/propTypes.js +2 -1
- package/src/Card/Card.jsx +7 -4
- package/src/Card/CardBase.jsx +6 -5
- package/src/Card/PressableCardBase.jsx +16 -14
- package/src/Checkbox/Checkbox.jsx +12 -7
- package/src/Divider/Divider.jsx +19 -12
- package/src/ExpandCollapse/Control.jsx +12 -7
- package/src/ExpandCollapse/ExpandCollapse.jsx +13 -3
- package/src/ExpandCollapse/Panel.jsx +15 -5
- package/src/Feedback/Feedback.jsx +13 -3
- package/src/Fieldset/Fieldset.jsx +1 -1
- package/src/FlexGrid/FlexGrid.jsx +11 -5
- package/src/FlexGrid/helpers/index.js +1 -3
- package/src/HorizontalScroll/HorizontalScroll.jsx +12 -5
- package/src/IconButton/IconButton.jsx +18 -12
- package/src/InputLabel/InputLabel.jsx +16 -2
- package/src/InputSupports/InputSupports.jsx +1 -1
- package/src/Link/LinkBase.jsx +15 -12
- package/src/List/List.jsx +12 -5
- package/src/List/ListItem.jsx +16 -2
- package/src/Modal/Modal.jsx +63 -50
- package/src/Notification/Notification.jsx +17 -3
- package/src/Pagination/PageButton.jsx +3 -2
- package/src/Pagination/Pagination.jsx +38 -4
- package/src/Pagination/SideButton.jsx +2 -2
- package/src/Progress/Progress.jsx +5 -3
- package/src/Progress/ProgressBar.jsx +8 -6
- package/src/Radio/Radio.jsx +13 -7
- package/src/Radio/RadioButton.jsx +13 -3
- package/src/Radio/RadioGroup.jsx +14 -2
- package/src/RadioCard/RadioCard.jsx +9 -6
- package/src/RadioCard/RadioCardGroup.jsx +16 -4
- package/src/Search/Search.jsx +15 -3
- package/src/Select/Select.jsx +21 -7
- package/src/SideNav/Item.jsx +15 -7
- package/src/SideNav/SideNav.jsx +13 -2
- package/src/Skeleton/Skeleton.jsx +55 -43
- package/src/Spacer/Spacer.jsx +10 -18
- package/src/StackView/StackView.jsx +13 -12
- package/src/StackView/StackWrapBox.jsx +12 -12
- package/src/StackView/StackWrapGap.jsx +9 -7
- package/src/StackView/getStackedContent.jsx +1 -1
- package/src/StepTracker/Step.jsx +7 -4
- package/src/StepTracker/StepTracker.jsx +8 -8
- package/src/Tabs/Tabs.jsx +63 -23
- package/src/Tabs/TabsItem.jsx +22 -14
- package/src/Tags/Tags.jsx +16 -7
- package/src/TextInput/TextArea.jsx +20 -8
- package/src/TextInput/TextInput.jsx +20 -8
- package/src/TextInput/TextInputBase.jsx +13 -3
- package/src/ThemeProvider/useThemeTokens.js +3 -3
- package/src/ThemeProvider/utils/theme-tokens.js +3 -3
- package/src/ToggleSwitch/ToggleSwitch.jsx +104 -41
- package/src/ToggleSwitch/ToggleSwitchGroup.jsx +211 -0
- package/src/ToggleSwitch/index.js +2 -1
- package/src/Tooltip/Tooltip.jsx +13 -3
- package/src/TooltipButton/TooltipButton.jsx +6 -4
- package/src/Typography/Typography.jsx +10 -6
- package/src/index.js +2 -2
- package/src/utils/a11y/semantics.js +3 -2
- package/src/utils/children.jsx +2 -1
- package/src/utils/index.js +3 -1
- package/src/utils/pressability.js +1 -1
- package/src/utils/props/a11yProps.js +151 -0
- package/src/utils/props/clickProps.js +31 -0
- package/src/utils/props/componentPropType.js +67 -0
- package/src/utils/props/copyPropTypes.js +3 -0
- package/src/utils/props/getPropSelector.js +14 -0
- package/src/utils/props/hrefAttrsProp.js +25 -0
- package/src/utils/props/index.js +16 -0
- package/src/{InputSupports/propTypes.js → utils/props/inputSupportsProps.js} +2 -4
- package/src/utils/props/linkProps.js +43 -0
- package/src/utils/props/paddingProp.js +10 -0
- package/src/utils/props/pressProps.js +45 -0
- package/src/utils/props/rectProp.js +10 -0
- package/src/utils/props/responsiveProps.js +30 -0
- package/src/utils/props/selectSystemProps.js +25 -0
- package/src/utils/props/spacingProps.js +58 -0
- package/src/utils/props/tokens.js +150 -0
- package/src/utils/props/variantProp.js +20 -0
- package/src/utils/props/viewProps.js +23 -0
- package/src/utils/ssr.js +35 -0
- package/src/utils/useResponsiveProp.js +1 -1
- package/src/utils/useSpacingScale.js +4 -4
- package/src/utils/withLinkRouter.jsx +68 -0
- package/stories/TextInput/TextArea.stories.jsx +1 -0
- package/stories/ToggleSwitch/ToggleSwitch.stories.jsx +5 -1
- package/stories/ToggleSwitch/ToggleSwitchGroup.stories.jsx +81 -0
- package/.ultra.cache.json +0 -1
- package/lib/utils/a11y/propTypes.js +0 -61
- package/lib/utils/a11y/propTypes.native.js +0 -47
- package/lib/utils/propTypes.js +0 -541
- package/release-context.json +0 -7
- package/src/utils/a11y/propTypes.js +0 -61
- package/src/utils/a11y/propTypes.native.js +0 -39
- package/src/utils/propTypes.js +0 -531
package/component-docs.json
CHANGED
|
@@ -725,6 +725,12 @@
|
|
|
725
725
|
"trackBorderRadius": "radius",
|
|
726
726
|
"iconSize": "size",
|
|
727
727
|
"iconColor": "color",
|
|
728
|
+
"labelColor": "color",
|
|
729
|
+
"labelFontName": "fontName",
|
|
730
|
+
"labelFontSize": "fontSize",
|
|
731
|
+
"labelFontWeight": "fontWeight",
|
|
732
|
+
"labelLineHeight": "lineHeight",
|
|
733
|
+
"labelMarginLeft": "size",
|
|
728
734
|
"switchSize": "size",
|
|
729
735
|
"switchColor": "color",
|
|
730
736
|
"switchBorderColor": "color",
|
|
@@ -732,6 +738,14 @@
|
|
|
732
738
|
"switchBorderRadius": "radius",
|
|
733
739
|
"switchShadow": "shadow"
|
|
734
740
|
},
|
|
741
|
+
"ToggleSwitchGroup": {
|
|
742
|
+
"space": "integer",
|
|
743
|
+
"direction": "direction",
|
|
744
|
+
"alignItems": "flexAlign",
|
|
745
|
+
"justifyContent": "flexJustifyContent",
|
|
746
|
+
"flexGrow": "integer",
|
|
747
|
+
"flexShrink": "integer"
|
|
748
|
+
},
|
|
735
749
|
"Tooltip": {
|
|
736
750
|
"backgroundColor": "color",
|
|
737
751
|
"paddingTop": "size",
|
|
@@ -1730,52 +1744,6 @@
|
|
|
1730
1744
|
"required": false,
|
|
1731
1745
|
"description": "Sets right padding using the theme's spacing scale.\n\n@see {@link SpacingValue}"
|
|
1732
1746
|
},
|
|
1733
|
-
"pointerEvents": {
|
|
1734
|
-
"type": {
|
|
1735
|
-
"name": "enum",
|
|
1736
|
-
"value": [
|
|
1737
|
-
{
|
|
1738
|
-
"value": "'all'",
|
|
1739
|
-
"computed": false
|
|
1740
|
-
},
|
|
1741
|
-
{
|
|
1742
|
-
"value": "'none'",
|
|
1743
|
-
"computed": false
|
|
1744
|
-
},
|
|
1745
|
-
{
|
|
1746
|
-
"value": "'box-only'",
|
|
1747
|
-
"computed": false
|
|
1748
|
-
},
|
|
1749
|
-
{
|
|
1750
|
-
"value": "'box-none'",
|
|
1751
|
-
"computed": false
|
|
1752
|
-
}
|
|
1753
|
-
]
|
|
1754
|
-
},
|
|
1755
|
-
"required": false,
|
|
1756
|
-
"description": ""
|
|
1757
|
-
},
|
|
1758
|
-
"onLayout": {
|
|
1759
|
-
"type": {
|
|
1760
|
-
"name": "func"
|
|
1761
|
-
},
|
|
1762
|
-
"required": false,
|
|
1763
|
-
"description": ""
|
|
1764
|
-
},
|
|
1765
|
-
"nativeID": {
|
|
1766
|
-
"type": {
|
|
1767
|
-
"name": "string"
|
|
1768
|
-
},
|
|
1769
|
-
"required": false,
|
|
1770
|
-
"description": ""
|
|
1771
|
-
},
|
|
1772
|
-
"testID": {
|
|
1773
|
-
"type": {
|
|
1774
|
-
"name": "string"
|
|
1775
|
-
},
|
|
1776
|
-
"required": false,
|
|
1777
|
-
"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`)."
|
|
1778
|
-
},
|
|
1779
1747
|
"variant": {
|
|
1780
1748
|
"type": {
|
|
1781
1749
|
"name": "objectOf",
|
|
@@ -1932,6 +1900,13 @@
|
|
|
1932
1900
|
"required": false,
|
|
1933
1901
|
"description": "Optional semantic HTML tag, to apply to the container on web. Does not change styling.\n\nIn native apps, if a header tag is provided (\"h1\", \"h2\" etc) and accessibilityRole prop\nis not defined, the accessibilityRole will default to \"heading\"."
|
|
1934
1902
|
},
|
|
1903
|
+
"testID": {
|
|
1904
|
+
"type": {
|
|
1905
|
+
"name": "string"
|
|
1906
|
+
},
|
|
1907
|
+
"required": false,
|
|
1908
|
+
"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`)."
|
|
1909
|
+
},
|
|
1935
1910
|
"children": {
|
|
1936
1911
|
"type": {
|
|
1937
1912
|
"name": "node"
|
|
@@ -1999,7 +1974,7 @@
|
|
|
1999
1974
|
}
|
|
2000
1975
|
},
|
|
2001
1976
|
"attributes": {
|
|
2002
|
-
"acceptsRNA11yProps":
|
|
1977
|
+
"acceptsRNA11yProps": false
|
|
2003
1978
|
}
|
|
2004
1979
|
}
|
|
2005
1980
|
},
|
|
@@ -2007,6 +1982,13 @@
|
|
|
2007
1982
|
"docs": {
|
|
2008
1983
|
"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.",
|
|
2009
1984
|
"props": {
|
|
1985
|
+
"accessibilityRole": {
|
|
1986
|
+
"defaultValue": {
|
|
1987
|
+
"value": "href ? 'link' : undefined",
|
|
1988
|
+
"computed": false
|
|
1989
|
+
},
|
|
1990
|
+
"required": false
|
|
1991
|
+
},
|
|
2010
1992
|
"children": {
|
|
2011
1993
|
"type": {
|
|
2012
1994
|
"name": "union",
|
|
@@ -2053,7 +2035,7 @@
|
|
|
2053
2035
|
}
|
|
2054
2036
|
},
|
|
2055
2037
|
"attributes": {
|
|
2056
|
-
"acceptsRNA11yProps":
|
|
2038
|
+
"acceptsRNA11yProps": false
|
|
2057
2039
|
}
|
|
2058
2040
|
}
|
|
2059
2041
|
},
|
|
@@ -3013,59 +2995,6 @@
|
|
|
3013
2995
|
"required": false,
|
|
3014
2996
|
"description": "Whether or not to include gutter at the ends to the left and right of the FlexGrid"
|
|
3015
2997
|
},
|
|
3016
|
-
"pointerEvents": {
|
|
3017
|
-
"type": {
|
|
3018
|
-
"name": "enum",
|
|
3019
|
-
"value": [
|
|
3020
|
-
{
|
|
3021
|
-
"value": "'all'",
|
|
3022
|
-
"computed": false
|
|
3023
|
-
},
|
|
3024
|
-
{
|
|
3025
|
-
"value": "'none'",
|
|
3026
|
-
"computed": false
|
|
3027
|
-
},
|
|
3028
|
-
{
|
|
3029
|
-
"value": "'box-only'",
|
|
3030
|
-
"computed": false
|
|
3031
|
-
},
|
|
3032
|
-
{
|
|
3033
|
-
"value": "'box-none'",
|
|
3034
|
-
"computed": false
|
|
3035
|
-
}
|
|
3036
|
-
]
|
|
3037
|
-
},
|
|
3038
|
-
"required": false,
|
|
3039
|
-
"description": ""
|
|
3040
|
-
},
|
|
3041
|
-
"onLayout": {
|
|
3042
|
-
"type": {
|
|
3043
|
-
"name": "func"
|
|
3044
|
-
},
|
|
3045
|
-
"required": false,
|
|
3046
|
-
"description": ""
|
|
3047
|
-
},
|
|
3048
|
-
"nativeID": {
|
|
3049
|
-
"type": {
|
|
3050
|
-
"name": "string"
|
|
3051
|
-
},
|
|
3052
|
-
"required": false,
|
|
3053
|
-
"description": ""
|
|
3054
|
-
},
|
|
3055
|
-
"testID": {
|
|
3056
|
-
"type": {
|
|
3057
|
-
"name": "string"
|
|
3058
|
-
},
|
|
3059
|
-
"required": false,
|
|
3060
|
-
"description": ""
|
|
3061
|
-
},
|
|
3062
|
-
"dataSet": {
|
|
3063
|
-
"type": {
|
|
3064
|
-
"name": "object"
|
|
3065
|
-
},
|
|
3066
|
-
"required": false,
|
|
3067
|
-
"description": ""
|
|
3068
|
-
},
|
|
3069
2998
|
"xsReverse": {
|
|
3070
2999
|
"type": {
|
|
3071
3000
|
"name": "bool"
|
|
@@ -3967,7 +3896,7 @@
|
|
|
3967
3896
|
},
|
|
3968
3897
|
"HorizontalScroll": {
|
|
3969
3898
|
"docs": {
|
|
3970
|
-
"description": "Base component that scrolls horizontally and displays left and right buttons if\nthere is content to the left and the right which can be scrolled to.\n\n@TODO
|
|
3899
|
+
"description": "Base component that scrolls horizontally and displays left and right buttons if\nthere is content to the left and the right which can be scrolled to.\n\n@TODO revisit `ScrollButton` after IconButton is stable.",
|
|
3971
3900
|
"props": {
|
|
3972
3901
|
"itemPositions": {
|
|
3973
3902
|
"type": {
|
|
@@ -4117,6 +4046,13 @@
|
|
|
4117
4046
|
"docs": {
|
|
4118
4047
|
"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.",
|
|
4119
4048
|
"props": {
|
|
4049
|
+
"accessibilityRole": {
|
|
4050
|
+
"defaultValue": {
|
|
4051
|
+
"value": "href ? 'link' : 'button'",
|
|
4052
|
+
"computed": false
|
|
4053
|
+
},
|
|
4054
|
+
"required": false
|
|
4055
|
+
},
|
|
4120
4056
|
"variant": {
|
|
4121
4057
|
"type": {
|
|
4122
4058
|
"name": "objectOf",
|
|
@@ -4223,7 +4159,7 @@
|
|
|
4223
4159
|
}
|
|
4224
4160
|
},
|
|
4225
4161
|
"attributes": {
|
|
4226
|
-
"acceptsRNA11yProps":
|
|
4162
|
+
"acceptsRNA11yProps": false
|
|
4227
4163
|
}
|
|
4228
4164
|
}
|
|
4229
4165
|
},
|
|
@@ -4402,7 +4338,7 @@
|
|
|
4402
4338
|
}
|
|
4403
4339
|
},
|
|
4404
4340
|
"attributes": {
|
|
4405
|
-
"acceptsRNA11yProps":
|
|
4341
|
+
"acceptsRNA11yProps": false
|
|
4406
4342
|
}
|
|
4407
4343
|
},
|
|
4408
4344
|
"Item": {
|
|
@@ -4644,7 +4580,7 @@
|
|
|
4644
4580
|
}
|
|
4645
4581
|
},
|
|
4646
4582
|
"attributes": {
|
|
4647
|
-
"acceptsRNA11yProps":
|
|
4583
|
+
"acceptsRNA11yProps": false
|
|
4648
4584
|
}
|
|
4649
4585
|
},
|
|
4650
4586
|
"Item": {
|
|
@@ -5003,6 +4939,20 @@
|
|
|
5003
4939
|
"required": false,
|
|
5004
4940
|
"description": ""
|
|
5005
4941
|
},
|
|
4942
|
+
"LinkRouter": {
|
|
4943
|
+
"type": {
|
|
4944
|
+
"name": "elementType"
|
|
4945
|
+
},
|
|
4946
|
+
"required": false,
|
|
4947
|
+
"description": ""
|
|
4948
|
+
},
|
|
4949
|
+
"linkRouterProps": {
|
|
4950
|
+
"type": {
|
|
4951
|
+
"name": "object"
|
|
4952
|
+
},
|
|
4953
|
+
"required": false,
|
|
4954
|
+
"description": ""
|
|
4955
|
+
},
|
|
5006
4956
|
"children": {
|
|
5007
4957
|
"type": {
|
|
5008
4958
|
"name": "custom",
|
|
@@ -5889,68 +5839,6 @@
|
|
|
5889
5839
|
"docs": {
|
|
5890
5840
|
"description": "A basic form single-choice select component. Use in forms or individually to receive user's input.\n\n## Usage criteria\n- Include a `placeholder` to provide instructions such as \"Please select...\" as an unselectable option (recommended)\n- Use when options are between 7-15 (recommended)\n- For options are 6 and under, use `Radio` groups or `ButtonGroup`.\n- For options 15 and above, look for alternatives (e.g grouping into categories, or input field with auto-complete etc.)\n\n## Controlled component\nIf it is required that the state of the `Select` be controlled by the application or other external methods,\n`value` and `onChange` props must be passed to the `Select`.\nIf the `Select` 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 `Select` state, you can create one without a value prop.\nIn this case its value can be accessed within the `onChange` callback. Use the `initialValue` prop to set the\ndefault value for an uncontrolled `Select`.\n\n## Getting feedback for entered values\nUse the `feedback` prop to give the user feedback regarding their selection.\nYou can affirm that the user's selection 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## Using a tooltip\nWhen a more in-depth explanation is needed to fill out a `Select` properly, the tooltip prop may be used.\n\n## Grouping options\n`Select` supports option groups. Use a `Select.Group` component to render an `<optgroup>` element with its items.\nNOTE: this does not work on native platforms - the grouped items will be shown at the same level as the non-grouped items.",
|
|
5891
5841
|
"props": {
|
|
5892
|
-
"label": {
|
|
5893
|
-
"type": {
|
|
5894
|
-
"name": "string"
|
|
5895
|
-
},
|
|
5896
|
-
"required": false,
|
|
5897
|
-
"description": "The input label."
|
|
5898
|
-
},
|
|
5899
|
-
"hint": {
|
|
5900
|
-
"type": {
|
|
5901
|
-
"name": "string"
|
|
5902
|
-
},
|
|
5903
|
-
"required": false,
|
|
5904
|
-
"description": "A short description of the expected input."
|
|
5905
|
-
},
|
|
5906
|
-
"hintPosition": {
|
|
5907
|
-
"type": {
|
|
5908
|
-
"name": "enum",
|
|
5909
|
-
"value": [
|
|
5910
|
-
{
|
|
5911
|
-
"value": "'inline'",
|
|
5912
|
-
"computed": false
|
|
5913
|
-
},
|
|
5914
|
-
{
|
|
5915
|
-
"value": "'below'",
|
|
5916
|
-
"computed": false
|
|
5917
|
-
}
|
|
5918
|
-
]
|
|
5919
|
-
},
|
|
5920
|
-
"required": false,
|
|
5921
|
-
"description": "Position of the hint relative to label. Use `below` to display a larger hint below the label."
|
|
5922
|
-
},
|
|
5923
|
-
"feedback": {
|
|
5924
|
-
"type": {
|
|
5925
|
-
"name": "string"
|
|
5926
|
-
},
|
|
5927
|
-
"required": false,
|
|
5928
|
-
"description": "A detailed description of validation error/success or additional instructions.\nVisual variant is determined based on the `validation` prop."
|
|
5929
|
-
},
|
|
5930
|
-
"tooltip": {
|
|
5931
|
-
"type": {
|
|
5932
|
-
"name": "string"
|
|
5933
|
-
},
|
|
5934
|
-
"required": false,
|
|
5935
|
-
"description": "Content of an optional `Tooltip`. If set, a tooltip button will be shown next to the label."
|
|
5936
|
-
},
|
|
5937
|
-
"validation": {
|
|
5938
|
-
"type": {
|
|
5939
|
-
"name": "enum",
|
|
5940
|
-
"value": [
|
|
5941
|
-
{
|
|
5942
|
-
"value": "'error'",
|
|
5943
|
-
"computed": false
|
|
5944
|
-
},
|
|
5945
|
-
{
|
|
5946
|
-
"value": "'success'",
|
|
5947
|
-
"computed": false
|
|
5948
|
-
}
|
|
5949
|
-
]
|
|
5950
|
-
},
|
|
5951
|
-
"required": false,
|
|
5952
|
-
"description": "Use to visually mark an input as valid or invalid."
|
|
5953
|
-
},
|
|
5954
5842
|
"initialValue": {
|
|
5955
5843
|
"type": {
|
|
5956
5844
|
"name": "string"
|
|
@@ -6233,6 +6121,13 @@
|
|
|
6233
6121
|
"docs": {
|
|
6234
6122
|
"description": "`SideNav.Item` is a navigational element that is used within `SideNav` or `SideNav.ItemsGroup`.\n\n This component can only be accessed as a name-spaced component: `SideNav.Item`.",
|
|
6235
6123
|
"props": {
|
|
6124
|
+
"accessibilityRole": {
|
|
6125
|
+
"defaultValue": {
|
|
6126
|
+
"value": "'link'",
|
|
6127
|
+
"computed": false
|
|
6128
|
+
},
|
|
6129
|
+
"required": false
|
|
6130
|
+
},
|
|
6236
6131
|
"children": {
|
|
6237
6132
|
"type": {
|
|
6238
6133
|
"name": "node"
|
|
@@ -6343,7 +6238,7 @@
|
|
|
6343
6238
|
}
|
|
6344
6239
|
},
|
|
6345
6240
|
"attributes": {
|
|
6346
|
-
"acceptsRNA11yProps":
|
|
6241
|
+
"acceptsRNA11yProps": false
|
|
6347
6242
|
}
|
|
6348
6243
|
}
|
|
6349
6244
|
},
|
|
@@ -6625,59 +6520,6 @@
|
|
|
6625
6520
|
"required": false,
|
|
6626
6521
|
"description": "Sets the `flexDirection` of the container and, if `divider` is used, gives the Divider the appropriate direction."
|
|
6627
6522
|
},
|
|
6628
|
-
"pointerEvents": {
|
|
6629
|
-
"type": {
|
|
6630
|
-
"name": "enum",
|
|
6631
|
-
"value": [
|
|
6632
|
-
{
|
|
6633
|
-
"value": "'all'",
|
|
6634
|
-
"computed": false
|
|
6635
|
-
},
|
|
6636
|
-
{
|
|
6637
|
-
"value": "'none'",
|
|
6638
|
-
"computed": false
|
|
6639
|
-
},
|
|
6640
|
-
{
|
|
6641
|
-
"value": "'box-only'",
|
|
6642
|
-
"computed": false
|
|
6643
|
-
},
|
|
6644
|
-
{
|
|
6645
|
-
"value": "'box-none'",
|
|
6646
|
-
"computed": false
|
|
6647
|
-
}
|
|
6648
|
-
]
|
|
6649
|
-
},
|
|
6650
|
-
"required": false,
|
|
6651
|
-
"description": ""
|
|
6652
|
-
},
|
|
6653
|
-
"onLayout": {
|
|
6654
|
-
"type": {
|
|
6655
|
-
"name": "func"
|
|
6656
|
-
},
|
|
6657
|
-
"required": false,
|
|
6658
|
-
"description": ""
|
|
6659
|
-
},
|
|
6660
|
-
"nativeID": {
|
|
6661
|
-
"type": {
|
|
6662
|
-
"name": "string"
|
|
6663
|
-
},
|
|
6664
|
-
"required": false,
|
|
6665
|
-
"description": ""
|
|
6666
|
-
},
|
|
6667
|
-
"testID": {
|
|
6668
|
-
"type": {
|
|
6669
|
-
"name": "string"
|
|
6670
|
-
},
|
|
6671
|
-
"required": false,
|
|
6672
|
-
"description": ""
|
|
6673
|
-
},
|
|
6674
|
-
"dataSet": {
|
|
6675
|
-
"type": {
|
|
6676
|
-
"name": "object"
|
|
6677
|
-
},
|
|
6678
|
-
"required": false,
|
|
6679
|
-
"description": ""
|
|
6680
|
-
},
|
|
6681
6523
|
"tokens": {
|
|
6682
6524
|
"type": {
|
|
6683
6525
|
"name": "custom",
|
|
@@ -6741,11 +6583,6 @@
|
|
|
6741
6583
|
"name": "bool",
|
|
6742
6584
|
"description": "By default, the divider is a horizontal line the full width of its parent.\nWith `vertical` prop and when inside a container with { flexDirection: row }, draws a full height vertical line.",
|
|
6743
6585
|
"required": false
|
|
6744
|
-
},
|
|
6745
|
-
"testID": {
|
|
6746
|
-
"name": "string",
|
|
6747
|
-
"description": "@ignore\nIn tests, the only way to select dividers is with testID prop and getByTestId, since they have no content,\nno accessibility role on native, and there is no equivalent of nextSibling in React Native Testing Library.",
|
|
6748
|
-
"required": false
|
|
6749
6586
|
}
|
|
6750
6587
|
}
|
|
6751
6588
|
}
|
|
@@ -7309,110 +7146,7 @@
|
|
|
7309
7146
|
}
|
|
7310
7147
|
}
|
|
7311
7148
|
},
|
|
7312
|
-
"
|
|
7313
|
-
"docs": {
|
|
7314
|
-
"description": "",
|
|
7315
|
-
"props": {
|
|
7316
|
-
"accessibilityRole": {
|
|
7317
|
-
"defaultValue": {
|
|
7318
|
-
"value": "'switch'",
|
|
7319
|
-
"computed": false
|
|
7320
|
-
},
|
|
7321
|
-
"required": false
|
|
7322
|
-
},
|
|
7323
|
-
"tokens": {
|
|
7324
|
-
"type": {
|
|
7325
|
-
"name": "custom",
|
|
7326
|
-
"raw": {
|
|
7327
|
-
"borderColor": "color",
|
|
7328
|
-
"borderWidth": "border",
|
|
7329
|
-
"borderRadius": "radius",
|
|
7330
|
-
"outerBorderColor": "color",
|
|
7331
|
-
"outerBorderWidth": "border",
|
|
7332
|
-
"outerBorderGap": "size",
|
|
7333
|
-
"outerBackgroundColor": "color",
|
|
7334
|
-
"backgroundColor": "color",
|
|
7335
|
-
"opacity": "opacity",
|
|
7336
|
-
"paddingLeft": "size",
|
|
7337
|
-
"paddingRight": "size",
|
|
7338
|
-
"paddingTop": "size",
|
|
7339
|
-
"paddingBottom": "size",
|
|
7340
|
-
"shadow": "shadow",
|
|
7341
|
-
"alignSelf": "flexAlign",
|
|
7342
|
-
"icon": "icon",
|
|
7343
|
-
"width": "size",
|
|
7344
|
-
"trackBorderWidth": "border",
|
|
7345
|
-
"trackBorderColor": "color",
|
|
7346
|
-
"trackBorderRadius": "radius",
|
|
7347
|
-
"iconSize": "size",
|
|
7348
|
-
"iconColor": "color",
|
|
7349
|
-
"switchSize": "size",
|
|
7350
|
-
"switchColor": "color",
|
|
7351
|
-
"switchBorderColor": "color",
|
|
7352
|
-
"switchBorderWidth": "border",
|
|
7353
|
-
"switchBorderRadius": "radius",
|
|
7354
|
-
"switchShadow": "shadow"
|
|
7355
|
-
}
|
|
7356
|
-
},
|
|
7357
|
-
"required": false,
|
|
7358
|
-
"description": ""
|
|
7359
|
-
},
|
|
7360
|
-
"variant": {
|
|
7361
|
-
"type": {
|
|
7362
|
-
"name": "objectOf",
|
|
7363
|
-
"value": {
|
|
7364
|
-
"name": "union",
|
|
7365
|
-
"value": [
|
|
7366
|
-
{
|
|
7367
|
-
"name": "string"
|
|
7368
|
-
},
|
|
7369
|
-
{
|
|
7370
|
-
"name": "number"
|
|
7371
|
-
},
|
|
7372
|
-
{
|
|
7373
|
-
"name": "bool"
|
|
7374
|
-
}
|
|
7375
|
-
]
|
|
7376
|
-
}
|
|
7377
|
-
},
|
|
7378
|
-
"required": false,
|
|
7379
|
-
"description": ""
|
|
7380
|
-
},
|
|
7381
|
-
"value": {
|
|
7382
|
-
"type": {
|
|
7383
|
-
"name": "bool"
|
|
7384
|
-
},
|
|
7385
|
-
"required": false,
|
|
7386
|
-
"description": "If this is a \"controlled\" component and a parent handles its selected state,\ntells the switch if it is on (true) or off (false)."
|
|
7387
|
-
},
|
|
7388
|
-
"initialValue": {
|
|
7389
|
-
"type": {
|
|
7390
|
-
"name": "bool"
|
|
7391
|
-
},
|
|
7392
|
-
"required": false,
|
|
7393
|
-
"description": "If this is an \"uncontrolled\" component that handles its own selected state,\noptionally tells the switch if it should default to on (true) or off (false)."
|
|
7394
|
-
},
|
|
7395
|
-
"onChange": {
|
|
7396
|
-
"type": {
|
|
7397
|
-
"name": "func"
|
|
7398
|
-
},
|
|
7399
|
-
"required": false,
|
|
7400
|
-
"description": "Function called when the switch is toggled, with one boolean argument that is the\nnew position of the switch, on (true) or off (false). For \"controlled\" components,\nthis should always be passed and used to control the state of the switch."
|
|
7401
|
-
},
|
|
7402
|
-
"inactive": {
|
|
7403
|
-
"type": {
|
|
7404
|
-
"name": "bool"
|
|
7405
|
-
},
|
|
7406
|
-
"required": false,
|
|
7407
|
-
"description": "If passed, the switch does not respond to user input and may recieve different\ntheme tokens if the theme supports inactive appearance."
|
|
7408
|
-
}
|
|
7409
|
-
},
|
|
7410
|
-
"attributes": {
|
|
7411
|
-
"acceptsRNA11yProps": false
|
|
7412
|
-
}
|
|
7413
|
-
}
|
|
7414
|
-
},
|
|
7415
|
-
"Tooltip": {
|
|
7149
|
+
"Tooltip": {
|
|
7416
7150
|
"docs": {
|
|
7417
7151
|
"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.",
|
|
7418
7152
|
"props": {
|
|
@@ -7694,6 +7428,13 @@
|
|
|
7694
7428
|
"required": false,
|
|
7695
7429
|
"description": "Optional semantic HTML tag, to apply to the text on web. Does not change styling.\n\n`tag` and `heading` props set the same thing, so shouldn't be used together (`tag` overrides `heading`).\n\nIn native apps, if a header tag is provided (\"h1\", \"h2\" etc) and accessibilityRole prop\nis not defined, the accessibilityRole will default to \"heading\"."
|
|
7696
7430
|
},
|
|
7431
|
+
"accessibilityRole": {
|
|
7432
|
+
"defaultValue": {
|
|
7433
|
+
"value": "heading === true ? 'header' : undefined",
|
|
7434
|
+
"computed": false
|
|
7435
|
+
},
|
|
7436
|
+
"required": false
|
|
7437
|
+
},
|
|
7697
7438
|
"block": {
|
|
7698
7439
|
"defaultValue": {
|
|
7699
7440
|
"value": "false",
|
|
@@ -7822,7 +7563,7 @@
|
|
|
7822
7563
|
}
|
|
7823
7564
|
},
|
|
7824
7565
|
"attributes": {
|
|
7825
|
-
"acceptsRNA11yProps":
|
|
7566
|
+
"acceptsRNA11yProps": false
|
|
7826
7567
|
}
|
|
7827
7568
|
}
|
|
7828
7569
|
},
|
|
@@ -7925,6 +7666,38 @@
|
|
|
7925
7666
|
"docs": {
|
|
7926
7667
|
"description": "",
|
|
7927
7668
|
"props": {
|
|
7669
|
+
"tokens": {
|
|
7670
|
+
"type": {
|
|
7671
|
+
"name": "custom",
|
|
7672
|
+
"raw": {
|
|
7673
|
+
"borderColor": "color",
|
|
7674
|
+
"borderWidth": "border",
|
|
7675
|
+
"borderRadius": "radius",
|
|
7676
|
+
"shadow": "shadow",
|
|
7677
|
+
"fontSize": "fontSize",
|
|
7678
|
+
"color": "color",
|
|
7679
|
+
"lineHeight": "lineHeight",
|
|
7680
|
+
"textAlign": "flexJustifyContent",
|
|
7681
|
+
"alignSelf": "flexAlign",
|
|
7682
|
+
"fontName": "fontName",
|
|
7683
|
+
"fontWeight": "fontWeight",
|
|
7684
|
+
"backgroundColor": "color",
|
|
7685
|
+
"opacity": "opacity",
|
|
7686
|
+
"paddingLeft": "size",
|
|
7687
|
+
"paddingRight": "size",
|
|
7688
|
+
"paddingTop": "size",
|
|
7689
|
+
"paddingBottom": "size",
|
|
7690
|
+
"width": "size",
|
|
7691
|
+
"minWidth": "size",
|
|
7692
|
+
"outerBorderColor": "color",
|
|
7693
|
+
"outerBorderWidth": "border",
|
|
7694
|
+
"outerBorderGap": "size",
|
|
7695
|
+
"outerBackgroundColor": "color"
|
|
7696
|
+
}
|
|
7697
|
+
},
|
|
7698
|
+
"required": false,
|
|
7699
|
+
"description": ""
|
|
7700
|
+
},
|
|
7928
7701
|
"inactive": {
|
|
7929
7702
|
"type": {
|
|
7930
7703
|
"name": "bool"
|
|
@@ -7985,6 +7758,38 @@
|
|
|
7985
7758
|
"docs": {
|
|
7986
7759
|
"description": "`ButtonLink` is a component with the semantics and behaviour of a link, but with the visual appearance of a button.\nButtonLink is a block-level component and should not be used inline.",
|
|
7987
7760
|
"props": {
|
|
7761
|
+
"tokens": {
|
|
7762
|
+
"type": {
|
|
7763
|
+
"name": "custom",
|
|
7764
|
+
"raw": {
|
|
7765
|
+
"borderColor": "color",
|
|
7766
|
+
"borderWidth": "border",
|
|
7767
|
+
"borderRadius": "radius",
|
|
7768
|
+
"shadow": "shadow",
|
|
7769
|
+
"fontSize": "fontSize",
|
|
7770
|
+
"color": "color",
|
|
7771
|
+
"lineHeight": "lineHeight",
|
|
7772
|
+
"textAlign": "flexJustifyContent",
|
|
7773
|
+
"alignSelf": "flexAlign",
|
|
7774
|
+
"fontName": "fontName",
|
|
7775
|
+
"fontWeight": "fontWeight",
|
|
7776
|
+
"backgroundColor": "color",
|
|
7777
|
+
"opacity": "opacity",
|
|
7778
|
+
"paddingLeft": "size",
|
|
7779
|
+
"paddingRight": "size",
|
|
7780
|
+
"paddingTop": "size",
|
|
7781
|
+
"paddingBottom": "size",
|
|
7782
|
+
"width": "size",
|
|
7783
|
+
"minWidth": "size",
|
|
7784
|
+
"outerBorderColor": "color",
|
|
7785
|
+
"outerBorderWidth": "border",
|
|
7786
|
+
"outerBorderGap": "size",
|
|
7787
|
+
"outerBackgroundColor": "color"
|
|
7788
|
+
}
|
|
7789
|
+
},
|
|
7790
|
+
"required": false,
|
|
7791
|
+
"description": ""
|
|
7792
|
+
},
|
|
7988
7793
|
"inactive": {
|
|
7989
7794
|
"type": {
|
|
7990
7795
|
"name": "bool"
|
|
@@ -8666,87 +8471,106 @@
|
|
|
8666
8471
|
"required": false,
|
|
8667
8472
|
"description": ""
|
|
8668
8473
|
},
|
|
8669
|
-
"
|
|
8474
|
+
"tokens": {
|
|
8670
8475
|
"type": {
|
|
8671
|
-
"name": "
|
|
8476
|
+
"name": "custom",
|
|
8477
|
+
"raw": "getTokensPropType('ChevronLink', 'Link')"
|
|
8672
8478
|
},
|
|
8673
8479
|
"required": false,
|
|
8674
8480
|
"description": ""
|
|
8481
|
+
}
|
|
8482
|
+
},
|
|
8483
|
+
"attributes": {
|
|
8484
|
+
"acceptsRNA11yProps": false
|
|
8485
|
+
}
|
|
8486
|
+
}
|
|
8487
|
+
},
|
|
8488
|
+
"Link": {
|
|
8489
|
+
"docs": {
|
|
8490
|
+
"description": "",
|
|
8491
|
+
"props": {
|
|
8492
|
+
"accessibilityRole": {
|
|
8493
|
+
"defaultValue": {
|
|
8494
|
+
"value": "'link'",
|
|
8495
|
+
"computed": false
|
|
8496
|
+
},
|
|
8497
|
+
"required": false
|
|
8675
8498
|
},
|
|
8676
|
-
"
|
|
8499
|
+
"variant": {
|
|
8500
|
+
"defaultValue": {
|
|
8501
|
+
"value": "{}",
|
|
8502
|
+
"computed": false
|
|
8503
|
+
},
|
|
8504
|
+
"required": false
|
|
8505
|
+
}
|
|
8506
|
+
},
|
|
8507
|
+
"attributes": {
|
|
8508
|
+
"acceptsRNA11yProps": false
|
|
8509
|
+
}
|
|
8510
|
+
}
|
|
8511
|
+
},
|
|
8512
|
+
"LinkBase": {
|
|
8513
|
+
"docs": {
|
|
8514
|
+
"description": "Renders a pressable text link, with optional icon. This is rendered as a block element\nonly (see 'Current Limitations'). On Web, renders an `<a>` anchor tag if `href` is provided.\n\n## Current limitations\n\n- Not yet integrated with widely-used Telus navigation packages. This will probably\n require adding a `navigate` prop that aliases onPress so this can be passed to\n router's Link components' `Component` or `as` props but this needs testing\n as part of https://github.com/telus/universal-design-system/issues/24\n\n- Doesn't work inline e.g. in paragraphs. Support for inline links in native and\n web was implemented in https://github.com/telus/universal-design-system/pull/233\n but removed and will need to be restored at some point. When inline link support\n is restored, icons in inline links on Android will be slightly off-centre\n vertically (see )\n\n- Doesn't support :visited styles on web. Support for :visited styles was\n implemented in https://github.com/telus/universal-design-system/pull/234 but\n dropped in favour of investigating if a full-featured CSS-in-JS package could or\n should be used more widely (e.g. styled components)",
|
|
8515
|
+
"props": {
|
|
8516
|
+
"iconPosition": {
|
|
8517
|
+
"defaultValue": {
|
|
8518
|
+
"value": "icon ? 'left' : undefined",
|
|
8519
|
+
"computed": false
|
|
8520
|
+
},
|
|
8677
8521
|
"type": {
|
|
8678
|
-
"name": "
|
|
8522
|
+
"name": "enum",
|
|
8523
|
+
"value": [
|
|
8524
|
+
{
|
|
8525
|
+
"value": "'left'",
|
|
8526
|
+
"computed": false
|
|
8527
|
+
},
|
|
8528
|
+
{
|
|
8529
|
+
"value": "'right'",
|
|
8530
|
+
"computed": false
|
|
8531
|
+
}
|
|
8532
|
+
]
|
|
8679
8533
|
},
|
|
8680
8534
|
"required": false,
|
|
8681
|
-
"description": ""
|
|
8535
|
+
"description": "When `icon` is provided, use `iconPosition` to place the Icon to the left or right side of Link."
|
|
8682
8536
|
},
|
|
8683
|
-
"
|
|
8537
|
+
"tokens": {
|
|
8538
|
+
"defaultValue": {
|
|
8539
|
+
"value": "{}",
|
|
8540
|
+
"computed": false
|
|
8541
|
+
},
|
|
8684
8542
|
"type": {
|
|
8685
|
-
"name": "
|
|
8543
|
+
"name": "custom",
|
|
8544
|
+
"raw": {
|
|
8545
|
+
"color": "color",
|
|
8546
|
+
"textLine": "textLine",
|
|
8547
|
+
"textLineStyle": "textLineStyle",
|
|
8548
|
+
"outerBorderColor": "color",
|
|
8549
|
+
"outerBorderWidth": "border",
|
|
8550
|
+
"outerBorderGap": "size",
|
|
8551
|
+
"outerBorderOutline": "borderStyle",
|
|
8552
|
+
"borderRadius": "radius",
|
|
8553
|
+
"blockFontName": "fontName",
|
|
8554
|
+
"blockFontWeight": "fontWeight",
|
|
8555
|
+
"blockFontSize": "fontSize",
|
|
8556
|
+
"blockLineHeight": "lineHeight",
|
|
8557
|
+
"icon": "icon",
|
|
8558
|
+
"iconSize": "size",
|
|
8559
|
+
"iconSpace": "integer",
|
|
8560
|
+
"iconTranslateX": "size",
|
|
8561
|
+
"iconTranslateY": "size",
|
|
8562
|
+
"alignSelf": "flexAlign"
|
|
8563
|
+
}
|
|
8686
8564
|
},
|
|
8687
8565
|
"required": false,
|
|
8688
8566
|
"description": ""
|
|
8689
8567
|
},
|
|
8690
|
-
"
|
|
8691
|
-
"
|
|
8692
|
-
"
|
|
8693
|
-
|
|
8694
|
-
"required": false,
|
|
8695
|
-
"description": ""
|
|
8696
|
-
},
|
|
8697
|
-
"href": {
|
|
8698
|
-
"type": {
|
|
8699
|
-
"name": "string"
|
|
8700
|
-
},
|
|
8701
|
-
"required": false,
|
|
8702
|
-
"description": ""
|
|
8703
|
-
},
|
|
8704
|
-
"hrefAttrs": {
|
|
8705
|
-
"type": {
|
|
8706
|
-
"name": "shape",
|
|
8707
|
-
"value": {
|
|
8708
|
-
"download": {
|
|
8709
|
-
"name": "string",
|
|
8710
|
-
"required": false
|
|
8711
|
-
},
|
|
8712
|
-
"rel": {
|
|
8713
|
-
"name": "string",
|
|
8714
|
-
"required": false
|
|
8715
|
-
},
|
|
8716
|
-
"target": {
|
|
8717
|
-
"name": "enum",
|
|
8718
|
-
"value": [
|
|
8719
|
-
{
|
|
8720
|
-
"value": "'_self'",
|
|
8721
|
-
"computed": false
|
|
8722
|
-
},
|
|
8723
|
-
{
|
|
8724
|
-
"value": "'_blank'",
|
|
8725
|
-
"computed": false
|
|
8726
|
-
},
|
|
8727
|
-
{
|
|
8728
|
-
"value": "'_parent'",
|
|
8729
|
-
"computed": false
|
|
8730
|
-
},
|
|
8731
|
-
{
|
|
8732
|
-
"value": "'_top'",
|
|
8733
|
-
"computed": false
|
|
8734
|
-
}
|
|
8735
|
-
],
|
|
8736
|
-
"required": false
|
|
8737
|
-
}
|
|
8738
|
-
}
|
|
8739
|
-
},
|
|
8740
|
-
"required": false,
|
|
8741
|
-
"description": "On Web if href is passed, React Native Web maps this object's props to\n`rel`, `target` and `download` attrs."
|
|
8742
|
-
},
|
|
8743
|
-
"tokens": {
|
|
8744
|
-
"type": {
|
|
8745
|
-
"name": "custom",
|
|
8746
|
-
"raw": "getTokensPropType('ChevronLink', 'Link')"
|
|
8568
|
+
"accessibilityRole": {
|
|
8569
|
+
"defaultValue": {
|
|
8570
|
+
"value": "'link'",
|
|
8571
|
+
"computed": false
|
|
8747
8572
|
},
|
|
8748
|
-
"required": false
|
|
8749
|
-
"description": ""
|
|
8573
|
+
"required": false
|
|
8750
8574
|
},
|
|
8751
8575
|
"variant": {
|
|
8752
8576
|
"type": {
|
|
@@ -8805,93 +8629,6 @@
|
|
|
8805
8629
|
"required": false,
|
|
8806
8630
|
"description": "A function component for an SVG icon to render inside the link. Inherits size and color from\nthe link and any Typography the link is nested inside."
|
|
8807
8631
|
},
|
|
8808
|
-
"iconPosition": {
|
|
8809
|
-
"type": {
|
|
8810
|
-
"name": "enum",
|
|
8811
|
-
"value": [
|
|
8812
|
-
{
|
|
8813
|
-
"value": "'left'",
|
|
8814
|
-
"computed": false
|
|
8815
|
-
},
|
|
8816
|
-
{
|
|
8817
|
-
"value": "'right'",
|
|
8818
|
-
"computed": false
|
|
8819
|
-
}
|
|
8820
|
-
]
|
|
8821
|
-
},
|
|
8822
|
-
"required": false,
|
|
8823
|
-
"description": "When `icon` is provided, use `iconPosition` to place the Icon to the left or right side of Link."
|
|
8824
|
-
}
|
|
8825
|
-
},
|
|
8826
|
-
"attributes": {
|
|
8827
|
-
"acceptsRNA11yProps": true
|
|
8828
|
-
}
|
|
8829
|
-
}
|
|
8830
|
-
},
|
|
8831
|
-
"Link": {
|
|
8832
|
-
"docs": {
|
|
8833
|
-
"description": "",
|
|
8834
|
-
"props": {
|
|
8835
|
-
"variant": {
|
|
8836
|
-
"defaultValue": {
|
|
8837
|
-
"value": "{}",
|
|
8838
|
-
"computed": false
|
|
8839
|
-
},
|
|
8840
|
-
"type": {
|
|
8841
|
-
"name": "objectOf",
|
|
8842
|
-
"value": {
|
|
8843
|
-
"name": "union",
|
|
8844
|
-
"value": [
|
|
8845
|
-
{
|
|
8846
|
-
"name": "string"
|
|
8847
|
-
},
|
|
8848
|
-
{
|
|
8849
|
-
"name": "number"
|
|
8850
|
-
},
|
|
8851
|
-
{
|
|
8852
|
-
"name": "bool"
|
|
8853
|
-
}
|
|
8854
|
-
]
|
|
8855
|
-
}
|
|
8856
|
-
},
|
|
8857
|
-
"required": false,
|
|
8858
|
-
"description": ""
|
|
8859
|
-
},
|
|
8860
|
-
"onPress": {
|
|
8861
|
-
"type": {
|
|
8862
|
-
"name": "func"
|
|
8863
|
-
},
|
|
8864
|
-
"required": false,
|
|
8865
|
-
"description": ""
|
|
8866
|
-
},
|
|
8867
|
-
"onPressIn": {
|
|
8868
|
-
"type": {
|
|
8869
|
-
"name": "func"
|
|
8870
|
-
},
|
|
8871
|
-
"required": false,
|
|
8872
|
-
"description": ""
|
|
8873
|
-
},
|
|
8874
|
-
"onPressOut": {
|
|
8875
|
-
"type": {
|
|
8876
|
-
"name": "func"
|
|
8877
|
-
},
|
|
8878
|
-
"required": false,
|
|
8879
|
-
"description": ""
|
|
8880
|
-
},
|
|
8881
|
-
"disabled": {
|
|
8882
|
-
"type": {
|
|
8883
|
-
"name": "bool"
|
|
8884
|
-
},
|
|
8885
|
-
"required": false,
|
|
8886
|
-
"description": ""
|
|
8887
|
-
},
|
|
8888
|
-
"href": {
|
|
8889
|
-
"type": {
|
|
8890
|
-
"name": "string"
|
|
8891
|
-
},
|
|
8892
|
-
"required": false,
|
|
8893
|
-
"description": ""
|
|
8894
|
-
},
|
|
8895
8632
|
"hrefAttrs": {
|
|
8896
8633
|
"type": {
|
|
8897
8634
|
"name": "shape",
|
|
@@ -8930,478 +8667,44 @@
|
|
|
8930
8667
|
},
|
|
8931
8668
|
"required": false,
|
|
8932
8669
|
"description": "On Web if href is passed, React Native Web maps this object's props to\n`rel`, `target` and `download` attrs."
|
|
8933
|
-
}
|
|
8934
|
-
|
|
8935
|
-
|
|
8936
|
-
|
|
8937
|
-
|
|
8938
|
-
|
|
8939
|
-
|
|
8940
|
-
|
|
8941
|
-
|
|
8942
|
-
|
|
8943
|
-
|
|
8944
|
-
|
|
8945
|
-
|
|
8946
|
-
|
|
8947
|
-
|
|
8948
|
-
"blockFontSize": "fontSize",
|
|
8949
|
-
"blockLineHeight": "lineHeight",
|
|
8950
|
-
"icon": "icon",
|
|
8951
|
-
"iconSize": "size",
|
|
8952
|
-
"iconSpace": "integer",
|
|
8953
|
-
"iconTranslateX": "size",
|
|
8954
|
-
"iconTranslateY": "size",
|
|
8955
|
-
"alignSelf": "flexAlign"
|
|
8956
|
-
}
|
|
8957
|
-
},
|
|
8958
|
-
"required": false,
|
|
8959
|
-
"description": ""
|
|
8960
|
-
},
|
|
8961
|
-
"iconProps": {
|
|
8962
|
-
"type": {
|
|
8963
|
-
"name": "exact",
|
|
8964
|
-
"value": {
|
|
8965
|
-
"variant": {
|
|
8966
|
-
"name": "custom",
|
|
8967
|
-
"raw": "variantProp.propType",
|
|
8968
|
-
"required": false
|
|
8969
|
-
},
|
|
8970
|
-
"tokens": {
|
|
8971
|
-
"name": "custom",
|
|
8972
|
-
"raw": "getTokensPropType('Icon')",
|
|
8973
|
-
"required": false
|
|
8974
|
-
},
|
|
8975
|
-
"accessibilityLabel": {
|
|
8976
|
-
"name": "string",
|
|
8977
|
-
"description": "Descriptive label used in web SVG title tag for accessibility",
|
|
8978
|
-
"required": false
|
|
8979
|
-
},
|
|
8980
|
-
"scalesWithText": {
|
|
8981
|
-
"name": "bool",
|
|
8982
|
-
"description": "controls whether the icon size should be proportionate to any accessibility-related font scaling.",
|
|
8983
|
-
"required": false
|
|
8984
|
-
}
|
|
8985
|
-
}
|
|
8670
|
+
}
|
|
8671
|
+
},
|
|
8672
|
+
"attributes": {
|
|
8673
|
+
"acceptsRNA11yProps": false
|
|
8674
|
+
}
|
|
8675
|
+
}
|
|
8676
|
+
},
|
|
8677
|
+
"TextButton": {
|
|
8678
|
+
"docs": {
|
|
8679
|
+
"description": "`TextButton` is a button that looks like a Link. It uses the same theming and variants as\nLink but has the accessibility role of a `Button`. It should be used for actions that\ntake place on the current page, or for navigation within an app.",
|
|
8680
|
+
"props": {
|
|
8681
|
+
"accessibilityRole": {
|
|
8682
|
+
"defaultValue": {
|
|
8683
|
+
"value": "'button'",
|
|
8684
|
+
"computed": false
|
|
8986
8685
|
},
|
|
8987
|
-
"required": false
|
|
8988
|
-
"description": "Optional variant that may be passed down to the link's icon if there is one"
|
|
8686
|
+
"required": false
|
|
8989
8687
|
},
|
|
8990
|
-
"
|
|
8688
|
+
"onPress": {
|
|
8991
8689
|
"type": {
|
|
8992
8690
|
"name": "func"
|
|
8993
8691
|
},
|
|
8994
|
-
"required":
|
|
8995
|
-
"description": "
|
|
8996
|
-
},
|
|
8997
|
-
"iconPosition": {
|
|
8998
|
-
"type": {
|
|
8999
|
-
"name": "enum",
|
|
9000
|
-
"value": [
|
|
9001
|
-
{
|
|
9002
|
-
"value": "'left'",
|
|
9003
|
-
"computed": false
|
|
9004
|
-
},
|
|
9005
|
-
{
|
|
9006
|
-
"value": "'right'",
|
|
9007
|
-
"computed": false
|
|
9008
|
-
}
|
|
9009
|
-
]
|
|
9010
|
-
},
|
|
9011
|
-
"required": false,
|
|
9012
|
-
"description": "When `icon` is provided, use `iconPosition` to place the Icon to the left or right side of Link."
|
|
8692
|
+
"required": true,
|
|
8693
|
+
"description": ""
|
|
9013
8694
|
}
|
|
9014
8695
|
},
|
|
9015
8696
|
"attributes": {
|
|
9016
|
-
"acceptsRNA11yProps":
|
|
8697
|
+
"acceptsRNA11yProps": false
|
|
9017
8698
|
}
|
|
9018
8699
|
}
|
|
9019
8700
|
},
|
|
9020
|
-
"
|
|
8701
|
+
"RadioGroup": {
|
|
9021
8702
|
"docs": {
|
|
9022
|
-
"description": "
|
|
8703
|
+
"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 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\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```",
|
|
9023
8704
|
"props": {
|
|
9024
|
-
"
|
|
8705
|
+
"items": {
|
|
9025
8706
|
"defaultValue": {
|
|
9026
|
-
"value": "
|
|
9027
|
-
"computed": false
|
|
9028
|
-
},
|
|
9029
|
-
"type": {
|
|
9030
|
-
"name": "enum",
|
|
9031
|
-
"value": [
|
|
9032
|
-
{
|
|
9033
|
-
"value": "'left'",
|
|
9034
|
-
"computed": false
|
|
9035
|
-
},
|
|
9036
|
-
{
|
|
9037
|
-
"value": "'right'",
|
|
9038
|
-
"computed": false
|
|
9039
|
-
}
|
|
9040
|
-
]
|
|
9041
|
-
},
|
|
9042
|
-
"required": false,
|
|
9043
|
-
"description": "When `icon` is provided, use `iconPosition` to place the Icon to the left or right side of Link."
|
|
9044
|
-
},
|
|
9045
|
-
"tokens": {
|
|
9046
|
-
"defaultValue": {
|
|
9047
|
-
"value": "{}",
|
|
9048
|
-
"computed": false
|
|
9049
|
-
},
|
|
9050
|
-
"type": {
|
|
9051
|
-
"name": "custom",
|
|
9052
|
-
"raw": {
|
|
9053
|
-
"color": "color",
|
|
9054
|
-
"textLine": "textLine",
|
|
9055
|
-
"textLineStyle": "textLineStyle",
|
|
9056
|
-
"outerBorderColor": "color",
|
|
9057
|
-
"outerBorderWidth": "border",
|
|
9058
|
-
"outerBorderGap": "size",
|
|
9059
|
-
"outerBorderOutline": "borderStyle",
|
|
9060
|
-
"borderRadius": "radius",
|
|
9061
|
-
"blockFontName": "fontName",
|
|
9062
|
-
"blockFontWeight": "fontWeight",
|
|
9063
|
-
"blockFontSize": "fontSize",
|
|
9064
|
-
"blockLineHeight": "lineHeight",
|
|
9065
|
-
"icon": "icon",
|
|
9066
|
-
"iconSize": "size",
|
|
9067
|
-
"iconSpace": "integer",
|
|
9068
|
-
"iconTranslateX": "size",
|
|
9069
|
-
"iconTranslateY": "size",
|
|
9070
|
-
"alignSelf": "flexAlign"
|
|
9071
|
-
}
|
|
9072
|
-
},
|
|
9073
|
-
"required": false,
|
|
9074
|
-
"description": ""
|
|
9075
|
-
},
|
|
9076
|
-
"onPress": {
|
|
9077
|
-
"type": {
|
|
9078
|
-
"name": "func"
|
|
9079
|
-
},
|
|
9080
|
-
"required": false,
|
|
9081
|
-
"description": ""
|
|
9082
|
-
},
|
|
9083
|
-
"onPressIn": {
|
|
9084
|
-
"type": {
|
|
9085
|
-
"name": "func"
|
|
9086
|
-
},
|
|
9087
|
-
"required": false,
|
|
9088
|
-
"description": ""
|
|
9089
|
-
},
|
|
9090
|
-
"onPressOut": {
|
|
9091
|
-
"type": {
|
|
9092
|
-
"name": "func"
|
|
9093
|
-
},
|
|
9094
|
-
"required": false,
|
|
9095
|
-
"description": ""
|
|
9096
|
-
},
|
|
9097
|
-
"disabled": {
|
|
9098
|
-
"type": {
|
|
9099
|
-
"name": "bool"
|
|
9100
|
-
},
|
|
9101
|
-
"required": false,
|
|
9102
|
-
"description": ""
|
|
9103
|
-
},
|
|
9104
|
-
"href": {
|
|
9105
|
-
"type": {
|
|
9106
|
-
"name": "string"
|
|
9107
|
-
},
|
|
9108
|
-
"required": false,
|
|
9109
|
-
"description": ""
|
|
9110
|
-
},
|
|
9111
|
-
"hrefAttrs": {
|
|
9112
|
-
"type": {
|
|
9113
|
-
"name": "shape",
|
|
9114
|
-
"value": {
|
|
9115
|
-
"download": {
|
|
9116
|
-
"name": "string",
|
|
9117
|
-
"required": false
|
|
9118
|
-
},
|
|
9119
|
-
"rel": {
|
|
9120
|
-
"name": "string",
|
|
9121
|
-
"required": false
|
|
9122
|
-
},
|
|
9123
|
-
"target": {
|
|
9124
|
-
"name": "enum",
|
|
9125
|
-
"value": [
|
|
9126
|
-
{
|
|
9127
|
-
"value": "'_self'",
|
|
9128
|
-
"computed": false
|
|
9129
|
-
},
|
|
9130
|
-
{
|
|
9131
|
-
"value": "'_blank'",
|
|
9132
|
-
"computed": false
|
|
9133
|
-
},
|
|
9134
|
-
{
|
|
9135
|
-
"value": "'_parent'",
|
|
9136
|
-
"computed": false
|
|
9137
|
-
},
|
|
9138
|
-
{
|
|
9139
|
-
"value": "'_top'",
|
|
9140
|
-
"computed": false
|
|
9141
|
-
}
|
|
9142
|
-
],
|
|
9143
|
-
"required": false
|
|
9144
|
-
}
|
|
9145
|
-
}
|
|
9146
|
-
},
|
|
9147
|
-
"required": false,
|
|
9148
|
-
"description": "On Web if href is passed, React Native Web maps this object's props to\n`rel`, `target` and `download` attrs."
|
|
9149
|
-
},
|
|
9150
|
-
"variant": {
|
|
9151
|
-
"type": {
|
|
9152
|
-
"name": "objectOf",
|
|
9153
|
-
"value": {
|
|
9154
|
-
"name": "union",
|
|
9155
|
-
"value": [
|
|
9156
|
-
{
|
|
9157
|
-
"name": "string"
|
|
9158
|
-
},
|
|
9159
|
-
{
|
|
9160
|
-
"name": "number"
|
|
9161
|
-
},
|
|
9162
|
-
{
|
|
9163
|
-
"name": "bool"
|
|
9164
|
-
}
|
|
9165
|
-
]
|
|
9166
|
-
}
|
|
9167
|
-
},
|
|
9168
|
-
"required": false,
|
|
9169
|
-
"description": ""
|
|
9170
|
-
},
|
|
9171
|
-
"iconProps": {
|
|
9172
|
-
"type": {
|
|
9173
|
-
"name": "exact",
|
|
9174
|
-
"value": {
|
|
9175
|
-
"variant": {
|
|
9176
|
-
"name": "custom",
|
|
9177
|
-
"raw": "variantProp.propType",
|
|
9178
|
-
"required": false
|
|
9179
|
-
},
|
|
9180
|
-
"tokens": {
|
|
9181
|
-
"name": "custom",
|
|
9182
|
-
"raw": "getTokensPropType('Icon')",
|
|
9183
|
-
"required": false
|
|
9184
|
-
},
|
|
9185
|
-
"accessibilityLabel": {
|
|
9186
|
-
"name": "string",
|
|
9187
|
-
"description": "Descriptive label used in web SVG title tag for accessibility",
|
|
9188
|
-
"required": false
|
|
9189
|
-
},
|
|
9190
|
-
"scalesWithText": {
|
|
9191
|
-
"name": "bool",
|
|
9192
|
-
"description": "controls whether the icon size should be proportionate to any accessibility-related font scaling.",
|
|
9193
|
-
"required": false
|
|
9194
|
-
}
|
|
9195
|
-
}
|
|
9196
|
-
},
|
|
9197
|
-
"required": false,
|
|
9198
|
-
"description": "Optional variant that may be passed down to the link's icon if there is one"
|
|
9199
|
-
},
|
|
9200
|
-
"icon": {
|
|
9201
|
-
"type": {
|
|
9202
|
-
"name": "func"
|
|
9203
|
-
},
|
|
9204
|
-
"required": false,
|
|
9205
|
-
"description": "A function component for an SVG icon to render inside the link. Inherits size and color from\nthe link and any Typography the link is nested inside."
|
|
9206
|
-
}
|
|
9207
|
-
},
|
|
9208
|
-
"attributes": {
|
|
9209
|
-
"acceptsRNA11yProps": true
|
|
9210
|
-
}
|
|
9211
|
-
}
|
|
9212
|
-
},
|
|
9213
|
-
"TextButton": {
|
|
9214
|
-
"docs": {
|
|
9215
|
-
"description": "`TextButton` is a button that looks like a Link. It uses the same theming and variants as\nLink but has the accessibility role of a `Button`. It should be used for actions that\ntake place on the current page, or for navigation within an app.",
|
|
9216
|
-
"props": {
|
|
9217
|
-
"onPress": {
|
|
9218
|
-
"type": {
|
|
9219
|
-
"name": "func"
|
|
9220
|
-
},
|
|
9221
|
-
"required": true,
|
|
9222
|
-
"description": ""
|
|
9223
|
-
},
|
|
9224
|
-
"onPressIn": {
|
|
9225
|
-
"type": {
|
|
9226
|
-
"name": "func"
|
|
9227
|
-
},
|
|
9228
|
-
"required": false,
|
|
9229
|
-
"description": ""
|
|
9230
|
-
},
|
|
9231
|
-
"onPressOut": {
|
|
9232
|
-
"type": {
|
|
9233
|
-
"name": "func"
|
|
9234
|
-
},
|
|
9235
|
-
"required": false,
|
|
9236
|
-
"description": ""
|
|
9237
|
-
},
|
|
9238
|
-
"disabled": {
|
|
9239
|
-
"type": {
|
|
9240
|
-
"name": "bool"
|
|
9241
|
-
},
|
|
9242
|
-
"required": false,
|
|
9243
|
-
"description": ""
|
|
9244
|
-
},
|
|
9245
|
-
"href": {
|
|
9246
|
-
"type": {
|
|
9247
|
-
"name": "string"
|
|
9248
|
-
},
|
|
9249
|
-
"required": false,
|
|
9250
|
-
"description": ""
|
|
9251
|
-
},
|
|
9252
|
-
"hrefAttrs": {
|
|
9253
|
-
"type": {
|
|
9254
|
-
"name": "shape",
|
|
9255
|
-
"value": {
|
|
9256
|
-
"download": {
|
|
9257
|
-
"name": "string",
|
|
9258
|
-
"required": false
|
|
9259
|
-
},
|
|
9260
|
-
"rel": {
|
|
9261
|
-
"name": "string",
|
|
9262
|
-
"required": false
|
|
9263
|
-
},
|
|
9264
|
-
"target": {
|
|
9265
|
-
"name": "enum",
|
|
9266
|
-
"value": [
|
|
9267
|
-
{
|
|
9268
|
-
"value": "'_self'",
|
|
9269
|
-
"computed": false
|
|
9270
|
-
},
|
|
9271
|
-
{
|
|
9272
|
-
"value": "'_blank'",
|
|
9273
|
-
"computed": false
|
|
9274
|
-
},
|
|
9275
|
-
{
|
|
9276
|
-
"value": "'_parent'",
|
|
9277
|
-
"computed": false
|
|
9278
|
-
},
|
|
9279
|
-
{
|
|
9280
|
-
"value": "'_top'",
|
|
9281
|
-
"computed": false
|
|
9282
|
-
}
|
|
9283
|
-
],
|
|
9284
|
-
"required": false
|
|
9285
|
-
}
|
|
9286
|
-
}
|
|
9287
|
-
},
|
|
9288
|
-
"required": false,
|
|
9289
|
-
"description": "On Web if href is passed, React Native Web maps this object's props to\n`rel`, `target` and `download` attrs."
|
|
9290
|
-
},
|
|
9291
|
-
"tokens": {
|
|
9292
|
-
"type": {
|
|
9293
|
-
"name": "custom",
|
|
9294
|
-
"raw": {
|
|
9295
|
-
"color": "color",
|
|
9296
|
-
"textLine": "textLine",
|
|
9297
|
-
"textLineStyle": "textLineStyle",
|
|
9298
|
-
"outerBorderColor": "color",
|
|
9299
|
-
"outerBorderWidth": "border",
|
|
9300
|
-
"outerBorderGap": "size",
|
|
9301
|
-
"outerBorderOutline": "borderStyle",
|
|
9302
|
-
"borderRadius": "radius",
|
|
9303
|
-
"blockFontName": "fontName",
|
|
9304
|
-
"blockFontWeight": "fontWeight",
|
|
9305
|
-
"blockFontSize": "fontSize",
|
|
9306
|
-
"blockLineHeight": "lineHeight",
|
|
9307
|
-
"icon": "icon",
|
|
9308
|
-
"iconSize": "size",
|
|
9309
|
-
"iconSpace": "integer",
|
|
9310
|
-
"iconTranslateX": "size",
|
|
9311
|
-
"iconTranslateY": "size",
|
|
9312
|
-
"alignSelf": "flexAlign"
|
|
9313
|
-
}
|
|
9314
|
-
},
|
|
9315
|
-
"required": false,
|
|
9316
|
-
"description": ""
|
|
9317
|
-
},
|
|
9318
|
-
"variant": {
|
|
9319
|
-
"type": {
|
|
9320
|
-
"name": "objectOf",
|
|
9321
|
-
"value": {
|
|
9322
|
-
"name": "union",
|
|
9323
|
-
"value": [
|
|
9324
|
-
{
|
|
9325
|
-
"name": "string"
|
|
9326
|
-
},
|
|
9327
|
-
{
|
|
9328
|
-
"name": "number"
|
|
9329
|
-
},
|
|
9330
|
-
{
|
|
9331
|
-
"name": "bool"
|
|
9332
|
-
}
|
|
9333
|
-
]
|
|
9334
|
-
}
|
|
9335
|
-
},
|
|
9336
|
-
"required": false,
|
|
9337
|
-
"description": ""
|
|
9338
|
-
},
|
|
9339
|
-
"iconProps": {
|
|
9340
|
-
"type": {
|
|
9341
|
-
"name": "exact",
|
|
9342
|
-
"value": {
|
|
9343
|
-
"variant": {
|
|
9344
|
-
"name": "custom",
|
|
9345
|
-
"raw": "variantProp.propType",
|
|
9346
|
-
"required": false
|
|
9347
|
-
},
|
|
9348
|
-
"tokens": {
|
|
9349
|
-
"name": "custom",
|
|
9350
|
-
"raw": "getTokensPropType('Icon')",
|
|
9351
|
-
"required": false
|
|
9352
|
-
},
|
|
9353
|
-
"accessibilityLabel": {
|
|
9354
|
-
"name": "string",
|
|
9355
|
-
"description": "Descriptive label used in web SVG title tag for accessibility",
|
|
9356
|
-
"required": false
|
|
9357
|
-
},
|
|
9358
|
-
"scalesWithText": {
|
|
9359
|
-
"name": "bool",
|
|
9360
|
-
"description": "controls whether the icon size should be proportionate to any accessibility-related font scaling.",
|
|
9361
|
-
"required": false
|
|
9362
|
-
}
|
|
9363
|
-
}
|
|
9364
|
-
},
|
|
9365
|
-
"required": false,
|
|
9366
|
-
"description": "Optional variant that may be passed down to the link's icon if there is one"
|
|
9367
|
-
},
|
|
9368
|
-
"icon": {
|
|
9369
|
-
"type": {
|
|
9370
|
-
"name": "func"
|
|
9371
|
-
},
|
|
9372
|
-
"required": false,
|
|
9373
|
-
"description": "A function component for an SVG icon to render inside the link. Inherits size and color from\nthe link and any Typography the link is nested inside."
|
|
9374
|
-
},
|
|
9375
|
-
"iconPosition": {
|
|
9376
|
-
"type": {
|
|
9377
|
-
"name": "enum",
|
|
9378
|
-
"value": [
|
|
9379
|
-
{
|
|
9380
|
-
"value": "'left'",
|
|
9381
|
-
"computed": false
|
|
9382
|
-
},
|
|
9383
|
-
{
|
|
9384
|
-
"value": "'right'",
|
|
9385
|
-
"computed": false
|
|
9386
|
-
}
|
|
9387
|
-
]
|
|
9388
|
-
},
|
|
9389
|
-
"required": false,
|
|
9390
|
-
"description": "When `icon` is provided, use `iconPosition` to place the Icon to the left or right side of Link."
|
|
9391
|
-
}
|
|
9392
|
-
},
|
|
9393
|
-
"attributes": {
|
|
9394
|
-
"acceptsRNA11yProps": true
|
|
9395
|
-
}
|
|
9396
|
-
}
|
|
9397
|
-
},
|
|
9398
|
-
"RadioGroup": {
|
|
9399
|
-
"docs": {
|
|
9400
|
-
"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 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\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```",
|
|
9401
|
-
"props": {
|
|
9402
|
-
"items": {
|
|
9403
|
-
"defaultValue": {
|
|
9404
|
-
"value": "[]",
|
|
8707
|
+
"value": "[]",
|
|
9405
8708
|
"computed": false
|
|
9406
8709
|
},
|
|
9407
8710
|
"type": {
|
|
@@ -9803,59 +9106,6 @@
|
|
|
9803
9106
|
"docs": {
|
|
9804
9107
|
"description": "StackWrap is an alternative to StackView where the spaced items are allowed to wrap.\n\nAs well as providing space between the items, StackWrap provides `gap` space between\nwrapped lines of items. By default, this `gap` is the same as the gap between spaced items.\nIf a different spacing is desired between wrapped lines, pass a spacing value to the `gap` prop.",
|
|
9805
9108
|
"props": {
|
|
9806
|
-
"pointerEvents": {
|
|
9807
|
-
"type": {
|
|
9808
|
-
"name": "enum",
|
|
9809
|
-
"value": [
|
|
9810
|
-
{
|
|
9811
|
-
"value": "'all'",
|
|
9812
|
-
"computed": false
|
|
9813
|
-
},
|
|
9814
|
-
{
|
|
9815
|
-
"value": "'none'",
|
|
9816
|
-
"computed": false
|
|
9817
|
-
},
|
|
9818
|
-
{
|
|
9819
|
-
"value": "'box-only'",
|
|
9820
|
-
"computed": false
|
|
9821
|
-
},
|
|
9822
|
-
{
|
|
9823
|
-
"value": "'box-none'",
|
|
9824
|
-
"computed": false
|
|
9825
|
-
}
|
|
9826
|
-
]
|
|
9827
|
-
},
|
|
9828
|
-
"required": false,
|
|
9829
|
-
"description": ""
|
|
9830
|
-
},
|
|
9831
|
-
"onLayout": {
|
|
9832
|
-
"type": {
|
|
9833
|
-
"name": "func"
|
|
9834
|
-
},
|
|
9835
|
-
"required": false,
|
|
9836
|
-
"description": ""
|
|
9837
|
-
},
|
|
9838
|
-
"nativeID": {
|
|
9839
|
-
"type": {
|
|
9840
|
-
"name": "string"
|
|
9841
|
-
},
|
|
9842
|
-
"required": false,
|
|
9843
|
-
"description": ""
|
|
9844
|
-
},
|
|
9845
|
-
"testID": {
|
|
9846
|
-
"type": {
|
|
9847
|
-
"name": "string"
|
|
9848
|
-
},
|
|
9849
|
-
"required": false,
|
|
9850
|
-
"description": ""
|
|
9851
|
-
},
|
|
9852
|
-
"dataSet": {
|
|
9853
|
-
"type": {
|
|
9854
|
-
"name": "object"
|
|
9855
|
-
},
|
|
9856
|
-
"required": false,
|
|
9857
|
-
"description": ""
|
|
9858
|
-
},
|
|
9859
9109
|
"tokens": {
|
|
9860
9110
|
"type": {
|
|
9861
9111
|
"name": "custom",
|
|
@@ -9994,14 +9244,112 @@
|
|
|
9994
9244
|
]
|
|
9995
9245
|
},
|
|
9996
9246
|
"required": false,
|
|
9997
|
-
"description": "Optional semantic HTML tag, to apply to the container on web. Does not change styling.\n\nIn native apps, if a header tag is provided (\"h1\", \"h2\" etc) and accessibilityRole prop\nis not defined, the accessibilityRole will default to \"heading\"."
|
|
9247
|
+
"description": "Optional semantic HTML tag, to apply to the container on web. Does not change styling.\n\nIn native apps, if a header tag is provided (\"h1\", \"h2\" etc) and accessibilityRole prop\nis not defined, the accessibilityRole will default to \"heading\"."
|
|
9248
|
+
},
|
|
9249
|
+
"children": {
|
|
9250
|
+
"type": {
|
|
9251
|
+
"name": "node"
|
|
9252
|
+
},
|
|
9253
|
+
"required": false,
|
|
9254
|
+
"description": "A StackWrap may take any children, but will have no effect if it is only passed one child or is passed children\nwrapped in a component. If necessary, children may be wrapped in one React Fragment."
|
|
9255
|
+
}
|
|
9256
|
+
},
|
|
9257
|
+
"attributes": {
|
|
9258
|
+
"acceptsRNA11yProps": false
|
|
9259
|
+
}
|
|
9260
|
+
}
|
|
9261
|
+
},
|
|
9262
|
+
"TextInput": {
|
|
9263
|
+
"docs": {
|
|
9264
|
+
"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.",
|
|
9265
|
+
"props": {
|
|
9266
|
+
"variant": {
|
|
9267
|
+
"defaultValue": {
|
|
9268
|
+
"value": "{}",
|
|
9269
|
+
"computed": false
|
|
9270
|
+
},
|
|
9271
|
+
"type": {
|
|
9272
|
+
"name": "objectOf",
|
|
9273
|
+
"value": {
|
|
9274
|
+
"name": "union",
|
|
9275
|
+
"value": [
|
|
9276
|
+
{
|
|
9277
|
+
"name": "string"
|
|
9278
|
+
},
|
|
9279
|
+
{
|
|
9280
|
+
"name": "number"
|
|
9281
|
+
},
|
|
9282
|
+
{
|
|
9283
|
+
"name": "bool"
|
|
9284
|
+
}
|
|
9285
|
+
]
|
|
9286
|
+
}
|
|
9287
|
+
},
|
|
9288
|
+
"required": false,
|
|
9289
|
+
"description": ""
|
|
9998
9290
|
},
|
|
9999
|
-
"
|
|
9291
|
+
"value": {
|
|
10000
9292
|
"type": {
|
|
10001
|
-
"name": "
|
|
9293
|
+
"name": "string"
|
|
10002
9294
|
},
|
|
10003
9295
|
"required": false,
|
|
10004
|
-
"description": "
|
|
9296
|
+
"description": "If the input's state is to be controlled by a parent component, use this prop\ntogether with the `onChange` to pass down and update the lifted state."
|
|
9297
|
+
},
|
|
9298
|
+
"initialValue": {
|
|
9299
|
+
"type": {
|
|
9300
|
+
"name": "string"
|
|
9301
|
+
},
|
|
9302
|
+
"required": false,
|
|
9303
|
+
"description": "Use this to set the initial value of an uncontrolled input.\nUpdating `initialValue` will **not** update the actual value."
|
|
9304
|
+
},
|
|
9305
|
+
"inactive": {
|
|
9306
|
+
"type": {
|
|
9307
|
+
"name": "bool"
|
|
9308
|
+
},
|
|
9309
|
+
"required": false,
|
|
9310
|
+
"description": "Disables all user interactions with the input."
|
|
9311
|
+
},
|
|
9312
|
+
"readOnly": {
|
|
9313
|
+
"type": {
|
|
9314
|
+
"name": "bool"
|
|
9315
|
+
},
|
|
9316
|
+
"required": false,
|
|
9317
|
+
"description": "Makes it impossible to change the input's value."
|
|
9318
|
+
},
|
|
9319
|
+
"onChange": {
|
|
9320
|
+
"type": {
|
|
9321
|
+
"name": "func"
|
|
9322
|
+
},
|
|
9323
|
+
"required": false,
|
|
9324
|
+
"description": "Use to react upon input's value changes. Required when the `value` prop is set.\nWill receive the input's value as an argument."
|
|
9325
|
+
},
|
|
9326
|
+
"tokens": {
|
|
9327
|
+
"type": {
|
|
9328
|
+
"name": "custom",
|
|
9329
|
+
"raw": {
|
|
9330
|
+
"backgroundColor": "color",
|
|
9331
|
+
"color": "color",
|
|
9332
|
+
"borderWidth": "border",
|
|
9333
|
+
"borderColor": "color",
|
|
9334
|
+
"borderRadius": "radius",
|
|
9335
|
+
"paddingTop": "size",
|
|
9336
|
+
"paddingBottom": "size",
|
|
9337
|
+
"paddingLeft": "size",
|
|
9338
|
+
"paddingRight": "size",
|
|
9339
|
+
"outerBackgroundColor": "color",
|
|
9340
|
+
"outerBorderWidth": "border",
|
|
9341
|
+
"outerBorderColor": "color",
|
|
9342
|
+
"fontName": "fontName",
|
|
9343
|
+
"fontWeight": "fontWeight",
|
|
9344
|
+
"fontSize": "fontSize",
|
|
9345
|
+
"lineHeight": "lineHeight",
|
|
9346
|
+
"icon": "icon",
|
|
9347
|
+
"iconSize": "size",
|
|
9348
|
+
"iconColor": "color"
|
|
9349
|
+
}
|
|
9350
|
+
},
|
|
9351
|
+
"required": false,
|
|
9352
|
+
"description": ""
|
|
10005
9353
|
}
|
|
10006
9354
|
},
|
|
10007
9355
|
"attributes": {
|
|
@@ -10009,9 +9357,9 @@
|
|
|
10009
9357
|
}
|
|
10010
9358
|
}
|
|
10011
9359
|
},
|
|
10012
|
-
"
|
|
9360
|
+
"TextArea": {
|
|
10013
9361
|
"docs": {
|
|
10014
|
-
"description": "
|
|
9362
|
+
"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.",
|
|
10015
9363
|
"props": {
|
|
10016
9364
|
"variant": {
|
|
10017
9365
|
"defaultValue": {
|
|
@@ -10038,146 +9386,281 @@
|
|
|
10038
9386
|
"required": false,
|
|
10039
9387
|
"description": ""
|
|
10040
9388
|
},
|
|
10041
|
-
"
|
|
9389
|
+
"value": {
|
|
10042
9390
|
"type": {
|
|
10043
9391
|
"name": "string"
|
|
10044
9392
|
},
|
|
10045
9393
|
"required": false,
|
|
10046
|
-
"description": "
|
|
9394
|
+
"description": "If the input's state is to be controlled by a parent component, use this prop\ntogether with the `onChange` to pass down and update the lifted state."
|
|
10047
9395
|
},
|
|
10048
|
-
"
|
|
9396
|
+
"initialValue": {
|
|
10049
9397
|
"type": {
|
|
10050
9398
|
"name": "string"
|
|
10051
9399
|
},
|
|
10052
9400
|
"required": false,
|
|
10053
|
-
"description": "
|
|
9401
|
+
"description": "Use this to set the initial value of an uncontrolled input.\nUpdating `initialValue` will **not** update the actual value."
|
|
10054
9402
|
},
|
|
10055
|
-
"
|
|
9403
|
+
"inactive": {
|
|
10056
9404
|
"type": {
|
|
10057
|
-
"name": "
|
|
10058
|
-
"value": [
|
|
10059
|
-
{
|
|
10060
|
-
"value": "'inline'",
|
|
10061
|
-
"computed": false
|
|
10062
|
-
},
|
|
10063
|
-
{
|
|
10064
|
-
"value": "'below'",
|
|
10065
|
-
"computed": false
|
|
10066
|
-
}
|
|
10067
|
-
]
|
|
9405
|
+
"name": "bool"
|
|
10068
9406
|
},
|
|
10069
9407
|
"required": false,
|
|
10070
|
-
"description": "
|
|
9408
|
+
"description": "Disables all user interactions with the input."
|
|
10071
9409
|
},
|
|
10072
|
-
"
|
|
9410
|
+
"readOnly": {
|
|
10073
9411
|
"type": {
|
|
10074
|
-
"name": "
|
|
9412
|
+
"name": "bool"
|
|
10075
9413
|
},
|
|
10076
9414
|
"required": false,
|
|
10077
|
-
"description": "
|
|
9415
|
+
"description": "Makes it impossible to change the input's value."
|
|
10078
9416
|
},
|
|
10079
|
-
"
|
|
9417
|
+
"onChange": {
|
|
10080
9418
|
"type": {
|
|
10081
|
-
"name": "
|
|
9419
|
+
"name": "func"
|
|
10082
9420
|
},
|
|
10083
9421
|
"required": false,
|
|
10084
|
-
"description": "
|
|
9422
|
+
"description": "Use to react upon input's value changes. Required when the `value` prop is set.\nWill receive the input's value as an argument."
|
|
10085
9423
|
},
|
|
10086
|
-
"
|
|
9424
|
+
"tokens": {
|
|
10087
9425
|
"type": {
|
|
10088
|
-
"name": "
|
|
10089
|
-
"
|
|
10090
|
-
{
|
|
10091
|
-
"value": "'error'",
|
|
10092
|
-
"computed": false
|
|
10093
|
-
},
|
|
10094
|
-
{
|
|
10095
|
-
"value": "'success'",
|
|
10096
|
-
"computed": false
|
|
10097
|
-
}
|
|
10098
|
-
]
|
|
9426
|
+
"name": "custom",
|
|
9427
|
+
"raw": "getTokensPropType('TextArea', 'TextInput')"
|
|
10099
9428
|
},
|
|
10100
9429
|
"required": false,
|
|
10101
|
-
"description": "
|
|
9430
|
+
"description": ""
|
|
9431
|
+
}
|
|
9432
|
+
},
|
|
9433
|
+
"attributes": {
|
|
9434
|
+
"acceptsRNA11yProps": false
|
|
9435
|
+
}
|
|
9436
|
+
}
|
|
9437
|
+
},
|
|
9438
|
+
"ToggleSwitch": {
|
|
9439
|
+
"docs": {
|
|
9440
|
+
"description": "",
|
|
9441
|
+
"props": {
|
|
9442
|
+
"accessibilityRole": {
|
|
9443
|
+
"defaultValue": {
|
|
9444
|
+
"value": "'switch'",
|
|
9445
|
+
"computed": false
|
|
9446
|
+
},
|
|
9447
|
+
"required": false
|
|
9448
|
+
},
|
|
9449
|
+
"accessibilityLabel": {
|
|
9450
|
+
"defaultValue": {
|
|
9451
|
+
"value": "label",
|
|
9452
|
+
"computed": true
|
|
9453
|
+
},
|
|
9454
|
+
"required": false
|
|
9455
|
+
},
|
|
9456
|
+
"tokens": {
|
|
9457
|
+
"type": {
|
|
9458
|
+
"name": "custom",
|
|
9459
|
+
"raw": {
|
|
9460
|
+
"borderColor": "color",
|
|
9461
|
+
"borderWidth": "border",
|
|
9462
|
+
"borderRadius": "radius",
|
|
9463
|
+
"outerBorderColor": "color",
|
|
9464
|
+
"outerBorderWidth": "border",
|
|
9465
|
+
"outerBorderGap": "size",
|
|
9466
|
+
"outerBackgroundColor": "color",
|
|
9467
|
+
"backgroundColor": "color",
|
|
9468
|
+
"opacity": "opacity",
|
|
9469
|
+
"paddingLeft": "size",
|
|
9470
|
+
"paddingRight": "size",
|
|
9471
|
+
"paddingTop": "size",
|
|
9472
|
+
"paddingBottom": "size",
|
|
9473
|
+
"shadow": "shadow",
|
|
9474
|
+
"alignSelf": "flexAlign",
|
|
9475
|
+
"icon": "icon",
|
|
9476
|
+
"width": "size",
|
|
9477
|
+
"trackBorderWidth": "border",
|
|
9478
|
+
"trackBorderColor": "color",
|
|
9479
|
+
"trackBorderRadius": "radius",
|
|
9480
|
+
"iconSize": "size",
|
|
9481
|
+
"iconColor": "color",
|
|
9482
|
+
"labelColor": "color",
|
|
9483
|
+
"labelFontName": "fontName",
|
|
9484
|
+
"labelFontSize": "fontSize",
|
|
9485
|
+
"labelFontWeight": "fontWeight",
|
|
9486
|
+
"labelLineHeight": "lineHeight",
|
|
9487
|
+
"labelMarginLeft": "size",
|
|
9488
|
+
"switchSize": "size",
|
|
9489
|
+
"switchColor": "color",
|
|
9490
|
+
"switchBorderColor": "color",
|
|
9491
|
+
"switchBorderWidth": "border",
|
|
9492
|
+
"switchBorderRadius": "radius",
|
|
9493
|
+
"switchShadow": "shadow"
|
|
9494
|
+
}
|
|
9495
|
+
},
|
|
9496
|
+
"required": false,
|
|
9497
|
+
"description": ""
|
|
9498
|
+
},
|
|
9499
|
+
"variant": {
|
|
9500
|
+
"type": {
|
|
9501
|
+
"name": "objectOf",
|
|
9502
|
+
"value": {
|
|
9503
|
+
"name": "union",
|
|
9504
|
+
"value": [
|
|
9505
|
+
{
|
|
9506
|
+
"name": "string"
|
|
9507
|
+
},
|
|
9508
|
+
{
|
|
9509
|
+
"name": "number"
|
|
9510
|
+
},
|
|
9511
|
+
{
|
|
9512
|
+
"name": "bool"
|
|
9513
|
+
}
|
|
9514
|
+
]
|
|
9515
|
+
}
|
|
9516
|
+
},
|
|
9517
|
+
"required": false,
|
|
9518
|
+
"description": ""
|
|
10102
9519
|
},
|
|
10103
9520
|
"value": {
|
|
10104
9521
|
"type": {
|
|
10105
|
-
"name": "
|
|
9522
|
+
"name": "bool"
|
|
10106
9523
|
},
|
|
10107
9524
|
"required": false,
|
|
10108
|
-
"description": "If
|
|
9525
|
+
"description": "If this is a \"controlled\" component and a parent handles its selected state,\ntells the switch if it is on (true) or off (false)."
|
|
10109
9526
|
},
|
|
10110
9527
|
"initialValue": {
|
|
9528
|
+
"type": {
|
|
9529
|
+
"name": "bool"
|
|
9530
|
+
},
|
|
9531
|
+
"required": false,
|
|
9532
|
+
"description": "If this is an \"uncontrolled\" component that handles its own selected state,\noptionally tells the switch if it should default to on (true) or off (false)."
|
|
9533
|
+
},
|
|
9534
|
+
"onChange": {
|
|
9535
|
+
"type": {
|
|
9536
|
+
"name": "func"
|
|
9537
|
+
},
|
|
9538
|
+
"required": false,
|
|
9539
|
+
"description": "Function called when the switch is toggled, with one boolean argument that is the\nnew position of the switch, on (true) or off (false). For \"controlled\" components,\nthis should always be passed and used to control the state of the switch."
|
|
9540
|
+
},
|
|
9541
|
+
"id": {
|
|
9542
|
+
"type": {
|
|
9543
|
+
"name": "string"
|
|
9544
|
+
},
|
|
9545
|
+
"required": false,
|
|
9546
|
+
"description": "Input ID."
|
|
9547
|
+
},
|
|
9548
|
+
"label": {
|
|
10111
9549
|
"type": {
|
|
10112
9550
|
"name": "string"
|
|
10113
9551
|
},
|
|
10114
9552
|
"required": false,
|
|
10115
|
-
"description": "
|
|
9553
|
+
"description": "An optional label."
|
|
10116
9554
|
},
|
|
10117
9555
|
"inactive": {
|
|
10118
9556
|
"type": {
|
|
10119
9557
|
"name": "bool"
|
|
10120
9558
|
},
|
|
10121
9559
|
"required": false,
|
|
10122
|
-
"description": "
|
|
9560
|
+
"description": "If passed, the switch does not respond to user input and may recieve different\ntheme tokens if the theme supports inactive appearance."
|
|
10123
9561
|
},
|
|
10124
|
-
"
|
|
9562
|
+
"tooltip": {
|
|
10125
9563
|
"type": {
|
|
10126
|
-
"name": "
|
|
9564
|
+
"name": "string"
|
|
10127
9565
|
},
|
|
10128
9566
|
"required": false,
|
|
10129
|
-
"description": "
|
|
9567
|
+
"description": "Content of an optional Tooltip. If set, a tooltip button will be shown next to the label."
|
|
9568
|
+
}
|
|
9569
|
+
},
|
|
9570
|
+
"attributes": {
|
|
9571
|
+
"acceptsRNA11yProps": false
|
|
9572
|
+
}
|
|
9573
|
+
}
|
|
9574
|
+
},
|
|
9575
|
+
"ToggleSwitchGroup": {
|
|
9576
|
+
"docs": {
|
|
9577
|
+
"description": "",
|
|
9578
|
+
"props": {
|
|
9579
|
+
"items": {
|
|
9580
|
+
"defaultValue": {
|
|
9581
|
+
"value": "[]",
|
|
9582
|
+
"computed": false
|
|
9583
|
+
},
|
|
9584
|
+
"type": {
|
|
9585
|
+
"name": "arrayOf",
|
|
9586
|
+
"value": {
|
|
9587
|
+
"name": "shape",
|
|
9588
|
+
"value": {
|
|
9589
|
+
"label": {
|
|
9590
|
+
"name": "string",
|
|
9591
|
+
"description": "The text displayed to the user on the label.",
|
|
9592
|
+
"required": true
|
|
9593
|
+
},
|
|
9594
|
+
"accessibilityLabel": {
|
|
9595
|
+
"name": "string",
|
|
9596
|
+
"description": "An optional accessibility label may be passed to each ToggleSwitch\nand will be applied as normal for a React Native accessibilityLabel prop.",
|
|
9597
|
+
"required": false
|
|
9598
|
+
},
|
|
9599
|
+
"id": {
|
|
9600
|
+
"name": "string",
|
|
9601
|
+
"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.",
|
|
9602
|
+
"required": false
|
|
9603
|
+
},
|
|
9604
|
+
"ref": {
|
|
9605
|
+
"name": "custom",
|
|
9606
|
+
"raw": "ABBPropTypes.ref()",
|
|
9607
|
+
"description": "An optional ref for one individual ToggleSwitch in the ToggleSwitchGroup",
|
|
9608
|
+
"required": false
|
|
9609
|
+
}
|
|
9610
|
+
}
|
|
9611
|
+
}
|
|
9612
|
+
},
|
|
9613
|
+
"required": false,
|
|
9614
|
+
"description": "The options a user may select"
|
|
10130
9615
|
},
|
|
10131
|
-
"
|
|
9616
|
+
"maxValues": {
|
|
9617
|
+
"defaultValue": {
|
|
9618
|
+
"value": "1",
|
|
9619
|
+
"computed": false
|
|
9620
|
+
},
|
|
10132
9621
|
"type": {
|
|
10133
|
-
"name": "
|
|
9622
|
+
"name": "number"
|
|
10134
9623
|
},
|
|
10135
9624
|
"required": false,
|
|
10136
|
-
"description": "
|
|
9625
|
+
"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`."
|
|
9626
|
+
},
|
|
9627
|
+
"readOnly": {
|
|
9628
|
+
"defaultValue": {
|
|
9629
|
+
"value": "false",
|
|
9630
|
+
"computed": false
|
|
9631
|
+
},
|
|
9632
|
+
"required": false
|
|
9633
|
+
},
|
|
9634
|
+
"inactive": {
|
|
9635
|
+
"defaultValue": {
|
|
9636
|
+
"value": "false",
|
|
9637
|
+
"computed": false
|
|
9638
|
+
},
|
|
9639
|
+
"required": false
|
|
9640
|
+
},
|
|
9641
|
+
"accessibilityRole": {
|
|
9642
|
+
"defaultValue": {
|
|
9643
|
+
"value": "maxValues === 1\n? 'radiogroup' // radiogroup is cross-platform; only web aria has generic groups\n: Platform.select({ web: 'group', default: 'none' })",
|
|
9644
|
+
"computed": false
|
|
9645
|
+
},
|
|
9646
|
+
"required": false
|
|
10137
9647
|
},
|
|
10138
9648
|
"tokens": {
|
|
10139
9649
|
"type": {
|
|
10140
9650
|
"name": "custom",
|
|
10141
9651
|
"raw": {
|
|
10142
|
-
"
|
|
10143
|
-
"
|
|
10144
|
-
"
|
|
10145
|
-
"
|
|
10146
|
-
"
|
|
10147
|
-
"
|
|
10148
|
-
"paddingBottom": "size",
|
|
10149
|
-
"paddingLeft": "size",
|
|
10150
|
-
"paddingRight": "size",
|
|
10151
|
-
"outerBackgroundColor": "color",
|
|
10152
|
-
"outerBorderWidth": "border",
|
|
10153
|
-
"outerBorderColor": "color",
|
|
10154
|
-
"fontName": "fontName",
|
|
10155
|
-
"fontWeight": "fontWeight",
|
|
10156
|
-
"fontSize": "fontSize",
|
|
10157
|
-
"lineHeight": "lineHeight",
|
|
10158
|
-
"icon": "icon",
|
|
10159
|
-
"iconSize": "size",
|
|
10160
|
-
"iconColor": "color"
|
|
9652
|
+
"space": "integer",
|
|
9653
|
+
"direction": "direction",
|
|
9654
|
+
"alignItems": "flexAlign",
|
|
9655
|
+
"justifyContent": "flexJustifyContent",
|
|
9656
|
+
"flexGrow": "integer",
|
|
9657
|
+
"flexShrink": "integer"
|
|
10161
9658
|
}
|
|
10162
9659
|
},
|
|
10163
9660
|
"required": false,
|
|
10164
9661
|
"description": ""
|
|
10165
|
-
}
|
|
10166
|
-
},
|
|
10167
|
-
"attributes": {
|
|
10168
|
-
"acceptsRNA11yProps": false
|
|
10169
|
-
}
|
|
10170
|
-
}
|
|
10171
|
-
},
|
|
10172
|
-
"TextArea": {
|
|
10173
|
-
"docs": {
|
|
10174
|
-
"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.",
|
|
10175
|
-
"props": {
|
|
9662
|
+
},
|
|
10176
9663
|
"variant": {
|
|
10177
|
-
"defaultValue": {
|
|
10178
|
-
"value": "{}",
|
|
10179
|
-
"computed": false
|
|
10180
|
-
},
|
|
10181
9664
|
"type": {
|
|
10182
9665
|
"name": "objectOf",
|
|
10183
9666
|
"value": {
|
|
@@ -10198,110 +9681,120 @@
|
|
|
10198
9681
|
"required": false,
|
|
10199
9682
|
"description": ""
|
|
10200
9683
|
},
|
|
10201
|
-
"
|
|
9684
|
+
"onChange": {
|
|
10202
9685
|
"type": {
|
|
10203
|
-
"name": "
|
|
9686
|
+
"name": "func"
|
|
10204
9687
|
},
|
|
10205
9688
|
"required": false,
|
|
10206
|
-
"description": "
|
|
9689
|
+
"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`."
|
|
10207
9690
|
},
|
|
10208
|
-
"
|
|
9691
|
+
"values": {
|
|
10209
9692
|
"type": {
|
|
10210
|
-
"name": "
|
|
9693
|
+
"name": "arrayOf",
|
|
9694
|
+
"value": {
|
|
9695
|
+
"name": "string"
|
|
9696
|
+
}
|
|
10211
9697
|
},
|
|
10212
9698
|
"required": false,
|
|
10213
|
-
"description": "
|
|
9699
|
+
"description": "If the selected item(s) in the toggle switch 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 ToggleSwitchGroup a \"controlled\" component that\nexpects its state to be handled via `onChange` and so doesn't handle it itself."
|
|
10214
9700
|
},
|
|
10215
|
-
"
|
|
9701
|
+
"initialValues": {
|
|
10216
9702
|
"type": {
|
|
10217
|
-
"name": "
|
|
10218
|
-
"value":
|
|
10219
|
-
|
|
10220
|
-
|
|
10221
|
-
"computed": false
|
|
10222
|
-
},
|
|
10223
|
-
{
|
|
10224
|
-
"value": "'below'",
|
|
10225
|
-
"computed": false
|
|
10226
|
-
}
|
|
10227
|
-
]
|
|
9703
|
+
"name": "arrayOf",
|
|
9704
|
+
"value": {
|
|
9705
|
+
"name": "string"
|
|
9706
|
+
}
|
|
10228
9707
|
},
|
|
10229
9708
|
"required": false,
|
|
10230
|
-
"description": "
|
|
9709
|
+
"description": "If `values` is not passed, making the ToggleSwitchGroup 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."
|
|
10231
9710
|
},
|
|
10232
|
-
"
|
|
9711
|
+
"hint": {
|
|
10233
9712
|
"type": {
|
|
10234
9713
|
"name": "string"
|
|
10235
9714
|
},
|
|
10236
9715
|
"required": false,
|
|
10237
|
-
"description": "
|
|
9716
|
+
"description": "Optional additional text giving more detail to help a user make a choice."
|
|
10238
9717
|
},
|
|
10239
9718
|
"tooltip": {
|
|
10240
9719
|
"type": {
|
|
10241
9720
|
"name": "string"
|
|
10242
9721
|
},
|
|
10243
9722
|
"required": false,
|
|
10244
|
-
"description": "
|
|
10245
|
-
},
|
|
10246
|
-
"validation": {
|
|
10247
|
-
"type": {
|
|
10248
|
-
"name": "enum",
|
|
10249
|
-
"value": [
|
|
10250
|
-
{
|
|
10251
|
-
"value": "'error'",
|
|
10252
|
-
"computed": false
|
|
10253
|
-
},
|
|
10254
|
-
{
|
|
10255
|
-
"value": "'success'",
|
|
10256
|
-
"computed": false
|
|
10257
|
-
}
|
|
10258
|
-
]
|
|
10259
|
-
},
|
|
10260
|
-
"required": false,
|
|
10261
|
-
"description": "Use to visually mark an input as valid or invalid."
|
|
9723
|
+
"description": "Optional tooltip text content to include alongside the legend and hint."
|
|
10262
9724
|
},
|
|
10263
|
-
"
|
|
9725
|
+
"feedback": {
|
|
10264
9726
|
"type": {
|
|
10265
9727
|
"name": "string"
|
|
10266
9728
|
},
|
|
10267
9729
|
"required": false,
|
|
10268
|
-
"description": "If
|
|
9730
|
+
"description": "If provided, a Feedback element is rendered containing this text."
|
|
10269
9731
|
},
|
|
10270
|
-
"
|
|
9732
|
+
"legend": {
|
|
10271
9733
|
"type": {
|
|
10272
9734
|
"name": "string"
|
|
10273
9735
|
},
|
|
10274
9736
|
"required": false,
|
|
10275
|
-
"description": "
|
|
10276
|
-
},
|
|
10277
|
-
"inactive": {
|
|
10278
|
-
"type": {
|
|
10279
|
-
"name": "bool"
|
|
10280
|
-
},
|
|
10281
|
-
"required": false,
|
|
10282
|
-
"description": "Disables all user interactions with the input."
|
|
10283
|
-
},
|
|
10284
|
-
"readOnly": {
|
|
10285
|
-
"type": {
|
|
10286
|
-
"name": "bool"
|
|
10287
|
-
},
|
|
10288
|
-
"required": false,
|
|
10289
|
-
"description": "Makes it impossible to change the input's value."
|
|
9737
|
+
"description": "Main text used to describe this group, used in Fieldset's Legend element."
|
|
10290
9738
|
},
|
|
10291
|
-
"
|
|
9739
|
+
"toggleSwitchTokens": {
|
|
10292
9740
|
"type": {
|
|
10293
|
-
"name": "
|
|
9741
|
+
"name": "custom",
|
|
9742
|
+
"raw": {
|
|
9743
|
+
"borderColor": "color",
|
|
9744
|
+
"borderWidth": "border",
|
|
9745
|
+
"borderRadius": "radius",
|
|
9746
|
+
"outerBorderColor": "color",
|
|
9747
|
+
"outerBorderWidth": "border",
|
|
9748
|
+
"outerBorderGap": "size",
|
|
9749
|
+
"outerBackgroundColor": "color",
|
|
9750
|
+
"backgroundColor": "color",
|
|
9751
|
+
"opacity": "opacity",
|
|
9752
|
+
"paddingLeft": "size",
|
|
9753
|
+
"paddingRight": "size",
|
|
9754
|
+
"paddingTop": "size",
|
|
9755
|
+
"paddingBottom": "size",
|
|
9756
|
+
"shadow": "shadow",
|
|
9757
|
+
"alignSelf": "flexAlign",
|
|
9758
|
+
"icon": "icon",
|
|
9759
|
+
"width": "size",
|
|
9760
|
+
"trackBorderWidth": "border",
|
|
9761
|
+
"trackBorderColor": "color",
|
|
9762
|
+
"trackBorderRadius": "radius",
|
|
9763
|
+
"iconSize": "size",
|
|
9764
|
+
"iconColor": "color",
|
|
9765
|
+
"labelColor": "color",
|
|
9766
|
+
"labelFontName": "fontName",
|
|
9767
|
+
"labelFontSize": "fontSize",
|
|
9768
|
+
"labelFontWeight": "fontWeight",
|
|
9769
|
+
"labelLineHeight": "lineHeight",
|
|
9770
|
+
"labelMarginLeft": "size",
|
|
9771
|
+
"switchSize": "size",
|
|
9772
|
+
"switchColor": "color",
|
|
9773
|
+
"switchBorderColor": "color",
|
|
9774
|
+
"switchBorderWidth": "border",
|
|
9775
|
+
"switchBorderRadius": "radius",
|
|
9776
|
+
"switchShadow": "shadow"
|
|
9777
|
+
}
|
|
10294
9778
|
},
|
|
10295
9779
|
"required": false,
|
|
10296
|
-
"description": "
|
|
9780
|
+
"description": "Toggle switch token overrides."
|
|
10297
9781
|
},
|
|
10298
|
-
"
|
|
9782
|
+
"validation": {
|
|
10299
9783
|
"type": {
|
|
10300
|
-
"name": "
|
|
10301
|
-
"
|
|
9784
|
+
"name": "enum",
|
|
9785
|
+
"value": [
|
|
9786
|
+
{
|
|
9787
|
+
"value": "'error'",
|
|
9788
|
+
"computed": false
|
|
9789
|
+
},
|
|
9790
|
+
{
|
|
9791
|
+
"value": "'success'",
|
|
9792
|
+
"computed": false
|
|
9793
|
+
}
|
|
9794
|
+
]
|
|
10302
9795
|
},
|
|
10303
9796
|
"required": false,
|
|
10304
|
-
"description": ""
|
|
9797
|
+
"description": "Current validation status of the group, passed to the feedback element if there is one."
|
|
10305
9798
|
}
|
|
10306
9799
|
},
|
|
10307
9800
|
"attributes": {
|