diff --git a/.changeset/moody-dolls-kneel.md b/.changeset/moody-dolls-kneel.md new file mode 100644 index 00000000000..4107d7374c5 --- /dev/null +++ b/.changeset/moody-dolls-kneel.md @@ -0,0 +1,6 @@ +--- +'@shopify/polaris': minor +'polaris.shopify.com': patch +--- + +Added support for responsive spacing on `Bleed` diff --git a/polaris-react/src/components/Bleed/Bleed.scss b/polaris-react/src/components/Bleed/Bleed.scss index 434f9efb5fc..19f29e2e432 100644 --- a/polaris-react/src/components/Bleed/Bleed.scss +++ b/polaris-react/src/components/Bleed/Bleed.scss @@ -1,8 +1,56 @@ @import '../../styles/common'; .Bleed { - margin-block-start: calc(-1 * var(--pc-bleed-margin-block-start)); - margin-block-end: calc(-1 * var(--pc-bleed-margin-block-end)); - margin-inline-start: calc(-1 * var(--pc-bleed-margin-inline-start)); - margin-inline-end: calc(-1 * var(--pc-bleed-margin-inline-end)); + --pc-bleed-margin-block-start-xs: initial; + --pc-bleed-margin-block-start-sm: var(--pc-bleed-margin-block-start-xs); + --pc-bleed-margin-block-start-md: var(--pc-bleed-margin-block-start-sm); + --pc-bleed-margin-block-start-lg: var(--pc-bleed-margin-block-start-md); + --pc-bleed-margin-block-start-xl: var(--pc-bleed-margin-block-start-lg); + --pc-bleed-margin-block-end-xs: initial; + --pc-bleed-margin-block-end-sm: var(--pc-bleed-margin-block-end-xs); + --pc-bleed-margin-block-end-md: var(--pc-bleed-margin-block-end-sm); + --pc-bleed-margin-block-end-lg: var(--pc-bleed-margin-block-end-md); + --pc-bleed-margin-block-end-xl: var(--pc-bleed-margin-block-end-lg); + --pc-bleed-margin-inline-start-xs: initial; + --pc-bleed-margin-inline-start-sm: var(--pc-bleed-margin-inline-start-xs); + --pc-bleed-margin-inline-start-md: var(--pc-bleed-margin-inline-start-sm); + --pc-bleed-margin-inline-start-lg: var(--pc-bleed-margin-inline-start-md); + --pc-bleed-margin-inline-start-xl: var(--pc-bleed-margin-inline-start-lg); + --pc-bleed-margin-inline-end-xs: initial; + --pc-bleed-margin-inline-end-sm: var(--pc-bleed-margin-inline-end-xs); + --pc-bleed-margin-inline-end-md: var(--pc-bleed-margin-inline-end-sm); + --pc-bleed-margin-inline-end-lg: var(--pc-bleed-margin-inline-end-md); + --pc-bleed-margin-inline-end-xl: var(--pc-bleed-margin-inline-end-lg); + margin-block-start: calc(-1 * var(--pc-bleed-margin-block-start-xs)); + margin-block-end: calc(-1 * var(--pc-bleed-margin-block-end-xs)); + margin-inline-start: calc(-1 * var(--pc-bleed-margin-inline-start-xs)); + margin-inline-end: calc(-1 * var(--pc-bleed-margin-inline-end-xs)); + + @media #{$p-breakpoints-sm-up} { + margin-block-start: calc(-1 * var(--pc-bleed-margin-block-start-sm)); + margin-block-end: calc(-1 * var(--pc-bleed-margin-block-end-sm)); + margin-inline-start: calc(-1 * var(--pc-bleed-margin-inline-start-sm)); + margin-inline-end: calc(-1 * var(--pc-bleed-margin-inline-end-sm)); + } + + @media #{$p-breakpoints-md-up} { + margin-block-start: calc(-1 * var(--pc-bleed-margin-block-start-md)); + margin-block-end: calc(-1 * var(--pc-bleed-margin-block-end-md)); + margin-inline-start: calc(-1 * var(--pc-bleed-margin-inline-start-md)); + margin-inline-end: calc(-1 * var(--pc-bleed-margin-inline-end-md)); + } + + @media #{$p-breakpoints-lg-up} { + margin-block-start: calc(-1 * var(--pc-bleed-margin-block-start-lg)); + margin-block-end: calc(-1 * var(--pc-bleed-margin-block-end-lg)); + margin-inline-start: calc(-1 * var(--pc-bleed-margin-inline-start-lg)); + margin-inline-end: calc(-1 * var(--pc-bleed-margin-inline-end-lg)); + } + + @media #{$p-breakpoints-xl-up} { + margin-block-start: calc(-1 * var(--pc-bleed-margin-block-start-xl)); + margin-block-end: calc(-1 * var(--pc-bleed-margin-block-end-xl)); + margin-inline-start: calc(-1 * var(--pc-bleed-margin-inline-start-xl)); + margin-inline-end: calc(-1 * var(--pc-bleed-margin-inline-end-xl)); + } } diff --git a/polaris-react/src/components/Bleed/Bleed.stories.tsx b/polaris-react/src/components/Bleed/Bleed.stories.tsx index f4af5585009..b2ddfd4e1f5 100644 --- a/polaris-react/src/components/Bleed/Bleed.stories.tsx +++ b/polaris-react/src/components/Bleed/Bleed.stories.tsx @@ -35,7 +35,7 @@ export function Default() { export function WithVerticalDirection() { return ( - +
@@ -45,7 +45,7 @@ export function WithVerticalDirection() { export function WithHorizontalDirection() { return ( - +
@@ -57,33 +57,33 @@ export function WithSpecificDirection() { return ( - Top + Block Start - +
- Bottom + Block End - +
- Left + Inline Start - +
- Right + Inline End - +
@@ -94,10 +94,24 @@ export function WithSpecificDirection() { export function WithAllDirection() { return ( - +
); } + +export function WithResponsiveHorizontalDirection() { + return ( + + +
+ + + ); +} diff --git a/polaris-react/src/components/Bleed/Bleed.tsx b/polaris-react/src/components/Bleed/Bleed.tsx index afa5af54148..c591f899970 100644 --- a/polaris-react/src/components/Bleed/Bleed.tsx +++ b/polaris-react/src/components/Bleed/Bleed.tsx @@ -1,26 +1,32 @@ import React from 'react'; import type {SpacingSpaceScale} from '@shopify/polaris-tokens'; -import {sanitizeCustomProperties} from '../../utilities/css'; +import { + getResponsiveProps, + sanitizeCustomProperties, +} from '../../utilities/css'; +import type {ResponsiveProp} from '../../utilities/css'; import styles from './Bleed.scss'; +type Spacing = ResponsiveProp; + export interface BleedProps { children?: React.ReactNode; /** Negative horizontal space around children * @default '5' */ - marginInline?: SpacingSpaceScale; + marginInline?: Spacing; /** Negative vertical space around children */ - marginBlock?: SpacingSpaceScale; + marginBlock?: Spacing; /** Negative top space around children */ - marginBlockStart?: SpacingSpaceScale; + marginBlockStart?: Spacing; /** Negative bottom space around children */ - marginBlockEnd?: SpacingSpaceScale; + marginBlockEnd?: Spacing; /** Negative left space around children */ - marginInlineStart?: SpacingSpaceScale; + marginInlineStart?: Spacing; /** Negative right space around children */ - marginInlineEnd?: SpacingSpaceScale; + marginInlineEnd?: Spacing; } export const Bleed = ({ @@ -36,7 +42,7 @@ export const Bleed = ({ const xAxis = ['marginInlineStart', 'marginInlineEnd']; const yAxis = ['marginBlockStart', 'marginBlockEnd']; - const directionValues: {[key: string]: string | undefined} = { + const directionValues: {[key: string]: Spacing | undefined} = { marginBlockStart, marginBlockEnd, marginInlineStart, @@ -60,18 +66,30 @@ export const Bleed = ({ const negativeMarginInlineEnd = getNegativeMargins('marginInlineEnd'); const style = { - '--pc-bleed-margin-block-start': negativeMarginBlockStart - ? `var(--p-space-${negativeMarginBlockStart})` - : undefined, - '--pc-bleed-margin-block-end': negativeMarginBlockEnd - ? `var(--p-space-${negativeMarginBlockEnd})` - : undefined, - '--pc-bleed-margin-inline-start': negativeMarginInlineStart - ? `var(--p-space-${negativeMarginInlineStart})` - : undefined, - '--pc-bleed-margin-inline-end': negativeMarginInlineEnd - ? `var(--p-space-${negativeMarginInlineEnd})` - : undefined, + ...getResponsiveProps( + 'bleed', + 'margin-block-start', + 'space', + negativeMarginBlockStart, + ), + ...getResponsiveProps( + 'bleed', + 'margin-block-end', + 'space', + negativeMarginBlockEnd, + ), + ...getResponsiveProps( + 'bleed', + 'margin-inline-start', + 'space', + negativeMarginInlineStart, + ), + ...getResponsiveProps( + 'bleed', + 'margin-inline-end', + 'space', + negativeMarginInlineEnd, + ), } as React.CSSProperties; return ( diff --git a/polaris-react/src/components/Bleed/tests/Bleed.test.tsx b/polaris-react/src/components/Bleed/tests/Bleed.test.tsx index d18206b705c..675563735cc 100644 --- a/polaris-react/src/components/Bleed/tests/Bleed.test.tsx +++ b/polaris-react/src/components/Bleed/tests/Bleed.test.tsx @@ -25,8 +25,8 @@ describe('', () => { expect(bleed).toContainReactComponent('div', { style: { - '--pc-bleed-margin-inline-start': 'var(--p-space-5)', - '--pc-bleed-margin-inline-end': 'var(--p-space-5)', + '--pc-bleed-margin-inline-start-xs': 'var(--p-space-5)', + '--pc-bleed-margin-inline-end-xs': 'var(--p-space-5)', } as React.CSSProperties, }); }); @@ -40,8 +40,8 @@ describe('', () => { expect(bleed).toContainReactComponent('div', { style: { - '--pc-bleed-margin-inline-start': 'var(--p-space-2)', - '--pc-bleed-margin-inline-end': 'var(--p-space-5)', + '--pc-bleed-margin-inline-start-xs': 'var(--p-space-2)', + '--pc-bleed-margin-inline-end-xs': 'var(--p-space-5)', } as React.CSSProperties, }); }); @@ -55,11 +55,26 @@ describe('', () => { expect(bleed).toContainReactComponent('div', { style: { - '--pc-bleed-margin-block-start': 'var(--p-space-1)', - '--pc-bleed-margin-block-end': 'var(--p-space-1)', - '--pc-bleed-margin-inline-start': 'var(--p-space-2)', - '--pc-bleed-margin-inline-end': 'var(--p-space-3)', + '--pc-bleed-margin-block-start-xs': 'var(--p-space-1)', + '--pc-bleed-margin-block-end-xs': 'var(--p-space-1)', + '--pc-bleed-margin-inline-start-xs': 'var(--p-space-2)', + '--pc-bleed-margin-inline-end-xs': 'var(--p-space-3)', } as React.CSSProperties, }); }); + + it('renders margin based on breakpoints', () => { + const bleed = mountWithApp( + + + , + ); + + expect(bleed).toContainReactComponent('div', { + style: expect.objectContaining({ + '--pc-bleed-margin-inline-start-xs': 'var(--p-space-2)', + '--pc-bleed-margin-inline-start-md': 'var(--p-space-8)', + }) as React.CSSProperties, + }); + }); }); diff --git a/polaris.shopify.com/src/data/props.json b/polaris.shopify.com/src/data/props.json index 64bb8536b3a..80b266de2f1 100644 --- a/polaris.shopify.com/src/data/props.json +++ b/polaris.shopify.com/src/data/props.json @@ -7789,6 +7789,13 @@ "value": "ResponsiveProp", "description": "" }, + "polaris-react/src/components/Bleed/Bleed.tsx": { + "filePath": "polaris-react/src/components/Bleed/Bleed.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Spacing", + "value": "ResponsiveProp", + "description": "" + }, "polaris-react/src/components/Box/Box.tsx": { "filePath": "polaris-react/src/components/Box/Box.tsx", "syntaxKind": "TypeAliasDeclaration", @@ -9730,7 +9737,7 @@ "filePath": "polaris-react/src/components/Bleed/Bleed.tsx", "syntaxKind": "PropertySignature", "name": "marginInline", - "value": "\"0\" | \"025\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", + "value": "Spacing", "description": "Negative horizontal space around children", "isOptional": true, "defaultValue": "'5'" @@ -9739,7 +9746,7 @@ "filePath": "polaris-react/src/components/Bleed/Bleed.tsx", "syntaxKind": "PropertySignature", "name": "marginBlock", - "value": "\"0\" | \"025\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", + "value": "Spacing", "description": "Negative vertical space around children", "isOptional": true }, @@ -9747,7 +9754,7 @@ "filePath": "polaris-react/src/components/Bleed/Bleed.tsx", "syntaxKind": "PropertySignature", "name": "marginBlockStart", - "value": "\"0\" | \"025\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", + "value": "Spacing", "description": "Negative top space around children", "isOptional": true }, @@ -9755,7 +9762,7 @@ "filePath": "polaris-react/src/components/Bleed/Bleed.tsx", "syntaxKind": "PropertySignature", "name": "marginBlockEnd", - "value": "\"0\" | \"025\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", + "value": "Spacing", "description": "Negative bottom space around children", "isOptional": true }, @@ -9763,7 +9770,7 @@ "filePath": "polaris-react/src/components/Bleed/Bleed.tsx", "syntaxKind": "PropertySignature", "name": "marginInlineStart", - "value": "\"0\" | \"025\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", + "value": "Spacing", "description": "Negative left space around children", "isOptional": true }, @@ -9771,12 +9778,12 @@ "filePath": "polaris-react/src/components/Bleed/Bleed.tsx", "syntaxKind": "PropertySignature", "name": "marginInlineEnd", - "value": "\"0\" | \"025\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", + "value": "Spacing", "description": "Negative right space around children", "isOptional": true } ], - "value": "export interface BleedProps {\n children?: React.ReactNode;\n /** Negative horizontal space around children\n * @default '5'\n */\n marginInline?: SpacingSpaceScale;\n /** Negative vertical space around children */\n marginBlock?: SpacingSpaceScale;\n /** Negative top space around children */\n marginBlockStart?: SpacingSpaceScale;\n /** Negative bottom space around children */\n marginBlockEnd?: SpacingSpaceScale;\n /** Negative left space around children */\n marginInlineStart?: SpacingSpaceScale;\n /** Negative right space around children */\n marginInlineEnd?: SpacingSpaceScale;\n}" + "value": "export interface BleedProps {\n children?: React.ReactNode;\n /** Negative horizontal space around children\n * @default '5'\n */\n marginInline?: Spacing;\n /** Negative vertical space around children */\n marginBlock?: Spacing;\n /** Negative top space around children */\n marginBlockStart?: Spacing;\n /** Negative bottom space around children */\n marginBlockEnd?: Spacing;\n /** Negative left space around children */\n marginInlineStart?: Spacing;\n /** Negative right space around children */\n marginInlineEnd?: Spacing;\n}" } }, "Overflow": { @@ -11827,6 +11834,40 @@ "value": "export interface ColumnsProps {\n children?: React.ReactNode;\n /** The number of columns to display\n * @default {xs: 6, sm: 6, md: 6, lg: 6, xl: 6}\n */\n columns?: Columns;\n /** The spacing between children. Accepts a spacing token or an object of spacing tokens for different screen sizes.\n * @default '4'\n * @example\n * gap='2'\n * gap={{xs: '1', sm: '2', md: '3', lg: '4', xl: '5'}}\n */\n gap?: Gap;\n}" } }, + "ConnectedProps": { + "polaris-react/src/components/Connected/Connected.tsx": { + "filePath": "polaris-react/src/components/Connected/Connected.tsx", + "name": "ConnectedProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Connected/Connected.tsx", + "syntaxKind": "PropertySignature", + "name": "left", + "value": "React.ReactNode", + "description": "Content to display on the left", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Connected/Connected.tsx", + "syntaxKind": "PropertySignature", + "name": "right", + "value": "React.ReactNode", + "description": "Content to display on the right", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Connected/Connected.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "Connected content", + "isOptional": true + } + ], + "value": "export interface ConnectedProps {\n /** Content to display on the left */\n left?: React.ReactNode;\n /** Content to display on the right */\n right?: React.ReactNode;\n /** Connected content */\n children?: React.ReactNode;\n}" + } + }, "ComboboxProps": { "polaris-react/src/components/Combobox/Combobox.tsx": { "filePath": "polaris-react/src/components/Combobox/Combobox.tsx", @@ -11900,40 +11941,6 @@ "value": "export interface ComboboxProps {\n /** The text field component to activate the Popover */\n activator: React.ReactElement;\n /** Allows more than one option to be selected */\n allowMultiple?: boolean;\n /** The content to display inside the popover */\n children?: React.ReactElement | null;\n /** The preferred direction to open the popover */\n preferredPosition?: PopoverProps['preferredPosition'];\n /** Whether or not more options are available to lazy load when the bottom of the listbox reached. Use the hasMoreResults boolean provided by the GraphQL API of the paginated data. */\n willLoadMoreOptions?: boolean;\n /** Height to set on the Popover Pane. */\n height?: string;\n /** Callback fired when the bottom of the lisbox is reached. Use to lazy load when listbox option data is paginated. */\n onScrolledToBottom?(): void;\n /** Callback fired when the popover closes */\n onClose?(): void;\n}" } }, - "ConnectedProps": { - "polaris-react/src/components/Connected/Connected.tsx": { - "filePath": "polaris-react/src/components/Connected/Connected.tsx", - "name": "ConnectedProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Connected/Connected.tsx", - "syntaxKind": "PropertySignature", - "name": "left", - "value": "React.ReactNode", - "description": "Content to display on the left", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Connected/Connected.tsx", - "syntaxKind": "PropertySignature", - "name": "right", - "value": "React.ReactNode", - "description": "Content to display on the right", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Connected/Connected.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "Connected content", - "isOptional": true - } - ], - "value": "export interface ConnectedProps {\n /** Content to display on the left */\n left?: React.ReactNode;\n /** Content to display on the right */\n right?: React.ReactNode;\n /** Connected content */\n children?: React.ReactNode;\n}" - } - }, "TableRow": { "polaris-react/src/components/DataTable/DataTable.tsx": { "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", @@ -13248,6 +13255,15 @@ "value": "export interface FocusProps {\n children?: React.ReactNode;\n disabled?: boolean;\n root: React.RefObject | HTMLElement | null;\n}" } }, + "Context": { + "polaris-react/src/components/FocusManager/FocusManager.tsx": { + "filePath": "polaris-react/src/components/FocusManager/FocusManager.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Context", + "value": "NonNullable>", + "description": "" + } + }, "FooterHelpProps": { "polaris-react/src/components/FooterHelp/FooterHelp.tsx": { "filePath": "polaris-react/src/components/FooterHelp/FooterHelp.tsx", @@ -13266,15 +13282,6 @@ "value": "export interface FooterHelpProps {\n /** The content to display inside the layout. */\n children?: React.ReactNode;\n}" } }, - "Context": { - "polaris-react/src/components/FocusManager/FocusManager.tsx": { - "filePath": "polaris-react/src/components/FocusManager/FocusManager.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Context", - "value": "NonNullable>", - "description": "" - } - }, "Enctype": { "polaris-react/src/components/Form/Form.tsx": { "filePath": "polaris-react/src/components/Form/Form.tsx", @@ -13425,31 +13432,6 @@ "value": "export interface FormLayoutProps {\n /** The content to display inside the layout. */\n children?: React.ReactNode;\n}" } }, - "FullscreenBarProps": { - "polaris-react/src/components/FullscreenBar/FullscreenBar.tsx": { - "filePath": "polaris-react/src/components/FullscreenBar/FullscreenBar.tsx", - "name": "FullscreenBarProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/FullscreenBar/FullscreenBar.tsx", - "syntaxKind": "PropertySignature", - "name": "onAction", - "value": "() => void", - "description": "Callback when back button is clicked" - }, - { - "filePath": "polaris-react/src/components/FullscreenBar/FullscreenBar.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "Render child elements", - "isOptional": true - } - ], - "value": "export interface FullscreenBarProps {\n /** Callback when back button is clicked */\n onAction: () => void;\n /** Render child elements */\n children?: React.ReactNode;\n}" - } - }, "FrameProps": { "polaris-react/src/components/Frame/Frame.tsx": { "filePath": "polaris-react/src/components/Frame/Frame.tsx", @@ -13533,6 +13515,31 @@ "value": "export interface FrameProps {\n /** Sets the logo for the TopBar, Navigation, and ContextualSaveBar components */\n logo?: Logo;\n /** A horizontal offset that pushes the frame to the right, leaving empty space on the left */\n offset?: string;\n /** The content to display inside the frame. */\n children?: React.ReactNode;\n /** Accepts a top bar component that will be rendered at the top-most portion of an application frame */\n topBar?: React.ReactNode;\n /** Accepts a navigation component that will be rendered in the left sidebar of an application frame */\n navigation?: React.ReactNode;\n /** Accepts a global ribbon component that will be rendered fixed to the bottom of an application frame */\n globalRibbon?: React.ReactNode;\n /** A boolean property indicating whether the mobile navigation is currently visible\n * @default false\n */\n showMobileNavigation?: boolean;\n /** Accepts a ref to the html anchor element you wish to focus when clicking the skip to content link */\n skipToContentTarget?: React.RefObject;\n /** A callback function to handle clicking the mobile navigation dismiss button */\n onNavigationDismiss?(): void;\n}" } }, + "FullscreenBarProps": { + "polaris-react/src/components/FullscreenBar/FullscreenBar.tsx": { + "filePath": "polaris-react/src/components/FullscreenBar/FullscreenBar.tsx", + "name": "FullscreenBarProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/FullscreenBar/FullscreenBar.tsx", + "syntaxKind": "PropertySignature", + "name": "onAction", + "value": "() => void", + "description": "Callback when back button is clicked" + }, + { + "filePath": "polaris-react/src/components/FullscreenBar/FullscreenBar.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "Render child elements", + "isOptional": true + } + ], + "value": "export interface FullscreenBarProps {\n /** Callback when back button is clicked */\n onAction: () => void;\n /** Render child elements */\n children?: React.ReactNode;\n}" + } + }, "Breakpoints": { "polaris-react/src/components/Grid/Grid.tsx": { "filePath": "polaris-react/src/components/Grid/Grid.tsx", @@ -13766,24 +13773,6 @@ "value": "export interface ImageProps extends React.HTMLProps {\n alt: string;\n source: string;\n crossOrigin?: CrossOrigin;\n sourceSet?: SourceSet[];\n onLoad?(): void;\n onError?(): void;\n}" } }, - "IndicatorProps": { - "polaris-react/src/components/Indicator/Indicator.tsx": { - "filePath": "polaris-react/src/components/Indicator/Indicator.tsx", - "name": "IndicatorProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Indicator/Indicator.tsx", - "syntaxKind": "PropertySignature", - "name": "pulse", - "value": "boolean", - "description": "", - "isOptional": true - } - ], - "value": "export interface IndicatorProps {\n pulse?: boolean;\n}" - } - }, "IndexTableHeadingBase": { "polaris-react/src/components/IndexTable/IndexTable.tsx": { "filePath": "polaris-react/src/components/IndexTable/IndexTable.tsx", @@ -14288,6 +14277,24 @@ "value": "export interface IndexTableProps\n extends IndexTableBaseProps,\n IndexProviderProps {}" } }, + "IndicatorProps": { + "polaris-react/src/components/Indicator/Indicator.tsx": { + "filePath": "polaris-react/src/components/Indicator/Indicator.tsx", + "name": "IndicatorProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Indicator/Indicator.tsx", + "syntaxKind": "PropertySignature", + "name": "pulse", + "value": "boolean", + "description": "", + "isOptional": true + } + ], + "value": "export interface IndicatorProps {\n pulse?: boolean;\n}" + } + }, "BlockAlign": { "polaris-react/src/components/Inline/Inline.tsx": { "filePath": "polaris-react/src/components/Inline/Inline.tsx", @@ -15773,52 +15780,191 @@ "value": "export interface PaginationProps {\n /** Keyboard shortcuts for the next button */\n nextKeys?: Key[];\n /** Keyboard shortcuts for the previous button */\n previousKeys?: Key[];\n /** Tooltip for the next button */\n nextTooltip?: string;\n /** Tooltip for the previous button */\n previousTooltip?: string;\n /** The URL of the next page */\n nextURL?: string;\n /** The URL of the previous page */\n previousURL?: string;\n /** Whether there is a next page to show */\n hasNext?: boolean;\n /** Whether there is a previous page to show */\n hasPrevious?: boolean;\n /** Accessible label for the pagination */\n accessibilityLabel?: string;\n /** Accessible labels for the buttons and UnstyledLinks */\n accessibilityLabels?: AccessibilityLabels;\n /** Callback when next button is clicked */\n onNext?(): void;\n /** Callback when previous button is clicked */\n onPrevious?(): void;\n /** Text to provide more context in between the arrow buttons */\n label?: React.ReactNode;\n}" } }, - "PopoverProps": { - "polaris-react/src/components/Popover/Popover.tsx": { - "filePath": "polaris-react/src/components/Popover/Popover.tsx", - "name": "PopoverProps", + "MediaQueryContextType": { + "polaris-react/src/components/PolarisTestProvider/PolarisTestProvider.tsx": { + "filePath": "polaris-react/src/components/PolarisTestProvider/PolarisTestProvider.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "MediaQueryContextType", + "value": "NonNullable<\n React.ContextType\n>", + "description": "" + }, + "polaris-react/src/utilities/media-query/context.tsx": { + "filePath": "polaris-react/src/utilities/media-query/context.tsx", + "name": "MediaQueryContextType", "description": "", "members": [ { - "filePath": "polaris-react/src/components/Popover/Popover.tsx", + "filePath": "polaris-react/src/utilities/media-query/context.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "The content to display inside the popover", - "isOptional": true - }, + "name": "isNavigationCollapsed", + "value": "boolean", + "description": "" + } + ], + "value": "export interface MediaQueryContextType {\n isNavigationCollapsed: boolean;\n}" + } + }, + "WithPolarisTestProviderOptions": { + "polaris-react/src/components/PolarisTestProvider/PolarisTestProvider.tsx": { + "filePath": "polaris-react/src/components/PolarisTestProvider/PolarisTestProvider.tsx", + "name": "WithPolarisTestProviderOptions", + "description": "When writing a custom mounting function `mountWithAppContext(node, options)`\nthis is the type of the options object. These values are customizable when\nyou call the app", + "members": [ { - "filePath": "polaris-react/src/components/Popover/Popover.tsx", + "filePath": "polaris-react/src/components/PolarisTestProvider/PolarisTestProvider.tsx", "syntaxKind": "PropertySignature", - "name": "preferredPosition", - "value": "PreferredPosition", - "description": "The preferred direction to open the popover", + "name": "i18n", + "value": "TranslationDictionary | TranslationDictionary[]", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Popover/Popover.tsx", + "filePath": "polaris-react/src/components/PolarisTestProvider/PolarisTestProvider.tsx", "syntaxKind": "PropertySignature", - "name": "preferredAlignment", - "value": "PreferredAlignment", - "description": "The preferred alignment of the popover relative to its activator", + "name": "link", + "value": "LinkLikeComponent", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Popover/Popover.tsx", + "filePath": "polaris-react/src/components/PolarisTestProvider/PolarisTestProvider.tsx", "syntaxKind": "PropertySignature", - "name": "active", - "value": "boolean", - "description": "Show or hide the Popover" + "name": "mediaQuery", + "value": "Partial", + "description": "", + "isOptional": true }, { - "filePath": "polaris-react/src/components/Popover/Popover.tsx", + "filePath": "polaris-react/src/components/PolarisTestProvider/PolarisTestProvider.tsx", "syntaxKind": "PropertySignature", - "name": "activator", - "value": "React.ReactElement", - "description": "The element to activate the Popover" + "name": "features", + "value": "FeaturesConfig", + "description": "", + "isOptional": true }, { - "filePath": "polaris-react/src/components/Popover/Popover.tsx", + "filePath": "polaris-react/src/components/PolarisTestProvider/PolarisTestProvider.tsx", + "syntaxKind": "PropertySignature", + "name": "frame", + "value": "Partial", + "description": "", + "isOptional": true + } + ], + "value": "export interface WithPolarisTestProviderOptions {\n // Contexts provided by AppProvider\n i18n?: ConstructorParameters[0];\n link?: LinkLikeComponent;\n mediaQuery?: Partial;\n features?: FeaturesConfig;\n // Contexts provided by Frame\n frame?: Partial;\n}" + } + }, + "PolarisTestProviderProps": { + "polaris-react/src/components/PolarisTestProvider/PolarisTestProvider.tsx": { + "filePath": "polaris-react/src/components/PolarisTestProvider/PolarisTestProvider.tsx", + "name": "PolarisTestProviderProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/PolarisTestProvider/PolarisTestProvider.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactElement", + "description": "" + }, + { + "filePath": "polaris-react/src/components/PolarisTestProvider/PolarisTestProvider.tsx", + "syntaxKind": "PropertySignature", + "name": "strict", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/PolarisTestProvider/PolarisTestProvider.tsx", + "syntaxKind": "PropertySignature", + "name": "i18n", + "value": "TranslationDictionary | TranslationDictionary[]", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/PolarisTestProvider/PolarisTestProvider.tsx", + "syntaxKind": "PropertySignature", + "name": "link", + "value": "LinkLikeComponent", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/PolarisTestProvider/PolarisTestProvider.tsx", + "syntaxKind": "PropertySignature", + "name": "mediaQuery", + "value": "Partial", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/PolarisTestProvider/PolarisTestProvider.tsx", + "syntaxKind": "PropertySignature", + "name": "features", + "value": "FeaturesConfig", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/PolarisTestProvider/PolarisTestProvider.tsx", + "syntaxKind": "PropertySignature", + "name": "frame", + "value": "Partial", + "description": "", + "isOptional": true + } + ], + "value": "export interface PolarisTestProviderProps\n extends WithPolarisTestProviderOptions {\n children: React.ReactElement;\n strict?: boolean;\n}" + } + }, + "PopoverProps": { + "polaris-react/src/components/Popover/Popover.tsx": { + "filePath": "polaris-react/src/components/Popover/Popover.tsx", + "name": "PopoverProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Popover/Popover.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "The content to display inside the popover", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Popover/Popover.tsx", + "syntaxKind": "PropertySignature", + "name": "preferredPosition", + "value": "PreferredPosition", + "description": "The preferred direction to open the popover", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Popover/Popover.tsx", + "syntaxKind": "PropertySignature", + "name": "preferredAlignment", + "value": "PreferredAlignment", + "description": "The preferred alignment of the popover relative to its activator", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Popover/Popover.tsx", + "syntaxKind": "PropertySignature", + "name": "active", + "value": "boolean", + "description": "Show or hide the Popover" + }, + { + "filePath": "polaris-react/src/components/Popover/Popover.tsx", + "syntaxKind": "PropertySignature", + "name": "activator", + "value": "React.ReactElement", + "description": "The element to activate the Popover" + }, + { + "filePath": "polaris-react/src/components/Popover/Popover.tsx", "syntaxKind": "PropertySignature", "name": "preferInputActivator", "value": "boolean", @@ -15961,145 +16107,6 @@ "value": "export interface PopoverPublicAPI {\n forceUpdatePosition(): void;\n}" } }, - "MediaQueryContextType": { - "polaris-react/src/components/PolarisTestProvider/PolarisTestProvider.tsx": { - "filePath": "polaris-react/src/components/PolarisTestProvider/PolarisTestProvider.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "MediaQueryContextType", - "value": "NonNullable<\n React.ContextType\n>", - "description": "" - }, - "polaris-react/src/utilities/media-query/context.tsx": { - "filePath": "polaris-react/src/utilities/media-query/context.tsx", - "name": "MediaQueryContextType", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/utilities/media-query/context.tsx", - "syntaxKind": "PropertySignature", - "name": "isNavigationCollapsed", - "value": "boolean", - "description": "" - } - ], - "value": "export interface MediaQueryContextType {\n isNavigationCollapsed: boolean;\n}" - } - }, - "WithPolarisTestProviderOptions": { - "polaris-react/src/components/PolarisTestProvider/PolarisTestProvider.tsx": { - "filePath": "polaris-react/src/components/PolarisTestProvider/PolarisTestProvider.tsx", - "name": "WithPolarisTestProviderOptions", - "description": "When writing a custom mounting function `mountWithAppContext(node, options)`\nthis is the type of the options object. These values are customizable when\nyou call the app", - "members": [ - { - "filePath": "polaris-react/src/components/PolarisTestProvider/PolarisTestProvider.tsx", - "syntaxKind": "PropertySignature", - "name": "i18n", - "value": "TranslationDictionary | TranslationDictionary[]", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/PolarisTestProvider/PolarisTestProvider.tsx", - "syntaxKind": "PropertySignature", - "name": "link", - "value": "LinkLikeComponent", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/PolarisTestProvider/PolarisTestProvider.tsx", - "syntaxKind": "PropertySignature", - "name": "mediaQuery", - "value": "Partial", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/PolarisTestProvider/PolarisTestProvider.tsx", - "syntaxKind": "PropertySignature", - "name": "features", - "value": "FeaturesConfig", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/PolarisTestProvider/PolarisTestProvider.tsx", - "syntaxKind": "PropertySignature", - "name": "frame", - "value": "Partial", - "description": "", - "isOptional": true - } - ], - "value": "export interface WithPolarisTestProviderOptions {\n // Contexts provided by AppProvider\n i18n?: ConstructorParameters[0];\n link?: LinkLikeComponent;\n mediaQuery?: Partial;\n features?: FeaturesConfig;\n // Contexts provided by Frame\n frame?: Partial;\n}" - } - }, - "PolarisTestProviderProps": { - "polaris-react/src/components/PolarisTestProvider/PolarisTestProvider.tsx": { - "filePath": "polaris-react/src/components/PolarisTestProvider/PolarisTestProvider.tsx", - "name": "PolarisTestProviderProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/PolarisTestProvider/PolarisTestProvider.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactElement", - "description": "" - }, - { - "filePath": "polaris-react/src/components/PolarisTestProvider/PolarisTestProvider.tsx", - "syntaxKind": "PropertySignature", - "name": "strict", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/PolarisTestProvider/PolarisTestProvider.tsx", - "syntaxKind": "PropertySignature", - "name": "i18n", - "value": "TranslationDictionary | TranslationDictionary[]", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/PolarisTestProvider/PolarisTestProvider.tsx", - "syntaxKind": "PropertySignature", - "name": "link", - "value": "LinkLikeComponent", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/PolarisTestProvider/PolarisTestProvider.tsx", - "syntaxKind": "PropertySignature", - "name": "mediaQuery", - "value": "Partial", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/PolarisTestProvider/PolarisTestProvider.tsx", - "syntaxKind": "PropertySignature", - "name": "features", - "value": "FeaturesConfig", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/PolarisTestProvider/PolarisTestProvider.tsx", - "syntaxKind": "PropertySignature", - "name": "frame", - "value": "Partial", - "description": "", - "isOptional": true - } - ], - "value": "export interface PolarisTestProviderProps\n extends WithPolarisTestProviderOptions {\n children: React.ReactElement;\n strict?: boolean;\n}" - } - }, "PortalProps": { "polaris-react/src/components/Portal/Portal.tsx": { "filePath": "polaris-react/src/components/Portal/Portal.tsx", @@ -17446,40 +17453,6 @@ "value": "export interface SelectProps {\n /** List of options or option groups to choose from */\n options?: (SelectOption | SelectGroup)[];\n /** Label for the select */\n label: React.ReactNode;\n /** Adds an action to the label */\n labelAction?: LabelledProps['action'];\n /** Visually hide the label */\n labelHidden?: boolean;\n /** Show the label to the left of the value, inside the control */\n labelInline?: boolean;\n /** Disable input */\n disabled?: boolean;\n /** Additional text to aide in use */\n helpText?: React.ReactNode;\n /** Example text to display as placeholder */\n placeholder?: string;\n /** ID for form input */\n id?: string;\n /** Name for form input */\n name?: string;\n /** Value for form input */\n value?: string;\n /** Display an error state */\n error?: Error | boolean;\n /** Callback when selection is changed */\n onChange?(selected: string, id: string): void;\n /** Callback when select is focused */\n onFocus?(): void;\n /** Callback when focus is removed */\n onBlur?(): void;\n /** Visual required indicator, add an asterisk to label */\n requiredIndicator?: boolean;\n}" } }, - "SettingToggleProps": { - "polaris-react/src/components/SettingToggle/SettingToggle.tsx": { - "filePath": "polaris-react/src/components/SettingToggle/SettingToggle.tsx", - "name": "SettingToggleProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/SettingToggle/SettingToggle.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "Inner content of the card", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/SettingToggle/SettingToggle.tsx", - "syntaxKind": "PropertySignature", - "name": "action", - "value": "ComplexAction", - "description": "Card header actions", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/SettingToggle/SettingToggle.tsx", - "syntaxKind": "PropertySignature", - "name": "enabled", - "value": "boolean", - "description": "Sets toggle state to activated or deactivated", - "isOptional": true - } - ], - "value": "export interface SettingToggleProps {\n /** Inner content of the card */\n children?: React.ReactNode;\n /** Card header actions */\n action?: ComplexAction;\n /** Sets toggle state to activated or deactivated */\n enabled?: boolean;\n}" - } - }, "SettingActionProps": { "polaris-react/src/components/SettingAction/SettingAction.tsx": { "filePath": "polaris-react/src/components/SettingAction/SettingAction.tsx", @@ -17506,23 +17479,38 @@ "value": "export interface SettingActionProps {\n action?: React.ReactNode;\n children?: React.ReactNode;\n}" } }, - "SkeletonBodyTextProps": { - "polaris-react/src/components/SkeletonBodyText/SkeletonBodyText.tsx": { - "filePath": "polaris-react/src/components/SkeletonBodyText/SkeletonBodyText.tsx", - "name": "SkeletonBodyTextProps", + "SettingToggleProps": { + "polaris-react/src/components/SettingToggle/SettingToggle.tsx": { + "filePath": "polaris-react/src/components/SettingToggle/SettingToggle.tsx", + "name": "SettingToggleProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/SkeletonBodyText/SkeletonBodyText.tsx", + "filePath": "polaris-react/src/components/SettingToggle/SettingToggle.tsx", "syntaxKind": "PropertySignature", - "name": "lines", - "value": "number", - "description": "Number of lines to display", - "isOptional": true, - "defaultValue": "3" + "name": "children", + "value": "React.ReactNode", + "description": "Inner content of the card", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/SettingToggle/SettingToggle.tsx", + "syntaxKind": "PropertySignature", + "name": "action", + "value": "ComplexAction", + "description": "Card header actions", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/SettingToggle/SettingToggle.tsx", + "syntaxKind": "PropertySignature", + "name": "enabled", + "value": "boolean", + "description": "Sets toggle state to activated or deactivated", + "isOptional": true } ], - "value": "export interface SkeletonBodyTextProps {\n /**\n * Number of lines to display\n * @default 3\n */\n lines?: number;\n}" + "value": "export interface SettingToggleProps {\n /** Inner content of the card */\n children?: React.ReactNode;\n /** Card header actions */\n action?: ComplexAction;\n /** Sets toggle state to activated or deactivated */\n enabled?: boolean;\n}" } }, "SheetProps": { @@ -17587,6 +17575,25 @@ "value": "export interface SheetProps {\n /** Whether or not the sheet is open */\n open: boolean;\n /** The child elements to render in the sheet */\n children: React.ReactNode;\n /** Callback when the backdrop is clicked or `ESC` is pressed */\n onClose(): void;\n /** Callback when the sheet has completed entering */\n onEntered?(): void;\n /** Callback when the sheet has started to exit */\n onExit?(): void;\n /** ARIA label for sheet */\n accessibilityLabel: string;\n /** The element or the RefObject that activates the Sheet */\n activator?: React.RefObject | React.ReactElement;\n}" } }, + "SkeletonBodyTextProps": { + "polaris-react/src/components/SkeletonBodyText/SkeletonBodyText.tsx": { + "filePath": "polaris-react/src/components/SkeletonBodyText/SkeletonBodyText.tsx", + "name": "SkeletonBodyTextProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/SkeletonBodyText/SkeletonBodyText.tsx", + "syntaxKind": "PropertySignature", + "name": "lines", + "value": "number", + "description": "Number of lines to display", + "isOptional": true, + "defaultValue": "3" + } + ], + "value": "export interface SkeletonBodyTextProps {\n /**\n * Number of lines to display\n * @default 3\n */\n lines?: number;\n}" + } + }, "SkeletonDisplayTextProps": { "polaris-react/src/components/SkeletonDisplayText/SkeletonDisplayText.tsx": { "filePath": "polaris-react/src/components/SkeletonDisplayText/SkeletonDisplayText.tsx", @@ -18043,7 +18050,33 @@ "isOptional": true } ], - "value": "export interface TextProps {\n /** Adjust horizontal alignment of text */\n alignment?: Alignment;\n /** The element type */\n as: Element;\n /** Prevent text from overflowing */\n breakWord?: boolean;\n /** Text to display */\n children: ReactNode;\n /** Adjust color of text */\n color?: Color;\n /** Adjust weight of text */\n fontWeight?: FontWeight;\n /** HTML id attribute */\n id?: string;\n /** Truncate text overflow with ellipsis */\n truncate?: boolean;\n /** Typographic style of text */\n variant: Variant;\n /** Visually hide the text */\n visuallyHidden?: boolean;\n}" + "value": "export interface TextProps {\n /** Adjust horizontal alignment of text */\n alignment?: Alignment;\n /** The element type */\n as: Element;\n /** Prevent text from overflowing */\n breakWord?: boolean;\n /** Text to display */\n children: ReactNode;\n /** Adjust color of text */\n color?: Color;\n /** Adjust weight of text */\n fontWeight?: FontWeight;\n /** HTML id attribute */\n id?: string;\n /** Truncate text overflow with ellipsis */\n truncate?: boolean;\n /** Typographic style of text */\n variant: Variant;\n /** Visually hide the text */\n visuallyHidden?: boolean;\n}" + } + }, + "TextContainerProps": { + "polaris-react/src/components/TextContainer/TextContainer.tsx": { + "filePath": "polaris-react/src/components/TextContainer/TextContainer.tsx", + "name": "TextContainerProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/TextContainer/TextContainer.tsx", + "syntaxKind": "PropertySignature", + "name": "spacing", + "value": "Spacing", + "description": "The amount of vertical spacing children will get between them", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/TextContainer/TextContainer.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "The content to render in the text container.", + "isOptional": true + } + ], + "value": "export interface TextContainerProps {\n /** The amount of vertical spacing children will get between them */\n spacing?: Spacing;\n /** The content to render in the text container. */\n children?: React.ReactNode;\n}" } }, "InputMode": { @@ -18171,32 +18204,6 @@ "description": "" } }, - "TextContainerProps": { - "polaris-react/src/components/TextContainer/TextContainer.tsx": { - "filePath": "polaris-react/src/components/TextContainer/TextContainer.tsx", - "name": "TextContainerProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/TextContainer/TextContainer.tsx", - "syntaxKind": "PropertySignature", - "name": "spacing", - "value": "Spacing", - "description": "The amount of vertical spacing children will get between them", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/TextContainer/TextContainer.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "The content to render in the text container.", - "isOptional": true - } - ], - "value": "export interface TextContainerProps {\n /** The amount of vertical spacing children will get between them */\n spacing?: Spacing;\n /** The content to render in the text container. */\n children?: React.ReactNode;\n}" - } - }, "Variation": { "polaris-react/src/components/TextStyle/TextStyle.tsx": { "filePath": "polaris-react/src/components/TextStyle/TextStyle.tsx", @@ -23340,6 +23347,40 @@ "description": "" } }, + "CardHeaderProps": { + "polaris-react/src/components/Card/components/Header/Header.tsx": { + "filePath": "polaris-react/src/components/Card/components/Header/Header.tsx", + "name": "CardHeaderProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Card/components/Header/Header.tsx", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "React.ReactNode", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Card/components/Header/Header.tsx", + "syntaxKind": "PropertySignature", + "name": "actions", + "value": "DisableableAction[]", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Card/components/Header/Header.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "", + "isOptional": true + } + ], + "value": "export interface CardHeaderProps {\n title?: React.ReactNode;\n actions?: DisableableAction[];\n children?: React.ReactNode;\n}" + } + }, "BulkActionsMenuProps": { "polaris-react/src/components/BulkActions/components/BulkActionMenu/BulkActionMenu.tsx": { "filePath": "polaris-react/src/components/BulkActions/components/BulkActionMenu/BulkActionMenu.tsx", @@ -23427,40 +23468,6 @@ "value": "export interface BulkActionsMenuProps extends MenuGroupDescriptor {\n isNewBadgeInBadgeActions: boolean;\n}" } }, - "CardHeaderProps": { - "polaris-react/src/components/Card/components/Header/Header.tsx": { - "filePath": "polaris-react/src/components/Card/components/Header/Header.tsx", - "name": "CardHeaderProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Card/components/Header/Header.tsx", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "React.ReactNode", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Card/components/Header/Header.tsx", - "syntaxKind": "PropertySignature", - "name": "actions", - "value": "DisableableAction[]", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Card/components/Header/Header.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", - "isOptional": true - } - ], - "value": "export interface CardHeaderProps {\n title?: React.ReactNode;\n actions?: DisableableAction[];\n children?: React.ReactNode;\n}" - } - }, "CardSectionProps": { "polaris-react/src/components/Card/components/Section/Section.tsx": { "filePath": "polaris-react/src/components/Card/components/Section/Section.tsx", @@ -24541,23 +24548,6 @@ "description": "" } }, - "ToastManagerProps": { - "polaris-react/src/components/Frame/components/ToastManager/ToastManager.tsx": { - "filePath": "polaris-react/src/components/Frame/components/ToastManager/ToastManager.tsx", - "name": "ToastManagerProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Frame/components/ToastManager/ToastManager.tsx", - "syntaxKind": "PropertySignature", - "name": "toastMessages", - "value": "ToastPropsWithID[]", - "description": "" - } - ], - "value": "export interface ToastManagerProps {\n toastMessages: ToastPropsWithID[];\n}" - } - }, "CheckboxWrapperProps": { "polaris-react/src/components/IndexTable/components/Checkbox/Checkbox.tsx": { "filePath": "polaris-react/src/components/IndexTable/components/Checkbox/Checkbox.tsx", @@ -24672,6 +24662,23 @@ "value": "export interface RowProps {\n children: React.ReactNode;\n id: string;\n selected?: boolean;\n position: number;\n subdued?: boolean;\n status?: RowStatus;\n disabled?: boolean;\n onNavigation?(id: string): void;\n onClick?(): void;\n}" } }, + "ToastManagerProps": { + "polaris-react/src/components/Frame/components/ToastManager/ToastManager.tsx": { + "filePath": "polaris-react/src/components/Frame/components/ToastManager/ToastManager.tsx", + "name": "ToastManagerProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Frame/components/ToastManager/ToastManager.tsx", + "syntaxKind": "PropertySignature", + "name": "toastMessages", + "value": "ToastPropsWithID[]", + "description": "" + } + ], + "value": "export interface ToastManagerProps {\n toastMessages: ToastPropsWithID[];\n}" + } + }, "ScrollContainerProps": { "polaris-react/src/components/IndexTable/components/ScrollContainer/ScrollContainer.tsx": { "filePath": "polaris-react/src/components/IndexTable/components/ScrollContainer/ScrollContainer.tsx", @@ -25180,6 +25187,39 @@ "value": "export interface TextOptionProps {\n children: React.ReactNode;\n // Whether the option is selected\n selected?: boolean;\n // Whether the option is disabled\n disabled?: boolean;\n}" } }, + "CloseButtonProps": { + "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx": { + "filePath": "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx", + "name": "CloseButtonProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx", + "syntaxKind": "PropertySignature", + "name": "pressed", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx", + "syntaxKind": "PropertySignature", + "name": "titleHidden", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx", + "syntaxKind": "MethodSignature", + "name": "onClick", + "value": "() => void", + "description": "" + } + ], + "value": "export interface CloseButtonProps {\n pressed?: boolean;\n titleHidden?: boolean;\n onClick(): void;\n}" + } + }, "DialogProps": { "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx": { "filePath": "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx", @@ -25285,39 +25325,6 @@ "value": "export interface DialogProps {\n labelledBy?: string;\n instant?: boolean;\n children?: React.ReactNode;\n limitHeight?: boolean;\n large?: boolean;\n small?: boolean;\n onClose(): void;\n onEntered?(): void;\n onExited?(): void;\n in?: boolean;\n fullScreen?: boolean;\n setClosing?: Dispatch>;\n}" } }, - "CloseButtonProps": { - "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx": { - "filePath": "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx", - "name": "CloseButtonProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx", - "syntaxKind": "PropertySignature", - "name": "pressed", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx", - "syntaxKind": "PropertySignature", - "name": "titleHidden", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx", - "syntaxKind": "MethodSignature", - "name": "onClick", - "value": "() => void", - "description": "" - } - ], - "value": "export interface CloseButtonProps {\n pressed?: boolean;\n titleHidden?: boolean;\n onClick(): void;\n}" - } - }, "FooterProps": { "polaris-react/src/components/Modal/components/Footer/Footer.tsx": { "filePath": "polaris-react/src/components/Modal/components/Footer/Footer.tsx", @@ -25615,103 +25622,44 @@ "filePath": "polaris-react/src/components/Page/components/Header/Header.tsx", "syntaxKind": "MethodSignature", "name": "onTouchStart", - "value": "() => void", - "description": "Callback when element is touched", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Page/components/Header/Header.tsx", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "Whether or not the action is disabled", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Page/components/Header/Header.tsx", - "syntaxKind": "PropertySignature", - "name": "loading", - "value": "boolean", - "description": "Should a spinner be displayed", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Page/components/Header/Header.tsx", - "syntaxKind": "PropertySignature", - "name": "icon", - "value": "any", - "description": "Source of the icon", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Page/components/Header/Header.tsx", - "syntaxKind": "PropertySignature", - "name": "helpText", - "value": "React.ReactNode", - "description": "Text content to render in a tooltip", - "isOptional": true - } - ], - "value": "interface PrimaryAction\n extends DestructableAction,\n DisableableAction,\n LoadableAction,\n IconableAction,\n TooltipAction {\n /** Provides extra visual weight and identifies the primary action in a set of buttons */\n primary?: boolean;\n}" - } - }, - "PaneProps": { - "polaris-react/src/components/Popover/components/Pane/Pane.tsx": { - "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", - "name": "PaneProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", - "syntaxKind": "PropertySignature", - "name": "fixed", - "value": "boolean", - "description": "Fix the pane to the top of the popover", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", - "syntaxKind": "PropertySignature", - "name": "sectioned", - "value": "boolean", - "description": "Automatically wrap children in padded sections", + "value": "() => void", + "description": "Callback when element is touched", "isOptional": true }, { - "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", + "filePath": "polaris-react/src/components/Page/components/Header/Header.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "The pane content", + "name": "disabled", + "value": "boolean", + "description": "Whether or not the action is disabled", "isOptional": true }, { - "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", + "filePath": "polaris-react/src/components/Page/components/Header/Header.tsx", "syntaxKind": "PropertySignature", - "name": "height", - "value": "string", - "description": "Sets a fixed height and max-height on the Scrollable", + "name": "loading", + "value": "boolean", + "description": "Should a spinner be displayed", "isOptional": true }, { - "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", - "syntaxKind": "MethodSignature", - "name": "onScrolledToBottom", - "value": "() => void", - "description": "Callback when the bottom of the popover is reached by mouse or keyboard", + "filePath": "polaris-react/src/components/Page/components/Header/Header.tsx", + "syntaxKind": "PropertySignature", + "name": "icon", + "value": "any", + "description": "Source of the icon", "isOptional": true }, { - "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", + "filePath": "polaris-react/src/components/Page/components/Header/Header.tsx", "syntaxKind": "PropertySignature", - "name": "captureOverscroll", - "value": "boolean", - "description": "Prevents page scrolling when the end of the scrollable Popover content is reached", - "isOptional": true, - "defaultValue": "false" + "name": "helpText", + "value": "React.ReactNode", + "description": "Text content to render in a tooltip", + "isOptional": true } ], - "value": "export interface PaneProps {\n /** Fix the pane to the top of the popover */\n fixed?: boolean;\n /** Automatically wrap children in padded sections */\n sectioned?: boolean;\n /** The pane content */\n children?: React.ReactNode;\n /** Sets a fixed height and max-height on the Scrollable */\n height?: string;\n /** Callback when the bottom of the popover is reached by mouse or keyboard */\n onScrolledToBottom?(): void;\n /**\n * Prevents page scrolling when the end of the scrollable Popover content is reached\n * @default false\n */\n captureOverscroll?: boolean;\n}" + "value": "interface PrimaryAction\n extends DestructableAction,\n DisableableAction,\n LoadableAction,\n IconableAction,\n TooltipAction {\n /** Provides extra visual weight and identifies the primary action in a set of buttons */\n primary?: boolean;\n}" } }, "PopoverCloseSource": { @@ -25903,6 +25851,65 @@ "value": "export interface PopoverOverlayProps {\n children?: React.ReactNode;\n fullWidth?: boolean;\n fullHeight?: boolean;\n fluidContent?: boolean;\n preferredPosition?: PositionedOverlayProps['preferredPosition'];\n preferredAlignment?: PositionedOverlayProps['preferredAlignment'];\n active: boolean;\n id: string;\n zIndexOverride?: number;\n activator: HTMLElement;\n preferInputActivator?: PositionedOverlayProps['preferInputActivator'];\n sectioned?: boolean;\n fixed?: boolean;\n hideOnPrint?: boolean;\n onClose(source: PopoverCloseSource): void;\n autofocusTarget?: PopoverAutofocusTarget;\n preventCloseOnChildOverlayClick?: boolean;\n captureOverscroll?: boolean;\n}" } }, + "PaneProps": { + "polaris-react/src/components/Popover/components/Pane/Pane.tsx": { + "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", + "name": "PaneProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", + "syntaxKind": "PropertySignature", + "name": "fixed", + "value": "boolean", + "description": "Fix the pane to the top of the popover", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", + "syntaxKind": "PropertySignature", + "name": "sectioned", + "value": "boolean", + "description": "Automatically wrap children in padded sections", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "The pane content", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", + "syntaxKind": "PropertySignature", + "name": "height", + "value": "string", + "description": "Sets a fixed height and max-height on the Scrollable", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", + "syntaxKind": "MethodSignature", + "name": "onScrolledToBottom", + "value": "() => void", + "description": "Callback when the bottom of the popover is reached by mouse or keyboard", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", + "syntaxKind": "PropertySignature", + "name": "captureOverscroll", + "value": "boolean", + "description": "Prevents page scrolling when the end of the scrollable Popover content is reached", + "isOptional": true, + "defaultValue": "false" + } + ], + "value": "export interface PaneProps {\n /** Fix the pane to the top of the popover */\n fixed?: boolean;\n /** Automatically wrap children in padded sections */\n sectioned?: boolean;\n /** The pane content */\n children?: React.ReactNode;\n /** Sets a fixed height and max-height on the Scrollable */\n height?: string;\n /** Callback when the bottom of the popover is reached by mouse or keyboard */\n onScrolledToBottom?(): void;\n /**\n * Prevents page scrolling when the end of the scrollable Popover content is reached\n * @default false\n */\n captureOverscroll?: boolean;\n}" + } + }, "PolarisContainerProps": { "polaris-react/src/components/PortalsManager/components/PortalsContainer/PortalsContainer.tsx": { "filePath": "polaris-react/src/components/PortalsManager/components/PortalsContainer/PortalsContainer.tsx", @@ -25912,56 +25919,56 @@ "value": "export interface PolarisContainerProps {}" } }, - "DualThumbProps": { - "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx": { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", - "name": "DualThumbProps", + "SingleThumbProps": { + "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx": { + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "name": "SingleThumbProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "PropertySignature", "name": "value", - "value": "DualValue", + "value": "number", "description": "Initial value for range input" }, { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "PropertySignature", "name": "id", "value": "string", "description": "ID for range input" }, { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "PropertySignature", "name": "min", "value": "number", "description": "Minimum possible value for range input" }, { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "PropertySignature", "name": "max", "value": "number", "description": "Maximum possible value for range input" }, { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "PropertySignature", "name": "step", "value": "number", "description": "Increment value for range input changes" }, { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "PropertySignature", "name": "label", "value": "ReactNode", "description": "Label for the range input" }, { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "PropertySignature", "name": "labelAction", "value": "Action", @@ -25969,7 +25976,7 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "PropertySignature", "name": "labelHidden", "value": "boolean", @@ -25977,7 +25984,7 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "PropertySignature", "name": "output", "value": "boolean", @@ -25985,7 +25992,7 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "PropertySignature", "name": "helpText", "value": "ReactNode", @@ -25993,7 +26000,7 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "PropertySignature", "name": "error", "value": "any", @@ -26001,7 +26008,7 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", @@ -26009,7 +26016,7 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "PropertySignature", "name": "prefix", "value": "ReactNode", @@ -26017,7 +26024,7 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "PropertySignature", "name": "suffix", "value": "ReactNode", @@ -26025,14 +26032,14 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "MethodSignature", "name": "onChange", "value": "(value: RangeSliderValue, id: string) => void", "description": "Callback when the range input is changed" }, { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "MethodSignature", "name": "onFocus", "value": "() => void", @@ -26040,7 +26047,7 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "MethodSignature", "name": "onBlur", "value": "() => void", @@ -26048,94 +26055,59 @@ "isOptional": true } ], - "value": "export interface DualThumbProps extends RangeSliderProps {\n value: DualValue;\n id: string;\n min: number;\n max: number;\n step: number;\n}" + "value": "export interface SingleThumbProps extends RangeSliderProps {\n value: number;\n id: string;\n min: number;\n max: number;\n step: number;\n}" } }, - "KeyHandlers": { + "DualThumbProps": { "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx": { "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", - "name": "KeyHandlers", + "name": "DualThumbProps", "description": "", "members": [ { "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", - "name": "[key: string]", - "value": "() => void" - } - ], - "value": "interface KeyHandlers {\n [key: string]: () => void;\n}" - } - }, - "Control": { - "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx": { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", - "syntaxKind": "EnumDeclaration", - "name": "Control", - "value": "enum Control {\n Lower,\n Upper,\n}", - "members": [ - { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", - "name": "Lower", - "value": 0 - }, - { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", - "name": "Upper", - "value": 1 - } - ] - } - }, - "SingleThumbProps": { - "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx": { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", - "name": "SingleThumbProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "PropertySignature", "name": "value", - "value": "number", + "value": "DualValue", "description": "Initial value for range input" }, { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", "syntaxKind": "PropertySignature", "name": "id", "value": "string", "description": "ID for range input" }, { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", "syntaxKind": "PropertySignature", "name": "min", "value": "number", "description": "Minimum possible value for range input" }, { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", "syntaxKind": "PropertySignature", "name": "max", "value": "number", "description": "Maximum possible value for range input" }, { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", "syntaxKind": "PropertySignature", "name": "step", "value": "number", "description": "Increment value for range input changes" }, { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", "syntaxKind": "PropertySignature", "name": "label", "value": "ReactNode", "description": "Label for the range input" }, { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", "syntaxKind": "PropertySignature", "name": "labelAction", "value": "Action", @@ -26143,7 +26115,7 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", "syntaxKind": "PropertySignature", "name": "labelHidden", "value": "boolean", @@ -26151,7 +26123,7 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", "syntaxKind": "PropertySignature", "name": "output", "value": "boolean", @@ -26159,7 +26131,7 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", "syntaxKind": "PropertySignature", "name": "helpText", "value": "ReactNode", @@ -26167,7 +26139,7 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", "syntaxKind": "PropertySignature", "name": "error", "value": "any", @@ -26175,7 +26147,7 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", @@ -26183,7 +26155,7 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", "syntaxKind": "PropertySignature", "name": "prefix", "value": "ReactNode", @@ -26191,7 +26163,7 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", "syntaxKind": "PropertySignature", "name": "suffix", "value": "ReactNode", @@ -26199,14 +26171,14 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", "syntaxKind": "MethodSignature", "name": "onChange", "value": "(value: RangeSliderValue, id: string) => void", "description": "Callback when the range input is changed" }, { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", "syntaxKind": "MethodSignature", "name": "onFocus", "value": "() => void", @@ -26214,7 +26186,7 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", "syntaxKind": "MethodSignature", "name": "onBlur", "value": "() => void", @@ -26222,7 +26194,42 @@ "isOptional": true } ], - "value": "export interface SingleThumbProps extends RangeSliderProps {\n value: number;\n id: string;\n min: number;\n max: number;\n step: number;\n}" + "value": "export interface DualThumbProps extends RangeSliderProps {\n value: DualValue;\n id: string;\n min: number;\n max: number;\n step: number;\n}" + } + }, + "KeyHandlers": { + "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx": { + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "name": "KeyHandlers", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "name": "[key: string]", + "value": "() => void" + } + ], + "value": "interface KeyHandlers {\n [key: string]: () => void;\n}" + } + }, + "Control": { + "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx": { + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "syntaxKind": "EnumDeclaration", + "name": "Control", + "value": "enum Control {\n Lower,\n Upper,\n}", + "members": [ + { + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "name": "Lower", + "value": 0 + }, + { + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "name": "Upper", + "value": 1 + } + ] } }, "PanelProps": {