From 3032b64d3c809d5948579c348dd1b3d94c45b9b2 Mon Sep 17 00:00:00 2001 From: Lo Kim Date: Fri, 18 Nov 2022 08:52:51 -0500 Subject: [PATCH 1/5] [Columns] Refactor `gap` to use `getResponsiveProps` util --- .../src/components/Columns/Columns.scss | 12 ++----- .../src/components/Columns/Columns.tsx | 33 ++++++++++--------- 2 files changed, 19 insertions(+), 26 deletions(-) diff --git a/polaris-react/src/components/Columns/Columns.scss b/polaris-react/src/components/Columns/Columns.scss index 25556b65338..7889f485a78 100644 --- a/polaris-react/src/components/Columns/Columns.scss +++ b/polaris-react/src/components/Columns/Columns.scss @@ -1,37 +1,29 @@ @import '../../styles/common'; .Columns { + @include responsive-props('columns', 'gap', 'gap'); + --pc-columns-xs: 6; --pc-columns-sm: var(--pc-columns-xs); --pc-columns-md: var(--pc-columns-sm); --pc-columns-lg: var(--pc-columns-md); --pc-columns-xl: var(--pc-columns-lg); - --pc-columns-gap-xs: var(--p-space-4); - --pc-columns-gap-sm: var(--pc-columns-gap-xs); - --pc-columns-gap-md: var(--pc-columns-gap-sm); - --pc-columns-gap-lg: var(--pc-columns-gap-md); - --pc-columns-gap-xl: var(--pc-columns-gap-lg); display: grid; - gap: var(--pc-columns-gap-xs); grid-template-columns: var(--pc-columns-xs); @media #{$p-breakpoints-sm-up} { - gap: var(--pc-columns-gap-sm); grid-template-columns: var(--pc-columns-sm); } @media #{$p-breakpoints-md-up} { - gap: var(--pc-columns-gap-md); grid-template-columns: var(--pc-columns-md); } @media #{$p-breakpoints-lg-up} { - gap: var(--pc-columns-gap-lg); grid-template-columns: var(--pc-columns-lg); } @media #{$p-breakpoints-xl-up} { - gap: var(--pc-columns-gap-xl); grid-template-columns: var(--pc-columns-xl); } } diff --git a/polaris-react/src/components/Columns/Columns.tsx b/polaris-react/src/components/Columns/Columns.tsx index e2d1a7fbc09..0803bf86185 100644 --- a/polaris-react/src/components/Columns/Columns.tsx +++ b/polaris-react/src/components/Columns/Columns.tsx @@ -4,7 +4,11 @@ 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 './Columns.scss'; @@ -12,35 +16,32 @@ type Columns = { [Breakpoint in BreakpointsAlias]?: number | string; }; -type Gap = { - [Breakpoint in BreakpointsAlias]?: SpacingSpaceScale; -}; +type Gap = ResponsiveProp; export interface ColumnsProps { - /** The spacing between columns - * @default '4' - */ - gap?: Gap; + /** Elements to display inside columns */ + children?: React.ReactNode; /** The number of columns to display * @default {xs: 6, sm: 6, md: 6, lg: 6, xl: 6} */ columns?: Columns; - /** Elements to display inside columns */ - children?: React.ReactNode; + /** The spacing between columns. Accepts a spacing token or an object of spacing tokens for different screen sizes. + * @default '4' + * @example + * gap='2' + * gap={{xs: '1', sm: '2', md: '3', lg: '4', xl: '5'}} + */ + gap?: Gap; } -export function Columns({columns, children, gap}: ColumnsProps) { +export function Columns({children, columns, gap = '4'}: ColumnsProps) { const style = { '--pc-columns-xs': formatColumns(columns?.xs || 6), '--pc-columns-sm': formatColumns(columns?.sm), '--pc-columns-md': formatColumns(columns?.md), '--pc-columns-lg': formatColumns(columns?.lg), '--pc-columns-xl': formatColumns(columns?.xl), - '--pc-columns-gap-xs': gap?.xs ? `var(--p-space-${gap?.xs})` : undefined, - '--pc-columns-gap-sm': gap?.sm ? `var(--p-space-${gap?.sm})` : undefined, - '--pc-columns-gap-md': gap?.md ? `var(--p-space-${gap?.md})` : undefined, - '--pc-columns-gap-lg': gap?.lg ? `var(--p-space-${gap?.lg})` : undefined, - '--pc-columns-gap-xl': gap?.xl ? `var(--p-space-${gap?.xl})` : undefined, + ...getResponsiveProps('columns', 'gap', 'space', gap), } as React.CSSProperties; return ( From ea2a0612ebd77230fef96117f645801931c7d1bc Mon Sep 17 00:00:00 2001 From: Lo Kim Date: Fri, 18 Nov 2022 08:53:02 -0500 Subject: [PATCH 2/5] [Columns] Update tests --- polaris-react/src/components/Columns/tests/Columns.test.tsx | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/polaris-react/src/components/Columns/tests/Columns.test.tsx b/polaris-react/src/components/Columns/tests/Columns.test.tsx index 40cf01d6e27..9fd3fcdf6ad 100644 --- a/polaris-react/src/components/Columns/tests/Columns.test.tsx +++ b/polaris-react/src/components/Columns/tests/Columns.test.tsx @@ -4,12 +4,13 @@ import {mountWithApp} from 'tests/utilities'; import {Columns} from '..'; describe('Columns', () => { - it('does not render custom properties by default', () => { + it('renders custom properties with default values', () => { const columns = mountWithApp(); expect(columns).toContainReactComponent('div', { style: { '--pc-columns-xs': 'repeat(6, minmax(0, 1fr))', + '--pc-columns-gap-xs': 'var(--p-space-4)', } as React.CSSProperties, }); }); @@ -34,6 +35,7 @@ describe('Columns', () => { style: { '--pc-columns-xs': '1fr 1fr', '--pc-columns-lg': '1.5fr 0.5fr', + '--pc-columns-gap-xs': 'var(--p-space-4)', } as React.CSSProperties, }); }); @@ -45,6 +47,7 @@ describe('Columns', () => { style: { '--pc-columns-xs': 'repeat(1, minmax(0, 1fr))', '--pc-columns-md': 'repeat(4, minmax(0, 1fr))', + '--pc-columns-gap-xs': 'var(--p-space-4)', } as React.CSSProperties, }); }); From d8dadb54d0312e06ddf09e6bf004a63db357d299 Mon Sep 17 00:00:00 2001 From: Lo Kim Date: Fri, 18 Nov 2022 08:53:15 -0500 Subject: [PATCH 3/5] [Columns] Update stories --- .../components/Columns/Columns.stories.tsx | 25 +++++++++++++------ 1 file changed, 18 insertions(+), 7 deletions(-) diff --git a/polaris-react/src/components/Columns/Columns.stories.tsx b/polaris-react/src/components/Columns/Columns.stories.tsx index 4e576ead271..9f2b27e4351 100644 --- a/polaris-react/src/components/Columns/Columns.stories.tsx +++ b/polaris-react/src/components/Columns/Columns.stories.tsx @@ -7,7 +7,7 @@ export default { component: Columns, } as ComponentMeta; -export function BasicColumns() { +export function Default() { return ( @@ -22,7 +22,7 @@ export function BasicColumns() { ); } -export function ColumnsWithTemplateColumns() { +export function WithTemplateColumns() { return (
Column one
Column two
@@ -45,7 +44,7 @@ export function ColumnsWithTemplateColumns() { ); } -export function ColumnsWithMixedPropTypes() { +export function WithMixedPropTypes() { return ( + +
Column one
+
Column two
+
Column three
+ + + ); +} + +export function WithResponsiveGap() { return (
Column one
Column two
@@ -78,7 +89,7 @@ export function ColumnsWithVaryingGap() { ); } -export function ColumnsWithFreeAndFixedWidths() { +export function WithFreeAndFixedWidths() { return ( From a18178d11e04e39b8cbf7bf8bf3e9114e8238d40 Mon Sep 17 00:00:00 2001 From: Lo Kim Date: Fri, 18 Nov 2022 08:59:23 -0500 Subject: [PATCH 4/5] [polaris.shopify.com] Run `get-props` script --- polaris.shopify.com/src/data/props.json | 2654 ++++++++++++----------- 1 file changed, 1331 insertions(+), 1323 deletions(-) diff --git a/polaris.shopify.com/src/data/props.json b/polaris.shopify.com/src/data/props.json index 3dfa9c9a597..00fe992afd1 100644 --- a/polaris.shopify.com/src/data/props.json +++ b/polaris.shopify.com/src/data/props.json @@ -8160,7 +8160,7 @@ "filePath": "polaris-react/src/components/Columns/Columns.tsx", "syntaxKind": "TypeAliasDeclaration", "name": "Gap", - "value": "{\n [Breakpoint in BreakpointsAlias]?: SpacingSpaceScale;\n}", + "value": "ResponsiveProp", "description": "" }, "polaris-react/src/components/Grid/Grid.tsx": { @@ -9087,62 +9087,6 @@ ], "value": "export interface NonMutuallyExclusiveProps {\n keyCode: Key;\n handler(event: KeyboardEvent): void;\n keyEvent?: KeyEvent;\n}" }, - "polaris-react/src/components/Tag/Tag.tsx": { - "filePath": "polaris-react/src/components/Tag/Tag.tsx", - "name": "NonMutuallyExclusiveProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Tag/Tag.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "Content to display in the tag", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Tag/Tag.tsx", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "Disables the tag", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Tag/Tag.tsx", - "syntaxKind": "MethodSignature", - "name": "onClick", - "value": "() => void", - "description": "Callback when tag is clicked or keypressed. Renders without remove button or url when set.", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Tag/Tag.tsx", - "syntaxKind": "MethodSignature", - "name": "onRemove", - "value": "() => void", - "description": "Callback when remove button is clicked or keypressed.", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Tag/Tag.tsx", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "A string to use when tag has more than textual content", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Tag/Tag.tsx", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "Url to navigate to when tag is clicked or keypressed.", - "isOptional": true - } - ], - "value": "export interface NonMutuallyExclusiveProps {\n /** Content to display in the tag */\n children?: React.ReactNode;\n /** Disables the tag */\n disabled?: boolean;\n /** Callback when tag is clicked or keypressed. Renders without remove button or url when set. */\n onClick?(): void;\n /** Callback when remove button is clicked or keypressed. */\n onRemove?(): void;\n /** A string to use when tag has more than textual content */\n accessibilityLabel?: string;\n /** Url to navigate to when tag is clicked or keypressed. */\n url?: string;\n}" - }, "polaris-react/src/components/TextField/TextField.tsx": { "filePath": "polaris-react/src/components/TextField/TextField.tsx", "name": "NonMutuallyExclusiveProps", @@ -9524,6 +9468,62 @@ } ], "value": "interface NonMutuallyExclusiveProps {\n /** Text to display before value */\n prefix?: React.ReactNode;\n /** Text to display after value */\n suffix?: React.ReactNode;\n /** Content to vertically display above the input value */\n verticalContent?: React.ReactNode;\n /** Hint text to display */\n placeholder?: string;\n /** Initial value for the input */\n value?: string;\n /** Additional hint text to display */\n helpText?: React.ReactNode;\n /** Label for the input */\n label: React.ReactNode;\n /** Adds an action to the label */\n labelAction?: LabelledProps['action'];\n /** Visually hide the label */\n labelHidden?: boolean;\n /** Disable the input */\n disabled?: boolean;\n /** Show a clear text button in the input */\n clearButton?: boolean;\n /** Indicates whether or not the entire value should be selected on focus. */\n selectTextOnFocus?: boolean;\n /** An inline autocomplete suggestion containing the input value. The characters that complete the input value are selected for ease of deletion on input change or keypress of Backspace/Delete. The selected substring is visually highlighted with subdued styling. */\n suggestion?: string;\n /** Disable editing of the input */\n readOnly?: boolean;\n /** Automatically focus the input */\n autoFocus?: boolean;\n /** Force the focus state on the input */\n focused?: boolean;\n /** Allow for multiple lines of input */\n multiline?: boolean | number;\n /** Error to display beneath the label */\n error?: Error | boolean;\n /** An element connected to the right of the input */\n connectedRight?: React.ReactNode;\n /** An element connected to the left of the input */\n connectedLeft?: React.ReactNode;\n /** Determine type of input */\n type?: Type;\n /** Name of the input */\n name?: string;\n /** ID for the input */\n id?: string;\n /** Defines a specific role attribute for the input */\n role?: string;\n /** Limit increment value for numeric and date-time inputs */\n step?: number;\n /** Enable automatic completion by the browser. Set to \"off\" when you do not want the browser to fill in info */\n autoComplete: string;\n /** Mimics the behavior of the native HTML attribute, limiting the maximum value */\n max?: number | string;\n /** Maximum character length for an input */\n maxLength?: number;\n /** Maximum height of the input element. Only applies when `multiline` is `true` */\n maxHeight?: number | string;\n /** Mimics the behavior of the native HTML attribute, limiting the minimum value */\n min?: number | string;\n /** Minimum character length for an input */\n minLength?: number;\n /** A regular expression to check the value against */\n pattern?: string;\n /** Choose the keyboard that should be used on mobile devices */\n inputMode?: InputMode;\n /** Indicate whether value should have spelling checked */\n spellCheck?: boolean;\n /** Indicates the id of a component owned by the input */\n ariaOwns?: string;\n /** Indicates whether or not a Popover is displayed */\n ariaExpanded?: boolean;\n /** Indicates the id of a component controlled by the input */\n ariaControls?: string;\n /** Indicates the id of a related component’s visually focused element to the input */\n ariaActiveDescendant?: string;\n /** Indicates what kind of user input completion suggestions are provided */\n ariaAutocomplete?: string;\n /** Indicates whether or not the character count should be displayed */\n showCharacterCount?: boolean;\n /** Determines the alignment of the text in the input */\n align?: Alignment;\n /** Visual required indicator, adds an asterisk to label */\n requiredIndicator?: boolean;\n /** Indicates whether or not a monospaced font should be used */\n monospaced?: boolean;\n /** Callback fired when clear button is clicked */\n onClearButtonClick?(id: string): void;\n /** Callback fired when value is changed */\n onChange?(value: string, id: string): void;\n /** Callback fired when input is focused */\n onFocus?: (event?: React.FocusEvent) => void;\n /** Callback fired when input is blurred */\n onBlur?(event?: React.FocusEvent): void;\n}" + }, + "polaris-react/src/components/Tag/Tag.tsx": { + "filePath": "polaris-react/src/components/Tag/Tag.tsx", + "name": "NonMutuallyExclusiveProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Tag/Tag.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "Content to display in the tag", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Tag/Tag.tsx", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Disables the tag", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Tag/Tag.tsx", + "syntaxKind": "MethodSignature", + "name": "onClick", + "value": "() => void", + "description": "Callback when tag is clicked or keypressed. Renders without remove button or url when set.", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Tag/Tag.tsx", + "syntaxKind": "MethodSignature", + "name": "onRemove", + "value": "() => void", + "description": "Callback when remove button is clicked or keypressed.", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Tag/Tag.tsx", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A string to use when tag has more than textual content", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Tag/Tag.tsx", + "syntaxKind": "PropertySignature", + "name": "url", + "value": "string", + "description": "Url to navigate to when tag is clicked or keypressed.", + "isOptional": true + } + ], + "value": "export interface NonMutuallyExclusiveProps {\n /** Content to display in the tag */\n children?: React.ReactNode;\n /** Disables the tag */\n disabled?: boolean;\n /** Callback when tag is clicked or keypressed. Renders without remove button or url when set. */\n onClick?(): void;\n /** Callback when remove button is clicked or keypressed. */\n onRemove?(): void;\n /** A string to use when tag has more than textual content */\n accessibilityLabel?: string;\n /** Url to navigate to when tag is clicked or keypressed. */\n url?: string;\n}" } }, "BadgeProps": { @@ -9666,71 +9666,6 @@ "value": "export interface BannerHandles {\n focus(): void;\n}" } }, - "BleedProps": { - "polaris-react/src/components/Bleed/Bleed.tsx": { - "filePath": "polaris-react/src/components/Bleed/Bleed.tsx", - "name": "BleedProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Bleed/Bleed.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "Elements to display inside tile" - }, - { - "filePath": "polaris-react/src/components/Bleed/Bleed.tsx", - "syntaxKind": "PropertySignature", - "name": "horizontal", - "value": "\"0\" | \"025\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", - "description": "Negative horizontal space around the element\n* @default '5'", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Bleed/Bleed.tsx", - "syntaxKind": "PropertySignature", - "name": "vertical", - "value": "\"0\" | \"025\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", - "description": "Negative vertical space around the element", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Bleed/Bleed.tsx", - "syntaxKind": "PropertySignature", - "name": "top", - "value": "\"0\" | \"025\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", - "description": "Negative top space around the element", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Bleed/Bleed.tsx", - "syntaxKind": "PropertySignature", - "name": "bottom", - "value": "\"0\" | \"025\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", - "description": "Negative bottom space around the element", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Bleed/Bleed.tsx", - "syntaxKind": "PropertySignature", - "name": "left", - "value": "\"0\" | \"025\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", - "description": "Negative left space around the element", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Bleed/Bleed.tsx", - "syntaxKind": "PropertySignature", - "name": "right", - "value": "\"0\" | \"025\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", - "description": "Negative right space around the element", - "isOptional": true - } - ], - "value": "export interface BleedProps {\n /** Elements to display inside tile */\n children: React.ReactNode;\n /** Negative horizontal space around the element\n * * @default '5'\n */\n horizontal?: SpacingSpaceScale;\n /** Negative vertical space around the element */\n vertical?: SpacingSpaceScale;\n /** Negative top space around the element */\n top?: SpacingSpaceScale;\n /** Negative bottom space around the element */\n bottom?: SpacingSpaceScale;\n /** Negative left space around the element */\n left?: SpacingSpaceScale;\n /** Negative right space around the element */\n right?: SpacingSpaceScale;\n}" - } - }, "Overflow": { "polaris-react/src/components/Box/Box.tsx": { "filePath": "polaris-react/src/components/Box/Box.tsx", @@ -10186,6 +10121,71 @@ "value": "export interface BoxProps {\n /** HTML Element type */\n as?: Element;\n /** Background color */\n background?: BackgroundColors;\n /** Border style */\n border?: BorderTokenAlias;\n /** Vertical end border style */\n borderBlockEnd?: BorderTokenAlias;\n /** Horizontal start border style */\n borderInlineStart?: BorderTokenAlias;\n /** Horizontal end border style */\n borderInlineEnd?: BorderTokenAlias;\n /** Vertical start border style */\n borderBlockStart?: BorderTokenAlias;\n /** Border radius */\n borderRadius?: BorderRadiusTokenScale;\n /** Vertical end horizontal start border radius */\n borderRadiusEndStart?: BorderRadiusTokenScale;\n /** Vertical end horizontal end border radius */\n borderRadiusEndEnd?: BorderRadiusTokenScale;\n /** Vertical start horizontal start border radius */\n borderRadiusStartStart?: BorderRadiusTokenScale;\n /** Verital start horizontal end border radius */\n borderRadiusStartEnd?: BorderRadiusTokenScale;\n /** Border width */\n borderWidth?: ShapeBorderWidthScale;\n /** Vertical start border width */\n borderBlockStartWidth?: ShapeBorderWidthScale;\n /** Vertical end border width */\n borderBlockEndWidth?: ShapeBorderWidthScale;\n /** Horizontal start border width */\n borderInlineStartWidth?: ShapeBorderWidthScale;\n /** Horizontal end border width */\n borderInlineEndWidth?: ShapeBorderWidthScale;\n /** Color of children */\n color?: ColorTokenScale;\n /** HTML id attribute */\n id?: string;\n /** Set minimum height of container */\n minHeight?: string;\n /** Set minimum width of container */\n minWidth?: string;\n /** Set maximum width of container */\n maxWidth?: string;\n /** Clip horizontal content of children */\n overflowX?: Overflow;\n /** Clip vertical content of children */\n overflowY?: Overflow;\n /** Spacing around children */\n padding?: Spacing;\n /** Vertical start spacing around children */\n paddingBlockStart?: Spacing;\n /** Vertical end spacing around children */\n paddingBlockEnd?: Spacing;\n /** Horizontal start spacing around children */\n paddingInlineStart?: Spacing;\n /** Horizontal end spacing around children */\n paddingInlineEnd?: Spacing;\n /** Shadow */\n shadow?: DepthShadowAlias;\n /** Set width of container */\n width?: string;\n /** Elements to display inside box */\n children?: React.ReactNode;\n}" } }, + "BleedProps": { + "polaris-react/src/components/Bleed/Bleed.tsx": { + "filePath": "polaris-react/src/components/Bleed/Bleed.tsx", + "name": "BleedProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Bleed/Bleed.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "Elements to display inside tile" + }, + { + "filePath": "polaris-react/src/components/Bleed/Bleed.tsx", + "syntaxKind": "PropertySignature", + "name": "horizontal", + "value": "\"0\" | \"025\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", + "description": "Negative horizontal space around the element\n* @default '5'", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Bleed/Bleed.tsx", + "syntaxKind": "PropertySignature", + "name": "vertical", + "value": "\"0\" | \"025\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", + "description": "Negative vertical space around the element", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Bleed/Bleed.tsx", + "syntaxKind": "PropertySignature", + "name": "top", + "value": "\"0\" | \"025\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", + "description": "Negative top space around the element", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Bleed/Bleed.tsx", + "syntaxKind": "PropertySignature", + "name": "bottom", + "value": "\"0\" | \"025\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", + "description": "Negative bottom space around the element", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Bleed/Bleed.tsx", + "syntaxKind": "PropertySignature", + "name": "left", + "value": "\"0\" | \"025\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", + "description": "Negative left space around the element", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Bleed/Bleed.tsx", + "syntaxKind": "PropertySignature", + "name": "right", + "value": "\"0\" | \"025\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", + "description": "Negative right space around the element", + "isOptional": true + } + ], + "value": "export interface BleedProps {\n /** Elements to display inside tile */\n children: React.ReactNode;\n /** Negative horizontal space around the element\n * * @default '5'\n */\n horizontal?: SpacingSpaceScale;\n /** Negative vertical space around the element */\n vertical?: SpacingSpaceScale;\n /** Negative top space around the element */\n top?: SpacingSpaceScale;\n /** Negative bottom space around the element */\n bottom?: SpacingSpaceScale;\n /** Negative left space around the element */\n left?: SpacingSpaceScale;\n /** Negative right space around the element */\n right?: SpacingSpaceScale;\n}" + } + }, "BreadcrumbsProps": { "polaris-react/src/components/Breadcrumbs/Breadcrumbs.tsx": { "filePath": "polaris-react/src/components/Breadcrumbs/Breadcrumbs.tsx", @@ -10808,17 +10808,35 @@ "description": "" } }, - "ButtonGroupProps": { - "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx": { - "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", - "name": "ButtonGroupProps", + "CaptionProps": { + "polaris-react/src/components/Caption/Caption.tsx": { + "filePath": "polaris-react/src/components/Caption/Caption.tsx", + "name": "CaptionProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", + "filePath": "polaris-react/src/components/Caption/Caption.tsx", "syntaxKind": "PropertySignature", - "name": "spacing", - "value": "Spacing", + "name": "children", + "value": "React.ReactNode", + "description": "The content to use as a graph label or timestamp", + "isOptional": true + } + ], + "value": "export interface CaptionProps {\n /** The content to use as a graph label or timestamp */\n children?: React.ReactNode;\n}" + } + }, + "ButtonGroupProps": { + "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx": { + "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", + "name": "ButtonGroupProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "spacing", + "value": "Spacing", "description": "Determines the space between button group items", "isOptional": true }, @@ -11003,106 +11021,6 @@ "value": "export interface CardProps {\n /** Title content for the card */\n title?: React.ReactNode;\n /** Inner content of the card */\n children?: React.ReactNode;\n /** A less prominent card */\n subdued?: boolean;\n /** Auto wrap content in section */\n sectioned?: boolean;\n /** Card header actions */\n actions?: DisableableAction[];\n /** Primary action in the card footer */\n primaryFooterAction?: ComplexAction;\n /** Secondary actions in the card footer */\n secondaryFooterActions?: ComplexAction[];\n /** The content of the disclosure button rendered when there is more than one secondary footer action */\n secondaryFooterActionsDisclosureText?: string;\n /** Alignment of the footer actions on the card, defaults to right */\n footerActionAlignment?: 'right' | 'left';\n /** Allow the card to be hidden when printing */\n hideOnPrint?: boolean;\n}" } }, - "CaptionProps": { - "polaris-react/src/components/Caption/Caption.tsx": { - "filePath": "polaris-react/src/components/Caption/Caption.tsx", - "name": "CaptionProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Caption/Caption.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "The content to use as a graph label or timestamp", - "isOptional": true - } - ], - "value": "export interface CaptionProps {\n /** The content to use as a graph label or timestamp */\n children?: React.ReactNode;\n}" - } - }, - "CheckableButtonProps": { - "polaris-react/src/components/CheckableButton/CheckableButton.tsx": { - "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx", - "name": "CheckableButtonProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx", - "syntaxKind": "PropertySignature", - "name": "label", - "value": "string", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx", - "syntaxKind": "PropertySignature", - "name": "selected", - "value": "boolean | \"indeterminate\"", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx", - "syntaxKind": "PropertySignature", - "name": "selectMode", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx", - "syntaxKind": "PropertySignature", - "name": "smallScreen", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx", - "syntaxKind": "PropertySignature", - "name": "plain", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx", - "syntaxKind": "PropertySignature", - "name": "measuring", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx", - "syntaxKind": "MethodSignature", - "name": "onToggleAll", - "value": "() => void", - "description": "", - "isOptional": true - } - ], - "value": "export interface CheckableButtonProps {\n accessibilityLabel?: string;\n label?: string;\n selected?: boolean | 'indeterminate';\n selectMode?: boolean;\n smallScreen?: boolean;\n plain?: boolean;\n measuring?: boolean;\n disabled?: boolean;\n onToggleAll?(): void;\n}" - } - }, "CheckboxProps": { "polaris-react/src/components/Checkbox/Checkbox.tsx": { "filePath": "polaris-react/src/components/Checkbox/Checkbox.tsx", @@ -11295,6 +11213,88 @@ "value": "export interface CheckboxProps {\n checked?: boolean;\n disabled?: boolean;\n active?: boolean;\n id?: string;\n name?: string;\n value?: string;\n role?: string;\n onChange(): void;\n}" } }, + "CheckableButtonProps": { + "polaris-react/src/components/CheckableButton/CheckableButton.tsx": { + "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx", + "name": "CheckableButtonProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx", + "syntaxKind": "PropertySignature", + "name": "selected", + "value": "boolean | \"indeterminate\"", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx", + "syntaxKind": "PropertySignature", + "name": "selectMode", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx", + "syntaxKind": "PropertySignature", + "name": "smallScreen", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx", + "syntaxKind": "PropertySignature", + "name": "plain", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx", + "syntaxKind": "PropertySignature", + "name": "measuring", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx", + "syntaxKind": "MethodSignature", + "name": "onToggleAll", + "value": "() => void", + "description": "", + "isOptional": true + } + ], + "value": "export interface CheckableButtonProps {\n accessibilityLabel?: string;\n label?: string;\n selected?: boolean | 'indeterminate';\n selectMode?: boolean;\n smallScreen?: boolean;\n plain?: boolean;\n measuring?: boolean;\n disabled?: boolean;\n onToggleAll?(): void;\n}" + } + }, "ChoiceProps": { "polaris-react/src/components/Choice/Choice.tsx": { "filePath": "polaris-react/src/components/Choice/Choice.tsx", @@ -11619,36 +11619,143 @@ "description": "" } }, - "Color": { - "polaris-react/src/components/ColorPicker/ColorPicker.tsx": { - "filePath": "polaris-react/src/components/ColorPicker/ColorPicker.tsx", - "name": "Color", + "Columns": { + "polaris-react/src/components/Columns/Columns.tsx": { + "filePath": "polaris-react/src/components/Columns/Columns.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Columns", + "value": "{\n [Breakpoint in BreakpointsAlias]?: number | string;\n}", + "description": "" + }, + "polaris-react/src/components/Grid/Grid.tsx": { + "filePath": "polaris-react/src/components/Grid/Grid.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Columns", + "value": "{\n [Breakpoint in Breakpoints]?: number;\n}", + "description": "" + }, + "polaris-react/src/components/Tiles/Tiles.tsx": { + "filePath": "polaris-react/src/components/Tiles/Tiles.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Columns", + "value": "{\n [Breakpoint in BreakpointsAlias]?: number | string;\n}", + "description": "" + }, + "polaris-react/src/components/Grid/components/Cell/Cell.tsx": { + "filePath": "polaris-react/src/components/Grid/components/Cell/Cell.tsx", + "name": "Columns", "description": "", "members": [ { - "filePath": "polaris-react/src/components/ColorPicker/ColorPicker.tsx", + "filePath": "polaris-react/src/components/Grid/components/Cell/Cell.tsx", "syntaxKind": "PropertySignature", - "name": "alpha", - "value": "number", - "description": "Level of transparency", + "name": "xs", + "value": "2 | 5 | 1 | 4 | 3 | 6", + "description": "Number of columns the section should span on extra small screens", "isOptional": true }, { - "filePath": "polaris-react/src/components/ColorPicker/ColorPicker.tsx", + "filePath": "polaris-react/src/components/Grid/components/Cell/Cell.tsx", "syntaxKind": "PropertySignature", - "name": "brightness", - "value": "number", - "description": "Brightness of the color" + "name": "sm", + "value": "2 | 5 | 1 | 4 | 3 | 6", + "description": "Number of columns the section should span on small screens", + "isOptional": true }, { - "filePath": "polaris-react/src/components/ColorPicker/ColorPicker.tsx", + "filePath": "polaris-react/src/components/Grid/components/Cell/Cell.tsx", "syntaxKind": "PropertySignature", - "name": "hue", - "value": "number", - "description": "The color" - }, - { - "filePath": "polaris-react/src/components/ColorPicker/ColorPicker.tsx", + "name": "md", + "value": "2 | 5 | 1 | 4 | 3 | 6", + "description": "Number of columns the section should span on medium screens", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Grid/components/Cell/Cell.tsx", + "syntaxKind": "PropertySignature", + "name": "lg", + "value": "2 | 5 | 1 | 4 | 10 | 3 | 6 | 7 | 8 | 9 | 11 | 12", + "description": "Number of columns the section should span on large screens", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Grid/components/Cell/Cell.tsx", + "syntaxKind": "PropertySignature", + "name": "xl", + "value": "2 | 5 | 1 | 4 | 10 | 3 | 6 | 7 | 8 | 9 | 11 | 12", + "description": "Number of columns the section should span on extra large screens", + "isOptional": true + } + ], + "value": "interface Columns {\n /** Number of columns the section should span on extra small screens */\n xs?: 1 | 2 | 3 | 4 | 5 | 6;\n /** Number of columns the section should span on small screens */\n sm?: 1 | 2 | 3 | 4 | 5 | 6;\n /** Number of columns the section should span on medium screens */\n md?: 1 | 2 | 3 | 4 | 5 | 6;\n /** Number of columns the section should span on large screens */\n lg?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12;\n /** Number of columns the section should span on extra large screens */\n xl?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12;\n}" + } + }, + "ColumnsProps": { + "polaris-react/src/components/Columns/Columns.tsx": { + "filePath": "polaris-react/src/components/Columns/Columns.tsx", + "name": "ColumnsProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Columns/Columns.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "Elements to display inside columns", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Columns/Columns.tsx", + "syntaxKind": "PropertySignature", + "name": "columns", + "value": "Columns", + "description": "The number of columns to display", + "isOptional": true, + "defaultValue": "{xs: 6, sm: 6, md: 6, lg: 6, xl: 6}" + }, + { + "filePath": "polaris-react/src/components/Columns/Columns.tsx", + "syntaxKind": "PropertySignature", + "name": "gap", + "value": "Gap", + "description": "The spacing between columns. Accepts a spacing token or an object of spacing tokens for different screen sizes.", + "isOptional": true, + "defaultValue": "'4'" + } + ], + "value": "export interface ColumnsProps {\n /** Elements to display inside columns */\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 columns. 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}" + } + }, + "Color": { + "polaris-react/src/components/ColorPicker/ColorPicker.tsx": { + "filePath": "polaris-react/src/components/ColorPicker/ColorPicker.tsx", + "name": "Color", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/ColorPicker/ColorPicker.tsx", + "syntaxKind": "PropertySignature", + "name": "alpha", + "value": "number", + "description": "Level of transparency", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ColorPicker/ColorPicker.tsx", + "syntaxKind": "PropertySignature", + "name": "brightness", + "value": "number", + "description": "Brightness of the color" + }, + { + "filePath": "polaris-react/src/components/ColorPicker/ColorPicker.tsx", + "syntaxKind": "PropertySignature", + "name": "hue", + "value": "number", + "description": "The color" + }, + { + "filePath": "polaris-react/src/components/ColorPicker/ColorPicker.tsx", "syntaxKind": "PropertySignature", "name": "saturation", "value": "number", @@ -11727,113 +11834,6 @@ "value": "export interface ColorPickerProps {\n /** ID for the element */\n id?: string;\n /** The currently selected color */\n color: Color;\n /** Allow user to select an alpha value */\n allowAlpha?: boolean;\n /** Allow HuePicker to take the full width */\n fullWidth?: boolean;\n /** Callback when color is selected */\n onChange(color: HSBAColor): void;\n}" } }, - "Columns": { - "polaris-react/src/components/Columns/Columns.tsx": { - "filePath": "polaris-react/src/components/Columns/Columns.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Columns", - "value": "{\n [Breakpoint in BreakpointsAlias]?: number | string;\n}", - "description": "" - }, - "polaris-react/src/components/Grid/Grid.tsx": { - "filePath": "polaris-react/src/components/Grid/Grid.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Columns", - "value": "{\n [Breakpoint in Breakpoints]?: number;\n}", - "description": "" - }, - "polaris-react/src/components/Tiles/Tiles.tsx": { - "filePath": "polaris-react/src/components/Tiles/Tiles.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Columns", - "value": "{\n [Breakpoint in BreakpointsAlias]?: number | string;\n}", - "description": "" - }, - "polaris-react/src/components/Grid/components/Cell/Cell.tsx": { - "filePath": "polaris-react/src/components/Grid/components/Cell/Cell.tsx", - "name": "Columns", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Grid/components/Cell/Cell.tsx", - "syntaxKind": "PropertySignature", - "name": "xs", - "value": "2 | 5 | 1 | 4 | 3 | 6", - "description": "Number of columns the section should span on extra small screens", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Grid/components/Cell/Cell.tsx", - "syntaxKind": "PropertySignature", - "name": "sm", - "value": "2 | 5 | 1 | 4 | 3 | 6", - "description": "Number of columns the section should span on small screens", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Grid/components/Cell/Cell.tsx", - "syntaxKind": "PropertySignature", - "name": "md", - "value": "2 | 5 | 1 | 4 | 3 | 6", - "description": "Number of columns the section should span on medium screens", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Grid/components/Cell/Cell.tsx", - "syntaxKind": "PropertySignature", - "name": "lg", - "value": "2 | 5 | 1 | 4 | 10 | 3 | 6 | 7 | 8 | 9 | 11 | 12", - "description": "Number of columns the section should span on large screens", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Grid/components/Cell/Cell.tsx", - "syntaxKind": "PropertySignature", - "name": "xl", - "value": "2 | 5 | 1 | 4 | 10 | 3 | 6 | 7 | 8 | 9 | 11 | 12", - "description": "Number of columns the section should span on extra large screens", - "isOptional": true - } - ], - "value": "interface Columns {\n /** Number of columns the section should span on extra small screens */\n xs?: 1 | 2 | 3 | 4 | 5 | 6;\n /** Number of columns the section should span on small screens */\n sm?: 1 | 2 | 3 | 4 | 5 | 6;\n /** Number of columns the section should span on medium screens */\n md?: 1 | 2 | 3 | 4 | 5 | 6;\n /** Number of columns the section should span on large screens */\n lg?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12;\n /** Number of columns the section should span on extra large screens */\n xl?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12;\n}" - } - }, - "ColumnsProps": { - "polaris-react/src/components/Columns/Columns.tsx": { - "filePath": "polaris-react/src/components/Columns/Columns.tsx", - "name": "ColumnsProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Columns/Columns.tsx", - "syntaxKind": "PropertySignature", - "name": "gap", - "value": "Gap", - "description": "The spacing between columns", - "isOptional": true, - "defaultValue": "'4'" - }, - { - "filePath": "polaris-react/src/components/Columns/Columns.tsx", - "syntaxKind": "PropertySignature", - "name": "columns", - "value": "Columns", - "description": "The number of columns to display", - "isOptional": true, - "defaultValue": "{xs: 6, sm: 6, md: 6, lg: 6, xl: 6}" - }, - { - "filePath": "polaris-react/src/components/Columns/Columns.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "Elements to display inside columns", - "isOptional": true - } - ], - "value": "export interface ColumnsProps {\n /** The spacing between columns\n * @default '4'\n */\n gap?: Gap;\n /** The number of columns to display\n * @default {xs: 6, sm: 6, md: 6, lg: 6, xl: 6}\n */\n columns?: Columns;\n /** Elements to display inside columns */\n children?: React.ReactNode;\n}" - } - }, "ComboboxProps": { "polaris-react/src/components/Combobox/Combobox.tsx": { "filePath": "polaris-react/src/components/Combobox/Combobox.tsx", @@ -12149,134 +12149,57 @@ "value": "export interface DataTableProps {\n /** List of data types, which determines content alignment for each column. Data types are \"text,\" which aligns left, or \"numeric,\" which aligns right. */\n columnContentTypes: ColumnContentType[];\n /** List of column headings. */\n headings: React.ReactNode[];\n /** List of numeric column totals, highlighted in the table’s header below column headings. Use empty strings as placeholders for columns with no total. */\n totals?: TableData[];\n /** Custom totals row heading */\n totalsName?: {\n singular: React.ReactNode;\n plural: React.ReactNode;\n };\n /** Placement of totals row within table */\n showTotalsInFooter?: boolean;\n /** Lists of data points which map to table body rows. */\n rows: TableData[][];\n /** Hide column visibility and navigation buttons above the header when the table horizontally collapses to be scrollable.\n * @default false\n */\n hideScrollIndicator?: boolean;\n /** Truncate content in first column instead of wrapping.\n * @default true\n */\n truncate?: boolean;\n /** Vertical alignment of content in the cells.\n * @default 'top'\n */\n verticalAlign?: VerticalAlign;\n /** Content centered in the full width cell of the table footer row. */\n footerContent?: TableData;\n /** Table row has hover state. Defaults to true. */\n hoverable?: boolean;\n /** List of booleans, which maps to whether sorting is enabled or not for each column. Defaults to false for all columns. */\n sortable?: boolean[];\n /**\n * The direction to sort the table rows on first click or keypress of a sortable column heading. Defaults to ascending.\n * @default 'ascending'\n */\n defaultSortDirection?: SortDirection;\n /**\n * The index of the heading that the table rows are initially sorted by. Defaults to the first column.\n * @default 0\n */\n initialSortColumnIndex?: number;\n /** Callback fired on click or keypress of a sortable column heading. */\n onSort?(headingIndex: number, direction: SortDirection): void;\n /** Increased density */\n increasedTableDensity?: boolean;\n /** Add zebra striping to data rows */\n hasZebraStripingOnData?: boolean;\n /** Header becomes sticky and pins to top of table when scrolling */\n stickyHeader?: boolean;\n /** @deprecated Add a fixed first column on horizontal scroll. Use fixedFirstColumns={n} instead. */\n hasFixedFirstColumn?: boolean;\n /** Add fixed columns on horizontal scroll. */\n fixedFirstColumns?: number;\n /** Specify a min width for the first column if neccessary */\n firstColumnMinWidth?: string;\n}" } }, - "DatePickerProps": { - "polaris-react/src/components/DatePicker/DatePicker.tsx": { - "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", - "name": "DatePickerProps", + "DisplayTextProps": { + "polaris-react/src/components/DisplayText/DisplayText.tsx": { + "filePath": "polaris-react/src/components/DisplayText/DisplayText.tsx", + "name": "DisplayTextProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", + "filePath": "polaris-react/src/components/DisplayText/DisplayText.tsx", "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "ID for the element", - "isOptional": true + "name": "element", + "value": "HeadingTagName", + "description": "Name of element to use for text", + "isOptional": true, + "defaultValue": "'p'" }, { - "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", + "filePath": "polaris-react/src/components/DisplayText/DisplayText.tsx", "syntaxKind": "PropertySignature", - "name": "selected", - "value": "Range | Date", - "description": "The selected date or range of dates", - "isOptional": true + "name": "size", + "value": "Size", + "description": "Size of the text", + "isOptional": true, + "defaultValue": "'medium'" }, { - "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", + "filePath": "polaris-react/src/components/DisplayText/DisplayText.tsx", "syntaxKind": "PropertySignature", - "name": "month", - "value": "number", - "description": "The month to show, from 0 to 11. 0 is January, 1 is February ... 11 is December" - }, + "name": "children", + "value": "React.ReactNode", + "description": "Content to display", + "isOptional": true + } + ], + "value": "export interface DisplayTextProps {\n /**\n * Name of element to use for text\n * @default 'p'\n */\n element?: HeadingTagName;\n /**\n * Size of the text\n * @default 'medium'\n */\n size?: Size;\n /** Content to display */\n children?: React.ReactNode;\n}" + } + }, + "Item": { + "polaris-react/src/components/DescriptionList/DescriptionList.tsx": { + "filePath": "polaris-react/src/components/DescriptionList/DescriptionList.tsx", + "name": "Item", + "description": "", + "members": [ { - "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", + "filePath": "polaris-react/src/components/DescriptionList/DescriptionList.tsx", "syntaxKind": "PropertySignature", - "name": "year", - "value": "number", - "description": "The year to show" + "name": "term", + "value": "React.ReactNode", + "description": "Title of the item" }, { - "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", - "syntaxKind": "PropertySignature", - "name": "allowRange", - "value": "boolean", - "description": "Allow a range of dates to be selected", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", - "syntaxKind": "PropertySignature", - "name": "disableDatesBefore", - "value": "Date", - "description": "Disable selecting dates before this.", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", - "syntaxKind": "PropertySignature", - "name": "disableDatesAfter", - "value": "Date", - "description": "Disable selecting dates after this.", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", - "syntaxKind": "PropertySignature", - "name": "disableSpecificDates", - "value": "Date[]", - "description": "Disable specific dates.", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", - "syntaxKind": "PropertySignature", - "name": "multiMonth", - "value": "boolean", - "description": "The selection can span multiple months", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", - "syntaxKind": "PropertySignature", - "name": "weekStartsOn", - "value": "number", - "description": "First day of week, from 0 to 6. 0 is Sunday, 1 is Monday ... 6 is Saturday", - "isOptional": true, - "defaultValue": "0" - }, - { - "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", - "syntaxKind": "PropertySignature", - "name": "dayAccessibilityLabelPrefix", - "value": "string", - "description": "Visually hidden prefix text for selected days on single selection date pickers", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", - "syntaxKind": "MethodSignature", - "name": "onChange", - "value": "(date: Range) => void", - "description": "Callback when date is selected.", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", - "syntaxKind": "MethodSignature", - "name": "onMonthChange", - "value": "(month: number, year: number) => void", - "description": "Callback when month is changed.", - "isOptional": true - } - ], - "value": "export interface DatePickerProps {\n /** ID for the element */\n id?: string;\n /** The selected date or range of dates */\n selected?: Date | Range;\n /** The month to show, from 0 to 11. 0 is January, 1 is February ... 11 is December */\n month: number;\n /** The year to show */\n year: number;\n /** Allow a range of dates to be selected */\n allowRange?: boolean;\n /** Disable selecting dates before this. */\n disableDatesBefore?: Date;\n /** Disable selecting dates after this. */\n disableDatesAfter?: Date;\n /** Disable specific dates. */\n disableSpecificDates?: Date[];\n /** The selection can span multiple months */\n multiMonth?: boolean;\n /**\n * First day of week, from 0 to 6. 0 is Sunday, 1 is Monday ... 6 is Saturday\n * @default 0\n */\n weekStartsOn?: number;\n /** Visually hidden prefix text for selected days on single selection date pickers */\n dayAccessibilityLabelPrefix?: string;\n /** Callback when date is selected. */\n onChange?(date: Range): void;\n /** Callback when month is changed. */\n onMonthChange?(month: number, year: number): void;\n}" - } - }, - "Item": { - "polaris-react/src/components/DescriptionList/DescriptionList.tsx": { - "filePath": "polaris-react/src/components/DescriptionList/DescriptionList.tsx", - "name": "Item", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/DescriptionList/DescriptionList.tsx", - "syntaxKind": "PropertySignature", - "name": "term", - "value": "React.ReactNode", - "description": "Title of the item" - }, - { - "filePath": "polaris-react/src/components/DescriptionList/DescriptionList.tsx", + "filePath": "polaris-react/src/components/DescriptionList/DescriptionList.tsx", "syntaxKind": "PropertySignature", "name": "description", "value": "React.ReactNode", @@ -12359,40 +12282,117 @@ "value": "export interface DescriptionListProps {\n /** Collection of items for list */\n items: Item[];\n /** Determines the spacing between list items */\n spacing?: 'tight' | 'loose';\n}" } }, - "DisplayTextProps": { - "polaris-react/src/components/DisplayText/DisplayText.tsx": { - "filePath": "polaris-react/src/components/DisplayText/DisplayText.tsx", - "name": "DisplayTextProps", + "DatePickerProps": { + "polaris-react/src/components/DatePicker/DatePicker.tsx": { + "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", + "name": "DatePickerProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/DisplayText/DisplayText.tsx", + "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", "syntaxKind": "PropertySignature", - "name": "element", - "value": "HeadingTagName", - "description": "Name of element to use for text", - "isOptional": true, - "defaultValue": "'p'" + "name": "id", + "value": "string", + "description": "ID for the element", + "isOptional": true }, { - "filePath": "polaris-react/src/components/DisplayText/DisplayText.tsx", + "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", "syntaxKind": "PropertySignature", - "name": "size", - "value": "Size", - "description": "Size of the text", + "name": "selected", + "value": "Range | Date", + "description": "The selected date or range of dates", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", + "syntaxKind": "PropertySignature", + "name": "month", + "value": "number", + "description": "The month to show, from 0 to 11. 0 is January, 1 is February ... 11 is December" + }, + { + "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", + "syntaxKind": "PropertySignature", + "name": "year", + "value": "number", + "description": "The year to show" + }, + { + "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", + "syntaxKind": "PropertySignature", + "name": "allowRange", + "value": "boolean", + "description": "Allow a range of dates to be selected", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", + "syntaxKind": "PropertySignature", + "name": "disableDatesBefore", + "value": "Date", + "description": "Disable selecting dates before this.", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", + "syntaxKind": "PropertySignature", + "name": "disableDatesAfter", + "value": "Date", + "description": "Disable selecting dates after this.", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", + "syntaxKind": "PropertySignature", + "name": "disableSpecificDates", + "value": "Date[]", + "description": "Disable specific dates.", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", + "syntaxKind": "PropertySignature", + "name": "multiMonth", + "value": "boolean", + "description": "The selection can span multiple months", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", + "syntaxKind": "PropertySignature", + "name": "weekStartsOn", + "value": "number", + "description": "First day of week, from 0 to 6. 0 is Sunday, 1 is Monday ... 6 is Saturday", "isOptional": true, - "defaultValue": "'medium'" + "defaultValue": "0" }, { - "filePath": "polaris-react/src/components/DisplayText/DisplayText.tsx", + "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "Content to display", + "name": "dayAccessibilityLabelPrefix", + "value": "string", + "description": "Visually hidden prefix text for selected days on single selection date pickers", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", + "syntaxKind": "MethodSignature", + "name": "onChange", + "value": "(date: Range) => void", + "description": "Callback when date is selected.", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", + "syntaxKind": "MethodSignature", + "name": "onMonthChange", + "value": "(month: number, year: number) => void", + "description": "Callback when month is changed.", "isOptional": true } ], - "value": "export interface DisplayTextProps {\n /**\n * Name of element to use for text\n * @default 'p'\n */\n element?: HeadingTagName;\n /**\n * Size of the text\n * @default 'medium'\n */\n size?: Size;\n /** Content to display */\n children?: React.ReactNode;\n}" + "value": "export interface DatePickerProps {\n /** ID for the element */\n id?: string;\n /** The selected date or range of dates */\n selected?: Date | Range;\n /** The month to show, from 0 to 11. 0 is January, 1 is February ... 11 is December */\n month: number;\n /** The year to show */\n year: number;\n /** Allow a range of dates to be selected */\n allowRange?: boolean;\n /** Disable selecting dates before this. */\n disableDatesBefore?: Date;\n /** Disable selecting dates after this. */\n disableDatesAfter?: Date;\n /** Disable specific dates. */\n disableSpecificDates?: Date[];\n /** The selection can span multiple months */\n multiMonth?: boolean;\n /**\n * First day of week, from 0 to 6. 0 is Sunday, 1 is Monday ... 6 is Saturday\n * @default 0\n */\n weekStartsOn?: number;\n /** Visually hidden prefix text for selected days on single selection date pickers */\n dayAccessibilityLabelPrefix?: string;\n /** Callback when date is selected. */\n onChange?(date: Range): void;\n /** Callback when month is changed. */\n onMonthChange?(month: number, year: number): void;\n}" } }, "DropZoneFileType": { @@ -14435,23 +14435,6 @@ "description": "" } }, - "KonamiCodeProps": { - "polaris-react/src/components/KonamiCode/KonamiCode.tsx": { - "filePath": "polaris-react/src/components/KonamiCode/KonamiCode.tsx", - "name": "KonamiCodeProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/KonamiCode/KonamiCode.tsx", - "syntaxKind": "MethodSignature", - "name": "handler", - "value": "(event: KeyboardEvent) => void", - "description": "" - } - ], - "value": "export interface KonamiCodeProps {\n handler(event: KeyboardEvent): void;\n}" - } - }, "LabelProps": { "polaris-react/src/components/Label/Label.tsx": { "filePath": "polaris-react/src/components/Label/Label.tsx", @@ -14565,6 +14548,23 @@ "value": "export interface LabelledProps {\n /** A unique identifier for the label */\n id: LabelProps['id'];\n /** Text for the label */\n label: React.ReactNode;\n /** Error to display beneath the label */\n error?: Error | boolean;\n /** An action */\n action?: Action;\n /** Additional hint text to display */\n helpText?: React.ReactNode;\n /** Content to display inside the connected */\n children?: React.ReactNode;\n /** Visually hide the label */\n labelHidden?: boolean;\n /** Visual required indicator for the label */\n requiredIndicator?: boolean;\n}" } }, + "KonamiCodeProps": { + "polaris-react/src/components/KonamiCode/KonamiCode.tsx": { + "filePath": "polaris-react/src/components/KonamiCode/KonamiCode.tsx", + "name": "KonamiCodeProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/KonamiCode/KonamiCode.tsx", + "syntaxKind": "MethodSignature", + "name": "handler", + "value": "(event: KeyboardEvent) => void", + "description": "" + } + ], + "value": "export interface KonamiCodeProps {\n handler(event: KeyboardEvent): void;\n}" + } + }, "LayoutProps": { "polaris-react/src/components/Layout/Layout.tsx": { "filePath": "polaris-react/src/components/Layout/Layout.tsx", @@ -14591,88 +14591,6 @@ "value": "export interface LayoutProps {\n /** Automatically adds sections to layout. */\n sectioned?: boolean;\n /** The content to display inside the layout. */\n children?: React.ReactNode;\n}" } }, - "LinkProps": { - "polaris-react/src/components/Link/Link.tsx": { - "filePath": "polaris-react/src/components/Link/Link.tsx", - "name": "LinkProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Link/Link.tsx", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "ID for the link", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Link/Link.tsx", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "The url to link to", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Link/Link.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "The content to display inside the link", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Link/Link.tsx", - "syntaxKind": "PropertySignature", - "name": "external", - "value": "boolean", - "description": "Makes the link open in a new tab", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Link/Link.tsx", - "syntaxKind": "PropertySignature", - "name": "monochrome", - "value": "boolean", - "description": "Makes the link color the same as the current text color and adds an underline", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Link/Link.tsx", - "syntaxKind": "PropertySignature", - "name": "removeUnderline", - "value": "boolean", - "description": "Removes text decoration underline to the link", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Link/Link.tsx", - "syntaxKind": "MethodSignature", - "name": "onClick", - "value": "() => void", - "description": "Callback when a link is clicked", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Link/Link.tsx", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "Descriptive text to be read to screenreaders", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Link/Link.tsx", - "syntaxKind": "PropertySignature", - "name": "dataPrimaryLink", - "value": "boolean", - "description": "Indicates whether or not the link is the primary navigation link when rendered inside of an `IndexTable.Row`", - "isOptional": true - } - ], - "value": "export interface LinkProps {\n /** ID for the link */\n id?: string;\n /** The url to link to */\n url?: string;\n /** The content to display inside the link */\n children?: React.ReactNode;\n /** Makes the link open in a new tab */\n external?: boolean;\n /** Makes the link color the same as the current text color and adds an underline */\n monochrome?: boolean;\n /** Removes text decoration underline to the link*/\n removeUnderline?: boolean;\n /** Callback when a link is clicked */\n onClick?(): void;\n /** Descriptive text to be read to screenreaders */\n accessibilityLabel?: string;\n /** Indicates whether or not the link is the primary navigation link when rendered inside of an `IndexTable.Row` */\n dataPrimaryLink?: boolean;\n}" - } - }, "Type": { "polaris-react/src/components/List/List.tsx": { "filePath": "polaris-react/src/components/List/List.tsx", @@ -14754,6 +14672,88 @@ "value": "export interface ListProps {\n focusIndex: number;\n disclosureTabs: TabDescriptor[];\n onClick?(id: string): void;\n onKeyPress?(event: React.KeyboardEvent): void;\n}" } }, + "LinkProps": { + "polaris-react/src/components/Link/Link.tsx": { + "filePath": "polaris-react/src/components/Link/Link.tsx", + "name": "LinkProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Link/Link.tsx", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "ID for the link", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Link/Link.tsx", + "syntaxKind": "PropertySignature", + "name": "url", + "value": "string", + "description": "The url to link to", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Link/Link.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "The content to display inside the link", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Link/Link.tsx", + "syntaxKind": "PropertySignature", + "name": "external", + "value": "boolean", + "description": "Makes the link open in a new tab", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Link/Link.tsx", + "syntaxKind": "PropertySignature", + "name": "monochrome", + "value": "boolean", + "description": "Makes the link color the same as the current text color and adds an underline", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Link/Link.tsx", + "syntaxKind": "PropertySignature", + "name": "removeUnderline", + "value": "boolean", + "description": "Removes text decoration underline to the link", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Link/Link.tsx", + "syntaxKind": "MethodSignature", + "name": "onClick", + "value": "() => void", + "description": "Callback when a link is clicked", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Link/Link.tsx", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "Descriptive text to be read to screenreaders", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Link/Link.tsx", + "syntaxKind": "PropertySignature", + "name": "dataPrimaryLink", + "value": "boolean", + "description": "Indicates whether or not the link is the primary navigation link when rendered inside of an `IndexTable.Row`", + "isOptional": true + } + ], + "value": "export interface LinkProps {\n /** ID for the link */\n id?: string;\n /** The url to link to */\n url?: string;\n /** The content to display inside the link */\n children?: React.ReactNode;\n /** Makes the link open in a new tab */\n external?: boolean;\n /** Makes the link color the same as the current text color and adds an underline */\n monochrome?: boolean;\n /** Removes text decoration underline to the link*/\n removeUnderline?: boolean;\n /** Callback when a link is clicked */\n onClick?(): void;\n /** Descriptive text to be read to screenreaders */\n accessibilityLabel?: string;\n /** Indicates whether or not the link is the primary navigation link when rendered inside of an `IndexTable.Row` */\n dataPrimaryLink?: boolean;\n}" + } + }, "AutoSelection": { "polaris-react/src/components/Listbox/Listbox.tsx": { "filePath": "polaris-react/src/components/Listbox/Listbox.tsx", @@ -17513,6 +17513,25 @@ "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}" } }, + "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}" + } + }, "SheetProps": { "polaris-react/src/components/Sheet/Sheet.tsx": { "filePath": "polaris-react/src/components/Sheet/Sheet.tsx", @@ -17575,25 +17594,6 @@ "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", @@ -17939,15 +17939,6 @@ "value": "export interface TabsProps {\n /** Content to display in tabs */\n children?: React.ReactNode;\n /** Index of selected tab */\n selected: number;\n /** List of tabs */\n tabs: TabDescriptor[];\n /** Fit tabs to container */\n fitted?: boolean;\n /** Text to replace disclosures horizontal dots */\n disclosureText?: string;\n /** Callback when tab is selected */\n onSelect?(selectedTabIndex: number): void;\n}" } }, - "TagProps": { - "polaris-react/src/components/Tag/Tag.tsx": { - "filePath": "polaris-react/src/components/Tag/Tag.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "TagProps", - "value": "NonMutuallyExclusiveProps & (\n | {onClick?(): void; onRemove?: undefined; url?: undefined}\n | {onClick?: undefined; onRemove?(): void; url?: string}\n )", - "description": "" - } - }, "Variant": { "polaris-react/src/components/Text/Text.tsx": { "filePath": "polaris-react/src/components/Text/Text.tsx", @@ -18204,6 +18195,56 @@ "description": "" } }, + "TagProps": { + "polaris-react/src/components/Tag/Tag.tsx": { + "filePath": "polaris-react/src/components/Tag/Tag.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "TagProps", + "value": "NonMutuallyExclusiveProps & (\n | {onClick?(): void; onRemove?: undefined; url?: undefined}\n | {onClick?: undefined; onRemove?(): void; url?: string}\n )", + "description": "" + } + }, + "ThumbnailProps": { + "polaris-react/src/components/Thumbnail/Thumbnail.tsx": { + "filePath": "polaris-react/src/components/Thumbnail/Thumbnail.tsx", + "name": "ThumbnailProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Thumbnail/Thumbnail.tsx", + "syntaxKind": "PropertySignature", + "name": "size", + "value": "Size", + "description": "Size of thumbnail", + "isOptional": true, + "defaultValue": "'medium'" + }, + { + "filePath": "polaris-react/src/components/Thumbnail/Thumbnail.tsx", + "syntaxKind": "PropertySignature", + "name": "source", + "value": "any", + "description": "URL for the image" + }, + { + "filePath": "polaris-react/src/components/Thumbnail/Thumbnail.tsx", + "syntaxKind": "PropertySignature", + "name": "alt", + "value": "string", + "description": "Alt text for the thumbnail image" + }, + { + "filePath": "polaris-react/src/components/Thumbnail/Thumbnail.tsx", + "syntaxKind": "PropertySignature", + "name": "transparent", + "value": "boolean", + "description": "Transparent background", + "isOptional": true + } + ], + "value": "export interface ThumbnailProps {\n /**\n * Size of thumbnail\n * @default 'medium'\n */\n size?: Size;\n /** URL for the image */\n source: string | React.FunctionComponent>;\n /** Alt text for the thumbnail image */\n alt: string;\n /** Transparent background */\n transparent?: boolean;\n}" + } + }, "Variation": { "polaris-react/src/components/TextStyle/TextStyle.tsx": { "filePath": "polaris-react/src/components/TextStyle/TextStyle.tsx", @@ -18279,88 +18320,14 @@ "value": "export interface TextStyleProps {\n /** Give text additional visual meaning */\n variation?: Variation;\n /** The content that should get the intended styling */\n children?: React.ReactNode;\n}" } }, - "ThumbnailProps": { - "polaris-react/src/components/Thumbnail/Thumbnail.tsx": { - "filePath": "polaris-react/src/components/Thumbnail/Thumbnail.tsx", - "name": "ThumbnailProps", + "TooltipProps": { + "polaris-react/src/components/Tooltip/Tooltip.tsx": { + "filePath": "polaris-react/src/components/Tooltip/Tooltip.tsx", + "name": "TooltipProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/Thumbnail/Thumbnail.tsx", - "syntaxKind": "PropertySignature", - "name": "size", - "value": "Size", - "description": "Size of thumbnail", - "isOptional": true, - "defaultValue": "'medium'" - }, - { - "filePath": "polaris-react/src/components/Thumbnail/Thumbnail.tsx", - "syntaxKind": "PropertySignature", - "name": "source", - "value": "any", - "description": "URL for the image" - }, - { - "filePath": "polaris-react/src/components/Thumbnail/Thumbnail.tsx", - "syntaxKind": "PropertySignature", - "name": "alt", - "value": "string", - "description": "Alt text for the thumbnail image" - }, - { - "filePath": "polaris-react/src/components/Thumbnail/Thumbnail.tsx", - "syntaxKind": "PropertySignature", - "name": "transparent", - "value": "boolean", - "description": "Transparent background", - "isOptional": true - } - ], - "value": "export interface ThumbnailProps {\n /**\n * Size of thumbnail\n * @default 'medium'\n */\n size?: Size;\n /** URL for the image */\n source: string | React.FunctionComponent>;\n /** Alt text for the thumbnail image */\n alt: string;\n /** Transparent background */\n transparent?: boolean;\n}" - } - }, - "TilesProps": { - "polaris-react/src/components/Tiles/Tiles.tsx": { - "filePath": "polaris-react/src/components/Tiles/Tiles.tsx", - "name": "TilesProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Tiles/Tiles.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "Elements to display inside tile" - }, - { - "filePath": "polaris-react/src/components/Tiles/Tiles.tsx", - "syntaxKind": "PropertySignature", - "name": "gap", - "value": "Gap", - "description": "Adjust spacing between elements", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Tiles/Tiles.tsx", - "syntaxKind": "PropertySignature", - "name": "columns", - "value": "Columns", - "description": "Adjust number of columns", - "isOptional": true - } - ], - "value": "export interface TilesProps {\n /** Elements to display inside tile */\n children: React.ReactNode;\n /** Adjust spacing between elements */\n gap?: Gap;\n /** Adjust number of columns */\n columns?: Columns;\n}" - } - }, - "TooltipProps": { - "polaris-react/src/components/Tooltip/Tooltip.tsx": { - "filePath": "polaris-react/src/components/Tooltip/Tooltip.tsx", - "name": "TooltipProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Tooltip/Tooltip.tsx", + "filePath": "polaris-react/src/components/Tooltip/Tooltip.tsx", "syntaxKind": "PropertySignature", "name": "children", "value": "React.ReactNode", @@ -18436,6 +18403,39 @@ "value": "export interface TooltipProps {\n /** The element that will activate to tooltip */\n children?: React.ReactNode;\n /** The content to display within the tooltip */\n content: React.ReactNode;\n /** Toggle whether the tooltip is visible */\n active?: boolean;\n /** Dismiss tooltip when not interacting with its children */\n dismissOnMouseOut?: TooltipOverlayProps['preventInteraction'];\n /**\n * The direction the tooltip tries to display\n * @default 'below'\n */\n preferredPosition?: TooltipOverlayProps['preferredPosition'];\n /**\n * The element type to wrap the activator in\n * @default 'span'\n */\n activatorWrapper?: string;\n /** Visually hidden text for screen readers */\n accessibilityLabel?: string;\n /* Callback fired when the tooltip is activated */\n onOpen?(): void;\n /* Callback fired when the tooltip is dismissed */\n onClose?(): void;\n}" } }, + "TilesProps": { + "polaris-react/src/components/Tiles/Tiles.tsx": { + "filePath": "polaris-react/src/components/Tiles/Tiles.tsx", + "name": "TilesProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Tiles/Tiles.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "Elements to display inside tile" + }, + { + "filePath": "polaris-react/src/components/Tiles/Tiles.tsx", + "syntaxKind": "PropertySignature", + "name": "gap", + "value": "Gap", + "description": "Adjust spacing between elements", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Tiles/Tiles.tsx", + "syntaxKind": "PropertySignature", + "name": "columns", + "value": "Columns", + "description": "Adjust number of columns", + "isOptional": true + } + ], + "value": "export interface TilesProps {\n /** Elements to display inside tile */\n children: React.ReactNode;\n /** Adjust spacing between elements */\n gap?: Gap;\n /** Adjust number of columns */\n columns?: Columns;\n}" + } + }, "TopBarProps": { "polaris-react/src/components/TopBar/TopBar.tsx": { "filePath": "polaris-react/src/components/TopBar/TopBar.tsx", @@ -18541,255 +18541,40 @@ "description": "", "members": [ { - "filePath": "polaris-react/src/components/TrapFocus/TrapFocus.tsx", - "syntaxKind": "PropertySignature", - "name": "trapping", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/TrapFocus/TrapFocus.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", - "isOptional": true - } - ], - "value": "export interface TrapFocusProps {\n trapping?: boolean;\n children?: React.ReactNode;\n}" - } - }, - "TruncateProps": { - "polaris-react/src/components/Truncate/Truncate.tsx": { - "filePath": "polaris-react/src/components/Truncate/Truncate.tsx", - "name": "TruncateProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Truncate/Truncate.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "" - } - ], - "value": "export interface TruncateProps {\n children: React.ReactNode;\n}" - } - }, - "UnstyledButtonProps": { - "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx": { - "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", - "name": "UnstyledButtonProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", - "name": "[key: string]", - "value": "any" - }, - { - "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "The content to display inside the button", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", - "syntaxKind": "PropertySignature", - "name": "className", - "value": "string", - "description": "A custom class name to apply styles to button", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the button", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "A destination to link to, rendered in the href attribute of a link", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", - "syntaxKind": "PropertySignature", - "name": "external", - "value": "boolean", - "description": "Forces url to open in a new tab", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", - "syntaxKind": "PropertySignature", - "name": "download", - "value": "string | boolean", - "description": "Tells the browser to download the url instead of opening it. Provides a hint for the downloaded filename if it is a string value", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", - "syntaxKind": "PropertySignature", - "name": "submit", - "value": "boolean", - "description": "Allows the button to submit a form", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "Disables the button, disallowing merchant interaction", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", - "syntaxKind": "PropertySignature", - "name": "loading", - "value": "boolean", - "description": "Replaces button text with a spinner while a background action is being performed", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", - "syntaxKind": "PropertySignature", - "name": "pressed", - "value": "boolean", - "description": "Sets the button in a pressed state", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "Visually hidden text for screen readers", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", - "syntaxKind": "PropertySignature", - "name": "role", - "value": "string", - "description": "A valid WAI-ARIA role to define the semantic value of this element", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", - "syntaxKind": "PropertySignature", - "name": "ariaControls", - "value": "string", - "description": "Id of the element the button controls", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", - "syntaxKind": "PropertySignature", - "name": "ariaExpanded", - "value": "boolean", - "description": "Tells screen reader the controlled element is expanded", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", - "syntaxKind": "PropertySignature", - "name": "ariaDescribedBy", - "value": "string", - "description": "Indicates the ID of the element that describes the button", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", - "syntaxKind": "PropertySignature", - "name": "ariaChecked", - "value": "\"false\" | \"true\"", - "description": "Indicates the current checked state of the button when acting as a toggle or switch", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", - "syntaxKind": "MethodSignature", - "name": "onClick", - "value": "() => void", - "description": "Callback when clicked", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", - "syntaxKind": "MethodSignature", - "name": "onFocus", - "value": "() => void", - "description": "Callback when button becomes focussed", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", - "syntaxKind": "MethodSignature", - "name": "onBlur", - "value": "() => void", - "description": "Callback when focus leaves button", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", - "syntaxKind": "MethodSignature", - "name": "onKeyPress", - "value": "(event: React.KeyboardEvent) => void", - "description": "Callback when a keypress event is registered on the button", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", - "syntaxKind": "MethodSignature", - "name": "onKeyUp", - "value": "(event: React.KeyboardEvent) => void", - "description": "Callback when a keyup event is registered on the button", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", - "syntaxKind": "MethodSignature", - "name": "onKeyDown", - "value": "(event: React.KeyboardEvent) => void", - "description": "Callback when a keydown event is registered on the button", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", - "syntaxKind": "MethodSignature", - "name": "onMouseEnter", - "value": "() => void", - "description": "Callback when mouse enter", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", - "syntaxKind": "MethodSignature", - "name": "onTouchStart", - "value": "() => void", - "description": "Callback when element is touched", + "filePath": "polaris-react/src/components/TrapFocus/TrapFocus.tsx", + "syntaxKind": "PropertySignature", + "name": "trapping", + "value": "boolean", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", - "syntaxKind": "MethodSignature", - "name": "onPointerDown", - "value": "() => void", - "description": "Callback when pointerdown event is being triggered", + "filePath": "polaris-react/src/components/TrapFocus/TrapFocus.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "", "isOptional": true } ], - "value": "export interface UnstyledButtonProps extends BaseButton {\n /** The content to display inside the button */\n children?: React.ReactNode;\n /** A custom class name to apply styles to button */\n className?: string;\n [key: string]: any;\n}" + "value": "export interface TrapFocusProps {\n trapping?: boolean;\n children?: React.ReactNode;\n}" + } + }, + "TruncateProps": { + "polaris-react/src/components/Truncate/Truncate.tsx": { + "filePath": "polaris-react/src/components/Truncate/Truncate.tsx", + "name": "TruncateProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Truncate/Truncate.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "" + } + ], + "value": "export interface TruncateProps {\n children: React.ReactNode;\n}" } }, "UnstyledLinkProps": { @@ -21709,6 +21494,221 @@ "value": "export interface UnstyledLinkProps extends LinkLikeComponentProps {}" } }, + "UnstyledButtonProps": { + "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx": { + "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", + "name": "UnstyledButtonProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", + "name": "[key: string]", + "value": "any" + }, + { + "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "The content to display inside the button", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", + "syntaxKind": "PropertySignature", + "name": "className", + "value": "string", + "description": "A custom class name to apply styles to button", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the button", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", + "syntaxKind": "PropertySignature", + "name": "url", + "value": "string", + "description": "A destination to link to, rendered in the href attribute of a link", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", + "syntaxKind": "PropertySignature", + "name": "external", + "value": "boolean", + "description": "Forces url to open in a new tab", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", + "syntaxKind": "PropertySignature", + "name": "download", + "value": "string | boolean", + "description": "Tells the browser to download the url instead of opening it. Provides a hint for the downloaded filename if it is a string value", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", + "syntaxKind": "PropertySignature", + "name": "submit", + "value": "boolean", + "description": "Allows the button to submit a form", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Disables the button, disallowing merchant interaction", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", + "syntaxKind": "PropertySignature", + "name": "loading", + "value": "boolean", + "description": "Replaces button text with a spinner while a background action is being performed", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", + "syntaxKind": "PropertySignature", + "name": "pressed", + "value": "boolean", + "description": "Sets the button in a pressed state", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "Visually hidden text for screen readers", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", + "syntaxKind": "PropertySignature", + "name": "role", + "value": "string", + "description": "A valid WAI-ARIA role to define the semantic value of this element", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", + "syntaxKind": "PropertySignature", + "name": "ariaControls", + "value": "string", + "description": "Id of the element the button controls", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", + "syntaxKind": "PropertySignature", + "name": "ariaExpanded", + "value": "boolean", + "description": "Tells screen reader the controlled element is expanded", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", + "syntaxKind": "PropertySignature", + "name": "ariaDescribedBy", + "value": "string", + "description": "Indicates the ID of the element that describes the button", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", + "syntaxKind": "PropertySignature", + "name": "ariaChecked", + "value": "\"false\" | \"true\"", + "description": "Indicates the current checked state of the button when acting as a toggle or switch", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", + "syntaxKind": "MethodSignature", + "name": "onClick", + "value": "() => void", + "description": "Callback when clicked", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", + "syntaxKind": "MethodSignature", + "name": "onFocus", + "value": "() => void", + "description": "Callback when button becomes focussed", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", + "syntaxKind": "MethodSignature", + "name": "onBlur", + "value": "() => void", + "description": "Callback when focus leaves button", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", + "syntaxKind": "MethodSignature", + "name": "onKeyPress", + "value": "(event: React.KeyboardEvent) => void", + "description": "Callback when a keypress event is registered on the button", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", + "syntaxKind": "MethodSignature", + "name": "onKeyUp", + "value": "(event: React.KeyboardEvent) => void", + "description": "Callback when a keyup event is registered on the button", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", + "syntaxKind": "MethodSignature", + "name": "onKeyDown", + "value": "(event: React.KeyboardEvent) => void", + "description": "Callback when a keydown event is registered on the button", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", + "syntaxKind": "MethodSignature", + "name": "onMouseEnter", + "value": "() => void", + "description": "Callback when mouse enter", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", + "syntaxKind": "MethodSignature", + "name": "onTouchStart", + "value": "() => void", + "description": "Callback when element is touched", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", + "syntaxKind": "MethodSignature", + "name": "onPointerDown", + "value": "() => void", + "description": "Callback when pointerdown event is being triggered", + "isOptional": true + } + ], + "value": "export interface UnstyledButtonProps extends BaseButton {\n /** The content to display inside the button */\n children?: React.ReactNode;\n /** A custom class name to apply styles to button */\n className?: string;\n [key: string]: any;\n}" + } + }, "VideoThumbnailProps": { "polaris-react/src/components/VideoThumbnail/VideoThumbnail.tsx": { "filePath": "polaris-react/src/components/VideoThumbnail/VideoThumbnail.tsx", @@ -22203,6 +22203,14 @@ "description": "", "isOptional": true }, + { + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "syntaxKind": "PropertySignature", + "name": "truncateText", + "value": "boolean", + "description": "", + "isOptional": true + }, { "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", @@ -22244,7 +22252,7 @@ "isOptional": true } ], - "value": "export interface ItemProps extends ItemURLDetails {\n icon?: IconProps['source'];\n badge?: ReactNode;\n label: string;\n disabled?: boolean;\n accessibilityLabel?: string;\n selected?: boolean;\n exactMatch?: boolean;\n new?: boolean;\n subNavigationItems?: SubNavigationItem[];\n secondaryAction?: SecondaryAction;\n onClick?(): void;\n onToggleExpandedState?(): void;\n expanded?: boolean;\n shouldResizeIcon?: boolean;\n}" + "value": "export interface ItemProps extends ItemURLDetails {\n icon?: IconProps['source'];\n badge?: ReactNode;\n label: string;\n disabled?: boolean;\n accessibilityLabel?: string;\n selected?: boolean;\n exactMatch?: boolean;\n new?: boolean;\n subNavigationItems?: SubNavigationItem[];\n secondaryAction?: SecondaryAction;\n onClick?(): void;\n onToggleExpandedState?(): void;\n expanded?: boolean;\n shouldResizeIcon?: boolean;\n truncateText?: boolean;\n}" }, "polaris-react/src/components/Stack/components/Item/Item.tsx": { "filePath": "polaris-react/src/components/Stack/components/Item/Item.tsx", @@ -22587,64 +22595,6 @@ "value": "export interface SectionProps {\n children?: React.ReactNode;\n}" } }, - "MeasuredActions": { - "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx": { - "filePath": "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx", - "name": "MeasuredActions", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx", - "syntaxKind": "PropertySignature", - "name": "showable", - "value": "MenuActionDescriptor[]", - "description": "" - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx", - "syntaxKind": "PropertySignature", - "name": "rolledUp", - "value": "(MenuActionDescriptor | MenuGroupDescriptor)[]", - "description": "" - } - ], - "value": "interface MeasuredActions {\n showable: MenuActionDescriptor[];\n rolledUp: (MenuActionDescriptor | MenuGroupDescriptor)[];\n}" - } - }, - "RollupActionsProps": { - "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx": { - "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", - "name": "RollupActionsProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "Accessibilty label", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", - "syntaxKind": "PropertySignature", - "name": "items", - "value": "ActionListItemDescriptor[]", - "description": "Collection of actions for the list", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", - "syntaxKind": "PropertySignature", - "name": "sections", - "value": "ActionListSection[]", - "description": "Collection of sectioned action items", - "isOptional": true - } - ], - "value": "export interface RollupActionsProps {\n /** Accessibilty label */\n accessibilityLabel?: string;\n /** Collection of actions for the list */\n items?: ActionListItemDescriptor[];\n /** Collection of sectioned action items */\n sections?: ActionListSection[];\n}" - } - }, "MenuGroupProps": { "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx": { "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", @@ -22744,31 +22694,238 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "PropertySignature", - "name": "index", - "value": "number", - "description": "Zero-indexed numerical position. Overrides the group's order in the menu.", + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "index", + "value": "number", + "description": "Zero-indexed numerical position. Overrides the group's order in the menu.", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "onActionAnyItem", + "value": "() => void", + "description": "Callback when any action takes place", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "badge", + "value": "{ status: \"new\"; content: string; }", + "description": "", + "isOptional": true + } + ], + "value": "export interface MenuGroupProps extends MenuGroupDescriptor {\n /** Visually hidden menu description for screen readers */\n accessibilityLabel?: string;\n /** Whether or not the menu is open */\n active?: boolean;\n /** Callback when the menu is clicked */\n onClick?(openActions: () => void): void;\n /** Callback for opening the MenuGroup by title */\n onOpen(title: string): void;\n /** Callback for closing the MenuGroup by title */\n onClose(title: string): void;\n /** Callback for getting the offsetWidth of the MenuGroup */\n getOffsetWidth?(width: number): void;\n /** Collection of sectioned action items */\n sections?: readonly ActionListSection[];\n}" + } + }, + "RollupActionsProps": { + "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx": { + "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", + "name": "RollupActionsProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "Accessibilty label", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", + "syntaxKind": "PropertySignature", + "name": "items", + "value": "ActionListItemDescriptor[]", + "description": "Collection of actions for the list", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", + "syntaxKind": "PropertySignature", + "name": "sections", + "value": "ActionListSection[]", + "description": "Collection of sectioned action items", + "isOptional": true + } + ], + "value": "export interface RollupActionsProps {\n /** Accessibilty label */\n accessibilityLabel?: string;\n /** Collection of actions for the list */\n items?: ActionListItemDescriptor[];\n /** Collection of sectioned action items */\n sections?: ActionListSection[];\n}" + } + }, + "MappedAction": { + "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx": { + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "name": "MappedAction", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "syntaxKind": "PropertySignature", + "name": "wrapOverflow", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "Visually hidden text for screen readers", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "syntaxKind": "PropertySignature", + "name": "badge", + "value": "{ status: \"new\"; content: string; }", + "description": "", + "isOptional": true, + "deprecationMessage": "Badge component" + }, + { + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "syntaxKind": "PropertySignature", + "name": "helpText", + "value": "React.ReactNode", + "description": "Additional hint text to display with item", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "syntaxKind": "PropertySignature", + "name": "icon", + "value": "any", + "description": "", + "isOptional": true, + "deprecationMessage": "Source of the icon" + }, + { + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "syntaxKind": "PropertySignature", + "name": "image", + "value": "string", + "description": "", + "isOptional": true, + "deprecationMessage": "Image source" + }, + { + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "syntaxKind": "PropertySignature", + "name": "prefix", + "value": "React.ReactNode", + "description": "Prefix source", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "syntaxKind": "PropertySignature", + "name": "suffix", + "value": "React.ReactNode", + "description": "Suffix source", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "syntaxKind": "PropertySignature", + "name": "ellipsis", + "value": "boolean", + "description": "Add an ellipsis suffix to action content", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "syntaxKind": "PropertySignature", + "name": "active", + "value": "boolean", + "description": "Whether the action is active or not", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "syntaxKind": "PropertySignature", + "name": "role", + "value": "string", + "description": "Defines a role for the action", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether or not the action is disabled", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the action", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "syntaxKind": "PropertySignature", + "name": "content", + "value": "string", + "description": "Content the action displays", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "syntaxKind": "PropertySignature", + "name": "url", + "value": "string", + "description": "A destination to link to, rendered in the action", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "syntaxKind": "PropertySignature", + "name": "external", + "value": "boolean", + "description": "Forces url to open in a new tab", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onAction", + "value": "() => void", + "description": "Callback when an action takes place", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "PropertySignature", - "name": "onActionAnyItem", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onMouseEnter", "value": "() => void", - "description": "Callback when any action takes place", + "description": "Callback when mouse enter", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onTouchStart", + "value": "() => void", + "description": "Callback when element is touched", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", "syntaxKind": "PropertySignature", - "name": "badge", - "value": "{ status: \"new\"; content: string; }", - "description": "", + "name": "destructive", + "value": "boolean", + "description": "Destructive action", "isOptional": true } ], - "value": "export interface MenuGroupProps extends MenuGroupDescriptor {\n /** Visually hidden menu description for screen readers */\n accessibilityLabel?: string;\n /** Whether or not the menu is open */\n active?: boolean;\n /** Callback when the menu is clicked */\n onClick?(openActions: () => void): void;\n /** Callback for opening the MenuGroup by title */\n onOpen(title: string): void;\n /** Callback for closing the MenuGroup by title */\n onClose(title: string): void;\n /** Callback for getting the offsetWidth of the MenuGroup */\n getOffsetWidth?(width: number): void;\n /** Collection of sectioned action items */\n sections?: readonly ActionListSection[];\n}" + "value": "interface MappedAction extends ActionListItemDescriptor {\n wrapOverflow?: boolean;\n}" } }, "SecondaryAction": { @@ -23147,179 +23304,6 @@ "value": "interface SecondaryAction {\n url: string;\n accessibilityLabel: string;\n icon: IconProps['source'];\n onClick?(): void;\n tooltip?: TooltipProps;\n}" } }, - "MappedAction": { - "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx": { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", - "name": "MappedAction", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", - "syntaxKind": "PropertySignature", - "name": "wrapOverflow", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "Visually hidden text for screen readers", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", - "syntaxKind": "PropertySignature", - "name": "badge", - "value": "{ status: \"new\"; content: string; }", - "description": "", - "isOptional": true, - "deprecationMessage": "Badge component" - }, - { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", - "syntaxKind": "PropertySignature", - "name": "helpText", - "value": "React.ReactNode", - "description": "Additional hint text to display with item", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", - "syntaxKind": "PropertySignature", - "name": "icon", - "value": "any", - "description": "", - "isOptional": true, - "deprecationMessage": "Source of the icon" - }, - { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "string", - "description": "", - "isOptional": true, - "deprecationMessage": "Image source" - }, - { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", - "syntaxKind": "PropertySignature", - "name": "prefix", - "value": "React.ReactNode", - "description": "Prefix source", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", - "syntaxKind": "PropertySignature", - "name": "suffix", - "value": "React.ReactNode", - "description": "Suffix source", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", - "syntaxKind": "PropertySignature", - "name": "ellipsis", - "value": "boolean", - "description": "Add an ellipsis suffix to action content", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", - "syntaxKind": "PropertySignature", - "name": "active", - "value": "boolean", - "description": "Whether the action is active or not", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", - "syntaxKind": "PropertySignature", - "name": "role", - "value": "string", - "description": "Defines a role for the action", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "Whether or not the action is disabled", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the action", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", - "syntaxKind": "PropertySignature", - "name": "content", - "value": "string", - "description": "Content the action displays", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "A destination to link to, rendered in the action", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", - "syntaxKind": "PropertySignature", - "name": "external", - "value": "boolean", - "description": "Forces url to open in a new tab", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", - "syntaxKind": "MethodSignature", - "name": "onAction", - "value": "() => void", - "description": "Callback when an action takes place", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", - "syntaxKind": "MethodSignature", - "name": "onMouseEnter", - "value": "() => void", - "description": "Callback when mouse enter", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", - "syntaxKind": "MethodSignature", - "name": "onTouchStart", - "value": "() => void", - "description": "Callback when element is touched", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", - "syntaxKind": "PropertySignature", - "name": "destructive", - "value": "boolean", - "description": "Destructive action", - "isOptional": true - } - ], - "value": "interface MappedAction extends ActionListItemDescriptor {\n wrapOverflow?: boolean;\n}" - } - }, "MappedOption": { "polaris-react/src/components/Autocomplete/components/MappedOption/MappedOption.tsx": { "filePath": "polaris-react/src/components/Autocomplete/components/MappedOption/MappedOption.tsx", @@ -23363,6 +23347,30 @@ "value": "export interface PipProps {\n status?: Status;\n progress?: Progress;\n accessibilityLabelOverride?: string;\n}" } }, + "MeasuredActions": { + "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx": { + "filePath": "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx", + "name": "MeasuredActions", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx", + "syntaxKind": "PropertySignature", + "name": "showable", + "value": "MenuActionDescriptor[]", + "description": "" + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx", + "syntaxKind": "PropertySignature", + "name": "rolledUp", + "value": "(MenuActionDescriptor | MenuGroupDescriptor)[]", + "description": "" + } + ], + "value": "interface MeasuredActions {\n showable: MenuActionDescriptor[];\n rolledUp: (MenuActionDescriptor | MenuGroupDescriptor)[];\n}" + } + }, "BulkActionButtonProps": { "polaris-react/src/components/BulkActions/components/BulkActionButton/BulkActionButton.tsx": { "filePath": "polaris-react/src/components/BulkActions/components/BulkActionButton/BulkActionButton.tsx", @@ -23697,6 +23705,15 @@ "value": "export interface SlidableProps {\n draggerX?: number;\n draggerY?: number;\n onChange(position: Position): void;\n onDraggerHeight?(height: number): void;\n}" } }, + "ItemPosition": { + "polaris-react/src/components/Connected/components/Item/Item.tsx": { + "filePath": "polaris-react/src/components/Connected/components/Item/Item.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "ItemPosition", + "value": "'left' | 'right' | 'primary'", + "description": "" + } + }, "CellProps": { "polaris-react/src/components/DataTable/components/Cell/Cell.tsx": { "filePath": "polaris-react/src/components/DataTable/components/Cell/Cell.tsx", @@ -23989,19 +24006,10 @@ "name": "flush", "value": "boolean", "description": "", - "isOptional": true - } - ], - "value": "export interface CellProps {\n children?: ReactNode;\n className?: string;\n flush?: boolean;\n}" - } - }, - "ItemPosition": { - "polaris-react/src/components/Connected/components/Item/Item.tsx": { - "filePath": "polaris-react/src/components/Connected/components/Item/Item.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "ItemPosition", - "value": "'left' | 'right' | 'primary'", - "description": "" + "isOptional": true + } + ], + "value": "export interface CellProps {\n children?: ReactNode;\n className?: string;\n flush?: boolean;\n}" } }, "DayProps": { @@ -24260,32 +24268,6 @@ "value": "export interface MonthProps {\n focusedDate?: Date;\n selected?: Range;\n hoverDate?: Date;\n month: number;\n year: number;\n disableDatesBefore?: Date;\n disableDatesAfter?: Date;\n disableSpecificDates?: Date[];\n allowRange?: boolean;\n weekStartsOn: number;\n accessibilityLabelPrefixes: [string | undefined, string];\n onChange?(date: Range): void;\n onHover?(hoverEnd: Date): void;\n onFocus?(date: Date): void;\n}" } }, - "FileUploadProps": { - "polaris-react/src/components/DropZone/components/FileUpload/FileUpload.tsx": { - "filePath": "polaris-react/src/components/DropZone/components/FileUpload/FileUpload.tsx", - "name": "FileUploadProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/DropZone/components/FileUpload/FileUpload.tsx", - "syntaxKind": "PropertySignature", - "name": "actionTitle", - "value": "string", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/DropZone/components/FileUpload/FileUpload.tsx", - "syntaxKind": "PropertySignature", - "name": "actionHint", - "value": "string", - "description": "", - "isOptional": true - } - ], - "value": "export interface FileUploadProps {\n actionTitle?: string;\n actionHint?: string;\n}" - } - }, "WeekdayProps": { "polaris-react/src/components/DatePicker/components/Weekday/Weekday.tsx": { "filePath": "polaris-react/src/components/DatePicker/components/Weekday/Weekday.tsx", @@ -24317,6 +24299,32 @@ "value": "export interface WeekdayProps {\n label: string;\n title: string;\n current: boolean;\n}" } }, + "FileUploadProps": { + "polaris-react/src/components/DropZone/components/FileUpload/FileUpload.tsx": { + "filePath": "polaris-react/src/components/DropZone/components/FileUpload/FileUpload.tsx", + "name": "FileUploadProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/DropZone/components/FileUpload/FileUpload.tsx", + "syntaxKind": "PropertySignature", + "name": "actionTitle", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/DropZone/components/FileUpload/FileUpload.tsx", + "syntaxKind": "PropertySignature", + "name": "actionHint", + "value": "string", + "description": "", + "isOptional": true + } + ], + "value": "export interface FileUploadProps {\n actionTitle?: string;\n actionHint?: string;\n}" + } + }, "PopoverableAction": { "polaris-react/src/components/Filters/components/ConnectedFilterControl/ConnectedFilterControl.tsx": { "filePath": "polaris-react/src/components/Filters/components/ConnectedFilterControl/ConnectedFilterControl.tsx", @@ -24498,48 +24506,6 @@ "value": "interface ComputedProperty {\n [key: string]: number;\n}" } }, - "GroupProps": { - "polaris-react/src/components/FormLayout/components/Group/Group.tsx": { - "filePath": "polaris-react/src/components/FormLayout/components/Group/Group.tsx", - "name": "GroupProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/FormLayout/components/Group/Group.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/FormLayout/components/Group/Group.tsx", - "syntaxKind": "PropertySignature", - "name": "condensed", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/FormLayout/components/Group/Group.tsx", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/FormLayout/components/Group/Group.tsx", - "syntaxKind": "PropertySignature", - "name": "helpText", - "value": "React.ReactNode", - "description": "", - "isOptional": true - } - ], - "value": "export interface GroupProps {\n children?: React.ReactNode;\n condensed?: boolean;\n title?: string;\n helpText?: React.ReactNode;\n}" - } - }, "AnimationType": { "polaris-react/src/components/Frame/components/CSSAnimation/CSSAnimation.tsx": { "filePath": "polaris-react/src/components/Frame/components/CSSAnimation/CSSAnimation.tsx", @@ -24588,6 +24554,48 @@ "value": "export interface CSSAnimationProps {\n in: boolean;\n className: string;\n type: AnimationType;\n children?: React.ReactNode;\n}" } }, + "GroupProps": { + "polaris-react/src/components/FormLayout/components/Group/Group.tsx": { + "filePath": "polaris-react/src/components/FormLayout/components/Group/Group.tsx", + "name": "GroupProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/FormLayout/components/Group/Group.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/FormLayout/components/Group/Group.tsx", + "syntaxKind": "PropertySignature", + "name": "condensed", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/FormLayout/components/Group/Group.tsx", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/FormLayout/components/Group/Group.tsx", + "syntaxKind": "PropertySignature", + "name": "helpText", + "value": "React.ReactNode", + "description": "", + "isOptional": true + } + ], + "value": "export interface GroupProps {\n children?: React.ReactNode;\n condensed?: boolean;\n title?: string;\n helpText?: React.ReactNode;\n}" + } + }, "ToastManagerProps": { "polaris-react/src/components/Frame/components/ToastManager/ToastManager.tsx": { "filePath": "polaris-react/src/components/Frame/components/ToastManager/ToastManager.tsx", @@ -26873,6 +26881,39 @@ "value": "export interface UserMenuProps {\n /** An array of action objects that are rendered inside of a popover triggered by this menu */\n actions: {items: IconableAction[]}[];\n /** Accepts a message that facilitates direct, urgent communication with the merchant through the user menu */\n message?: MenuProps['message'];\n /** A string detailing the merchant’s full name to be displayed in the user menu */\n name: string;\n /** A string allowing further detail on the merchant’s name displayed in the user menu */\n detail?: string;\n /** A string that provides the accessibility labeling */\n accessibilityLabel?: string;\n /** The merchant’s initials, rendered in place of an avatar image when not provided */\n initials: AvatarProps['initials'];\n /** An avatar image representing the merchant */\n avatar?: AvatarProps['source'];\n /** A boolean property indicating whether the user menu is currently open */\n open: boolean;\n /** A callback function to handle opening and closing the user menu */\n onToggle(): void;\n}" } }, + "SecondaryProps": { + "polaris-react/src/components/Navigation/components/Item/components/Secondary/Secondary.tsx": { + "filePath": "polaris-react/src/components/Navigation/components/Item/components/Secondary/Secondary.tsx", + "name": "SecondaryProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Navigation/components/Item/components/Secondary/Secondary.tsx", + "syntaxKind": "PropertySignature", + "name": "expanded", + "value": "boolean", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Navigation/components/Item/components/Secondary/Secondary.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Navigation/components/Item/components/Secondary/Secondary.tsx", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "", + "isOptional": true + } + ], + "value": "interface SecondaryProps {\n expanded: boolean;\n children?: React.ReactNode;\n id?: string;\n}" + } + }, "DiscardConfirmationModalProps": { "polaris-react/src/components/Frame/components/ContextualSaveBar/components/DiscardConfirmationModal/DiscardConfirmationModal.tsx": { "filePath": "polaris-react/src/components/Frame/components/ContextualSaveBar/components/DiscardConfirmationModal/DiscardConfirmationModal.tsx", @@ -26904,37 +26945,46 @@ "value": "export interface DiscardConfirmationModalProps {\n open: boolean;\n onDiscard(): void;\n onCancel(): void;\n}" } }, - "SecondaryProps": { - "polaris-react/src/components/Navigation/components/Item/components/Secondary/Secondary.tsx": { - "filePath": "polaris-react/src/components/Navigation/components/Item/components/Secondary/Secondary.tsx", - "name": "SecondaryProps", + "TitleProps": { + "polaris-react/src/components/Page/components/Header/components/Title/Title.tsx": { + "filePath": "polaris-react/src/components/Page/components/Header/components/Title/Title.tsx", + "name": "TitleProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/Navigation/components/Item/components/Secondary/Secondary.tsx", + "filePath": "polaris-react/src/components/Page/components/Header/components/Title/Title.tsx", "syntaxKind": "PropertySignature", - "name": "expanded", - "value": "boolean", - "description": "" + "name": "title", + "value": "string", + "description": "Page title, in large type", + "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/components/Secondary/Secondary.tsx", + "filePath": "polaris-react/src/components/Page/components/Header/components/Title/Title.tsx", "syntaxKind": "PropertySignature", - "name": "children", + "name": "subtitle", + "value": "string", + "description": "Page subtitle, in regular type", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Page/components/Header/components/Title/Title.tsx", + "syntaxKind": "PropertySignature", + "name": "titleMetadata", "value": "React.ReactNode", - "description": "", + "description": "Important and non-interactive status information shown immediately after the title.", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/components/Secondary/Secondary.tsx", + "filePath": "polaris-react/src/components/Page/components/Header/components/Title/Title.tsx", "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "", + "name": "compactTitle", + "value": "boolean", + "description": "Removes spacing between title and subtitle", "isOptional": true } ], - "value": "interface SecondaryProps {\n expanded: boolean;\n children?: React.ReactNode;\n id?: string;\n}" + "value": "export interface TitleProps {\n /** Page title, in large type */\n title?: string;\n /** Page subtitle, in regular type*/\n subtitle?: string;\n /** Important and non-interactive status information shown immediately after the title. */\n titleMetadata?: React.ReactNode;\n /** Removes spacing between title and subtitle */\n compactTitle?: boolean;\n}" } }, "MessageProps": { @@ -26982,47 +27032,5 @@ ], "value": "export interface MessageProps {\n title: string;\n description: string;\n action: {onClick(): void; content: string};\n link: {to: string; content: string};\n badge?: {content: string; status: BadgeProps['status']};\n}" } - }, - "TitleProps": { - "polaris-react/src/components/Page/components/Header/components/Title/Title.tsx": { - "filePath": "polaris-react/src/components/Page/components/Header/components/Title/Title.tsx", - "name": "TitleProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Page/components/Header/components/Title/Title.tsx", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "Page title, in large type", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Page/components/Header/components/Title/Title.tsx", - "syntaxKind": "PropertySignature", - "name": "subtitle", - "value": "string", - "description": "Page subtitle, in regular type", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Page/components/Header/components/Title/Title.tsx", - "syntaxKind": "PropertySignature", - "name": "titleMetadata", - "value": "React.ReactNode", - "description": "Important and non-interactive status information shown immediately after the title.", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Page/components/Header/components/Title/Title.tsx", - "syntaxKind": "PropertySignature", - "name": "compactTitle", - "value": "boolean", - "description": "Removes spacing between title and subtitle", - "isOptional": true - } - ], - "value": "export interface TitleProps {\n /** Page title, in large type */\n title?: string;\n /** Page subtitle, in regular type*/\n subtitle?: string;\n /** Important and non-interactive status information shown immediately after the title. */\n titleMetadata?: React.ReactNode;\n /** Removes spacing between title and subtitle */\n compactTitle?: boolean;\n}" - } } } \ No newline at end of file From 09fa2f802ad328ddfa86393f5dc4ed910cb23529 Mon Sep 17 00:00:00 2001 From: Lo Kim Date: Fri, 18 Nov 2022 09:00:16 -0500 Subject: [PATCH 5/5] Add changeset --- .changeset/light-mirrors-act.md | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 .changeset/light-mirrors-act.md diff --git a/.changeset/light-mirrors-act.md b/.changeset/light-mirrors-act.md new file mode 100644 index 00000000000..67644b63f3f --- /dev/null +++ b/.changeset/light-mirrors-act.md @@ -0,0 +1,6 @@ +--- +'@shopify/polaris': patch +'polaris.shopify.com': patch +--- + +Refactored `Columns` `gap` to use `getResponsiveProps` util