From 2cc93f7d42c7a01b6674cda34b8a35c133b2b6b6 Mon Sep 17 00:00:00 2001 From: aveline Date: Mon, 28 Nov 2022 11:52:25 -0800 Subject: [PATCH 1/8] Update `ActionList` `Sections` --- .../src/components/ActionList/ActionList.scss | 37 ++----------------- .../src/components/ActionList/ActionList.tsx | 1 + .../ActionList/components/Item/Item.tsx | 5 ++- .../ActionList/components/Section/Section.tsx | 28 ++++++++------ 4 files changed, 25 insertions(+), 46 deletions(-) diff --git a/polaris-react/src/components/ActionList/ActionList.scss b/polaris-react/src/components/ActionList/ActionList.scss index c0779e01dbe..5568031828a 100644 --- a/polaris-react/src/components/ActionList/ActionList.scss +++ b/polaris-react/src/components/ActionList/ActionList.scss @@ -7,35 +7,11 @@ padding: 0; } -.Section:not(:first-child) { - border-top: var(--p-border-divider); - - // stylelint-disable-next-line selector-max-class, selector-max-combinators, selector-max-specificity - > .Section-withoutTitle .Actions { - padding-top: var(--p-space-2); - } -} - -.Actions { - outline: none; - list-style: none; - margin: 0; - padding: var(--p-space-2); -} - -.ActionList, -.Section:first-child { +.ActionList { // stylelint-disable-next-line selector-max-class, selector-max-combinators, selector-max-specificity > .Section-withoutTitle .Actions { - border-top: none; - padding-top: var(--p-space-2); - } -} - -.ActionList .Section { - // stylelint-disable-next-line selector-max-class, selector-max-combinators - .Actions { - padding-top: 0; + // border-top: none; + // padding-top: var(--p-space-2); } } @@ -117,11 +93,6 @@ } } -.Content { - display: flex; - align-items: center; -} - .Prefix { @include recolor-icon(var(--p-icon)); display: flex; @@ -141,7 +112,7 @@ } .Suffix { - @include recolor-icon(var(--p-icon)); + // @include recolor-icon(var(--p-icon)); margin-left: var(--p-space-4); } diff --git a/polaris-react/src/components/ActionList/ActionList.tsx b/polaris-react/src/components/ActionList/ActionList.tsx index 233fe2ad650..193a51dcda4 100644 --- a/polaris-react/src/components/ActionList/ActionList.tsx +++ b/polaris-react/src/components/ActionList/ActionList.tsx @@ -57,6 +57,7 @@ export function ActionList({ hasMultipleSections={hasMultipleSections} actionRole={actionRole} onActionAnyItem={onActionAnyItem} + isFirst={index === 0} /> ) : null; }); diff --git a/polaris-react/src/components/ActionList/components/Item/Item.tsx b/polaris-react/src/components/ActionList/components/Item/Item.tsx index 46177c3c10b..82ce902693e 100644 --- a/polaris-react/src/components/ActionList/components/Item/Item.tsx +++ b/polaris-react/src/components/ActionList/components/Item/Item.tsx @@ -9,6 +9,7 @@ import {Badge} from '../../../Badge'; import {Text} from '../../../Text'; import styles from '../../ActionList.scss'; import {handleMouseUpByBlurring} from '../../../../utilities/focus'; +import {Inline} from '../../../Inline'; export type ItemProps = ActionListItemDescriptor; @@ -84,12 +85,12 @@ export function Item({ const textMarkup = {contentMarkup}; const contentElement = ( - + {prefixMarkup} {textMarkup} {badgeMarkup} {suffixMarkup} - + ); const scrollMarkup = active ? : null; diff --git a/polaris-react/src/components/ActionList/components/Section/Section.tsx b/polaris-react/src/components/ActionList/components/Section/Section.tsx index de76ad9d2c3..292f1fa63ae 100644 --- a/polaris-react/src/components/ActionList/components/Section/Section.tsx +++ b/polaris-react/src/components/ActionList/components/Section/Section.tsx @@ -7,7 +7,6 @@ import type { ActionListItemDescriptor, ActionListSection, } from '../../../../types'; -import styles from '../../ActionList.scss'; export interface SectionProps { /** Section of action items */ @@ -18,11 +17,13 @@ export interface SectionProps { actionRole?: 'option' | 'menuitem' | string; /** Callback when any item is clicked or keypressed */ onActionAnyItem?: ActionListItemDescriptor['onAction']; + isFirst?: boolean; } export function Section({ section, hasMultipleSections, + isFirst, actionRole, onActionAnyItem, }: SectionProps) { @@ -55,8 +56,6 @@ export function Section({ }, ); - const className = section.title ? undefined : styles['Section-withoutTitle']; - const titleMarkup = section.title ? ( + <> {titleMarkup} -
    {actionMarkup} -
- +
+ ); return hasMultipleSections ? ( -
  • + {sectionMarkup} -
  • + ) : ( sectionMarkup ); From f856c12b2c1848b36115cca66e9e1ea06b80a963 Mon Sep 17 00:00:00 2001 From: aveline Date: Mon, 28 Nov 2022 14:22:18 -0800 Subject: [PATCH 2/8] Refactor `ActionList` --- .../src/components/ActionList/ActionList.scss | 22 +------------------ .../src/components/ActionList/ActionList.tsx | 12 ++++------ .../ActionList/components/Item/Item.tsx | 7 +++--- 3 files changed, 9 insertions(+), 32 deletions(-) diff --git a/polaris-react/src/components/ActionList/ActionList.scss b/polaris-react/src/components/ActionList/ActionList.scss index 5568031828a..feb78810d64 100644 --- a/polaris-react/src/components/ActionList/ActionList.scss +++ b/polaris-react/src/components/ActionList/ActionList.scss @@ -1,20 +1,5 @@ @import '../../styles/common'; -.ActionList { - outline: none; - list-style: none; - margin: 0; - padding: 0; -} - -.ActionList { - // stylelint-disable-next-line selector-max-class, selector-max-combinators, selector-max-specificity - > .Section-withoutTitle .Actions { - // border-top: none; - // padding-top: var(--p-space-2); - } -} - .Item { --pc-action-list-image-size: 20px; --pc-action-list-item-min-height: var(--p-space-10); @@ -112,15 +97,10 @@ } .Suffix { - // @include recolor-icon(var(--p-icon)); + @include recolor-icon(var(--p-icon)); margin-left: var(--p-space-4); } -.ContentBlock, -.ContentBlockInner { - display: block; -} - .Text { @include layout-flex-fix; flex: 1 1 auto; diff --git a/polaris-react/src/components/ActionList/ActionList.tsx b/polaris-react/src/components/ActionList/ActionList.tsx index 193a51dcda4..7ec14e87b69 100644 --- a/polaris-react/src/components/ActionList/ActionList.tsx +++ b/polaris-react/src/components/ActionList/ActionList.tsx @@ -6,11 +6,10 @@ import { } from '../../utilities/focus'; import {KeypressListener} from '../KeypressListener'; import {ActionListItemDescriptor, ActionListSection, Key} from '../../types'; -import {classNames} from '../../utilities/css'; +import {Box} from '../Box'; import {Section, Item} from './components'; import type {ItemProps} from './components'; -import styles from './ActionList.scss'; export interface ActionListProps { /** Collection of actions for list */ @@ -40,10 +39,7 @@ export function ActionList({ finalSections = sections; } - const className = classNames(styles.ActionList); - const hasMultipleSections = finalSections.length > 1; - const Element = hasMultipleSections ? 'ul' : 'div'; const elementRole = hasMultipleSections && actionRole === 'menuitem' ? 'menu' : undefined; const elementTabIndex = @@ -103,15 +99,15 @@ export function ActionList({ ) : null; return ( - {listeners} {sectionMarkup} - + ); } diff --git a/polaris-react/src/components/ActionList/components/Item/Item.tsx b/polaris-react/src/components/ActionList/components/Item/Item.tsx index 82ce902693e..0f68016543d 100644 --- a/polaris-react/src/components/ActionList/components/Item/Item.tsx +++ b/polaris-react/src/components/ActionList/components/Item/Item.tsx @@ -10,6 +10,7 @@ import {Text} from '../../../Text'; import styles from '../../ActionList.scss'; import {handleMouseUpByBlurring} from '../../../../utilities/focus'; import {Inline} from '../../../Inline'; +import {Box} from '../../../Box'; export type ItemProps = ActionListItemDescriptor; @@ -62,12 +63,12 @@ export function Item({ const contentText = ellipsis && content ? `${content}…` : content; const contentMarkup = helpText ? ( - - {contentText} + <> + {contentText} {helpText} - + ) : ( contentText ); From 07d791dd8ab22d50e30195f96807cf6918f95685 Mon Sep 17 00:00:00 2001 From: aveline Date: Tue, 29 Nov 2022 07:54:53 -0800 Subject: [PATCH 3/8] Refactor `ActionList` --- polaris-react/src/components/ActionList/ActionList.scss | 1 - .../src/components/ActionList/components/Item/Item.tsx | 4 +++- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/polaris-react/src/components/ActionList/ActionList.scss b/polaris-react/src/components/ActionList/ActionList.scss index feb78810d64..35d367d8e66 100644 --- a/polaris-react/src/components/ActionList/ActionList.scss +++ b/polaris-react/src/components/ActionList/ActionList.scss @@ -98,7 +98,6 @@ .Suffix { @include recolor-icon(var(--p-icon)); - margin-left: var(--p-space-4); } .Text { diff --git a/polaris-react/src/components/ActionList/components/Item/Item.tsx b/polaris-react/src/components/ActionList/components/Item/Item.tsx index 0f68016543d..03957153ac4 100644 --- a/polaris-react/src/components/ActionList/components/Item/Item.tsx +++ b/polaris-react/src/components/ActionList/components/Item/Item.tsx @@ -80,7 +80,9 @@ export function Item({ ); const suffixMarkup = suffix && ( - {suffix} + + {suffix} + ); const textMarkup = {contentMarkup}; From 0217a0511030c2f1d2df0274a94504319b987818 Mon Sep 17 00:00:00 2001 From: aveline Date: Tue, 29 Nov 2022 08:44:46 -0800 Subject: [PATCH 4/8] Update sectionRole types --- .../src/components/ActionList/components/Section/Section.tsx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/polaris-react/src/components/ActionList/components/Section/Section.tsx b/polaris-react/src/components/ActionList/components/Section/Section.tsx index 292f1fa63ae..8731d02fc77 100644 --- a/polaris-react/src/components/ActionList/components/Section/Section.tsx +++ b/polaris-react/src/components/ActionList/components/Section/Section.tsx @@ -69,7 +69,7 @@ export function Section({ ) : null; - let sectionRole; + let sectionRole: 'menu' | 'presentation' | undefined; switch (actionRole) { case 'option': sectionRole = 'presentation'; From 0143ba9b81b36b3a7ca42f382fa3c8ae60352eb8 Mon Sep 17 00:00:00 2001 From: aveline Date: Tue, 29 Nov 2022 11:25:33 -0800 Subject: [PATCH 5/8] Update props.json --- polaris.shopify.com/src/data/props.json | 2450 ++++++++++++----------- 1 file changed, 1229 insertions(+), 1221 deletions(-) diff --git a/polaris.shopify.com/src/data/props.json b/polaris.shopify.com/src/data/props.json index 64d07ca17e4..d8f5a1eeaea 100644 --- a/polaris.shopify.com/src/data/props.json +++ b/polaris.shopify.com/src/data/props.json @@ -7722,153 +7722,6 @@ "description": "" } }, - "ActionMenuProps": { - "polaris-react/src/components/ActionMenu/ActionMenu.tsx": { - "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", - "name": "ActionMenuProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", - "syntaxKind": "PropertySignature", - "name": "actions", - "value": "MenuActionDescriptor[]", - "description": "Collection of page-level secondary actions", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", - "syntaxKind": "PropertySignature", - "name": "groups", - "value": "MenuGroupDescriptor[]", - "description": "Collection of page-level action groups", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", - "syntaxKind": "PropertySignature", - "name": "rollup", - "value": "boolean", - "description": "Roll up all actions into a Popover > ActionList", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", - "syntaxKind": "PropertySignature", - "name": "rollupActionsLabel", - "value": "string", - "description": "Label for rolled up actions activator", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", - "syntaxKind": "MethodSignature", - "name": "onActionRollup", - "value": "(hasRolledUp: boolean) => void", - "description": "Callback that returns true when secondary actions are rolled up into action groups, and false when not", - "isOptional": true - } - ], - "value": "export interface ActionMenuProps {\n /** Collection of page-level secondary actions */\n actions?: MenuActionDescriptor[];\n /** Collection of page-level action groups */\n groups?: MenuGroupDescriptor[];\n /** Roll up all actions into a Popover > ActionList */\n rollup?: boolean;\n /** Label for rolled up actions activator */\n rollupActionsLabel?: string;\n /** Callback that returns true when secondary actions are rolled up into action groups, and false when not */\n onActionRollup?(hasRolledUp: boolean): void;\n}" - } - }, - "CardBackgroundColorTokenScale": { - "polaris-react/src/components/AlphaCard/AlphaCard.tsx": { - "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "CardBackgroundColorTokenScale", - "value": "\"surface\" | \"surface-subdued\"", - "description": "" - } - }, - "Spacing": { - "polaris-react/src/components/AlphaCard/AlphaCard.tsx": { - "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Spacing", - "value": "ResponsiveProp", - "description": "" - }, - "polaris-react/src/components/Bleed/Bleed.tsx": { - "filePath": "polaris-react/src/components/Bleed/Bleed.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Spacing", - "value": "ResponsiveProp", - "description": "" - }, - "polaris-react/src/components/Box/Box.tsx": { - "filePath": "polaris-react/src/components/Box/Box.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Spacing", - "value": "ResponsiveProp", - "description": "" - }, - "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx": { - "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Spacing", - "value": "'extraTight' | 'tight' | 'loose'", - "description": "" - }, - "polaris-react/src/components/Stack/Stack.tsx": { - "filePath": "polaris-react/src/components/Stack/Stack.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Spacing", - "value": "'extraTight' | 'tight' | 'baseTight' | 'loose' | 'extraLoose' | 'none'", - "description": "" - }, - "polaris-react/src/components/TextContainer/TextContainer.tsx": { - "filePath": "polaris-react/src/components/TextContainer/TextContainer.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Spacing", - "value": "'tight' | 'loose'", - "description": "" - } - }, - "AlphaCardProps": { - "polaris-react/src/components/AlphaCard/AlphaCard.tsx": { - "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", - "name": "AlphaCardProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", - "syntaxKind": "PropertySignature", - "name": "background", - "value": "CardBackgroundColorTokenScale", - "description": "Background color", - "isOptional": true, - "defaultValue": "'surface'" - }, - { - "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", - "syntaxKind": "PropertySignature", - "name": "padding", - "value": "Spacing", - "description": "The spacing around the card", - "isOptional": true, - "defaultValue": "{xs: '4', sm: '5'}" - }, - { - "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", - "syntaxKind": "PropertySignature", - "name": "roundedAbove", - "value": "\"xs\" | \"sm\" | \"md\" | \"lg\" | \"xl\"", - "description": "Border radius value above a set breakpoint", - "isOptional": true - } - ], - "value": "export interface AlphaCardProps {\n children?: React.ReactNode;\n /** Background color\n * @default 'surface'\n */\n background?: CardBackgroundColorTokenScale;\n /** The spacing around the card\n * @default {xs: '4', sm: '5'}\n * @example\n * padding='4'\n * padding={{xs: '2', sm: '3', md: '4', lg: '5', xl: '6'}}\n */\n padding?: Spacing;\n /** Border radius value above a set breakpoint */\n roundedAbove?: BreakpointsAlias;\n}" - } - }, "Props": { "polaris-react/src/components/AfterInitialMount/AfterInitialMount.tsx": { "filePath": "polaris-react/src/components/AfterInitialMount/AfterInitialMount.tsx", @@ -8153,83 +8006,67 @@ "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}" } }, - "Align": { - "polaris-react/src/components/AlphaStack/AlphaStack.tsx": { - "filePath": "polaris-react/src/components/AlphaStack/AlphaStack.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Align", - "value": "'start' | 'end' | 'center'", - "description": "" - }, - "polaris-react/src/components/Inline/Inline.tsx": { - "filePath": "polaris-react/src/components/Inline/Inline.tsx", + "CardBackgroundColorTokenScale": { + "polaris-react/src/components/AlphaCard/AlphaCard.tsx": { + "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", "syntaxKind": "TypeAliasDeclaration", - "name": "Align", - "value": "'start' | 'center' | 'end' | 'space-around' | 'space-between' | 'space-evenly'", + "name": "CardBackgroundColorTokenScale", + "value": "\"surface\" | \"surface-subdued\"", "description": "" } }, - "Element": { - "polaris-react/src/components/AlphaStack/AlphaStack.tsx": { - "filePath": "polaris-react/src/components/AlphaStack/AlphaStack.tsx", + "Spacing": { + "polaris-react/src/components/AlphaCard/AlphaCard.tsx": { + "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", "syntaxKind": "TypeAliasDeclaration", - "name": "Element", - "value": "'div' | 'ul' | 'ol' | 'fieldset'", + "name": "Spacing", + "value": "ResponsiveProp", "description": "" }, - "polaris-react/src/components/Box/Box.tsx": { - "filePath": "polaris-react/src/components/Box/Box.tsx", + "polaris-react/src/components/Bleed/Bleed.tsx": { + "filePath": "polaris-react/src/components/Bleed/Bleed.tsx", "syntaxKind": "TypeAliasDeclaration", - "name": "Element", - "value": "'div' | 'span' | 'section' | 'ul' | 'li'", + "name": "Spacing", + "value": "ResponsiveProp", "description": "" }, - "polaris-react/src/components/Text/Text.tsx": { - "filePath": "polaris-react/src/components/Text/Text.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Element", - "value": "'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6' | 'p' | 'span' | 'legend'", - "description": "" - } - }, - "Gap": { - "polaris-react/src/components/AlphaStack/AlphaStack.tsx": { - "filePath": "polaris-react/src/components/AlphaStack/AlphaStack.tsx", + "polaris-react/src/components/Box/Box.tsx": { + "filePath": "polaris-react/src/components/Box/Box.tsx", "syntaxKind": "TypeAliasDeclaration", - "name": "Gap", + "name": "Spacing", "value": "ResponsiveProp", "description": "" }, - "polaris-react/src/components/Columns/Columns.tsx": { - "filePath": "polaris-react/src/components/Columns/Columns.tsx", + "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx": { + "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", "syntaxKind": "TypeAliasDeclaration", - "name": "Gap", - "value": "ResponsiveProp", + "name": "Spacing", + "value": "'extraTight' | 'tight' | 'loose'", "description": "" }, - "polaris-react/src/components/Grid/Grid.tsx": { - "filePath": "polaris-react/src/components/Grid/Grid.tsx", + "polaris-react/src/components/Stack/Stack.tsx": { + "filePath": "polaris-react/src/components/Stack/Stack.tsx", "syntaxKind": "TypeAliasDeclaration", - "name": "Gap", - "value": "{\n [Breakpoint in Breakpoints]?: string;\n}", + "name": "Spacing", + "value": "'extraTight' | 'tight' | 'baseTight' | 'loose' | 'extraLoose' | 'none'", "description": "" }, - "polaris-react/src/components/Inline/Inline.tsx": { - "filePath": "polaris-react/src/components/Inline/Inline.tsx", + "polaris-react/src/components/TextContainer/TextContainer.tsx": { + "filePath": "polaris-react/src/components/TextContainer/TextContainer.tsx", "syntaxKind": "TypeAliasDeclaration", - "name": "Gap", - "value": "ResponsiveProp", + "name": "Spacing", + "value": "'tight' | 'loose'", "description": "" } }, - "AlphaStackProps": { - "polaris-react/src/components/AlphaStack/AlphaStack.tsx": { - "filePath": "polaris-react/src/components/AlphaStack/AlphaStack.tsx", - "name": "AlphaStackProps", + "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/AlphaStack/AlphaStack.tsx", + "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", "syntaxKind": "PropertySignature", "name": "children", "value": "React.ReactNode", @@ -8237,29 +8074,192 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/AlphaStack/AlphaStack.tsx", + "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", "syntaxKind": "PropertySignature", - "name": "as", - "value": "Element", - "description": "HTML Element type", + "name": "background", + "value": "CardBackgroundColorTokenScale", + "description": "Background color", "isOptional": true, - "defaultValue": "'div'" + "defaultValue": "'surface'" }, { - "filePath": "polaris-react/src/components/AlphaStack/AlphaStack.tsx", + "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", "syntaxKind": "PropertySignature", - "name": "align", - "value": "Align", - "description": "Vertical alignment of children", + "name": "padding", + "value": "Spacing", + "description": "The spacing around the card", "isOptional": true, - "defaultValue": "'start'" + "defaultValue": "{xs: '4', sm: '5'}" }, { - "filePath": "polaris-react/src/components/AlphaStack/AlphaStack.tsx", + "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", "syntaxKind": "PropertySignature", - "name": "fullWidth", - "value": "boolean", - "description": "Toggle children to be full width", + "name": "roundedAbove", + "value": "\"xs\" | \"sm\" | \"md\" | \"lg\" | \"xl\"", + "description": "Border radius value above a set breakpoint", + "isOptional": true + } + ], + "value": "export interface AlphaCardProps {\n children?: React.ReactNode;\n /** Background color\n * @default 'surface'\n */\n background?: CardBackgroundColorTokenScale;\n /** The spacing around the card\n * @default {xs: '4', sm: '5'}\n * @example\n * padding='4'\n * padding={{xs: '2', sm: '3', md: '4', lg: '5', xl: '6'}}\n */\n padding?: Spacing;\n /** Border radius value above a set breakpoint */\n roundedAbove?: BreakpointsAlias;\n}" + } + }, + "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}" + } + }, + "Align": { + "polaris-react/src/components/AlphaStack/AlphaStack.tsx": { + "filePath": "polaris-react/src/components/AlphaStack/AlphaStack.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Align", + "value": "'start' | 'end' | 'center'", + "description": "" + }, + "polaris-react/src/components/Inline/Inline.tsx": { + "filePath": "polaris-react/src/components/Inline/Inline.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Align", + "value": "'start' | 'center' | 'end' | 'space-around' | 'space-between' | 'space-evenly'", + "description": "" + } + }, + "Element": { + "polaris-react/src/components/AlphaStack/AlphaStack.tsx": { + "filePath": "polaris-react/src/components/AlphaStack/AlphaStack.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Element", + "value": "'div' | 'ul' | 'ol' | 'fieldset'", + "description": "" + }, + "polaris-react/src/components/Box/Box.tsx": { + "filePath": "polaris-react/src/components/Box/Box.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Element", + "value": "'div' | 'span' | 'section' | 'ul' | 'li'", + "description": "" + }, + "polaris-react/src/components/Text/Text.tsx": { + "filePath": "polaris-react/src/components/Text/Text.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Element", + "value": "'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6' | 'p' | 'span' | 'legend'", + "description": "" + } + }, + "Gap": { + "polaris-react/src/components/AlphaStack/AlphaStack.tsx": { + "filePath": "polaris-react/src/components/AlphaStack/AlphaStack.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Gap", + "value": "ResponsiveProp", + "description": "" + }, + "polaris-react/src/components/Columns/Columns.tsx": { + "filePath": "polaris-react/src/components/Columns/Columns.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Gap", + "value": "ResponsiveProp", + "description": "" + }, + "polaris-react/src/components/Grid/Grid.tsx": { + "filePath": "polaris-react/src/components/Grid/Grid.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Gap", + "value": "{\n [Breakpoint in Breakpoints]?: string;\n}", + "description": "" + }, + "polaris-react/src/components/Inline/Inline.tsx": { + "filePath": "polaris-react/src/components/Inline/Inline.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Gap", + "value": "ResponsiveProp", + "description": "" + } + }, + "AlphaStackProps": { + "polaris-react/src/components/AlphaStack/AlphaStack.tsx": { + "filePath": "polaris-react/src/components/AlphaStack/AlphaStack.tsx", + "name": "AlphaStackProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/AlphaStack/AlphaStack.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/AlphaStack/AlphaStack.tsx", + "syntaxKind": "PropertySignature", + "name": "as", + "value": "Element", + "description": "HTML Element type", + "isOptional": true, + "defaultValue": "'div'" + }, + { + "filePath": "polaris-react/src/components/AlphaStack/AlphaStack.tsx", + "syntaxKind": "PropertySignature", + "name": "align", + "value": "Align", + "description": "Vertical alignment of children", + "isOptional": true, + "defaultValue": "'start'" + }, + { + "filePath": "polaris-react/src/components/AlphaStack/AlphaStack.tsx", + "syntaxKind": "PropertySignature", + "name": "fullWidth", + "value": "boolean", + "description": "Toggle children to be full width", "isOptional": true, "defaultValue": "false" }, @@ -10130,7 +10130,7 @@ "syntaxKind": "PropertySignature", "name": "tabIndex", "value": "any", - "description": "Width of container", + "description": "Set tab order", "isOptional": true }, { @@ -10138,7 +10138,7 @@ "syntaxKind": "PropertySignature", "name": "width", "value": "string", - "description": "", + "description": "Width of container", "isOptional": true }, { @@ -10206,7 +10206,7 @@ "isOptional": true } ], - "value": "export interface BoxProps extends React.AriaAttributes {\n children?: React.ReactNode;\n /** HTML Element type\n * @default 'div'\n */\n as?: Element;\n /** Background color */\n background?: BackgroundColors;\n /** Border style */\n border?: BorderTokenAlias;\n /** Vertical end border style */\n borderBlockEnd?: BorderTokenAlias;\n /** Horizontal start border style */\n borderInlineStart?: BorderTokenAlias;\n /** Horizontal end border style */\n borderInlineEnd?: BorderTokenAlias;\n /** Vertical start border style */\n borderBlockStart?: BorderTokenAlias;\n /** Border radius */\n borderRadius?: BorderRadiusTokenScale;\n /** Vertical end horizontal start border radius */\n borderRadiusEndStart?: BorderRadiusTokenScale;\n /** Vertical end horizontal end border radius */\n borderRadiusEndEnd?: BorderRadiusTokenScale;\n /** Vertical start horizontal start border radius */\n borderRadiusStartStart?: BorderRadiusTokenScale;\n /** Vertical start horizontal end border radius */\n borderRadiusStartEnd?: BorderRadiusTokenScale;\n /** Border width */\n borderWidth?: ShapeBorderWidthScale;\n /** Vertical start border width */\n borderBlockStartWidth?: ShapeBorderWidthScale;\n /** Vertical end border width */\n borderBlockEndWidth?: ShapeBorderWidthScale;\n /** Horizontal start border width */\n borderInlineStartWidth?: ShapeBorderWidthScale;\n /** Horizontal end border width */\n borderInlineEndWidth?: ShapeBorderWidthScale;\n /** Color of children */\n color?: ColorTokenScale;\n /** HTML id attribute */\n id?: string;\n /** Minimum height of container */\n minHeight?: string;\n /** Minimum width of container */\n minWidth?: string;\n /** 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. Accepts a spacing token or an object of spacing tokens for different screen sizes.\n * @example\n * padding='4'\n * padding={{xs: '2', sm: '3', md: '4', lg: '5', xl: '6'}}\n */\n padding?: Spacing;\n /** Vertical start spacing around children. Accepts a spacing token or an object of spacing tokens for different screen sizes.\n * @example\n * paddingBlockStart='4'\n * paddingBlockStart={{xs: '2', sm: '3', md: '4', lg: '5', xl: '6'}}\n */\n paddingBlockStart?: Spacing;\n /** Vertical end spacing around children. Accepts a spacing token or an object of spacing tokens for different screen sizes.\n * @example\n * paddingBlockEnd='4'\n * paddingBlockEnd={{xs: '2', sm: '3', md: '4', lg: '5', xl: '6'}}\n */\n paddingBlockEnd?: Spacing;\n /** Horizontal start spacing around children. Accepts a spacing token or an object of spacing tokens for different screen sizes.\n * @example\n * paddingInlineStart='4'\n * paddingInlineStart={{xs: '2', sm: '3', md: '4', lg: '5', xl: '6'}}\n */\n paddingInlineStart?: Spacing;\n /** Horizontal end spacing around children. Accepts a spacing token or an object of spacing tokens for different screen sizes.\n * @example\n * paddingInlineEnd='4'\n * paddingInlineEnd={{xs: '2', sm: '3', md: '4', lg: '5', xl: '6'}}\n */\n paddingInlineEnd?: Spacing;\n /** Aria role */\n role?: Extract;\n /** Shadow on box */\n shadow?: DepthShadowAlias;\n /** Width of container */\n tabIndex?: Extract['tabIndex'], number>;\n width?: string;\n // These could be moved to new layout component(s) in the future\n /** Position of box */\n position?: Position;\n /** Top position of box */\n insetBlockStart?: Spacing;\n /** Bottom position of box */\n insetBlockEnd?: Spacing;\n /** Left position of box */\n insetInlineStart?: Spacing;\n /** Right position of box */\n insetInlineEnd?: Spacing;\n /** Opacity of box */\n opacity?: string;\n /** Visually hide the contents (still announced by screenreader) */\n visuallyHidden?: boolean;\n /** z-index of box */\n zIndex?: string;\n}" + "value": "export interface BoxProps extends React.AriaAttributes {\n children?: React.ReactNode;\n /** HTML Element type\n * @default 'div'\n */\n as?: Element;\n /** Background color */\n background?: BackgroundColors;\n /** Border style */\n border?: BorderTokenAlias;\n /** Vertical end border style */\n borderBlockEnd?: BorderTokenAlias;\n /** Horizontal start border style */\n borderInlineStart?: BorderTokenAlias;\n /** Horizontal end border style */\n borderInlineEnd?: BorderTokenAlias;\n /** Vertical start border style */\n borderBlockStart?: BorderTokenAlias;\n /** Border radius */\n borderRadius?: BorderRadiusTokenScale;\n /** Vertical end horizontal start border radius */\n borderRadiusEndStart?: BorderRadiusTokenScale;\n /** Vertical end horizontal end border radius */\n borderRadiusEndEnd?: BorderRadiusTokenScale;\n /** Vertical start horizontal start border radius */\n borderRadiusStartStart?: BorderRadiusTokenScale;\n /** Vertical start horizontal end border radius */\n borderRadiusStartEnd?: BorderRadiusTokenScale;\n /** Border width */\n borderWidth?: ShapeBorderWidthScale;\n /** Vertical start border width */\n borderBlockStartWidth?: ShapeBorderWidthScale;\n /** Vertical end border width */\n borderBlockEndWidth?: ShapeBorderWidthScale;\n /** Horizontal start border width */\n borderInlineStartWidth?: ShapeBorderWidthScale;\n /** Horizontal end border width */\n borderInlineEndWidth?: ShapeBorderWidthScale;\n /** Color of children */\n color?: ColorTokenScale;\n /** HTML id attribute */\n id?: string;\n /** Minimum height of container */\n minHeight?: string;\n /** Minimum width of container */\n minWidth?: string;\n /** 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. Accepts a spacing token or an object of spacing tokens for different screen sizes.\n * @example\n * padding='4'\n * padding={{xs: '2', sm: '3', md: '4', lg: '5', xl: '6'}}\n */\n padding?: Spacing;\n /** Vertical start spacing around children. Accepts a spacing token or an object of spacing tokens for different screen sizes.\n * @example\n * paddingBlockStart='4'\n * paddingBlockStart={{xs: '2', sm: '3', md: '4', lg: '5', xl: '6'}}\n */\n paddingBlockStart?: Spacing;\n /** Vertical end spacing around children. Accepts a spacing token or an object of spacing tokens for different screen sizes.\n * @example\n * paddingBlockEnd='4'\n * paddingBlockEnd={{xs: '2', sm: '3', md: '4', lg: '5', xl: '6'}}\n */\n paddingBlockEnd?: Spacing;\n /** Horizontal start spacing around children. Accepts a spacing token or an object of spacing tokens for different screen sizes.\n * @example\n * paddingInlineStart='4'\n * paddingInlineStart={{xs: '2', sm: '3', md: '4', lg: '5', xl: '6'}}\n */\n paddingInlineStart?: Spacing;\n /** Horizontal end spacing around children. Accepts a spacing token or an object of spacing tokens for different screen sizes.\n * @example\n * paddingInlineEnd='4'\n * paddingInlineEnd={{xs: '2', sm: '3', md: '4', lg: '5', xl: '6'}}\n */\n paddingInlineEnd?: Spacing;\n /** Aria role */\n role?: Extract;\n /** Shadow on box */\n shadow?: DepthShadowAlias;\n /** Set tab order */\n tabIndex?: Extract['tabIndex'], number>;\n /** Width of container */\n width?: string;\n // These could be moved to new layout component(s) in the future\n /** Position of box */\n position?: Position;\n /** Top position of box */\n insetBlockStart?: Spacing;\n /** Bottom position of box */\n insetBlockEnd?: Spacing;\n /** Left position of box */\n insetInlineStart?: Spacing;\n /** Right position of box */\n insetInlineEnd?: Spacing;\n /** Opacity of box */\n opacity?: string;\n /** Visually hide the contents (still announced by screenreader) */\n visuallyHidden?: boolean;\n /** z-index of box */\n zIndex?: string;\n}" } }, "BreadcrumbsProps": { @@ -12411,6 +12411,39 @@ "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}" } }, + "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/EmptySearchResult/EmptySearchResult.tsx", + "syntaxKind": "PropertySignature", + "name": "withIllustration", + "value": "boolean", + "description": "", + "isOptional": true + } + ], + "value": "export interface EmptySearchResultProps {\n title: string;\n description?: string;\n withIllustration?: boolean;\n}" + } + }, "DropZoneFileType": { "polaris-react/src/components/DropZone/DropZone.tsx": { "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", @@ -12785,39 +12818,6 @@ "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/EmptySearchResult/EmptySearchResult.tsx", - "syntaxKind": "PropertySignature", - "name": "withIllustration", - "value": "boolean", - "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", @@ -12899,17 +12899,43 @@ "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}" } }, - "BaseEventProps": { - "polaris-react/src/components/EventListener/EventListener.tsx": { - "filePath": "polaris-react/src/components/EventListener/EventListener.tsx", - "name": "BaseEventProps", + "Description": { + "polaris-react/src/components/ExceptionList/ExceptionList.tsx": { + "filePath": "polaris-react/src/components/ExceptionList/ExceptionList.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Description", + "value": "string | React.ReactElement | (string | React.ReactElement)[]", + "description": "" + } + }, + "ExceptionListProps": { + "polaris-react/src/components/ExceptionList/ExceptionList.tsx": { + "filePath": "polaris-react/src/components/ExceptionList/ExceptionList.tsx", + "name": "ExceptionListProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/EventListener/EventListener.tsx", + "filePath": "polaris-react/src/components/ExceptionList/ExceptionList.tsx", "syntaxKind": "PropertySignature", - "name": "event", - "value": "string", + "name": "items", + "value": "Item[]", + "description": "Collection of items for list" + } + ], + "value": "export interface ExceptionListProps {\n /** Collection of items for list */\n items: Item[];\n}" + } + }, + "BaseEventProps": { + "polaris-react/src/components/EventListener/EventListener.tsx": { + "filePath": "polaris-react/src/components/EventListener/EventListener.tsx", + "name": "BaseEventProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/EventListener/EventListener.tsx", + "syntaxKind": "PropertySignature", + "name": "event", + "value": "string", "description": "" }, { @@ -12971,32 +12997,6 @@ "value": "export interface EventListenerProps extends BaseEventProps {\n passive?: boolean;\n}" } }, - "Description": { - "polaris-react/src/components/ExceptionList/ExceptionList.tsx": { - "filePath": "polaris-react/src/components/ExceptionList/ExceptionList.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Description", - "value": "string | React.ReactElement | (string | React.ReactElement)[]", - "description": "" - } - }, - "ExceptionListProps": { - "polaris-react/src/components/ExceptionList/ExceptionList.tsx": { - "filePath": "polaris-react/src/components/ExceptionList/ExceptionList.tsx", - "name": "ExceptionListProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/ExceptionList/ExceptionList.tsx", - "syntaxKind": "PropertySignature", - "name": "items", - "value": "Item[]", - "description": "Collection of items for list" - } - ], - "value": "export interface ExceptionListProps {\n /** Collection of items for list */\n items: Item[];\n}" - } - }, "AppliedFilterInterface": { "polaris-react/src/components/Filters/Filters.tsx": { "filePath": "polaris-react/src/components/Filters/Filters.tsx", @@ -14607,87 +14607,6 @@ "value": "export interface LayoutProps {\n /** Automatically adds sections to layout. */\n sectioned?: boolean;\n /** The content to display inside the layout. */\n children?: React.ReactNode;\n}" } }, - "Type": { - "polaris-react/src/components/List/List.tsx": { - "filePath": "polaris-react/src/components/List/List.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Type", - "value": "'bullet' | 'number'", - "description": "" - }, - "polaris-react/src/components/TextField/TextField.tsx": { - "filePath": "polaris-react/src/components/TextField/TextField.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Type", - "value": "'text' | 'email' | 'number' | 'password' | 'search' | 'tel' | 'url' | 'date' | 'datetime-local' | 'month' | 'time' | 'week' | 'currency'", - "description": "" - } - }, - "ListProps": { - "polaris-react/src/components/List/List.tsx": { - "filePath": "polaris-react/src/components/List/List.tsx", - "name": "ListProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/List/List.tsx", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "Type", - "description": "Type of list to display", - "isOptional": true, - "defaultValue": "'bullet'" - }, - { - "filePath": "polaris-react/src/components/List/List.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "List item elements", - "isOptional": true - } - ], - "value": "export interface ListProps {\n /**\n * Type of list to display\n * @default 'bullet'\n */\n type?: Type;\n /** List item elements */\n children?: React.ReactNode;\n}" - }, - "polaris-react/src/components/Tabs/components/List/List.tsx": { - "filePath": "polaris-react/src/components/Tabs/components/List/List.tsx", - "name": "ListProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Tabs/components/List/List.tsx", - "syntaxKind": "PropertySignature", - "name": "focusIndex", - "value": "number", - "description": "" - }, - { - "filePath": "polaris-react/src/components/Tabs/components/List/List.tsx", - "syntaxKind": "PropertySignature", - "name": "disclosureTabs", - "value": "TabDescriptor[]", - "description": "" - }, - { - "filePath": "polaris-react/src/components/Tabs/components/List/List.tsx", - "syntaxKind": "MethodSignature", - "name": "onClick", - "value": "(id: string) => void", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Tabs/components/List/List.tsx", - "syntaxKind": "MethodSignature", - "name": "onKeyPress", - "value": "(event: React.KeyboardEvent) => void", - "description": "", - "isOptional": true - } - ], - "value": "export interface ListProps {\n focusIndex: number;\n disclosureTabs: TabDescriptor[];\n onClick?(id: string): void;\n onKeyPress?(event: React.KeyboardEvent): void;\n}" - } - }, "LinkProps": { "polaris-react/src/components/Link/Link.tsx": { "filePath": "polaris-react/src/components/Link/Link.tsx", @@ -14770,6 +14689,87 @@ "value": "export interface LinkProps {\n /** ID for the link */\n id?: string;\n /** The url to link to */\n url?: string;\n /** The content to display inside the link */\n children?: React.ReactNode;\n /** Makes the link open in a new tab */\n external?: boolean;\n /** Makes the link color the same as the current text color and adds an underline */\n monochrome?: boolean;\n /** Removes text decoration underline to the link*/\n removeUnderline?: boolean;\n /** Callback when a link is clicked */\n onClick?(): void;\n /** Descriptive text to be read to screenreaders */\n accessibilityLabel?: string;\n /** Indicates whether or not the link is the primary navigation link when rendered inside of an `IndexTable.Row` */\n dataPrimaryLink?: boolean;\n}" } }, + "Type": { + "polaris-react/src/components/List/List.tsx": { + "filePath": "polaris-react/src/components/List/List.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Type", + "value": "'bullet' | 'number'", + "description": "" + }, + "polaris-react/src/components/TextField/TextField.tsx": { + "filePath": "polaris-react/src/components/TextField/TextField.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Type", + "value": "'text' | 'email' | 'number' | 'password' | 'search' | 'tel' | 'url' | 'date' | 'datetime-local' | 'month' | 'time' | 'week' | 'currency'", + "description": "" + } + }, + "ListProps": { + "polaris-react/src/components/List/List.tsx": { + "filePath": "polaris-react/src/components/List/List.tsx", + "name": "ListProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/List/List.tsx", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "Type", + "description": "Type of list to display", + "isOptional": true, + "defaultValue": "'bullet'" + }, + { + "filePath": "polaris-react/src/components/List/List.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "List item elements", + "isOptional": true + } + ], + "value": "export interface ListProps {\n /**\n * Type of list to display\n * @default 'bullet'\n */\n type?: Type;\n /** List item elements */\n children?: React.ReactNode;\n}" + }, + "polaris-react/src/components/Tabs/components/List/List.tsx": { + "filePath": "polaris-react/src/components/Tabs/components/List/List.tsx", + "name": "ListProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Tabs/components/List/List.tsx", + "syntaxKind": "PropertySignature", + "name": "focusIndex", + "value": "number", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Tabs/components/List/List.tsx", + "syntaxKind": "PropertySignature", + "name": "disclosureTabs", + "value": "TabDescriptor[]", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Tabs/components/List/List.tsx", + "syntaxKind": "MethodSignature", + "name": "onClick", + "value": "(id: string) => void", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Tabs/components/List/List.tsx", + "syntaxKind": "MethodSignature", + "name": "onKeyPress", + "value": "(event: React.KeyboardEvent) => void", + "description": "", + "isOptional": true + } + ], + "value": "export interface ListProps {\n focusIndex: number;\n disclosureTabs: TabDescriptor[];\n onClick?(id: string): void;\n onKeyPress?(event: React.KeyboardEvent): void;\n}" + } + }, "AutoSelection": { "polaris-react/src/components/Listbox/Listbox.tsx": { "filePath": "polaris-react/src/components/Listbox/Listbox.tsx", @@ -16157,31 +16157,6 @@ "value": "export interface PortalProps {\n children?: React.ReactNode;\n idPrefix?: string;\n onPortalCreated?(): void;\n}" } }, - "PortalsManagerProps": { - "polaris-react/src/components/PortalsManager/PortalsManager.tsx": { - "filePath": "polaris-react/src/components/PortalsManager/PortalsManager.tsx", - "name": "PortalsManagerProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/PortalsManager/PortalsManager.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "" - }, - { - "filePath": "polaris-react/src/components/PortalsManager/PortalsManager.tsx", - "syntaxKind": "PropertySignature", - "name": "container", - "value": "HTMLDivElement", - "description": "", - "isOptional": true - } - ], - "value": "export interface PortalsManagerProps {\n children: React.ReactNode;\n container?: PortalsContainerElement;\n}" - } - }, "Positioning": { "polaris-react/src/components/PositionedOverlay/PositionedOverlay.tsx": { "filePath": "polaris-react/src/components/PositionedOverlay/PositionedOverlay.tsx", @@ -16402,109 +16377,29 @@ "value": "export interface ProgressBarProps {\n /**\n * The progression of certain tasks\n * @default 0\n */\n progress?: number;\n /**\n * Size of progressbar\n * @default 'medium'\n */\n size?: Size;\n /**\n * Color of progressbar\n * @default 'highlight'\n */\n color?: Color;\n /**\n * Whether the fill animation is triggered\n * @default 'true'\n */\n animated?: boolean;\n /**\n * Id (ids) of element (elements) that describes progressbar\n */\n ariaLabelledBy?: string;\n}" } }, - "RadioButtonProps": { - "polaris-react/src/components/RadioButton/RadioButton.tsx": { - "filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx", - "name": "RadioButtonProps", + "PortalsManagerProps": { + "polaris-react/src/components/PortalsManager/PortalsManager.tsx": { + "filePath": "polaris-react/src/components/PortalsManager/PortalsManager.tsx", + "name": "PortalsManagerProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx", - "syntaxKind": "PropertySignature", - "name": "ariaDescribedBy", - "value": "string", - "description": "Indicates the ID of the element that describes the the radio button", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx", + "filePath": "polaris-react/src/components/PortalsManager/PortalsManager.tsx", "syntaxKind": "PropertySignature", - "name": "label", + "name": "children", "value": "React.ReactNode", - "description": "Label for the radio button" + "description": "" }, { - "filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx", + "filePath": "polaris-react/src/components/PortalsManager/PortalsManager.tsx", "syntaxKind": "PropertySignature", - "name": "labelHidden", - "value": "boolean", - "description": "Visually hide the label", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx", - "syntaxKind": "PropertySignature", - "name": "checked", - "value": "boolean", - "description": "Radio button is selected", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx", - "syntaxKind": "PropertySignature", - "name": "helpText", - "value": "React.ReactNode", - "description": "Additional text to aid in use", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "Disable input", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "ID for form input", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "Name for form input", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "Value for form input", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx", - "syntaxKind": "MethodSignature", - "name": "onChange", - "value": "(newValue: boolean, id: string) => void", - "description": "Callback when the radio button is toggled", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx", - "syntaxKind": "MethodSignature", - "name": "onFocus", - "value": "() => void", - "description": "Callback when radio button is focussed", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx", - "syntaxKind": "MethodSignature", - "name": "onBlur", - "value": "() => void", - "description": "Callback when focus is removed", + "name": "container", + "value": "HTMLDivElement", + "description": "", "isOptional": true } ], - "value": "export interface RadioButtonProps {\n /** Indicates the ID of the element that describes the the radio button*/\n ariaDescribedBy?: string;\n /** Label for the radio button */\n label: React.ReactNode;\n /** Visually hide the label */\n labelHidden?: boolean;\n /** Radio button is selected */\n checked?: boolean;\n /** Additional text to aid in use */\n helpText?: React.ReactNode;\n /** Disable input */\n disabled?: boolean;\n /** ID for form input */\n id?: string;\n /** Name for form input */\n name?: string;\n /** Value for form input */\n value?: string;\n /** Callback when the radio button is toggled */\n onChange?(newValue: boolean, id: string): void;\n /** Callback when radio button is focussed */\n onFocus?(): void;\n /** Callback when focus is removed */\n onBlur?(): void;\n}" + "value": "export interface PortalsManagerProps {\n children: React.ReactNode;\n container?: PortalsContainerElement;\n}" } }, "BaseProps": { @@ -16925,6 +16820,111 @@ "value": "interface PropsFromWrapper {\n context: React.ContextType;\n i18n: ReturnType;\n}" } }, + "RadioButtonProps": { + "polaris-react/src/components/RadioButton/RadioButton.tsx": { + "filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx", + "name": "RadioButtonProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx", + "syntaxKind": "PropertySignature", + "name": "ariaDescribedBy", + "value": "string", + "description": "Indicates the ID of the element that describes the the radio button", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "React.ReactNode", + "description": "Label for the radio button" + }, + { + "filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx", + "syntaxKind": "PropertySignature", + "name": "labelHidden", + "value": "boolean", + "description": "Visually hide the label", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx", + "syntaxKind": "PropertySignature", + "name": "checked", + "value": "boolean", + "description": "Radio button is selected", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx", + "syntaxKind": "PropertySignature", + "name": "helpText", + "value": "React.ReactNode", + "description": "Additional text to aid in use", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Disable input", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "ID for form input", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "Name for form input", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "Value for form input", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx", + "syntaxKind": "MethodSignature", + "name": "onChange", + "value": "(newValue: boolean, id: string) => void", + "description": "Callback when the radio button is toggled", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx", + "syntaxKind": "MethodSignature", + "name": "onFocus", + "value": "() => void", + "description": "Callback when radio button is focussed", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx", + "syntaxKind": "MethodSignature", + "name": "onBlur", + "value": "() => void", + "description": "Callback when focus is removed", + "isOptional": true + } + ], + "value": "export interface RadioButtonProps {\n /** Indicates the ID of the element that describes the the radio button*/\n ariaDescribedBy?: string;\n /** Label for the radio button */\n label: React.ReactNode;\n /** Visually hide the label */\n labelHidden?: boolean;\n /** Radio button is selected */\n checked?: boolean;\n /** Additional text to aid in use */\n helpText?: React.ReactNode;\n /** Disable input */\n disabled?: boolean;\n /** ID for form input */\n id?: string;\n /** Name for form input */\n name?: string;\n /** Value for form input */\n value?: string;\n /** Callback when the radio button is toggled */\n onChange?(newValue: boolean, id: string): void;\n /** Callback when radio button is focussed */\n onFocus?(): void;\n /** Callback when focus is removed */\n onBlur?(): void;\n}" + } + }, "ResourceListProps": { "polaris-react/src/components/ResourceList/ResourceList.tsx": { "filePath": "polaris-react/src/components/ResourceList/ResourceList.tsx", @@ -21992,55 +21992,301 @@ "value": "export interface PortalsManager {\n container: PortalsContainerElement;\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 + }, + { + "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 + }, + { + "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "isFirst", + "value": "boolean", + "description": "", "isOptional": true } ], - "value": "export interface ItemProps {\n /** Position of the item */\n position: ItemPosition;\n /** Item content */\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 isFirst?: boolean;\n}" }, - "polaris-react/src/components/FormLayout/components/Item/Item.tsx": { - "filePath": "polaris-react/src/components/FormLayout/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/Layout/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "secondary", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "fullWidth", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "oneHalf", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "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/Listbox/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "divider", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Listbox/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "ReactNode", + "description": "", + "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", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "flush", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "subdued", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "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/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "icon", + "value": "any", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "fill", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "rollup", + "value": "{ after: number; view: string; hide: string; activePath: string; }", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "action", + "value": "{ icon: any; accessibilityLabel: string; onClick(): void; tooltip?: TooltipProps; }", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "separator", + "value": "boolean", + "description": "", + "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", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "", + "isOptional": true + } + ], + "value": "export interface SectionProps {\n children?: React.ReactNode;\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": [ { @@ -22281,485 +22527,121 @@ "description": "" }, { - "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", - "syntaxKind": "PropertySignature", - "name": "panelID", - "value": "string", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "", - "isOptional": true - }, - { - "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/Filters/components/ConnectedFilterControl/components/Item/Item.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", - "isOptional": true - } - ], - "value": "interface ItemProps {\n children?: React.ReactNode;\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", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "secondary", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "fullWidth", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "oneHalf", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "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/Listbox/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "divider", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Listbox/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "ReactNode", - "description": "", - "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", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "flush", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "subdued", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "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/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "icon", - "value": "any", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "fill", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "rollup", - "value": "{ after: number; view: string; hide: string; activePath: string; }", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "action", - "value": "{ icon: any; accessibilityLabel: string; onClick(): void; tooltip?: TooltipProps; }", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "separator", - "value": "boolean", - "description": "", - "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", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", - "isOptional": true - } - ], - "value": "export interface SectionProps {\n children?: React.ReactNode;\n}" - } - }, - "MeasuredActions": { - "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx": { - "filePath": "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx", - "name": "MeasuredActions", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx", - "syntaxKind": "PropertySignature", - "name": "showable", - "value": "MenuActionDescriptor[]", - "description": "" - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx", - "syntaxKind": "PropertySignature", - "name": "rolledUp", - "value": "(MenuActionDescriptor | MenuGroupDescriptor)[]", - "description": "" - } - ], - "value": "interface MeasuredActions {\n showable: MenuActionDescriptor[];\n rolledUp: (MenuActionDescriptor | MenuGroupDescriptor)[];\n}" - } - }, - "RollupActionsProps": { - "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx": { - "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", - "name": "RollupActionsProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "Accessibilty label", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", - "syntaxKind": "PropertySignature", - "name": "items", - "value": "ActionListItemDescriptor[]", - "description": "Collection of actions for the list", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", - "syntaxKind": "PropertySignature", - "name": "sections", - "value": "ActionListSection[]", - "description": "Collection of sectioned action items", - "isOptional": true - } - ], - "value": "export interface RollupActionsProps {\n /** Accessibilty label */\n accessibilityLabel?: string;\n /** Collection of actions for the list */\n items?: ActionListItemDescriptor[];\n /** Collection of sectioned action items */\n sections?: ActionListSection[];\n}" - } - }, - "MenuGroupProps": { - "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx": { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "name": "MenuGroupProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "Visually hidden menu description for screen readers", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "PropertySignature", - "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", + "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "sections", - "value": "readonly ActionListSection[]", - "description": "Collection of sectioned action items", + "name": "panelID", + "value": "string", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "Menu group title" + "name": "children", + "value": "React.ReactNode", + "description": "", + "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "actions", - "value": "ActionListItemDescriptor[]", - "description": "List of actions" + "name": "url", + "value": "string", + "description": "", + "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "icon", - "value": "any", - "description": "Icon to display", + "name": "accessibilityLabel", + "value": "string", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "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/Filters/components/ConnectedFilterControl/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "details", + "name": "children", "value": "React.ReactNode", - "description": "Action details", + "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/MenuGroup/MenuGroup.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx", "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "Disables action button", - "isOptional": true + "name": "showable", + "value": "MenuActionDescriptor[]", + "description": "" }, { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx", "syntaxKind": "PropertySignature", - "name": "index", - "value": "number", - "description": "Zero-indexed numerical position. Overrides the group's order in the menu.", + "name": "rolledUp", + "value": "(MenuActionDescriptor | MenuGroupDescriptor)[]", + "description": "" + } + ], + "value": "interface MeasuredActions {\n showable: MenuActionDescriptor[];\n rolledUp: (MenuActionDescriptor | MenuGroupDescriptor)[];\n}" + } + }, + "RollupActionsProps": { + "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx": { + "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", + "name": "RollupActionsProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "Accessibilty label", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", "syntaxKind": "PropertySignature", - "name": "onActionAnyItem", - "value": "() => void", - "description": "Callback when any action takes place", + "name": "items", + "value": "ActionListItemDescriptor[]", + "description": "Collection of actions for the list", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", "syntaxKind": "PropertySignature", - "name": "badge", - "value": "{ status: \"new\"; content: string; }", - "description": "", + "name": "sections", + "value": "ActionListSection[]", + "description": "Collection of sectioned action items", "isOptional": true } ], - "value": "export interface MenuGroupProps extends MenuGroupDescriptor {\n /** Visually hidden menu description for screen readers */\n accessibilityLabel?: string;\n /** Whether or not the menu is open */\n active?: boolean;\n /** Callback when the menu is clicked */\n onClick?(openActions: () => void): void;\n /** Callback for opening the MenuGroup by title */\n onOpen(title: string): void;\n /** Callback for closing the MenuGroup by title */\n onClose(title: string): void;\n /** Callback for getting the offsetWidth of the MenuGroup */\n getOffsetWidth?(width: number): void;\n /** Collection of sectioned action items */\n sections?: readonly ActionListSection[];\n}" + "value": "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": { @@ -23228,95 +23110,230 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", - "syntaxKind": "PropertySignature", - "name": "role", - "value": "string", - "description": "Defines a role for the action", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "syntaxKind": "PropertySignature", + "name": "role", + "value": "string", + "description": "Defines a role for the action", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether or not the action is disabled", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the action", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "syntaxKind": "PropertySignature", + "name": "content", + "value": "string", + "description": "Content the action displays", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "syntaxKind": "PropertySignature", + "name": "url", + "value": "string", + "description": "A destination to link to, rendered in the action", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "syntaxKind": "PropertySignature", + "name": "external", + "value": "boolean", + "description": "Forces url to open in a new tab", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onAction", + "value": "() => void", + "description": "Callback when an action takes place", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onMouseEnter", + "value": "() => void", + "description": "Callback when mouse enter", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onTouchStart", + "value": "() => void", + "description": "Callback when element is touched", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "syntaxKind": "PropertySignature", + "name": "destructive", + "value": "boolean", + "description": "Destructive action", + "isOptional": true + } + ], + "value": "interface MappedAction extends ActionListItemDescriptor {\n wrapOverflow?: boolean;\n}" + } + }, + "MappedOption": { + "polaris-react/src/components/Autocomplete/components/MappedOption/MappedOption.tsx": { + "filePath": "polaris-react/src/components/Autocomplete/components/MappedOption/MappedOption.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "MappedOption", + "value": "ArrayElement & {\n selected: boolean;\n singleSelection: boolean;\n}", + "description": "" + } + }, + "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/MenuGroup/MenuGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "Visually hidden menu description for screen readers", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "PropertySignature", + "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/Autocomplete/components/MappedAction/MappedAction.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "Whether or not the action is disabled", + "name": "sections", + "value": "readonly ActionListSection[]", + "description": "Collection of sectioned action items", "isOptional": true }, { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", "syntaxKind": "PropertySignature", - "name": "id", + "name": "title", "value": "string", - "description": "A unique identifier for the action", - "isOptional": true + "description": "Menu group title" }, { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", "syntaxKind": "PropertySignature", - "name": "content", - "value": "string", - "description": "Content the action displays", - "isOptional": true + "name": "actions", + "value": "ActionListItemDescriptor[]", + "description": "List of actions" }, { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "A destination to link to, rendered in the action", + "name": "icon", + "value": "any", + "description": "Icon to display", "isOptional": true }, { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", "syntaxKind": "PropertySignature", - "name": "external", - "value": "boolean", - "description": "Forces url to open in a new tab", + "name": "details", + "value": "React.ReactNode", + "description": "Action details", "isOptional": true }, { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", - "syntaxKind": "MethodSignature", - "name": "onAction", - "value": "() => void", - "description": "Callback when an action takes place", + "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/Autocomplete/components/MappedAction/MappedAction.tsx", - "syntaxKind": "MethodSignature", - "name": "onMouseEnter", - "value": "() => void", - "description": "Callback when mouse enter", + "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/Autocomplete/components/MappedAction/MappedAction.tsx", - "syntaxKind": "MethodSignature", - "name": "onTouchStart", + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "onActionAnyItem", "value": "() => void", - "description": "Callback when element is touched", + "description": "Callback when any action takes place", "isOptional": true }, { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", "syntaxKind": "PropertySignature", - "name": "destructive", - "value": "boolean", - "description": "Destructive action", + "name": "badge", + "value": "{ status: \"new\"; content: string; }", + "description": "", "isOptional": true } ], - "value": "interface MappedAction extends ActionListItemDescriptor {\n wrapOverflow?: boolean;\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}" } }, - "MappedOption": { - "polaris-react/src/components/Autocomplete/components/MappedOption/MappedOption.tsx": { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedOption/MappedOption.tsx", + "BulkActionButtonProps": { + "polaris-react/src/components/BulkActions/components/BulkActionButton/BulkActionButton.tsx": { + "filePath": "polaris-react/src/components/BulkActions/components/BulkActionButton/BulkActionButton.tsx", "syntaxKind": "TypeAliasDeclaration", - "name": "MappedOption", - "value": "ArrayElement & {\n selected: boolean;\n singleSelection: boolean;\n}", + "name": "BulkActionButtonProps", + "value": "{\n disclosure?: boolean;\n indicator?: boolean;\n handleMeasurement?(width: number): void;\n} & DisableableAction", "description": "" } }, @@ -23354,15 +23371,6 @@ "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", @@ -23550,24 +23558,6 @@ "value": "export interface CardSectionProps {\n title?: React.ReactNode;\n children?: React.ReactNode;\n subdued?: boolean;\n flush?: boolean;\n fullWidth?: boolean;\n /** Allow the card to be hidden when printing */\n hideOnPrint?: boolean;\n actions?: ComplexAction[];\n}" } }, - "CardSubsectionProps": { - "polaris-react/src/components/Card/components/Subsection/Subsection.tsx": { - "filePath": "polaris-react/src/components/Card/components/Subsection/Subsection.tsx", - "name": "CardSubsectionProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Card/components/Subsection/Subsection.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", - "isOptional": true - } - ], - "value": "export interface CardSubsectionProps {\n children?: React.ReactNode;\n}" - } - }, "AlphaPickerProps": { "polaris-react/src/components/ColorPicker/components/AlphaPicker/AlphaPicker.tsx": { "filePath": "polaris-react/src/components/ColorPicker/components/AlphaPicker/AlphaPicker.tsx", @@ -23623,6 +23613,24 @@ "value": "export interface HuePickerProps {\n hue: number;\n onChange(hue: number): void;\n}" } }, + "CardSubsectionProps": { + "polaris-react/src/components/Card/components/Subsection/Subsection.tsx": { + "filePath": "polaris-react/src/components/Card/components/Subsection/Subsection.tsx", + "name": "CardSubsectionProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Card/components/Subsection/Subsection.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "", + "isOptional": true + } + ], + "value": "export interface CardSubsectionProps {\n children?: React.ReactNode;\n}" + } + }, "SlidableProps": { "polaris-react/src/components/ColorPicker/components/Slidable/Slidable.tsx": { "filePath": "polaris-react/src/components/ColorPicker/components/Slidable/Slidable.tsx", @@ -23664,6 +23672,15 @@ "value": "export interface SlidableProps {\n draggerX?: number;\n draggerY?: number;\n onChange(position: Position): void;\n onDraggerHeight?(height: number): void;\n}" } }, + "ItemPosition": { + "polaris-react/src/components/Connected/components/Item/Item.tsx": { + "filePath": "polaris-react/src/components/Connected/components/Item/Item.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "ItemPosition", + "value": "'left' | 'right' | 'primary'", + "description": "" + } + }, "CellProps": { "polaris-react/src/components/DataTable/components/Cell/Cell.tsx": { "filePath": "polaris-react/src/components/DataTable/components/Cell/Cell.tsx", @@ -24100,15 +24117,6 @@ "value": "export interface DayProps {\n focused?: boolean;\n day?: Date;\n selected?: boolean;\n inRange?: boolean;\n inHoveringRange?: boolean;\n disabled?: boolean;\n lastDayOfMonth?: any;\n isLastSelectedDay?: boolean;\n isFirstSelectedDay?: boolean;\n isHoveringRight?: boolean;\n rangeIsDifferent?: boolean;\n weekday?: string;\n selectedAccessibilityLabelPrefix?: string;\n onClick?(day: Date): void;\n onHover?(day?: Date): void;\n onFocus?(day: Date): void;\n}" } }, - "ItemPosition": { - "polaris-react/src/components/Connected/components/Item/Item.tsx": { - "filePath": "polaris-react/src/components/Connected/components/Item/Item.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "ItemPosition", - "value": "'left' | 'right' | 'primary'", - "description": "" - } - }, "MonthProps": { "polaris-react/src/components/DatePicker/components/Month/Month.tsx": { "filePath": "polaris-react/src/components/DatePicker/components/Month/Month.tsx", @@ -24258,32 +24266,6 @@ "value": "export interface WeekdayProps {\n label: string;\n title: string;\n current: boolean;\n}" } }, - "FileUploadProps": { - "polaris-react/src/components/DropZone/components/FileUpload/FileUpload.tsx": { - "filePath": "polaris-react/src/components/DropZone/components/FileUpload/FileUpload.tsx", - "name": "FileUploadProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/DropZone/components/FileUpload/FileUpload.tsx", - "syntaxKind": "PropertySignature", - "name": "actionTitle", - "value": "string", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/DropZone/components/FileUpload/FileUpload.tsx", - "syntaxKind": "PropertySignature", - "name": "actionHint", - "value": "string", - "description": "", - "isOptional": true - } - ], - "value": "export interface FileUploadProps {\n actionTitle?: string;\n actionHint?: string;\n}" - } - }, "PopoverableAction": { "polaris-react/src/components/Filters/components/ConnectedFilterControl/ConnectedFilterControl.tsx": { "filePath": "polaris-react/src/components/Filters/components/ConnectedFilterControl/ConnectedFilterControl.tsx", @@ -24465,6 +24447,32 @@ "value": "interface ComputedProperty {\n [key: string]: number;\n}" } }, + "FileUploadProps": { + "polaris-react/src/components/DropZone/components/FileUpload/FileUpload.tsx": { + "filePath": "polaris-react/src/components/DropZone/components/FileUpload/FileUpload.tsx", + "name": "FileUploadProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/DropZone/components/FileUpload/FileUpload.tsx", + "syntaxKind": "PropertySignature", + "name": "actionTitle", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/DropZone/components/FileUpload/FileUpload.tsx", + "syntaxKind": "PropertySignature", + "name": "actionHint", + "value": "string", + "description": "", + "isOptional": true + } + ], + "value": "export interface FileUploadProps {\n actionTitle?: string;\n actionHint?: string;\n}" + } + }, "GroupProps": { "polaris-react/src/components/FormLayout/components/Group/Group.tsx": { "filePath": "polaris-react/src/components/FormLayout/components/Group/Group.tsx", @@ -26342,39 +26350,80 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/Tabs/components/Tab/Tab.tsx", + "filePath": "polaris-react/src/components/Tabs/components/Tab/Tab.tsx", + "syntaxKind": "PropertySignature", + "name": "url", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Tabs/components/Tab/Tab.tsx", + "syntaxKind": "PropertySignature", + "name": "measuring", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Tabs/components/Tab/Tab.tsx", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Tabs/components/Tab/Tab.tsx", + "syntaxKind": "MethodSignature", + "name": "onClick", + "value": "(id: string) => void", + "description": "", + "isOptional": true + } + ], + "value": "export interface TabProps {\n id: string;\n focused?: boolean;\n siblingTabHasFocus?: boolean;\n selected?: boolean;\n panelID?: string;\n children?: React.ReactNode;\n url?: string;\n measuring?: boolean;\n accessibilityLabel?: string;\n onClick?(id: string): void;\n}" + } + }, + "ResizerProps": { + "polaris-react/src/components/TextField/components/Resizer/Resizer.tsx": { + "filePath": "polaris-react/src/components/TextField/components/Resizer/Resizer.tsx", + "name": "ResizerProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/TextField/components/Resizer/Resizer.tsx", "syntaxKind": "PropertySignature", - "name": "url", + "name": "contents", "value": "string", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Tabs/components/Tab/Tab.tsx", + "filePath": "polaris-react/src/components/TextField/components/Resizer/Resizer.tsx", "syntaxKind": "PropertySignature", - "name": "measuring", - "value": "boolean", + "name": "currentHeight", + "value": "number", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Tabs/components/Tab/Tab.tsx", + "filePath": "polaris-react/src/components/TextField/components/Resizer/Resizer.tsx", "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", + "name": "minimumLines", + "value": "number", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Tabs/components/Tab/Tab.tsx", + "filePath": "polaris-react/src/components/TextField/components/Resizer/Resizer.tsx", "syntaxKind": "MethodSignature", - "name": "onClick", - "value": "(id: string) => void", - "description": "", - "isOptional": true + "name": "onHeightChange", + "value": "(height: number) => void", + "description": "" } ], - "value": "export interface TabProps {\n id: string;\n focused?: boolean;\n siblingTabHasFocus?: boolean;\n selected?: boolean;\n panelID?: string;\n children?: React.ReactNode;\n url?: string;\n measuring?: boolean;\n accessibilityLabel?: string;\n onClick?(id: string): void;\n}" + "value": "export interface ResizerProps {\n contents?: string;\n currentHeight?: number | null;\n minimumLines?: number;\n onHeightChange(height: number): void;\n}" } }, "TabMeasurements": { @@ -26460,47 +26509,6 @@ "value": "export interface TabMeasurerProps {\n tabToFocus: number;\n siblingTabHasFocus: boolean;\n activator: React.ReactElement;\n selected: number;\n tabs: TabDescriptor[];\n handleMeasurement(measurements: TabMeasurements): void;\n}" } }, - "ResizerProps": { - "polaris-react/src/components/TextField/components/Resizer/Resizer.tsx": { - "filePath": "polaris-react/src/components/TextField/components/Resizer/Resizer.tsx", - "name": "ResizerProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/TextField/components/Resizer/Resizer.tsx", - "syntaxKind": "PropertySignature", - "name": "contents", - "value": "string", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/TextField/components/Resizer/Resizer.tsx", - "syntaxKind": "PropertySignature", - "name": "currentHeight", - "value": "number", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/TextField/components/Resizer/Resizer.tsx", - "syntaxKind": "PropertySignature", - "name": "minimumLines", - "value": "number", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/TextField/components/Resizer/Resizer.tsx", - "syntaxKind": "MethodSignature", - "name": "onHeightChange", - "value": "(height: number) => void", - "description": "" - } - ], - "value": "export interface ResizerProps {\n contents?: string;\n currentHeight?: number | null;\n minimumLines?: number;\n onHeightChange(height: number): void;\n}" - } - }, "HandleStepFn": { "polaris-react/src/components/TextField/components/Spinner/Spinner.tsx": { "filePath": "polaris-react/src/components/TextField/components/Spinner/Spinner.tsx", @@ -26683,6 +26691,83 @@ "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}" } }, + "UserMenuProps": { + "polaris-react/src/components/TopBar/components/UserMenu/UserMenu.tsx": { + "filePath": "polaris-react/src/components/TopBar/components/UserMenu/UserMenu.tsx", + "name": "UserMenuProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/TopBar/components/UserMenu/UserMenu.tsx", + "syntaxKind": "PropertySignature", + "name": "actions", + "value": "{ items: IconableAction[]; }[]", + "description": "An array of action objects that are rendered inside of a popover triggered by this menu" + }, + { + "filePath": "polaris-react/src/components/TopBar/components/UserMenu/UserMenu.tsx", + "syntaxKind": "PropertySignature", + "name": "message", + "value": "MessageProps", + "description": "Accepts a message that facilitates direct, urgent communication with the merchant through the user menu", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/TopBar/components/UserMenu/UserMenu.tsx", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "A string detailing the merchant’s full name to be displayed in the user menu" + }, + { + "filePath": "polaris-react/src/components/TopBar/components/UserMenu/UserMenu.tsx", + "syntaxKind": "PropertySignature", + "name": "detail", + "value": "string", + "description": "A string allowing further detail on the merchant’s name displayed in the user menu", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/TopBar/components/UserMenu/UserMenu.tsx", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A string that provides the accessibility labeling", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/TopBar/components/UserMenu/UserMenu.tsx", + "syntaxKind": "PropertySignature", + "name": "initials", + "value": "string", + "description": "The merchant’s initials, rendered in place of an avatar image when not provided" + }, + { + "filePath": "polaris-react/src/components/TopBar/components/UserMenu/UserMenu.tsx", + "syntaxKind": "PropertySignature", + "name": "avatar", + "value": "string", + "description": "An avatar image representing the merchant", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/TopBar/components/UserMenu/UserMenu.tsx", + "syntaxKind": "PropertySignature", + "name": "open", + "value": "boolean", + "description": "A boolean property indicating whether the user menu is currently open" + }, + { + "filePath": "polaris-react/src/components/TopBar/components/UserMenu/UserMenu.tsx", + "syntaxKind": "MethodSignature", + "name": "onToggle", + "value": "() => void", + "description": "A callback function to handle opening and closing the user menu" + } + ], + "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}" + } + }, "SearchFieldProps": { "polaris-react/src/components/TopBar/components/SearchField/SearchField.tsx": { "filePath": "polaris-react/src/components/TopBar/components/SearchField/SearchField.tsx", @@ -26763,81 +26848,35 @@ "value": "export interface SearchFieldProps {\n /** Initial value for the input */\n value: string;\n /** Hint text to display */\n placeholder?: string;\n /** Force the focus state on the input */\n focused?: boolean;\n /** Force a state where search is active but the text field component is not focused */\n active?: boolean;\n /** Callback when value is changed */\n onChange(value: string): void;\n /** Callback when input is focused */\n onFocus?(): void;\n /** Callback when focus is removed */\n onBlur?(): void;\n /** Callback when search field cancel button is clicked */\n onCancel?(): void;\n /** Show a border when the search field is focused */\n showFocusBorder?: boolean;\n}" } }, - "UserMenuProps": { - "polaris-react/src/components/TopBar/components/UserMenu/UserMenu.tsx": { - "filePath": "polaris-react/src/components/TopBar/components/UserMenu/UserMenu.tsx", - "name": "UserMenuProps", + "DiscardConfirmationModalProps": { + "polaris-react/src/components/Frame/components/ContextualSaveBar/components/DiscardConfirmationModal/DiscardConfirmationModal.tsx": { + "filePath": "polaris-react/src/components/Frame/components/ContextualSaveBar/components/DiscardConfirmationModal/DiscardConfirmationModal.tsx", + "name": "DiscardConfirmationModalProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/TopBar/components/UserMenu/UserMenu.tsx", - "syntaxKind": "PropertySignature", - "name": "actions", - "value": "{ items: IconableAction[]; }[]", - "description": "An array of action objects that are rendered inside of a popover triggered by this menu" - }, - { - "filePath": "polaris-react/src/components/TopBar/components/UserMenu/UserMenu.tsx", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "MessageProps", - "description": "Accepts a message that facilitates direct, urgent communication with the merchant through the user menu", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/TopBar/components/UserMenu/UserMenu.tsx", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "A string detailing the merchant’s full name to be displayed in the user menu" - }, - { - "filePath": "polaris-react/src/components/TopBar/components/UserMenu/UserMenu.tsx", - "syntaxKind": "PropertySignature", - "name": "detail", - "value": "string", - "description": "A string allowing further detail on the merchant’s name displayed in the user menu", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/TopBar/components/UserMenu/UserMenu.tsx", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "A string that provides the accessibility labeling", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/TopBar/components/UserMenu/UserMenu.tsx", - "syntaxKind": "PropertySignature", - "name": "initials", - "value": "string", - "description": "The merchant’s initials, rendered in place of an avatar image when not provided" - }, - { - "filePath": "polaris-react/src/components/TopBar/components/UserMenu/UserMenu.tsx", - "syntaxKind": "PropertySignature", - "name": "avatar", - "value": "string", - "description": "An avatar image representing the merchant", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/TopBar/components/UserMenu/UserMenu.tsx", + "filePath": "polaris-react/src/components/Frame/components/ContextualSaveBar/components/DiscardConfirmationModal/DiscardConfirmationModal.tsx", "syntaxKind": "PropertySignature", "name": "open", "value": "boolean", - "description": "A boolean property indicating whether the user menu is currently open" + "description": "" }, { - "filePath": "polaris-react/src/components/TopBar/components/UserMenu/UserMenu.tsx", + "filePath": "polaris-react/src/components/Frame/components/ContextualSaveBar/components/DiscardConfirmationModal/DiscardConfirmationModal.tsx", "syntaxKind": "MethodSignature", - "name": "onToggle", + "name": "onDiscard", "value": "() => void", - "description": "A callback function to handle opening and closing the user menu" + "description": "" + }, + { + "filePath": "polaris-react/src/components/Frame/components/ContextualSaveBar/components/DiscardConfirmationModal/DiscardConfirmationModal.tsx", + "syntaxKind": "MethodSignature", + "name": "onCancel", + "value": "() => void", + "description": "" } ], - "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}" + "value": "export interface DiscardConfirmationModalProps {\n open: boolean;\n onDiscard(): void;\n onCancel(): void;\n}" } }, "SecondaryProps": { @@ -26873,37 +26912,6 @@ "value": "interface SecondaryProps {\n expanded: boolean;\n children?: React.ReactNode;\n id?: string;\n}" } }, - "DiscardConfirmationModalProps": { - "polaris-react/src/components/Frame/components/ContextualSaveBar/components/DiscardConfirmationModal/DiscardConfirmationModal.tsx": { - "filePath": "polaris-react/src/components/Frame/components/ContextualSaveBar/components/DiscardConfirmationModal/DiscardConfirmationModal.tsx", - "name": "DiscardConfirmationModalProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Frame/components/ContextualSaveBar/components/DiscardConfirmationModal/DiscardConfirmationModal.tsx", - "syntaxKind": "PropertySignature", - "name": "open", - "value": "boolean", - "description": "" - }, - { - "filePath": "polaris-react/src/components/Frame/components/ContextualSaveBar/components/DiscardConfirmationModal/DiscardConfirmationModal.tsx", - "syntaxKind": "MethodSignature", - "name": "onDiscard", - "value": "() => void", - "description": "" - }, - { - "filePath": "polaris-react/src/components/Frame/components/ContextualSaveBar/components/DiscardConfirmationModal/DiscardConfirmationModal.tsx", - "syntaxKind": "MethodSignature", - "name": "onCancel", - "value": "() => void", - "description": "" - } - ], - "value": "export interface DiscardConfirmationModalProps {\n open: boolean;\n onDiscard(): void;\n onCancel(): void;\n}" - } - }, "TitleProps": { "polaris-react/src/components/Page/components/Header/components/Title/Title.tsx": { "filePath": "polaris-react/src/components/Page/components/Header/components/Title/Title.tsx", From 3094365be99199f39c7933f7a9edc05044c16d99 Mon Sep 17 00:00:00 2001 From: aveline Date: Tue, 29 Nov 2022 11:25:38 -0800 Subject: [PATCH 6/8] changeset --- .changeset/serious-tomatoes-dress.md | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 .changeset/serious-tomatoes-dress.md diff --git a/.changeset/serious-tomatoes-dress.md b/.changeset/serious-tomatoes-dress.md new file mode 100644 index 00000000000..3c40b08b50a --- /dev/null +++ b/.changeset/serious-tomatoes-dress.md @@ -0,0 +1,6 @@ +--- +'@shopify/polaris': minor +'polaris.shopify.com': patch +--- + +Rebuilt `ActionList` to use layout primitives From 49bf20433ac97bbf771464d42be435f3a31026d1 Mon Sep 17 00:00:00 2001 From: aveline Date: Thu, 1 Dec 2022 07:33:36 -0800 Subject: [PATCH 7/8] Update polaris-react/src/components/ActionList/components/Section/Section.tsx Co-authored-by: Lo Kim --- .../src/components/ActionList/components/Section/Section.tsx | 1 + 1 file changed, 1 insertion(+) diff --git a/polaris-react/src/components/ActionList/components/Section/Section.tsx b/polaris-react/src/components/ActionList/components/Section/Section.tsx index 8731d02fc77..921d6b83681 100644 --- a/polaris-react/src/components/ActionList/components/Section/Section.tsx +++ b/polaris-react/src/components/ActionList/components/Section/Section.tsx @@ -17,6 +17,7 @@ export interface SectionProps { actionRole?: 'option' | 'menuitem' | string; /** Callback when any item is clicked or keypressed */ onActionAnyItem?: ActionListItemDescriptor['onAction']; + /** Whether it is the first in a group of sections */ isFirst?: boolean; } From af02689e648e0d37042f0866345e7c4f3ddbb1e2 Mon Sep 17 00:00:00 2001 From: aveline Date: Thu, 1 Dec 2022 07:34:19 -0800 Subject: [PATCH 8/8] Update props.json --- polaris.shopify.com/src/data/props.json | 1936 +++++++++++------------ 1 file changed, 968 insertions(+), 968 deletions(-) diff --git a/polaris.shopify.com/src/data/props.json b/polaris.shopify.com/src/data/props.json index d8f5a1eeaea..7469f8c4fcf 100644 --- a/polaris.shopify.com/src/data/props.json +++ b/polaris.shopify.com/src/data/props.json @@ -7722,6 +7722,56 @@ "description": "" } }, + "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}" + } + }, "Props": { "polaris-react/src/components/AfterInitialMount/AfterInitialMount.tsx": { "filePath": "polaris-react/src/components/AfterInitialMount/AfterInitialMount.tsx", @@ -8103,56 +8153,6 @@ "value": "export interface AlphaCardProps {\n children?: React.ReactNode;\n /** Background color\n * @default 'surface'\n */\n background?: CardBackgroundColorTokenScale;\n /** The spacing around the card\n * @default {xs: '4', sm: '5'}\n * @example\n * padding='4'\n * padding={{xs: '2', sm: '3', md: '4', lg: '5', xl: '6'}}\n */\n padding?: Spacing;\n /** Border radius value above a set breakpoint */\n roundedAbove?: BreakpointsAlias;\n}" } }, - "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}" - } - }, "Align": { "polaris-react/src/components/AlphaStack/AlphaStack.tsx": { "filePath": "polaris-react/src/components/AlphaStack/AlphaStack.tsx", @@ -12411,39 +12411,6 @@ "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}" } }, - "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/EmptySearchResult/EmptySearchResult.tsx", - "syntaxKind": "PropertySignature", - "name": "withIllustration", - "value": "boolean", - "description": "", - "isOptional": true - } - ], - "value": "export interface EmptySearchResultProps {\n title: string;\n description?: string;\n withIllustration?: boolean;\n}" - } - }, "DropZoneFileType": { "polaris-react/src/components/DropZone/DropZone.tsx": { "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", @@ -12818,6 +12785,39 @@ "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/EmptySearchResult/EmptySearchResult.tsx", + "syntaxKind": "PropertySignature", + "name": "withIllustration", + "value": "boolean", + "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", @@ -12899,32 +12899,6 @@ "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}" } }, - "Description": { - "polaris-react/src/components/ExceptionList/ExceptionList.tsx": { - "filePath": "polaris-react/src/components/ExceptionList/ExceptionList.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Description", - "value": "string | React.ReactElement | (string | React.ReactElement)[]", - "description": "" - } - }, - "ExceptionListProps": { - "polaris-react/src/components/ExceptionList/ExceptionList.tsx": { - "filePath": "polaris-react/src/components/ExceptionList/ExceptionList.tsx", - "name": "ExceptionListProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/ExceptionList/ExceptionList.tsx", - "syntaxKind": "PropertySignature", - "name": "items", - "value": "Item[]", - "description": "Collection of items for list" - } - ], - "value": "export interface ExceptionListProps {\n /** Collection of items for list */\n items: Item[];\n}" - } - }, "BaseEventProps": { "polaris-react/src/components/EventListener/EventListener.tsx": { "filePath": "polaris-react/src/components/EventListener/EventListener.tsx", @@ -12997,6 +12971,32 @@ "value": "export interface EventListenerProps extends BaseEventProps {\n passive?: boolean;\n}" } }, + "Description": { + "polaris-react/src/components/ExceptionList/ExceptionList.tsx": { + "filePath": "polaris-react/src/components/ExceptionList/ExceptionList.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Description", + "value": "string | React.ReactElement | (string | React.ReactElement)[]", + "description": "" + } + }, + "ExceptionListProps": { + "polaris-react/src/components/ExceptionList/ExceptionList.tsx": { + "filePath": "polaris-react/src/components/ExceptionList/ExceptionList.tsx", + "name": "ExceptionListProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/ExceptionList/ExceptionList.tsx", + "syntaxKind": "PropertySignature", + "name": "items", + "value": "Item[]", + "description": "Collection of items for list" + } + ], + "value": "export interface ExceptionListProps {\n /** Collection of items for list */\n items: Item[];\n}" + } + }, "AppliedFilterInterface": { "polaris-react/src/components/Filters/Filters.tsx": { "filePath": "polaris-react/src/components/Filters/Filters.tsx", @@ -16157,6 +16157,31 @@ "value": "export interface PortalProps {\n children?: React.ReactNode;\n idPrefix?: string;\n onPortalCreated?(): void;\n}" } }, + "PortalsManagerProps": { + "polaris-react/src/components/PortalsManager/PortalsManager.tsx": { + "filePath": "polaris-react/src/components/PortalsManager/PortalsManager.tsx", + "name": "PortalsManagerProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/PortalsManager/PortalsManager.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "" + }, + { + "filePath": "polaris-react/src/components/PortalsManager/PortalsManager.tsx", + "syntaxKind": "PropertySignature", + "name": "container", + "value": "HTMLDivElement", + "description": "", + "isOptional": true + } + ], + "value": "export interface PortalsManagerProps {\n children: React.ReactNode;\n container?: PortalsContainerElement;\n}" + } + }, "Positioning": { "polaris-react/src/components/PositionedOverlay/PositionedOverlay.tsx": { "filePath": "polaris-react/src/components/PositionedOverlay/PositionedOverlay.tsx", @@ -16377,29 +16402,109 @@ "value": "export interface ProgressBarProps {\n /**\n * The progression of certain tasks\n * @default 0\n */\n progress?: number;\n /**\n * Size of progressbar\n * @default 'medium'\n */\n size?: Size;\n /**\n * Color of progressbar\n * @default 'highlight'\n */\n color?: Color;\n /**\n * Whether the fill animation is triggered\n * @default 'true'\n */\n animated?: boolean;\n /**\n * Id (ids) of element (elements) that describes progressbar\n */\n ariaLabelledBy?: string;\n}" } }, - "PortalsManagerProps": { - "polaris-react/src/components/PortalsManager/PortalsManager.tsx": { - "filePath": "polaris-react/src/components/PortalsManager/PortalsManager.tsx", - "name": "PortalsManagerProps", + "RadioButtonProps": { + "polaris-react/src/components/RadioButton/RadioButton.tsx": { + "filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx", + "name": "RadioButtonProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/PortalsManager/PortalsManager.tsx", + "filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "" + "name": "ariaDescribedBy", + "value": "string", + "description": "Indicates the ID of the element that describes the the radio button", + "isOptional": true }, { - "filePath": "polaris-react/src/components/PortalsManager/PortalsManager.tsx", + "filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx", "syntaxKind": "PropertySignature", - "name": "container", - "value": "HTMLDivElement", - "description": "", + "name": "label", + "value": "React.ReactNode", + "description": "Label for the radio button" + }, + { + "filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx", + "syntaxKind": "PropertySignature", + "name": "labelHidden", + "value": "boolean", + "description": "Visually hide the label", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx", + "syntaxKind": "PropertySignature", + "name": "checked", + "value": "boolean", + "description": "Radio button is selected", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx", + "syntaxKind": "PropertySignature", + "name": "helpText", + "value": "React.ReactNode", + "description": "Additional text to aid in use", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Disable input", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "ID for form input", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "Name for form input", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "Value for form input", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx", + "syntaxKind": "MethodSignature", + "name": "onChange", + "value": "(newValue: boolean, id: string) => void", + "description": "Callback when the radio button is toggled", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx", + "syntaxKind": "MethodSignature", + "name": "onFocus", + "value": "() => void", + "description": "Callback when radio button is focussed", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx", + "syntaxKind": "MethodSignature", + "name": "onBlur", + "value": "() => void", + "description": "Callback when focus is removed", "isOptional": true } ], - "value": "export interface PortalsManagerProps {\n children: React.ReactNode;\n container?: PortalsContainerElement;\n}" + "value": "export interface RadioButtonProps {\n /** Indicates the ID of the element that describes the the radio button*/\n ariaDescribedBy?: string;\n /** Label for the radio button */\n label: React.ReactNode;\n /** Visually hide the label */\n labelHidden?: boolean;\n /** Radio button is selected */\n checked?: boolean;\n /** Additional text to aid in use */\n helpText?: React.ReactNode;\n /** Disable input */\n disabled?: boolean;\n /** ID for form input */\n id?: string;\n /** Name for form input */\n name?: string;\n /** Value for form input */\n value?: string;\n /** Callback when the radio button is toggled */\n onChange?(newValue: boolean, id: string): void;\n /** Callback when radio button is focussed */\n onFocus?(): void;\n /** Callback when focus is removed */\n onBlur?(): void;\n}" } }, "BaseProps": { @@ -16820,111 +16925,6 @@ "value": "interface PropsFromWrapper {\n context: React.ContextType;\n i18n: ReturnType;\n}" } }, - "RadioButtonProps": { - "polaris-react/src/components/RadioButton/RadioButton.tsx": { - "filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx", - "name": "RadioButtonProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx", - "syntaxKind": "PropertySignature", - "name": "ariaDescribedBy", - "value": "string", - "description": "Indicates the ID of the element that describes the the radio button", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx", - "syntaxKind": "PropertySignature", - "name": "label", - "value": "React.ReactNode", - "description": "Label for the radio button" - }, - { - "filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx", - "syntaxKind": "PropertySignature", - "name": "labelHidden", - "value": "boolean", - "description": "Visually hide the label", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx", - "syntaxKind": "PropertySignature", - "name": "checked", - "value": "boolean", - "description": "Radio button is selected", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx", - "syntaxKind": "PropertySignature", - "name": "helpText", - "value": "React.ReactNode", - "description": "Additional text to aid in use", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "Disable input", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "ID for form input", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "Name for form input", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "Value for form input", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx", - "syntaxKind": "MethodSignature", - "name": "onChange", - "value": "(newValue: boolean, id: string) => void", - "description": "Callback when the radio button is toggled", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx", - "syntaxKind": "MethodSignature", - "name": "onFocus", - "value": "() => void", - "description": "Callback when radio button is focussed", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx", - "syntaxKind": "MethodSignature", - "name": "onBlur", - "value": "() => void", - "description": "Callback when focus is removed", - "isOptional": true - } - ], - "value": "export interface RadioButtonProps {\n /** Indicates the ID of the element that describes the the radio button*/\n ariaDescribedBy?: string;\n /** Label for the radio button */\n label: React.ReactNode;\n /** Visually hide the label */\n labelHidden?: boolean;\n /** Radio button is selected */\n checked?: boolean;\n /** Additional text to aid in use */\n helpText?: React.ReactNode;\n /** Disable input */\n disabled?: boolean;\n /** ID for form input */\n id?: string;\n /** Name for form input */\n name?: string;\n /** Value for form input */\n value?: string;\n /** Callback when the radio button is toggled */\n onChange?(newValue: boolean, id: string): void;\n /** Callback when radio button is focussed */\n onFocus?(): void;\n /** Callback when focus is removed */\n onBlur?(): void;\n}" - } - }, "ResourceListProps": { "polaris-react/src/components/ResourceList/ResourceList.tsx": { "filePath": "polaris-react/src/components/ResourceList/ResourceList.tsx", @@ -21992,293 +21992,47 @@ "value": "export interface PortalsManager {\n container: PortalsContainerElement;\n}" } }, - "SectionProps": { - "polaris-react/src/components/ActionList/components/Section/Section.tsx": { - "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", - "name": "SectionProps", + "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/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", + "filePath": "polaris-react/src/components/ButtonGroup/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "hasMultipleSections", - "value": "boolean", - "description": "Should there be multiple sections" - }, + "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/ActionList/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/Connected/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "actionRole", - "value": "string", - "description": "Defines a specific role attribute for each action in the list", - "isOptional": true + "name": "position", + "value": "ItemPosition", + "description": "Position of the item" }, { - "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/Connected/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "onActionAnyItem", - "value": "() => void", - "description": "Callback when any item is clicked or keypressed", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "isFirst", - "value": "boolean", - "description": "", - "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 isFirst?: boolean;\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", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "secondary", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "fullWidth", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "oneHalf", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "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/Listbox/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "divider", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Listbox/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "ReactNode", - "description": "", - "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", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "flush", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "subdued", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "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/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "icon", - "value": "any", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "fill", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "rollup", - "value": "{ after: number; view: string; hide: string; activePath: string; }", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "action", - "value": "{ icon: any; accessibilityLabel: string; onClick(): void; tooltip?: TooltipProps; }", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "separator", - "value": "boolean", - "description": "", - "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", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", - "isOptional": true - } - ], - "value": "export interface SectionProps {\n children?: React.ReactNode;\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", + "name": "children", + "value": "React.ReactNode", + "description": "Item content", "isOptional": true } ], @@ -22483,8 +22237,70 @@ ], "value": "export interface ItemProps extends ItemURLDetails {\n icon?: IconProps['source'];\n badge?: ReactNode;\n label: string;\n disabled?: boolean;\n accessibilityLabel?: string;\n selected?: boolean;\n exactMatch?: boolean;\n new?: boolean;\n subNavigationItems?: SubNavigationItem[];\n secondaryAction?: SecondaryAction;\n onClick?(): void;\n onToggleExpandedState?(): void;\n expanded?: boolean;\n shouldResizeIcon?: boolean;\n truncateText?: boolean;\n}" }, - "polaris-react/src/components/Stack/components/Item/Item.tsx": { - "filePath": "polaris-react/src/components/Stack/components/Item/Item.tsx", + "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/Tabs/components/Item/Item.tsx", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", + "syntaxKind": "PropertySignature", + "name": "focused", + "value": "boolean", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", + "syntaxKind": "PropertySignature", + "name": "panelID", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", + "syntaxKind": "PropertySignature", + "name": "url", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "", + "isOptional": true + }, + { + "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/Stack/components/Item/Item.tsx": { + "filePath": "polaris-react/src/components/Stack/components/Item/Item.tsx", "name": "ItemProps", "description": "", "members": [ @@ -22507,107 +22323,417 @@ ], "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", + "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/Tabs/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Filters/components/ConnectedFilterControl/components/Item/Item.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "", + "isOptional": true + } + ], + "value": "interface ItemProps {\n children?: React.ReactNode;\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 + }, + { + "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "isFirst", + "value": "boolean", + "description": "", + "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 isFirst?: boolean;\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", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "secondary", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "fullWidth", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "oneHalf", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "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/Listbox/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "divider", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Listbox/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "ReactNode", + "description": "", + "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", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "flush", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "subdued", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "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/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "icon", + "value": "any", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "fill", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "rollup", + "value": "{ after: number; view: string; hide: string; activePath: string; }", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "action", + "value": "{ icon: any; accessibilityLabel: string; onClick(): void; tooltip?: TooltipProps; }", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "separator", + "value": "boolean", + "description": "", + "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", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "", + "isOptional": true + } + ], + "value": "export interface SectionProps {\n children?: React.ReactNode;\n}" + } + }, + "MeasuredActions": { + "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx": { + "filePath": "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx", + "name": "MeasuredActions", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx", + "syntaxKind": "PropertySignature", + "name": "showable", + "value": "MenuActionDescriptor[]", + "description": "" + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx", + "syntaxKind": "PropertySignature", + "name": "rolledUp", + "value": "(MenuActionDescriptor | MenuGroupDescriptor)[]", + "description": "" + } + ], + "value": "interface MeasuredActions {\n showable: MenuActionDescriptor[];\n rolledUp: (MenuActionDescriptor | MenuGroupDescriptor)[];\n}" + } + }, + "MenuGroupProps": { + "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx": { + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "name": "MenuGroupProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "Visually hidden menu description for screen readers", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "PropertySignature", + "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": "id", + "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": "" + "description": "Menu group title" }, { - "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", "syntaxKind": "PropertySignature", - "name": "focused", - "value": "boolean", - "description": "" + "name": "actions", + "value": "ActionListItemDescriptor[]", + "description": "List of actions" }, { - "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", "syntaxKind": "PropertySignature", - "name": "panelID", - "value": "string", - "description": "", + "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/ActionMenu/components/MenuGroup/MenuGroup.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/ActionMenu/components/MenuGroup/MenuGroup.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/ActionMenu/components/MenuGroup/MenuGroup.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", - "syntaxKind": "MethodSignature", - "name": "onClick", + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "onActionAnyItem", "value": "() => void", - "description": "", + "description": "Callback when any action takes place", "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/ActionMenu/components/MenuGroup/MenuGroup.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}" - } - }, - "MeasuredActions": { - "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx": { - "filePath": "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx", - "name": "MeasuredActions", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx", - "syntaxKind": "PropertySignature", - "name": "showable", - "value": "MenuActionDescriptor[]", - "description": "" - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx", - "syntaxKind": "PropertySignature", - "name": "rolledUp", - "value": "(MenuActionDescriptor | MenuGroupDescriptor)[]", - "description": "" - } - ], - "value": "interface MeasuredActions {\n showable: MenuActionDescriptor[];\n rolledUp: (MenuActionDescriptor | MenuGroupDescriptor)[];\n}" + "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": { @@ -22644,6 +22770,15 @@ "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}" } }, + "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": "" + } + }, "SecondaryAction": { "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx": { "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", @@ -23193,150 +23328,6 @@ "value": "interface MappedAction extends ActionListItemDescriptor {\n wrapOverflow?: boolean;\n}" } }, - "MappedOption": { - "polaris-react/src/components/Autocomplete/components/MappedOption/MappedOption.tsx": { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedOption/MappedOption.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "MappedOption", - "value": "ArrayElement & {\n selected: boolean;\n singleSelection: boolean;\n}", - "description": "" - } - }, - "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/MenuGroup/MenuGroup.tsx", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "Visually hidden menu description for screen readers", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "PropertySignature", - "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": "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}" - } - }, - "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": "" - } - }, "PipProps": { "polaris-react/src/components/Badge/components/Pip/Pip.tsx": { "filePath": "polaris-react/src/components/Badge/components/Pip/Pip.tsx", @@ -23371,6 +23362,15 @@ "value": "export interface PipProps {\n status?: Status;\n progress?: Progress;\n accessibilityLabelOverride?: string;\n}" } }, + "BulkActionButtonProps": { + "polaris-react/src/components/BulkActions/components/BulkActionButton/BulkActionButton.tsx": { + "filePath": "polaris-react/src/components/BulkActions/components/BulkActionButton/BulkActionButton.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "BulkActionButtonProps", + "value": "{\n disclosure?: boolean;\n indicator?: boolean;\n handleMeasurement?(width: number): void;\n} & DisableableAction", + "description": "" + } + }, "BulkActionsMenuProps": { "polaris-react/src/components/BulkActions/components/BulkActionMenu/BulkActionMenu.tsx": { "filePath": "polaris-react/src/components/BulkActions/components/BulkActionMenu/BulkActionMenu.tsx", @@ -23613,24 +23613,6 @@ "value": "export interface HuePickerProps {\n hue: number;\n onChange(hue: number): void;\n}" } }, - "CardSubsectionProps": { - "polaris-react/src/components/Card/components/Subsection/Subsection.tsx": { - "filePath": "polaris-react/src/components/Card/components/Subsection/Subsection.tsx", - "name": "CardSubsectionProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Card/components/Subsection/Subsection.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", - "isOptional": true - } - ], - "value": "export interface CardSubsectionProps {\n children?: React.ReactNode;\n}" - } - }, "SlidableProps": { "polaris-react/src/components/ColorPicker/components/Slidable/Slidable.tsx": { "filePath": "polaris-react/src/components/ColorPicker/components/Slidable/Slidable.tsx", @@ -23672,6 +23654,24 @@ "value": "export interface SlidableProps {\n draggerX?: number;\n draggerY?: number;\n onChange(position: Position): void;\n onDraggerHeight?(height: number): void;\n}" } }, + "CardSubsectionProps": { + "polaris-react/src/components/Card/components/Subsection/Subsection.tsx": { + "filePath": "polaris-react/src/components/Card/components/Subsection/Subsection.tsx", + "name": "CardSubsectionProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Card/components/Subsection/Subsection.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "", + "isOptional": true + } + ], + "value": "export interface CardSubsectionProps {\n children?: React.ReactNode;\n}" + } + }, "ItemPosition": { "polaris-react/src/components/Connected/components/Item/Item.tsx": { "filePath": "polaris-react/src/components/Connected/components/Item/Item.tsx", @@ -24235,6 +24235,32 @@ "value": "export interface MonthProps {\n focusedDate?: Date;\n selected?: Range;\n hoverDate?: Date;\n month: number;\n year: number;\n disableDatesBefore?: Date;\n disableDatesAfter?: Date;\n disableSpecificDates?: Date[];\n allowRange?: boolean;\n weekStartsOn: number;\n accessibilityLabelPrefixes: [string | undefined, string];\n onChange?(date: Range): void;\n onHover?(hoverEnd: Date): void;\n onFocus?(date: Date): void;\n}" } }, + "FileUploadProps": { + "polaris-react/src/components/DropZone/components/FileUpload/FileUpload.tsx": { + "filePath": "polaris-react/src/components/DropZone/components/FileUpload/FileUpload.tsx", + "name": "FileUploadProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/DropZone/components/FileUpload/FileUpload.tsx", + "syntaxKind": "PropertySignature", + "name": "actionTitle", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/DropZone/components/FileUpload/FileUpload.tsx", + "syntaxKind": "PropertySignature", + "name": "actionHint", + "value": "string", + "description": "", + "isOptional": true + } + ], + "value": "export interface FileUploadProps {\n actionTitle?: string;\n actionHint?: string;\n}" + } + }, "WeekdayProps": { "polaris-react/src/components/DatePicker/components/Weekday/Weekday.tsx": { "filePath": "polaris-react/src/components/DatePicker/components/Weekday/Weekday.tsx", @@ -24447,32 +24473,6 @@ "value": "interface ComputedProperty {\n [key: string]: number;\n}" } }, - "FileUploadProps": { - "polaris-react/src/components/DropZone/components/FileUpload/FileUpload.tsx": { - "filePath": "polaris-react/src/components/DropZone/components/FileUpload/FileUpload.tsx", - "name": "FileUploadProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/DropZone/components/FileUpload/FileUpload.tsx", - "syntaxKind": "PropertySignature", - "name": "actionTitle", - "value": "string", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/DropZone/components/FileUpload/FileUpload.tsx", - "syntaxKind": "PropertySignature", - "name": "actionHint", - "value": "string", - "description": "", - "isOptional": true - } - ], - "value": "export interface FileUploadProps {\n actionTitle?: string;\n actionHint?: string;\n}" - } - }, "GroupProps": { "polaris-react/src/components/FormLayout/components/Group/Group.tsx": { "filePath": "polaris-react/src/components/FormLayout/components/Group/Group.tsx", @@ -25564,6 +25564,65 @@ ] } }, + "PaneProps": { + "polaris-react/src/components/Popover/components/Pane/Pane.tsx": { + "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", + "name": "PaneProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", + "syntaxKind": "PropertySignature", + "name": "fixed", + "value": "boolean", + "description": "Fix the pane to the top of the popover", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", + "syntaxKind": "PropertySignature", + "name": "sectioned", + "value": "boolean", + "description": "Automatically wrap children in padded sections", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "The pane content", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", + "syntaxKind": "PropertySignature", + "name": "height", + "value": "string", + "description": "Sets a fixed height and max-height on the Scrollable", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", + "syntaxKind": "MethodSignature", + "name": "onScrolledToBottom", + "value": "() => void", + "description": "Callback when the bottom of the popover is reached by mouse or keyboard", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", + "syntaxKind": "PropertySignature", + "name": "captureOverscroll", + "value": "boolean", + "description": "Prevents page scrolling when the end of the scrollable Popover content is reached", + "isOptional": true, + "defaultValue": "false" + } + ], + "value": "export interface PaneProps {\n /** Fix the pane to the top of the popover */\n fixed?: boolean;\n /** Automatically wrap children in padded sections */\n sectioned?: boolean;\n /** The pane content */\n children?: React.ReactNode;\n /** Sets a fixed height and max-height on the Scrollable */\n height?: string;\n /** Callback when the bottom of the popover is reached by mouse or keyboard */\n onScrolledToBottom?(): void;\n /**\n * Prevents page scrolling when the end of the scrollable Popover content is reached\n * @default false\n */\n captureOverscroll?: boolean;\n}" + } + }, "PrimaryAction": { "polaris-react/src/components/Page/components/Header/Header.tsx": { "filePath": "polaris-react/src/components/Page/components/Header/Header.tsx", @@ -25686,65 +25745,6 @@ "value": "interface PrimaryAction\n extends DestructableAction,\n DisableableAction,\n LoadableAction,\n IconableAction,\n TooltipAction {\n /** Provides extra visual weight and identifies the primary action in a set of buttons */\n primary?: boolean;\n}" } }, - "PaneProps": { - "polaris-react/src/components/Popover/components/Pane/Pane.tsx": { - "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", - "name": "PaneProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", - "syntaxKind": "PropertySignature", - "name": "fixed", - "value": "boolean", - "description": "Fix the pane to the top of the popover", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", - "syntaxKind": "PropertySignature", - "name": "sectioned", - "value": "boolean", - "description": "Automatically wrap children in padded sections", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "The pane content", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", - "syntaxKind": "PropertySignature", - "name": "height", - "value": "string", - "description": "Sets a fixed height and max-height on the Scrollable", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", - "syntaxKind": "MethodSignature", - "name": "onScrolledToBottom", - "value": "() => void", - "description": "Callback when the bottom of the popover is reached by mouse or keyboard", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", - "syntaxKind": "PropertySignature", - "name": "captureOverscroll", - "value": "boolean", - "description": "Prevents page scrolling when the end of the scrollable Popover content is reached", - "isOptional": true, - "defaultValue": "false" - } - ], - "value": "export interface PaneProps {\n /** Fix the pane to the top of the popover */\n fixed?: boolean;\n /** Automatically wrap children in padded sections */\n sectioned?: boolean;\n /** The pane content */\n children?: React.ReactNode;\n /** Sets a fixed height and max-height on the Scrollable */\n height?: string;\n /** Callback when the bottom of the popover is reached by mouse or keyboard */\n onScrolledToBottom?(): void;\n /**\n * Prevents page scrolling when the end of the scrollable Popover content is reached\n * @default false\n */\n captureOverscroll?: boolean;\n}" - } - }, "PopoverCloseSource": { "polaris-react/src/components/Popover/components/PopoverOverlay/PopoverOverlay.tsx": { "filePath": "polaris-react/src/components/Popover/components/PopoverOverlay/PopoverOverlay.tsx", @@ -26366,64 +26366,23 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/Tabs/components/Tab/Tab.tsx", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Tabs/components/Tab/Tab.tsx", - "syntaxKind": "MethodSignature", - "name": "onClick", - "value": "(id: string) => void", - "description": "", - "isOptional": true - } - ], - "value": "export interface TabProps {\n id: string;\n focused?: boolean;\n siblingTabHasFocus?: boolean;\n selected?: boolean;\n panelID?: string;\n children?: React.ReactNode;\n url?: string;\n measuring?: boolean;\n accessibilityLabel?: string;\n onClick?(id: string): void;\n}" - } - }, - "ResizerProps": { - "polaris-react/src/components/TextField/components/Resizer/Resizer.tsx": { - "filePath": "polaris-react/src/components/TextField/components/Resizer/Resizer.tsx", - "name": "ResizerProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/TextField/components/Resizer/Resizer.tsx", - "syntaxKind": "PropertySignature", - "name": "contents", - "value": "string", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/TextField/components/Resizer/Resizer.tsx", - "syntaxKind": "PropertySignature", - "name": "currentHeight", - "value": "number", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/TextField/components/Resizer/Resizer.tsx", + "filePath": "polaris-react/src/components/Tabs/components/Tab/Tab.tsx", "syntaxKind": "PropertySignature", - "name": "minimumLines", - "value": "number", + "name": "accessibilityLabel", + "value": "string", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/TextField/components/Resizer/Resizer.tsx", + "filePath": "polaris-react/src/components/Tabs/components/Tab/Tab.tsx", "syntaxKind": "MethodSignature", - "name": "onHeightChange", - "value": "(height: number) => void", - "description": "" + "name": "onClick", + "value": "(id: string) => void", + "description": "", + "isOptional": true } ], - "value": "export interface ResizerProps {\n contents?: string;\n currentHeight?: number | null;\n minimumLines?: number;\n onHeightChange(height: number): void;\n}" + "value": "export interface TabProps {\n id: string;\n focused?: boolean;\n siblingTabHasFocus?: boolean;\n selected?: boolean;\n panelID?: string;\n children?: React.ReactNode;\n url?: string;\n measuring?: boolean;\n accessibilityLabel?: string;\n onClick?(id: string): void;\n}" } }, "TabMeasurements": { @@ -26509,6 +26468,47 @@ "value": "export interface TabMeasurerProps {\n tabToFocus: number;\n siblingTabHasFocus: boolean;\n activator: React.ReactElement;\n selected: number;\n tabs: TabDescriptor[];\n handleMeasurement(measurements: TabMeasurements): void;\n}" } }, + "ResizerProps": { + "polaris-react/src/components/TextField/components/Resizer/Resizer.tsx": { + "filePath": "polaris-react/src/components/TextField/components/Resizer/Resizer.tsx", + "name": "ResizerProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/TextField/components/Resizer/Resizer.tsx", + "syntaxKind": "PropertySignature", + "name": "contents", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/TextField/components/Resizer/Resizer.tsx", + "syntaxKind": "PropertySignature", + "name": "currentHeight", + "value": "number", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/TextField/components/Resizer/Resizer.tsx", + "syntaxKind": "PropertySignature", + "name": "minimumLines", + "value": "number", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/TextField/components/Resizer/Resizer.tsx", + "syntaxKind": "MethodSignature", + "name": "onHeightChange", + "value": "(height: number) => void", + "description": "" + } + ], + "value": "export interface ResizerProps {\n contents?: string;\n currentHeight?: number | null;\n minimumLines?: number;\n onHeightChange(height: number): void;\n}" + } + }, "HandleStepFn": { "polaris-react/src/components/TextField/components/Spinner/Spinner.tsx": { "filePath": "polaris-react/src/components/TextField/components/Spinner/Spinner.tsx", @@ -26588,6 +26588,48 @@ "value": "export interface TooltipOverlayProps {\n id: string;\n active: boolean;\n preventInteraction?: PositionedOverlayProps['preventInteraction'];\n preferredPosition?: PositionedOverlayProps['preferredPosition'];\n children?: React.ReactNode;\n activator: HTMLElement;\n accessibilityLabel?: string;\n onClose(): 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}" + } + }, "MenuProps": { "polaris-react/src/components/TopBar/components/Menu/Menu.tsx": { "filePath": "polaris-react/src/components/TopBar/components/Menu/Menu.tsx", @@ -26649,46 +26691,84 @@ "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", + "SearchFieldProps": { + "polaris-react/src/components/TopBar/components/SearchField/SearchField.tsx": { + "filePath": "polaris-react/src/components/TopBar/components/SearchField/SearchField.tsx", + "name": "SearchFieldProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/TopBar/components/Search/Search.tsx", + "filePath": "polaris-react/src/components/TopBar/components/SearchField/SearchField.tsx", "syntaxKind": "PropertySignature", - "name": "visible", - "value": "boolean", - "description": "Toggles whether or not the search is visible", + "name": "value", + "value": "string", + "description": "Initial value for the input" + }, + { + "filePath": "polaris-react/src/components/TopBar/components/SearchField/SearchField.tsx", + "syntaxKind": "PropertySignature", + "name": "placeholder", + "value": "string", + "description": "Hint text to display", "isOptional": true }, { - "filePath": "polaris-react/src/components/TopBar/components/Search/Search.tsx", + "filePath": "polaris-react/src/components/TopBar/components/SearchField/SearchField.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "The content to display inside the search", + "name": "focused", + "value": "boolean", + "description": "Force the focus state on the input", "isOptional": true }, { - "filePath": "polaris-react/src/components/TopBar/components/Search/Search.tsx", + "filePath": "polaris-react/src/components/TopBar/components/SearchField/SearchField.tsx", "syntaxKind": "PropertySignature", - "name": "overlayVisible", + "name": "active", "value": "boolean", - "description": "Whether or not the search results overlay has a visible backdrop", + "description": "Force a state where search is active but the text field component is not focused", "isOptional": true }, { - "filePath": "polaris-react/src/components/TopBar/components/Search/Search.tsx", + "filePath": "polaris-react/src/components/TopBar/components/SearchField/SearchField.tsx", "syntaxKind": "MethodSignature", - "name": "onDismiss", + "name": "onChange", + "value": "(value: string) => void", + "description": "Callback when value is changed" + }, + { + "filePath": "polaris-react/src/components/TopBar/components/SearchField/SearchField.tsx", + "syntaxKind": "MethodSignature", + "name": "onFocus", "value": "() => void", - "description": "Callback when the search is dismissed", + "description": "Callback when input is focused", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/TopBar/components/SearchField/SearchField.tsx", + "syntaxKind": "MethodSignature", + "name": "onBlur", + "value": "() => void", + "description": "Callback when focus is removed", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/TopBar/components/SearchField/SearchField.tsx", + "syntaxKind": "MethodSignature", + "name": "onCancel", + "value": "() => void", + "description": "Callback when search field cancel button is clicked", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/TopBar/components/SearchField/SearchField.tsx", + "syntaxKind": "PropertySignature", + "name": "showFocusBorder", + "value": "boolean", + "description": "Show a border when the search field is focused", "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}" + "value": "export interface SearchFieldProps {\n /** Initial value for the input */\n value: string;\n /** Hint text to display */\n placeholder?: string;\n /** Force the focus state on the input */\n focused?: boolean;\n /** Force a state where search is active but the text field component is not focused */\n active?: boolean;\n /** Callback when value is changed */\n onChange(value: string): void;\n /** Callback when input is focused */\n onFocus?(): void;\n /** Callback when focus is removed */\n onBlur?(): void;\n /** Callback when search field cancel button is clicked */\n onCancel?(): void;\n /** Show a border when the search field is focused */\n showFocusBorder?: boolean;\n}" } }, "UserMenuProps": { @@ -26768,86 +26848,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}" } }, - "SearchFieldProps": { - "polaris-react/src/components/TopBar/components/SearchField/SearchField.tsx": { - "filePath": "polaris-react/src/components/TopBar/components/SearchField/SearchField.tsx", - "name": "SearchFieldProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/TopBar/components/SearchField/SearchField.tsx", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "Initial value for the input" - }, - { - "filePath": "polaris-react/src/components/TopBar/components/SearchField/SearchField.tsx", - "syntaxKind": "PropertySignature", - "name": "placeholder", - "value": "string", - "description": "Hint text to display", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/TopBar/components/SearchField/SearchField.tsx", - "syntaxKind": "PropertySignature", - "name": "focused", - "value": "boolean", - "description": "Force the focus state on the input", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/TopBar/components/SearchField/SearchField.tsx", - "syntaxKind": "PropertySignature", - "name": "active", - "value": "boolean", - "description": "Force a state where search is active but the text field component is not focused", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/TopBar/components/SearchField/SearchField.tsx", - "syntaxKind": "MethodSignature", - "name": "onChange", - "value": "(value: string) => void", - "description": "Callback when value is changed" - }, - { - "filePath": "polaris-react/src/components/TopBar/components/SearchField/SearchField.tsx", - "syntaxKind": "MethodSignature", - "name": "onFocus", - "value": "() => void", - "description": "Callback when input is focused", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/TopBar/components/SearchField/SearchField.tsx", - "syntaxKind": "MethodSignature", - "name": "onBlur", - "value": "() => void", - "description": "Callback when focus is removed", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/TopBar/components/SearchField/SearchField.tsx", - "syntaxKind": "MethodSignature", - "name": "onCancel", - "value": "() => void", - "description": "Callback when search field cancel button is clicked", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/TopBar/components/SearchField/SearchField.tsx", - "syntaxKind": "PropertySignature", - "name": "showFocusBorder", - "value": "boolean", - "description": "Show a border when the search field is focused", - "isOptional": true - } - ], - "value": "export interface SearchFieldProps {\n /** Initial value for the input */\n value: string;\n /** Hint text to display */\n placeholder?: string;\n /** Force the focus state on the input */\n focused?: boolean;\n /** Force a state where search is active but the text field component is not focused */\n active?: boolean;\n /** Callback when value is changed */\n onChange(value: string): void;\n /** Callback when input is focused */\n onFocus?(): void;\n /** Callback when focus is removed */\n onBlur?(): void;\n /** Callback when search field cancel button is clicked */\n onCancel?(): void;\n /** Show a border when the search field is focused */\n showFocusBorder?: boolean;\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",