diff --git a/.changeset/little-islands-act.md b/.changeset/little-islands-act.md new file mode 100644 index 00000000000..a3bc6f872a3 --- /dev/null +++ b/.changeset/little-islands-act.md @@ -0,0 +1,7 @@ +--- +'@shopify/polaris': patch +'polaris.shopify.com': patch +--- + +Renamed `alignY` prop to `alignBlock` on `Inline` +Added more flex properties to `align` on `Inline` diff --git a/polaris-react/src/components/Frame/components/Toast/Toast.tsx b/polaris-react/src/components/Frame/components/Toast/Toast.tsx index 7ddf378853b..820679fbded 100644 --- a/polaris-react/src/components/Frame/components/Toast/Toast.tsx +++ b/polaris-react/src/components/Frame/components/Toast/Toast.tsx @@ -67,7 +67,7 @@ export function Toast({ return (
- + {content} diff --git a/polaris-react/src/components/Inline/Inline.scss b/polaris-react/src/components/Inline/Inline.scss index 08c005a957a..1de85007f7a 100644 --- a/polaris-react/src/components/Inline/Inline.scss +++ b/polaris-react/src/components/Inline/Inline.scss @@ -2,6 +2,6 @@ display: flex; gap: var(--pc-inline-spacing); flex-wrap: var(--pc-inline-wrap); - align-items: var(--pc-inline-align-y); + align-items: var(--pc-inline-block-align); justify-content: var(--pc-inline-align); } diff --git a/polaris-react/src/components/Inline/Inline.stories.tsx b/polaris-react/src/components/Inline/Inline.stories.tsx index da57cae59ac..3ec7fd8b9f6 100644 --- a/polaris-react/src/components/Inline/Inline.stories.tsx +++ b/polaris-react/src/components/Inline/Inline.stories.tsx @@ -20,9 +20,9 @@ export function Default() { ); } -export function AlignYCenter() { +export function AlignStart() { return ( - + One Two @@ -31,9 +31,9 @@ export function AlignYCenter() { ); } -export function AlignYTop() { +export function AlignCenter() { return ( - + One Two @@ -42,9 +42,9 @@ export function AlignYTop() { ); } -export function AlignYBottom() { +export function AlignEnd() { return ( - + One Two @@ -53,9 +53,39 @@ export function AlignYBottom() { ); } -export function AlignYBaseline() { +export function AlignSpaceAround() { + return ( + + One + Two + Three + + ); +} + +export function AlignSpaceBetween() { + return ( + + One + Two + Three + + ); +} + +export function AlignSpaceEvenly() { return ( - + + One + Two + Three + + ); +} + +export function BlockAlignCenter() { + return ( + One Two @@ -64,9 +94,9 @@ export function AlignYBaseline() { ); } -export function AlignStart() { +export function BlockAlignStart() { return ( - + One Two @@ -75,9 +105,9 @@ export function AlignStart() { ); } -export function AlignCenter() { +export function BlockAlignEnd() { return ( - + One Two @@ -86,9 +116,20 @@ export function AlignCenter() { ); } -export function AlignEnd() { +export function BlockAlignBaseline() { + return ( + + + One + Two + Three + + ); +} + +export function BlockAlignStrech() { return ( - + One Two @@ -97,9 +138,9 @@ export function AlignEnd() { ); } -export function AlignCenterAlignYCenter() { +export function AlignCenterBlockAlignCenter() { return ( - + One Two diff --git a/polaris-react/src/components/Inline/Inline.tsx b/polaris-react/src/components/Inline/Inline.tsx index 106568dd74b..dfe8e2ab446 100644 --- a/polaris-react/src/components/Inline/Inline.tsx +++ b/polaris-react/src/components/Inline/Inline.tsx @@ -3,40 +3,46 @@ import type {SpacingSpaceScale} from '@shopify/polaris-tokens'; import styles from './Inline.scss'; -const AlignY = { - top: 'start', - center: 'center', - bottom: 'end', - baseline: 'baseline', -}; - -type Align = 'start' | 'center' | 'end'; +type Align = + | 'start' + | 'center' + | 'end' + | 'space-around' + | 'space-between' + | 'space-evenly'; +type BlockAlign = 'start' | 'center' | 'end' | 'baseline' | 'stretch'; export interface InlineProps { - /** Elements to display inside stack */ - children?: React.ReactNode; - /** Wrap stack elements to additional rows as needed on small screens (Defaults to true) */ - wrap?: boolean; + /** Adjust horizontal alignment of elements + * @default 'start' + */ + align?: Align; + /** Adjust vertical alignment of elements + * @default 'center' + */ + blockAlign?: BlockAlign; /** The spacing between elements * @default '4' */ spacing?: SpacingSpaceScale; - /** Adjust vertical alignment of elements */ - alignY?: keyof typeof AlignY; - /** Adjust horizontal alignment of elements */ - align?: Align; + /** Wrap stack elements to additional rows as needed on small screens + * @default true + */ + wrap?: boolean; + /** Elements to display inside stack */ + children?: React.ReactNode; } export const Inline = function Inline({ - children, + align = 'start', + blockAlign = 'center', spacing = '4', - align, - alignY, wrap = true, + children, }: InlineProps) { const style = { '--pc-inline-align': align, - '--pc-inline-align-y': alignY ? AlignY[alignY] : undefined, + '--pc-inline-block-align': blockAlign, '--pc-inline-wrap': wrap ? 'wrap' : 'nowrap', '--pc-inline-spacing': `var(--p-space-${spacing})`, } as React.CSSProperties; diff --git a/polaris.shopify.com/pages/examples/columns-default.tsx b/polaris.shopify.com/pages/examples/columns-default.tsx index f5754a1423e..c2828d2151a 100644 --- a/polaris.shopify.com/pages/examples/columns-default.tsx +++ b/polaris.shopify.com/pages/examples/columns-default.tsx @@ -26,7 +26,7 @@ const Placeholder = ({label = '', height = 'auto', width = 'auto'}) => { width: width ?? undefined, }} > - +
{ width: width ?? undefined, }} > - +
{ width: width ?? undefined, }} > - +
{ width: width ?? undefined, }} > - +
{ width: width, }} > - +
- + diff --git a/polaris.shopify.com/pages/examples/inline-with-vertical-alignment.tsx b/polaris.shopify.com/pages/examples/inline-with-vertical-alignment.tsx index f3c1f3a52c8..f9a2c6d3cf2 100644 --- a/polaris.shopify.com/pages/examples/inline-with-vertical-alignment.tsx +++ b/polaris.shopify.com/pages/examples/inline-with-vertical-alignment.tsx @@ -6,7 +6,7 @@ import {withPolarisExample} from '../../src/components/PolarisExampleWrapper'; function InlineWithVerticalAlignmentExample() { return ( - + @@ -14,7 +14,7 @@ function InlineWithVerticalAlignmentExample() { - + @@ -22,7 +22,7 @@ function InlineWithVerticalAlignmentExample() { - + @@ -30,7 +30,7 @@ function InlineWithVerticalAlignmentExample() { - + @@ -58,7 +58,7 @@ const Placeholder = ({ width: width, }} > - +
void", - "description": "" - }, - { - "filePath": "polaris-react/src/utilities/listbox/context.ts", - "syntaxKind": "MethodSignature", - "name": "setLoading", - "value": "(label?: string) => void", - "description": "" - } - ], - "value": "export interface ListboxContextType {\n onOptionSelect(option: NavigableOption): void;\n setLoading(label?: string): void;\n}" - } - }, "LinkLikeComponentProps": { "polaris-react/src/utilities/link/types.ts": { "filePath": "polaris-react/src/utilities/link/types.ts", @@ -7305,6 +7227,84 @@ "description": "" } }, + "NavigableOption": { + "polaris-react/src/utilities/listbox/types.ts": { + "filePath": "polaris-react/src/utilities/listbox/types.ts", + "name": "NavigableOption", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/utilities/listbox/types.ts", + "syntaxKind": "PropertySignature", + "name": "domId", + "value": "string", + "description": "" + }, + { + "filePath": "polaris-react/src/utilities/listbox/types.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "" + }, + { + "filePath": "polaris-react/src/utilities/listbox/types.ts", + "syntaxKind": "PropertySignature", + "name": "element", + "value": "HTMLElement", + "description": "" + }, + { + "filePath": "polaris-react/src/utilities/listbox/types.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "" + }, + { + "filePath": "polaris-react/src/utilities/listbox/types.ts", + "syntaxKind": "PropertySignature", + "name": "isAction", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/utilities/listbox/types.ts", + "syntaxKind": "PropertySignature", + "name": "index", + "value": "number", + "description": "", + "isOptional": true + } + ], + "value": "export interface NavigableOption {\n domId: string;\n value: string;\n element: HTMLElement;\n disabled: boolean;\n isAction?: boolean;\n index?: number;\n}" + } + }, + "ListboxContextType": { + "polaris-react/src/utilities/listbox/context.ts": { + "filePath": "polaris-react/src/utilities/listbox/context.ts", + "name": "ListboxContextType", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/utilities/listbox/context.ts", + "syntaxKind": "MethodSignature", + "name": "onOptionSelect", + "value": "(option: NavigableOption) => void", + "description": "" + }, + { + "filePath": "polaris-react/src/utilities/listbox/context.ts", + "syntaxKind": "MethodSignature", + "name": "setLoading", + "value": "(label?: string) => void", + "description": "" + } + ], + "value": "export interface ListboxContextType {\n onOptionSelect(option: NavigableOption): void;\n setLoading(label?: string): void;\n}" + } + }, "PortalsContainerElement": { "polaris-react/src/utilities/portals/types.ts": { "filePath": "polaris-react/src/utilities/portals/types.ts", @@ -7605,268 +7605,101 @@ "description": "" } }, - "AccountConnectionProps": { - "polaris-react/src/components/AccountConnection/AccountConnection.tsx": { - "filePath": "polaris-react/src/components/AccountConnection/AccountConnection.tsx", - "name": "AccountConnectionProps", + "Props": { + "polaris-react/src/components/AfterInitialMount/AfterInitialMount.tsx": { + "filePath": "polaris-react/src/components/AfterInitialMount/AfterInitialMount.tsx", + "name": "Props", "description": "", "members": [ { - "filePath": "polaris-react/src/components/AccountConnection/AccountConnection.tsx", + "filePath": "polaris-react/src/components/AfterInitialMount/AfterInitialMount.tsx", "syntaxKind": "PropertySignature", - "name": "title", - "value": "React.ReactNode", - "description": "Content to display as title", + "name": "children", + "value": "ReactNode", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/AccountConnection/AccountConnection.tsx", + "filePath": "polaris-react/src/components/AfterInitialMount/AfterInitialMount.tsx", "syntaxKind": "PropertySignature", - "name": "details", - "value": "React.ReactNode", - "description": "Content to display as additional details", + "name": "fallback", + "value": "ReactNode", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/AccountConnection/AccountConnection.tsx", + "filePath": "polaris-react/src/components/AfterInitialMount/AfterInitialMount.tsx", "syntaxKind": "PropertySignature", - "name": "termsOfService", + "name": "onMount", + "value": "() => void", + "description": "", + "isOptional": true + } + ], + "value": "interface Props {\n children?: ReactNode;\n fallback?: ReactNode;\n onMount?: () => void;\n}" + }, + "polaris-react/src/components/FocusManager/FocusManager.tsx": { + "filePath": "polaris-react/src/components/FocusManager/FocusManager.tsx", + "name": "Props", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/FocusManager/FocusManager.tsx", + "syntaxKind": "PropertySignature", + "name": "children", "value": "React.ReactNode", - "description": "Content to display as terms of service", + "description": "", "isOptional": true - }, + } + ], + "value": "interface Props {\n children?: React.ReactNode;\n}" + }, + "polaris-react/src/components/MediaQueryProvider/MediaQueryProvider.tsx": { + "filePath": "polaris-react/src/components/MediaQueryProvider/MediaQueryProvider.tsx", + "name": "Props", + "description": "", + "members": [ { - "filePath": "polaris-react/src/components/AccountConnection/AccountConnection.tsx", + "filePath": "polaris-react/src/components/MediaQueryProvider/MediaQueryProvider.tsx", "syntaxKind": "PropertySignature", - "name": "accountName", - "value": "string", - "description": "The name of the service", + "name": "children", + "value": "React.ReactNode", + "description": "", "isOptional": true + } + ], + "value": "interface Props {\n children?: React.ReactNode;\n}" + }, + "polaris-react/src/components/RangeSlider/RangeSlider.tsx": { + "filePath": "polaris-react/src/components/RangeSlider/RangeSlider.tsx", + "name": "Props", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/RangeSlider/RangeSlider.tsx", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "ReactNode", + "description": "Label for the range input" }, { - "filePath": "polaris-react/src/components/AccountConnection/AccountConnection.tsx", + "filePath": "polaris-react/src/components/RangeSlider/RangeSlider.tsx", "syntaxKind": "PropertySignature", - "name": "avatarUrl", - "value": "string", - "description": "URL for the user’s avatar image", + "name": "labelAction", + "value": "Action", + "description": "Adds an action to the label", "isOptional": true }, { - "filePath": "polaris-react/src/components/AccountConnection/AccountConnection.tsx", + "filePath": "polaris-react/src/components/RangeSlider/RangeSlider.tsx", "syntaxKind": "PropertySignature", - "name": "connected", + "name": "labelHidden", "value": "boolean", - "description": "Set if the account is connected", + "description": "Visually hide the label", "isOptional": true }, { - "filePath": "polaris-react/src/components/AccountConnection/AccountConnection.tsx", - "syntaxKind": "PropertySignature", - "name": "action", - "value": "Action", - "description": "Action for account connection", - "isOptional": true - } - ], - "value": "export interface AccountConnectionProps {\n /** Content to display as title */\n title?: React.ReactNode;\n /** Content to display as additional details */\n details?: React.ReactNode;\n /** Content to display as terms of service */\n termsOfService?: React.ReactNode;\n /** The name of the service */\n accountName?: string;\n /** URL for the user’s avatar image */\n avatarUrl?: string;\n /** Set if the account is connected */\n connected?: boolean;\n /** Action for account connection */\n action?: Action;\n}" - } - }, - "ActionMenuProps": { - "polaris-react/src/components/ActionMenu/ActionMenu.tsx": { - "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", - "name": "ActionMenuProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", - "syntaxKind": "PropertySignature", - "name": "actions", - "value": "MenuActionDescriptor[]", - "description": "Collection of page-level secondary actions", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", - "syntaxKind": "PropertySignature", - "name": "groups", - "value": "MenuGroupDescriptor[]", - "description": "Collection of page-level action groups", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", - "syntaxKind": "PropertySignature", - "name": "rollup", - "value": "boolean", - "description": "Roll up all actions into a Popover > ActionList", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", - "syntaxKind": "PropertySignature", - "name": "rollupActionsLabel", - "value": "string", - "description": "Label for rolled up actions activator", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", - "syntaxKind": "MethodSignature", - "name": "onActionRollup", - "value": "(hasRolledUp: boolean) => void", - "description": "Callback that returns true when secondary actions are rolled up into action groups, and false when not", - "isOptional": true - } - ], - "value": "export interface ActionMenuProps {\n /** Collection of page-level secondary actions */\n actions?: MenuActionDescriptor[];\n /** Collection of page-level action groups */\n groups?: MenuGroupDescriptor[];\n /** Roll up all actions into a Popover > ActionList */\n rollup?: boolean;\n /** Label for rolled up actions activator */\n rollupActionsLabel?: string;\n /** Callback that returns true when secondary actions are rolled up into action groups, and false when not */\n onActionRollup?(hasRolledUp: boolean): void;\n}" - } - }, - "ActionListProps": { - "polaris-react/src/components/ActionList/ActionList.tsx": { - "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", - "name": "ActionListProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", - "syntaxKind": "PropertySignature", - "name": "items", - "value": "readonly ActionListItemDescriptor[]", - "description": "Collection of actions for list", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", - "syntaxKind": "PropertySignature", - "name": "sections", - "value": "readonly ActionListSection[]", - "description": "Collection of sectioned action items", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", - "syntaxKind": "PropertySignature", - "name": "actionRole", - "value": "string", - "description": "Defines a specific role attribute for each action in the list", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", - "syntaxKind": "PropertySignature", - "name": "onActionAnyItem", - "value": "() => void", - "description": "Callback when any item is clicked or keypressed", - "isOptional": true - } - ], - "value": "export interface ActionListProps {\n /** Collection of actions for list */\n items?: readonly ActionListItemDescriptor[];\n /** Collection of sectioned action items */\n sections?: readonly ActionListSection[];\n /** Defines a specific role attribute for each action in the list */\n actionRole?: 'menuitem' | string;\n /** Callback when any item is clicked or keypressed */\n onActionAnyItem?: ActionListItemDescriptor['onAction'];\n}" - } - }, - "ActionListItemProps": { - "polaris-react/src/components/ActionList/ActionList.tsx": { - "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "ActionListItemProps", - "value": "ItemProps", - "description": "" - } - }, - "Props": { - "polaris-react/src/components/AfterInitialMount/AfterInitialMount.tsx": { - "filePath": "polaris-react/src/components/AfterInitialMount/AfterInitialMount.tsx", - "name": "Props", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/AfterInitialMount/AfterInitialMount.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "ReactNode", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/AfterInitialMount/AfterInitialMount.tsx", - "syntaxKind": "PropertySignature", - "name": "fallback", - "value": "ReactNode", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/AfterInitialMount/AfterInitialMount.tsx", - "syntaxKind": "PropertySignature", - "name": "onMount", - "value": "() => void", - "description": "", - "isOptional": true - } - ], - "value": "interface Props {\n children?: ReactNode;\n fallback?: ReactNode;\n onMount?: () => void;\n}" - }, - "polaris-react/src/components/FocusManager/FocusManager.tsx": { - "filePath": "polaris-react/src/components/FocusManager/FocusManager.tsx", - "name": "Props", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/FocusManager/FocusManager.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", - "isOptional": true - } - ], - "value": "interface Props {\n children?: React.ReactNode;\n}" - }, - "polaris-react/src/components/MediaQueryProvider/MediaQueryProvider.tsx": { - "filePath": "polaris-react/src/components/MediaQueryProvider/MediaQueryProvider.tsx", - "name": "Props", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/MediaQueryProvider/MediaQueryProvider.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", - "isOptional": true - } - ], - "value": "interface Props {\n children?: React.ReactNode;\n}" - }, - "polaris-react/src/components/RangeSlider/RangeSlider.tsx": { - "filePath": "polaris-react/src/components/RangeSlider/RangeSlider.tsx", - "name": "Props", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/RangeSlider/RangeSlider.tsx", - "syntaxKind": "PropertySignature", - "name": "label", - "value": "ReactNode", - "description": "Label for the range input" - }, - { - "filePath": "polaris-react/src/components/RangeSlider/RangeSlider.tsx", - "syntaxKind": "PropertySignature", - "name": "labelAction", - "value": "Action", - "description": "Adds an action to the label", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/RangeSlider/RangeSlider.tsx", - "syntaxKind": "PropertySignature", - "name": "labelHidden", - "value": "boolean", - "description": "Visually hide the label", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/RangeSlider/RangeSlider.tsx", + "filePath": "polaris-react/src/components/RangeSlider/RangeSlider.tsx", "syntaxKind": "PropertySignature", "name": "id", "value": "string", @@ -8056,59 +7889,228 @@ "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", - "syntaxKind": "TypeAliasDeclaration", - "name": "CardBackgroundColorTokenScale", - "value": "\"surface\" | \"surface-subdued\"", - "description": "" - } - }, - "AlphaCardProps": { - "polaris-react/src/components/AlphaCard/AlphaCard.tsx": { - "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", - "name": "AlphaCardProps", + "ActionMenuProps": { + "polaris-react/src/components/ActionMenu/ActionMenu.tsx": { + "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", + "name": "ActionMenuProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", + "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "Elements to display inside card", + "name": "actions", + "value": "MenuActionDescriptor[]", + "description": "Collection of page-level secondary actions", "isOptional": true }, { - "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", + "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", "syntaxKind": "PropertySignature", - "name": "background", - "value": "CardBackgroundColorTokenScale", - "description": "", + "name": "groups", + "value": "MenuGroupDescriptor[]", + "description": "Collection of page-level action groups", "isOptional": true }, { - "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", + "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", "syntaxKind": "PropertySignature", - "name": "padding", - "value": "\"0\" | \"025\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", - "description": "", + "name": "rollup", + "value": "boolean", + "description": "Roll up all actions into a Popover > ActionList", "isOptional": true }, { - "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", + "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", "syntaxKind": "PropertySignature", - "name": "roundedAbove", - "value": "\"xs\" | \"sm\" | \"md\" | \"lg\" | \"xl\"", - "description": "", + "name": "rollupActionsLabel", + "value": "string", + "description": "Label for rolled up actions activator", "isOptional": true - } - ], - "value": "export interface AlphaCardProps {\n /** Elements to display inside card */\n children?: React.ReactNode;\n background?: CardBackgroundColorTokenScale;\n padding?: SpacingSpaceScale;\n roundedAbove?: BreakpointsAlias;\n}" - } - }, - "Align": { - "polaris-react/src/components/AlphaStack/AlphaStack.tsx": { + }, + { + "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", + "syntaxKind": "MethodSignature", + "name": "onActionRollup", + "value": "(hasRolledUp: boolean) => void", + "description": "Callback that returns true when secondary actions are rolled up into action groups, and false when not", + "isOptional": true + } + ], + "value": "export interface ActionMenuProps {\n /** Collection of page-level secondary actions */\n actions?: MenuActionDescriptor[];\n /** Collection of page-level action groups */\n groups?: MenuGroupDescriptor[];\n /** Roll up all actions into a Popover > ActionList */\n rollup?: boolean;\n /** Label for rolled up actions activator */\n rollupActionsLabel?: string;\n /** Callback that returns true when secondary actions are rolled up into action groups, and false when not */\n onActionRollup?(hasRolledUp: boolean): void;\n}" + } + }, + "ActionListProps": { + "polaris-react/src/components/ActionList/ActionList.tsx": { + "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", + "name": "ActionListProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", + "syntaxKind": "PropertySignature", + "name": "items", + "value": "readonly ActionListItemDescriptor[]", + "description": "Collection of actions for list", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", + "syntaxKind": "PropertySignature", + "name": "sections", + "value": "readonly ActionListSection[]", + "description": "Collection of sectioned action items", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", + "syntaxKind": "PropertySignature", + "name": "actionRole", + "value": "string", + "description": "Defines a specific role attribute for each action in the list", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", + "syntaxKind": "PropertySignature", + "name": "onActionAnyItem", + "value": "() => void", + "description": "Callback when any item is clicked or keypressed", + "isOptional": true + } + ], + "value": "export interface ActionListProps {\n /** Collection of actions for list */\n items?: readonly ActionListItemDescriptor[];\n /** Collection of sectioned action items */\n sections?: readonly ActionListSection[];\n /** Defines a specific role attribute for each action in the list */\n actionRole?: 'menuitem' | string;\n /** Callback when any item is clicked or keypressed */\n onActionAnyItem?: ActionListItemDescriptor['onAction'];\n}" + } + }, + "ActionListItemProps": { + "polaris-react/src/components/ActionList/ActionList.tsx": { + "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "ActionListItemProps", + "value": "ItemProps", + "description": "" + } + }, + "AccountConnectionProps": { + "polaris-react/src/components/AccountConnection/AccountConnection.tsx": { + "filePath": "polaris-react/src/components/AccountConnection/AccountConnection.tsx", + "name": "AccountConnectionProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/AccountConnection/AccountConnection.tsx", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "React.ReactNode", + "description": "Content to display as title", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/AccountConnection/AccountConnection.tsx", + "syntaxKind": "PropertySignature", + "name": "details", + "value": "React.ReactNode", + "description": "Content to display as additional details", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/AccountConnection/AccountConnection.tsx", + "syntaxKind": "PropertySignature", + "name": "termsOfService", + "value": "React.ReactNode", + "description": "Content to display as terms of service", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/AccountConnection/AccountConnection.tsx", + "syntaxKind": "PropertySignature", + "name": "accountName", + "value": "string", + "description": "The name of the service", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/AccountConnection/AccountConnection.tsx", + "syntaxKind": "PropertySignature", + "name": "avatarUrl", + "value": "string", + "description": "URL for the user’s avatar image", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/AccountConnection/AccountConnection.tsx", + "syntaxKind": "PropertySignature", + "name": "connected", + "value": "boolean", + "description": "Set if the account is connected", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/AccountConnection/AccountConnection.tsx", + "syntaxKind": "PropertySignature", + "name": "action", + "value": "Action", + "description": "Action for account connection", + "isOptional": true + } + ], + "value": "export interface AccountConnectionProps {\n /** Content to display as title */\n title?: React.ReactNode;\n /** Content to display as additional details */\n details?: React.ReactNode;\n /** Content to display as terms of service */\n termsOfService?: React.ReactNode;\n /** The name of the service */\n accountName?: string;\n /** URL for the user’s avatar image */\n avatarUrl?: string;\n /** Set if the account is connected */\n connected?: boolean;\n /** Action for account connection */\n action?: Action;\n}" + } + }, + "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": "" + } + }, + "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": "Elements to display inside card", + "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": "\"0\" | \"025\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", + "description": "The spacing around the card", + "isOptional": true, + "defaultValue": "'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 /** Elements to display inside card */\n children?: React.ReactNode;\n /** Background color\n * @default 'surface'\n */\n background?: CardBackgroundColorTokenScale;\n /** The spacing around the card\n * @default '5'\n */\n padding?: SpacingSpaceScale;\n /** Border radius value above a set breakpoint */\n roundedAbove?: BreakpointsAlias;\n}" + } + }, + "Align": { + "polaris-react/src/components/AlphaStack/AlphaStack.tsx": { "filePath": "polaris-react/src/components/AlphaStack/AlphaStack.tsx", "syntaxKind": "TypeAliasDeclaration", "name": "Align", @@ -8119,7 +8121,7 @@ "filePath": "polaris-react/src/components/Inline/Inline.tsx", "syntaxKind": "TypeAliasDeclaration", "name": "Align", - "value": "'start' | 'center' | 'end'", + "value": "'start' | 'center' | 'end' | 'space-around' | 'space-between' | 'space-evenly'", "description": "" } }, @@ -8154,42 +8156,6 @@ "value": "ResponsiveProp", "description": "" }, - "polaris-react/src/components/Bleed/Bleed.tsx": { - "filePath": "polaris-react/src/components/Bleed/Bleed.tsx", - "name": "Spacing", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Bleed/Bleed.tsx", - "syntaxKind": "PropertySignature", - "name": "bottom", - "value": "\"0\" | \"025\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", - "description": "" - }, - { - "filePath": "polaris-react/src/components/Bleed/Bleed.tsx", - "syntaxKind": "PropertySignature", - "name": "left", - "value": "\"0\" | \"025\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", - "description": "" - }, - { - "filePath": "polaris-react/src/components/Bleed/Bleed.tsx", - "syntaxKind": "PropertySignature", - "name": "right", - "value": "\"0\" | \"025\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", - "description": "" - }, - { - "filePath": "polaris-react/src/components/Bleed/Bleed.tsx", - "syntaxKind": "PropertySignature", - "name": "top", - "value": "\"0\" | \"025\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", - "description": "" - } - ], - "value": "interface Spacing {\n bottom: SpacingSpaceScale;\n left: SpacingSpaceScale;\n right: SpacingSpaceScale;\n top: SpacingSpaceScale;\n}" - }, "polaris-react/src/components/Box/Box.tsx": { "filePath": "polaris-react/src/components/Box/Box.tsx", "name": "Spacing", @@ -8267,7 +8233,8 @@ "name": "as", "value": "Element", "description": "HTML Element type", - "isOptional": true + "isOptional": true, + "defaultValue": "'div'" }, { "filePath": "polaris-react/src/components/AlphaStack/AlphaStack.tsx", @@ -8282,8 +8249,9 @@ "syntaxKind": "PropertySignature", "name": "align", "value": "Align", - "description": "Adjust vertical alignment of elements", - "isOptional": true + "description": "The vertical alignment of elements", + "isOptional": true, + "defaultValue": "'start'" }, { "filePath": "polaris-react/src/components/AlphaStack/AlphaStack.tsx", @@ -8298,11 +8266,12 @@ "syntaxKind": "PropertySignature", "name": "spacing", "value": "Spacing", - "description": "Adjust spacing between elements", - "isOptional": true + "description": "The spacing between elements", + "isOptional": true, + "defaultValue": "'4'" } ], - "value": "export interface AlphaStackProps {\n /** HTML Element type */\n as?: Element;\n /** Elements to display inside stack */\n children?: React.ReactNode;\n /** Adjust vertical alignment of elements */\n align?: Align;\n /** Toggle elements to be full width */\n fullWidth?: boolean;\n /** Adjust spacing between elements */\n spacing?: Spacing;\n}" + "value": "export interface AlphaStackProps {\n /** HTML Element type\n * @default 'div'\n */\n as?: Element;\n /** Elements to display inside stack */\n children?: React.ReactNode;\n /** The vertical alignment of elements\n * @default 'start'\n */\n align?: Align;\n /** Toggle elements to be full width */\n fullWidth?: boolean;\n /** The spacing between elements\n * @default '4'\n */\n spacing?: Spacing;\n}" } }, "State": { @@ -8573,42 +8542,6 @@ ], "value": "interface State {\n actionsMenuVisible: boolean;\n focused: boolean;\n focusedInner: boolean;\n selected: boolean;\n}" }, - "polaris-react/src/components/Scrollable/Scrollable.tsx": { - "filePath": "polaris-react/src/components/Scrollable/Scrollable.tsx", - "name": "State", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Scrollable/Scrollable.tsx", - "syntaxKind": "PropertySignature", - "name": "topShadow", - "value": "boolean", - "description": "" - }, - { - "filePath": "polaris-react/src/components/Scrollable/Scrollable.tsx", - "syntaxKind": "PropertySignature", - "name": "bottomShadow", - "value": "boolean", - "description": "" - }, - { - "filePath": "polaris-react/src/components/Scrollable/Scrollable.tsx", - "syntaxKind": "PropertySignature", - "name": "scrollPosition", - "value": "number", - "description": "" - }, - { - "filePath": "polaris-react/src/components/Scrollable/Scrollable.tsx", - "syntaxKind": "PropertySignature", - "name": "canScroll", - "value": "boolean", - "description": "" - } - ], - "value": "interface State {\n topShadow: boolean;\n bottomShadow: boolean;\n scrollPosition: number;\n canScroll: boolean;\n}" - }, "polaris-react/src/components/Sticky/Sticky.tsx": { "filePath": "polaris-react/src/components/Sticky/Sticky.tsx", "name": "State", @@ -8710,21 +8643,6 @@ ], "value": "interface State {\n sliderHeight: number;\n draggerHeight: number;\n}" }, - "polaris-react/src/components/ColorPicker/components/Slidable/Slidable.tsx": { - "filePath": "polaris-react/src/components/ColorPicker/components/Slidable/Slidable.tsx", - "name": "State", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/ColorPicker/components/Slidable/Slidable.tsx", - "syntaxKind": "PropertySignature", - "name": "dragging", - "value": "boolean", - "description": "" - } - ], - "value": "interface State {\n dragging: boolean;\n}" - }, "polaris-react/src/components/ColorPicker/components/HuePicker/HuePicker.tsx": { "filePath": "polaris-react/src/components/ColorPicker/components/HuePicker/HuePicker.tsx", "name": "State", @@ -8747,6 +8665,21 @@ ], "value": "interface State {\n sliderHeight: number;\n draggerHeight: number;\n}" }, + "polaris-react/src/components/ColorPicker/components/Slidable/Slidable.tsx": { + "filePath": "polaris-react/src/components/ColorPicker/components/Slidable/Slidable.tsx", + "name": "State", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/ColorPicker/components/Slidable/Slidable.tsx", + "syntaxKind": "PropertySignature", + "name": "dragging", + "value": "boolean", + "description": "" + } + ], + "value": "interface State {\n dragging: boolean;\n}" + }, "polaris-react/src/components/Filters/components/ConnectedFilterControl/ConnectedFilterControl.tsx": { "filePath": "polaris-react/src/components/Filters/components/ConnectedFilterControl/ConnectedFilterControl.tsx", "name": "State", @@ -8973,6 +8906,48 @@ "value": "export interface AutocompleteProps {\n /** A unique identifier for the Autocomplete */\n id?: string;\n /** Collection of options to be listed */\n options: SectionDescriptor[] | OptionDescriptor[];\n /** The selected options */\n selected: string[];\n /** The text field component attached to the list of options */\n textField: React.ReactElement;\n /** The preferred direction to open the popover */\n preferredPosition?: PopoverProps['preferredPosition'];\n /** Title of the list of options */\n listTitle?: string;\n /** Allow more than one option to be selected */\n allowMultiple?: boolean;\n /** An action to render above the list of options */\n actionBefore?: ActionListItemDescriptor & {\n /** Specifies that if the label is too long it will wrap instead of being hidden */\n wrapOverflow?: boolean;\n };\n /** Display loading state */\n loading?: boolean;\n /** Indicates if more results will load dynamically */\n willLoadMoreResults?: boolean;\n /** Is rendered when there are no options */\n emptyState?: React.ReactNode;\n /** Callback when the selection of options is changed */\n onSelect(selected: string[]): void;\n /** Callback when the end of the list is reached */\n onLoadMoreResults?(): void;\n}" } }, + "BackdropProps": { + "polaris-react/src/components/Backdrop/Backdrop.tsx": { + "filePath": "polaris-react/src/components/Backdrop/Backdrop.tsx", + "name": "BackdropProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Backdrop/Backdrop.tsx", + "syntaxKind": "PropertySignature", + "name": "belowNavigation", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Backdrop/Backdrop.tsx", + "syntaxKind": "PropertySignature", + "name": "transparent", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Backdrop/Backdrop.tsx", + "syntaxKind": "MethodSignature", + "name": "onClick", + "value": "() => void", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Backdrop/Backdrop.tsx", + "syntaxKind": "MethodSignature", + "name": "onTouchStart", + "value": "() => void", + "description": "", + "isOptional": true + } + ], + "value": "export interface BackdropProps {\n belowNavigation?: boolean;\n transparent?: boolean;\n onClick?(): void;\n onTouchStart?(): void;\n}" + } + }, "Shape": { "polaris-react/src/components/Avatar/Avatar.tsx": { "filePath": "polaris-react/src/components/Avatar/Avatar.tsx", @@ -9058,48 +9033,6 @@ "value": "export interface AvatarProps {\n /**\n * Size of avatar\n * @default 'medium'\n */\n size?: Size;\n /**\n * Shape of avatar\n * @default 'round'\n */\n shape?: Shape;\n /** The name of the person */\n name?: string;\n /** Initials of person to display */\n initials?: string;\n /** Whether the avatar is for a customer */\n customer?: boolean;\n /** URL of the avatar image which falls back to initials if the image fails to load */\n source?: string;\n /** Callback fired when the image fails to load */\n onError?(): void;\n /** Accessible label for the avatar image */\n accessibilityLabel?: string;\n}" } }, - "BackdropProps": { - "polaris-react/src/components/Backdrop/Backdrop.tsx": { - "filePath": "polaris-react/src/components/Backdrop/Backdrop.tsx", - "name": "BackdropProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Backdrop/Backdrop.tsx", - "syntaxKind": "PropertySignature", - "name": "belowNavigation", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Backdrop/Backdrop.tsx", - "syntaxKind": "PropertySignature", - "name": "transparent", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Backdrop/Backdrop.tsx", - "syntaxKind": "MethodSignature", - "name": "onClick", - "value": "() => void", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Backdrop/Backdrop.tsx", - "syntaxKind": "MethodSignature", - "name": "onTouchStart", - "value": "() => void", - "description": "", - "isOptional": true - } - ], - "value": "export interface BackdropProps {\n belowNavigation?: boolean;\n transparent?: boolean;\n onClick?(): void;\n onTouchStart?(): void;\n}" - } - }, "NonMutuallyExclusiveProps": { "polaris-react/src/components/Badge/Badge.tsx": { "filePath": "polaris-react/src/components/Badge/Badge.tsx", @@ -9143,8 +9076,9 @@ "syntaxKind": "PropertySignature", "name": "size", "value": "Size", - "description": "Medium or small size.", + "description": "", "isOptional": true, + "deprecationMessage": "Medium or small size.", "defaultValue": "'medium'" }, { @@ -9156,7 +9090,7 @@ "isOptional": true } ], - "value": "interface NonMutuallyExclusiveProps {\n /** The content to display inside the badge. */\n children?: string;\n /** Colors and labels the badge with the given status. */\n status?: Status;\n /** Render a pip showing the progress of a given task. */\n progress?: Progress;\n /** Icon to display to the left of the badge’s content. */\n icon?: IconSource;\n /**\n * Medium or small size.\n * @default 'medium'\n */\n size?: Size;\n /** Pass a custom accessibilityLabel */\n statusAndProgressLabelOverride?: string;\n}" + "value": "interface NonMutuallyExclusiveProps {\n /** The content to display inside the badge. */\n children?: string;\n /** Colors and labels the badge with the given status. */\n status?: Status;\n /** Render a pip showing the progress of a given task. */\n progress?: Progress;\n /** Icon to display to the left of the badge’s content. */\n icon?: IconSource;\n /**\n * @deprecated\n * Medium or small size.\n * @default 'medium'\n */\n size?: Size;\n /** Pass a custom accessibilityLabel */\n statusAndProgressLabelOverride?: string;\n}" }, "polaris-react/src/components/KeypressListener/KeypressListener.tsx": { "filePath": "polaris-react/src/components/KeypressListener/KeypressListener.tsx", @@ -9785,7 +9719,7 @@ "syntaxKind": "PropertySignature", "name": "spacing", "value": "\"0\" | \"025\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", - "description": "", + "description": "Negative space around the element", "isOptional": true }, { @@ -9793,7 +9727,7 @@ "syntaxKind": "PropertySignature", "name": "horizontal", "value": "\"0\" | \"025\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", - "description": "", + "description": "Negative horizontal space around the element", "isOptional": true }, { @@ -9801,7 +9735,7 @@ "syntaxKind": "PropertySignature", "name": "vertical", "value": "\"0\" | \"025\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", - "description": "", + "description": "Negative vertical space around the element", "isOptional": true }, { @@ -9809,7 +9743,7 @@ "syntaxKind": "PropertySignature", "name": "top", "value": "\"0\" | \"025\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", - "description": "", + "description": "Negative top space around the element", "isOptional": true }, { @@ -9817,7 +9751,7 @@ "syntaxKind": "PropertySignature", "name": "bottom", "value": "\"0\" | \"025\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", - "description": "", + "description": "Negative bottom space around the element", "isOptional": true }, { @@ -9825,7 +9759,7 @@ "syntaxKind": "PropertySignature", "name": "left", "value": "\"0\" | \"025\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", - "description": "", + "description": "Negative left space around the element", "isOptional": true }, { @@ -9833,11 +9767,11 @@ "syntaxKind": "PropertySignature", "name": "right", "value": "\"0\" | \"025\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", - "description": "", + "description": "Negative right space around the element", "isOptional": true } ], - "value": "export interface BleedProps {\n /** Elements to display inside tile */\n children: React.ReactNode;\n spacing?: SpacingSpaceScale;\n horizontal?: SpacingSpaceScale;\n vertical?: SpacingSpaceScale;\n top?: SpacingSpaceScale;\n bottom?: SpacingSpaceScale;\n left?: SpacingSpaceScale;\n right?: SpacingSpaceScale;\n}" + "value": "export interface BleedProps {\n /** Elements to display inside tile */\n children: React.ReactNode;\n /** Negative space around the element */\n spacing?: SpacingSpaceScale;\n /** Negative horizontal space around the element */\n horizontal?: SpacingSpaceScale;\n /** Negative vertical space around the element */\n vertical?: SpacingSpaceScale;\n /** Negative top space around the element */\n top?: SpacingSpaceScale;\n /** Negative bottom space around the element */\n bottom?: SpacingSpaceScale;\n /** Negative left space around the element */\n left?: SpacingSpaceScale;\n /** Negative right space around the element */\n right?: SpacingSpaceScale;\n}" } }, "Overflow": { @@ -10179,12 +10113,12 @@ "filePath": "polaris-react/src/components/Box/Box.tsx", "syntaxKind": "PropertySignature", "name": "children", - "value": "ReactNode", - "description": "", + "value": "React.ReactNode", + "description": "Elements to display inside box", "isOptional": true } ], - "value": "export interface BoxProps extends PropsWithChildren {\n /** HTML Element type */\n as?: Element;\n /** Background color */\n background?: BackgroundColorTokenScale;\n /** Border style */\n border?: BorderTokenAlias;\n /** Vertical end border style */\n borderBlockEnd?: BorderTokenAlias;\n /** Horizontal start border style */\n borderInlineStart?: BorderTokenAlias;\n /** Horizontal end border style */\n borderInlineEnd?: BorderTokenAlias;\n /** Vertical start border style */\n borderBlockStart?: BorderTokenAlias;\n /** Border radius */\n borderRadius?: BorderRadiusTokenScale;\n /** Vertical end horizontal start border radius */\n borderRadiusEndStart?: BorderRadiusTokenScale;\n /** Vertical end horizontal end border radius */\n borderRadiusEndEnd?: BorderRadiusTokenScale;\n /** Vertical start horizontal start border radius */\n borderRadiusStartStart?: BorderRadiusTokenScale;\n /** Verital start horizontal end border radius */\n borderRadiusStartEnd?: BorderRadiusTokenScale;\n /** Color of children */\n color?: ColorTokenScale;\n /** HTML id attribute */\n id?: string;\n /** Set minimum height of container */\n minHeight?: string;\n /** Set minimum width of container */\n minWidth?: string;\n /** Set maximum width of container */\n maxWidth?: string;\n /** Clip horizontal content of children */\n overflowX?: Overflow;\n /** Clip vertical content of children */\n overflowY?: Overflow;\n /** Spacing around children */\n padding?: SpacingSpaceScale;\n /** Vertical start spacing around children */\n paddingBlockStart?: SpacingSpaceScale;\n /** Vertical end spacing around children */\n paddingBlockEnd?: SpacingSpaceScale;\n /** Horizontal start spacing around children */\n paddingInlineStart?: SpacingSpaceScale;\n /** Horizontal end spacing around children */\n paddingInlineEnd?: SpacingSpaceScale;\n /** Shadow */\n shadow?: DepthShadowAlias;\n /** Set width of container */\n width?: string;\n}" + "value": "export interface BoxProps {\n /** HTML Element type */\n as?: Element;\n /** Background color */\n background?: BackgroundColorTokenScale;\n /** Border style */\n border?: BorderTokenAlias;\n /** Vertical end border style */\n borderBlockEnd?: BorderTokenAlias;\n /** Horizontal start border style */\n borderInlineStart?: BorderTokenAlias;\n /** Horizontal end border style */\n borderInlineEnd?: BorderTokenAlias;\n /** Vertical start border style */\n borderBlockStart?: BorderTokenAlias;\n /** Border radius */\n borderRadius?: BorderRadiusTokenScale;\n /** Vertical end horizontal start border radius */\n borderRadiusEndStart?: BorderRadiusTokenScale;\n /** Vertical end horizontal end border radius */\n borderRadiusEndEnd?: BorderRadiusTokenScale;\n /** Vertical start horizontal start border radius */\n borderRadiusStartStart?: BorderRadiusTokenScale;\n /** Verital start horizontal end border radius */\n borderRadiusStartEnd?: BorderRadiusTokenScale;\n /** Color of children */\n color?: ColorTokenScale;\n /** HTML id attribute */\n id?: string;\n /** Set minimum height of container */\n minHeight?: string;\n /** Set minimum width of container */\n minWidth?: string;\n /** Set maximum width of container */\n maxWidth?: string;\n /** Clip horizontal content of children */\n overflowX?: Overflow;\n /** Clip vertical content of children */\n overflowY?: Overflow;\n /** Spacing around children */\n padding?: SpacingSpaceScale;\n /** Vertical start spacing around children */\n paddingBlockStart?: SpacingSpaceScale;\n /** Vertical end spacing around children */\n paddingBlockEnd?: SpacingSpaceScale;\n /** Horizontal start spacing around children */\n paddingInlineStart?: SpacingSpaceScale;\n /** Horizontal end spacing around children */\n paddingInlineEnd?: SpacingSpaceScale;\n /** Shadow */\n shadow?: DepthShadowAlias;\n /** Set width of container */\n width?: string;\n /** Elements to display inside box */\n children?: React.ReactNode;\n}" } }, "BreadcrumbsProps": { @@ -11676,7 +11610,7 @@ "filePath": "polaris-react/src/components/Text/Text.tsx", "syntaxKind": "TypeAliasDeclaration", "name": "Color", - "value": "'success' | 'critical' | 'warning' | 'subdued'", + "value": "'success' | 'critical' | 'warning' | 'subdued' | 'text-inverse'", "description": "" } }, @@ -11810,8 +11744,9 @@ "syntaxKind": "PropertySignature", "name": "spacing", "value": "Spacing", - "description": "The space between columns", - "isOptional": true + "description": "The spacing between columns", + "isOptional": true, + "defaultValue": "'4'" }, { "filePath": "polaris-react/src/components/Columns/Columns.tsx", @@ -11827,11 +11762,11 @@ "syntaxKind": "PropertySignature", "name": "children", "value": "React.ReactNode", - "description": "", + "description": "Elements to display inside columns", "isOptional": true } ], - "value": "export interface ColumnsProps extends PropsWithChildren {\n /** The space between columns */\n spacing?: Spacing;\n /** The number of columns to display\n * @default {xs: 6, sm: 6, md: 6, lg: 6, xl: 6}\n */\n columns?: Columns;\n children?: React.ReactNode;\n}" + "value": "export interface ColumnsProps {\n /** The spacing between columns\n * @default '4'\n */\n spacing?: Spacing;\n /** The number of columns to display\n * @default {xs: 6, sm: 6, md: 6, lg: 6, xl: 6}\n */\n columns?: Columns;\n /** Elements to display inside columns */\n children?: React.ReactNode;\n}" } }, "ComboboxProps": { @@ -11975,946 +11910,946 @@ "value": "export interface ContentBlockProps {\n /** Elements to display inside container */\n children?: React.ReactNode;\n /** Adjust maximum width of container */\n width: Width;\n}" } }, - "TableRow": { - "polaris-react/src/components/DataTable/DataTable.tsx": { - "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "TableRow", - "value": "DataTableProps['headings'] | DataTableProps['rows'] | DataTableProps['totals']", - "description": "" - } - }, - "TableData": { - "polaris-react/src/components/DataTable/DataTable.tsx": { - "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "TableData", - "value": "string | number | React.ReactNode", - "description": "" - } - }, - "ColumnContentType": { - "polaris-react/src/components/DataTable/DataTable.tsx": { - "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "ColumnContentType", - "value": "'text' | 'numeric'", - "description": "" - } - }, - "DataTableProps": { - "polaris-react/src/components/DataTable/DataTable.tsx": { - "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", - "name": "DataTableProps", + "Item": { + "polaris-react/src/components/DescriptionList/DescriptionList.tsx": { + "filePath": "polaris-react/src/components/DescriptionList/DescriptionList.tsx", + "name": "Item", "description": "", "members": [ { - "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", + "filePath": "polaris-react/src/components/DescriptionList/DescriptionList.tsx", "syntaxKind": "PropertySignature", - "name": "columnContentTypes", - "value": "ColumnContentType[]", - "description": "List of data types, which determines content alignment for each column. Data types are \"text,\" which aligns left, or \"numeric,\" which aligns right." + "name": "term", + "value": "React.ReactNode", + "description": "Title of the item" }, { - "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", + "filePath": "polaris-react/src/components/DescriptionList/DescriptionList.tsx", "syntaxKind": "PropertySignature", - "name": "headings", - "value": "React.ReactNode[]", - "description": "List of column headings." - }, + "name": "description", + "value": "React.ReactNode", + "description": "Item content" + } + ], + "value": "interface Item {\n /** Title of the item */\n term: React.ReactNode;\n /** Item content */\n description: React.ReactNode;\n}" + }, + "polaris-react/src/components/ExceptionList/ExceptionList.tsx": { + "filePath": "polaris-react/src/components/ExceptionList/ExceptionList.tsx", + "name": "Item", + "description": "", + "members": [ { - "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", + "filePath": "polaris-react/src/components/ExceptionList/ExceptionList.tsx", "syntaxKind": "PropertySignature", - "name": "totals", - "value": "any[]", - "description": "List of numeric column totals, highlighted in the table’s header below column headings. Use empty strings as placeholders for columns with no total.", + "name": "status", + "value": "\"warning\" | \"critical\"", + "description": "Set the color of the icon and title for the given item.", "isOptional": true }, { - "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", + "filePath": "polaris-react/src/components/ExceptionList/ExceptionList.tsx", "syntaxKind": "PropertySignature", - "name": "totalsName", - "value": "{ singular: React.ReactNode; plural: React.ReactNode; }", - "description": "Custom totals row heading", + "name": "icon", + "value": "any", + "description": "Icon displayed by the list item", "isOptional": true }, { - "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", + "filePath": "polaris-react/src/components/ExceptionList/ExceptionList.tsx", "syntaxKind": "PropertySignature", - "name": "showTotalsInFooter", - "value": "boolean", - "description": "Placement of totals row within table", + "name": "title", + "value": "string", + "description": "Text displayed beside the icon", "isOptional": true }, { - "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", + "filePath": "polaris-react/src/components/ExceptionList/ExceptionList.tsx", "syntaxKind": "PropertySignature", - "name": "rows", - "value": "any[][]", - "description": "Lists of data points which map to table body rows." + "name": "description", + "value": "any", + "description": "Text displayed for the item", + "isOptional": true }, { - "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", + "filePath": "polaris-react/src/components/ExceptionList/ExceptionList.tsx", "syntaxKind": "PropertySignature", - "name": "hideScrollIndicator", + "name": "truncate", "value": "boolean", - "description": "Hide column visibility and navigation buttons above the header when the table horizontally collapses to be scrollable.", - "isOptional": true, - "defaultValue": "false" - }, + "description": "Should the description be truncated at end of line", + "isOptional": true + } + ], + "value": "interface Item {\n /** Set the color of the icon and title for the given item. */\n status?: 'critical' | 'warning';\n /** Icon displayed by the list item */\n icon?: IconProps['source'];\n /** Text displayed beside the icon */\n title?: string;\n /** Text displayed for the item */\n description?: Description;\n /** Should the description be truncated at end of line */\n truncate?: boolean;\n}" + } + }, + "DescriptionListProps": { + "polaris-react/src/components/DescriptionList/DescriptionList.tsx": { + "filePath": "polaris-react/src/components/DescriptionList/DescriptionList.tsx", + "name": "DescriptionListProps", + "description": "", + "members": [ { - "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", + "filePath": "polaris-react/src/components/DescriptionList/DescriptionList.tsx", "syntaxKind": "PropertySignature", - "name": "truncate", - "value": "boolean", - "description": "Truncate content in first column instead of wrapping.", - "isOptional": true, - "defaultValue": "true" + "name": "items", + "value": "Item[]", + "description": "Collection of items for list" }, { - "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", + "filePath": "polaris-react/src/components/DescriptionList/DescriptionList.tsx", "syntaxKind": "PropertySignature", - "name": "verticalAlign", - "value": "VerticalAlign", - "description": "Vertical alignment of content in the cells.", + "name": "spacing", + "value": "\"tight\" | \"loose\"", + "description": "Determines the spacing between list items", + "isOptional": true + } + ], + "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": "'top'" + "defaultValue": "'p'" }, { - "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", + "filePath": "polaris-react/src/components/DisplayText/DisplayText.tsx", "syntaxKind": "PropertySignature", - "name": "footerContent", - "value": "any", - "description": "Content centered in the full width cell of the table footer row.", - "isOptional": true + "name": "size", + "value": "Size", + "description": "Size of the text", + "isOptional": true, + "defaultValue": "'medium'" }, { - "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", + "filePath": "polaris-react/src/components/DisplayText/DisplayText.tsx", "syntaxKind": "PropertySignature", - "name": "hoverable", - "value": "boolean", - "description": "Table row has hover state. Defaults to true.", + "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}" + } + }, + "DropZoneFileType": { + "polaris-react/src/components/DropZone/DropZone.tsx": { + "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "DropZoneFileType", + "value": "'file' | 'image' | 'video'", + "description": "" + } + }, + "DropZoneProps": { + "polaris-react/src/components/DropZone/DropZone.tsx": { + "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", + "name": "DropZoneProps", + "description": "", + "members": [ { - "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", + "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", "syntaxKind": "PropertySignature", - "name": "sortable", - "value": "boolean[]", - "description": "List of booleans, which maps to whether sorting is enabled or not for each column. Defaults to false for all columns.", + "name": "label", + "value": "React.ReactNode", + "description": "Label for the file input", "isOptional": true }, { - "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", + "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", "syntaxKind": "PropertySignature", - "name": "defaultSortDirection", - "value": "SortDirection", - "description": "The direction to sort the table rows on first click or keypress of a sortable column heading. Defaults to ascending.", - "isOptional": true, - "defaultValue": "'ascending'" + "name": "labelAction", + "value": "Action", + "description": "Adds an action to the label", + "isOptional": true }, { - "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", + "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", "syntaxKind": "PropertySignature", - "name": "initialSortColumnIndex", - "value": "number", - "description": "The index of the heading that the table rows are initially sorted by. Defaults to the first column.", - "isOptional": true, - "defaultValue": "0" + "name": "labelHidden", + "value": "boolean", + "description": "Visually hide the label", + "isOptional": true }, { - "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", - "syntaxKind": "MethodSignature", - "name": "onSort", - "value": "(headingIndex: number, direction: SortDirection) => void", - "description": "Callback fired on click or keypress of a sortable column heading.", + "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "ID for file input", "isOptional": true }, { - "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", + "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", "syntaxKind": "PropertySignature", - "name": "increasedTableDensity", - "value": "boolean", - "description": "Increased density", + "name": "accept", + "value": "string", + "description": "Allowed file types", "isOptional": true }, { - "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", + "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", "syntaxKind": "PropertySignature", - "name": "hasZebraStripingOnData", + "name": "type", + "value": "DropZoneFileType", + "description": "Whether is a file or an image", + "isOptional": true, + "defaultValue": "'file'" + }, + { + "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", + "syntaxKind": "PropertySignature", + "name": "active", "value": "boolean", - "description": "Add zebra striping to data rows", + "description": "Sets an active state", "isOptional": true }, { - "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", + "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", "syntaxKind": "PropertySignature", - "name": "stickyHeader", + "name": "error", "value": "boolean", - "description": "Header becomes sticky and pins to top of table when scrolling", + "description": "Sets an error state", "isOptional": true }, { - "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", + "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", "syntaxKind": "PropertySignature", - "name": "hasFixedFirstColumn", + "name": "outline", "value": "boolean", - "description": "", + "description": "Displays an outline border", "isOptional": true, - "deprecationMessage": "Add a fixed first column on horizontal scroll. Use fixedFirstColumns={n} instead." + "defaultValue": "true" }, { - "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", + "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", "syntaxKind": "PropertySignature", - "name": "fixedFirstColumns", - "value": "number", - "description": "Add fixed columns on horizontal scroll.", - "isOptional": true + "name": "overlay", + "value": "boolean", + "description": "Displays an overlay on hover", + "isOptional": true, + "defaultValue": "true" }, { - "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", - "syntaxKind": "PropertySignature", - "name": "firstColumnMinWidth", - "value": "string", - "description": "Specify a min width for the first column if neccessary", - "isOptional": true - } - ], - "value": "export interface DataTableProps {\n /** List of data types, which determines content alignment for each column. Data types are \"text,\" which aligns left, or \"numeric,\" which aligns right. */\n columnContentTypes: ColumnContentType[];\n /** List of column headings. */\n headings: React.ReactNode[];\n /** List of numeric column totals, highlighted in the table’s header below column headings. Use empty strings as placeholders for columns with no total. */\n totals?: TableData[];\n /** Custom totals row heading */\n totalsName?: {\n singular: React.ReactNode;\n plural: React.ReactNode;\n };\n /** Placement of totals row within table */\n showTotalsInFooter?: boolean;\n /** Lists of data points which map to table body rows. */\n rows: TableData[][];\n /** Hide column visibility and navigation buttons above the header when the table horizontally collapses to be scrollable.\n * @default false\n */\n hideScrollIndicator?: boolean;\n /** Truncate content in first column instead of wrapping.\n * @default true\n */\n truncate?: boolean;\n /** Vertical alignment of content in the cells.\n * @default 'top'\n */\n verticalAlign?: VerticalAlign;\n /** Content centered in the full width cell of the table footer row. */\n footerContent?: TableData;\n /** Table row has hover state. Defaults to true. */\n hoverable?: boolean;\n /** List of booleans, which maps to whether sorting is enabled or not for each column. Defaults to false for all columns. */\n sortable?: boolean[];\n /**\n * The direction to sort the table rows on first click or keypress of a sortable column heading. Defaults to ascending.\n * @default 'ascending'\n */\n defaultSortDirection?: SortDirection;\n /**\n * The index of the heading that the table rows are initially sorted by. Defaults to the first column.\n * @default 0\n */\n initialSortColumnIndex?: number;\n /** Callback fired on click or keypress of a sortable column heading. */\n onSort?(headingIndex: number, direction: SortDirection): void;\n /** Increased density */\n increasedTableDensity?: boolean;\n /** Add zebra striping to data rows */\n hasZebraStripingOnData?: boolean;\n /** Header becomes sticky and pins to top of table when scrolling */\n stickyHeader?: boolean;\n /** @deprecated Add a fixed first column on horizontal scroll. Use fixedFirstColumns={n} instead. */\n hasFixedFirstColumn?: boolean;\n /** Add fixed columns on horizontal scroll. */\n fixedFirstColumns?: number;\n /** Specify a min width for the first column if neccessary */\n firstColumnMinWidth?: string;\n}" - } - }, - "DatePickerProps": { - "polaris-react/src/components/DatePicker/DatePicker.tsx": { - "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", - "name": "DatePickerProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", + "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", "syntaxKind": "PropertySignature", - "name": "id", + "name": "overlayText", "value": "string", - "description": "ID for the element", + "description": "Text that appears in the overlay", "isOptional": true }, { - "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", + "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", "syntaxKind": "PropertySignature", - "name": "selected", - "value": "Range | Date", - "description": "The selected date or range of dates", + "name": "errorOverlayText", + "value": "string", + "description": "Text that appears in the overlay when set in error state", "isOptional": true }, { - "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", - "syntaxKind": "PropertySignature", - "name": "month", - "value": "number", - "description": "The month to show, from 0 to 11. 0 is January, 1 is February ... 11 is December" - }, - { - "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", + "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", "syntaxKind": "PropertySignature", - "name": "year", - "value": "number", - "description": "The year to show" + "name": "allowMultiple", + "value": "boolean", + "description": "Allows multiple files to be uploaded at once", + "isOptional": true, + "defaultValue": "true" }, { - "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", + "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", "syntaxKind": "PropertySignature", - "name": "allowRange", + "name": "disabled", "value": "boolean", - "description": "Allow a range of dates to be selected", + "description": "Sets a disabled state", "isOptional": true }, { - "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", + "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", "syntaxKind": "PropertySignature", - "name": "disableDatesBefore", - "value": "Date", - "description": "Disable selecting dates before this.", + "name": "children", + "value": "any", + "description": "The child elements to render in the dropzone.", "isOptional": true }, { - "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", + "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", "syntaxKind": "PropertySignature", - "name": "disableDatesAfter", - "value": "Date", - "description": "Disable selecting dates after this.", + "name": "dropOnPage", + "value": "boolean", + "description": "Allows a file to be dropped anywhere on the page", "isOptional": true }, { - "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", + "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", "syntaxKind": "PropertySignature", - "name": "disableSpecificDates", - "value": "Date[]", - "description": "Disable specific dates.", + "name": "openFileDialog", + "value": "boolean", + "description": "Sets the default file dialog state", "isOptional": true }, { - "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", + "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", "syntaxKind": "PropertySignature", - "name": "multiMonth", + "name": "variableHeight", "value": "boolean", - "description": "The selection can span multiple months", + "description": "Allows child content to adjust height", "isOptional": true }, { - "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", - "syntaxKind": "PropertySignature", - "name": "weekStartsOn", - "value": "number", - "description": "First day of week, from 0 to 6. 0 is Sunday, 1 is Monday ... 6 is Saturday", - "isOptional": true, - "defaultValue": "0" - }, - { - "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", - "syntaxKind": "PropertySignature", - "name": "dayAccessibilityLabelPrefix", - "value": "string", - "description": "Visually hidden prefix text for selected days on single selection date pickers", + "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", + "syntaxKind": "MethodSignature", + "name": "customValidator", + "value": "(file: File) => boolean", + "description": "Adds custom validations", "isOptional": true }, { - "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", + "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", "syntaxKind": "MethodSignature", - "name": "onChange", - "value": "(date: Range) => void", - "description": "Callback when date is selected.", + "name": "onClick", + "value": "(event: React.MouseEvent) => void", + "description": "Callback triggered on click", "isOptional": true }, { - "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", + "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", "syntaxKind": "MethodSignature", - "name": "onMonthChange", - "value": "(month: number, year: number) => void", - "description": "Callback when month is changed.", - "isOptional": true - } - ], - "value": "export interface DatePickerProps {\n /** ID for the element */\n id?: string;\n /** The selected date or range of dates */\n selected?: Date | Range;\n /** The month to show, from 0 to 11. 0 is January, 1 is February ... 11 is December */\n month: number;\n /** The year to show */\n year: number;\n /** Allow a range of dates to be selected */\n allowRange?: boolean;\n /** Disable selecting dates before this. */\n disableDatesBefore?: Date;\n /** Disable selecting dates after this. */\n disableDatesAfter?: Date;\n /** Disable specific dates. */\n disableSpecificDates?: Date[];\n /** The selection can span multiple months */\n multiMonth?: boolean;\n /**\n * First day of week, from 0 to 6. 0 is Sunday, 1 is Monday ... 6 is Saturday\n * @default 0\n */\n weekStartsOn?: number;\n /** Visually hidden prefix text for selected days on single selection date pickers */\n dayAccessibilityLabelPrefix?: string;\n /** Callback when date is selected. */\n onChange?(date: Range): void;\n /** Callback when month is changed. */\n onMonthChange?(month: number, year: number): void;\n}" - } - }, - "Item": { - "polaris-react/src/components/DescriptionList/DescriptionList.tsx": { - "filePath": "polaris-react/src/components/DescriptionList/DescriptionList.tsx", - "name": "Item", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/DescriptionList/DescriptionList.tsx", - "syntaxKind": "PropertySignature", - "name": "term", - "value": "React.ReactNode", - "description": "Title of the item" - }, - { - "filePath": "polaris-react/src/components/DescriptionList/DescriptionList.tsx", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "React.ReactNode", - "description": "Item content" - } - ], - "value": "interface Item {\n /** Title of the item */\n term: React.ReactNode;\n /** Item content */\n description: React.ReactNode;\n}" - }, - "polaris-react/src/components/ExceptionList/ExceptionList.tsx": { - "filePath": "polaris-react/src/components/ExceptionList/ExceptionList.tsx", - "name": "Item", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/ExceptionList/ExceptionList.tsx", - "syntaxKind": "PropertySignature", - "name": "status", - "value": "\"warning\" | \"critical\"", - "description": "Set the color of the icon and title for the given item.", + "name": "onDrop", + "value": "(files: File[], acceptedFiles: File[], rejectedFiles: File[]) => void", + "description": "Callback triggered on any file drop", "isOptional": true }, { - "filePath": "polaris-react/src/components/ExceptionList/ExceptionList.tsx", - "syntaxKind": "PropertySignature", - "name": "icon", - "value": "any", - "description": "Icon displayed by the list item", + "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", + "syntaxKind": "MethodSignature", + "name": "onDropAccepted", + "value": "(acceptedFiles: File[]) => void", + "description": "Callback triggered when at least one of the files dropped was accepted", "isOptional": true }, { - "filePath": "polaris-react/src/components/ExceptionList/ExceptionList.tsx", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "Text displayed beside the icon", + "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", + "syntaxKind": "MethodSignature", + "name": "onDropRejected", + "value": "(rejectedFiles: File[]) => void", + "description": "Callback triggered when at least one of the files dropped was rejected", "isOptional": true }, { - "filePath": "polaris-react/src/components/ExceptionList/ExceptionList.tsx", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "any", - "description": "Text displayed for the item", + "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", + "syntaxKind": "MethodSignature", + "name": "onDragOver", + "value": "() => void", + "description": "Callback triggered when one or more files are dragging over the drag area", "isOptional": true }, { - "filePath": "polaris-react/src/components/ExceptionList/ExceptionList.tsx", - "syntaxKind": "PropertySignature", - "name": "truncate", - "value": "boolean", - "description": "Should the description be truncated at end of line", + "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", + "syntaxKind": "MethodSignature", + "name": "onDragEnter", + "value": "() => void", + "description": "Callback triggered when one or more files entered the drag area", "isOptional": true - } - ], - "value": "interface Item {\n /** Set the color of the icon and title for the given item. */\n status?: 'critical' | 'warning';\n /** Icon displayed by the list item */\n icon?: IconProps['source'];\n /** Text displayed beside the icon */\n title?: string;\n /** Text displayed for the item */\n description?: Description;\n /** Should the description be truncated at end of line */\n truncate?: boolean;\n}" - } - }, - "DescriptionListProps": { - "polaris-react/src/components/DescriptionList/DescriptionList.tsx": { - "filePath": "polaris-react/src/components/DescriptionList/DescriptionList.tsx", - "name": "DescriptionListProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/DescriptionList/DescriptionList.tsx", - "syntaxKind": "PropertySignature", - "name": "items", - "value": "Item[]", - "description": "Collection of items for list" }, { - "filePath": "polaris-react/src/components/DescriptionList/DescriptionList.tsx", - "syntaxKind": "PropertySignature", - "name": "spacing", - "value": "\"tight\" | \"loose\"", - "description": "Determines the spacing between list items", + "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", + "syntaxKind": "MethodSignature", + "name": "onDragLeave", + "value": "() => void", + "description": "Callback triggered when one or more files left the drag area", "isOptional": true - } - ], - "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", + "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", + "syntaxKind": "MethodSignature", + "name": "onFileDialogClose", + "value": "() => void", + "description": "Callback triggered when the file dialog is canceled", "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}" - } - }, - "DropZoneFileType": { - "polaris-react/src/components/DropZone/DropZone.tsx": { - "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "DropZoneFileType", - "value": "'file' | 'image' | 'video'", - "description": "" + "value": "export interface DropZoneProps {\n /** Label for the file 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 /** ID for file input */\n id?: string;\n /** Allowed file types */\n accept?: string;\n /**\n * Whether is a file or an image\n * @default 'file'\n */\n type?: DropZoneFileType;\n /** Sets an active state */\n active?: boolean;\n /** Sets an error state */\n error?: boolean;\n /**\n * Displays an outline border\n * @default true\n */\n outline?: boolean;\n /**\n * Displays an overlay on hover\n * @default true\n */\n overlay?: boolean;\n /** Text that appears in the overlay */\n overlayText?: string;\n /** Text that appears in the overlay when set in error state */\n errorOverlayText?: string;\n /**\n * Allows multiple files to be uploaded at once\n * @default true\n */\n allowMultiple?: boolean;\n /** Sets a disabled state */\n disabled?: boolean;\n /** The child elements to render in the dropzone. */\n children?: string | React.ReactNode;\n /** Allows a file to be dropped anywhere on the page */\n dropOnPage?: boolean;\n /** Sets the default file dialog state */\n openFileDialog?: boolean;\n /** Allows child content to adjust height */\n variableHeight?: boolean;\n /** Adds custom validations */\n customValidator?(file: File): boolean;\n /** Callback triggered on click */\n onClick?(event: React.MouseEvent): void;\n /** Callback triggered on any file drop */\n onDrop?(files: File[], acceptedFiles: File[], rejectedFiles: File[]): void;\n /** Callback triggered when at least one of the files dropped was accepted */\n onDropAccepted?(acceptedFiles: File[]): void;\n /** Callback triggered when at least one of the files dropped was rejected */\n onDropRejected?(rejectedFiles: File[]): void;\n /** Callback triggered when one or more files are dragging over the drag area */\n onDragOver?(): void;\n /** Callback triggered when one or more files entered the drag area */\n onDragEnter?(): void;\n /** Callback triggered when one or more files left the drag area */\n onDragLeave?(): void;\n /** Callback triggered when the file dialog is canceled */\n onFileDialogClose?(): void;\n}" } }, - "DropZoneProps": { + "DropZoneInputProps": { "polaris-react/src/components/DropZone/DropZone.tsx": { "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", - "name": "DropZoneProps", + "name": "DropZoneInputProps", "description": "", "members": [ { "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", "syntaxKind": "PropertySignature", - "name": "label", - "value": "React.ReactNode", - "description": "Label for the file input", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", - "syntaxKind": "PropertySignature", - "name": "labelAction", - "value": "Action", - "description": "Adds an action to the label", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", - "syntaxKind": "PropertySignature", - "name": "labelHidden", - "value": "boolean", - "description": "Visually hide the label", - "isOptional": true + "name": "id", + "value": "string", + "description": "" }, { "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", "syntaxKind": "PropertySignature", - "name": "id", + "name": "accept", "value": "string", - "description": "ID for file input", + "description": "", "isOptional": true }, { "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", "syntaxKind": "PropertySignature", - "name": "accept", - "value": "string", - "description": "Allowed file types", - "isOptional": true + "name": "disabled", + "value": "boolean", + "description": "" }, { "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", "syntaxKind": "PropertySignature", "name": "type", "value": "DropZoneFileType", - "description": "Whether is a file or an image", - "isOptional": true, - "defaultValue": "'file'" + "description": "" }, { "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", "syntaxKind": "PropertySignature", - "name": "active", + "name": "multiple", "value": "boolean", - "description": "Sets an active state", - "isOptional": true + "description": "" }, { "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", "syntaxKind": "PropertySignature", - "name": "error", + "name": "openFileDialog", "value": "boolean", - "description": "Sets an error state", + "description": "", "isOptional": true }, { "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", - "syntaxKind": "PropertySignature", - "name": "outline", - "value": "boolean", - "description": "Displays an outline border", - "isOptional": true, - "defaultValue": "true" + "syntaxKind": "MethodSignature", + "name": "onChange", + "value": "(event: any) => void", + "description": "" }, { "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", - "syntaxKind": "PropertySignature", - "name": "overlay", - "value": "boolean", - "description": "Displays an overlay on hover", - "isOptional": true, - "defaultValue": "true" + "syntaxKind": "MethodSignature", + "name": "onFocus", + "value": "() => void", + "description": "" }, { "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", - "syntaxKind": "PropertySignature", - "name": "overlayText", - "value": "string", - "description": "Text that appears in the overlay", - "isOptional": true + "syntaxKind": "MethodSignature", + "name": "onBlur", + "value": "() => void", + "description": "" }, { "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", - "syntaxKind": "PropertySignature", - "name": "errorOverlayText", - "value": "string", - "description": "Text that appears in the overlay when set in error state", + "syntaxKind": "MethodSignature", + "name": "onFileDialogClose", + "value": "() => void", + "description": "", "isOptional": true - }, + } + ], + "value": "interface DropZoneInputProps {\n id: string;\n accept?: string;\n disabled: boolean;\n type: DropZoneFileType;\n multiple: boolean;\n openFileDialog?: boolean;\n onChange(event: DragEvent | React.ChangeEvent): void;\n onFocus(): void;\n onBlur(): void;\n onFileDialogClose?(): void;\n}" + } + }, + "DropZoneContextType": { + "polaris-react/src/components/DropZone/context.tsx": { + "filePath": "polaris-react/src/components/DropZone/context.tsx", + "name": "DropZoneContextType", + "description": "", + "members": [ { - "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", + "filePath": "polaris-react/src/components/DropZone/context.tsx", "syntaxKind": "PropertySignature", - "name": "allowMultiple", + "name": "disabled", "value": "boolean", - "description": "Allows multiple files to be uploaded at once", - "isOptional": true, - "defaultValue": "true" + "description": "" }, { - "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", + "filePath": "polaris-react/src/components/DropZone/context.tsx", "syntaxKind": "PropertySignature", - "name": "disabled", + "name": "focused", "value": "boolean", - "description": "Sets a disabled state", - "isOptional": true + "description": "" }, { - "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", + "filePath": "polaris-react/src/components/DropZone/context.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "any", - "description": "The child elements to render in the dropzone.", - "isOptional": true + "name": "measuring", + "value": "boolean", + "description": "" }, { - "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", + "filePath": "polaris-react/src/components/DropZone/context.tsx", "syntaxKind": "PropertySignature", - "name": "dropOnPage", + "name": "allowMultiple", "value": "boolean", - "description": "Allows a file to be dropped anywhere on the page", - "isOptional": true + "description": "" }, { - "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", + "filePath": "polaris-react/src/components/DropZone/context.tsx", "syntaxKind": "PropertySignature", - "name": "openFileDialog", - "value": "boolean", - "description": "Sets the default file dialog state", + "name": "size", + "value": "string", + "description": "" + }, + { + "filePath": "polaris-react/src/components/DropZone/context.tsx", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "string", + "description": "" + } + ], + "value": "interface DropZoneContextType {\n disabled: boolean;\n focused: boolean;\n measuring: boolean;\n allowMultiple: boolean;\n size: string;\n type: string;\n}" + } + }, + "EmptySearchResultProps": { + "polaris-react/src/components/EmptySearchResult/EmptySearchResult.tsx": { + "filePath": "polaris-react/src/components/EmptySearchResult/EmptySearchResult.tsx", + "name": "EmptySearchResultProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/EmptySearchResult/EmptySearchResult.tsx", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "" + }, + { + "filePath": "polaris-react/src/components/EmptySearchResult/EmptySearchResult.tsx", + "syntaxKind": "PropertySignature", + "name": "description", + "value": "string", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", + "filePath": "polaris-react/src/components/EmptySearchResult/EmptySearchResult.tsx", "syntaxKind": "PropertySignature", - "name": "variableHeight", + "name": "withIllustration", "value": "boolean", - "description": "Allows child content to adjust height", + "description": "", "isOptional": true - }, + } + ], + "value": "export interface EmptySearchResultProps {\n title: string;\n description?: string;\n withIllustration?: boolean;\n}" + } + }, + "EmptyStateProps": { + "polaris-react/src/components/EmptyState/EmptyState.tsx": { + "filePath": "polaris-react/src/components/EmptyState/EmptyState.tsx", + "name": "EmptyStateProps", + "description": "", + "members": [ { - "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", - "syntaxKind": "MethodSignature", - "name": "customValidator", - "value": "(file: File) => boolean", - "description": "Adds custom validations", + "filePath": "polaris-react/src/components/EmptyState/EmptyState.tsx", + "syntaxKind": "PropertySignature", + "name": "heading", + "value": "string", + "description": "The empty state heading", "isOptional": true }, { - "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", - "syntaxKind": "MethodSignature", - "name": "onClick", - "value": "(event: React.MouseEvent) => void", - "description": "Callback triggered on click", - "isOptional": true + "filePath": "polaris-react/src/components/EmptyState/EmptyState.tsx", + "syntaxKind": "PropertySignature", + "name": "image", + "value": "string", + "description": "The path to the image to display.\nThe image should have ~40px of white space above when empty state is used within a card, modal, or navigation component" }, { - "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", - "syntaxKind": "MethodSignature", - "name": "onDrop", - "value": "(files: File[], acceptedFiles: File[], rejectedFiles: File[]) => void", - "description": "Callback triggered on any file drop", + "filePath": "polaris-react/src/components/EmptyState/EmptyState.tsx", + "syntaxKind": "PropertySignature", + "name": "largeImage", + "value": "string", + "description": "The path to the image to display on large screens", "isOptional": true }, { - "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", - "syntaxKind": "MethodSignature", - "name": "onDropAccepted", - "value": "(acceptedFiles: File[]) => void", - "description": "Callback triggered when at least one of the files dropped was accepted", + "filePath": "polaris-react/src/components/EmptyState/EmptyState.tsx", + "syntaxKind": "PropertySignature", + "name": "imageContained", + "value": "boolean", + "description": "Whether or not to limit the image to the size of its container on large screens", "isOptional": true }, { - "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", - "syntaxKind": "MethodSignature", - "name": "onDropRejected", - "value": "(rejectedFiles: File[]) => void", - "description": "Callback triggered when at least one of the files dropped was rejected", + "filePath": "polaris-react/src/components/EmptyState/EmptyState.tsx", + "syntaxKind": "PropertySignature", + "name": "fullWidth", + "value": "boolean", + "description": "Whether or not the content should span the full width of its container", "isOptional": true }, { - "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", - "syntaxKind": "MethodSignature", - "name": "onDragOver", - "value": "() => void", - "description": "Callback triggered when one or more files are dragging over the drag area", + "filePath": "polaris-react/src/components/EmptyState/EmptyState.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "Elements to display inside empty state", "isOptional": true }, { - "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", - "syntaxKind": "MethodSignature", - "name": "onDragEnter", - "value": "() => void", - "description": "Callback triggered when one or more files entered the drag area", + "filePath": "polaris-react/src/components/EmptyState/EmptyState.tsx", + "syntaxKind": "PropertySignature", + "name": "action", + "value": "ComplexAction", + "description": "Primary action for empty state", "isOptional": true }, { - "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", - "syntaxKind": "MethodSignature", - "name": "onDragLeave", - "value": "() => void", - "description": "Callback triggered when one or more files left the drag area", + "filePath": "polaris-react/src/components/EmptyState/EmptyState.tsx", + "syntaxKind": "PropertySignature", + "name": "secondaryAction", + "value": "ComplexAction", + "description": "Secondary action for empty state", "isOptional": true }, { - "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", - "syntaxKind": "MethodSignature", - "name": "onFileDialogClose", - "value": "() => void", - "description": "Callback triggered when the file dialog is canceled", + "filePath": "polaris-react/src/components/EmptyState/EmptyState.tsx", + "syntaxKind": "PropertySignature", + "name": "footerContent", + "value": "React.ReactNode", + "description": "Secondary elements to display below empty state actions", "isOptional": true } ], - "value": "export interface DropZoneProps {\n /** Label for the file 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 /** ID for file input */\n id?: string;\n /** Allowed file types */\n accept?: string;\n /**\n * Whether is a file or an image\n * @default 'file'\n */\n type?: DropZoneFileType;\n /** Sets an active state */\n active?: boolean;\n /** Sets an error state */\n error?: boolean;\n /**\n * Displays an outline border\n * @default true\n */\n outline?: boolean;\n /**\n * Displays an overlay on hover\n * @default true\n */\n overlay?: boolean;\n /** Text that appears in the overlay */\n overlayText?: string;\n /** Text that appears in the overlay when set in error state */\n errorOverlayText?: string;\n /**\n * Allows multiple files to be uploaded at once\n * @default true\n */\n allowMultiple?: boolean;\n /** Sets a disabled state */\n disabled?: boolean;\n /** The child elements to render in the dropzone. */\n children?: string | React.ReactNode;\n /** Allows a file to be dropped anywhere on the page */\n dropOnPage?: boolean;\n /** Sets the default file dialog state */\n openFileDialog?: boolean;\n /** Allows child content to adjust height */\n variableHeight?: boolean;\n /** Adds custom validations */\n customValidator?(file: File): boolean;\n /** Callback triggered on click */\n onClick?(event: React.MouseEvent): void;\n /** Callback triggered on any file drop */\n onDrop?(files: File[], acceptedFiles: File[], rejectedFiles: File[]): void;\n /** Callback triggered when at least one of the files dropped was accepted */\n onDropAccepted?(acceptedFiles: File[]): void;\n /** Callback triggered when at least one of the files dropped was rejected */\n onDropRejected?(rejectedFiles: File[]): void;\n /** Callback triggered when one or more files are dragging over the drag area */\n onDragOver?(): void;\n /** Callback triggered when one or more files entered the drag area */\n onDragEnter?(): void;\n /** Callback triggered when one or more files left the drag area */\n onDragLeave?(): void;\n /** Callback triggered when the file dialog is canceled */\n onFileDialogClose?(): void;\n}" + "value": "export interface EmptyStateProps {\n /** The empty state heading */\n heading?: string;\n /**\n * The path to the image to display.\n * The image should have ~40px of white space above when empty state is used within a card, modal, or navigation component\n */\n image: string;\n /** The path to the image to display on large screens */\n largeImage?: string;\n /** Whether or not to limit the image to the size of its container on large screens */\n imageContained?: boolean;\n /** Whether or not the content should span the full width of its container */\n fullWidth?: boolean;\n /** Elements to display inside empty state */\n children?: React.ReactNode;\n /** Primary action for empty state */\n action?: ComplexAction;\n /** Secondary action for empty state */\n secondaryAction?: ComplexAction;\n /** Secondary elements to display below empty state actions */\n footerContent?: React.ReactNode;\n}" } }, - "DropZoneInputProps": { - "polaris-react/src/components/DropZone/DropZone.tsx": { - "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", - "name": "DropZoneInputProps", + "DatePickerProps": { + "polaris-react/src/components/DatePicker/DatePicker.tsx": { + "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", + "name": "DatePickerProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", + "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "" + "description": "ID for the element", + "isOptional": true }, { - "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", + "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", "syntaxKind": "PropertySignature", - "name": "accept", - "value": "string", - "description": "", + "name": "selected", + "value": "Range | Date", + "description": "The selected date or range of dates", "isOptional": true }, { - "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", + "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "" + "name": "month", + "value": "number", + "description": "The month to show, from 0 to 11. 0 is January, 1 is February ... 11 is December" }, { - "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", + "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", "syntaxKind": "PropertySignature", - "name": "type", - "value": "DropZoneFileType", - "description": "" + "name": "year", + "value": "number", + "description": "The year to show" }, { - "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", + "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", "syntaxKind": "PropertySignature", - "name": "multiple", + "name": "allowRange", "value": "boolean", - "description": "" + "description": "Allow a range of dates to be selected", + "isOptional": true }, { - "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", + "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", "syntaxKind": "PropertySignature", - "name": "openFileDialog", + "name": "disableDatesBefore", + "value": "Date", + "description": "Disable selecting dates before this.", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", + "syntaxKind": "PropertySignature", + "name": "disableDatesAfter", + "value": "Date", + "description": "Disable selecting dates after this.", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", + "syntaxKind": "PropertySignature", + "name": "disableSpecificDates", + "value": "Date[]", + "description": "Disable specific dates.", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", + "syntaxKind": "PropertySignature", + "name": "multiMonth", "value": "boolean", - "description": "", + "description": "The selection can span multiple months", "isOptional": true }, { - "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", - "syntaxKind": "MethodSignature", - "name": "onChange", - "value": "(event: any) => void", - "description": "" + "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", + "syntaxKind": "PropertySignature", + "name": "weekStartsOn", + "value": "number", + "description": "First day of week, from 0 to 6. 0 is Sunday, 1 is Monday ... 6 is Saturday", + "isOptional": true, + "defaultValue": "0" }, { - "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", - "syntaxKind": "MethodSignature", - "name": "onFocus", - "value": "() => void", - "description": "" + "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", + "syntaxKind": "PropertySignature", + "name": "dayAccessibilityLabelPrefix", + "value": "string", + "description": "Visually hidden prefix text for selected days on single selection date pickers", + "isOptional": true }, { - "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", + "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", "syntaxKind": "MethodSignature", - "name": "onBlur", - "value": "() => void", - "description": "" + "name": "onChange", + "value": "(date: Range) => void", + "description": "Callback when date is selected.", + "isOptional": true }, { - "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", + "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", "syntaxKind": "MethodSignature", - "name": "onFileDialogClose", - "value": "() => void", - "description": "", + "name": "onMonthChange", + "value": "(month: number, year: number) => void", + "description": "Callback when month is changed.", "isOptional": true } ], - "value": "interface DropZoneInputProps {\n id: string;\n accept?: string;\n disabled: boolean;\n type: DropZoneFileType;\n multiple: boolean;\n openFileDialog?: boolean;\n onChange(event: DragEvent | React.ChangeEvent): void;\n onFocus(): void;\n onBlur(): void;\n onFileDialogClose?(): void;\n}" + "value": "export interface DatePickerProps {\n /** ID for the element */\n id?: string;\n /** The selected date or range of dates */\n selected?: Date | Range;\n /** The month to show, from 0 to 11. 0 is January, 1 is February ... 11 is December */\n month: number;\n /** The year to show */\n year: number;\n /** Allow a range of dates to be selected */\n allowRange?: boolean;\n /** Disable selecting dates before this. */\n disableDatesBefore?: Date;\n /** Disable selecting dates after this. */\n disableDatesAfter?: Date;\n /** Disable specific dates. */\n disableSpecificDates?: Date[];\n /** The selection can span multiple months */\n multiMonth?: boolean;\n /**\n * First day of week, from 0 to 6. 0 is Sunday, 1 is Monday ... 6 is Saturday\n * @default 0\n */\n weekStartsOn?: number;\n /** Visually hidden prefix text for selected days on single selection date pickers */\n dayAccessibilityLabelPrefix?: string;\n /** Callback when date is selected. */\n onChange?(date: Range): void;\n /** Callback when month is changed. */\n onMonthChange?(month: number, year: number): void;\n}" } }, - "DropZoneContextType": { - "polaris-react/src/components/DropZone/context.tsx": { - "filePath": "polaris-react/src/components/DropZone/context.tsx", - "name": "DropZoneContextType", + "TableRow": { + "polaris-react/src/components/DataTable/DataTable.tsx": { + "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "TableRow", + "value": "DataTableProps['headings'] | DataTableProps['rows'] | DataTableProps['totals']", + "description": "" + } + }, + "TableData": { + "polaris-react/src/components/DataTable/DataTable.tsx": { + "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "TableData", + "value": "string | number | React.ReactNode", + "description": "" + } + }, + "ColumnContentType": { + "polaris-react/src/components/DataTable/DataTable.tsx": { + "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "ColumnContentType", + "value": "'text' | 'numeric'", + "description": "" + } + }, + "DataTableProps": { + "polaris-react/src/components/DataTable/DataTable.tsx": { + "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", + "name": "DataTableProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/DropZone/context.tsx", + "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "" + "name": "columnContentTypes", + "value": "ColumnContentType[]", + "description": "List of data types, which determines content alignment for each column. Data types are \"text,\" which aligns left, or \"numeric,\" which aligns right." }, { - "filePath": "polaris-react/src/components/DropZone/context.tsx", + "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", "syntaxKind": "PropertySignature", - "name": "focused", - "value": "boolean", - "description": "" + "name": "headings", + "value": "React.ReactNode[]", + "description": "List of column headings." }, { - "filePath": "polaris-react/src/components/DropZone/context.tsx", + "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", "syntaxKind": "PropertySignature", - "name": "measuring", - "value": "boolean", - "description": "" + "name": "totals", + "value": "any[]", + "description": "List of numeric column totals, highlighted in the table’s header below column headings. Use empty strings as placeholders for columns with no total.", + "isOptional": true }, { - "filePath": "polaris-react/src/components/DropZone/context.tsx", + "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", "syntaxKind": "PropertySignature", - "name": "allowMultiple", + "name": "totalsName", + "value": "{ singular: React.ReactNode; plural: React.ReactNode; }", + "description": "Custom totals row heading", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", + "syntaxKind": "PropertySignature", + "name": "showTotalsInFooter", "value": "boolean", - "description": "" + "description": "Placement of totals row within table", + "isOptional": true }, { - "filePath": "polaris-react/src/components/DropZone/context.tsx", + "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", "syntaxKind": "PropertySignature", - "name": "size", - "value": "string", - "description": "" + "name": "rows", + "value": "any[][]", + "description": "Lists of data points which map to table body rows." }, { - "filePath": "polaris-react/src/components/DropZone/context.tsx", + "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", "syntaxKind": "PropertySignature", - "name": "type", - "value": "string", - "description": "" - } - ], - "value": "interface DropZoneContextType {\n disabled: boolean;\n focused: boolean;\n measuring: boolean;\n allowMultiple: boolean;\n size: string;\n type: string;\n}" - } - }, - "EmptySearchResultProps": { - "polaris-react/src/components/EmptySearchResult/EmptySearchResult.tsx": { - "filePath": "polaris-react/src/components/EmptySearchResult/EmptySearchResult.tsx", - "name": "EmptySearchResultProps", - "description": "", - "members": [ + "name": "hideScrollIndicator", + "value": "boolean", + "description": "Hide column visibility and navigation buttons above the header when the table horizontally collapses to be scrollable.", + "isOptional": true, + "defaultValue": "false" + }, { - "filePath": "polaris-react/src/components/EmptySearchResult/EmptySearchResult.tsx", + "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "" + "name": "truncate", + "value": "boolean", + "description": "Truncate content in first column instead of wrapping.", + "isOptional": true, + "defaultValue": "true" }, { - "filePath": "polaris-react/src/components/EmptySearchResult/EmptySearchResult.tsx", + "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "", + "name": "verticalAlign", + "value": "VerticalAlign", + "description": "Vertical alignment of content in the cells.", + "isOptional": true, + "defaultValue": "'top'" + }, + { + "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", + "syntaxKind": "PropertySignature", + "name": "footerContent", + "value": "any", + "description": "Content centered in the full width cell of the table footer row.", "isOptional": true }, { - "filePath": "polaris-react/src/components/EmptySearchResult/EmptySearchResult.tsx", + "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", "syntaxKind": "PropertySignature", - "name": "withIllustration", + "name": "hoverable", "value": "boolean", - "description": "", + "description": "Table row has hover state. Defaults to true.", "isOptional": true - } - ], - "value": "export interface EmptySearchResultProps {\n title: string;\n description?: string;\n withIllustration?: boolean;\n}" - } - }, - "EmptyStateProps": { - "polaris-react/src/components/EmptyState/EmptyState.tsx": { - "filePath": "polaris-react/src/components/EmptyState/EmptyState.tsx", - "name": "EmptyStateProps", - "description": "", - "members": [ + }, { - "filePath": "polaris-react/src/components/EmptyState/EmptyState.tsx", + "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", "syntaxKind": "PropertySignature", - "name": "heading", - "value": "string", - "description": "The empty state heading", + "name": "sortable", + "value": "boolean[]", + "description": "List of booleans, which maps to whether sorting is enabled or not for each column. Defaults to false for all columns.", "isOptional": true }, { - "filePath": "polaris-react/src/components/EmptyState/EmptyState.tsx", + "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", "syntaxKind": "PropertySignature", - "name": "image", - "value": "string", - "description": "The path to the image to display.\nThe image should have ~40px of white space above when empty state is used within a card, modal, or navigation component" + "name": "defaultSortDirection", + "value": "SortDirection", + "description": "The direction to sort the table rows on first click or keypress of a sortable column heading. Defaults to ascending.", + "isOptional": true, + "defaultValue": "'ascending'" }, { - "filePath": "polaris-react/src/components/EmptyState/EmptyState.tsx", + "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", "syntaxKind": "PropertySignature", - "name": "largeImage", - "value": "string", - "description": "The path to the image to display on large screens", + "name": "initialSortColumnIndex", + "value": "number", + "description": "The index of the heading that the table rows are initially sorted by. Defaults to the first column.", + "isOptional": true, + "defaultValue": "0" + }, + { + "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", + "syntaxKind": "MethodSignature", + "name": "onSort", + "value": "(headingIndex: number, direction: SortDirection) => void", + "description": "Callback fired on click or keypress of a sortable column heading.", "isOptional": true }, { - "filePath": "polaris-react/src/components/EmptyState/EmptyState.tsx", + "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", "syntaxKind": "PropertySignature", - "name": "imageContained", + "name": "increasedTableDensity", "value": "boolean", - "description": "Whether or not to limit the image to the size of its container on large screens", + "description": "Increased density", "isOptional": true }, { - "filePath": "polaris-react/src/components/EmptyState/EmptyState.tsx", + "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", "syntaxKind": "PropertySignature", - "name": "fullWidth", + "name": "hasZebraStripingOnData", "value": "boolean", - "description": "Whether or not the content should span the full width of its container", + "description": "Add zebra striping to data rows", "isOptional": true }, { - "filePath": "polaris-react/src/components/EmptyState/EmptyState.tsx", + "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "Elements to display inside empty state", + "name": "stickyHeader", + "value": "boolean", + "description": "Header becomes sticky and pins to top of table when scrolling", "isOptional": true }, { - "filePath": "polaris-react/src/components/EmptyState/EmptyState.tsx", + "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", "syntaxKind": "PropertySignature", - "name": "action", - "value": "ComplexAction", - "description": "Primary action for empty state", - "isOptional": true + "name": "hasFixedFirstColumn", + "value": "boolean", + "description": "", + "isOptional": true, + "deprecationMessage": "Add a fixed first column on horizontal scroll. Use fixedFirstColumns={n} instead." }, { - "filePath": "polaris-react/src/components/EmptyState/EmptyState.tsx", + "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", "syntaxKind": "PropertySignature", - "name": "secondaryAction", - "value": "ComplexAction", - "description": "Secondary action for empty state", + "name": "fixedFirstColumns", + "value": "number", + "description": "Add fixed columns on horizontal scroll.", "isOptional": true }, { - "filePath": "polaris-react/src/components/EmptyState/EmptyState.tsx", + "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", "syntaxKind": "PropertySignature", - "name": "footerContent", - "value": "React.ReactNode", - "description": "Secondary elements to display below empty state actions", + "name": "firstColumnMinWidth", + "value": "string", + "description": "Specify a min width for the first column if neccessary", "isOptional": true } ], - "value": "export interface EmptyStateProps {\n /** The empty state heading */\n heading?: string;\n /**\n * The path to the image to display.\n * The image should have ~40px of white space above when empty state is used within a card, modal, or navigation component\n */\n image: string;\n /** The path to the image to display on large screens */\n largeImage?: string;\n /** Whether or not to limit the image to the size of its container on large screens */\n imageContained?: boolean;\n /** Whether or not the content should span the full width of its container */\n fullWidth?: boolean;\n /** Elements to display inside empty state */\n children?: React.ReactNode;\n /** Primary action for empty state */\n action?: ComplexAction;\n /** Secondary action for empty state */\n secondaryAction?: ComplexAction;\n /** Secondary elements to display below empty state actions */\n footerContent?: React.ReactNode;\n}" + "value": "export interface DataTableProps {\n /** List of data types, which determines content alignment for each column. Data types are \"text,\" which aligns left, or \"numeric,\" which aligns right. */\n columnContentTypes: ColumnContentType[];\n /** List of column headings. */\n headings: React.ReactNode[];\n /** List of numeric column totals, highlighted in the table’s header below column headings. Use empty strings as placeholders for columns with no total. */\n totals?: TableData[];\n /** Custom totals row heading */\n totalsName?: {\n singular: React.ReactNode;\n plural: React.ReactNode;\n };\n /** Placement of totals row within table */\n showTotalsInFooter?: boolean;\n /** Lists of data points which map to table body rows. */\n rows: TableData[][];\n /** Hide column visibility and navigation buttons above the header when the table horizontally collapses to be scrollable.\n * @default false\n */\n hideScrollIndicator?: boolean;\n /** Truncate content in first column instead of wrapping.\n * @default true\n */\n truncate?: boolean;\n /** Vertical alignment of content in the cells.\n * @default 'top'\n */\n verticalAlign?: VerticalAlign;\n /** Content centered in the full width cell of the table footer row. */\n footerContent?: TableData;\n /** Table row has hover state. Defaults to true. */\n hoverable?: boolean;\n /** List of booleans, which maps to whether sorting is enabled or not for each column. Defaults to false for all columns. */\n sortable?: boolean[];\n /**\n * The direction to sort the table rows on first click or keypress of a sortable column heading. Defaults to ascending.\n * @default 'ascending'\n */\n defaultSortDirection?: SortDirection;\n /**\n * The index of the heading that the table rows are initially sorted by. Defaults to the first column.\n * @default 0\n */\n initialSortColumnIndex?: number;\n /** Callback fired on click or keypress of a sortable column heading. */\n onSort?(headingIndex: number, direction: SortDirection): void;\n /** Increased density */\n increasedTableDensity?: boolean;\n /** Add zebra striping to data rows */\n hasZebraStripingOnData?: boolean;\n /** Header becomes sticky and pins to top of table when scrolling */\n stickyHeader?: boolean;\n /** @deprecated Add a fixed first column on horizontal scroll. Use fixedFirstColumns={n} instead. */\n hasFixedFirstColumn?: boolean;\n /** Add fixed columns on horizontal scroll. */\n fixedFirstColumns?: number;\n /** Specify a min width for the first column if neccessary */\n firstColumnMinWidth?: string;\n}" } }, "BaseEventProps": { @@ -14345,6 +14280,15 @@ "value": "export interface IndicatorProps {\n pulse?: boolean;\n}" } }, + "BlockAlign": { + "polaris-react/src/components/Inline/Inline.tsx": { + "filePath": "polaris-react/src/components/Inline/Inline.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "BlockAlign", + "value": "'start' | 'center' | 'end' | 'baseline' | 'stretch'", + "description": "" + } + }, "InlineProps": { "polaris-react/src/components/Inline/Inline.tsx": { "filePath": "polaris-react/src/components/Inline/Inline.tsx", @@ -14354,45 +14298,49 @@ { "filePath": "polaris-react/src/components/Inline/Inline.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "Elements to display inside stack", - "isOptional": true + "name": "align", + "value": "Align", + "description": "Adjust horizontal alignment of elements", + "isOptional": true, + "defaultValue": "'start'" }, { "filePath": "polaris-react/src/components/Inline/Inline.tsx", "syntaxKind": "PropertySignature", - "name": "wrap", - "value": "boolean", - "description": "Wrap stack elements to additional rows as needed on small screens (Defaults to true)", - "isOptional": true + "name": "blockAlign", + "value": "BlockAlign", + "description": "Adjust vertical alignment of elements", + "isOptional": true, + "defaultValue": "'center'" }, { "filePath": "polaris-react/src/components/Inline/Inline.tsx", "syntaxKind": "PropertySignature", "name": "spacing", "value": "\"0\" | \"025\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", - "description": "Adjust spacing between elements", - "isOptional": true + "description": "The spacing between elements", + "isOptional": true, + "defaultValue": "'4'" }, { "filePath": "polaris-react/src/components/Inline/Inline.tsx", "syntaxKind": "PropertySignature", - "name": "alignY", - "value": "\"center\" | \"top\" | \"bottom\" | \"baseline\"", - "description": "Adjust vertical alignment of elements", - "isOptional": true + "name": "wrap", + "value": "boolean", + "description": "Wrap stack elements to additional rows as needed on small screens", + "isOptional": true, + "defaultValue": "true" }, { "filePath": "polaris-react/src/components/Inline/Inline.tsx", "syntaxKind": "PropertySignature", - "name": "align", - "value": "Align", - "description": "Adjust horizontal alignment of elements", + "name": "children", + "value": "React.ReactNode", + "description": "Elements to display inside stack", "isOptional": true } ], - "value": "export interface InlineProps {\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 /** Adjust spacing between elements */\n spacing?: SpacingSpaceScale;\n /** Adjust vertical alignment of elements */\n alignY?: keyof typeof AlignY;\n /** Adjust horizontal alignment of elements */\n align?: Align;\n}" + "value": "export interface InlineProps {\n /** Adjust horizontal alignment of elements\n * @default 'start'\n */\n align?: Align;\n /** Adjust vertical alignment of elements\n * @default 'center'\n */\n blockAlign?: BlockAlign;\n /** The spacing between elements\n * @default '4'\n */\n spacing?: SpacingSpaceScale;\n /** Wrap stack elements to additional rows as needed on small screens\n * @default true\n */\n wrap?: boolean;\n /** Elements to display inside stack */\n children?: React.ReactNode;\n}" } }, "InlineCodeProps": { @@ -15654,167 +15602,29 @@ { "filePath": "polaris-react/src/components/PageActions/PageActions.tsx", "syntaxKind": "PropertySignature", - "name": "secondaryActions", - "value": "any", - "description": "The secondary actions for the page", - "isOptional": true - } - ], - "value": "export interface PageActionsProps {\n /** The primary action for the page */\n primaryAction?: (DisableableAction & LoadableAction) | React.ReactNode;\n /** The secondary actions for the page */\n secondaryActions?: ComplexAction[] | React.ReactNode;\n}" - } - }, - "MaybeJSX": { - "polaris-react/src/components/PageActions/PageActions.tsx": { - "filePath": "polaris-react/src/components/PageActions/PageActions.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "MaybeJSX", - "value": "JSX.Element | null", - "description": "" - }, - "polaris-react/src/components/Page/components/Header/Header.tsx": { - "filePath": "polaris-react/src/components/Page/components/Header/Header.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "MaybeJSX", - "value": "JSX.Element | null", - "description": "" - } - }, - "AccessibilityLabels": { - "polaris-react/src/components/Pagination/Pagination.tsx": { - "filePath": "polaris-react/src/components/Pagination/Pagination.tsx", - "name": "AccessibilityLabels", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Pagination/Pagination.tsx", - "syntaxKind": "PropertySignature", - "name": "previous", - "value": "string", - "description": "" - }, - { - "filePath": "polaris-react/src/components/Pagination/Pagination.tsx", - "syntaxKind": "PropertySignature", - "name": "next", - "value": "string", - "description": "" - } - ], - "value": "interface AccessibilityLabels {\n previous: string;\n next: string;\n}" - } - }, - "PaginationProps": { - "polaris-react/src/components/Pagination/Pagination.tsx": { - "filePath": "polaris-react/src/components/Pagination/Pagination.tsx", - "name": "PaginationProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Pagination/Pagination.tsx", - "syntaxKind": "PropertySignature", - "name": "nextKeys", - "value": "Key[]", - "description": "Keyboard shortcuts for the next button", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Pagination/Pagination.tsx", - "syntaxKind": "PropertySignature", - "name": "previousKeys", - "value": "Key[]", - "description": "Keyboard shortcuts for the previous button", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Pagination/Pagination.tsx", - "syntaxKind": "PropertySignature", - "name": "nextTooltip", - "value": "string", - "description": "Tooltip for the next button", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Pagination/Pagination.tsx", - "syntaxKind": "PropertySignature", - "name": "previousTooltip", - "value": "string", - "description": "Tooltip for the previous button", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Pagination/Pagination.tsx", - "syntaxKind": "PropertySignature", - "name": "nextURL", - "value": "string", - "description": "The URL of the next page", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Pagination/Pagination.tsx", - "syntaxKind": "PropertySignature", - "name": "previousURL", - "value": "string", - "description": "The URL of the previous page", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Pagination/Pagination.tsx", - "syntaxKind": "PropertySignature", - "name": "hasNext", - "value": "boolean", - "description": "Whether there is a next page to show", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Pagination/Pagination.tsx", - "syntaxKind": "PropertySignature", - "name": "hasPrevious", - "value": "boolean", - "description": "Whether there is a previous page to show", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Pagination/Pagination.tsx", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "Accessible label for the pagination", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Pagination/Pagination.tsx", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabels", - "value": "AccessibilityLabels", - "description": "Accessible labels for the buttons and UnstyledLinks", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Pagination/Pagination.tsx", - "syntaxKind": "MethodSignature", - "name": "onNext", - "value": "() => void", - "description": "Callback when next button is clicked", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Pagination/Pagination.tsx", - "syntaxKind": "MethodSignature", - "name": "onPrevious", - "value": "() => void", - "description": "Callback when previous button is clicked", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Pagination/Pagination.tsx", - "syntaxKind": "PropertySignature", - "name": "label", - "value": "React.ReactNode", - "description": "Text to provide more context in between the arrow buttons", + "name": "secondaryActions", + "value": "any", + "description": "The secondary actions for the page", "isOptional": true } ], - "value": "export interface PaginationProps {\n /** Keyboard shortcuts for the next button */\n nextKeys?: Key[];\n /** Keyboard shortcuts for the previous button */\n previousKeys?: Key[];\n /** Tooltip for the next button */\n nextTooltip?: string;\n /** Tooltip for the previous button */\n previousTooltip?: string;\n /** The URL of the next page */\n nextURL?: string;\n /** The URL of the previous page */\n previousURL?: string;\n /** Whether there is a next page to show */\n hasNext?: boolean;\n /** Whether there is a previous page to show */\n hasPrevious?: boolean;\n /** Accessible label for the pagination */\n accessibilityLabel?: string;\n /** Accessible labels for the buttons and UnstyledLinks */\n accessibilityLabels?: AccessibilityLabels;\n /** Callback when next button is clicked */\n onNext?(): void;\n /** Callback when previous button is clicked */\n onPrevious?(): void;\n /** Text to provide more context in between the arrow buttons */\n label?: React.ReactNode;\n}" + "value": "export interface PageActionsProps {\n /** The primary action for the page */\n primaryAction?: (DisableableAction & LoadableAction) | React.ReactNode;\n /** The secondary actions for the page */\n secondaryActions?: ComplexAction[] | React.ReactNode;\n}" + } + }, + "MaybeJSX": { + "polaris-react/src/components/PageActions/PageActions.tsx": { + "filePath": "polaris-react/src/components/PageActions/PageActions.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "MaybeJSX", + "value": "JSX.Element | null", + "description": "" + }, + "polaris-react/src/components/Page/components/Header/Header.tsx": { + "filePath": "polaris-react/src/components/Page/components/Header/Header.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "MaybeJSX", + "value": "JSX.Element | null", + "description": "" } }, "MediaQueryContextType": { @@ -15956,6 +15766,144 @@ "value": "export interface PolarisTestProviderProps\n extends WithPolarisTestProviderOptions {\n children: React.ReactElement;\n strict?: boolean;\n}" } }, + "AccessibilityLabels": { + "polaris-react/src/components/Pagination/Pagination.tsx": { + "filePath": "polaris-react/src/components/Pagination/Pagination.tsx", + "name": "AccessibilityLabels", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Pagination/Pagination.tsx", + "syntaxKind": "PropertySignature", + "name": "previous", + "value": "string", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Pagination/Pagination.tsx", + "syntaxKind": "PropertySignature", + "name": "next", + "value": "string", + "description": "" + } + ], + "value": "interface AccessibilityLabels {\n previous: string;\n next: string;\n}" + } + }, + "PaginationProps": { + "polaris-react/src/components/Pagination/Pagination.tsx": { + "filePath": "polaris-react/src/components/Pagination/Pagination.tsx", + "name": "PaginationProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Pagination/Pagination.tsx", + "syntaxKind": "PropertySignature", + "name": "nextKeys", + "value": "Key[]", + "description": "Keyboard shortcuts for the next button", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Pagination/Pagination.tsx", + "syntaxKind": "PropertySignature", + "name": "previousKeys", + "value": "Key[]", + "description": "Keyboard shortcuts for the previous button", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Pagination/Pagination.tsx", + "syntaxKind": "PropertySignature", + "name": "nextTooltip", + "value": "string", + "description": "Tooltip for the next button", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Pagination/Pagination.tsx", + "syntaxKind": "PropertySignature", + "name": "previousTooltip", + "value": "string", + "description": "Tooltip for the previous button", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Pagination/Pagination.tsx", + "syntaxKind": "PropertySignature", + "name": "nextURL", + "value": "string", + "description": "The URL of the next page", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Pagination/Pagination.tsx", + "syntaxKind": "PropertySignature", + "name": "previousURL", + "value": "string", + "description": "The URL of the previous page", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Pagination/Pagination.tsx", + "syntaxKind": "PropertySignature", + "name": "hasNext", + "value": "boolean", + "description": "Whether there is a next page to show", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Pagination/Pagination.tsx", + "syntaxKind": "PropertySignature", + "name": "hasPrevious", + "value": "boolean", + "description": "Whether there is a previous page to show", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Pagination/Pagination.tsx", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "Accessible label for the pagination", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Pagination/Pagination.tsx", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabels", + "value": "AccessibilityLabels", + "description": "Accessible labels for the buttons and UnstyledLinks", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Pagination/Pagination.tsx", + "syntaxKind": "MethodSignature", + "name": "onNext", + "value": "() => void", + "description": "Callback when next button is clicked", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Pagination/Pagination.tsx", + "syntaxKind": "MethodSignature", + "name": "onPrevious", + "value": "() => void", + "description": "Callback when previous button is clicked", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Pagination/Pagination.tsx", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "React.ReactNode", + "description": "Text to provide more context in between the arrow buttons", + "isOptional": true + } + ], + "value": "export interface PaginationProps {\n /** Keyboard shortcuts for the next button */\n nextKeys?: Key[];\n /** Keyboard shortcuts for the previous button */\n previousKeys?: Key[];\n /** Tooltip for the next button */\n nextTooltip?: string;\n /** Tooltip for the previous button */\n previousTooltip?: string;\n /** The URL of the next page */\n nextURL?: string;\n /** The URL of the previous page */\n previousURL?: string;\n /** Whether there is a next page to show */\n hasNext?: boolean;\n /** Whether there is a previous page to show */\n hasPrevious?: boolean;\n /** Accessible label for the pagination */\n accessibilityLabel?: string;\n /** Accessible labels for the buttons and UnstyledLinks */\n accessibilityLabels?: AccessibilityLabels;\n /** Callback when next button is clicked */\n onNext?(): void;\n /** Callback when previous button is clicked */\n onPrevious?(): void;\n /** Text to provide more context in between the arrow buttons */\n label?: React.ReactNode;\n}" + } + }, "PopoverProps": { "polaris-react/src/components/Popover/Popover.tsx": { "filePath": "polaris-react/src/components/Popover/Popover.tsx", @@ -17541,6 +17489,44 @@ "value": "export interface SettingToggleProps {\n /** Inner content of the card */\n children?: React.ReactNode;\n /** Card header actions */\n action?: ComplexAction;\n /** Sets toggle state to activated or deactivated */\n enabled?: boolean;\n}" } }, + "SkeletonBodyTextProps": { + "polaris-react/src/components/SkeletonBodyText/SkeletonBodyText.tsx": { + "filePath": "polaris-react/src/components/SkeletonBodyText/SkeletonBodyText.tsx", + "name": "SkeletonBodyTextProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/SkeletonBodyText/SkeletonBodyText.tsx", + "syntaxKind": "PropertySignature", + "name": "lines", + "value": "number", + "description": "Number of lines to display", + "isOptional": true, + "defaultValue": "3" + } + ], + "value": "export interface SkeletonBodyTextProps {\n /**\n * Number of lines to display\n * @default 3\n */\n lines?: number;\n}" + } + }, + "SkeletonDisplayTextProps": { + "polaris-react/src/components/SkeletonDisplayText/SkeletonDisplayText.tsx": { + "filePath": "polaris-react/src/components/SkeletonDisplayText/SkeletonDisplayText.tsx", + "name": "SkeletonDisplayTextProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/SkeletonDisplayText/SkeletonDisplayText.tsx", + "syntaxKind": "PropertySignature", + "name": "size", + "value": "Size", + "description": "Size of the text", + "isOptional": true, + "defaultValue": "'medium'" + } + ], + "value": "export interface SkeletonDisplayTextProps {\n /**\n * Size of the text\n * @default 'medium'\n */\n size?: Size;\n}" + } + }, "SheetProps": { "polaris-react/src/components/Sheet/Sheet.tsx": { "filePath": "polaris-react/src/components/Sheet/Sheet.tsx", @@ -17603,44 +17589,6 @@ "value": "export interface SheetProps {\n /** Whether or not the sheet is open */\n open: boolean;\n /** The child elements to render in the sheet */\n children: React.ReactNode;\n /** Callback when the backdrop is clicked or `ESC` is pressed */\n onClose(): void;\n /** Callback when the sheet has completed entering */\n onEntered?(): void;\n /** Callback when the sheet has started to exit */\n onExit?(): void;\n /** ARIA label for sheet */\n accessibilityLabel: string;\n /** The element or the RefObject that activates the Sheet */\n activator?: React.RefObject | React.ReactElement;\n}" } }, - "SkeletonBodyTextProps": { - "polaris-react/src/components/SkeletonBodyText/SkeletonBodyText.tsx": { - "filePath": "polaris-react/src/components/SkeletonBodyText/SkeletonBodyText.tsx", - "name": "SkeletonBodyTextProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/SkeletonBodyText/SkeletonBodyText.tsx", - "syntaxKind": "PropertySignature", - "name": "lines", - "value": "number", - "description": "Number of lines to display", - "isOptional": true, - "defaultValue": "3" - } - ], - "value": "export interface SkeletonBodyTextProps {\n /**\n * Number of lines to display\n * @default 3\n */\n lines?: number;\n}" - } - }, - "SkeletonDisplayTextProps": { - "polaris-react/src/components/SkeletonDisplayText/SkeletonDisplayText.tsx": { - "filePath": "polaris-react/src/components/SkeletonDisplayText/SkeletonDisplayText.tsx", - "name": "SkeletonDisplayTextProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/SkeletonDisplayText/SkeletonDisplayText.tsx", - "syntaxKind": "PropertySignature", - "name": "size", - "value": "Size", - "description": "Size of the text", - "isOptional": true, - "defaultValue": "'medium'" - } - ], - "value": "export interface SkeletonDisplayTextProps {\n /**\n * Size of the text\n * @default 'medium'\n */\n size?: Size;\n}" - } - }, "SkeletonPageProps": { "polaris-react/src/components/SkeletonPage/SkeletonPage.tsx": { "filePath": "polaris-react/src/components/SkeletonPage/SkeletonPage.tsx", @@ -17690,31 +17638,13 @@ { "filePath": "polaris-react/src/components/SkeletonPage/SkeletonPage.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "The child elements to render in the skeleton page.", - "isOptional": true - } - ], - "value": "export interface SkeletonPageProps {\n /** Page title, in large type */\n title?: string;\n /** Remove the normal max-width on the page */\n fullWidth?: boolean;\n /** Decreases the maximum layout width. Intended for single-column layouts */\n narrowWidth?: boolean;\n /** Shows a skeleton over the primary action */\n primaryAction?: boolean;\n /** Shows a skeleton over the breadcrumb */\n breadcrumbs?: boolean;\n /** The child elements to render in the skeleton page. */\n children?: React.ReactNode;\n}" - } - }, - "SkeletonTabsProps": { - "polaris-react/src/components/SkeletonTabs/SkeletonTabs.tsx": { - "filePath": "polaris-react/src/components/SkeletonTabs/SkeletonTabs.tsx", - "name": "SkeletonTabsProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/SkeletonTabs/SkeletonTabs.tsx", - "syntaxKind": "PropertySignature", - "name": "count", - "value": "number", - "description": "", + "name": "children", + "value": "React.ReactNode", + "description": "The child elements to render in the skeleton page.", "isOptional": true } ], - "value": "export interface SkeletonTabsProps {\n count?: number;\n}" + "value": "export interface SkeletonPageProps {\n /** Page title, in large type */\n title?: string;\n /** Remove the normal max-width on the page */\n fullWidth?: boolean;\n /** Decreases the maximum layout width. Intended for single-column layouts */\n narrowWidth?: boolean;\n /** Shows a skeleton over the primary action */\n primaryAction?: boolean;\n /** Shows a skeleton over the breadcrumb */\n breadcrumbs?: boolean;\n /** The child elements to render in the skeleton page. */\n children?: React.ReactNode;\n}" } }, "SkeletonThumbnailProps": { @@ -17736,6 +17666,24 @@ "value": "export interface SkeletonThumbnailProps {\n /**\n * Size of the thumbnail\n * @default 'medium'\n */\n size?: Size;\n}" } }, + "SkeletonTabsProps": { + "polaris-react/src/components/SkeletonTabs/SkeletonTabs.tsx": { + "filePath": "polaris-react/src/components/SkeletonTabs/SkeletonTabs.tsx", + "name": "SkeletonTabsProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/SkeletonTabs/SkeletonTabs.tsx", + "syntaxKind": "PropertySignature", + "name": "count", + "value": "number", + "description": "", + "isOptional": true + } + ], + "value": "export interface SkeletonTabsProps {\n count?: number;\n}" + } + }, "SpinnerProps": { "polaris-react/src/components/Spinner/Spinner.tsx": { "filePath": "polaris-react/src/components/Spinner/Spinner.tsx", @@ -22037,495 +21985,677 @@ "value": "export interface PortalsManager {\n container: PortalsContainerElement;\n}" } }, - "MeasuredActions": { - "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx": { - "filePath": "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx", - "name": "MeasuredActions", + "MenuGroupProps": { + "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx": { + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "name": "MenuGroupProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", "syntaxKind": "PropertySignature", - "name": "showable", - "value": "MenuActionDescriptor[]", - "description": "" + "name": "accessibilityLabel", + "value": "string", + "description": "Visually hidden menu description for screen readers", + "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", "syntaxKind": "PropertySignature", - "name": "rolledUp", - "value": "(MenuActionDescriptor | MenuGroupDescriptor)[]", - "description": "" + "name": "active", + "value": "boolean", + "description": "Whether or not the menu is open", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "MethodSignature", + "name": "onClick", + "value": "(openActions: () => void) => void", + "description": "Callback when the menu is clicked", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "MethodSignature", + "name": "onOpen", + "value": "(title: string) => void", + "description": "Callback for opening the MenuGroup by title" + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "MethodSignature", + "name": "onClose", + "value": "(title: string) => void", + "description": "Callback for closing the MenuGroup by title" + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "MethodSignature", + "name": "getOffsetWidth", + "value": "(width: number) => void", + "description": "Callback for getting the offsetWidth of the MenuGroup", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "sections", + "value": "readonly ActionListSection[]", + "description": "Collection of sectioned action items", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "Menu group title" + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "actions", + "value": "ActionListItemDescriptor[]", + "description": "List of actions" + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "icon", + "value": "any", + "description": "Icon to display", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "details", + "value": "React.ReactNode", + "description": "Action details", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Disables action button", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "index", + "value": "number", + "description": "Zero-indexed numerical position. Overrides the group's order in the menu.", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "onActionAnyItem", + "value": "() => void", + "description": "Callback when any action takes place", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "badge", + "value": "{ status: \"new\"; content: string; }", + "description": "", + "isOptional": true } ], - "value": "interface MeasuredActions {\n showable: MenuActionDescriptor[];\n rolledUp: (MenuActionDescriptor | MenuGroupDescriptor)[];\n}" + "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}" } }, - "MenuGroupProps": { - "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx": { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "name": "MenuGroupProps", + "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}" + } + }, + "ItemProps": { + "polaris-react/src/components/ActionList/components/Item/Item.tsx": { + "filePath": "polaris-react/src/components/ActionList/components/Item/Item.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "ItemProps", + "value": "ActionListItemDescriptor", + "description": "" + }, + "polaris-react/src/components/ButtonGroup/components/Item/Item.tsx": { + "filePath": "polaris-react/src/components/ButtonGroup/components/Item/Item.tsx", + "name": "ItemProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/ButtonGroup/components/Item/Item.tsx", + "syntaxKind": "PropertySignature", + "name": "button", + "value": "React.ReactElement", + "description": "" + } + ], + "value": "export interface ItemProps {\n button: React.ReactElement;\n}" + }, + "polaris-react/src/components/Connected/components/Item/Item.tsx": { + "filePath": "polaris-react/src/components/Connected/components/Item/Item.tsx", + "name": "ItemProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Connected/components/Item/Item.tsx", + "syntaxKind": "PropertySignature", + "name": "position", + "value": "ItemPosition", + "description": "Position of the item" + }, + { + "filePath": "polaris-react/src/components/Connected/components/Item/Item.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "Item content", + "isOptional": true + } + ], + "value": "export interface ItemProps {\n /** Position of the item */\n position: ItemPosition;\n /** Item content */\n children?: React.ReactNode;\n}" + }, + "polaris-react/src/components/FormLayout/components/Item/Item.tsx": { + "filePath": "polaris-react/src/components/FormLayout/components/Item/Item.tsx", + "name": "ItemProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/FormLayout/components/Item/Item.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "", + "isOptional": true + } + ], + "value": "export interface ItemProps {\n children?: React.ReactNode;\n}" + }, + "polaris-react/src/components/List/components/Item/Item.tsx": { + "filePath": "polaris-react/src/components/List/components/Item/Item.tsx", + "name": "ItemProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "filePath": "polaris-react/src/components/List/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "Visually hidden menu description for screen readers", + "name": "children", + "value": "React.ReactNode", + "description": "Content to display inside the item", "isOptional": true - }, + } + ], + "value": "export interface ItemProps {\n /** Content to display inside the item */\n children?: React.ReactNode;\n}" + }, + "polaris-react/src/components/Navigation/components/Item/Item.tsx": { + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "name": "ItemProps", + "description": "", + "members": [ { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "active", - "value": "boolean", - "description": "Whether or not the menu is open", + "name": "icon", + "value": "any", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "MethodSignature", - "name": "onClick", - "value": "(openActions: () => void) => void", - "description": "Callback when the menu is clicked", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "syntaxKind": "PropertySignature", + "name": "badge", + "value": "ReactNode", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "MethodSignature", - "name": "onOpen", - "value": "(title: string) => void", - "description": "Callback for opening the MenuGroup by title" - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "MethodSignature", - "name": "onClose", - "value": "(title: string) => void", - "description": "Callback for closing the MenuGroup by title" - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "MethodSignature", - "name": "getOffsetWidth", - "value": "(width: number) => void", - "description": "Callback for getting the offsetWidth of the MenuGroup", - "isOptional": true + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "string", + "description": "" }, { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "sections", - "value": "readonly ActionListSection[]", - "description": "Collection of sectioned action items", + "name": "disabled", + "value": "boolean", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "title", + "name": "accessibilityLabel", "value": "string", - "description": "Menu group title" + "description": "", + "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "actions", - "value": "ActionListItemDescriptor[]", - "description": "List of actions" + "name": "selected", + "value": "boolean", + "description": "", + "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "icon", - "value": "any", - "description": "Icon to display", + "name": "exactMatch", + "value": "boolean", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "details", - "value": "React.ReactNode", - "description": "Action details", + "name": "new", + "value": "boolean", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "Disables action button", + "name": "subNavigationItems", + "value": "SubNavigationItem[]", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "index", - "value": "number", - "description": "Zero-indexed numerical position. Overrides the group's order in the menu.", + "name": "secondaryAction", + "value": "SecondaryAction", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "PropertySignature", - "name": "onActionAnyItem", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "syntaxKind": "MethodSignature", + "name": "onClick", "value": "() => void", - "description": "Callback when any action takes place", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "PropertySignature", - "name": "badge", - "value": "{ status: \"new\"; content: string; }", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "syntaxKind": "MethodSignature", + "name": "onToggleExpandedState", + "value": "() => void", "description": "", "isOptional": true - } - ], - "value": "export interface MenuGroupProps extends MenuGroupDescriptor {\n /** Visually hidden menu description for screen readers */\n accessibilityLabel?: string;\n /** Whether or not the menu is open */\n active?: boolean;\n /** Callback when the menu is clicked */\n onClick?(openActions: () => void): void;\n /** Callback for opening the MenuGroup by title */\n onOpen(title: string): void;\n /** Callback for closing the MenuGroup by title */\n onClose(title: string): void;\n /** Callback for getting the offsetWidth of the MenuGroup */\n getOffsetWidth?(width: number): void;\n /** Collection of sectioned action items */\n sections?: readonly ActionListSection[];\n}" - } - }, - "RollupActionsProps": { - "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx": { - "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", - "name": "RollupActionsProps", - "description": "", - "members": [ + }, { - "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "Accessibilty label", + "name": "expanded", + "value": "boolean", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "items", - "value": "ActionListItemDescriptor[]", - "description": "Collection of actions for the list", + "name": "shouldResizeIcon", + "value": "boolean", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "sections", - "value": "ActionListSection[]", - "description": "Collection of sectioned action items", + "name": "url", + "value": "string", + "description": "", "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", - "name": "SecondaryAction", - "description": "", - "members": [ + }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "helpText", - "value": "React.ReactNode", + "name": "matches", + "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "MethodSignature", - "name": "onAction", - "value": "() => void", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "syntaxKind": "PropertySignature", + "name": "matchPaths", + "value": "string[]", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "MethodSignature", - "name": "getOffsetWidth", - "value": "(width: number) => void", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "syntaxKind": "PropertySignature", + "name": "excludePaths", + "value": "string[]", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "string | string[]", - "description": "The content to display inside the button", + "name": "external", + "value": "boolean", + "description": "", "isOptional": true - }, + } + ], + "value": "export interface ItemProps extends ItemURLDetails {\n icon?: IconProps['source'];\n badge?: ReactNode;\n label: string;\n disabled?: boolean;\n accessibilityLabel?: string;\n selected?: boolean;\n exactMatch?: boolean;\n new?: boolean;\n subNavigationItems?: SubNavigationItem[];\n secondaryAction?: SecondaryAction;\n onClick?(): void;\n onToggleExpandedState?(): void;\n expanded?: boolean;\n shouldResizeIcon?: boolean;\n}" + }, + "polaris-react/src/components/Stack/components/Item/Item.tsx": { + "filePath": "polaris-react/src/components/Stack/components/Item/Item.tsx", + "name": "ItemProps", + "description": "", + "members": [ { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Stack/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "primary", - "value": "boolean", - "description": "Provides extra visual weight and identifies the primary action in a set of buttons", + "name": "children", + "value": "React.ReactNode", + "description": "Elements to display inside item", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Stack/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "destructive", + "name": "fill", "value": "boolean", - "description": "Indicates a dangerous or potentially negative action", + "description": "Fill the remaining horizontal space in the stack with the item", "isOptional": true - }, + } + ], + "value": "export interface ItemProps {\n /** Elements to display inside item */\n children?: React.ReactNode;\n /** Fill the remaining horizontal space in the stack with the item */\n fill?: boolean;\n /**\n * @default false\n */\n}" + }, + "polaris-react/src/components/Tabs/components/Item/Item.tsx": { + "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", + "name": "ItemProps", + "description": "", + "members": [ { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "size", - "value": "\"medium\" | \"large\" | \"slim\"", - "description": "Changes the size of the button, giving it more or less padding", - "isOptional": true, - "defaultValue": "'medium'" + "name": "id", + "value": "string", + "description": "" }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "textAlign", - "value": "\"start\" | \"end\" | \"center\" | \"left\" | \"right\"", - "description": "Changes the inner text alignment of the button", - "isOptional": true + "name": "focused", + "value": "boolean", + "description": "" }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "outline", - "value": "boolean", - "description": "Gives the button a subtle alternative to the default button styling, appropriate for certain backdrops", + "name": "panelID", + "value": "string", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "fullWidth", - "value": "boolean", - "description": "Allows the button to grow to the width of its container", + "name": "children", + "value": "React.ReactNode", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "disclosure", - "value": "boolean | \"up\" | \"down\" | \"select\"", - "description": "Displays the button with a disclosure icon. Defaults to `down` when set to true", + "name": "url", + "value": "string", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "plain", - "value": "boolean", - "description": "Renders a button that looks like a link", + "name": "accessibilityLabel", + "value": "string", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "PropertySignature", - "name": "monochrome", - "value": "boolean", - "description": "Makes `plain` and `outline` Button colors (text, borders, icons) the same as the current text color. Also adds an underline to `plain` Buttons", + "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", + "syntaxKind": "MethodSignature", + "name": "onClick", + "value": "() => void", + "description": "", "isOptional": true - }, + } + ], + "value": "export interface ItemProps {\n id: string;\n focused: boolean;\n panelID?: string;\n children?: React.ReactNode;\n url?: string;\n accessibilityLabel?: string;\n onClick?(): void;\n}" + }, + "polaris-react/src/components/Filters/components/ConnectedFilterControl/components/Item/Item.tsx": { + "filePath": "polaris-react/src/components/Filters/components/ConnectedFilterControl/components/Item/Item.tsx", + "name": "ItemProps", + "description": "", + "members": [ { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Filters/components/ConnectedFilterControl/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "removeUnderline", - "value": "boolean", - "description": "Removes underline from button text (including on interaction) when `monochrome` and `plain` are true", + "name": "children", + "value": "React.ReactNode", + "description": "", "isOptional": true - }, + } + ], + "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/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx", "syntaxKind": "PropertySignature", - "name": "icon", - "value": "any", - "description": "Icon to display to the left of the button content", - "isOptional": true + "name": "showable", + "value": "MenuActionDescriptor[]", + "description": "" }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx", "syntaxKind": "PropertySignature", - "name": "connectedDisclosure", - "value": "ConnectedDisclosure", - "description": "Disclosure button connected right of the button. Toggles a popover action list.", - "isOptional": true - }, + "name": "rolledUp", + "value": "(MenuActionDescriptor | MenuGroupDescriptor)[]", + "description": "" + } + ], + "value": "interface MeasuredActions {\n showable: MenuActionDescriptor[];\n rolledUp: (MenuActionDescriptor | MenuGroupDescriptor)[];\n}" + } + }, + "MappedAction": { + "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx": { + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "name": "MappedAction", + "description": "", + "members": [ { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", "syntaxKind": "PropertySignature", - "name": "dataPrimaryLink", + "name": "wrapOverflow", "value": "boolean", - "description": "Indicates whether or not the button is the primary navigation link when rendered inside of an `IndexTable.Row`", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", "syntaxKind": "PropertySignature", - "name": "id", + "name": "accessibilityLabel", "value": "string", - "description": "A unique identifier for the button", + "description": "Visually hidden text for screen readers", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "A destination to link to, rendered in the href attribute of a link", - "isOptional": true + "name": "badge", + "value": "{ status: \"new\"; content: string; }", + "description": "", + "isOptional": true, + "deprecationMessage": "Badge component" }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", "syntaxKind": "PropertySignature", - "name": "external", - "value": "boolean", - "description": "Forces url to open in a new tab", + "name": "helpText", + "value": "React.ReactNode", + "description": "Additional hint text to display with item", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", "syntaxKind": "PropertySignature", - "name": "download", - "value": "string | boolean", - "description": "Tells the browser to download the url instead of opening it. Provides a hint for the downloaded filename if it is a string value", - "isOptional": true + "name": "icon", + "value": "any", + "description": "", + "isOptional": true, + "deprecationMessage": "Source of the icon" }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", "syntaxKind": "PropertySignature", - "name": "submit", - "value": "boolean", - "description": "Allows the button to submit a form", - "isOptional": true + "name": "image", + "value": "string", + "description": "", + "isOptional": true, + "deprecationMessage": "Image source" }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "Disables the button, disallowing merchant interaction", + "name": "prefix", + "value": "React.ReactNode", + "description": "Prefix source", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", "syntaxKind": "PropertySignature", - "name": "loading", - "value": "boolean", - "description": "Replaces button text with a spinner while a background action is being performed", + "name": "suffix", + "value": "React.ReactNode", + "description": "Suffix source", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", "syntaxKind": "PropertySignature", - "name": "pressed", + "name": "ellipsis", "value": "boolean", - "description": "Sets the button in a pressed state", + "description": "Add an ellipsis suffix to action content", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "Visually hidden text for screen readers", + "name": "active", + "value": "boolean", + "description": "Whether the action is active or not", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", "syntaxKind": "PropertySignature", "name": "role", "value": "string", - "description": "A valid WAI-ARIA role to define the semantic value of this element", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "PropertySignature", - "name": "ariaControls", - "value": "string", - "description": "Id of the element the button controls", + "description": "Defines a role for the action", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", "syntaxKind": "PropertySignature", - "name": "ariaExpanded", + "name": "disabled", "value": "boolean", - "description": "Tells screen reader the controlled element is expanded", + "description": "Whether or not the action is disabled", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", "syntaxKind": "PropertySignature", - "name": "ariaDescribedBy", + "name": "id", "value": "string", - "description": "Indicates the ID of the element that describes the button", + "description": "A unique identifier for the action", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", "syntaxKind": "PropertySignature", - "name": "ariaChecked", - "value": "\"false\" | \"true\"", - "description": "Indicates the current checked state of the button when acting as a toggle or switch", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "MethodSignature", - "name": "onClick", - "value": "() => void", - "description": "Callback when clicked", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "MethodSignature", - "name": "onFocus", - "value": "() => void", - "description": "Callback when button becomes focussed", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "MethodSignature", - "name": "onBlur", - "value": "() => void", - "description": "Callback when focus leaves button", + "name": "content", + "value": "string", + "description": "Content the action displays", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "MethodSignature", - "name": "onKeyPress", - "value": "(event: React.KeyboardEvent) => void", - "description": "Callback when a keypress event is registered on the button", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "syntaxKind": "PropertySignature", + "name": "url", + "value": "string", + "description": "A destination to link to, rendered in the action", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "MethodSignature", - "name": "onKeyUp", - "value": "(event: React.KeyboardEvent) => void", - "description": "Callback when a keyup event is registered on the button", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "syntaxKind": "PropertySignature", + "name": "external", + "value": "boolean", + "description": "Forces url to open in a new tab", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", "syntaxKind": "MethodSignature", - "name": "onKeyDown", - "value": "(event: React.KeyboardEvent) => void", - "description": "Callback when a keydown event is registered on the button", + "name": "onAction", + "value": "() => void", + "description": "Callback when an action takes place", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", "syntaxKind": "MethodSignature", "name": "onMouseEnter", "value": "() => void", @@ -22533,7 +22663,7 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", "syntaxKind": "MethodSignature", "name": "onTouchStart", "value": "() => void", @@ -22541,447 +22671,322 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "MethodSignature", - "name": "onPointerDown", - "value": "() => void", - "description": "Callback when pointerdown event is being triggered", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "syntaxKind": "PropertySignature", + "name": "destructive", + "value": "boolean", + "description": "Destructive action", "isOptional": true } ], - "value": "interface SecondaryAction extends ButtonProps {\n helpText?: React.ReactNode;\n onAction?(): void;\n getOffsetWidth?(width: number): void;\n}" - }, - "polaris-react/src/components/Navigation/components/Item/Item.tsx": { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "value": "interface MappedAction extends ActionListItemDescriptor {\n wrapOverflow?: boolean;\n}" + } + }, + "SecondaryAction": { + "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx": { + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "name": "SecondaryAction", "description": "", "members": [ { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "" - }, - { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "" - }, - { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "icon", - "value": "any", - "description": "" + "name": "helpText", + "value": "React.ReactNode", + "description": "", + "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "MethodSignature", - "name": "onClick", + "name": "onAction", "value": "() => void", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "syntaxKind": "PropertySignature", - "name": "tooltip", - "value": "TooltipProps", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "MethodSignature", + "name": "getOffsetWidth", + "value": "(width: number) => void", "description": "", "isOptional": true - } - ], - "value": "interface SecondaryAction {\n url: string;\n accessibilityLabel: string;\n icon: IconProps['source'];\n onClick?(): void;\n tooltip?: TooltipProps;\n}" - } - }, - "SectionProps": { - "polaris-react/src/components/ActionList/components/Section/Section.tsx": { - "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", - "name": "SectionProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "section", - "value": "ActionListSection", - "description": "Section of action items" - }, - { - "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "hasMultipleSections", - "value": "boolean", - "description": "Should there be multiple sections" - }, - { - "filePath": "polaris-react/src/components/ActionList/components/Section/Section.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/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "onActionAnyItem", - "value": "() => void", - "description": "Callback when any item is clicked or keypressed", - "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}" - }, - "polaris-react/src/components/Layout/components/Section/Section.tsx": { - "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", - "name": "SectionProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", "name": "children", - "value": "React.ReactNode", - "description": "", + "value": "string | string[]", + "description": "The content to display inside the button", "isOptional": true }, { - "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "secondary", + "name": "primary", "value": "boolean", - "description": "", + "description": "Provides extra visual weight and identifies the primary action in a set of buttons", "isOptional": true }, { - "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "fullWidth", + "name": "destructive", "value": "boolean", - "description": "", + "description": "Indicates a dangerous or potentially negative action", "isOptional": true }, { - "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "oneHalf", - "value": "boolean", - "description": "", - "isOptional": true + "name": "size", + "value": "\"medium\" | \"large\" | \"slim\"", + "description": "Changes the size of the button, giving it more or less padding", + "isOptional": true, + "defaultValue": "'medium'" }, { - "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "oneThird", - "value": "boolean", - "description": "", + "name": "textAlign", + "value": "\"start\" | \"end\" | \"center\" | \"left\" | \"right\"", + "description": "Changes the inner text alignment of the button", "isOptional": true - } - ], - "value": "export interface SectionProps {\n children?: React.ReactNode;\n secondary?: boolean;\n fullWidth?: boolean;\n oneHalf?: boolean;\n oneThird?: boolean;\n}" - }, - "polaris-react/src/components/Listbox/components/Section/Section.tsx": { - "filePath": "polaris-react/src/components/Listbox/components/Section/Section.tsx", - "name": "SectionProps", - "description": "", - "members": [ + }, { - "filePath": "polaris-react/src/components/Listbox/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "divider", + "name": "outline", "value": "boolean", - "description": "", + "description": "Gives the button a subtle alternative to the default button styling, appropriate for certain backdrops", "isOptional": true }, { - "filePath": "polaris-react/src/components/Listbox/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "ReactNode", - "description": "", + "name": "fullWidth", + "value": "boolean", + "description": "Allows the button to grow to the width of its container", "isOptional": true }, { - "filePath": "polaris-react/src/components/Listbox/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "ReactNode", - "description": "" - } - ], - "value": "interface SectionProps {\n divider?: boolean;\n children?: ReactNode;\n title: ReactNode;\n}" - }, - "polaris-react/src/components/Modal/components/Section/Section.tsx": { - "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", - "name": "SectionProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", + "name": "disclosure", + "value": "boolean | \"up\" | \"down\" | \"select\"", + "description": "Displays the button with a disclosure icon. Defaults to `down` when set to true", "isOptional": true }, { - "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "flush", + "name": "plain", "value": "boolean", - "description": "", + "description": "Renders a button that looks like a link", "isOptional": true }, { - "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "subdued", + "name": "monochrome", "value": "boolean", - "description": "", + "description": "Makes `plain` and `outline` Button colors (text, borders, icons) the same as the current text color. Also adds an underline to `plain` Buttons", "isOptional": true }, { - "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "titleHidden", + "name": "removeUnderline", "value": "boolean", - "description": "", + "description": "Removes underline from button text (including on interaction) when `monochrome` and `plain` are true", "isOptional": true - } - ], - "value": "export interface SectionProps {\n children?: React.ReactNode;\n flush?: boolean;\n subdued?: boolean;\n titleHidden?: boolean;\n}" - }, - "polaris-react/src/components/Navigation/components/Section/Section.tsx": { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", - "name": "SectionProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "items", - "value": "ItemProps[]", - "description": "" }, { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", "name": "icon", "value": "any", - "description": "", + "description": "Icon to display to the left of the button content", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "", + "name": "connectedDisclosure", + "value": "ConnectedDisclosure", + "description": "Disclosure button connected right of the button. Toggles a popover action list.", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "fill", + "name": "dataPrimaryLink", "value": "boolean", - "description": "", + "description": "Indicates whether or not the button is the primary navigation link when rendered inside of an `IndexTable.Row`", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "rollup", - "value": "{ after: number; view: string; hide: string; activePath: string; }", - "description": "", + "name": "id", + "value": "string", + "description": "A unique identifier for the button", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "action", - "value": "{ icon: any; accessibilityLabel: string; onClick(): void; tooltip?: TooltipProps; }", - "description": "", + "name": "url", + "value": "string", + "description": "A destination to link to, rendered in the href attribute of a link", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "separator", + "name": "external", "value": "boolean", - "description": "", + "description": "Forces url to open in a new tab", "isOptional": true - } - ], - "value": "export interface SectionProps {\n items: ItemProps[];\n icon?: IconProps['source'];\n title?: string;\n fill?: boolean;\n rollup?: {\n after: number;\n view: string;\n hide: string;\n activePath: string;\n };\n action?: {\n icon: IconProps['source'];\n accessibilityLabel: string;\n onClick(): void;\n tooltip?: TooltipProps;\n };\n separator?: boolean;\n}" - }, - "polaris-react/src/components/Popover/components/Section/Section.tsx": { - "filePath": "polaris-react/src/components/Popover/components/Section/Section.tsx", - "name": "SectionProps", - "description": "", - "members": [ + }, { - "filePath": "polaris-react/src/components/Popover/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", + "name": "download", + "value": "string | boolean", + "description": "Tells the browser to download the url instead of opening it. Provides a hint for the downloaded filename if it is a string value", "isOptional": true - } - ], - "value": "export interface SectionProps {\n children?: React.ReactNode;\n}" - } - }, - "MappedAction": { - "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx": { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", - "name": "MappedAction", - "description": "", - "members": [ + }, { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "wrapOverflow", + "name": "submit", "value": "boolean", - "description": "", + "description": "Allows the button to submit a form", "isOptional": true }, { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "Visually hidden text for screen readers", + "name": "disabled", + "value": "boolean", + "description": "Disables the button, disallowing merchant interaction", "isOptional": true }, { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", - "syntaxKind": "PropertySignature", - "name": "badge", - "value": "{ status: \"new\"; content: string; }", - "description": "", - "isOptional": true, - "deprecationMessage": "Badge component" - }, - { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "helpText", - "value": "React.ReactNode", - "description": "Additional hint text to display with item", + "name": "loading", + "value": "boolean", + "description": "Replaces button text with a spinner while a background action is being performed", "isOptional": true }, { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "icon", - "value": "any", - "description": "", - "isOptional": true, - "deprecationMessage": "Source of the icon" + "name": "pressed", + "value": "boolean", + "description": "Sets the button in a pressed state", + "isOptional": true }, { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "image", + "name": "accessibilityLabel", "value": "string", - "description": "", - "isOptional": true, - "deprecationMessage": "Image source" + "description": "Visually hidden text for screen readers", + "isOptional": true }, { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "prefix", - "value": "React.ReactNode", - "description": "Prefix source", + "name": "role", + "value": "string", + "description": "A valid WAI-ARIA role to define the semantic value of this element", "isOptional": true }, { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "suffix", - "value": "React.ReactNode", - "description": "Suffix source", + "name": "ariaControls", + "value": "string", + "description": "Id of the element the button controls", "isOptional": true }, { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "ellipsis", + "name": "ariaExpanded", "value": "boolean", - "description": "Add an ellipsis suffix to action content", + "description": "Tells screen reader the controlled element is expanded", "isOptional": true }, { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "active", - "value": "boolean", - "description": "Whether the action is active or not", + "name": "ariaDescribedBy", + "value": "string", + "description": "Indicates the ID of the element that describes the button", "isOptional": true }, { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "role", - "value": "string", - "description": "Defines a role for the action", + "name": "ariaChecked", + "value": "\"false\" | \"true\"", + "description": "Indicates the current checked state of the button when acting as a toggle or switch", "isOptional": true }, { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "Whether or not the action is disabled", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onClick", + "value": "() => void", + "description": "Callback when clicked", "isOptional": true }, { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the action", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onFocus", + "value": "() => void", + "description": "Callback when button becomes focussed", "isOptional": true }, { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", - "syntaxKind": "PropertySignature", - "name": "content", - "value": "string", - "description": "Content the action displays", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onBlur", + "value": "() => void", + "description": "Callback when focus leaves button", "isOptional": true }, { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "A destination to link to, rendered in the action", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onKeyPress", + "value": "(event: React.KeyboardEvent) => void", + "description": "Callback when a keypress event is registered on the button", "isOptional": true }, { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", - "syntaxKind": "PropertySignature", - "name": "external", - "value": "boolean", - "description": "Forces url to open in a new tab", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onKeyUp", + "value": "(event: React.KeyboardEvent) => void", + "description": "Callback when a keyup event is registered on the button", "isOptional": true }, { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "MethodSignature", - "name": "onAction", - "value": "() => void", - "description": "Callback when an action takes place", + "name": "onKeyDown", + "value": "(event: React.KeyboardEvent) => void", + "description": "Callback when a keydown event is registered on the button", "isOptional": true }, { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "MethodSignature", "name": "onMouseEnter", "value": "() => void", @@ -22989,7 +22994,7 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "MethodSignature", "name": "onTouchStart", "value": "() => void", @@ -22997,407 +23002,437 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", - "syntaxKind": "PropertySignature", - "name": "destructive", - "value": "boolean", - "description": "Destructive action", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onPointerDown", + "value": "() => void", + "description": "Callback when pointerdown event is being triggered", "isOptional": true } ], - "value": "interface MappedAction extends ActionListItemDescriptor {\n wrapOverflow?: boolean;\n}" - } - }, - "PipProps": { - "polaris-react/src/components/Badge/components/Pip/Pip.tsx": { - "filePath": "polaris-react/src/components/Badge/components/Pip/Pip.tsx", - "name": "PipProps", + "value": "interface SecondaryAction extends ButtonProps {\n helpText?: React.ReactNode;\n onAction?(): void;\n getOffsetWidth?(width: number): void;\n}" + }, + "polaris-react/src/components/Navigation/components/Item/Item.tsx": { + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "name": "SecondaryAction", "description": "", "members": [ { - "filePath": "polaris-react/src/components/Badge/components/Pip/Pip.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "status", - "value": "Status", - "description": "", - "isOptional": true + "name": "url", + "value": "string", + "description": "" }, { - "filePath": "polaris-react/src/components/Badge/components/Pip/Pip.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "progress", - "value": "Progress", + "name": "accessibilityLabel", + "value": "string", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "syntaxKind": "PropertySignature", + "name": "icon", + "value": "any", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "syntaxKind": "MethodSignature", + "name": "onClick", + "value": "() => void", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Badge/components/Pip/Pip.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "accessibilityLabelOverride", - "value": "string", + "name": "tooltip", + "value": "TooltipProps", "description": "", "isOptional": true } ], - "value": "export interface PipProps {\n status?: Status;\n progress?: Progress;\n accessibilityLabelOverride?: string;\n}" - } - }, - "MappedOption": { - "polaris-react/src/components/Autocomplete/components/MappedOption/MappedOption.tsx": { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedOption/MappedOption.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "MappedOption", - "value": "ArrayElement & {\n selected: boolean;\n singleSelection: boolean;\n}", - "description": "" - } - }, - "BulkActionButtonProps": { - "polaris-react/src/components/BulkActions/components/BulkActionButton/BulkActionButton.tsx": { - "filePath": "polaris-react/src/components/BulkActions/components/BulkActionButton/BulkActionButton.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "BulkActionButtonProps", - "value": "{\n disclosure?: boolean;\n indicator?: boolean;\n handleMeasurement?(width: number): void;\n} & DisableableAction", - "description": "" + "value": "interface SecondaryAction {\n url: string;\n accessibilityLabel: string;\n icon: IconProps['source'];\n onClick?(): void;\n tooltip?: TooltipProps;\n}" } }, - "ItemProps": { - "polaris-react/src/components/ActionList/components/Item/Item.tsx": { - "filePath": "polaris-react/src/components/ActionList/components/Item/Item.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "ItemProps", - "value": "ActionListItemDescriptor", - "description": "" - }, - "polaris-react/src/components/ButtonGroup/components/Item/Item.tsx": { - "filePath": "polaris-react/src/components/ButtonGroup/components/Item/Item.tsx", - "name": "ItemProps", + "SectionProps": { + "polaris-react/src/components/ActionList/components/Section/Section.tsx": { + "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", + "name": "SectionProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/ButtonGroup/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "button", - "value": "React.ReactElement", - "description": "" - } - ], - "value": "export interface ItemProps {\n button: React.ReactElement;\n}" - }, - "polaris-react/src/components/Connected/components/Item/Item.tsx": { - "filePath": "polaris-react/src/components/Connected/components/Item/Item.tsx", - "name": "ItemProps", - "description": "", - "members": [ + "name": "section", + "value": "ActionListSection", + "description": "Section of action items" + }, { - "filePath": "polaris-react/src/components/Connected/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "position", - "value": "ItemPosition", - "description": "Position of the item" + "name": "hasMultipleSections", + "value": "boolean", + "description": "Should there be multiple sections" }, { - "filePath": "polaris-react/src/components/Connected/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "Item content", + "name": "actionRole", + "value": "string", + "description": "Defines a specific role attribute for each action in the list", "isOptional": true - } - ], - "value": "export interface ItemProps {\n /** Position of the item */\n position: ItemPosition;\n /** Item content */\n children?: React.ReactNode;\n}" - }, - "polaris-react/src/components/FormLayout/components/Item/Item.tsx": { - "filePath": "polaris-react/src/components/FormLayout/components/Item/Item.tsx", - "name": "ItemProps", - "description": "", - "members": [ + }, { - "filePath": "polaris-react/src/components/FormLayout/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", + "name": "onActionAnyItem", + "value": "() => void", + "description": "Callback when any item is clicked or keypressed", "isOptional": true } ], - "value": "export interface ItemProps {\n children?: React.ReactNode;\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}" }, - "polaris-react/src/components/List/components/Item/Item.tsx": { - "filePath": "polaris-react/src/components/List/components/Item/Item.tsx", - "name": "ItemProps", + "polaris-react/src/components/Layout/components/Section/Section.tsx": { + "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", + "name": "SectionProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/List/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", "syntaxKind": "PropertySignature", "name": "children", "value": "React.ReactNode", - "description": "Content to display inside the item", - "isOptional": true - } - ], - "value": "export interface ItemProps {\n /** Content to display inside the item */\n children?: React.ReactNode;\n}" - }, - "polaris-react/src/components/Navigation/components/Item/Item.tsx": { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "name": "ItemProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "syntaxKind": "PropertySignature", - "name": "icon", - "value": "any", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "badge", - "value": "ReactNode", + "name": "secondary", + "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "syntaxKind": "PropertySignature", - "name": "label", - "value": "string", - "description": "" - }, - { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "disabled", + "name": "fullWidth", "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", + "name": "oneHalf", + "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "selected", + "name": "oneThird", "value": "boolean", "description": "", "isOptional": true - }, + } + ], + "value": "export interface SectionProps {\n children?: React.ReactNode;\n secondary?: boolean;\n fullWidth?: boolean;\n oneHalf?: boolean;\n oneThird?: boolean;\n}" + }, + "polaris-react/src/components/Listbox/components/Section/Section.tsx": { + "filePath": "polaris-react/src/components/Listbox/components/Section/Section.tsx", + "name": "SectionProps", + "description": "", + "members": [ { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Listbox/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "exactMatch", + "name": "divider", "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Listbox/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "new", - "value": "boolean", + "name": "children", + "value": "ReactNode", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Listbox/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "subNavigationItems", - "value": "SubNavigationItem[]", - "description": "", - "isOptional": true - }, + "name": "title", + "value": "ReactNode", + "description": "" + } + ], + "value": "interface SectionProps {\n divider?: boolean;\n children?: ReactNode;\n title: ReactNode;\n}" + }, + "polaris-react/src/components/Modal/components/Section/Section.tsx": { + "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", + "name": "SectionProps", + "description": "", + "members": [ { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "secondaryAction", - "value": "SecondaryAction", + "name": "children", + "value": "React.ReactNode", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "syntaxKind": "MethodSignature", - "name": "onClick", - "value": "() => void", + "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "flush", + "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "syntaxKind": "MethodSignature", - "name": "onToggleExpandedState", - "value": "() => void", + "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "subdued", + "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "expanded", + "name": "titleHidden", "value": "boolean", "description": "", "isOptional": true + } + ], + "value": "export interface SectionProps {\n children?: React.ReactNode;\n flush?: boolean;\n subdued?: boolean;\n titleHidden?: boolean;\n}" + }, + "polaris-react/src/components/Navigation/components/Section/Section.tsx": { + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", + "name": "SectionProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "items", + "value": "ItemProps[]", + "description": "" }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "shouldResizeIcon", - "value": "boolean", + "name": "icon", + "value": "any", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "url", + "name": "title", "value": "string", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "matches", + "name": "fill", "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "matchPaths", - "value": "string[]", + "name": "rollup", + "value": "{ after: number; view: string; hide: string; activePath: string; }", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "excludePaths", - "value": "string[]", + "name": "action", + "value": "{ icon: any; accessibilityLabel: string; onClick(): void; tooltip?: TooltipProps; }", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "external", + "name": "separator", "value": "boolean", "description": "", "isOptional": true } ], - "value": "export interface ItemProps extends ItemURLDetails {\n icon?: IconProps['source'];\n badge?: ReactNode;\n label: string;\n disabled?: boolean;\n accessibilityLabel?: string;\n selected?: boolean;\n exactMatch?: boolean;\n new?: boolean;\n subNavigationItems?: SubNavigationItem[];\n secondaryAction?: SecondaryAction;\n onClick?(): void;\n onToggleExpandedState?(): void;\n expanded?: boolean;\n shouldResizeIcon?: boolean;\n}" + "value": "export interface SectionProps {\n items: ItemProps[];\n icon?: IconProps['source'];\n title?: string;\n fill?: boolean;\n rollup?: {\n after: number;\n view: string;\n hide: string;\n activePath: string;\n };\n action?: {\n icon: IconProps['source'];\n accessibilityLabel: string;\n onClick(): void;\n tooltip?: TooltipProps;\n };\n separator?: boolean;\n}" }, - "polaris-react/src/components/Stack/components/Item/Item.tsx": { - "filePath": "polaris-react/src/components/Stack/components/Item/Item.tsx", - "name": "ItemProps", + "polaris-react/src/components/Popover/components/Section/Section.tsx": { + "filePath": "polaris-react/src/components/Popover/components/Section/Section.tsx", + "name": "SectionProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/Stack/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Popover/components/Section/Section.tsx", "syntaxKind": "PropertySignature", "name": "children", "value": "React.ReactNode", - "description": "Elements to display inside item", + "description": "", + "isOptional": true + } + ], + "value": "export interface SectionProps {\n children?: React.ReactNode;\n}" + } + }, + "MappedOption": { + "polaris-react/src/components/Autocomplete/components/MappedOption/MappedOption.tsx": { + "filePath": "polaris-react/src/components/Autocomplete/components/MappedOption/MappedOption.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "MappedOption", + "value": "ArrayElement & {\n selected: boolean;\n singleSelection: boolean;\n}", + "description": "" + } + }, + "PipProps": { + "polaris-react/src/components/Badge/components/Pip/Pip.tsx": { + "filePath": "polaris-react/src/components/Badge/components/Pip/Pip.tsx", + "name": "PipProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Badge/components/Pip/Pip.tsx", + "syntaxKind": "PropertySignature", + "name": "status", + "value": "Status", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Stack/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Badge/components/Pip/Pip.tsx", "syntaxKind": "PropertySignature", - "name": "fill", - "value": "boolean", - "description": "Fill the remaining horizontal space in the stack with the item", + "name": "progress", + "value": "Progress", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Badge/components/Pip/Pip.tsx", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabelOverride", + "value": "string", + "description": "", "isOptional": true } ], - "value": "export interface ItemProps {\n /** Elements to display inside item */\n children?: React.ReactNode;\n /** Fill the remaining horizontal space in the stack with the item */\n fill?: boolean;\n /**\n * @default false\n */\n}" - }, - "polaris-react/src/components/Tabs/components/Item/Item.tsx": { - "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", - "name": "ItemProps", + "value": "export interface PipProps {\n status?: Status;\n progress?: Progress;\n accessibilityLabelOverride?: string;\n}" + } + }, + "BulkActionButtonProps": { + "polaris-react/src/components/BulkActions/components/BulkActionButton/BulkActionButton.tsx": { + "filePath": "polaris-react/src/components/BulkActions/components/BulkActionButton/BulkActionButton.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "BulkActionButtonProps", + "value": "{\n disclosure?: boolean;\n indicator?: boolean;\n handleMeasurement?(width: number): void;\n} & DisableableAction", + "description": "" + } + }, + "BulkActionsMenuProps": { + "polaris-react/src/components/BulkActions/components/BulkActionMenu/BulkActionMenu.tsx": { + "filePath": "polaris-react/src/components/BulkActions/components/BulkActionMenu/BulkActionMenu.tsx", + "name": "BulkActionsMenuProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/BulkActions/components/BulkActionMenu/BulkActionMenu.tsx", "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", + "name": "isNewBadgeInBadgeActions", + "value": "boolean", "description": "" }, { - "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/BulkActions/components/BulkActionMenu/BulkActionMenu.tsx", "syntaxKind": "PropertySignature", - "name": "focused", - "value": "boolean", - "description": "" + "name": "title", + "value": "string", + "description": "Menu group title" }, { - "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/BulkActions/components/BulkActionMenu/BulkActionMenu.tsx", "syntaxKind": "PropertySignature", - "name": "panelID", - "value": "string", - "description": "", + "name": "actions", + "value": "ActionListItemDescriptor[]", + "description": "List of actions" + }, + { + "filePath": "polaris-react/src/components/BulkActions/components/BulkActionMenu/BulkActionMenu.tsx", + "syntaxKind": "PropertySignature", + "name": "icon", + "value": "any", + "description": "Icon to display", "isOptional": true }, { - "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/BulkActions/components/BulkActionMenu/BulkActionMenu.tsx", "syntaxKind": "PropertySignature", - "name": "children", + "name": "details", "value": "React.ReactNode", - "description": "", + "description": "Action details", "isOptional": true }, { - "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/BulkActions/components/BulkActionMenu/BulkActionMenu.tsx", "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "", + "name": "disabled", + "value": "boolean", + "description": "Disables action button", "isOptional": true }, { - "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/BulkActions/components/BulkActionMenu/BulkActionMenu.tsx", "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "", + "name": "index", + "value": "number", + "description": "Zero-indexed numerical position. Overrides the group's order in the menu.", "isOptional": true }, { - "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/BulkActions/components/BulkActionMenu/BulkActionMenu.tsx", + "syntaxKind": "PropertySignature", + "name": "onActionAnyItem", + "value": "() => void", + "description": "Callback when any action takes place", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/BulkActions/components/BulkActionMenu/BulkActionMenu.tsx", "syntaxKind": "MethodSignature", "name": "onClick", - "value": "() => void", - "description": "", + "value": "(openActions: () => void) => void", + "description": "Callback when the menu is clicked", "isOptional": true - } - ], - "value": "export interface ItemProps {\n id: string;\n focused: boolean;\n panelID?: string;\n children?: React.ReactNode;\n url?: string;\n accessibilityLabel?: string;\n onClick?(): void;\n}" - }, - "polaris-react/src/components/Filters/components/ConnectedFilterControl/components/Item/Item.tsx": { - "filePath": "polaris-react/src/components/Filters/components/ConnectedFilterControl/components/Item/Item.tsx", - "name": "ItemProps", - "description": "", - "members": [ + }, { - "filePath": "polaris-react/src/components/Filters/components/ConnectedFilterControl/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/BulkActions/components/BulkActionMenu/BulkActionMenu.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", + "name": "badge", + "value": "{ status: \"new\"; content: string; }", "description": "", "isOptional": true } ], - "value": "interface ItemProps {\n children?: React.ReactNode;\n}" + "value": "export interface BulkActionsMenuProps extends MenuGroupDescriptor {\n isNewBadgeInBadgeActions: boolean;\n}" } }, "CardHeaderProps": { @@ -23518,122 +23553,59 @@ "value": "export interface CardSubsectionProps {\n children?: React.ReactNode;\n}" } }, - "BulkActionsMenuProps": { - "polaris-react/src/components/BulkActions/components/BulkActionMenu/BulkActionMenu.tsx": { - "filePath": "polaris-react/src/components/BulkActions/components/BulkActionMenu/BulkActionMenu.tsx", - "name": "BulkActionsMenuProps", + "AlphaPickerProps": { + "polaris-react/src/components/ColorPicker/components/AlphaPicker/AlphaPicker.tsx": { + "filePath": "polaris-react/src/components/ColorPicker/components/AlphaPicker/AlphaPicker.tsx", + "name": "AlphaPickerProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/BulkActions/components/BulkActionMenu/BulkActionMenu.tsx", + "filePath": "polaris-react/src/components/ColorPicker/components/AlphaPicker/AlphaPicker.tsx", "syntaxKind": "PropertySignature", - "name": "isNewBadgeInBadgeActions", - "value": "boolean", + "name": "color", + "value": "HSBColor", "description": "" }, { - "filePath": "polaris-react/src/components/BulkActions/components/BulkActionMenu/BulkActionMenu.tsx", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "Menu group title" - }, - { - "filePath": "polaris-react/src/components/BulkActions/components/BulkActionMenu/BulkActionMenu.tsx", - "syntaxKind": "PropertySignature", - "name": "actions", - "value": "ActionListItemDescriptor[]", - "description": "List of actions" - }, - { - "filePath": "polaris-react/src/components/BulkActions/components/BulkActionMenu/BulkActionMenu.tsx", - "syntaxKind": "PropertySignature", - "name": "icon", - "value": "any", - "description": "Icon to display", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/BulkActions/components/BulkActionMenu/BulkActionMenu.tsx", - "syntaxKind": "PropertySignature", - "name": "details", - "value": "React.ReactNode", - "description": "Action details", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/BulkActions/components/BulkActionMenu/BulkActionMenu.tsx", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "Disables action button", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/BulkActions/components/BulkActionMenu/BulkActionMenu.tsx", + "filePath": "polaris-react/src/components/ColorPicker/components/AlphaPicker/AlphaPicker.tsx", "syntaxKind": "PropertySignature", - "name": "index", + "name": "alpha", "value": "number", - "description": "Zero-indexed numerical position. Overrides the group's order in the menu.", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/BulkActions/components/BulkActionMenu/BulkActionMenu.tsx", - "syntaxKind": "PropertySignature", - "name": "onActionAnyItem", - "value": "() => void", - "description": "Callback when any action takes place", - "isOptional": true + "description": "" }, { - "filePath": "polaris-react/src/components/BulkActions/components/BulkActionMenu/BulkActionMenu.tsx", + "filePath": "polaris-react/src/components/ColorPicker/components/AlphaPicker/AlphaPicker.tsx", "syntaxKind": "MethodSignature", - "name": "onClick", - "value": "(openActions: () => void) => void", - "description": "Callback when the menu is clicked", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/BulkActions/components/BulkActionMenu/BulkActionMenu.tsx", - "syntaxKind": "PropertySignature", - "name": "badge", - "value": "{ status: \"new\"; content: string; }", - "description": "", - "isOptional": true + "name": "onChange", + "value": "(hue: number) => void", + "description": "" } ], - "value": "export interface BulkActionsMenuProps extends MenuGroupDescriptor {\n isNewBadgeInBadgeActions: boolean;\n}" - } - }, - "AlphaPickerProps": { - "polaris-react/src/components/ColorPicker/components/AlphaPicker/AlphaPicker.tsx": { - "filePath": "polaris-react/src/components/ColorPicker/components/AlphaPicker/AlphaPicker.tsx", - "name": "AlphaPickerProps", + "value": "export interface AlphaPickerProps {\n color: HSBColor;\n alpha: number;\n onChange(hue: number): void;\n}" + } + }, + "HuePickerProps": { + "polaris-react/src/components/ColorPicker/components/HuePicker/HuePicker.tsx": { + "filePath": "polaris-react/src/components/ColorPicker/components/HuePicker/HuePicker.tsx", + "name": "HuePickerProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/ColorPicker/components/AlphaPicker/AlphaPicker.tsx", - "syntaxKind": "PropertySignature", - "name": "color", - "value": "HSBColor", - "description": "" - }, - { - "filePath": "polaris-react/src/components/ColorPicker/components/AlphaPicker/AlphaPicker.tsx", + "filePath": "polaris-react/src/components/ColorPicker/components/HuePicker/HuePicker.tsx", "syntaxKind": "PropertySignature", - "name": "alpha", + "name": "hue", "value": "number", "description": "" }, { - "filePath": "polaris-react/src/components/ColorPicker/components/AlphaPicker/AlphaPicker.tsx", + "filePath": "polaris-react/src/components/ColorPicker/components/HuePicker/HuePicker.tsx", "syntaxKind": "MethodSignature", "name": "onChange", "value": "(hue: number) => void", "description": "" } ], - "value": "export interface AlphaPickerProps {\n color: HSBColor;\n alpha: number;\n onChange(hue: number): void;\n}" + "value": "export interface HuePickerProps {\n hue: number;\n onChange(hue: number): void;\n}" } }, "Position": { @@ -23701,30 +23673,6 @@ "value": "export interface SlidableProps {\n draggerX?: number;\n draggerY?: number;\n onChange(position: Position): void;\n onDraggerHeight?(height: number): void;\n}" } }, - "HuePickerProps": { - "polaris-react/src/components/ColorPicker/components/HuePicker/HuePicker.tsx": { - "filePath": "polaris-react/src/components/ColorPicker/components/HuePicker/HuePicker.tsx", - "name": "HuePickerProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/ColorPicker/components/HuePicker/HuePicker.tsx", - "syntaxKind": "PropertySignature", - "name": "hue", - "value": "number", - "description": "" - }, - { - "filePath": "polaris-react/src/components/ColorPicker/components/HuePicker/HuePicker.tsx", - "syntaxKind": "MethodSignature", - "name": "onChange", - "value": "(hue: number) => void", - "description": "" - } - ], - "value": "export interface HuePickerProps {\n hue: number;\n onChange(hue: number): void;\n}" - } - }, "ItemPosition": { "polaris-react/src/components/Connected/components/Item/Item.tsx": { "filePath": "polaris-react/src/components/Connected/components/Item/Item.tsx", @@ -23734,302 +23682,168 @@ "description": "" } }, - "CellProps": { - "polaris-react/src/components/DataTable/components/Cell/Cell.tsx": { - "filePath": "polaris-react/src/components/DataTable/components/Cell/Cell.tsx", - "name": "CellProps", + "FileUploadProps": { + "polaris-react/src/components/DropZone/components/FileUpload/FileUpload.tsx": { + "filePath": "polaris-react/src/components/DropZone/components/FileUpload/FileUpload.tsx", + "name": "FileUploadProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/DataTable/components/Cell/Cell.tsx", - "syntaxKind": "PropertySignature", - "name": "content", - "value": "React.ReactNode", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/DataTable/components/Cell/Cell.tsx", + "filePath": "polaris-react/src/components/DropZone/components/FileUpload/FileUpload.tsx", "syntaxKind": "PropertySignature", - "name": "contentType", + "name": "actionTitle", "value": "string", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/DataTable/components/Cell/Cell.tsx", - "syntaxKind": "PropertySignature", - "name": "nthColumn", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/DataTable/components/Cell/Cell.tsx", - "syntaxKind": "PropertySignature", - "name": "firstColumn", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/DataTable/components/Cell/Cell.tsx", - "syntaxKind": "PropertySignature", - "name": "truncate", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/DataTable/components/Cell/Cell.tsx", - "syntaxKind": "PropertySignature", - "name": "header", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/DataTable/components/Cell/Cell.tsx", + "filePath": "polaris-react/src/components/DropZone/components/FileUpload/FileUpload.tsx", "syntaxKind": "PropertySignature", - "name": "total", - "value": "boolean", + "name": "actionHint", + "value": "string", "description": "", "isOptional": true - }, + } + ], + "value": "export interface FileUploadProps {\n actionTitle?: string;\n actionHint?: string;\n}" + } + }, + "DayProps": { + "polaris-react/src/components/DatePicker/components/Day/Day.tsx": { + "filePath": "polaris-react/src/components/DatePicker/components/Day/Day.tsx", + "name": "DayProps", + "description": "", + "members": [ { - "filePath": "polaris-react/src/components/DataTable/components/Cell/Cell.tsx", + "filePath": "polaris-react/src/components/DatePicker/components/Day/Day.tsx", "syntaxKind": "PropertySignature", - "name": "totalInFooter", + "name": "focused", "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/DataTable/components/Cell/Cell.tsx", + "filePath": "polaris-react/src/components/DatePicker/components/Day/Day.tsx", "syntaxKind": "PropertySignature", - "name": "sorted", - "value": "boolean", + "name": "day", + "value": "Date", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/DataTable/components/Cell/Cell.tsx", + "filePath": "polaris-react/src/components/DatePicker/components/Day/Day.tsx", "syntaxKind": "PropertySignature", - "name": "sortable", + "name": "selected", "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/DataTable/components/Cell/Cell.tsx", - "syntaxKind": "PropertySignature", - "name": "sortDirection", - "value": "SortDirection", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/DataTable/components/Cell/Cell.tsx", - "syntaxKind": "PropertySignature", - "name": "defaultSortDirection", - "value": "SortDirection", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/DataTable/components/Cell/Cell.tsx", - "syntaxKind": "PropertySignature", - "name": "verticalAlign", - "value": "VerticalAlign", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/DataTable/components/Cell/Cell.tsx", - "syntaxKind": "MethodSignature", - "name": "onSort", - "value": "() => void", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/DataTable/components/Cell/Cell.tsx", - "syntaxKind": "PropertySignature", - "name": "colSpan", - "value": "number", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/DataTable/components/Cell/Cell.tsx", - "syntaxKind": "PropertySignature", - "name": "setRef", - "value": "(ref: HTMLTableCellElement) => void", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/DataTable/components/Cell/Cell.tsx", + "filePath": "polaris-react/src/components/DatePicker/components/Day/Day.tsx", "syntaxKind": "PropertySignature", - "name": "stickyHeadingCell", + "name": "inRange", "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/DataTable/components/Cell/Cell.tsx", - "syntaxKind": "PropertySignature", - "name": "stickyCellWidth", - "value": "number", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/DataTable/components/Cell/Cell.tsx", + "filePath": "polaris-react/src/components/DatePicker/components/Day/Day.tsx", "syntaxKind": "PropertySignature", - "name": "hovered", + "name": "inHoveringRange", "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/DataTable/components/Cell/Cell.tsx", - "syntaxKind": "PropertySignature", - "name": "handleFocus", - "value": "FocusEventHandler", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/DataTable/components/Cell/Cell.tsx", + "filePath": "polaris-react/src/components/DatePicker/components/Day/Day.tsx", "syntaxKind": "PropertySignature", - "name": "inFixedNthColumn", + "name": "disabled", "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/DataTable/components/Cell/Cell.tsx", + "filePath": "polaris-react/src/components/DatePicker/components/Day/Day.tsx", "syntaxKind": "PropertySignature", - "name": "hasFixedNthColumn", - "value": "boolean", + "name": "lastDayOfMonth", + "value": "any", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/DataTable/components/Cell/Cell.tsx", + "filePath": "polaris-react/src/components/DatePicker/components/Day/Day.tsx", "syntaxKind": "PropertySignature", - "name": "fixedCellVisible", + "name": "isLastSelectedDay", "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/DataTable/components/Cell/Cell.tsx", - "syntaxKind": "PropertySignature", - "name": "firstColumnMinWidth", - "value": "string", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/DataTable/components/Cell/Cell.tsx", - "syntaxKind": "PropertySignature", - "name": "style", - "value": "React.CSSProperties", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/DataTable/components/Cell/Cell.tsx", + "filePath": "polaris-react/src/components/DatePicker/components/Day/Day.tsx", "syntaxKind": "PropertySignature", - "name": "lastFixedFirstColumn", + "name": "isFirstSelectedDay", "value": "boolean", "description": "", "isOptional": true - } - ], - "value": "export interface CellProps {\n content?: React.ReactNode;\n contentType?: string;\n nthColumn?: boolean;\n firstColumn?: boolean;\n truncate?: boolean;\n header?: boolean;\n total?: boolean;\n totalInFooter?: boolean;\n sorted?: boolean;\n sortable?: boolean;\n sortDirection?: SortDirection;\n defaultSortDirection?: SortDirection;\n verticalAlign?: VerticalAlign;\n onSort?(): void;\n colSpan?: number;\n setRef?: (ref: HTMLTableCellElement | null) => void;\n stickyHeadingCell?: boolean;\n stickyCellWidth?: number;\n hovered?: boolean;\n handleFocus?: FocusEventHandler;\n inFixedNthColumn?: boolean;\n hasFixedNthColumn?: boolean;\n fixedCellVisible?: boolean;\n firstColumnMinWidth?: string;\n style?: React.CSSProperties;\n lastFixedFirstColumn?: boolean;\n}" - }, - "polaris-react/src/components/Grid/components/Cell/Cell.tsx": { - "filePath": "polaris-react/src/components/Grid/components/Cell/Cell.tsx", - "name": "CellProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Grid/components/Cell/Cell.tsx", - "syntaxKind": "PropertySignature", - "name": "area", - "value": "string", - "description": "", - "isOptional": true }, { - "filePath": "polaris-react/src/components/Grid/components/Cell/Cell.tsx", + "filePath": "polaris-react/src/components/DatePicker/components/Day/Day.tsx", "syntaxKind": "PropertySignature", - "name": "column", - "value": "Cell", + "name": "isHoveringRight", + "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Grid/components/Cell/Cell.tsx", + "filePath": "polaris-react/src/components/DatePicker/components/Day/Day.tsx", "syntaxKind": "PropertySignature", - "name": "columnSpan", - "value": "Columns", + "name": "rangeIsDifferent", + "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Grid/components/Cell/Cell.tsx", + "filePath": "polaris-react/src/components/DatePicker/components/Day/Day.tsx", "syntaxKind": "PropertySignature", - "name": "row", - "value": "Cell", + "name": "weekday", + "value": "string", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Grid/components/Cell/Cell.tsx", + "filePath": "polaris-react/src/components/DatePicker/components/Day/Day.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", + "name": "selectedAccessibilityLabelPrefix", + "value": "string", "description": "", "isOptional": true - } - ], - "value": "export interface CellProps {\n area?: string;\n column?: Cell;\n columnSpan?: Columns;\n row?: Cell;\n children?: React.ReactNode;\n}" - }, - "polaris-react/src/components/IndexTable/components/Cell/Cell.tsx": { - "filePath": "polaris-react/src/components/IndexTable/components/Cell/Cell.tsx", - "name": "CellProps", - "description": "", - "members": [ + }, { - "filePath": "polaris-react/src/components/IndexTable/components/Cell/Cell.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "ReactNode", + "filePath": "polaris-react/src/components/DatePicker/components/Day/Day.tsx", + "syntaxKind": "MethodSignature", + "name": "onClick", + "value": "(day: Date) => void", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/IndexTable/components/Cell/Cell.tsx", - "syntaxKind": "PropertySignature", - "name": "className", - "value": "string", + "filePath": "polaris-react/src/components/DatePicker/components/Day/Day.tsx", + "syntaxKind": "MethodSignature", + "name": "onHover", + "value": "(day?: Date) => void", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/IndexTable/components/Cell/Cell.tsx", - "syntaxKind": "PropertySignature", - "name": "flush", - "value": "boolean", + "filePath": "polaris-react/src/components/DatePicker/components/Day/Day.tsx", + "syntaxKind": "MethodSignature", + "name": "onFocus", + "value": "(day: Date) => void", "description": "", "isOptional": true } ], - "value": "export interface CellProps {\n children?: ReactNode;\n className?: string;\n flush?: boolean;\n}" + "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}" } }, "MonthProps": { @@ -24150,199 +23964,333 @@ "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}" } }, - "DayProps": { - "polaris-react/src/components/DatePicker/components/Day/Day.tsx": { - "filePath": "polaris-react/src/components/DatePicker/components/Day/Day.tsx", - "name": "DayProps", + "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/Day/Day.tsx", + "filePath": "polaris-react/src/components/DatePicker/components/Weekday/Weekday.tsx", "syntaxKind": "PropertySignature", - "name": "focused", + "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}" + } + }, + "CellProps": { + "polaris-react/src/components/DataTable/components/Cell/Cell.tsx": { + "filePath": "polaris-react/src/components/DataTable/components/Cell/Cell.tsx", + "name": "CellProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/DataTable/components/Cell/Cell.tsx", + "syntaxKind": "PropertySignature", + "name": "content", + "value": "React.ReactNode", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/DatePicker/components/Day/Day.tsx", + "filePath": "polaris-react/src/components/DataTable/components/Cell/Cell.tsx", "syntaxKind": "PropertySignature", - "name": "day", - "value": "Date", + "name": "contentType", + "value": "string", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/DatePicker/components/Day/Day.tsx", + "filePath": "polaris-react/src/components/DataTable/components/Cell/Cell.tsx", "syntaxKind": "PropertySignature", - "name": "selected", + "name": "nthColumn", "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/DatePicker/components/Day/Day.tsx", + "filePath": "polaris-react/src/components/DataTable/components/Cell/Cell.tsx", "syntaxKind": "PropertySignature", - "name": "inRange", + "name": "firstColumn", "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/DatePicker/components/Day/Day.tsx", + "filePath": "polaris-react/src/components/DataTable/components/Cell/Cell.tsx", "syntaxKind": "PropertySignature", - "name": "inHoveringRange", + "name": "truncate", "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/DatePicker/components/Day/Day.tsx", + "filePath": "polaris-react/src/components/DataTable/components/Cell/Cell.tsx", "syntaxKind": "PropertySignature", - "name": "disabled", + "name": "header", "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/DatePicker/components/Day/Day.tsx", + "filePath": "polaris-react/src/components/DataTable/components/Cell/Cell.tsx", "syntaxKind": "PropertySignature", - "name": "lastDayOfMonth", - "value": "any", + "name": "total", + "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/DatePicker/components/Day/Day.tsx", + "filePath": "polaris-react/src/components/DataTable/components/Cell/Cell.tsx", "syntaxKind": "PropertySignature", - "name": "isLastSelectedDay", + "name": "totalInFooter", "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/DatePicker/components/Day/Day.tsx", + "filePath": "polaris-react/src/components/DataTable/components/Cell/Cell.tsx", "syntaxKind": "PropertySignature", - "name": "isFirstSelectedDay", + "name": "sorted", "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/DatePicker/components/Day/Day.tsx", + "filePath": "polaris-react/src/components/DataTable/components/Cell/Cell.tsx", + "syntaxKind": "PropertySignature", + "name": "sortable", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/DataTable/components/Cell/Cell.tsx", + "syntaxKind": "PropertySignature", + "name": "sortDirection", + "value": "SortDirection", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/DataTable/components/Cell/Cell.tsx", + "syntaxKind": "PropertySignature", + "name": "defaultSortDirection", + "value": "SortDirection", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/DataTable/components/Cell/Cell.tsx", + "syntaxKind": "PropertySignature", + "name": "verticalAlign", + "value": "VerticalAlign", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/DataTable/components/Cell/Cell.tsx", + "syntaxKind": "MethodSignature", + "name": "onSort", + "value": "() => void", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/DataTable/components/Cell/Cell.tsx", + "syntaxKind": "PropertySignature", + "name": "colSpan", + "value": "number", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/DataTable/components/Cell/Cell.tsx", + "syntaxKind": "PropertySignature", + "name": "setRef", + "value": "(ref: HTMLTableCellElement) => void", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/DataTable/components/Cell/Cell.tsx", + "syntaxKind": "PropertySignature", + "name": "stickyHeadingCell", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/DataTable/components/Cell/Cell.tsx", + "syntaxKind": "PropertySignature", + "name": "stickyCellWidth", + "value": "number", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/DataTable/components/Cell/Cell.tsx", + "syntaxKind": "PropertySignature", + "name": "hovered", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/DataTable/components/Cell/Cell.tsx", + "syntaxKind": "PropertySignature", + "name": "handleFocus", + "value": "FocusEventHandler", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/DataTable/components/Cell/Cell.tsx", + "syntaxKind": "PropertySignature", + "name": "inFixedNthColumn", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/DataTable/components/Cell/Cell.tsx", + "syntaxKind": "PropertySignature", + "name": "hasFixedNthColumn", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/DataTable/components/Cell/Cell.tsx", + "syntaxKind": "PropertySignature", + "name": "fixedCellVisible", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/DataTable/components/Cell/Cell.tsx", + "syntaxKind": "PropertySignature", + "name": "firstColumnMinWidth", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/DataTable/components/Cell/Cell.tsx", "syntaxKind": "PropertySignature", - "name": "isHoveringRight", - "value": "boolean", + "name": "style", + "value": "React.CSSProperties", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/DatePicker/components/Day/Day.tsx", + "filePath": "polaris-react/src/components/DataTable/components/Cell/Cell.tsx", "syntaxKind": "PropertySignature", - "name": "rangeIsDifferent", + "name": "lastFixedFirstColumn", "value": "boolean", "description": "", "isOptional": true - }, + } + ], + "value": "export interface CellProps {\n content?: React.ReactNode;\n contentType?: string;\n nthColumn?: boolean;\n firstColumn?: boolean;\n truncate?: boolean;\n header?: boolean;\n total?: boolean;\n totalInFooter?: boolean;\n sorted?: boolean;\n sortable?: boolean;\n sortDirection?: SortDirection;\n defaultSortDirection?: SortDirection;\n verticalAlign?: VerticalAlign;\n onSort?(): void;\n colSpan?: number;\n setRef?: (ref: HTMLTableCellElement | null) => void;\n stickyHeadingCell?: boolean;\n stickyCellWidth?: number;\n hovered?: boolean;\n handleFocus?: FocusEventHandler;\n inFixedNthColumn?: boolean;\n hasFixedNthColumn?: boolean;\n fixedCellVisible?: boolean;\n firstColumnMinWidth?: string;\n style?: React.CSSProperties;\n lastFixedFirstColumn?: boolean;\n}" + }, + "polaris-react/src/components/Grid/components/Cell/Cell.tsx": { + "filePath": "polaris-react/src/components/Grid/components/Cell/Cell.tsx", + "name": "CellProps", + "description": "", + "members": [ { - "filePath": "polaris-react/src/components/DatePicker/components/Day/Day.tsx", + "filePath": "polaris-react/src/components/Grid/components/Cell/Cell.tsx", "syntaxKind": "PropertySignature", - "name": "weekday", + "name": "area", "value": "string", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/DatePicker/components/Day/Day.tsx", + "filePath": "polaris-react/src/components/Grid/components/Cell/Cell.tsx", "syntaxKind": "PropertySignature", - "name": "selectedAccessibilityLabelPrefix", - "value": "string", + "name": "column", + "value": "Cell", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/DatePicker/components/Day/Day.tsx", - "syntaxKind": "MethodSignature", - "name": "onClick", - "value": "(day: Date) => void", + "filePath": "polaris-react/src/components/Grid/components/Cell/Cell.tsx", + "syntaxKind": "PropertySignature", + "name": "columnSpan", + "value": "Columns", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/DatePicker/components/Day/Day.tsx", - "syntaxKind": "MethodSignature", - "name": "onHover", - "value": "(day?: Date) => void", + "filePath": "polaris-react/src/components/Grid/components/Cell/Cell.tsx", + "syntaxKind": "PropertySignature", + "name": "row", + "value": "Cell", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/DatePicker/components/Day/Day.tsx", - "syntaxKind": "MethodSignature", - "name": "onFocus", - "value": "(day: Date) => void", + "filePath": "polaris-react/src/components/Grid/components/Cell/Cell.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", "description": "", "isOptional": true } ], - "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", + "value": "export interface CellProps {\n area?: string;\n column?: Cell;\n columnSpan?: Columns;\n row?: Cell;\n children?: React.ReactNode;\n}" + }, + "polaris-react/src/components/IndexTable/components/Cell/Cell.tsx": { + "filePath": "polaris-react/src/components/IndexTable/components/Cell/Cell.tsx", + "name": "CellProps", "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", + "filePath": "polaris-react/src/components/IndexTable/components/Cell/Cell.tsx", "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "" + "name": "children", + "value": "ReactNode", + "description": "", + "isOptional": true }, { - "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", - "name": "FileUploadProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/DropZone/components/FileUpload/FileUpload.tsx", + "filePath": "polaris-react/src/components/IndexTable/components/Cell/Cell.tsx", "syntaxKind": "PropertySignature", - "name": "actionTitle", + "name": "className", "value": "string", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/DropZone/components/FileUpload/FileUpload.tsx", + "filePath": "polaris-react/src/components/IndexTable/components/Cell/Cell.tsx", "syntaxKind": "PropertySignature", - "name": "actionHint", - "value": "string", + "name": "flush", + "value": "boolean", "description": "", "isOptional": true } ], - "value": "export interface FileUploadProps {\n actionTitle?: string;\n actionHint?: string;\n}" + "value": "export interface CellProps {\n children?: ReactNode;\n className?: string;\n flush?: boolean;\n}" } }, "PopoverableAction": { @@ -24659,37 +24607,6 @@ "value": "interface CheckboxWrapperProps {\n children: ReactNode;\n}" } }, - "ScrollContainerProps": { - "polaris-react/src/components/IndexTable/components/ScrollContainer/ScrollContainer.tsx": { - "filePath": "polaris-react/src/components/IndexTable/components/ScrollContainer/ScrollContainer.tsx", - "name": "ScrollContainerProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/IndexTable/components/ScrollContainer/ScrollContainer.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "" - }, - { - "filePath": "polaris-react/src/components/IndexTable/components/ScrollContainer/ScrollContainer.tsx", - "syntaxKind": "PropertySignature", - "name": "scrollableContainerRef", - "value": "React.RefObject", - "description": "" - }, - { - "filePath": "polaris-react/src/components/IndexTable/components/ScrollContainer/ScrollContainer.tsx", - "syntaxKind": "MethodSignature", - "name": "onScroll", - "value": "(canScrollLeft: boolean, canScrollRight: boolean) => void", - "description": "" - } - ], - "value": "export interface ScrollContainerProps {\n children: React.ReactNode;\n scrollableContainerRef: React.RefObject;\n onScroll(canScrollLeft: boolean, canScrollRight: boolean): void;\n}" - } - }, "RowStatus": { "polaris-react/src/components/IndexTable/components/Row/Row.tsx": { "filePath": "polaris-react/src/components/IndexTable/components/Row/Row.tsx", @@ -24787,6 +24704,37 @@ "value": "export interface RowProps {\n children: React.ReactNode;\n id: string;\n selected?: boolean;\n position: number;\n subdued?: boolean;\n status?: RowStatus;\n disabled?: boolean;\n onNavigation?(id: string): void;\n onClick?(): void;\n}" } }, + "ScrollContainerProps": { + "polaris-react/src/components/IndexTable/components/ScrollContainer/ScrollContainer.tsx": { + "filePath": "polaris-react/src/components/IndexTable/components/ScrollContainer/ScrollContainer.tsx", + "name": "ScrollContainerProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/IndexTable/components/ScrollContainer/ScrollContainer.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "" + }, + { + "filePath": "polaris-react/src/components/IndexTable/components/ScrollContainer/ScrollContainer.tsx", + "syntaxKind": "PropertySignature", + "name": "scrollableContainerRef", + "value": "React.RefObject", + "description": "" + }, + { + "filePath": "polaris-react/src/components/IndexTable/components/ScrollContainer/ScrollContainer.tsx", + "syntaxKind": "MethodSignature", + "name": "onScroll", + "value": "(canScrollLeft: boolean, canScrollRight: boolean) => void", + "description": "" + } + ], + "value": "export interface ScrollContainerProps {\n children: React.ReactNode;\n scrollableContainerRef: React.RefObject;\n onScroll(canScrollLeft: boolean, canScrollRight: boolean): void;\n}" + } + }, "AnnotatedSectionProps": { "polaris-react/src/components/Layout/components/AnnotatedSection/AnnotatedSection.tsx": { "filePath": "polaris-react/src/components/Layout/components/AnnotatedSection/AnnotatedSection.tsx", @@ -26662,6 +26610,48 @@ "value": "export interface MenuProps {\n /** Accepts an activator component that renders inside of a button that opens the menu */\n activatorContent: React.ReactNode;\n /** An array of action objects that are rendered inside of a popover triggered by this menu */\n actions: ActionListProps['sections'];\n /** Accepts a message that facilitates direct, urgent communication with the merchant through the menu */\n message?: MessageProps;\n /** A boolean property indicating whether the menu is currently open */\n open: boolean;\n /** A callback function to handle opening the menu popover */\n onOpen(): void;\n /** A callback function to handle closing the menu popover */\n onClose(): void;\n /** A callback function to handle closing the menu popover */\n onClose(): void;\n /** A string that provides the accessibility labeling */\n accessibilityLabel?: string;\n}" } }, + "SearchProps": { + "polaris-react/src/components/TopBar/components/Search/Search.tsx": { + "filePath": "polaris-react/src/components/TopBar/components/Search/Search.tsx", + "name": "SearchProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/TopBar/components/Search/Search.tsx", + "syntaxKind": "PropertySignature", + "name": "visible", + "value": "boolean", + "description": "Toggles whether or not the search is visible", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/TopBar/components/Search/Search.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "The content to display inside the search", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/TopBar/components/Search/Search.tsx", + "syntaxKind": "PropertySignature", + "name": "overlayVisible", + "value": "boolean", + "description": "Whether or not the search results overlay has a visible backdrop", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/TopBar/components/Search/Search.tsx", + "syntaxKind": "MethodSignature", + "name": "onDismiss", + "value": "() => void", + "description": "Callback when the search is dismissed", + "isOptional": true + } + ], + "value": "export interface SearchProps {\n /** Toggles whether or not the search is visible */\n visible?: boolean;\n /** The content to display inside the search */\n children?: React.ReactNode;\n /** Whether or not the search results overlay has a visible backdrop */\n overlayVisible?: boolean;\n /** Callback when the search is dismissed */\n onDismiss?(): void;\n}" + } + }, "SearchFieldProps": { "polaris-react/src/components/TopBar/components/SearchField/SearchField.tsx": { "filePath": "polaris-react/src/components/TopBar/components/SearchField/SearchField.tsx", @@ -26819,48 +26809,6 @@ "value": "export interface UserMenuProps {\n /** An array of action objects that are rendered inside of a popover triggered by this menu */\n actions: {items: IconableAction[]}[];\n /** Accepts a message that facilitates direct, urgent communication with the merchant through the user menu */\n message?: MenuProps['message'];\n /** A string detailing the merchant’s full name to be displayed in the user menu */\n name: string;\n /** A string allowing further detail on the merchant’s name displayed in the user menu */\n detail?: string;\n /** A string that provides the accessibility labeling */\n accessibilityLabel?: string;\n /** The merchant’s initials, rendered in place of an avatar image when not provided */\n initials: AvatarProps['initials'];\n /** An avatar image representing the merchant */\n avatar?: AvatarProps['source'];\n /** A boolean property indicating whether the user menu is currently open */\n open: boolean;\n /** A callback function to handle opening and closing the user menu */\n onToggle(): void;\n}" } }, - "SearchProps": { - "polaris-react/src/components/TopBar/components/Search/Search.tsx": { - "filePath": "polaris-react/src/components/TopBar/components/Search/Search.tsx", - "name": "SearchProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/TopBar/components/Search/Search.tsx", - "syntaxKind": "PropertySignature", - "name": "visible", - "value": "boolean", - "description": "Toggles whether or not the search is visible", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/TopBar/components/Search/Search.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "The content to display inside the search", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/TopBar/components/Search/Search.tsx", - "syntaxKind": "PropertySignature", - "name": "overlayVisible", - "value": "boolean", - "description": "Whether or not the search results overlay has a visible backdrop", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/TopBar/components/Search/Search.tsx", - "syntaxKind": "MethodSignature", - "name": "onDismiss", - "value": "() => void", - "description": "Callback when the search is dismissed", - "isOptional": true - } - ], - "value": "export interface SearchProps {\n /** Toggles whether or not the search is visible */\n visible?: boolean;\n /** The content to display inside the search */\n children?: React.ReactNode;\n /** Whether or not the search results overlay has a visible backdrop */\n overlayVisible?: boolean;\n /** Callback when the search is dismissed */\n onDismiss?(): void;\n}" - } - }, "DiscardConfirmationModalProps": { "polaris-react/src/components/Frame/components/ContextualSaveBar/components/DiscardConfirmationModal/DiscardConfirmationModal.tsx": { "filePath": "polaris-react/src/components/Frame/components/ContextualSaveBar/components/DiscardConfirmationModal/DiscardConfirmationModal.tsx",