@@ -52,25 +54,45 @@ export function SkeletonPage({
) : null;
const breadcrumbMarkup = breadcrumbs ? (
-
+
-
+
) : null;
return (
-
-
- {breadcrumbMarkup}
-
- {titleMarkup}
- {primaryActionMarkup}
-
-
-
{children}
-
+
+
+
+
+ {breadcrumbMarkup}
+
+
+ {titleContent}
+
+ {primaryActionMarkup}
+
+
+ {children}
+
+
+
);
}
diff --git a/polaris-react/src/components/SkeletonPage/tests/SkeletonPage.test.tsx b/polaris-react/src/components/SkeletonPage/tests/SkeletonPage.test.tsx
index 1bef933df19..20688bd794d 100644
--- a/polaris-react/src/components/SkeletonPage/tests/SkeletonPage.test.tsx
+++ b/polaris-react/src/components/SkeletonPage/tests/SkeletonPage.test.tsx
@@ -2,11 +2,11 @@ import React from 'react';
import {mountWithApp} from 'tests/utilities';
import {Card} from '../../Card';
-import {Text} from '../../Text';
import {Layout} from '../../Layout';
import {SkeletonBodyText} from '../../SkeletonBodyText';
import {SkeletonDisplayText} from '../../SkeletonDisplayText';
import {SkeletonPage} from '../SkeletonPage';
+import {Box} from '../../Box';
describe('
', () => {
it('renders its children', () => {
@@ -38,7 +38,9 @@ describe('
', () => {
const skeletonPage = mountWithApp(
);
expect(skeletonPage).toContainReactComponent('h1', {className: 'Title'});
- expect(skeletonPage).not.toContainReactComponent(Text);
+ expect(skeletonPage).not.toContainReactComponent(Box, {
+ background: 'surface-neutral',
+ });
});
it('renders SkeletonTitle when a title not defined', () => {
@@ -47,8 +49,8 @@ describe('
', () => {
expect(skeletonPage).not.toContainReactComponent('h1', {
className: 'Title',
});
- expect(skeletonPage).toContainReactComponent('div', {
- className: 'SkeletonTitle',
+ expect(skeletonPage).toContainReactComponent(Box, {
+ background: 'surface-neutral',
});
});
@@ -58,8 +60,8 @@ describe('
', () => {
expect(skeletonPage).not.toContainReactComponent('h1', {
className: 'Title',
});
- expect(skeletonPage).toContainReactComponent('div', {
- className: 'SkeletonTitle',
+ expect(skeletonPage).toContainReactComponent(Box, {
+ background: 'surface-neutral',
});
});
});
diff --git a/polaris.shopify.com/src/data/props.json b/polaris.shopify.com/src/data/props.json
index 5d1c6d4176b..4e11be9979f 100644
--- a/polaris.shopify.com/src/data/props.json
+++ b/polaris.shopify.com/src/data/props.json
@@ -3179,6 +3179,13 @@
"name": "BreakpointsMatches",
"value": "{\n [DirectionAlias in BreakpointsDirectionAlias]: boolean;\n}",
"description": "Match results for each directional Polaris `breakpoints` alias."
+ },
+ "polaris-react/src/components/ResourceItem/ResourceItem.tsx": {
+ "filePath": "polaris-react/src/components/ResourceItem/ResourceItem.tsx",
+ "syntaxKind": "TypeAliasDeclaration",
+ "name": "BreakpointsMatches",
+ "value": "{\n [DirectionAlias in BreakpointsDirectionAlias]: boolean;\n}",
+ "description": ""
}
},
"UseBreakpointsOptions": {
@@ -7696,6 +7703,57 @@
"description": ""
}
},
+ "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": ""
+ }
+ },
"ActionMenuProps": {
"polaris-react/src/components/ActionMenu/ActionMenu.tsx": {
"filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx",
@@ -7746,6 +7804,103 @@
"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",
+ "syntaxKind": "TypeAliasDeclaration",
+ "name": "CardBackgroundColorTokenScale",
+ "value": "\"surface\" | \"surface-subdued\"",
+ "description": ""
+ }
+ },
+ "Spacing": {
+ "polaris-react/src/components/AlphaCard/AlphaCard.tsx": {
+ "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx",
+ "syntaxKind": "TypeAliasDeclaration",
+ "name": "Spacing",
+ "value": "ResponsiveProp
",
+ "description": ""
+ },
+ "polaris-react/src/components/Bleed/Bleed.tsx": {
+ "filePath": "polaris-react/src/components/Bleed/Bleed.tsx",
+ "syntaxKind": "TypeAliasDeclaration",
+ "name": "Spacing",
+ "value": "ResponsiveProp",
+ "description": ""
+ },
+ "polaris-react/src/components/Box/Box.tsx": {
+ "filePath": "polaris-react/src/components/Box/Box.tsx",
+ "syntaxKind": "TypeAliasDeclaration",
+ "name": "Spacing",
+ "value": "ResponsiveProp",
+ "description": ""
+ },
+ "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx": {
+ "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx",
+ "syntaxKind": "TypeAliasDeclaration",
+ "name": "Spacing",
+ "value": "'extraTight' | 'tight' | 'loose'",
+ "description": ""
+ },
+ "polaris-react/src/components/Stack/Stack.tsx": {
+ "filePath": "polaris-react/src/components/Stack/Stack.tsx",
+ "syntaxKind": "TypeAliasDeclaration",
+ "name": "Spacing",
+ "value": "'extraTight' | 'tight' | 'baseTight' | 'loose' | 'extraLoose' | 'none'",
+ "description": ""
+ },
+ "polaris-react/src/components/TextContainer/TextContainer.tsx": {
+ "filePath": "polaris-react/src/components/TextContainer/TextContainer.tsx",
+ "syntaxKind": "TypeAliasDeclaration",
+ "name": "Spacing",
+ "value": "'tight' | 'loose'",
+ "description": ""
+ }
+ },
+ "AlphaCardProps": {
+ "polaris-react/src/components/AlphaCard/AlphaCard.tsx": {
+ "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx",
+ "name": "AlphaCardProps",
+ "description": "",
+ "members": [
+ {
+ "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx",
+ "syntaxKind": "PropertySignature",
+ "name": "children",
+ "value": "React.ReactNode",
+ "description": "",
+ "isOptional": true
+ },
+ {
+ "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx",
+ "syntaxKind": "PropertySignature",
+ "name": "background",
+ "value": "CardBackgroundColorTokenScale",
+ "description": "Background color",
+ "isOptional": true,
+ "defaultValue": "'surface'"
+ },
+ {
+ "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx",
+ "syntaxKind": "PropertySignature",
+ "name": "padding",
+ "value": "Spacing",
+ "description": "The spacing around the card",
+ "isOptional": true,
+ "defaultValue": "{xs: '4', sm: '5'}"
+ },
+ {
+ "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx",
+ "syntaxKind": "PropertySignature",
+ "name": "roundedAbove",
+ "value": "\"xs\" | \"sm\" | \"md\" | \"lg\" | \"xl\"",
+ "description": "Border radius value above a set breakpoint",
+ "isOptional": true
+ }
+ ],
+ "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 {xs: '4', sm: '5'}\n * @example\n * padding='4'\n * padding={{xs: '2', sm: '3', md: '4', lg: '5', xl: '6'}}\n */\n padding?: Spacing;\n /** Border radius value above a set breakpoint */\n roundedAbove?: BreakpointsAlias;\n}"
+ }
+ },
"Props": {
"polaris-react/src/components/AfterInitialMount/AfterInitialMount.tsx": {
"filePath": "polaris-react/src/components/AfterInitialMount/AfterInitialMount.tsx",
@@ -8030,74 +8185,83 @@
"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}"
}
},
- "CardBackgroundColorTokenScale": {
- "polaris-react/src/components/AlphaCard/AlphaCard.tsx": {
- "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx",
+ "Align": {
+ "polaris-react/src/components/AlphaStack/AlphaStack.tsx": {
+ "filePath": "polaris-react/src/components/AlphaStack/AlphaStack.tsx",
"syntaxKind": "TypeAliasDeclaration",
- "name": "CardBackgroundColorTokenScale",
- "value": "\"surface\" | \"surface-subdued\"",
+ "name": "Align",
+ "value": "'start' | 'end' | 'center'",
"description": ""
- }
- },
- "Spacing": {
- "polaris-react/src/components/AlphaCard/AlphaCard.tsx": {
- "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx",
+ },
+ "polaris-react/src/components/Inline/Inline.tsx": {
+ "filePath": "polaris-react/src/components/Inline/Inline.tsx",
"syntaxKind": "TypeAliasDeclaration",
- "name": "Spacing",
- "value": "ResponsiveProp",
+ "name": "Align",
+ "value": "'start' | 'center' | 'end' | 'space-around' | 'space-between' | 'space-evenly'",
"description": ""
- },
- "polaris-react/src/components/Bleed/Bleed.tsx": {
- "filePath": "polaris-react/src/components/Bleed/Bleed.tsx",
+ }
+ },
+ "Element": {
+ "polaris-react/src/components/AlphaStack/AlphaStack.tsx": {
+ "filePath": "polaris-react/src/components/AlphaStack/AlphaStack.tsx",
"syntaxKind": "TypeAliasDeclaration",
- "name": "Spacing",
- "value": "ResponsiveProp",
+ "name": "Element",
+ "value": "'div' | 'ul' | 'ol' | 'fieldset'",
"description": ""
},
"polaris-react/src/components/Box/Box.tsx": {
"filePath": "polaris-react/src/components/Box/Box.tsx",
"syntaxKind": "TypeAliasDeclaration",
- "name": "Spacing",
- "value": "ResponsiveProp",
+ "name": "Element",
+ "value": "'div' | 'span' | 'section' | 'legend' | 'ul' | 'li'",
"description": ""
},
- "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx": {
- "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx",
+ "polaris-react/src/components/Text/Text.tsx": {
+ "filePath": "polaris-react/src/components/Text/Text.tsx",
"syntaxKind": "TypeAliasDeclaration",
- "name": "Spacing",
- "value": "'extraTight' | 'tight' | 'loose'",
+ "name": "Element",
+ "value": "'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6' | 'p' | 'span' | 'legend'",
+ "description": ""
+ }
+ },
+ "Gap": {
+ "polaris-react/src/components/AlphaStack/AlphaStack.tsx": {
+ "filePath": "polaris-react/src/components/AlphaStack/AlphaStack.tsx",
+ "syntaxKind": "TypeAliasDeclaration",
+ "name": "Gap",
+ "value": "ResponsiveProp",
"description": ""
},
- "polaris-react/src/components/List/List.tsx": {
- "filePath": "polaris-react/src/components/List/List.tsx",
+ "polaris-react/src/components/Columns/Columns.tsx": {
+ "filePath": "polaris-react/src/components/Columns/Columns.tsx",
"syntaxKind": "TypeAliasDeclaration",
- "name": "Spacing",
- "value": "'extraTight' | 'loose'",
+ "name": "Gap",
+ "value": "ResponsiveProp",
"description": ""
},
- "polaris-react/src/components/Stack/Stack.tsx": {
- "filePath": "polaris-react/src/components/Stack/Stack.tsx",
+ "polaris-react/src/components/Grid/Grid.tsx": {
+ "filePath": "polaris-react/src/components/Grid/Grid.tsx",
"syntaxKind": "TypeAliasDeclaration",
- "name": "Spacing",
- "value": "'extraTight' | 'tight' | 'baseTight' | 'loose' | 'extraLoose' | 'none'",
+ "name": "Gap",
+ "value": "{\n [Breakpoint in Breakpoints]?: string;\n}",
"description": ""
},
- "polaris-react/src/components/TextContainer/TextContainer.tsx": {
- "filePath": "polaris-react/src/components/TextContainer/TextContainer.tsx",
+ "polaris-react/src/components/Inline/Inline.tsx": {
+ "filePath": "polaris-react/src/components/Inline/Inline.tsx",
"syntaxKind": "TypeAliasDeclaration",
- "name": "Spacing",
- "value": "'tight' | 'loose'",
+ "name": "Gap",
+ "value": "ResponsiveProp",
"description": ""
}
},
- "AlphaCardProps": {
- "polaris-react/src/components/AlphaCard/AlphaCard.tsx": {
- "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx",
- "name": "AlphaCardProps",
+ "AlphaStackProps": {
+ "polaris-react/src/components/AlphaStack/AlphaStack.tsx": {
+ "filePath": "polaris-react/src/components/AlphaStack/AlphaStack.tsx",
+ "name": "AlphaStackProps",
"description": "",
"members": [
{
- "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx",
+ "filePath": "polaris-react/src/components/AlphaStack/AlphaStack.tsx",
"syntaxKind": "PropertySignature",
"name": "children",
"value": "React.ReactNode",
@@ -8105,129 +8269,16 @@
"isOptional": true
},
{
- "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx",
+ "filePath": "polaris-react/src/components/AlphaStack/AlphaStack.tsx",
"syntaxKind": "PropertySignature",
- "name": "background",
- "value": "CardBackgroundColorTokenScale",
- "description": "Background color",
+ "name": "as",
+ "value": "Element",
+ "description": "HTML Element type",
"isOptional": true,
- "defaultValue": "'surface'"
+ "defaultValue": "'div'"
},
{
- "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx",
- "syntaxKind": "PropertySignature",
- "name": "padding",
- "value": "Spacing",
- "description": "The spacing around the card",
- "isOptional": true,
- "defaultValue": "{xs: '4', sm: '5'}"
- },
- {
- "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx",
- "syntaxKind": "PropertySignature",
- "name": "roundedAbove",
- "value": "\"xs\" | \"sm\" | \"md\" | \"lg\" | \"xl\"",
- "description": "Border radius value above a set breakpoint",
- "isOptional": true
- }
- ],
- "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 {xs: '4', sm: '5'}\n * @example\n * padding='4'\n * padding={{xs: '2', sm: '3', md: '4', lg: '5', xl: '6'}}\n */\n padding?: Spacing;\n /** Border radius value above a set breakpoint */\n roundedAbove?: BreakpointsAlias;\n}"
- }
- },
- "Align": {
- "polaris-react/src/components/AlphaStack/AlphaStack.tsx": {
- "filePath": "polaris-react/src/components/AlphaStack/AlphaStack.tsx",
- "syntaxKind": "TypeAliasDeclaration",
- "name": "Align",
- "value": "'start' | 'end' | 'center'",
- "description": ""
- },
- "polaris-react/src/components/Inline/Inline.tsx": {
- "filePath": "polaris-react/src/components/Inline/Inline.tsx",
- "syntaxKind": "TypeAliasDeclaration",
- "name": "Align",
- "value": "'start' | 'center' | 'end' | 'space-around' | 'space-between' | 'space-evenly'",
- "description": ""
- }
- },
- "Element": {
- "polaris-react/src/components/AlphaStack/AlphaStack.tsx": {
- "filePath": "polaris-react/src/components/AlphaStack/AlphaStack.tsx",
- "syntaxKind": "TypeAliasDeclaration",
- "name": "Element",
- "value": "'div' | 'ul' | 'ol' | 'fieldset'",
- "description": ""
- },
- "polaris-react/src/components/Box/Box.tsx": {
- "filePath": "polaris-react/src/components/Box/Box.tsx",
- "syntaxKind": "TypeAliasDeclaration",
- "name": "Element",
- "value": "'div' | 'span' | 'section' | 'legend' | 'ul' | 'li'",
- "description": ""
- },
- "polaris-react/src/components/Text/Text.tsx": {
- "filePath": "polaris-react/src/components/Text/Text.tsx",
- "syntaxKind": "TypeAliasDeclaration",
- "name": "Element",
- "value": "'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6' | 'p' | 'span' | 'legend'",
- "description": ""
- }
- },
- "Gap": {
- "polaris-react/src/components/AlphaStack/AlphaStack.tsx": {
- "filePath": "polaris-react/src/components/AlphaStack/AlphaStack.tsx",
- "syntaxKind": "TypeAliasDeclaration",
- "name": "Gap",
- "value": "ResponsiveProp",
- "description": ""
- },
- "polaris-react/src/components/Columns/Columns.tsx": {
- "filePath": "polaris-react/src/components/Columns/Columns.tsx",
- "syntaxKind": "TypeAliasDeclaration",
- "name": "Gap",
- "value": "ResponsiveProp",
- "description": ""
- },
- "polaris-react/src/components/Grid/Grid.tsx": {
- "filePath": "polaris-react/src/components/Grid/Grid.tsx",
- "syntaxKind": "TypeAliasDeclaration",
- "name": "Gap",
- "value": "{\n [Breakpoint in Breakpoints]?: string;\n}",
- "description": ""
- },
- "polaris-react/src/components/Inline/Inline.tsx": {
- "filePath": "polaris-react/src/components/Inline/Inline.tsx",
- "syntaxKind": "TypeAliasDeclaration",
- "name": "Gap",
- "value": "ResponsiveProp",
- "description": ""
- }
- },
- "AlphaStackProps": {
- "polaris-react/src/components/AlphaStack/AlphaStack.tsx": {
- "filePath": "polaris-react/src/components/AlphaStack/AlphaStack.tsx",
- "name": "AlphaStackProps",
- "description": "",
- "members": [
- {
- "filePath": "polaris-react/src/components/AlphaStack/AlphaStack.tsx",
- "syntaxKind": "PropertySignature",
- "name": "children",
- "value": "React.ReactNode",
- "description": "",
- "isOptional": true
- },
- {
- "filePath": "polaris-react/src/components/AlphaStack/AlphaStack.tsx",
- "syntaxKind": "PropertySignature",
- "name": "as",
- "value": "Element",
- "description": "HTML Element type",
- "isOptional": true,
- "defaultValue": "'div'"
- },
- {
- "filePath": "polaris-react/src/components/AlphaStack/AlphaStack.tsx",
+ "filePath": "polaris-react/src/components/AlphaStack/AlphaStack.tsx",
"syntaxKind": "PropertySignature",
"name": "align",
"value": "Align",
@@ -8270,7 +8321,7 @@
"isOptional": true
}
],
- "value": "export interface AlphaStackProps extends React.AriaAttributes {\n children?: React.ReactNode;\n /** HTML Element type\n * @default 'div'\n */\n as?: Element;\n /** Horizontal alignment of children\n * @default 'start'\n */\n align?: Align;\n /** Toggle children to be full width\n * @default false\n */\n fullWidth?: boolean;\n /** The spacing between children\n * @default '4'\n */\n gap?: Gap;\n /** HTML id attribute */\n id?: string;\n /** Toggle order of child items */\n reverseOrder?: boolean;\n}"
+ "value": "export interface AlphaStackProps extends React.AriaAttributes {\n children?: React.ReactNode;\n /** HTML Element type\n * @default 'div'\n */\n as?: Element;\n /** Vertical alignment of children\n * @default 'start'\n */\n align?: Align;\n /** Toggle children to be full width\n * @default false\n */\n fullWidth?: boolean;\n /** The spacing between children\n * @default '4'\n */\n gap?: Gap;\n /** HTML id attribute */\n id?: string;\n /** Toggle order of child items */\n reverseOrder?: boolean;\n}"
}
},
"State": {
@@ -9122,62 +9173,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",
@@ -9559,6 +9554,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": {
@@ -10802,64 +10853,32 @@
"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",
- "description": "Determines the space between button group items",
+ "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}"
+ }
+ },
+ "CalloutCardProps": {
+ "polaris-react/src/components/CalloutCard/CalloutCard.tsx": {
+ "filePath": "polaris-react/src/components/CalloutCard/CalloutCard.tsx",
+ "name": "CalloutCardProps",
+ "description": "",
+ "members": [
{
- "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx",
- "syntaxKind": "PropertySignature",
- "name": "segmented",
- "value": "boolean",
- "description": "Join buttons as segmented group",
- "isOptional": true
- },
- {
- "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx",
- "syntaxKind": "PropertySignature",
- "name": "fullWidth",
- "value": "boolean",
- "description": "Buttons will stretch/shrink to occupy the full width",
- "isOptional": true
- },
- {
- "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx",
- "syntaxKind": "PropertySignature",
- "name": "connectedTop",
- "value": "boolean",
- "description": "Remove top left and right border radius",
- "isOptional": true
- },
- {
- "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx",
- "syntaxKind": "PropertySignature",
- "name": "children",
- "value": "React.ReactNode",
- "description": "Button components",
- "isOptional": true
- }
- ],
- "value": "export interface ButtonGroupProps {\n /** Determines the space between button group items */\n spacing?: Spacing;\n /** Join buttons as segmented group */\n segmented?: boolean;\n /** Buttons will stretch/shrink to occupy the full width */\n fullWidth?: boolean;\n /** Remove top left and right border radius */\n connectedTop?: boolean;\n /** Button components */\n children?: React.ReactNode;\n}"
- }
- },
- "CalloutCardProps": {
- "polaris-react/src/components/CalloutCard/CalloutCard.tsx": {
- "filePath": "polaris-react/src/components/CalloutCard/CalloutCard.tsx",
- "name": "CalloutCardProps",
- "description": "",
- "members": [
- {
- "filePath": "polaris-react/src/components/CalloutCard/CalloutCard.tsx",
+ "filePath": "polaris-react/src/components/CalloutCard/CalloutCard.tsx",
"syntaxKind": "PropertySignature",
"name": "children",
"value": "React.ReactNode",
@@ -10907,22 +10926,54 @@
"value": "export interface CalloutCardProps {\n /** The content to display inside the callout card. */\n children?: React.ReactNode;\n /** The title of the card */\n title: React.ReactNode;\n /** URL to the card illustration */\n illustration: string;\n /** Primary action for the card */\n primaryAction: Action;\n /** Secondary action for the card */\n secondaryAction?: Action;\n /** Callback when banner is dismissed */\n onDismiss?(): void;\n}"
}
},
- "CaptionProps": {
- "polaris-react/src/components/Caption/Caption.tsx": {
- "filePath": "polaris-react/src/components/Caption/Caption.tsx",
- "name": "CaptionProps",
+ "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/Caption/Caption.tsx",
+ "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx",
+ "syntaxKind": "PropertySignature",
+ "name": "spacing",
+ "value": "Spacing",
+ "description": "Determines the space between button group items",
+ "isOptional": true
+ },
+ {
+ "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx",
+ "syntaxKind": "PropertySignature",
+ "name": "segmented",
+ "value": "boolean",
+ "description": "Join buttons as segmented group",
+ "isOptional": true
+ },
+ {
+ "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx",
+ "syntaxKind": "PropertySignature",
+ "name": "fullWidth",
+ "value": "boolean",
+ "description": "Buttons will stretch/shrink to occupy the full width",
+ "isOptional": true
+ },
+ {
+ "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx",
+ "syntaxKind": "PropertySignature",
+ "name": "connectedTop",
+ "value": "boolean",
+ "description": "Remove top left and right border radius",
+ "isOptional": true
+ },
+ {
+ "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx",
"syntaxKind": "PropertySignature",
"name": "children",
"value": "React.ReactNode",
- "description": "The content to use as a graph label or timestamp",
+ "description": "Button components",
"isOptional": true
}
],
- "value": "export interface CaptionProps {\n /** The content to use as a graph label or timestamp */\n children?: React.ReactNode;\n}"
+ "value": "export interface ButtonGroupProps {\n /** Determines the space between button group items */\n spacing?: Spacing;\n /** Join buttons as segmented group */\n segmented?: boolean;\n /** Buttons will stretch/shrink to occupy the full width */\n fullWidth?: boolean;\n /** Remove top left and right border radius */\n connectedTop?: boolean;\n /** Button components */\n children?: React.ReactNode;\n}"
}
},
"CardProps": {
@@ -11015,50 +11066,88 @@
"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}"
}
},
- "CheckableButtonProps": {
- "polaris-react/src/components/CheckableButton/CheckableButton.tsx": {
- "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx",
- "name": "CheckableButtonProps",
+ "ChoiceProps": {
+ "polaris-react/src/components/Choice/Choice.tsx": {
+ "filePath": "polaris-react/src/components/Choice/Choice.tsx",
+ "name": "ChoiceProps",
"description": "",
"members": [
{
- "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx",
+ "filePath": "polaris-react/src/components/Choice/Choice.tsx",
"syntaxKind": "PropertySignature",
- "name": "accessibilityLabel",
+ "name": "id",
"value": "string",
- "description": "",
- "isOptional": true
+ "description": "A unique identifier for the choice"
},
{
- "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx",
+ "filePath": "polaris-react/src/components/Choice/Choice.tsx",
"syntaxKind": "PropertySignature",
"name": "label",
- "value": "string",
- "description": "",
+ "value": "React.ReactNode",
+ "description": "Label for the choice"
+ },
+ {
+ "filePath": "polaris-react/src/components/Choice/Choice.tsx",
+ "syntaxKind": "PropertySignature",
+ "name": "disabled",
+ "value": "boolean",
+ "description": "Whether the associated form control is disabled",
"isOptional": true
},
{
- "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx",
+ "filePath": "polaris-react/src/components/Choice/Choice.tsx",
"syntaxKind": "PropertySignature",
- "name": "selected",
- "value": "boolean | \"indeterminate\"",
- "description": "",
+ "name": "error",
+ "value": "any",
+ "description": "Display an error message",
"isOptional": true
},
{
- "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx",
+ "filePath": "polaris-react/src/components/Choice/Choice.tsx",
"syntaxKind": "PropertySignature",
- "name": "disabled",
+ "name": "labelHidden",
"value": "boolean",
- "description": "",
+ "description": "Visually hide the label",
"isOptional": true
},
{
- "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx",
+ "filePath": "polaris-react/src/components/Choice/Choice.tsx",
+ "syntaxKind": "PropertySignature",
+ "name": "children",
+ "value": "React.ReactNode",
+ "description": "Content to display inside the choice",
+ "isOptional": true
+ },
+ {
+ "filePath": "polaris-react/src/components/Choice/Choice.tsx",
+ "syntaxKind": "PropertySignature",
+ "name": "helpText",
+ "value": "React.ReactNode",
+ "description": "Additional text to aide in use",
+ "isOptional": true
+ },
+ {
+ "filePath": "polaris-react/src/components/Choice/Choice.tsx",
"syntaxKind": "MethodSignature",
- "name": "onToggleAll",
+ "name": "onClick",
"value": "() => void",
- "description": "",
+ "description": "Callback when clicked",
+ "isOptional": true
+ },
+ {
+ "filePath": "polaris-react/src/components/Choice/Choice.tsx",
+ "syntaxKind": "MethodSignature",
+ "name": "onMouseOver",
+ "value": "() => void",
+ "description": "Callback when mouse over",
+ "isOptional": true
+ },
+ {
+ "filePath": "polaris-react/src/components/Choice/Choice.tsx",
+ "syntaxKind": "MethodSignature",
+ "name": "onMouseOut",
+ "value": "() => void",
+ "description": "Callback when mouse out",
"isOptional": true
},
{
@@ -11070,7 +11159,7 @@
"isOptional": true
}
],
- "value": "export interface CheckableButtonProps {\n accessibilityLabel?: string;\n label?: string;\n selected?: boolean | 'indeterminate';\n disabled?: boolean;\n onToggleAll?(): void;\n ariaLive?: 'off' | 'polite';\n}"
+ "value": "export interface ChoiceProps {\n /** A unique identifier for the choice */\n id: string;\n /**\tLabel for the choice */\n label: React.ReactNode;\n /** Whether the associated form control is disabled */\n disabled?: boolean;\n /** Display an error message */\n error?: Error | boolean;\n /** Visually hide the label */\n labelHidden?: boolean;\n /** Content to display inside the choice */\n children?: React.ReactNode;\n /** Additional text to aide in use */\n helpText?: React.ReactNode;\n /** Callback when clicked */\n onClick?(): void;\n /** Callback when mouse over */\n onMouseOver?(): void;\n /** Callback when mouse out */\n onMouseOut?(): void;\n}"
}
},
"CheckboxProps": {
@@ -11265,92 +11354,62 @@
"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}"
}
},
- "ChoiceProps": {
- "polaris-react/src/components/Choice/Choice.tsx": {
- "filePath": "polaris-react/src/components/Choice/Choice.tsx",
- "name": "ChoiceProps",
+ "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/Choice/Choice.tsx",
+ "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx",
"syntaxKind": "PropertySignature",
- "name": "id",
+ "name": "accessibilityLabel",
"value": "string",
- "description": "A unique identifier for the choice"
+ "description": "",
+ "isOptional": true
},
{
- "filePath": "polaris-react/src/components/Choice/Choice.tsx",
+ "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx",
"syntaxKind": "PropertySignature",
"name": "label",
- "value": "React.ReactNode",
- "description": "Label for the choice"
- },
- {
- "filePath": "polaris-react/src/components/Choice/Choice.tsx",
- "syntaxKind": "PropertySignature",
- "name": "disabled",
- "value": "boolean",
- "description": "Whether the associated form control is disabled",
+ "value": "string",
+ "description": "",
"isOptional": true
},
{
- "filePath": "polaris-react/src/components/Choice/Choice.tsx",
+ "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx",
"syntaxKind": "PropertySignature",
- "name": "error",
- "value": "any",
- "description": "Display an error message",
+ "name": "selected",
+ "value": "boolean | \"indeterminate\"",
+ "description": "",
"isOptional": true
},
{
- "filePath": "polaris-react/src/components/Choice/Choice.tsx",
+ "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx",
"syntaxKind": "PropertySignature",
- "name": "labelHidden",
+ "name": "disabled",
"value": "boolean",
- "description": "Visually hide the label",
- "isOptional": true
- },
- {
- "filePath": "polaris-react/src/components/Choice/Choice.tsx",
- "syntaxKind": "PropertySignature",
- "name": "children",
- "value": "React.ReactNode",
- "description": "Content to display inside the choice",
- "isOptional": true
- },
- {
- "filePath": "polaris-react/src/components/Choice/Choice.tsx",
- "syntaxKind": "PropertySignature",
- "name": "helpText",
- "value": "React.ReactNode",
- "description": "Additional text to aide in use",
- "isOptional": true
- },
- {
- "filePath": "polaris-react/src/components/Choice/Choice.tsx",
- "syntaxKind": "MethodSignature",
- "name": "onClick",
- "value": "() => void",
- "description": "Callback when clicked",
+ "description": "",
"isOptional": true
},
{
- "filePath": "polaris-react/src/components/Choice/Choice.tsx",
+ "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx",
"syntaxKind": "MethodSignature",
- "name": "onMouseOver",
+ "name": "onToggleAll",
"value": "() => void",
- "description": "Callback when mouse over",
+ "description": "",
"isOptional": true
},
{
- "filePath": "polaris-react/src/components/Choice/Choice.tsx",
- "syntaxKind": "MethodSignature",
- "name": "onMouseOut",
- "value": "() => void",
- "description": "Callback when mouse out",
+ "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx",
+ "syntaxKind": "PropertySignature",
+ "name": "ariaLive",
+ "value": "\"off\" | \"polite\"",
+ "description": "",
"isOptional": true
}
],
- "value": "export interface ChoiceProps {\n /** A unique identifier for the choice */\n id: string;\n /**\tLabel for the choice */\n label: React.ReactNode;\n /** Whether the associated form control is disabled */\n disabled?: boolean;\n /** Display an error message */\n error?: Error | boolean;\n /** Visually hide the label */\n labelHidden?: boolean;\n /** Content to display inside the choice */\n children?: React.ReactNode;\n /** Additional text to aide in use */\n helpText?: React.ReactNode;\n /** Callback when clicked */\n onClick?(): void;\n /** Callback when mouse over */\n onMouseOver?(): void;\n /** Callback when mouse out */\n onMouseOut?(): void;\n}"
+ "value": "export interface CheckableButtonProps {\n accessibilityLabel?: string;\n label?: string;\n selected?: boolean | 'indeterminate';\n disabled?: boolean;\n onToggleAll?(): void;\n ariaLive?: 'off' | 'polite';\n}"
}
},
"Choice": {
@@ -11568,14 +11627,6 @@
"isOptional": true,
"deprecationMessage": "Re-measuring is no longer necessary on children update *"
},
- {
- "filePath": "polaris-react/src/components/Collapsible/Collapsible.tsx",
- "syntaxKind": "MethodSignature",
- "name": "onAnimationEnd",
- "value": "() => void",
- "description": "Callback when the animation completes.",
- "isOptional": true
- },
{
"filePath": "polaris-react/src/components/Collapsible/Collapsible.tsx",
"syntaxKind": "PropertySignature",
@@ -11585,7 +11636,7 @@
"isOptional": true
}
],
- "value": "export interface CollapsibleProps {\n /** Assign a unique ID to the collapsible. For accessibility, pass this ID as the value of the triggering component’s aria-controls prop. */\n id: string;\n /** Option to show collapsible content when printing */\n expandOnPrint?: boolean;\n /** Toggle whether the collapsible is expanded or not. */\n open: boolean;\n /** Override transition properties. When set to false, disables transition completely.\n * @default transition={{duration: 'var(--p-duration-150)', timingFunction: 'var(--p-ease-in-out)'}}\n */\n transition?: boolean | Transition;\n /** @deprecated Re-measuring is no longer necessary on children update **/\n preventMeasuringOnChildrenUpdate?: boolean;\n /** Callback when the animation completes. */\n onAnimationEnd?(): void;\n /** The content to display inside the collapsible. */\n children?: React.ReactNode;\n}"
+ "value": "export interface CollapsibleProps {\n /** Assign a unique ID to the collapsible. For accessibility, pass this ID as the value of the triggering component’s aria-controls prop. */\n id: string;\n /** Option to show collapsible content when printing */\n expandOnPrint?: boolean;\n /** Toggle whether the collapsible is expanded or not. */\n open: boolean;\n /** Override transition properties. When set to false, disables transition completely.\n * @default transition={{duration: 'var(--p-duration-150)', timingFunction: 'var(--p-ease-in-out)'}}\n */\n transition?: boolean | Transition;\n /** @deprecated Re-measuring is no longer necessary on children update **/\n preventMeasuringOnChildrenUpdate?: boolean;\n /** The content to display inside the collapsible. */\n children?: React.ReactNode;\n}"
}
},
"AnimationState": {
@@ -11697,112 +11748,12 @@
{
"filePath": "polaris-react/src/components/ColorPicker/ColorPicker.tsx",
"syntaxKind": "MethodSignature",
- "name": "onChange",
- "value": "(color: HSBAColor) => void",
- "description": "Callback when color is selected"
- }
- ],
- "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/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": "children",
- "value": "React.ReactNode",
- "description": "",
- "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 children. Accepts a spacing token or an object of spacing tokens for different screen sizes.",
- "isOptional": true,
- "defaultValue": "'4'"
+ "name": "onChange",
+ "value": "(color: HSBAColor) => void",
+ "description": "Callback when color is selected"
}
],
- "value": "export interface ColumnsProps {\n children?: React.ReactNode;\n /** The number of columns to display\n * @default {xs: 6, sm: 6, md: 6, lg: 6, xl: 6}\n */\n columns?: Columns;\n /** The spacing between children. Accepts a spacing token or an object of spacing tokens for different screen sizes.\n * @default '4'\n * @example\n * gap='2'\n * gap={{xs: '1', sm: '2', md: '3', lg: '4', xl: '5'}}\n */\n gap?: Gap;\n}"
+ "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}"
}
},
"ComboboxProps": {
@@ -11912,6 +11863,106 @@
"value": "export interface ConnectedProps {\n /** Content to display on the left */\n left?: React.ReactNode;\n /** Content to display on the right */\n right?: React.ReactNode;\n /** Connected content */\n children?: React.ReactNode;\n}"
}
},
+ "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/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": "children",
+ "value": "React.ReactNode",
+ "description": "",
+ "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 children. Accepts a spacing token or an object of spacing tokens for different screen sizes.",
+ "isOptional": true,
+ "defaultValue": "'4'"
+ }
+ ],
+ "value": "export interface ColumnsProps {\n children?: React.ReactNode;\n /** The number of columns to display\n * @default {xs: 6, sm: 6, md: 6, lg: 6, xl: 6}\n */\n columns?: Columns;\n /** The spacing between children. Accepts a spacing token or an object of spacing tokens for different screen sizes.\n * @default '4'\n * @example\n * gap='2'\n * gap={{xs: '1', sm: '2', md: '3', lg: '4', xl: '5'}}\n */\n gap?: Gap;\n}"
+ }
+ },
"TableRow": {
"polaris-react/src/components/DataTable/DataTable.tsx": {
"filePath": "polaris-react/src/components/DataTable/DataTable.tsx",
@@ -12233,6 +12284,42 @@
"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}"
}
},
+ "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/DisplayText/DisplayText.tsx",
+ "syntaxKind": "PropertySignature",
+ "name": "element",
+ "value": "HeadingTagName",
+ "description": "Name of element to use for text",
+ "isOptional": true,
+ "defaultValue": "'p'"
+ },
+ {
+ "filePath": "polaris-react/src/components/DisplayText/DisplayText.tsx",
+ "syntaxKind": "PropertySignature",
+ "name": "size",
+ "value": "Size",
+ "description": "Size of the text",
+ "isOptional": true,
+ "defaultValue": "'medium'"
+ },
+ {
+ "filePath": "polaris-react/src/components/DisplayText/DisplayText.tsx",
+ "syntaxKind": "PropertySignature",
+ "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",
@@ -12330,60 +12417,6 @@
"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",
- "description": "",
- "members": [
- {
- "filePath": "polaris-react/src/components/DisplayText/DisplayText.tsx",
- "syntaxKind": "PropertySignature",
- "name": "element",
- "value": "HeadingTagName",
- "description": "Name of element to use for text",
- "isOptional": true,
- "defaultValue": "'p'"
- },
- {
- "filePath": "polaris-react/src/components/DisplayText/DisplayText.tsx",
- "syntaxKind": "PropertySignature",
- "name": "size",
- "value": "Size",
- "description": "Size of the text",
- "isOptional": true,
- "defaultValue": "'medium'"
- },
- {
- "filePath": "polaris-react/src/components/DisplayText/DisplayText.tsx",
- "syntaxKind": "PropertySignature",
- "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}"
- }
- },
- "DividerProps": {
- "polaris-react/src/components/Divider/Divider.tsx": {
- "filePath": "polaris-react/src/components/Divider/Divider.tsx",
- "name": "DividerProps",
- "description": "",
- "members": [
- {
- "filePath": "polaris-react/src/components/Divider/Divider.tsx",
- "syntaxKind": "PropertySignature",
- "name": "borderStyle",
- "value": "BorderTokenAlias",
- "description": "Divider border style",
- "isOptional": true
- }
- ],
- "value": "export interface DividerProps {\n /** Divider border style */\n borderStyle?: BorderTokenAlias;\n}"
- }
- },
"DropZoneFileType": {
"polaris-react/src/components/DropZone/DropZone.tsx": {
"filePath": "polaris-react/src/components/DropZone/DropZone.tsx",
@@ -12758,6 +12791,24 @@
"value": "interface DropZoneContextType {\n disabled: boolean;\n focused: boolean;\n measuring: boolean;\n allowMultiple: boolean;\n size: string;\n type: string;\n}"
}
},
+ "DividerProps": {
+ "polaris-react/src/components/Divider/Divider.tsx": {
+ "filePath": "polaris-react/src/components/Divider/Divider.tsx",
+ "name": "DividerProps",
+ "description": "",
+ "members": [
+ {
+ "filePath": "polaris-react/src/components/Divider/Divider.tsx",
+ "syntaxKind": "PropertySignature",
+ "name": "borderStyle",
+ "value": "BorderTokenAlias",
+ "description": "Divider border style",
+ "isOptional": true
+ }
+ ],
+ "value": "export interface DividerProps {\n /** Divider border style */\n borderStyle?: BorderTokenAlias;\n}"
+ }
+ },
"EmptySearchResultProps": {
"polaris-react/src/components/EmptySearchResult/EmptySearchResult.tsx": {
"filePath": "polaris-react/src/components/EmptySearchResult/EmptySearchResult.tsx",
@@ -14266,24 +14317,6 @@
"value": "export interface IndexTableProps\n extends IndexTableBaseProps,\n IndexProviderProps {}"
}
},
- "IndicatorProps": {
- "polaris-react/src/components/Indicator/Indicator.tsx": {
- "filePath": "polaris-react/src/components/Indicator/Indicator.tsx",
- "name": "IndicatorProps",
- "description": "",
- "members": [
- {
- "filePath": "polaris-react/src/components/Indicator/Indicator.tsx",
- "syntaxKind": "PropertySignature",
- "name": "pulse",
- "value": "boolean",
- "description": "",
- "isOptional": true
- }
- ],
- "value": "export interface IndicatorProps {\n pulse?: boolean;\n}"
- }
- },
"BlockAlign": {
"polaris-react/src/components/Inline/Inline.tsx": {
"filePath": "polaris-react/src/components/Inline/Inline.tsx",
@@ -14347,21 +14380,40 @@
"value": "export interface InlineProps {\n children?: React.ReactNode;\n /** Horizontal alignment of children\n * @default 'start'\n */\n align?: Align;\n /** Vertical alignment of children\n * @default 'center'\n */\n blockAlign?: BlockAlign;\n /** The spacing between elements. 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: '2', sm: '3', md: '4', lg: '5', xl: '6'}}\n */\n gap?: Gap;\n /** Wrap stack elements to additional rows as needed on small screens\n * @default true\n */\n wrap?: boolean;\n}"
}
},
- "InlineCodeProps": {
- "polaris-react/src/components/InlineCode/InlineCode.tsx": {
- "filePath": "polaris-react/src/components/InlineCode/InlineCode.tsx",
- "name": "InlineCodeProps",
+ "IndicatorProps": {
+ "polaris-react/src/components/Indicator/Indicator.tsx": {
+ "filePath": "polaris-react/src/components/Indicator/Indicator.tsx",
+ "name": "IndicatorProps",
+ "description": "",
+ "members": [
+ {
+ "filePath": "polaris-react/src/components/Indicator/Indicator.tsx",
+ "syntaxKind": "PropertySignature",
+ "name": "pulse",
+ "value": "boolean",
+ "description": "",
+ "isOptional": true
+ }
+ ],
+ "value": "export interface IndicatorProps {\n pulse?: boolean;\n}"
+ }
+ },
+ "KeyboardKeyProps": {
+ "polaris-react/src/components/KeyboardKey/KeyboardKey.tsx": {
+ "filePath": "polaris-react/src/components/KeyboardKey/KeyboardKey.tsx",
+ "name": "KeyboardKeyProps",
"description": "",
"members": [
{
- "filePath": "polaris-react/src/components/InlineCode/InlineCode.tsx",
+ "filePath": "polaris-react/src/components/KeyboardKey/KeyboardKey.tsx",
"syntaxKind": "PropertySignature",
"name": "children",
- "value": "ReactNode",
- "description": "The content to render inside the code block"
+ "value": "string",
+ "description": "The content to display inside the key",
+ "isOptional": true
}
],
- "value": "export interface InlineCodeProps {\n /** The content to render inside the code block */\n children: ReactNode;\n}"
+ "value": "export interface KeyboardKeyProps {\n /** The content to display inside the key */\n children?: string;\n}"
}
},
"InlineErrorProps": {
@@ -14388,22 +14440,21 @@
"value": "export interface InlineErrorProps {\n /** Content briefly explaining how to resolve the invalid form field input. */\n message: Error;\n /** Unique identifier of the invalid form field that the message describes */\n fieldID: string;\n}"
}
},
- "KeyboardKeyProps": {
- "polaris-react/src/components/KeyboardKey/KeyboardKey.tsx": {
- "filePath": "polaris-react/src/components/KeyboardKey/KeyboardKey.tsx",
- "name": "KeyboardKeyProps",
+ "InlineCodeProps": {
+ "polaris-react/src/components/InlineCode/InlineCode.tsx": {
+ "filePath": "polaris-react/src/components/InlineCode/InlineCode.tsx",
+ "name": "InlineCodeProps",
"description": "",
"members": [
{
- "filePath": "polaris-react/src/components/KeyboardKey/KeyboardKey.tsx",
+ "filePath": "polaris-react/src/components/InlineCode/InlineCode.tsx",
"syntaxKind": "PropertySignature",
"name": "children",
- "value": "string",
- "description": "The content to display inside the key",
- "isOptional": true
+ "value": "ReactNode",
+ "description": "The content to render inside the code block"
}
],
- "value": "export interface KeyboardKeyProps {\n /** The content to display inside the key */\n children?: string;\n}"
+ "value": "export interface InlineCodeProps {\n /** The content to render inside the code block */\n children: ReactNode;\n}"
}
},
"KeypressListenerProps": {
@@ -14424,23 +14475,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",
@@ -14482,6 +14516,23 @@
"value": "export interface LabelProps {\n /** Label content */\n children?: React.ReactNode;\n /** A unique identifier for the label */\n id: string;\n /** Visually hide the label */\n hidden?: 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}"
+ }
+ },
"LabelledProps": {
"polaris-react/src/components/Labelled/Labelled.tsx": {
"filePath": "polaris-react/src/components/Labelled/Labelled.tsx",
@@ -16889,6 +16940,14 @@
"name": "PropsFromWrapper",
"description": "",
"members": [
+ {
+ "filePath": "polaris-react/src/components/ResourceItem/ResourceItem.tsx",
+ "syntaxKind": "PropertySignature",
+ "name": "breakpoints",
+ "value": "BreakpointsMatches",
+ "description": "",
+ "isOptional": true
+ },
{
"filePath": "polaris-react/src/components/ResourceItem/ResourceItem.tsx",
"syntaxKind": "PropertySignature",
@@ -16904,7 +16963,7 @@
"description": ""
}
],
- "value": "interface PropsFromWrapper {\n context: React.ContextType;\n i18n: ReturnType;\n}"
+ "value": "interface PropsFromWrapper {\n breakpoints?: BreakpointsMatches;\n context: React.ContextType;\n i18n: ReturnType;\n}"
}
},
"ResourceListProps": {
@@ -17169,6 +17228,89 @@
"value": "export interface ScrollableProps extends React.HTMLProps {\n /** Content to display in scrollable area */\n children?: React.ReactNode;\n /** Scroll content vertically\n * @default true\n * */\n vertical?: boolean;\n /** Scroll content horizontally\n * @default true\n * */\n horizontal?: boolean;\n /** Add a shadow when content is scrollable */\n shadow?: boolean;\n /** Slightly hints content upon mounting when scrollable */\n hint?: boolean;\n /** Adds a tabIndex to scrollable when children are not focusable */\n focusable?: boolean;\n /** Called when scrolled to the bottom of the scroll area */\n onScrolledToBottom?(): void;\n}"
}
},
+ "AriaLive": {
+ "polaris-react/src/components/SelectAllActions/SelectAllActions.tsx": {
+ "filePath": "polaris-react/src/components/SelectAllActions/SelectAllActions.tsx",
+ "syntaxKind": "TypeAliasDeclaration",
+ "name": "AriaLive",
+ "value": "'off' | 'polite' | undefined",
+ "description": ""
+ }
+ },
+ "SelectAllActionsProps": {
+ "polaris-react/src/components/SelectAllActions/SelectAllActions.tsx": {
+ "filePath": "polaris-react/src/components/SelectAllActions/SelectAllActions.tsx",
+ "name": "SelectAllActionsProps",
+ "description": "",
+ "members": [
+ {
+ "filePath": "polaris-react/src/components/SelectAllActions/SelectAllActions.tsx",
+ "syntaxKind": "PropertySignature",
+ "name": "accessibilityLabel",
+ "value": "string",
+ "description": "Visually hidden text for screen readers",
+ "isOptional": true
+ },
+ {
+ "filePath": "polaris-react/src/components/SelectAllActions/SelectAllActions.tsx",
+ "syntaxKind": "PropertySignature",
+ "name": "label",
+ "value": "string",
+ "description": "Label for the bulk actions",
+ "isOptional": true
+ },
+ {
+ "filePath": "polaris-react/src/components/SelectAllActions/SelectAllActions.tsx",
+ "syntaxKind": "PropertySignature",
+ "name": "selected",
+ "value": "boolean | \"indeterminate\"",
+ "description": "State of the bulk actions checkbox",
+ "isOptional": true
+ },
+ {
+ "filePath": "polaris-react/src/components/SelectAllActions/SelectAllActions.tsx",
+ "syntaxKind": "PropertySignature",
+ "name": "selectMode",
+ "value": "boolean",
+ "description": "List is in a selectable state",
+ "isOptional": true
+ },
+ {
+ "filePath": "polaris-react/src/components/SelectAllActions/SelectAllActions.tsx",
+ "syntaxKind": "PropertySignature",
+ "name": "paginatedSelectAllText",
+ "value": "string",
+ "description": "Text to select all across pages",
+ "isOptional": true
+ },
+ {
+ "filePath": "polaris-react/src/components/SelectAllActions/SelectAllActions.tsx",
+ "syntaxKind": "PropertySignature",
+ "name": "paginatedSelectAllAction",
+ "value": "Action",
+ "description": "Action for selecting all across pages",
+ "isOptional": true
+ },
+ {
+ "filePath": "polaris-react/src/components/SelectAllActions/SelectAllActions.tsx",
+ "syntaxKind": "PropertySignature",
+ "name": "disabled",
+ "value": "boolean",
+ "description": "Disables bulk actions",
+ "isOptional": true
+ },
+ {
+ "filePath": "polaris-react/src/components/SelectAllActions/SelectAllActions.tsx",
+ "syntaxKind": "MethodSignature",
+ "name": "onToggleAll",
+ "value": "() => void",
+ "description": "Callback when the select all checkbox is clicked",
+ "isOptional": true
+ }
+ ],
+ "value": "export interface SelectAllActionsProps {\n /** Visually hidden text for screen readers */\n accessibilityLabel?: string;\n /** Label for the bulk actions */\n label?: string;\n /** State of the bulk actions checkbox */\n selected?: boolean | 'indeterminate';\n /** List is in a selectable state */\n selectMode?: boolean;\n /** Text to select all across pages */\n paginatedSelectAllText?: string;\n /** Action for selecting all across pages */\n paginatedSelectAllAction?: Action;\n /** Disables bulk actions */\n disabled?: boolean;\n /** Callback when the select all checkbox is clicked */\n onToggleAll?(): void;\n}"
+ }
+ },
"StrictOption": {
"polaris-react/src/components/Select/Select.tsx": {
"filePath": "polaris-react/src/components/Select/Select.tsx",
@@ -17861,6 +18003,15 @@
"value": "export interface SpinnerProps {\n onChange: HandleStepFn;\n onClick?(event: React.MouseEvent): void;\n onMouseDown(onChange: HandleStepFn): void;\n onMouseUp(): void;\n}"
}
},
+ "StickyProps": {
+ "polaris-react/src/components/Sticky/Sticky.tsx": {
+ "filePath": "polaris-react/src/components/Sticky/Sticky.tsx",
+ "syntaxKind": "TypeAliasDeclaration",
+ "name": "StickyProps",
+ "value": "{\n /** Element outlining the fixed position boundaries */\n boundingElement?: HTMLElement | null;\n /** Offset vertical spacing from the top of the scrollable container */\n offset?: boolean;\n /** Should the element remain in a fixed position when the layout is stacked (smaller screens) */\n disableWhenStacked?: boolean;\n /** Callback run when sticky header is added or removed */\n onStickyChange?: (isSticky: boolean) => void;\n} & (\n | {children: React.ReactNode}\n | {children(isSticky: boolean): React.ReactNode}\n)",
+ "description": ""
+ }
+ },
"Distribution": {
"polaris-react/src/components/Stack/Stack.tsx": {
"filePath": "polaris-react/src/components/Stack/Stack.tsx",
@@ -17928,15 +18079,6 @@
"value": "export interface StackProps {\n /** Elements to display inside stack */\n children?: React.ReactNode;\n /** Wrap stack elements to additional rows as needed on small screens (Defaults to true) */\n wrap?: boolean;\n /** Stack the elements vertically */\n vertical?: boolean;\n /** Adjust spacing between elements */\n spacing?: Spacing;\n /** Adjust vertical alignment of elements */\n alignment?: Alignment;\n /** Adjust horizontal alignment of elements */\n distribution?: Distribution;\n}"
}
},
- "StickyProps": {
- "polaris-react/src/components/Sticky/Sticky.tsx": {
- "filePath": "polaris-react/src/components/Sticky/Sticky.tsx",
- "syntaxKind": "TypeAliasDeclaration",
- "name": "StickyProps",
- "value": "{\n /** Element outlining the fixed position boundaries */\n boundingElement?: HTMLElement | null;\n /** Offset vertical spacing from the top of the scrollable container */\n offset?: boolean;\n /** Should the element remain in a fixed position when the layout is stacked (smaller screens) */\n disableWhenStacked?: boolean;\n /** Callback run when sticky header is added or removed */\n onStickyChange?: (isSticky: boolean) => void;\n} & (\n | {children: React.ReactNode}\n | {children(isSticky: boolean): React.ReactNode}\n)",
- "description": ""
- }
- },
"SubheadingProps": {
"polaris-react/src/components/Subheading/Subheading.tsx": {
"filePath": "polaris-react/src/components/Subheading/Subheading.tsx",
@@ -18020,13 +18162,30 @@
"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": ""
+ "TextContainerProps": {
+ "polaris-react/src/components/TextContainer/TextContainer.tsx": {
+ "filePath": "polaris-react/src/components/TextContainer/TextContainer.tsx",
+ "name": "TextContainerProps",
+ "description": "",
+ "members": [
+ {
+ "filePath": "polaris-react/src/components/TextContainer/TextContainer.tsx",
+ "syntaxKind": "PropertySignature",
+ "name": "spacing",
+ "value": "Spacing",
+ "description": "The amount of vertical spacing children will get between them",
+ "isOptional": true
+ },
+ {
+ "filePath": "polaris-react/src/components/TextContainer/TextContainer.tsx",
+ "syntaxKind": "PropertySignature",
+ "name": "children",
+ "value": "React.ReactNode",
+ "description": "The content to render in the text container.",
+ "isOptional": true
+ }
+ ],
+ "value": "export interface TextContainerProps {\n /** The amount of vertical spacing children will get between them */\n spacing?: Spacing;\n /** The content to render in the text container. */\n children?: React.ReactNode;\n}"
}
},
"Variant": {
@@ -18134,32 +18293,6 @@
"value": "export interface TextProps {\n /** Adjust horizontal alignment of text */\n alignment?: Alignment;\n /** The element type */\n as: Element;\n /** Prevent text from overflowing */\n breakWord?: boolean;\n /** Text to display */\n children: ReactNode;\n /** Adjust color of text */\n color?: Color;\n /** Adjust weight of text */\n fontWeight?: FontWeight;\n /** HTML id attribute */\n id?: string;\n /** Truncate text overflow with ellipsis */\n truncate?: boolean;\n /** Typographic style of text */\n variant: Variant;\n /** Visually hide the text */\n visuallyHidden?: boolean;\n}"
}
},
- "TextContainerProps": {
- "polaris-react/src/components/TextContainer/TextContainer.tsx": {
- "filePath": "polaris-react/src/components/TextContainer/TextContainer.tsx",
- "name": "TextContainerProps",
- "description": "",
- "members": [
- {
- "filePath": "polaris-react/src/components/TextContainer/TextContainer.tsx",
- "syntaxKind": "PropertySignature",
- "name": "spacing",
- "value": "Spacing",
- "description": "The amount of vertical spacing children will get between them",
- "isOptional": true
- },
- {
- "filePath": "polaris-react/src/components/TextContainer/TextContainer.tsx",
- "syntaxKind": "PropertySignature",
- "name": "children",
- "value": "React.ReactNode",
- "description": "The content to render in the text container.",
- "isOptional": true
- }
- ],
- "value": "export interface TextContainerProps {\n /** The amount of vertical spacing children will get between them */\n spacing?: Spacing;\n /** The content to render in the text container. */\n children?: React.ReactNode;\n}"
- }
- },
"InputMode": {
"polaris-react/src/components/TextField/TextField.tsx": {
"filePath": "polaris-react/src/components/TextField/TextField.tsx",
@@ -18285,6 +18418,15 @@
"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": ""
+ }
+ },
"Variation": {
"polaris-react/src/components/TextStyle/TextStyle.tsx": {
"filePath": "polaris-react/src/components/TextStyle/TextStyle.tsx",
@@ -18600,37 +18742,20 @@
"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": [
+ "value": "boolean",
+ "description": "",
+ "isOptional": true
+ },
{
- "filePath": "polaris-react/src/components/Truncate/Truncate.tsx",
+ "filePath": "polaris-react/src/components/TrapFocus/TrapFocus.tsx",
"syntaxKind": "PropertySignature",
"name": "children",
"value": "React.ReactNode",
- "description": ""
+ "description": "",
+ "isOptional": true
}
],
- "value": "export interface TruncateProps {\n children: React.ReactNode;\n}"
+ "value": "export interface TrapFocusProps {\n trapping?: boolean;\n children?: React.ReactNode;\n}"
}
},
"UnstyledButtonProps": {
@@ -22048,6 +22173,23 @@
"value": "export interface FocusManagerContextType {\n trapFocusList: string[];\n add: (id: string) => void;\n remove: (id: string) => boolean;\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}"
+ }
+ },
"PortalsManager": {
"polaris-react/src/utilities/portals/context.tsx": {
"filePath": "polaris-react/src/utilities/portals/context.tsx",
@@ -22413,6 +22555,30 @@
"value": "interface ItemProps {\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}"
+ }
+ },
"SectionProps": {
"polaris-react/src/components/ActionList/components/Section/Section.tsx": {
"filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx",
@@ -22448,9 +22614,17 @@
"value": "() => void",
"description": "Callback when any item is clicked or keypressed",
"isOptional": true
+ },
+ {
+ "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx",
+ "syntaxKind": "PropertySignature",
+ "name": "isFirst",
+ "value": "boolean",
+ "description": "Whether it is the first in a group of sections",
+ "isOptional": true
}
],
- "value": "export interface SectionProps {\n /** Section of action items */\n section: ActionListSection;\n /** Should there be multiple sections */\n hasMultipleSections: boolean;\n /** Defines a specific role attribute for each action in the list */\n actionRole?: 'option' | 'menuitem' | string;\n /** Callback when any item is clicked or keypressed */\n onActionAnyItem?: ActionListItemDescriptor['onAction'];\n}"
+ "value": "export interface SectionProps {\n /** Section of action items */\n section: ActionListSection;\n /** Should there be multiple sections */\n hasMultipleSections: boolean;\n /** Defines a specific role attribute for each action in the list */\n actionRole?: 'option' | 'menuitem' | string;\n /** Callback when any item is clicked or keypressed */\n onActionAnyItem?: ActionListItemDescriptor['onAction'];\n /** Whether it is the first in a group of sections */\n isFirst?: boolean;\n}"
},
"polaris-react/src/components/Layout/components/Section/Section.tsx": {
"filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx",
@@ -22651,30 +22825,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}"
- }
- },
"MenuGroupProps": {
"polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx": {
"filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx",
@@ -22801,40 +22951,6 @@
"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}"
- }
- },
"SecondaryAction": {
"polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx": {
"filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx",
@@ -23211,6 +23327,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}"
+ }
+ },
"MappedAction": {
"polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx": {
"filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx",
@@ -23432,7 +23582,7 @@
"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 showContentInButton?: boolean;\n} & DisableableAction",
+ "value": "{\n disclosure?: boolean;\n indicator?: boolean;\n handleMeasurement?(width: number): void;\n} & DisableableAction",
"description": ""
}
},
@@ -23557,72 +23707,6 @@
"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",
@@ -23703,38 +23787,104 @@
"description": "",
"members": [
{
- "filePath": "polaris-react/src/components/ColorPicker/components/Slidable/Slidable.tsx",
+ "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}"
+ }
+ },
+ "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": "draggerX",
- "value": "number",
+ "name": "title",
+ "value": "React.ReactNode",
"description": "",
"isOptional": true
},
{
- "filePath": "polaris-react/src/components/ColorPicker/components/Slidable/Slidable.tsx",
+ "filePath": "polaris-react/src/components/Card/components/Section/Section.tsx",
"syntaxKind": "PropertySignature",
- "name": "draggerY",
- "value": "number",
+ "name": "children",
+ "value": "React.ReactNode",
"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/Card/components/Section/Section.tsx",
+ "syntaxKind": "PropertySignature",
+ "name": "subdued",
+ "value": "boolean",
+ "description": "",
+ "isOptional": true
},
{
- "filePath": "polaris-react/src/components/ColorPicker/components/Slidable/Slidable.tsx",
- "syntaxKind": "MethodSignature",
- "name": "onDraggerHeight",
- "value": "(height: number) => void",
+ "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 SlidableProps {\n draggerX?: number;\n draggerY?: number;\n onChange(position: Position): void;\n onDraggerHeight?(height: number): void;\n}"
+ "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}"
}
},
"ItemPosition": {
@@ -24182,6 +24332,37 @@
"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",
@@ -24300,37 +24481,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}"
}
},
- "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}"
- }
- },
"FileUploadProps": {
"polaris-react/src/components/DropZone/components/FileUpload/FileUpload.tsx": {
"filePath": "polaris-react/src/components/DropZone/components/FileUpload/FileUpload.tsx",
@@ -24628,6 +24778,15 @@
"value": "export interface CSSAnimationProps {\n in: boolean;\n className: string;\n type: AnimationType;\n children?: React.ReactNode;\n}"
}
},
+ "Cell": {
+ "polaris-react/src/components/Grid/components/Cell/Cell.tsx": {
+ "filePath": "polaris-react/src/components/Grid/components/Cell/Cell.tsx",
+ "syntaxKind": "TypeAliasDeclaration",
+ "name": "Cell",
+ "value": "{\n [Breakpoint in Breakpoints]?: string;\n}",
+ "description": ""
+ }
+ },
"ToastManagerProps": {
"polaris-react/src/components/Frame/components/ToastManager/ToastManager.tsx": {
"filePath": "polaris-react/src/components/Frame/components/ToastManager/ToastManager.tsx",
@@ -24645,15 +24804,6 @@
"value": "export interface ToastManagerProps {\n toastMessages: ToastPropsWithID[];\n}"
}
},
- "Cell": {
- "polaris-react/src/components/Grid/components/Cell/Cell.tsx": {
- "filePath": "polaris-react/src/components/Grid/components/Cell/Cell.tsx",
- "syntaxKind": "TypeAliasDeclaration",
- "name": "Cell",
- "value": "{\n [Breakpoint in Breakpoints]?: string;\n}",
- "description": ""
- }
- },
"CheckboxWrapperProps": {
"polaris-react/src/components/IndexTable/components/Checkbox/Checkbox.tsx": {
"filePath": "polaris-react/src/components/IndexTable/components/Checkbox/Checkbox.tsx",
@@ -25760,65 +25910,6 @@
"value": "interface PrimaryAction\n extends DestructableAction,\n DisableableAction,\n LoadableAction,\n IconableAction,\n TooltipAction {\n /** Provides extra visual weight and identifies the primary action in a set of buttons */\n primary?: boolean;\n}"
}
},
- "PaneProps": {
- "polaris-react/src/components/Popover/components/Pane/Pane.tsx": {
- "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx",
- "name": "PaneProps",
- "description": "",
- "members": [
- {
- "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx",
- "syntaxKind": "PropertySignature",
- "name": "fixed",
- "value": "boolean",
- "description": "Fix the pane to the top of the popover",
- "isOptional": true
- },
- {
- "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx",
- "syntaxKind": "PropertySignature",
- "name": "sectioned",
- "value": "boolean",
- "description": "Automatically wrap children in padded sections",
- "isOptional": true
- },
- {
- "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx",
- "syntaxKind": "PropertySignature",
- "name": "children",
- "value": "React.ReactNode",
- "description": "The pane content",
- "isOptional": true
- },
- {
- "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx",
- "syntaxKind": "PropertySignature",
- "name": "height",
- "value": "string",
- "description": "Sets a fixed height and max-height on the Scrollable",
- "isOptional": true
- },
- {
- "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx",
- "syntaxKind": "MethodSignature",
- "name": "onScrolledToBottom",
- "value": "() => void",
- "description": "Callback when the bottom of the popover is reached by mouse or keyboard",
- "isOptional": true
- },
- {
- "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx",
- "syntaxKind": "PropertySignature",
- "name": "captureOverscroll",
- "value": "boolean",
- "description": "Prevents page scrolling when the end of the scrollable Popover content is reached",
- "isOptional": true,
- "defaultValue": "false"
- }
- ],
- "value": "export interface PaneProps {\n /** Fix the pane to the top of the popover */\n fixed?: boolean;\n /** Automatically wrap children in padded sections */\n sectioned?: boolean;\n /** The pane content */\n children?: React.ReactNode;\n /** Sets a fixed height and max-height on the Scrollable */\n height?: string;\n /** Callback when the bottom of the popover is reached by mouse or keyboard */\n onScrolledToBottom?(): void;\n /**\n * Prevents page scrolling when the end of the scrollable Popover content is reached\n * @default false\n */\n captureOverscroll?: boolean;\n}"
- }
- },
"PopoverCloseSource": {
"polaris-react/src/components/Popover/components/PopoverOverlay/PopoverOverlay.tsx": {
"filePath": "polaris-react/src/components/Popover/components/PopoverOverlay/PopoverOverlay.tsx",
@@ -26008,6 +26099,65 @@
"value": "export interface PopoverOverlayProps {\n children?: React.ReactNode;\n fullWidth?: boolean;\n fullHeight?: boolean;\n fluidContent?: boolean;\n preferredPosition?: PositionedOverlayProps['preferredPosition'];\n preferredAlignment?: PositionedOverlayProps['preferredAlignment'];\n active: boolean;\n id: string;\n zIndexOverride?: number;\n activator: HTMLElement;\n preferInputActivator?: PositionedOverlayProps['preferInputActivator'];\n sectioned?: boolean;\n fixed?: boolean;\n hideOnPrint?: boolean;\n onClose(source: PopoverCloseSource): void;\n autofocusTarget?: PopoverAutofocusTarget;\n preventCloseOnChildOverlayClick?: boolean;\n captureOverscroll?: boolean;\n}"
}
},
+ "PaneProps": {
+ "polaris-react/src/components/Popover/components/Pane/Pane.tsx": {
+ "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx",
+ "name": "PaneProps",
+ "description": "",
+ "members": [
+ {
+ "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx",
+ "syntaxKind": "PropertySignature",
+ "name": "fixed",
+ "value": "boolean",
+ "description": "Fix the pane to the top of the popover",
+ "isOptional": true
+ },
+ {
+ "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx",
+ "syntaxKind": "PropertySignature",
+ "name": "sectioned",
+ "value": "boolean",
+ "description": "Automatically wrap children in padded sections",
+ "isOptional": true
+ },
+ {
+ "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx",
+ "syntaxKind": "PropertySignature",
+ "name": "children",
+ "value": "React.ReactNode",
+ "description": "The pane content",
+ "isOptional": true
+ },
+ {
+ "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx",
+ "syntaxKind": "PropertySignature",
+ "name": "height",
+ "value": "string",
+ "description": "Sets a fixed height and max-height on the Scrollable",
+ "isOptional": true
+ },
+ {
+ "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx",
+ "syntaxKind": "MethodSignature",
+ "name": "onScrolledToBottom",
+ "value": "() => void",
+ "description": "Callback when the bottom of the popover is reached by mouse or keyboard",
+ "isOptional": true
+ },
+ {
+ "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx",
+ "syntaxKind": "PropertySignature",
+ "name": "captureOverscroll",
+ "value": "boolean",
+ "description": "Prevents page scrolling when the end of the scrollable Popover content is reached",
+ "isOptional": true,
+ "defaultValue": "false"
+ }
+ ],
+ "value": "export interface PaneProps {\n /** Fix the pane to the top of the popover */\n fixed?: boolean;\n /** Automatically wrap children in padded sections */\n sectioned?: boolean;\n /** The pane content */\n children?: React.ReactNode;\n /** Sets a fixed height and max-height on the Scrollable */\n height?: string;\n /** Callback when the bottom of the popover is reached by mouse or keyboard */\n onScrolledToBottom?(): void;\n /**\n * Prevents page scrolling when the end of the scrollable Popover content is reached\n * @default false\n */\n captureOverscroll?: boolean;\n}"
+ }
+ },
"PolarisContainerProps": {
"polaris-react/src/components/PortalsManager/components/PortalsContainer/PortalsContainer.tsx": {
"filePath": "polaris-react/src/components/PortalsManager/components/PortalsContainer/PortalsContainer.tsx",
@@ -27074,4 +27224,4 @@
"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}"
}
}
-}
\ No newline at end of file
+}