diff --git a/.changeset/two-fishes-join.md b/.changeset/two-fishes-join.md new file mode 100644 index 00000000000..5a93e09ab4c --- /dev/null +++ b/.changeset/two-fishes-join.md @@ -0,0 +1,6 @@ +--- +'@shopify/polaris': patch +'polaris.shopify.com': patch +--- + +Updated `Bleed` props to use logical properties, fixed reversed logic for horizontal/vertical bleed, and updated style guide diff --git a/polaris-react/src/components/Bleed/Bleed.scss b/polaris-react/src/components/Bleed/Bleed.scss index d46b8317b6b..434f9efb5fc 100644 --- a/polaris-react/src/components/Bleed/Bleed.scss +++ b/polaris-react/src/components/Bleed/Bleed.scss @@ -1,10 +1,8 @@ @import '../../styles/common'; .Bleed { - /* stylelint-disable declaration-block-no-redundant-longhand-properties */ - margin-bottom: calc(-1 * var(--pc-bleed-margin-bottom)); - margin-left: calc(-1 * var(--pc-bleed-margin-left)); - margin-right: calc(-1 * var(--pc-bleed-margin-right)); - margin-top: calc(-1 * var(--pc-bleed-margin-top)); - /* stylelint-enable declaration-block-no-redundant-longhand-properties */ + margin-block-start: calc(-1 * var(--pc-bleed-margin-block-start)); + margin-block-end: calc(-1 * var(--pc-bleed-margin-block-end)); + margin-inline-start: calc(-1 * var(--pc-bleed-margin-inline-start)); + margin-inline-end: calc(-1 * var(--pc-bleed-margin-inline-end)); } diff --git a/polaris-react/src/components/Bleed/Bleed.stories.tsx b/polaris-react/src/components/Bleed/Bleed.stories.tsx index c9928646963..f4af5585009 100644 --- a/polaris-react/src/components/Bleed/Bleed.stories.tsx +++ b/polaris-react/src/components/Bleed/Bleed.stories.tsx @@ -1,6 +1,6 @@ import React from 'react'; import type {ComponentMeta} from '@storybook/react'; -import {AlphaCard, Bleed, Box, Text} from '@shopify/polaris'; +import {AlphaCard, Bleed, Box, Stack, Text} from '@shopify/polaris'; export default { component: Bleed, @@ -16,17 +16,19 @@ const styles = { export function Default() { return ( - - Section 01 - + + + Section 01 + + - - - + - - Section 02 - + + + Section 02 + + ); } @@ -34,7 +36,7 @@ export function Default() { export function WithVerticalDirection() { return ( - +
@@ -44,7 +46,7 @@ export function WithVerticalDirection() { export function WithHorizontalDirection() { return ( - +
@@ -53,18 +55,47 @@ export function WithHorizontalDirection() { export function WithSpecificDirection() { return ( - - -
- - + + + Top + + + +
+ + + + Bottom + + + +
+ + + + Left + + + +
+ + + + Right + + + +
+ + + ); } export function WithAllDirection() { return ( - +
diff --git a/polaris-react/src/components/Bleed/Bleed.tsx b/polaris-react/src/components/Bleed/Bleed.tsx index 19c61292670..afa5af54148 100644 --- a/polaris-react/src/components/Bleed/Bleed.tsx +++ b/polaris-react/src/components/Bleed/Bleed.tsx @@ -10,67 +10,67 @@ export interface BleedProps { /** Negative horizontal space around children * @default '5' */ - horizontal?: SpacingSpaceScale; + marginInline?: SpacingSpaceScale; /** Negative vertical space around children */ - vertical?: SpacingSpaceScale; + marginBlock?: SpacingSpaceScale; /** Negative top space around children */ - top?: SpacingSpaceScale; + marginBlockStart?: SpacingSpaceScale; /** Negative bottom space around children */ - bottom?: SpacingSpaceScale; + marginBlockEnd?: SpacingSpaceScale; /** Negative left space around children */ - left?: SpacingSpaceScale; + marginInlineStart?: SpacingSpaceScale; /** Negative right space around children */ - right?: SpacingSpaceScale; + marginInlineEnd?: SpacingSpaceScale; } export const Bleed = ({ - horizontal = '5', - vertical, - top, - bottom, - left, - right, + marginInline = '5', + marginBlock, + marginBlockStart, + marginBlockEnd, + marginInlineStart, + marginInlineEnd, children, }: BleedProps) => { const getNegativeMargins = (direction: string) => { - const xAxis = ['left', 'right']; - const yAxis = ['top', 'bottom']; + const xAxis = ['marginInlineStart', 'marginInlineEnd']; + const yAxis = ['marginBlockStart', 'marginBlockEnd']; const directionValues: {[key: string]: string | undefined} = { - top, - bottom, - left, - right, - horizontal, - vertical, + marginBlockStart, + marginBlockEnd, + marginInlineStart, + marginInlineEnd, + marginInline, + marginBlock, }; if (directionValues[direction]) { return directionValues[direction]; - } else if (!yAxis.includes(direction) && horizontal) { - return directionValues.horizontal; - } else if (!xAxis.includes(direction) && vertical) { - return directionValues.vertical; + } else if (xAxis.includes(direction) && marginInline) { + return directionValues.marginInline; + } else if (yAxis.includes(direction) && marginBlock) { + return directionValues.marginBlock; } }; - const negativeTop = getNegativeMargins('top'); - const negativeLeft = getNegativeMargins('left'); - const negativeRight = getNegativeMargins('right'); - const negativeBottom = getNegativeMargins('bottom'); + const negativeMarginBlockStart = getNegativeMargins('marginBlockStart'); + const negativeMarginBlockEnd = getNegativeMargins('marginBlockEnd'); + const negativeMarginInlineStart = getNegativeMargins('marginInlineStart'); + const negativeMarginInlineEnd = getNegativeMargins('marginInlineEnd'); const style = { - '--pc-bleed-margin-bottom': negativeBottom - ? `var(--p-space-${negativeBottom})` + '--pc-bleed-margin-block-start': negativeMarginBlockStart + ? `var(--p-space-${negativeMarginBlockStart})` : undefined, - '--pc-bleed-margin-left': negativeLeft - ? `var(--p-space-${negativeLeft})` + '--pc-bleed-margin-block-end': negativeMarginBlockEnd + ? `var(--p-space-${negativeMarginBlockEnd})` : undefined, - '--pc-bleed-margin-right': negativeRight - ? `var(--p-space-${negativeRight})` + '--pc-bleed-margin-inline-start': negativeMarginInlineStart + ? `var(--p-space-${negativeMarginInlineStart})` : undefined, - '--pc-bleed-margin-top': negativeTop - ? `var(--p-space-${negativeTop})` + '--pc-bleed-margin-inline-end': negativeMarginInlineEnd + ? `var(--p-space-${negativeMarginInlineEnd})` : undefined, } as React.CSSProperties; diff --git a/polaris-react/src/components/Bleed/tests/Bleed.test.tsx b/polaris-react/src/components/Bleed/tests/Bleed.test.tsx index 11e469cdeae..d18206b705c 100644 --- a/polaris-react/src/components/Bleed/tests/Bleed.test.tsx +++ b/polaris-react/src/components/Bleed/tests/Bleed.test.tsx @@ -25,40 +25,40 @@ describe('', () => { expect(bleed).toContainReactComponent('div', { style: { - '--pc-bleed-margin-left': 'var(--p-space-5)', - '--pc-bleed-margin-right': 'var(--p-space-5)', + '--pc-bleed-margin-inline-start': 'var(--p-space-5)', + '--pc-bleed-margin-inline-end': 'var(--p-space-5)', } as React.CSSProperties, }); }); it('only renders the custom property that matches the property passed in', () => { const bleed = mountWithApp( - + , ); expect(bleed).toContainReactComponent('div', { style: { - '--pc-bleed-margin-left': 'var(--p-space-2)', - '--pc-bleed-margin-right': 'var(--p-space-5)', + '--pc-bleed-margin-inline-start': 'var(--p-space-2)', + '--pc-bleed-margin-inline-end': 'var(--p-space-5)', } as React.CSSProperties, }); }); it('renders custom properties combined with any overrides if they are passed in', () => { const bleed = mountWithApp( - + , ); expect(bleed).toContainReactComponent('div', { style: { - '--pc-bleed-margin-bottom': 'var(--p-space-1)', - '--pc-bleed-margin-left': 'var(--p-space-2)', - '--pc-bleed-margin-right': 'var(--p-space-3)', - '--pc-bleed-margin-top': 'var(--p-space-1)', + '--pc-bleed-margin-block-start': 'var(--p-space-1)', + '--pc-bleed-margin-block-end': 'var(--p-space-1)', + '--pc-bleed-margin-inline-start': 'var(--p-space-2)', + '--pc-bleed-margin-inline-end': 'var(--p-space-3)', } as React.CSSProperties, }); }); diff --git a/polaris.shopify.com/pages/examples/bleed-all-directions.tsx b/polaris.shopify.com/pages/examples/bleed-all-directions.tsx index d021f20fb23..8f05b21cdc6 100644 --- a/polaris.shopify.com/pages/examples/bleed-all-directions.tsx +++ b/polaris.shopify.com/pages/examples/bleed-all-directions.tsx @@ -6,7 +6,7 @@ import {withPolarisExample} from '../../src/components/PolarisExampleWrapper'; function BleedAllDirectionsExample() { return ( - + diff --git a/polaris.shopify.com/pages/examples/bleed-horizontal.tsx b/polaris.shopify.com/pages/examples/bleed-horizontal.tsx index c20de1c4877..074b5111905 100644 --- a/polaris.shopify.com/pages/examples/bleed-horizontal.tsx +++ b/polaris.shopify.com/pages/examples/bleed-horizontal.tsx @@ -6,7 +6,7 @@ import {withPolarisExample} from '../../src/components/PolarisExampleWrapper'; function BleedHorizontalExample() { return ( - + diff --git a/polaris.shopify.com/pages/examples/bleed-specific-direction.tsx b/polaris.shopify.com/pages/examples/bleed-specific-direction.tsx index 6baaed4367b..be001ad2b73 100644 --- a/polaris.shopify.com/pages/examples/bleed-specific-direction.tsx +++ b/polaris.shopify.com/pages/examples/bleed-specific-direction.tsx @@ -7,22 +7,22 @@ function BleedSpecificDirectionExample() { return ( - + - + - + - + diff --git a/polaris.shopify.com/pages/examples/bleed-vertical.tsx b/polaris.shopify.com/pages/examples/bleed-vertical.tsx index 4d60843a8cb..ea8569f051d 100644 --- a/polaris.shopify.com/pages/examples/bleed-vertical.tsx +++ b/polaris.shopify.com/pages/examples/bleed-vertical.tsx @@ -6,7 +6,7 @@ import {withPolarisExample} from '../../src/components/PolarisExampleWrapper'; function BleedVerticalExample() { return ( - + diff --git a/polaris.shopify.com/src/data/props.json b/polaris.shopify.com/src/data/props.json index a236d59cc11..2a3fc36609a 100644 --- a/polaris.shopify.com/src/data/props.json +++ b/polaris.shopify.com/src/data/props.json @@ -7671,6 +7671,107 @@ "value": "export interface AccountConnectionProps {\n /** Content to display as title */\n title?: React.ReactNode;\n /** Content to display as additional details */\n details?: React.ReactNode;\n /** Content to display as terms of service */\n termsOfService?: React.ReactNode;\n /** The name of the service */\n accountName?: string;\n /** URL for the user’s avatar image */\n avatarUrl?: string;\n /** Set if the account is connected */\n connected?: boolean;\n /** Action for account connection */\n action?: Action;\n}" } }, + "ActionMenuProps": { + "polaris-react/src/components/ActionMenu/ActionMenu.tsx": { + "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", + "name": "ActionMenuProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", + "syntaxKind": "PropertySignature", + "name": "actions", + "value": "MenuActionDescriptor[]", + "description": "Collection of page-level secondary actions", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", + "syntaxKind": "PropertySignature", + "name": "groups", + "value": "MenuGroupDescriptor[]", + "description": "Collection of page-level action groups", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", + "syntaxKind": "PropertySignature", + "name": "rollup", + "value": "boolean", + "description": "Roll up all actions into a Popover > ActionList", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", + "syntaxKind": "PropertySignature", + "name": "rollupActionsLabel", + "value": "string", + "description": "Label for rolled up actions activator", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", + "syntaxKind": "MethodSignature", + "name": "onActionRollup", + "value": "(hasRolledUp: boolean) => void", + "description": "Callback that returns true when secondary actions are rolled up into action groups, and false when not", + "isOptional": true + } + ], + "value": "export interface ActionMenuProps {\n /** Collection of page-level secondary actions */\n actions?: MenuActionDescriptor[];\n /** Collection of page-level action groups */\n groups?: MenuGroupDescriptor[];\n /** Roll up all actions into a Popover > ActionList */\n rollup?: boolean;\n /** Label for rolled up actions activator */\n rollupActionsLabel?: string;\n /** Callback that returns true when secondary actions are rolled up into action groups, and false when not */\n onActionRollup?(hasRolledUp: boolean): void;\n}" + } + }, + "ActionListProps": { + "polaris-react/src/components/ActionList/ActionList.tsx": { + "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", + "name": "ActionListProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", + "syntaxKind": "PropertySignature", + "name": "items", + "value": "readonly ActionListItemDescriptor[]", + "description": "Collection of actions for list", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", + "syntaxKind": "PropertySignature", + "name": "sections", + "value": "readonly ActionListSection[]", + "description": "Collection of sectioned action items", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", + "syntaxKind": "PropertySignature", + "name": "actionRole", + "value": "string", + "description": "Defines a specific role attribute for each action in the list", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", + "syntaxKind": "PropertySignature", + "name": "onActionAnyItem", + "value": "() => void", + "description": "Callback when any item is clicked or keypressed", + "isOptional": true + } + ], + "value": "export interface ActionListProps {\n /** Collection of actions for list */\n items?: readonly ActionListItemDescriptor[];\n /** Collection of sectioned action items */\n sections?: readonly ActionListSection[];\n /** Defines a specific role attribute for each action in the list */\n actionRole?: 'menuitem' | string;\n /** Callback when any item is clicked or keypressed */\n onActionAnyItem?: ActionListItemDescriptor['onAction'];\n}" + } + }, + "ActionListItemProps": { + "polaris-react/src/components/ActionList/ActionList.tsx": { + "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "ActionListItemProps", + "value": "ItemProps", + "description": "" + } + }, "Props": { "polaris-react/src/components/AfterInitialMount/AfterInitialMount.tsx": { "filePath": "polaris-react/src/components/AfterInitialMount/AfterInitialMount.tsx", @@ -7955,56 +8056,6 @@ "value": "interface Props {\n /** Callback when the search is dismissed */\n onDismiss?(): void;\n /** Determines whether the overlay should be visible */\n visible: boolean;\n}" } }, - "ActionMenuProps": { - "polaris-react/src/components/ActionMenu/ActionMenu.tsx": { - "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", - "name": "ActionMenuProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", - "syntaxKind": "PropertySignature", - "name": "actions", - "value": "MenuActionDescriptor[]", - "description": "Collection of page-level secondary actions", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", - "syntaxKind": "PropertySignature", - "name": "groups", - "value": "MenuGroupDescriptor[]", - "description": "Collection of page-level action groups", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", - "syntaxKind": "PropertySignature", - "name": "rollup", - "value": "boolean", - "description": "Roll up all actions into a Popover > ActionList", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", - "syntaxKind": "PropertySignature", - "name": "rollupActionsLabel", - "value": "string", - "description": "Label for rolled up actions activator", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", - "syntaxKind": "MethodSignature", - "name": "onActionRollup", - "value": "(hasRolledUp: boolean) => void", - "description": "Callback that returns true when secondary actions are rolled up into action groups, and false when not", - "isOptional": true - } - ], - "value": "export interface ActionMenuProps {\n /** Collection of page-level secondary actions */\n actions?: MenuActionDescriptor[];\n /** Collection of page-level action groups */\n groups?: MenuGroupDescriptor[];\n /** Roll up all actions into a Popover > ActionList */\n rollup?: boolean;\n /** Label for rolled up actions activator */\n rollupActionsLabel?: string;\n /** Callback that returns true when secondary actions are rolled up into action groups, and false when not */\n onActionRollup?(hasRolledUp: boolean): void;\n}" - } - }, "CardBackgroundColorTokenScale": { "polaris-react/src/components/AlphaCard/AlphaCard.tsx": { "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", @@ -8058,57 +8109,6 @@ "value": "export interface AlphaCardProps {\n children?: React.ReactNode;\n /** Background color\n * @default 'surface'\n */\n background?: CardBackgroundColorTokenScale;\n /** The spacing around the card\n * @default '5'\n */\n padding?: SpacingSpaceScale;\n /** Border radius value above a set breakpoint */\n roundedAbove?: BreakpointsAlias;\n}" } }, - "ActionListProps": { - "polaris-react/src/components/ActionList/ActionList.tsx": { - "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", - "name": "ActionListProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", - "syntaxKind": "PropertySignature", - "name": "items", - "value": "readonly ActionListItemDescriptor[]", - "description": "Collection of actions for list", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", - "syntaxKind": "PropertySignature", - "name": "sections", - "value": "readonly ActionListSection[]", - "description": "Collection of sectioned action items", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", - "syntaxKind": "PropertySignature", - "name": "actionRole", - "value": "string", - "description": "Defines a specific role attribute for each action in the list", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", - "syntaxKind": "PropertySignature", - "name": "onActionAnyItem", - "value": "() => void", - "description": "Callback when any item is clicked or keypressed", - "isOptional": true - } - ], - "value": "export interface ActionListProps {\n /** Collection of actions for list */\n items?: readonly ActionListItemDescriptor[];\n /** Collection of sectioned action items */\n sections?: readonly ActionListSection[];\n /** Defines a specific role attribute for each action in the list */\n actionRole?: 'menuitem' | string;\n /** Callback when any item is clicked or keypressed */\n onActionAnyItem?: ActionListItemDescriptor['onAction'];\n}" - } - }, - "ActionListItemProps": { - "polaris-react/src/components/ActionList/ActionList.tsx": { - "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "ActionListItemProps", - "value": "ItemProps", - "description": "" - } - }, "Align": { "polaris-react/src/components/AlphaStack/AlphaStack.tsx": { "filePath": "polaris-react/src/components/AlphaStack/AlphaStack.tsx", @@ -9692,7 +9692,7 @@ { "filePath": "polaris-react/src/components/Bleed/Bleed.tsx", "syntaxKind": "PropertySignature", - "name": "horizontal", + "name": "marginInline", "value": "\"0\" | \"025\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", "description": "Negative horizontal space around children", "isOptional": true, @@ -9701,7 +9701,7 @@ { "filePath": "polaris-react/src/components/Bleed/Bleed.tsx", "syntaxKind": "PropertySignature", - "name": "vertical", + "name": "marginBlock", "value": "\"0\" | \"025\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", "description": "Negative vertical space around children", "isOptional": true @@ -9709,7 +9709,7 @@ { "filePath": "polaris-react/src/components/Bleed/Bleed.tsx", "syntaxKind": "PropertySignature", - "name": "top", + "name": "marginBlockStart", "value": "\"0\" | \"025\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", "description": "Negative top space around children", "isOptional": true @@ -9717,7 +9717,7 @@ { "filePath": "polaris-react/src/components/Bleed/Bleed.tsx", "syntaxKind": "PropertySignature", - "name": "bottom", + "name": "marginBlockEnd", "value": "\"0\" | \"025\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", "description": "Negative bottom space around children", "isOptional": true @@ -9725,7 +9725,7 @@ { "filePath": "polaris-react/src/components/Bleed/Bleed.tsx", "syntaxKind": "PropertySignature", - "name": "left", + "name": "marginInlineStart", "value": "\"0\" | \"025\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", "description": "Negative left space around children", "isOptional": true @@ -9733,13 +9733,13 @@ { "filePath": "polaris-react/src/components/Bleed/Bleed.tsx", "syntaxKind": "PropertySignature", - "name": "right", + "name": "marginInlineEnd", "value": "\"0\" | \"025\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", "description": "Negative right space around children", "isOptional": true } ], - "value": "export interface BleedProps {\n children?: React.ReactNode;\n /** Negative horizontal space around children\n * @default '5'\n */\n horizontal?: SpacingSpaceScale;\n /** Negative vertical space around children */\n vertical?: SpacingSpaceScale;\n /** Negative top space around children */\n top?: SpacingSpaceScale;\n /** Negative bottom space around children */\n bottom?: SpacingSpaceScale;\n /** Negative left space around children */\n left?: SpacingSpaceScale;\n /** Negative right space around children */\n right?: SpacingSpaceScale;\n}" + "value": "export interface BleedProps {\n children?: React.ReactNode;\n /** Negative horizontal space around children\n * @default '5'\n */\n marginInline?: SpacingSpaceScale;\n /** Negative vertical space around children */\n marginBlock?: SpacingSpaceScale;\n /** Negative top space around children */\n marginBlockStart?: SpacingSpaceScale;\n /** Negative bottom space around children */\n marginBlockEnd?: SpacingSpaceScale;\n /** Negative left space around children */\n marginInlineStart?: SpacingSpaceScale;\n /** Negative right space around children */\n marginInlineEnd?: SpacingSpaceScale;\n}" } }, "Overflow": { @@ -22836,6 +22836,40 @@ "value": "interface SecondaryAction {\n url: string;\n accessibilityLabel: string;\n icon: IconProps['source'];\n onClick?(): void;\n tooltip?: TooltipProps;\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}" + } + }, "SectionProps": { "polaris-react/src/components/ActionList/components/Section/Section.tsx": { "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", @@ -23256,48 +23290,14 @@ "description": "" } }, - "RollupActionsProps": { - "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx": { - "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", - "name": "RollupActionsProps", + "PipProps": { + "polaris-react/src/components/Badge/components/Pip/Pip.tsx": { + "filePath": "polaris-react/src/components/Badge/components/Pip/Pip.tsx", + "name": "PipProps", "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}" - } - }, - "PipProps": { - "polaris-react/src/components/Badge/components/Pip/Pip.tsx": { - "filePath": "polaris-react/src/components/Badge/components/Pip/Pip.tsx", - "name": "PipProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Badge/components/Pip/Pip.tsx", + "filePath": "polaris-react/src/components/Badge/components/Pip/Pip.tsx", "syntaxKind": "PropertySignature", "name": "status", "value": "Status", @@ -23324,6 +23324,15 @@ "value": "export interface PipProps {\n status?: Status;\n progress?: Progress;\n accessibilityLabelOverride?: string;\n}" } }, + "BulkActionButtonProps": { + "polaris-react/src/components/BulkActions/components/BulkActionButton/BulkActionButton.tsx": { + "filePath": "polaris-react/src/components/BulkActions/components/BulkActionButton/BulkActionButton.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "BulkActionButtonProps", + "value": "{\n disclosure?: boolean;\n indicator?: boolean;\n handleMeasurement?(width: number): void;\n} & DisableableAction", + "description": "" + } + }, "BulkActionsMenuProps": { "polaris-react/src/components/BulkActions/components/BulkActionMenu/BulkActionMenu.tsx": { "filePath": "polaris-react/src/components/BulkActions/components/BulkActionMenu/BulkActionMenu.tsx", @@ -23411,15 +23420,6 @@ "value": "export interface BulkActionsMenuProps extends MenuGroupDescriptor {\n isNewBadgeInBadgeActions: boolean;\n}" } }, - "BulkActionButtonProps": { - "polaris-react/src/components/BulkActions/components/BulkActionButton/BulkActionButton.tsx": { - "filePath": "polaris-react/src/components/BulkActions/components/BulkActionButton/BulkActionButton.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "BulkActionButtonProps", - "value": "{\n disclosure?: boolean;\n indicator?: boolean;\n handleMeasurement?(width: number): void;\n} & DisableableAction", - "description": "" - } - }, "CardHeaderProps": { "polaris-react/src/components/Card/components/Header/Header.tsx": { "filePath": "polaris-react/src/components/Card/components/Header/Header.tsx", @@ -23454,6 +23454,72 @@ "value": "export interface CardHeaderProps {\n title?: React.ReactNode;\n actions?: DisableableAction[];\n children?: React.ReactNode;\n}" } }, + "CardSectionProps": { + "polaris-react/src/components/Card/components/Section/Section.tsx": { + "filePath": "polaris-react/src/components/Card/components/Section/Section.tsx", + "name": "CardSectionProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Card/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "React.ReactNode", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Card/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Card/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "subdued", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Card/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "flush", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Card/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "fullWidth", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Card/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "hideOnPrint", + "value": "boolean", + "description": "Allow the card to be hidden when printing", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Card/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "actions", + "value": "ComplexAction[]", + "description": "", + "isOptional": true + } + ], + "value": "export interface CardSectionProps {\n title?: React.ReactNode;\n children?: React.ReactNode;\n subdued?: boolean;\n flush?: boolean;\n fullWidth?: boolean;\n /** Allow the card to be hidden when printing */\n hideOnPrint?: boolean;\n actions?: ComplexAction[];\n}" + } + }, "CardSubsectionProps": { "polaris-react/src/components/Card/components/Subsection/Subsection.tsx": { "filePath": "polaris-react/src/components/Card/components/Subsection/Subsection.tsx", @@ -23527,70 +23593,45 @@ "value": "export interface HuePickerProps {\n hue: number;\n onChange(hue: number): void;\n}" } }, - "CardSectionProps": { - "polaris-react/src/components/Card/components/Section/Section.tsx": { - "filePath": "polaris-react/src/components/Card/components/Section/Section.tsx", - "name": "CardSectionProps", + "SlidableProps": { + "polaris-react/src/components/ColorPicker/components/Slidable/Slidable.tsx": { + "filePath": "polaris-react/src/components/ColorPicker/components/Slidable/Slidable.tsx", + "name": "SlidableProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/Card/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "React.ReactNode", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Card/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Card/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "subdued", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Card/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ColorPicker/components/Slidable/Slidable.tsx", "syntaxKind": "PropertySignature", - "name": "flush", - "value": "boolean", + "name": "draggerX", + "value": "number", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Card/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ColorPicker/components/Slidable/Slidable.tsx", "syntaxKind": "PropertySignature", - "name": "fullWidth", - "value": "boolean", + "name": "draggerY", + "value": "number", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Card/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "hideOnPrint", - "value": "boolean", - "description": "Allow the card to be hidden when printing", - "isOptional": true + "filePath": "polaris-react/src/components/ColorPicker/components/Slidable/Slidable.tsx", + "syntaxKind": "MethodSignature", + "name": "onChange", + "value": "(position: Position) => void", + "description": "" }, { - "filePath": "polaris-react/src/components/Card/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "actions", - "value": "ComplexAction[]", + "filePath": "polaris-react/src/components/ColorPicker/components/Slidable/Slidable.tsx", + "syntaxKind": "MethodSignature", + "name": "onDraggerHeight", + "value": "(height: number) => void", "description": "", "isOptional": true } ], - "value": "export interface CardSectionProps {\n title?: React.ReactNode;\n children?: React.ReactNode;\n subdued?: boolean;\n flush?: boolean;\n fullWidth?: boolean;\n /** Allow the card to be hidden when printing */\n hideOnPrint?: boolean;\n actions?: ComplexAction[];\n}" + "value": "export interface SlidableProps {\n draggerX?: number;\n draggerY?: number;\n onChange(position: Position): void;\n onDraggerHeight?(height: number): void;\n}" } }, "ItemPosition": { @@ -23900,47 +23941,6 @@ "value": "export interface CellProps {\n children?: ReactNode;\n className?: string;\n flush?: boolean;\n}" } }, - "SlidableProps": { - "polaris-react/src/components/ColorPicker/components/Slidable/Slidable.tsx": { - "filePath": "polaris-react/src/components/ColorPicker/components/Slidable/Slidable.tsx", - "name": "SlidableProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/ColorPicker/components/Slidable/Slidable.tsx", - "syntaxKind": "PropertySignature", - "name": "draggerX", - "value": "number", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ColorPicker/components/Slidable/Slidable.tsx", - "syntaxKind": "PropertySignature", - "name": "draggerY", - "value": "number", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ColorPicker/components/Slidable/Slidable.tsx", - "syntaxKind": "MethodSignature", - "name": "onChange", - "value": "(position: Position) => void", - "description": "" - }, - { - "filePath": "polaris-react/src/components/ColorPicker/components/Slidable/Slidable.tsx", - "syntaxKind": "MethodSignature", - "name": "onDraggerHeight", - "value": "(height: number) => void", - "description": "", - "isOptional": true - } - ], - "value": "export interface SlidableProps {\n draggerX?: number;\n draggerY?: number;\n onChange(position: Position): void;\n onDraggerHeight?(height: number): void;\n}" - } - }, "DayProps": { "polaris-react/src/components/DatePicker/components/Day/Day.tsx": { "filePath": "polaris-react/src/components/DatePicker/components/Day/Day.tsx", @@ -24079,37 +24079,6 @@ "value": "export interface DayProps {\n focused?: boolean;\n day?: Date;\n selected?: boolean;\n inRange?: boolean;\n inHoveringRange?: boolean;\n disabled?: boolean;\n lastDayOfMonth?: any;\n isLastSelectedDay?: boolean;\n isFirstSelectedDay?: boolean;\n isHoveringRight?: boolean;\n rangeIsDifferent?: boolean;\n weekday?: string;\n selectedAccessibilityLabelPrefix?: string;\n onClick?(day: Date): void;\n onHover?(day?: Date): void;\n onFocus?(day: Date): void;\n}" } }, - "WeekdayProps": { - "polaris-react/src/components/DatePicker/components/Weekday/Weekday.tsx": { - "filePath": "polaris-react/src/components/DatePicker/components/Weekday/Weekday.tsx", - "name": "WeekdayProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/DatePicker/components/Weekday/Weekday.tsx", - "syntaxKind": "PropertySignature", - "name": "label", - "value": "string", - "description": "" - }, - { - "filePath": "polaris-react/src/components/DatePicker/components/Weekday/Weekday.tsx", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "" - }, - { - "filePath": "polaris-react/src/components/DatePicker/components/Weekday/Weekday.tsx", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "boolean", - "description": "" - } - ], - "value": "export interface WeekdayProps {\n label: string;\n title: string;\n current: boolean;\n}" - } - }, "MonthProps": { "polaris-react/src/components/DatePicker/components/Month/Month.tsx": { "filePath": "polaris-react/src/components/DatePicker/components/Month/Month.tsx", @@ -24228,72 +24197,61 @@ "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", + "WeekdayProps": { + "polaris-react/src/components/DatePicker/components/Weekday/Weekday.tsx": { + "filePath": "polaris-react/src/components/DatePicker/components/Weekday/Weekday.tsx", + "name": "WeekdayProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/DropZone/components/FileUpload/FileUpload.tsx", + "filePath": "polaris-react/src/components/DatePicker/components/Weekday/Weekday.tsx", "syntaxKind": "PropertySignature", - "name": "actionTitle", + "name": "label", "value": "string", - "description": "", - "isOptional": true + "description": "" }, { - "filePath": "polaris-react/src/components/DropZone/components/FileUpload/FileUpload.tsx", + "filePath": "polaris-react/src/components/DatePicker/components/Weekday/Weekday.tsx", "syntaxKind": "PropertySignature", - "name": "actionHint", + "name": "title", "value": "string", - "description": "", - "isOptional": true + "description": "" + }, + { + "filePath": "polaris-react/src/components/DatePicker/components/Weekday/Weekday.tsx", + "syntaxKind": "PropertySignature", + "name": "current", + "value": "boolean", + "description": "" } ], - "value": "export interface FileUploadProps {\n actionTitle?: string;\n actionHint?: string;\n}" + "value": "export interface WeekdayProps {\n label: string;\n title: string;\n current: boolean;\n}" } }, - "GroupProps": { - "polaris-react/src/components/FormLayout/components/Group/Group.tsx": { - "filePath": "polaris-react/src/components/FormLayout/components/Group/Group.tsx", - "name": "GroupProps", + "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/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", + "filePath": "polaris-react/src/components/DropZone/components/FileUpload/FileUpload.tsx", "syntaxKind": "PropertySignature", - "name": "title", + "name": "actionTitle", "value": "string", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/FormLayout/components/Group/Group.tsx", + "filePath": "polaris-react/src/components/DropZone/components/FileUpload/FileUpload.tsx", "syntaxKind": "PropertySignature", - "name": "helpText", - "value": "React.ReactNode", + "name": "actionHint", + "value": "string", "description": "", "isOptional": true } ], - "value": "export interface GroupProps {\n children?: React.ReactNode;\n condensed?: boolean;\n title?: string;\n helpText?: React.ReactNode;\n}" + "value": "export interface FileUploadProps {\n actionTitle?: string;\n actionHint?: string;\n}" } }, "PopoverableAction": { @@ -24477,6 +24435,48 @@ "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", @@ -25140,6 +25140,39 @@ "value": "export interface OptionProps {\n id: string;\n label: React.ReactNode;\n value: string;\n section: number;\n index: number;\n media?: React.ReactElement;\n disabled?: boolean;\n active?: boolean;\n select?: boolean;\n allowMultiple?: boolean;\n verticalAlign?: Alignment;\n role?: string;\n onClick(section: number, option: number): void;\n}" } }, + "CloseButtonProps": { + "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx": { + "filePath": "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx", + "name": "CloseButtonProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx", + "syntaxKind": "PropertySignature", + "name": "pressed", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx", + "syntaxKind": "PropertySignature", + "name": "titleHidden", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx", + "syntaxKind": "MethodSignature", + "name": "onClick", + "value": "() => void", + "description": "" + } + ], + "value": "export interface CloseButtonProps {\n pressed?: boolean;\n titleHidden?: boolean;\n onClick(): void;\n}" + } + }, "TextOptionProps": { "polaris-react/src/components/Listbox/components/TextOption/TextOption.tsx": { "filePath": "polaris-react/src/components/Listbox/components/TextOption/TextOption.tsx", @@ -25173,37 +25206,38 @@ "value": "export interface TextOptionProps {\n children: React.ReactNode;\n // Whether the option is selected\n selected?: boolean;\n // Whether the option is disabled\n disabled?: boolean;\n}" } }, - "CloseButtonProps": { - "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx": { - "filePath": "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx", - "name": "CloseButtonProps", + "FooterProps": { + "polaris-react/src/components/Modal/components/Footer/Footer.tsx": { + "filePath": "polaris-react/src/components/Modal/components/Footer/Footer.tsx", + "name": "FooterProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx", + "filePath": "polaris-react/src/components/Modal/components/Footer/Footer.tsx", "syntaxKind": "PropertySignature", - "name": "pressed", - "value": "boolean", - "description": "", + "name": "primaryAction", + "value": "ComplexAction", + "description": "Primary action", "isOptional": true }, { - "filePath": "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx", + "filePath": "polaris-react/src/components/Modal/components/Footer/Footer.tsx", "syntaxKind": "PropertySignature", - "name": "titleHidden", - "value": "boolean", - "description": "", + "name": "secondaryActions", + "value": "ComplexAction[]", + "description": "Collection of secondary actions", "isOptional": true }, { - "filePath": "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx", - "syntaxKind": "MethodSignature", - "name": "onClick", - "value": "() => void", - "description": "" + "filePath": "polaris-react/src/components/Modal/components/Footer/Footer.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "The content to display inside modal", + "isOptional": true } ], - "value": "export interface CloseButtonProps {\n pressed?: boolean;\n titleHidden?: boolean;\n onClick(): void;\n}" + "value": "export interface FooterProps {\n /** Primary action */\n primaryAction?: ComplexAction;\n /** Collection of secondary actions */\n secondaryActions?: ComplexAction[];\n /** The content to display inside modal */\n children?: React.ReactNode;\n}" } }, "DialogProps": { @@ -25311,40 +25345,6 @@ "value": "export interface DialogProps {\n labelledBy?: string;\n instant?: boolean;\n children?: React.ReactNode;\n limitHeight?: boolean;\n large?: boolean;\n small?: boolean;\n onClose(): void;\n onEntered?(): void;\n onExited?(): void;\n in?: boolean;\n fullScreen?: boolean;\n setClosing?: Dispatch>;\n}" } }, - "FooterProps": { - "polaris-react/src/components/Modal/components/Footer/Footer.tsx": { - "filePath": "polaris-react/src/components/Modal/components/Footer/Footer.tsx", - "name": "FooterProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Modal/components/Footer/Footer.tsx", - "syntaxKind": "PropertySignature", - "name": "primaryAction", - "value": "ComplexAction", - "description": "Primary action", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Modal/components/Footer/Footer.tsx", - "syntaxKind": "PropertySignature", - "name": "secondaryActions", - "value": "ComplexAction[]", - "description": "Collection of secondary actions", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Modal/components/Footer/Footer.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "The content to display inside modal", - "isOptional": true - } - ], - "value": "export interface FooterProps {\n /** Primary action */\n primaryAction?: ComplexAction;\n /** Collection of secondary actions */\n secondaryActions?: ComplexAction[];\n /** The content to display inside modal */\n children?: React.ReactNode;\n}" - } - }, "ItemURLDetails": { "polaris-react/src/components/Navigation/components/Item/Item.tsx": { "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", @@ -26218,6 +26218,46 @@ "value": "export interface SingleThumbProps extends RangeSliderProps {\n value: number;\n id: string;\n min: number;\n max: number;\n step: number;\n}" } }, + "PanelProps": { + "polaris-react/src/components/Tabs/components/Panel/Panel.tsx": { + "filePath": "polaris-react/src/components/Tabs/components/Panel/Panel.tsx", + "name": "PanelProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Tabs/components/Panel/Panel.tsx", + "syntaxKind": "PropertySignature", + "name": "hidden", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Tabs/components/Panel/Panel.tsx", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Tabs/components/Panel/Panel.tsx", + "syntaxKind": "PropertySignature", + "name": "tabID", + "value": "string", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Tabs/components/Panel/Panel.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "", + "isOptional": true + } + ], + "value": "export interface PanelProps {\n hidden?: boolean;\n id: string;\n tabID: string;\n children?: React.ReactNode;\n}" + } + }, "TabProps": { "polaris-react/src/components/Tabs/components/Tab/Tab.tsx": { "filePath": "polaris-react/src/components/Tabs/components/Tab/Tab.tsx", @@ -26431,55 +26471,6 @@ "value": "export interface ResizerProps {\n contents?: string;\n currentHeight?: number | null;\n minimumLines?: number;\n onHeightChange(height: number): void;\n}" } }, - "HandleStepFn": { - "polaris-react/src/components/TextField/components/Spinner/Spinner.tsx": { - "filePath": "polaris-react/src/components/TextField/components/Spinner/Spinner.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "HandleStepFn", - "value": "(step: number) => void", - "description": "" - } - }, - "PanelProps": { - "polaris-react/src/components/Tabs/components/Panel/Panel.tsx": { - "filePath": "polaris-react/src/components/Tabs/components/Panel/Panel.tsx", - "name": "PanelProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Tabs/components/Panel/Panel.tsx", - "syntaxKind": "PropertySignature", - "name": "hidden", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Tabs/components/Panel/Panel.tsx", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "" - }, - { - "filePath": "polaris-react/src/components/Tabs/components/Panel/Panel.tsx", - "syntaxKind": "PropertySignature", - "name": "tabID", - "value": "string", - "description": "" - }, - { - "filePath": "polaris-react/src/components/Tabs/components/Panel/Panel.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", - "isOptional": true - } - ], - "value": "export interface PanelProps {\n hidden?: boolean;\n id: string;\n tabID: string;\n children?: React.ReactNode;\n}" - } - }, "TooltipOverlayProps": { "polaris-react/src/components/Tooltip/components/TooltipOverlay/TooltipOverlay.tsx": { "filePath": "polaris-react/src/components/Tooltip/components/TooltipOverlay/TooltipOverlay.tsx", @@ -26653,6 +26644,15 @@ "value": "export interface SearchProps {\n /** Toggles whether or not the search is visible */\n visible?: boolean;\n /** The content to display inside the search */\n children?: React.ReactNode;\n /** Whether or not the search results overlay has a visible backdrop */\n overlayVisible?: boolean;\n /** Callback when the search is dismissed */\n onDismiss?(): void;\n}" } }, + "HandleStepFn": { + "polaris-react/src/components/TextField/components/Spinner/Spinner.tsx": { + "filePath": "polaris-react/src/components/TextField/components/Spinner/Spinner.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "HandleStepFn", + "value": "(step: number) => void", + "description": "" + } + }, "SearchFieldProps": { "polaris-react/src/components/TopBar/components/SearchField/SearchField.tsx": { "filePath": "polaris-react/src/components/TopBar/components/SearchField/SearchField.tsx",