diff --git a/.changeset/gorgeous-dryers-wash.md b/.changeset/gorgeous-dryers-wash.md new file mode 100644 index 00000000000..d5f852411f1 --- /dev/null +++ b/.changeset/gorgeous-dryers-wash.md @@ -0,0 +1,7 @@ +--- +'@shopify/polaris': minor +'@shopify/polaris-tokens': minor +--- + +- Added border width prop to `Box` +- Exported color token subset alias types from tokens package and remove from `Box` diff --git a/polaris-react/src/components/Box/Box.scss b/polaris-react/src/components/Box/Box.scss index ec7486bb8d1..7e839dcd6fe 100644 --- a/polaris-react/src/components/Box/Box.scss +++ b/polaris-react/src/components/Box/Box.scss @@ -23,6 +23,7 @@ --pc-box-padding-inline-end: initial; --pc-box-padding-block-start: initial; --pc-box-width: initial; + --pc-box-border-width: var(--p-border-width-1); background-color: var(--pc-box-background); box-shadow: var(--pc-box-shadow); border-radius: var(--pc-box-border-radius); @@ -46,6 +47,22 @@ border-inline-start: var(--pc-box-border-inline-start, var(--pc-box-border)); border-inline-end: var(--pc-box-border-inline-end, var(--pc-box-border)); border-block-start: var(--pc-box-border-block-start, var(--pc-box-border)); + border-block-start-width: var( + --pc-box-border-block-start-width, + var(--pc-box-border-width) + ); + border-block-end-width: var( + --pc-box-border-block-end-width, + var(--pc-box-border-width) + ); + border-inline-start-width: var( + --pc-box-border-inline-start-width, + var(--pc-box-border-width) + ); + border-inline-end-width: var( + --pc-box-border-inline-end-width, + var(--pc-box-border-width) + ); color: var(--pc-box-color); min-height: var(--pc-box-min-height); min-width: var(--pc-box-min-width); diff --git a/polaris-react/src/components/Box/Box.stories.tsx b/polaris-react/src/components/Box/Box.stories.tsx new file mode 100644 index 00000000000..d35c249f85a --- /dev/null +++ b/polaris-react/src/components/Box/Box.stories.tsx @@ -0,0 +1,32 @@ +import React from 'react'; +import type {ComponentMeta} from '@storybook/react'; +import {Box, Icon} from '@shopify/polaris'; +import {PaintBrushMajor} from '@shopify/polaris-icons'; + +export default { + component: Box, +} as ComponentMeta; + +export function Default() { + return ( + + + + ); +} + +export function BoxWithDarkBorder() { + return ( + + + + ); +} + +export function BoxWithBorderRadius() { + return ( + + + + ); +} diff --git a/polaris-react/src/components/Box/Box.tsx b/polaris-react/src/components/Box/Box.tsx index fd608b5f224..09ffbc4feab 100644 --- a/polaris-react/src/components/Box/Box.tsx +++ b/polaris-react/src/components/Box/Box.tsx @@ -1,5 +1,11 @@ import React, {createElement, forwardRef} from 'react'; import type { + ColorsActionTokenAlias, + ColorsBackdropTokenAlias, + ColorsBackgroundTokenAlias, + ColorsOverlayTokenAlias, + ColorsSurfaceTokenAlias, + ShapeBorderWidthScale, DepthShadowAlias, SpacingSpaceScale, } from '@shopify/polaris-tokens'; @@ -12,72 +18,6 @@ type Element = 'div' | 'span' | 'section'; type Overflow = 'hidden' | 'scroll'; -export type BackgroundColorTokenScale = - | 'action-critical' - | 'action-critical-depressed' - | 'action-critical-disabled' - | 'action-critical-hovered' - | 'action-critical-pressed' - | 'action-primary' - | 'action-primary-depressed' - | 'action-primary-disabled' - | 'action-primary-hovered' - | 'action-primary-pressed' - | 'action-secondary' - | 'action-secondary-depressed' - | 'action-secondary-disabled' - | 'action-secondary-hovered' - | 'action-secondary-hovered-dark' - | 'action-secondary-pressed' - | 'action-secondary-pressed-dark' - | 'backdrop' - | 'background' - | 'background-hovered' - | 'background-pressed' - | 'background-selected' - | 'overlay' - | 'surface' - | 'surface-attention' - | 'surface-critical' - | 'surface-critical-subdued' - | 'surface-critical-subdued-depressed' - | 'surface-critical-subdued-hovered' - | 'surface-critical-subdued-pressed' - | 'surface-dark' - | 'surface-depressed' - | 'surface-disabled' - | 'surface-highlight' - | 'surface-highlight-subdued' - | 'surface-highlight-subdued-hovered' - | 'surface-highlight-subdued-pressed' - | 'surface-hovered' - | 'surface-hovered-dark' - | 'surface-neutral' - | 'surface-neutral-disabled' - | 'surface-neutral-hovered' - | 'surface-neutral-pressed' - | 'surface-neutral-subdued' - | 'surface-neutral-subdued-dark' - | 'surface-pressed' - | 'surface-pressed-dark' - | 'surface-primary-selected' - | 'surface-primary-selected-hovered' - | 'surface-primary-selected-pressed' - | 'surface-search-field' - | 'surface-search-field-dark' - | 'surface-selected' - | 'surface-selected-hovered' - | 'surface-selected-pressed' - | 'surface-subdued' - | 'surface-success' - | 'surface-success-subdued' - | 'surface-success-subdued-hovered' - | 'surface-success-subdued-pressed' - | 'surface-warning' - | 'surface-warning-subdued' - | 'surface-warning-subdued-hovered' - | 'surface-warning-subdued-pressed'; - export type ColorTokenScale = | 'text' | 'text-critical' @@ -121,6 +61,13 @@ export type BorderRadiusTokenScale = | 'large' | 'half'; +export type BackgroundColors = + | ColorsBackdropTokenAlias + | ColorsBackgroundTokenAlias + | ColorsOverlayTokenAlias + | ColorsActionTokenAlias + | ColorsSurfaceTokenAlias; + interface BorderRadius { startStart: BorderRadiusTokenScale; startEnd: BorderRadiusTokenScale; @@ -135,11 +82,18 @@ interface Spacing { inlineEnd: SpacingSpaceScale; } +interface BorderWidth { + blockStart: ShapeBorderWidthScale; + blockEnd: ShapeBorderWidthScale; + inlineStart: ShapeBorderWidthScale; + inlineEnd: ShapeBorderWidthScale; +} + export interface BoxProps { /** HTML Element type */ as?: Element; /** Background color */ - background?: BackgroundColorTokenScale; + background?: BackgroundColors; /** Border style */ border?: BorderTokenAlias; /** Vertical end border style */ @@ -160,6 +114,16 @@ export interface BoxProps { borderRadiusStartStart?: BorderRadiusTokenScale; /** Verital start horizontal end border radius */ borderRadiusStartEnd?: BorderRadiusTokenScale; + /** Border width */ + borderWidth?: ShapeBorderWidthScale; + /** Vertical start border width */ + borderBlockStartWidth?: ShapeBorderWidthScale; + /** Vertical end border width */ + borderBlockEndWidth?: ShapeBorderWidthScale; + /** Horizontal start border width */ + borderInlineStartWidth?: ShapeBorderWidthScale; + /** Horizontal end border width */ + borderInlineEndWidth?: ShapeBorderWidthScale; /** Color of children */ color?: ColorTokenScale; /** HTML id attribute */ @@ -202,6 +166,11 @@ export const Box = forwardRef( borderInlineStart, borderInlineEnd, borderBlockStart, + borderWidth, + borderBlockStartWidth, + borderBlockEndWidth, + borderInlineStartWidth, + borderInlineEndWidth, borderRadius, borderRadiusEndStart, borderRadiusEndEnd, @@ -239,6 +208,13 @@ export const Box = forwardRef( startEnd: borderRadiusStartEnd, } as BorderRadius; + const borderWidths = { + blockStart: borderBlockStartWidth, + blockEnd: borderBlockEndWidth, + inlineStart: borderInlineStartWidth, + inlineEnd: borderInlineEndWidth, + } as BorderWidth; + const paddings = { blockEnd: paddingBlockEnd, inlineStart: paddingInlineStart, @@ -277,6 +253,21 @@ export const Box = forwardRef( '--pc-box-border-radius-start-end': borderRadiuses.startEnd ? `var(--p-border-radius-${borderRadiuses.startEnd})` : undefined, + '--pc-box-border-width': borderWidth + ? `var(--p-border-width-${borderWidth})` + : undefined, + '--pc-box-border-block-start-width': borderWidths.blockStart + ? `var(--p-border-width-${borderWidths.blockStart})` + : undefined, + '--pc-box-border-block-end-width': borderWidths.blockEnd + ? `var(--p-border-width-${borderWidths.blockEnd})` + : undefined, + '--pc-box-border-inline-start-width': borderWidths.inlineStart + ? `var(--p-border-width-${borderWidths.inlineStart})` + : undefined, + '--pc-box-border-inline-end-width': borderWidths.inlineEnd + ? `var(--p-border-width-${borderWidths.inlineEnd})` + : undefined, '--pc-box-min-height': minHeight, '--pc-box-min-width': minWidth, '--pc-box-max-width': maxWidth, diff --git a/polaris-react/src/components/Box/tests/Box.test.tsx b/polaris-react/src/components/Box/tests/Box.test.tsx index 6e31aa71a13..1c788fe259c 100644 --- a/polaris-react/src/components/Box/tests/Box.test.tsx +++ b/polaris-react/src/components/Box/tests/Box.test.tsx @@ -4,7 +4,7 @@ import type {ColorsTokenName, ShapeTokenName} from '@shopify/polaris-tokens'; import {Box} from '..'; import type { - BackgroundColorTokenScale as BoxBackgroundColorTokenScale, + BackgroundColors as BoxBackgroundColorTokenScale, ColorTokenScale as BoxColorTokenScale, BorderTokenAlias as BoxBorderTokenAlias, BorderRadiusTokenScale as BoxBorderRadiusTokenScale, diff --git a/polaris-tokens/src/index.ts b/polaris-tokens/src/index.ts index 769bc580bc3..f8ad20484a1 100644 --- a/polaris-tokens/src/index.ts +++ b/polaris-tokens/src/index.ts @@ -13,7 +13,16 @@ export type { BreakpointsAlias, } from './token-groups/breakpoints'; -export type {ColorsTokenGroup, ColorsTokenName} from './token-groups/colors'; +export type { + ColorsTokenGroup, + ColorsTokenName, + ColorsBackgroundTokenAlias, + ColorsActionTokenAlias, + ColorsSurfaceTokenAlias, + ColorsBackdropTokenAlias, + ColorsOverlayTokenAlias, + ColorsBorderTokenAlias, +} from './token-groups/colors'; export type { DepthTokenGroup, @@ -43,6 +52,7 @@ export type { ShapeTokenName, ShapeBorderRadiusScale, ShapeBorderRadiusAlias, + ShapeBorderWidthScale, } from './token-groups/shape'; export type { diff --git a/polaris-tokens/src/token-groups/colors.ts b/polaris-tokens/src/token-groups/colors.ts index 73cbf572512..c799746e411 100644 --- a/polaris-tokens/src/token-groups/colors.ts +++ b/polaris-tokens/src/token-groups/colors.ts @@ -650,3 +650,106 @@ export const colors = { export type ColorsTokenGroup = TokenGroup; export type ColorsTokenName = keyof ColorsTokenGroup; + +export const colorsBackgroundTokenAlias = [ + 'background', + 'background-hovered', + 'background-pressed', + 'background-selected', +] as const; +export type ColorsBackgroundTokenAlias = + typeof colorsBackgroundTokenAlias[number]; + +export const colorsActionTokenAlias = [ + 'action-critical', + 'action-critical-depressed', + 'action-critical-disabled', + 'action-critical-hovered', + 'action-critical-pressed', + 'action-primary', + 'action-primary-depressed', + 'action-primary-disabled', + 'action-primary-hovered', + 'action-primary-pressed', + 'action-secondary', + 'action-secondary-depressed', + 'action-secondary-disabled', + 'action-secondary-hovered', + 'action-secondary-hovered-dark', + 'action-secondary-pressed', + 'action-secondary-pressed-dark', +] as const; +export type ColorsActionTokenAlias = typeof colorsActionTokenAlias[number]; + +export const colorsSurfaceTokenAlias = [ + 'surface', + 'surface-attention', + 'surface-critical', + 'surface-critical-subdued', + 'surface-critical-subdued-depressed', + 'surface-critical-subdued-hovered', + 'surface-critical-subdued-pressed', + 'surface-dark', + 'surface-depressed', + 'surface-disabled', + 'surface-highlight', + 'surface-highlight-subdued', + 'surface-highlight-subdued-hovered', + 'surface-highlight-subdued-pressed', + 'surface-hovered', + 'surface-hovered-dark', + 'surface-neutral', + 'surface-neutral-disabled', + 'surface-neutral-hovered', + 'surface-neutral-pressed', + 'surface-neutral-subdued', + 'surface-neutral-subdued-dark', + 'surface-pressed', + 'surface-pressed-dark', + 'surface-primary-selected', + 'surface-primary-selected-hovered', + 'surface-primary-selected-pressed', + 'surface-search-field', + 'surface-search-field-dark', + 'surface-selected', + 'surface-selected-hovered', + 'surface-selected-pressed', + 'surface-subdued', + 'surface-success', + 'surface-success-subdued', + 'surface-success-subdued-hovered', + 'surface-success-subdued-pressed', + 'surface-warning', + 'surface-warning-subdued', + 'surface-warning-subdued-hovered', + 'surface-warning-subdued-pressed', +] as const; +export type ColorsSurfaceTokenAlias = typeof colorsSurfaceTokenAlias[number]; + +export const colorsBackdropTokenAlias = ['backdrop'] as const; +export type ColorsBackdropTokenAlias = typeof colorsBackdropTokenAlias[number]; + +export const colorsOverlayTokenAlias = ['overlay'] as const; +export type ColorsOverlayTokenAlias = typeof colorsOverlayTokenAlias[number]; + +export const colorsBorderTokenAlias = [ + 'border', + 'border-on-dark', + 'border-neutral-subdued', + 'border-hovered', + 'border-disabled', + 'border-subdued', + 'border-depressed', + 'border-shadow', + 'border-shadow-subdued', + 'border-critical', + 'border-critical-subdued', + 'border-critical-disabled', + 'border-warning', + 'border-warning-subdued', + 'border-highlight', + 'border-highlight-subdued', + 'border-success', + 'border-success-subdued', +] as const; +export type ColorsBorderTokenAlias = typeof colorsBorderTokenAlias[number]; diff --git a/polaris-tokens/src/token-groups/shape.ts b/polaris-tokens/src/token-groups/shape.ts index 36b554bb6b3..4222768d87a 100644 --- a/polaris-tokens/src/token-groups/shape.ts +++ b/polaris-tokens/src/token-groups/shape.ts @@ -79,3 +79,6 @@ export type ShapeBorderRadiusScale = typeof shapeBorderRadiusScale[number]; export const shapeBorderRadiusAlias = ['base', 'large', 'half'] as const; export type ShapeBorderRadiusAlias = typeof shapeBorderRadiusAlias[number]; + +export const shapeBorderWidthScale = ['1', '2', '3', '4', '5'] as const; +export type ShapeBorderWidthScale = typeof shapeBorderWidthScale[number]; diff --git a/polaris.shopify.com/src/data/props.json b/polaris.shopify.com/src/data/props.json index f082de39919..6475e67f5ad 100644 --- a/polaris.shopify.com/src/data/props.json +++ b/polaris.shopify.com/src/data/props.json @@ -7605,6 +7605,173 @@ "description": "" } }, + "AccountConnectionProps": { + "polaris-react/src/components/AccountConnection/AccountConnection.tsx": { + "filePath": "polaris-react/src/components/AccountConnection/AccountConnection.tsx", + "name": "AccountConnectionProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/AccountConnection/AccountConnection.tsx", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "React.ReactNode", + "description": "Content to display as title", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/AccountConnection/AccountConnection.tsx", + "syntaxKind": "PropertySignature", + "name": "details", + "value": "React.ReactNode", + "description": "Content to display as additional details", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/AccountConnection/AccountConnection.tsx", + "syntaxKind": "PropertySignature", + "name": "termsOfService", + "value": "React.ReactNode", + "description": "Content to display as terms of service", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/AccountConnection/AccountConnection.tsx", + "syntaxKind": "PropertySignature", + "name": "accountName", + "value": "string", + "description": "The name of the service", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/AccountConnection/AccountConnection.tsx", + "syntaxKind": "PropertySignature", + "name": "avatarUrl", + "value": "string", + "description": "URL for the user’s avatar image", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/AccountConnection/AccountConnection.tsx", + "syntaxKind": "PropertySignature", + "name": "connected", + "value": "boolean", + "description": "Set if the account is connected", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/AccountConnection/AccountConnection.tsx", + "syntaxKind": "PropertySignature", + "name": "action", + "value": "Action", + "description": "Action for account connection", + "isOptional": true + } + ], + "value": "export interface AccountConnectionProps {\n /** Content to display as title */\n title?: React.ReactNode;\n /** Content to display as additional details */\n details?: React.ReactNode;\n /** Content to display as terms of service */\n termsOfService?: React.ReactNode;\n /** The name of the service */\n accountName?: string;\n /** URL for the user’s avatar image */\n avatarUrl?: string;\n /** Set if the account is connected */\n connected?: boolean;\n /** Action for account connection */\n action?: Action;\n}" + } + }, + "ActionListProps": { + "polaris-react/src/components/ActionList/ActionList.tsx": { + "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", + "name": "ActionListProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", + "syntaxKind": "PropertySignature", + "name": "items", + "value": "readonly ActionListItemDescriptor[]", + "description": "Collection of actions for list", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", + "syntaxKind": "PropertySignature", + "name": "sections", + "value": "readonly ActionListSection[]", + "description": "Collection of sectioned action items", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", + "syntaxKind": "PropertySignature", + "name": "actionRole", + "value": "string", + "description": "Defines a specific role attribute for each action in the list", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", + "syntaxKind": "PropertySignature", + "name": "onActionAnyItem", + "value": "() => void", + "description": "Callback when any item is clicked or keypressed", + "isOptional": true + } + ], + "value": "export interface ActionListProps {\n /** Collection of actions for list */\n items?: readonly ActionListItemDescriptor[];\n /** Collection of sectioned action items */\n sections?: readonly ActionListSection[];\n /** Defines a specific role attribute for each action in the list */\n actionRole?: 'menuitem' | string;\n /** Callback when any item is clicked or keypressed */\n onActionAnyItem?: ActionListItemDescriptor['onAction'];\n}" + } + }, + "ActionListItemProps": { + "polaris-react/src/components/ActionList/ActionList.tsx": { + "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "ActionListItemProps", + "value": "ItemProps", + "description": "" + } + }, + "ActionMenuProps": { + "polaris-react/src/components/ActionMenu/ActionMenu.tsx": { + "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", + "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", @@ -7889,224 +8056,57 @@ "value": "interface Props {\n /** Callback when the search is dismissed */\n onDismiss?(): void;\n /** Determines whether the overlay should be visible */\n visible: boolean;\n}" } }, - "ActionMenuProps": { - "polaris-react/src/components/ActionMenu/ActionMenu.tsx": { - "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", - "name": "ActionMenuProps", + "CardBackgroundColorTokenScale": { + "polaris-react/src/components/AlphaCard/AlphaCard.tsx": { + "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "CardBackgroundColorTokenScale", + "value": "\"surface\" | \"surface-subdued\"", + "description": "" + } + }, + "AlphaCardProps": { + "polaris-react/src/components/AlphaCard/AlphaCard.tsx": { + "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", + "name": "AlphaCardProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", + "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", "syntaxKind": "PropertySignature", - "name": "actions", - "value": "MenuActionDescriptor[]", - "description": "Collection of page-level secondary actions", + "name": "children", + "value": "React.ReactNode", + "description": "Elements to display inside card", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", + "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", "syntaxKind": "PropertySignature", - "name": "groups", - "value": "MenuGroupDescriptor[]", - "description": "Collection of page-level action groups", - "isOptional": true + "name": "background", + "value": "CardBackgroundColorTokenScale", + "description": "Background color", + "isOptional": true, + "defaultValue": "'surface'" }, { - "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", + "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", "syntaxKind": "PropertySignature", - "name": "rollup", - "value": "boolean", - "description": "Roll up all actions into a Popover > ActionList", - "isOptional": true + "name": "padding", + "value": "\"0\" | \"025\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", + "description": "The spacing around the card", + "isOptional": true, + "defaultValue": "'5'" }, { - "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", + "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.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", + "name": "roundedAbove", + "value": "\"xs\" | \"sm\" | \"md\" | \"lg\" | \"xl\"", + "description": "Border radius value above a set breakpoint", "isOptional": true } ], - "value": "export interface ActionMenuProps {\n /** Collection of page-level secondary actions */\n actions?: MenuActionDescriptor[];\n /** Collection of page-level action groups */\n groups?: MenuGroupDescriptor[];\n /** Roll up all actions into a Popover > ActionList */\n rollup?: boolean;\n /** Label for rolled up actions activator */\n rollupActionsLabel?: string;\n /** Callback that returns true when secondary actions are rolled up into action groups, and false when not */\n onActionRollup?(hasRolledUp: boolean): void;\n}" - } - }, - "ActionListProps": { - "polaris-react/src/components/ActionList/ActionList.tsx": { - "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", - "name": "ActionListProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", - "syntaxKind": "PropertySignature", - "name": "items", - "value": "readonly ActionListItemDescriptor[]", - "description": "Collection of actions for list", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", - "syntaxKind": "PropertySignature", - "name": "sections", - "value": "readonly ActionListSection[]", - "description": "Collection of sectioned action items", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", - "syntaxKind": "PropertySignature", - "name": "actionRole", - "value": "string", - "description": "Defines a specific role attribute for each action in the list", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", - "syntaxKind": "PropertySignature", - "name": "onActionAnyItem", - "value": "() => void", - "description": "Callback when any item is clicked or keypressed", - "isOptional": true - } - ], - "value": "export interface ActionListProps {\n /** Collection of actions for list */\n items?: readonly ActionListItemDescriptor[];\n /** Collection of sectioned action items */\n sections?: readonly ActionListSection[];\n /** Defines a specific role attribute for each action in the list */\n actionRole?: 'menuitem' | string;\n /** Callback when any item is clicked or keypressed */\n onActionAnyItem?: ActionListItemDescriptor['onAction'];\n}" - } - }, - "ActionListItemProps": { - "polaris-react/src/components/ActionList/ActionList.tsx": { - "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "ActionListItemProps", - "value": "ItemProps", - "description": "" - } - }, - "AccountConnectionProps": { - "polaris-react/src/components/AccountConnection/AccountConnection.tsx": { - "filePath": "polaris-react/src/components/AccountConnection/AccountConnection.tsx", - "name": "AccountConnectionProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/AccountConnection/AccountConnection.tsx", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "React.ReactNode", - "description": "Content to display as title", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/AccountConnection/AccountConnection.tsx", - "syntaxKind": "PropertySignature", - "name": "details", - "value": "React.ReactNode", - "description": "Content to display as additional details", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/AccountConnection/AccountConnection.tsx", - "syntaxKind": "PropertySignature", - "name": "termsOfService", - "value": "React.ReactNode", - "description": "Content to display as terms of service", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/AccountConnection/AccountConnection.tsx", - "syntaxKind": "PropertySignature", - "name": "accountName", - "value": "string", - "description": "The name of the service", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/AccountConnection/AccountConnection.tsx", - "syntaxKind": "PropertySignature", - "name": "avatarUrl", - "value": "string", - "description": "URL for the user’s avatar image", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/AccountConnection/AccountConnection.tsx", - "syntaxKind": "PropertySignature", - "name": "connected", - "value": "boolean", - "description": "Set if the account is connected", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/AccountConnection/AccountConnection.tsx", - "syntaxKind": "PropertySignature", - "name": "action", - "value": "Action", - "description": "Action for account connection", - "isOptional": true - } - ], - "value": "export interface AccountConnectionProps {\n /** Content to display as title */\n title?: React.ReactNode;\n /** Content to display as additional details */\n details?: React.ReactNode;\n /** Content to display as terms of service */\n termsOfService?: React.ReactNode;\n /** The name of the service */\n accountName?: string;\n /** URL for the user’s avatar image */\n avatarUrl?: string;\n /** Set if the account is connected */\n connected?: boolean;\n /** Action for account connection */\n action?: Action;\n}" - } - }, - "CardBackgroundColorTokenScale": { - "polaris-react/src/components/AlphaCard/AlphaCard.tsx": { - "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "CardBackgroundColorTokenScale", - "value": "\"surface\" | \"surface-subdued\"", - "description": "" - } - }, - "AlphaCardProps": { - "polaris-react/src/components/AlphaCard/AlphaCard.tsx": { - "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", - "name": "AlphaCardProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "Elements to display inside card", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", - "syntaxKind": "PropertySignature", - "name": "background", - "value": "CardBackgroundColorTokenScale", - "description": "Background color", - "isOptional": true, - "defaultValue": "'surface'" - }, - { - "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", - "syntaxKind": "PropertySignature", - "name": "padding", - "value": "\"0\" | \"025\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", - "description": "The spacing around the card", - "isOptional": true, - "defaultValue": "'5'" - }, - { - "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", - "syntaxKind": "PropertySignature", - "name": "roundedAbove", - "value": "\"xs\" | \"sm\" | \"md\" | \"lg\" | \"xl\"", - "description": "Border radius value above a set breakpoint", - "isOptional": true - } - ], - "value": "export interface AlphaCardProps {\n /** Elements to display inside card */\n children?: React.ReactNode;\n /** Background color\n * @default 'surface'\n */\n background?: CardBackgroundColorTokenScale;\n /** The spacing around the card\n * @default '5'\n */\n padding?: SpacingSpaceScale;\n /** Border radius value above a set breakpoint */\n roundedAbove?: BreakpointsAlias;\n}" + "value": "export interface AlphaCardProps {\n /** Elements to display inside card */\n children?: React.ReactNode;\n /** Background color\n * @default 'surface'\n */\n background?: CardBackgroundColorTokenScale;\n /** The spacing around the card\n * @default '5'\n */\n padding?: SpacingSpaceScale;\n /** Border radius value above a set breakpoint */\n roundedAbove?: BreakpointsAlias;\n}" } }, "Align": { @@ -8906,48 +8906,6 @@ "value": "export interface AutocompleteProps {\n /** A unique identifier for the Autocomplete */\n id?: string;\n /** Collection of options to be listed */\n options: SectionDescriptor[] | OptionDescriptor[];\n /** The selected options */\n selected: string[];\n /** The text field component attached to the list of options */\n textField: React.ReactElement;\n /** The preferred direction to open the popover */\n preferredPosition?: PopoverProps['preferredPosition'];\n /** Title of the list of options */\n listTitle?: string;\n /** Allow more than one option to be selected */\n allowMultiple?: boolean;\n /** An action to render above the list of options */\n actionBefore?: ActionListItemDescriptor & {\n /** Specifies that if the label is too long it will wrap instead of being hidden */\n wrapOverflow?: boolean;\n };\n /** Display loading state */\n loading?: boolean;\n /** Indicates if more results will load dynamically */\n willLoadMoreResults?: boolean;\n /** Is rendered when there are no options */\n emptyState?: React.ReactNode;\n /** Callback when the selection of options is changed */\n onSelect(selected: string[]): void;\n /** Callback when the end of the list is reached */\n onLoadMoreResults?(): void;\n}" } }, - "BackdropProps": { - "polaris-react/src/components/Backdrop/Backdrop.tsx": { - "filePath": "polaris-react/src/components/Backdrop/Backdrop.tsx", - "name": "BackdropProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Backdrop/Backdrop.tsx", - "syntaxKind": "PropertySignature", - "name": "belowNavigation", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Backdrop/Backdrop.tsx", - "syntaxKind": "PropertySignature", - "name": "transparent", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Backdrop/Backdrop.tsx", - "syntaxKind": "MethodSignature", - "name": "onClick", - "value": "() => void", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Backdrop/Backdrop.tsx", - "syntaxKind": "MethodSignature", - "name": "onTouchStart", - "value": "() => void", - "description": "", - "isOptional": true - } - ], - "value": "export interface BackdropProps {\n belowNavigation?: boolean;\n transparent?: boolean;\n onClick?(): void;\n onTouchStart?(): void;\n}" - } - }, "Shape": { "polaris-react/src/components/Avatar/Avatar.tsx": { "filePath": "polaris-react/src/components/Avatar/Avatar.tsx", @@ -9033,6 +8991,48 @@ "value": "export interface AvatarProps {\n /**\n * Size of avatar\n * @default 'medium'\n */\n size?: Size;\n /**\n * Shape of avatar\n * @default 'round'\n */\n shape?: Shape;\n /** The name of the person */\n name?: string;\n /** Initials of person to display */\n initials?: string;\n /** Whether the avatar is for a customer */\n customer?: boolean;\n /** URL of the avatar image which falls back to initials if the image fails to load */\n source?: string;\n /** Callback fired when the image fails to load */\n onError?(): void;\n /** Accessible label for the avatar image */\n accessibilityLabel?: string;\n}" } }, + "BackdropProps": { + "polaris-react/src/components/Backdrop/Backdrop.tsx": { + "filePath": "polaris-react/src/components/Backdrop/Backdrop.tsx", + "name": "BackdropProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Backdrop/Backdrop.tsx", + "syntaxKind": "PropertySignature", + "name": "belowNavigation", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Backdrop/Backdrop.tsx", + "syntaxKind": "PropertySignature", + "name": "transparent", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Backdrop/Backdrop.tsx", + "syntaxKind": "MethodSignature", + "name": "onClick", + "value": "() => void", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Backdrop/Backdrop.tsx", + "syntaxKind": "MethodSignature", + "name": "onTouchStart", + "value": "() => void", + "description": "", + "isOptional": true + } + ], + "value": "export interface BackdropProps {\n belowNavigation?: boolean;\n transparent?: boolean;\n onClick?(): void;\n onTouchStart?(): void;\n}" + } + }, "NonMutuallyExclusiveProps": { "polaris-react/src/components/Badge/Badge.tsx": { "filePath": "polaris-react/src/components/Badge/Badge.tsx", @@ -9783,15 +9783,6 @@ "description": "" } }, - "BackgroundColorTokenScale": { - "polaris-react/src/components/Box/Box.tsx": { - "filePath": "polaris-react/src/components/Box/Box.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "BackgroundColorTokenScale", - "value": "'action-critical' | 'action-critical-depressed' | 'action-critical-disabled' | 'action-critical-hovered' | 'action-critical-pressed' | 'action-primary' | 'action-primary-depressed' | 'action-primary-disabled' | 'action-primary-hovered' | 'action-primary-pressed' | 'action-secondary' | 'action-secondary-depressed' | 'action-secondary-disabled' | 'action-secondary-hovered' | 'action-secondary-hovered-dark' | 'action-secondary-pressed' | 'action-secondary-pressed-dark' | 'backdrop' | 'background' | 'background-hovered' | 'background-pressed' | 'background-selected' | 'overlay' | 'surface' | 'surface-attention' | 'surface-critical' | 'surface-critical-subdued' | 'surface-critical-subdued-depressed' | 'surface-critical-subdued-hovered' | 'surface-critical-subdued-pressed' | 'surface-dark' | 'surface-depressed' | 'surface-disabled' | 'surface-highlight' | 'surface-highlight-subdued' | 'surface-highlight-subdued-hovered' | 'surface-highlight-subdued-pressed' | 'surface-hovered' | 'surface-hovered-dark' | 'surface-neutral' | 'surface-neutral-disabled' | 'surface-neutral-hovered' | 'surface-neutral-pressed' | 'surface-neutral-subdued' | 'surface-neutral-subdued-dark' | 'surface-pressed' | 'surface-pressed-dark' | 'surface-primary-selected' | 'surface-primary-selected-hovered' | 'surface-primary-selected-pressed' | 'surface-search-field' | 'surface-search-field-dark' | 'surface-selected' | 'surface-selected-hovered' | 'surface-selected-pressed' | 'surface-subdued' | 'surface-success' | 'surface-success-subdued' | 'surface-success-subdued-hovered' | 'surface-success-subdued-pressed' | 'surface-warning' | 'surface-warning-subdued' | 'surface-warning-subdued-hovered' | 'surface-warning-subdued-pressed'", - "description": "" - } - }, "ColorTokenScale": { "polaris-react/src/components/Box/Box.tsx": { "filePath": "polaris-react/src/components/Box/Box.tsx", @@ -9857,6 +9848,15 @@ "description": "" } }, + "BackgroundColors": { + "polaris-react/src/components/Box/Box.tsx": { + "filePath": "polaris-react/src/components/Box/Box.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "BackgroundColors", + "value": "ColorsBackdropTokenAlias | ColorsBackgroundTokenAlias | ColorsOverlayTokenAlias | ColorsActionTokenAlias | ColorsSurfaceTokenAlias", + "description": "" + } + }, "BorderRadius": { "polaris-react/src/components/Box/Box.tsx": { "filePath": "polaris-react/src/components/Box/Box.tsx", @@ -9895,32 +9895,70 @@ "value": "interface BorderRadius {\n startStart: BorderRadiusTokenScale;\n startEnd: BorderRadiusTokenScale;\n endStart: BorderRadiusTokenScale;\n endEnd: BorderRadiusTokenScale;\n}" } }, - "BoxProps": { + "BorderWidth": { "polaris-react/src/components/Box/Box.tsx": { "filePath": "polaris-react/src/components/Box/Box.tsx", - "name": "BoxProps", + "name": "BorderWidth", "description": "", "members": [ { "filePath": "polaris-react/src/components/Box/Box.tsx", "syntaxKind": "PropertySignature", - "name": "as", - "value": "Element", - "description": "HTML Element type", - "isOptional": true + "name": "blockStart", + "value": "\"1\" | \"2\" | \"3\" | \"4\" | \"5\"", + "description": "" }, { "filePath": "polaris-react/src/components/Box/Box.tsx", "syntaxKind": "PropertySignature", - "name": "background", - "value": "BackgroundColorTokenScale", - "description": "Background color", - "isOptional": true + "name": "blockEnd", + "value": "\"1\" | \"2\" | \"3\" | \"4\" | \"5\"", + "description": "" }, { "filePath": "polaris-react/src/components/Box/Box.tsx", "syntaxKind": "PropertySignature", - "name": "border", + "name": "inlineStart", + "value": "\"1\" | \"2\" | \"3\" | \"4\" | \"5\"", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Box/Box.tsx", + "syntaxKind": "PropertySignature", + "name": "inlineEnd", + "value": "\"1\" | \"2\" | \"3\" | \"4\" | \"5\"", + "description": "" + } + ], + "value": "interface BorderWidth {\n blockStart: ShapeBorderWidthScale;\n blockEnd: ShapeBorderWidthScale;\n inlineStart: ShapeBorderWidthScale;\n inlineEnd: ShapeBorderWidthScale;\n}" + } + }, + "BoxProps": { + "polaris-react/src/components/Box/Box.tsx": { + "filePath": "polaris-react/src/components/Box/Box.tsx", + "name": "BoxProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Box/Box.tsx", + "syntaxKind": "PropertySignature", + "name": "as", + "value": "Element", + "description": "HTML Element type", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Box/Box.tsx", + "syntaxKind": "PropertySignature", + "name": "background", + "value": "BackgroundColors", + "description": "Background color", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Box/Box.tsx", + "syntaxKind": "PropertySignature", + "name": "border", "value": "BorderTokenAlias", "description": "Border style", "isOptional": true @@ -9997,6 +10035,46 @@ "description": "Verital start horizontal end border radius", "isOptional": true }, + { + "filePath": "polaris-react/src/components/Box/Box.tsx", + "syntaxKind": "PropertySignature", + "name": "borderWidth", + "value": "\"1\" | \"2\" | \"3\" | \"4\" | \"5\"", + "description": "Border width", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Box/Box.tsx", + "syntaxKind": "PropertySignature", + "name": "borderBlockStartWidth", + "value": "\"1\" | \"2\" | \"3\" | \"4\" | \"5\"", + "description": "Vertical start border width", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Box/Box.tsx", + "syntaxKind": "PropertySignature", + "name": "borderBlockEndWidth", + "value": "\"1\" | \"2\" | \"3\" | \"4\" | \"5\"", + "description": "Vertical end border width", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Box/Box.tsx", + "syntaxKind": "PropertySignature", + "name": "borderInlineStartWidth", + "value": "\"1\" | \"2\" | \"3\" | \"4\" | \"5\"", + "description": "Horizontal start border width", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Box/Box.tsx", + "syntaxKind": "PropertySignature", + "name": "borderInlineEndWidth", + "value": "\"1\" | \"2\" | \"3\" | \"4\" | \"5\"", + "description": "Horizontal end border width", + "isOptional": true + }, { "filePath": "polaris-react/src/components/Box/Box.tsx", "syntaxKind": "PropertySignature", @@ -10118,7 +10196,7 @@ "isOptional": true } ], - "value": "export interface BoxProps {\n /** HTML Element type */\n as?: Element;\n /** Background color */\n background?: BackgroundColorTokenScale;\n /** Border style */\n border?: BorderTokenAlias;\n /** Vertical end border style */\n borderBlockEnd?: BorderTokenAlias;\n /** Horizontal start border style */\n borderInlineStart?: BorderTokenAlias;\n /** Horizontal end border style */\n borderInlineEnd?: BorderTokenAlias;\n /** Vertical start border style */\n borderBlockStart?: BorderTokenAlias;\n /** Border radius */\n borderRadius?: BorderRadiusTokenScale;\n /** Vertical end horizontal start border radius */\n borderRadiusEndStart?: BorderRadiusTokenScale;\n /** Vertical end horizontal end border radius */\n borderRadiusEndEnd?: BorderRadiusTokenScale;\n /** Vertical start horizontal start border radius */\n borderRadiusStartStart?: BorderRadiusTokenScale;\n /** Verital start horizontal end border radius */\n borderRadiusStartEnd?: BorderRadiusTokenScale;\n /** Color of children */\n color?: ColorTokenScale;\n /** HTML id attribute */\n id?: string;\n /** Set minimum height of container */\n minHeight?: string;\n /** Set minimum width of container */\n minWidth?: string;\n /** Set maximum width of container */\n maxWidth?: string;\n /** Clip horizontal content of children */\n overflowX?: Overflow;\n /** Clip vertical content of children */\n overflowY?: Overflow;\n /** Spacing around children */\n padding?: SpacingSpaceScale;\n /** Vertical start spacing around children */\n paddingBlockStart?: SpacingSpaceScale;\n /** Vertical end spacing around children */\n paddingBlockEnd?: SpacingSpaceScale;\n /** Horizontal start spacing around children */\n paddingInlineStart?: SpacingSpaceScale;\n /** Horizontal end spacing around children */\n paddingInlineEnd?: SpacingSpaceScale;\n /** Shadow */\n shadow?: DepthShadowAlias;\n /** Set width of container */\n width?: string;\n /** Elements to display inside box */\n children?: React.ReactNode;\n}" + "value": "export interface BoxProps {\n /** HTML Element type */\n as?: Element;\n /** Background color */\n background?: BackgroundColors;\n /** Border style */\n border?: BorderTokenAlias;\n /** Vertical end border style */\n borderBlockEnd?: BorderTokenAlias;\n /** Horizontal start border style */\n borderInlineStart?: BorderTokenAlias;\n /** Horizontal end border style */\n borderInlineEnd?: BorderTokenAlias;\n /** Vertical start border style */\n borderBlockStart?: BorderTokenAlias;\n /** Border radius */\n borderRadius?: BorderRadiusTokenScale;\n /** Vertical end horizontal start border radius */\n borderRadiusEndStart?: BorderRadiusTokenScale;\n /** Vertical end horizontal end border radius */\n borderRadiusEndEnd?: BorderRadiusTokenScale;\n /** Vertical start horizontal start border radius */\n borderRadiusStartStart?: BorderRadiusTokenScale;\n /** Verital start horizontal end border radius */\n borderRadiusStartEnd?: BorderRadiusTokenScale;\n /** Border width */\n borderWidth?: ShapeBorderWidthScale;\n /** Vertical start border width */\n borderBlockStartWidth?: ShapeBorderWidthScale;\n /** Vertical end border width */\n borderBlockEndWidth?: ShapeBorderWidthScale;\n /** Horizontal start border width */\n borderInlineStartWidth?: ShapeBorderWidthScale;\n /** Horizontal end border width */\n borderInlineEndWidth?: ShapeBorderWidthScale;\n /** Color of children */\n color?: ColorTokenScale;\n /** HTML id attribute */\n id?: string;\n /** Set minimum height of container */\n minHeight?: string;\n /** Set minimum width of container */\n minWidth?: string;\n /** Set maximum width of container */\n maxWidth?: string;\n /** Clip horizontal content of children */\n overflowX?: Overflow;\n /** Clip vertical content of children */\n overflowY?: Overflow;\n /** Spacing around children */\n padding?: SpacingSpaceScale;\n /** Vertical start spacing around children */\n paddingBlockStart?: SpacingSpaceScale;\n /** Vertical end spacing around children */\n paddingBlockEnd?: SpacingSpaceScale;\n /** Horizontal start spacing around children */\n paddingInlineStart?: SpacingSpaceScale;\n /** Horizontal end spacing around children */\n paddingInlineEnd?: SpacingSpaceScale;\n /** Shadow */\n shadow?: DepthShadowAlias;\n /** Set width of container */\n width?: string;\n /** Elements to display inside box */\n children?: React.ReactNode;\n}" } }, "BreadcrumbsProps": { @@ -11693,7 +11771,7 @@ "filePath": "polaris-react/src/components/Grid/components/Cell/Cell.tsx", "syntaxKind": "PropertySignature", "name": "xs", - "value": "2 | 5 | 1 | 3 | 4 | 6", + "value": "2 | 5 | 1 | 4 | 3 | 6", "description": "Number of columns the section should span on extra small screens", "isOptional": true }, @@ -11701,7 +11779,7 @@ "filePath": "polaris-react/src/components/Grid/components/Cell/Cell.tsx", "syntaxKind": "PropertySignature", "name": "sm", - "value": "2 | 5 | 1 | 3 | 4 | 6", + "value": "2 | 5 | 1 | 4 | 3 | 6", "description": "Number of columns the section should span on small screens", "isOptional": true }, @@ -11709,7 +11787,7 @@ "filePath": "polaris-react/src/components/Grid/components/Cell/Cell.tsx", "syntaxKind": "PropertySignature", "name": "md", - "value": "2 | 5 | 1 | 3 | 4 | 6", + "value": "2 | 5 | 1 | 4 | 3 | 6", "description": "Number of columns the section should span on medium screens", "isOptional": true }, @@ -11717,7 +11795,7 @@ "filePath": "polaris-react/src/components/Grid/components/Cell/Cell.tsx", "syntaxKind": "PropertySignature", "name": "lg", - "value": "2 | 5 | 1 | 10 | 3 | 4 | 6 | 7 | 8 | 9 | 11 | 12", + "value": "2 | 5 | 1 | 4 | 10 | 3 | 6 | 7 | 8 | 9 | 11 | 12", "description": "Number of columns the section should span on large screens", "isOptional": true }, @@ -11725,7 +11803,7 @@ "filePath": "polaris-react/src/components/Grid/components/Cell/Cell.tsx", "syntaxKind": "PropertySignature", "name": "xl", - "value": "2 | 5 | 1 | 10 | 3 | 4 | 6 | 7 | 8 | 9 | 11 | 12", + "value": "2 | 5 | 1 | 4 | 10 | 3 | 6 | 7 | 8 | 9 | 11 | 12", "description": "Number of columns the section should span on extra large screens", "isOptional": true } @@ -11910,946 +11988,946 @@ "value": "export interface ContentBlockProps {\n /** Elements to display inside container */\n children?: React.ReactNode;\n /** Adjust maximum width of container */\n width: Width;\n}" } }, - "Item": { - "polaris-react/src/components/DescriptionList/DescriptionList.tsx": { - "filePath": "polaris-react/src/components/DescriptionList/DescriptionList.tsx", - "name": "Item", + "TableRow": { + "polaris-react/src/components/DataTable/DataTable.tsx": { + "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "TableRow", + "value": "DataTableProps['headings'] | DataTableProps['rows'] | DataTableProps['totals']", + "description": "" + } + }, + "TableData": { + "polaris-react/src/components/DataTable/DataTable.tsx": { + "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "TableData", + "value": "string | number | React.ReactNode", + "description": "" + } + }, + "ColumnContentType": { + "polaris-react/src/components/DataTable/DataTable.tsx": { + "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "ColumnContentType", + "value": "'text' | 'numeric'", + "description": "" + } + }, + "DataTableProps": { + "polaris-react/src/components/DataTable/DataTable.tsx": { + "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", + "name": "DataTableProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/DescriptionList/DescriptionList.tsx", + "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", "syntaxKind": "PropertySignature", - "name": "term", - "value": "React.ReactNode", - "description": "Title of the item" + "name": "columnContentTypes", + "value": "ColumnContentType[]", + "description": "List of data types, which determines content alignment for each column. Data types are \"text,\" which aligns left, or \"numeric,\" which aligns right." }, { - "filePath": "polaris-react/src/components/DescriptionList/DescriptionList.tsx", + "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", "syntaxKind": "PropertySignature", - "name": "description", - "value": "React.ReactNode", - "description": "Item content" - } - ], - "value": "interface Item {\n /** Title of the item */\n term: React.ReactNode;\n /** Item content */\n description: React.ReactNode;\n}" - }, - "polaris-react/src/components/ExceptionList/ExceptionList.tsx": { - "filePath": "polaris-react/src/components/ExceptionList/ExceptionList.tsx", - "name": "Item", - "description": "", - "members": [ + "name": "headings", + "value": "React.ReactNode[]", + "description": "List of column headings." + }, { - "filePath": "polaris-react/src/components/ExceptionList/ExceptionList.tsx", + "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", "syntaxKind": "PropertySignature", - "name": "status", - "value": "\"warning\" | \"critical\"", - "description": "Set the color of the icon and title for the given item.", + "name": "totals", + "value": "any[]", + "description": "List of numeric column totals, highlighted in the table’s header below column headings. Use empty strings as placeholders for columns with no total.", "isOptional": true }, { - "filePath": "polaris-react/src/components/ExceptionList/ExceptionList.tsx", + "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", "syntaxKind": "PropertySignature", - "name": "icon", - "value": "any", - "description": "Icon displayed by the list item", + "name": "totalsName", + "value": "{ singular: React.ReactNode; plural: React.ReactNode; }", + "description": "Custom totals row heading", "isOptional": true }, { - "filePath": "polaris-react/src/components/ExceptionList/ExceptionList.tsx", + "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "Text displayed beside the icon", + "name": "showTotalsInFooter", + "value": "boolean", + "description": "Placement of totals row within table", "isOptional": true }, { - "filePath": "polaris-react/src/components/ExceptionList/ExceptionList.tsx", + "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", "syntaxKind": "PropertySignature", - "name": "description", - "value": "any", - "description": "Text displayed for the item", - "isOptional": true + "name": "rows", + "value": "any[][]", + "description": "Lists of data points which map to table body rows." }, { - "filePath": "polaris-react/src/components/ExceptionList/ExceptionList.tsx", + "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", + "syntaxKind": "PropertySignature", + "name": "hideScrollIndicator", + "value": "boolean", + "description": "Hide column visibility and navigation buttons above the header when the table horizontally collapses to be scrollable.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", "syntaxKind": "PropertySignature", "name": "truncate", "value": "boolean", - "description": "Should the description be truncated at end of line", + "description": "Truncate content in first column instead of wrapping.", + "isOptional": true, + "defaultValue": "true" + }, + { + "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", + "syntaxKind": "PropertySignature", + "name": "verticalAlign", + "value": "VerticalAlign", + "description": "Vertical alignment of content in the cells.", + "isOptional": true, + "defaultValue": "'top'" + }, + { + "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", + "syntaxKind": "PropertySignature", + "name": "footerContent", + "value": "any", + "description": "Content centered in the full width cell of the table footer row.", "isOptional": true - } - ], - "value": "interface Item {\n /** Set the color of the icon and title for the given item. */\n status?: 'critical' | 'warning';\n /** Icon displayed by the list item */\n icon?: IconProps['source'];\n /** Text displayed beside the icon */\n title?: string;\n /** Text displayed for the item */\n description?: Description;\n /** Should the description be truncated at end of line */\n truncate?: boolean;\n}" - } - }, - "DescriptionListProps": { - "polaris-react/src/components/DescriptionList/DescriptionList.tsx": { - "filePath": "polaris-react/src/components/DescriptionList/DescriptionList.tsx", - "name": "DescriptionListProps", - "description": "", - "members": [ + }, { - "filePath": "polaris-react/src/components/DescriptionList/DescriptionList.tsx", + "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", "syntaxKind": "PropertySignature", - "name": "items", - "value": "Item[]", - "description": "Collection of items for list" + "name": "hoverable", + "value": "boolean", + "description": "Table row has hover state. Defaults to true.", + "isOptional": true }, { - "filePath": "polaris-react/src/components/DescriptionList/DescriptionList.tsx", + "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", "syntaxKind": "PropertySignature", - "name": "spacing", - "value": "\"tight\" | \"loose\"", - "description": "Determines the spacing between list items", + "name": "sortable", + "value": "boolean[]", + "description": "List of booleans, which maps to whether sorting is enabled or not for each column. Defaults to false for all columns.", "isOptional": true - } - ], - "value": "export interface DescriptionListProps {\n /** Collection of items for list */\n items: Item[];\n /** Determines the spacing between list items */\n spacing?: 'tight' | 'loose';\n}" - } - }, - "DisplayTextProps": { - "polaris-react/src/components/DisplayText/DisplayText.tsx": { - "filePath": "polaris-react/src/components/DisplayText/DisplayText.tsx", - "name": "DisplayTextProps", - "description": "", - "members": [ + }, { - "filePath": "polaris-react/src/components/DisplayText/DisplayText.tsx", + "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", "syntaxKind": "PropertySignature", - "name": "element", - "value": "HeadingTagName", - "description": "Name of element to use for text", + "name": "defaultSortDirection", + "value": "SortDirection", + "description": "The direction to sort the table rows on first click or keypress of a sortable column heading. Defaults to ascending.", "isOptional": true, - "defaultValue": "'p'" + "defaultValue": "'ascending'" }, { - "filePath": "polaris-react/src/components/DisplayText/DisplayText.tsx", + "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", "syntaxKind": "PropertySignature", - "name": "size", - "value": "Size", - "description": "Size of the text", + "name": "initialSortColumnIndex", + "value": "number", + "description": "The index of the heading that the table rows are initially sorted by. Defaults to the first column.", "isOptional": true, - "defaultValue": "'medium'" + "defaultValue": "0" }, { - "filePath": "polaris-react/src/components/DisplayText/DisplayText.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "Content to display", - "isOptional": true - } - ], - "value": "export interface DisplayTextProps {\n /**\n * Name of element to use for text\n * @default 'p'\n */\n element?: HeadingTagName;\n /**\n * Size of the text\n * @default 'medium'\n */\n size?: Size;\n /** Content to display */\n children?: React.ReactNode;\n}" - } - }, - "DropZoneFileType": { - "polaris-react/src/components/DropZone/DropZone.tsx": { - "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "DropZoneFileType", - "value": "'file' | 'image' | 'video'", - "description": "" - } - }, - "DropZoneProps": { - "polaris-react/src/components/DropZone/DropZone.tsx": { - "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", - "name": "DropZoneProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", - "syntaxKind": "PropertySignature", - "name": "label", - "value": "React.ReactNode", - "description": "Label for the file input", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", - "syntaxKind": "PropertySignature", - "name": "labelAction", - "value": "Action", - "description": "Adds an action to the label", + "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", + "syntaxKind": "MethodSignature", + "name": "onSort", + "value": "(headingIndex: number, direction: SortDirection) => void", + "description": "Callback fired on click or keypress of a sortable column heading.", "isOptional": true }, { - "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", + "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", "syntaxKind": "PropertySignature", - "name": "labelHidden", + "name": "increasedTableDensity", "value": "boolean", - "description": "Visually hide the label", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "ID for file input", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", - "syntaxKind": "PropertySignature", - "name": "accept", - "value": "string", - "description": "Allowed file types", + "description": "Increased density", "isOptional": true }, { - "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "DropZoneFileType", - "description": "Whether is a file or an image", - "isOptional": true, - "defaultValue": "'file'" - }, - { - "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", + "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", "syntaxKind": "PropertySignature", - "name": "active", + "name": "hasZebraStripingOnData", "value": "boolean", - "description": "Sets an active state", + "description": "Add zebra striping to data rows", "isOptional": true }, { - "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", + "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", "syntaxKind": "PropertySignature", - "name": "error", + "name": "stickyHeader", "value": "boolean", - "description": "Sets an error state", + "description": "Header becomes sticky and pins to top of table when scrolling", "isOptional": true }, { - "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", + "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", "syntaxKind": "PropertySignature", - "name": "outline", + "name": "hasFixedFirstColumn", "value": "boolean", - "description": "Displays an outline border", + "description": "", "isOptional": true, - "defaultValue": "true" + "deprecationMessage": "Add a fixed first column on horizontal scroll. Use fixedFirstColumns={n} instead." }, { - "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", + "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", "syntaxKind": "PropertySignature", - "name": "overlay", - "value": "boolean", - "description": "Displays an overlay on hover", - "isOptional": true, - "defaultValue": "true" + "name": "fixedFirstColumns", + "value": "number", + "description": "Add fixed columns on horizontal scroll.", + "isOptional": true }, { - "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", + "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", "syntaxKind": "PropertySignature", - "name": "overlayText", + "name": "firstColumnMinWidth", "value": "string", - "description": "Text that appears in the overlay", + "description": "Specify a min width for the first column if neccessary", "isOptional": true - }, + } + ], + "value": "export interface DataTableProps {\n /** List of data types, which determines content alignment for each column. Data types are \"text,\" which aligns left, or \"numeric,\" which aligns right. */\n columnContentTypes: ColumnContentType[];\n /** List of column headings. */\n headings: React.ReactNode[];\n /** List of numeric column totals, highlighted in the table’s header below column headings. Use empty strings as placeholders for columns with no total. */\n totals?: TableData[];\n /** Custom totals row heading */\n totalsName?: {\n singular: React.ReactNode;\n plural: React.ReactNode;\n };\n /** Placement of totals row within table */\n showTotalsInFooter?: boolean;\n /** Lists of data points which map to table body rows. */\n rows: TableData[][];\n /** Hide column visibility and navigation buttons above the header when the table horizontally collapses to be scrollable.\n * @default false\n */\n hideScrollIndicator?: boolean;\n /** Truncate content in first column instead of wrapping.\n * @default true\n */\n truncate?: boolean;\n /** Vertical alignment of content in the cells.\n * @default 'top'\n */\n verticalAlign?: VerticalAlign;\n /** Content centered in the full width cell of the table footer row. */\n footerContent?: TableData;\n /** Table row has hover state. Defaults to true. */\n hoverable?: boolean;\n /** List of booleans, which maps to whether sorting is enabled or not for each column. Defaults to false for all columns. */\n sortable?: boolean[];\n /**\n * The direction to sort the table rows on first click or keypress of a sortable column heading. Defaults to ascending.\n * @default 'ascending'\n */\n defaultSortDirection?: SortDirection;\n /**\n * The index of the heading that the table rows are initially sorted by. Defaults to the first column.\n * @default 0\n */\n initialSortColumnIndex?: number;\n /** Callback fired on click or keypress of a sortable column heading. */\n onSort?(headingIndex: number, direction: SortDirection): void;\n /** Increased density */\n increasedTableDensity?: boolean;\n /** Add zebra striping to data rows */\n hasZebraStripingOnData?: boolean;\n /** Header becomes sticky and pins to top of table when scrolling */\n stickyHeader?: boolean;\n /** @deprecated Add a fixed first column on horizontal scroll. Use fixedFirstColumns={n} instead. */\n hasFixedFirstColumn?: boolean;\n /** Add fixed columns on horizontal scroll. */\n fixedFirstColumns?: number;\n /** Specify a min width for the first column if neccessary */\n firstColumnMinWidth?: string;\n}" + } + }, + "DatePickerProps": { + "polaris-react/src/components/DatePicker/DatePicker.tsx": { + "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", + "name": "DatePickerProps", + "description": "", + "members": [ { - "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", + "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", "syntaxKind": "PropertySignature", - "name": "errorOverlayText", + "name": "id", "value": "string", - "description": "Text that appears in the overlay when set in error state", + "description": "ID for the element", "isOptional": true }, { - "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", + "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", "syntaxKind": "PropertySignature", - "name": "allowMultiple", - "value": "boolean", - "description": "Allows multiple files to be uploaded at once", - "isOptional": true, - "defaultValue": "true" + "name": "selected", + "value": "Range | Date", + "description": "The selected date or range of dates", + "isOptional": true }, { - "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", + "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "Sets a disabled state", - "isOptional": true + "name": "month", + "value": "number", + "description": "The month to show, from 0 to 11. 0 is January, 1 is February ... 11 is December" }, { - "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", + "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "any", - "description": "The child elements to render in the dropzone.", - "isOptional": true + "name": "year", + "value": "number", + "description": "The year to show" }, { - "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", + "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", "syntaxKind": "PropertySignature", - "name": "dropOnPage", + "name": "allowRange", "value": "boolean", - "description": "Allows a file to be dropped anywhere on the page", + "description": "Allow a range of dates to be selected", "isOptional": true }, { - "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", + "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", "syntaxKind": "PropertySignature", - "name": "openFileDialog", - "value": "boolean", - "description": "Sets the default file dialog state", + "name": "disableDatesBefore", + "value": "Date", + "description": "Disable selecting dates before this.", "isOptional": true }, { - "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", + "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", "syntaxKind": "PropertySignature", - "name": "variableHeight", - "value": "boolean", - "description": "Allows child content to adjust height", + "name": "disableDatesAfter", + "value": "Date", + "description": "Disable selecting dates after this.", "isOptional": true }, { - "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", - "syntaxKind": "MethodSignature", - "name": "customValidator", - "value": "(file: File) => boolean", - "description": "Adds custom validations", + "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", + "syntaxKind": "PropertySignature", + "name": "disableSpecificDates", + "value": "Date[]", + "description": "Disable specific dates.", "isOptional": true }, { - "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", - "syntaxKind": "MethodSignature", - "name": "onClick", - "value": "(event: React.MouseEvent) => void", - "description": "Callback triggered on click", + "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", + "syntaxKind": "PropertySignature", + "name": "multiMonth", + "value": "boolean", + "description": "The selection can span multiple months", "isOptional": true }, { - "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", - "syntaxKind": "MethodSignature", - "name": "onDrop", - "value": "(files: File[], acceptedFiles: File[], rejectedFiles: File[]) => void", - "description": "Callback triggered on any file drop", - "isOptional": true + "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", + "syntaxKind": "PropertySignature", + "name": "weekStartsOn", + "value": "number", + "description": "First day of week, from 0 to 6. 0 is Sunday, 1 is Monday ... 6 is Saturday", + "isOptional": true, + "defaultValue": "0" }, { - "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", - "syntaxKind": "MethodSignature", - "name": "onDropAccepted", - "value": "(acceptedFiles: File[]) => void", - "description": "Callback triggered when at least one of the files dropped was accepted", + "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", + "syntaxKind": "PropertySignature", + "name": "dayAccessibilityLabelPrefix", + "value": "string", + "description": "Visually hidden prefix text for selected days on single selection date pickers", "isOptional": true }, { - "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", + "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", "syntaxKind": "MethodSignature", - "name": "onDropRejected", - "value": "(rejectedFiles: File[]) => void", - "description": "Callback triggered when at least one of the files dropped was rejected", + "name": "onChange", + "value": "(date: Range) => void", + "description": "Callback when date is selected.", "isOptional": true }, { - "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", + "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", "syntaxKind": "MethodSignature", - "name": "onDragOver", - "value": "() => void", - "description": "Callback triggered when one or more files are dragging over the drag area", + "name": "onMonthChange", + "value": "(month: number, year: number) => void", + "description": "Callback when month is changed.", "isOptional": true - }, + } + ], + "value": "export interface DatePickerProps {\n /** ID for the element */\n id?: string;\n /** The selected date or range of dates */\n selected?: Date | Range;\n /** The month to show, from 0 to 11. 0 is January, 1 is February ... 11 is December */\n month: number;\n /** The year to show */\n year: number;\n /** Allow a range of dates to be selected */\n allowRange?: boolean;\n /** Disable selecting dates before this. */\n disableDatesBefore?: Date;\n /** Disable selecting dates after this. */\n disableDatesAfter?: Date;\n /** Disable specific dates. */\n disableSpecificDates?: Date[];\n /** The selection can span multiple months */\n multiMonth?: boolean;\n /**\n * First day of week, from 0 to 6. 0 is Sunday, 1 is Monday ... 6 is Saturday\n * @default 0\n */\n weekStartsOn?: number;\n /** Visually hidden prefix text for selected days on single selection date pickers */\n dayAccessibilityLabelPrefix?: string;\n /** Callback when date is selected. */\n onChange?(date: Range): void;\n /** Callback when month is changed. */\n onMonthChange?(month: number, year: number): void;\n}" + } + }, + "Item": { + "polaris-react/src/components/DescriptionList/DescriptionList.tsx": { + "filePath": "polaris-react/src/components/DescriptionList/DescriptionList.tsx", + "name": "Item", + "description": "", + "members": [ { - "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", - "syntaxKind": "MethodSignature", - "name": "onDragEnter", - "value": "() => void", - "description": "Callback triggered when one or more files entered the drag area", - "isOptional": true + "filePath": "polaris-react/src/components/DescriptionList/DescriptionList.tsx", + "syntaxKind": "PropertySignature", + "name": "term", + "value": "React.ReactNode", + "description": "Title of the item" }, { - "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", - "syntaxKind": "MethodSignature", - "name": "onDragLeave", - "value": "() => void", - "description": "Callback triggered when one or more files left the drag area", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", - "syntaxKind": "MethodSignature", - "name": "onFileDialogClose", - "value": "() => void", - "description": "Callback triggered when the file dialog is canceled", - "isOptional": true + "filePath": "polaris-react/src/components/DescriptionList/DescriptionList.tsx", + "syntaxKind": "PropertySignature", + "name": "description", + "value": "React.ReactNode", + "description": "Item content" } ], - "value": "export interface DropZoneProps {\n /** Label for the file input */\n label?: React.ReactNode;\n /** Adds an action to the label */\n labelAction?: LabelledProps['action'];\n /** Visually hide the label */\n labelHidden?: boolean;\n /** ID for file input */\n id?: string;\n /** Allowed file types */\n accept?: string;\n /**\n * Whether is a file or an image\n * @default 'file'\n */\n type?: DropZoneFileType;\n /** Sets an active state */\n active?: boolean;\n /** Sets an error state */\n error?: boolean;\n /**\n * Displays an outline border\n * @default true\n */\n outline?: boolean;\n /**\n * Displays an overlay on hover\n * @default true\n */\n overlay?: boolean;\n /** Text that appears in the overlay */\n overlayText?: string;\n /** Text that appears in the overlay when set in error state */\n errorOverlayText?: string;\n /**\n * Allows multiple files to be uploaded at once\n * @default true\n */\n allowMultiple?: boolean;\n /** Sets a disabled state */\n disabled?: boolean;\n /** The child elements to render in the dropzone. */\n children?: string | React.ReactNode;\n /** Allows a file to be dropped anywhere on the page */\n dropOnPage?: boolean;\n /** Sets the default file dialog state */\n openFileDialog?: boolean;\n /** Allows child content to adjust height */\n variableHeight?: boolean;\n /** Adds custom validations */\n customValidator?(file: File): boolean;\n /** Callback triggered on click */\n onClick?(event: React.MouseEvent): void;\n /** Callback triggered on any file drop */\n onDrop?(files: File[], acceptedFiles: File[], rejectedFiles: File[]): void;\n /** Callback triggered when at least one of the files dropped was accepted */\n onDropAccepted?(acceptedFiles: File[]): void;\n /** Callback triggered when at least one of the files dropped was rejected */\n onDropRejected?(rejectedFiles: File[]): void;\n /** Callback triggered when one or more files are dragging over the drag area */\n onDragOver?(): void;\n /** Callback triggered when one or more files entered the drag area */\n onDragEnter?(): void;\n /** Callback triggered when one or more files left the drag area */\n onDragLeave?(): void;\n /** Callback triggered when the file dialog is canceled */\n onFileDialogClose?(): void;\n}" - } - }, - "DropZoneInputProps": { - "polaris-react/src/components/DropZone/DropZone.tsx": { - "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", - "name": "DropZoneInputProps", + "value": "interface Item {\n /** Title of the item */\n term: React.ReactNode;\n /** Item content */\n description: React.ReactNode;\n}" + }, + "polaris-react/src/components/ExceptionList/ExceptionList.tsx": { + "filePath": "polaris-react/src/components/ExceptionList/ExceptionList.tsx", + "name": "Item", "description": "", "members": [ { - "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "" - }, - { - "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", + "filePath": "polaris-react/src/components/ExceptionList/ExceptionList.tsx", "syntaxKind": "PropertySignature", - "name": "accept", - "value": "string", - "description": "", + "name": "status", + "value": "\"warning\" | \"critical\"", + "description": "Set the color of the icon and title for the given item.", "isOptional": true }, { - "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", + "filePath": "polaris-react/src/components/ExceptionList/ExceptionList.tsx", "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "" + "name": "icon", + "value": "any", + "description": "Icon displayed by the list item", + "isOptional": true }, { - "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", + "filePath": "polaris-react/src/components/ExceptionList/ExceptionList.tsx", "syntaxKind": "PropertySignature", - "name": "type", - "value": "DropZoneFileType", - "description": "" + "name": "title", + "value": "string", + "description": "Text displayed beside the icon", + "isOptional": true }, { - "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", + "filePath": "polaris-react/src/components/ExceptionList/ExceptionList.tsx", "syntaxKind": "PropertySignature", - "name": "multiple", - "value": "boolean", - "description": "" + "name": "description", + "value": "any", + "description": "Text displayed for the item", + "isOptional": true }, { - "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", + "filePath": "polaris-react/src/components/ExceptionList/ExceptionList.tsx", "syntaxKind": "PropertySignature", - "name": "openFileDialog", + "name": "truncate", "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", - "syntaxKind": "MethodSignature", - "name": "onChange", - "value": "(event: any) => void", - "description": "" - }, - { - "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", - "syntaxKind": "MethodSignature", - "name": "onFocus", - "value": "() => void", - "description": "" - }, - { - "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", - "syntaxKind": "MethodSignature", - "name": "onBlur", - "value": "() => void", - "description": "" - }, - { - "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", - "syntaxKind": "MethodSignature", - "name": "onFileDialogClose", - "value": "() => void", - "description": "", + "description": "Should the description be truncated at end of line", "isOptional": true } ], - "value": "interface DropZoneInputProps {\n id: string;\n accept?: string;\n disabled: boolean;\n type: DropZoneFileType;\n multiple: boolean;\n openFileDialog?: boolean;\n onChange(event: DragEvent | React.ChangeEvent): void;\n onFocus(): void;\n onBlur(): void;\n onFileDialogClose?(): void;\n}" + "value": "interface Item {\n /** Set the color of the icon and title for the given item. */\n status?: 'critical' | 'warning';\n /** Icon displayed by the list item */\n icon?: IconProps['source'];\n /** Text displayed beside the icon */\n title?: string;\n /** Text displayed for the item */\n description?: Description;\n /** Should the description be truncated at end of line */\n truncate?: boolean;\n}" } }, - "DropZoneContextType": { - "polaris-react/src/components/DropZone/context.tsx": { - "filePath": "polaris-react/src/components/DropZone/context.tsx", - "name": "DropZoneContextType", + "DescriptionListProps": { + "polaris-react/src/components/DescriptionList/DescriptionList.tsx": { + "filePath": "polaris-react/src/components/DescriptionList/DescriptionList.tsx", + "name": "DescriptionListProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/DropZone/context.tsx", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "" - }, - { - "filePath": "polaris-react/src/components/DropZone/context.tsx", - "syntaxKind": "PropertySignature", - "name": "focused", - "value": "boolean", - "description": "" - }, - { - "filePath": "polaris-react/src/components/DropZone/context.tsx", - "syntaxKind": "PropertySignature", - "name": "measuring", - "value": "boolean", - "description": "" - }, - { - "filePath": "polaris-react/src/components/DropZone/context.tsx", - "syntaxKind": "PropertySignature", - "name": "allowMultiple", - "value": "boolean", - "description": "" - }, - { - "filePath": "polaris-react/src/components/DropZone/context.tsx", + "filePath": "polaris-react/src/components/DescriptionList/DescriptionList.tsx", "syntaxKind": "PropertySignature", - "name": "size", - "value": "string", - "description": "" + "name": "items", + "value": "Item[]", + "description": "Collection of items for list" }, { - "filePath": "polaris-react/src/components/DropZone/context.tsx", + "filePath": "polaris-react/src/components/DescriptionList/DescriptionList.tsx", "syntaxKind": "PropertySignature", - "name": "type", - "value": "string", - "description": "" + "name": "spacing", + "value": "\"tight\" | \"loose\"", + "description": "Determines the spacing between list items", + "isOptional": true } ], - "value": "interface DropZoneContextType {\n disabled: boolean;\n focused: boolean;\n measuring: boolean;\n allowMultiple: boolean;\n size: string;\n type: string;\n}" + "value": "export interface DescriptionListProps {\n /** Collection of items for list */\n items: Item[];\n /** Determines the spacing between list items */\n spacing?: 'tight' | 'loose';\n}" } }, - "EmptySearchResultProps": { - "polaris-react/src/components/EmptySearchResult/EmptySearchResult.tsx": { - "filePath": "polaris-react/src/components/EmptySearchResult/EmptySearchResult.tsx", - "name": "EmptySearchResultProps", + "DisplayTextProps": { + "polaris-react/src/components/DisplayText/DisplayText.tsx": { + "filePath": "polaris-react/src/components/DisplayText/DisplayText.tsx", + "name": "DisplayTextProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/EmptySearchResult/EmptySearchResult.tsx", + "filePath": "polaris-react/src/components/DisplayText/DisplayText.tsx", "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "" + "name": "element", + "value": "HeadingTagName", + "description": "Name of element to use for text", + "isOptional": true, + "defaultValue": "'p'" }, { - "filePath": "polaris-react/src/components/EmptySearchResult/EmptySearchResult.tsx", + "filePath": "polaris-react/src/components/DisplayText/DisplayText.tsx", "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "", - "isOptional": true + "name": "size", + "value": "Size", + "description": "Size of the text", + "isOptional": true, + "defaultValue": "'medium'" }, { - "filePath": "polaris-react/src/components/EmptySearchResult/EmptySearchResult.tsx", + "filePath": "polaris-react/src/components/DisplayText/DisplayText.tsx", "syntaxKind": "PropertySignature", - "name": "withIllustration", - "value": "boolean", - "description": "", + "name": "children", + "value": "React.ReactNode", + "description": "Content to display", "isOptional": true } ], - "value": "export interface EmptySearchResultProps {\n title: string;\n description?: string;\n withIllustration?: boolean;\n}" + "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}" } }, - "EmptyStateProps": { - "polaris-react/src/components/EmptyState/EmptyState.tsx": { - "filePath": "polaris-react/src/components/EmptyState/EmptyState.tsx", - "name": "EmptyStateProps", + "DropZoneFileType": { + "polaris-react/src/components/DropZone/DropZone.tsx": { + "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "DropZoneFileType", + "value": "'file' | 'image' | 'video'", + "description": "" + } + }, + "DropZoneProps": { + "polaris-react/src/components/DropZone/DropZone.tsx": { + "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", + "name": "DropZoneProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/EmptyState/EmptyState.tsx", + "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", "syntaxKind": "PropertySignature", - "name": "heading", - "value": "string", - "description": "The empty state heading", + "name": "label", + "value": "React.ReactNode", + "description": "Label for the file input", "isOptional": true }, { - "filePath": "polaris-react/src/components/EmptyState/EmptyState.tsx", + "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", "syntaxKind": "PropertySignature", - "name": "image", - "value": "string", - "description": "The path to the image to display.\nThe image should have ~40px of white space above when empty state is used within a card, modal, or navigation component" + "name": "labelAction", + "value": "Action", + "description": "Adds an action to the label", + "isOptional": true }, { - "filePath": "polaris-react/src/components/EmptyState/EmptyState.tsx", + "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", "syntaxKind": "PropertySignature", - "name": "largeImage", - "value": "string", - "description": "The path to the image to display on large screens", + "name": "labelHidden", + "value": "boolean", + "description": "Visually hide the label", "isOptional": true }, { - "filePath": "polaris-react/src/components/EmptyState/EmptyState.tsx", + "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", "syntaxKind": "PropertySignature", - "name": "imageContained", - "value": "boolean", - "description": "Whether or not to limit the image to the size of its container on large screens", + "name": "id", + "value": "string", + "description": "ID for file input", "isOptional": true }, { - "filePath": "polaris-react/src/components/EmptyState/EmptyState.tsx", + "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", "syntaxKind": "PropertySignature", - "name": "fullWidth", - "value": "boolean", - "description": "Whether or not the content should span the full width of its container", + "name": "accept", + "value": "string", + "description": "Allowed file types", "isOptional": true }, { - "filePath": "polaris-react/src/components/EmptyState/EmptyState.tsx", + "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "Elements to display inside empty state", - "isOptional": true + "name": "type", + "value": "DropZoneFileType", + "description": "Whether is a file or an image", + "isOptional": true, + "defaultValue": "'file'" }, { - "filePath": "polaris-react/src/components/EmptyState/EmptyState.tsx", + "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", "syntaxKind": "PropertySignature", - "name": "action", - "value": "ComplexAction", - "description": "Primary action for empty state", + "name": "active", + "value": "boolean", + "description": "Sets an active state", "isOptional": true }, { - "filePath": "polaris-react/src/components/EmptyState/EmptyState.tsx", + "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", "syntaxKind": "PropertySignature", - "name": "secondaryAction", - "value": "ComplexAction", - "description": "Secondary action for empty state", + "name": "error", + "value": "boolean", + "description": "Sets an error state", "isOptional": true }, { - "filePath": "polaris-react/src/components/EmptyState/EmptyState.tsx", + "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", "syntaxKind": "PropertySignature", - "name": "footerContent", - "value": "React.ReactNode", - "description": "Secondary elements to display below empty state actions", - "isOptional": true - } - ], - "value": "export interface EmptyStateProps {\n /** The empty state heading */\n heading?: string;\n /**\n * The path to the image to display.\n * The image should have ~40px of white space above when empty state is used within a card, modal, or navigation component\n */\n image: string;\n /** The path to the image to display on large screens */\n largeImage?: string;\n /** Whether or not to limit the image to the size of its container on large screens */\n imageContained?: boolean;\n /** Whether or not the content should span the full width of its container */\n fullWidth?: boolean;\n /** Elements to display inside empty state */\n children?: React.ReactNode;\n /** Primary action for empty state */\n action?: ComplexAction;\n /** Secondary action for empty state */\n secondaryAction?: ComplexAction;\n /** Secondary elements to display below empty state actions */\n footerContent?: React.ReactNode;\n}" - } - }, - "DatePickerProps": { - "polaris-react/src/components/DatePicker/DatePicker.tsx": { - "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", - "name": "DatePickerProps", - "description": "", - "members": [ + "name": "outline", + "value": "boolean", + "description": "Displays an outline border", + "isOptional": true, + "defaultValue": "true" + }, { - "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", + "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "ID for the element", - "isOptional": true + "name": "overlay", + "value": "boolean", + "description": "Displays an overlay on hover", + "isOptional": true, + "defaultValue": "true" }, { - "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", + "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", "syntaxKind": "PropertySignature", - "name": "selected", - "value": "Range | Date", - "description": "The selected date or range of dates", + "name": "overlayText", + "value": "string", + "description": "Text that appears in the overlay", "isOptional": true }, { - "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", + "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", "syntaxKind": "PropertySignature", - "name": "month", - "value": "number", - "description": "The month to show, from 0 to 11. 0 is January, 1 is February ... 11 is December" + "name": "errorOverlayText", + "value": "string", + "description": "Text that appears in the overlay when set in error state", + "isOptional": true }, { - "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", + "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", "syntaxKind": "PropertySignature", - "name": "year", - "value": "number", - "description": "The year to show" + "name": "allowMultiple", + "value": "boolean", + "description": "Allows multiple files to be uploaded at once", + "isOptional": true, + "defaultValue": "true" }, { - "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", + "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", "syntaxKind": "PropertySignature", - "name": "allowRange", + "name": "disabled", "value": "boolean", - "description": "Allow a range of dates to be selected", + "description": "Sets a disabled state", "isOptional": true }, { - "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", + "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", "syntaxKind": "PropertySignature", - "name": "disableDatesBefore", - "value": "Date", - "description": "Disable selecting dates before this.", + "name": "children", + "value": "any", + "description": "The child elements to render in the dropzone.", "isOptional": true }, { - "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", + "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", "syntaxKind": "PropertySignature", - "name": "disableDatesAfter", - "value": "Date", - "description": "Disable selecting dates after this.", + "name": "dropOnPage", + "value": "boolean", + "description": "Allows a file to be dropped anywhere on the page", "isOptional": true }, { - "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", + "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", "syntaxKind": "PropertySignature", - "name": "disableSpecificDates", - "value": "Date[]", - "description": "Disable specific dates.", + "name": "openFileDialog", + "value": "boolean", + "description": "Sets the default file dialog state", "isOptional": true }, { - "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", + "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", "syntaxKind": "PropertySignature", - "name": "multiMonth", + "name": "variableHeight", "value": "boolean", - "description": "The selection can span multiple months", + "description": "Allows child content to adjust height", "isOptional": true }, { - "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", - "syntaxKind": "PropertySignature", - "name": "weekStartsOn", - "value": "number", - "description": "First day of week, from 0 to 6. 0 is Sunday, 1 is Monday ... 6 is Saturday", - "isOptional": true, - "defaultValue": "0" + "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", + "syntaxKind": "MethodSignature", + "name": "customValidator", + "value": "(file: File) => boolean", + "description": "Adds custom validations", + "isOptional": true }, { - "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", - "syntaxKind": "PropertySignature", - "name": "dayAccessibilityLabelPrefix", - "value": "string", - "description": "Visually hidden prefix text for selected days on single selection date pickers", + "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", + "syntaxKind": "MethodSignature", + "name": "onClick", + "value": "(event: React.MouseEvent) => void", + "description": "Callback triggered on click", "isOptional": true }, { - "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", + "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", "syntaxKind": "MethodSignature", - "name": "onChange", - "value": "(date: Range) => void", - "description": "Callback when date is selected.", + "name": "onDrop", + "value": "(files: File[], acceptedFiles: File[], rejectedFiles: File[]) => void", + "description": "Callback triggered on any file drop", "isOptional": true }, { - "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", + "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", "syntaxKind": "MethodSignature", - "name": "onMonthChange", - "value": "(month: number, year: number) => void", - "description": "Callback when month is changed.", + "name": "onDropAccepted", + "value": "(acceptedFiles: File[]) => void", + "description": "Callback triggered when at least one of the files dropped was accepted", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", + "syntaxKind": "MethodSignature", + "name": "onDropRejected", + "value": "(rejectedFiles: File[]) => void", + "description": "Callback triggered when at least one of the files dropped was rejected", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", + "syntaxKind": "MethodSignature", + "name": "onDragOver", + "value": "() => void", + "description": "Callback triggered when one or more files are dragging over the drag area", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", + "syntaxKind": "MethodSignature", + "name": "onDragEnter", + "value": "() => void", + "description": "Callback triggered when one or more files entered the drag area", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", + "syntaxKind": "MethodSignature", + "name": "onDragLeave", + "value": "() => void", + "description": "Callback triggered when one or more files left the drag area", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", + "syntaxKind": "MethodSignature", + "name": "onFileDialogClose", + "value": "() => void", + "description": "Callback triggered when the file dialog is canceled", "isOptional": true } ], - "value": "export interface DatePickerProps {\n /** ID for the element */\n id?: string;\n /** The selected date or range of dates */\n selected?: Date | Range;\n /** The month to show, from 0 to 11. 0 is January, 1 is February ... 11 is December */\n month: number;\n /** The year to show */\n year: number;\n /** Allow a range of dates to be selected */\n allowRange?: boolean;\n /** Disable selecting dates before this. */\n disableDatesBefore?: Date;\n /** Disable selecting dates after this. */\n disableDatesAfter?: Date;\n /** Disable specific dates. */\n disableSpecificDates?: Date[];\n /** The selection can span multiple months */\n multiMonth?: boolean;\n /**\n * First day of week, from 0 to 6. 0 is Sunday, 1 is Monday ... 6 is Saturday\n * @default 0\n */\n weekStartsOn?: number;\n /** Visually hidden prefix text for selected days on single selection date pickers */\n dayAccessibilityLabelPrefix?: string;\n /** Callback when date is selected. */\n onChange?(date: Range): void;\n /** Callback when month is changed. */\n onMonthChange?(month: number, year: number): void;\n}" - } - }, - "TableRow": { - "polaris-react/src/components/DataTable/DataTable.tsx": { - "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "TableRow", - "value": "DataTableProps['headings'] | DataTableProps['rows'] | DataTableProps['totals']", - "description": "" - } - }, - "TableData": { - "polaris-react/src/components/DataTable/DataTable.tsx": { - "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "TableData", - "value": "string | number | React.ReactNode", - "description": "" - } - }, - "ColumnContentType": { - "polaris-react/src/components/DataTable/DataTable.tsx": { - "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "ColumnContentType", - "value": "'text' | 'numeric'", - "description": "" + "value": "export interface DropZoneProps {\n /** Label for the file input */\n label?: React.ReactNode;\n /** Adds an action to the label */\n labelAction?: LabelledProps['action'];\n /** Visually hide the label */\n labelHidden?: boolean;\n /** ID for file input */\n id?: string;\n /** Allowed file types */\n accept?: string;\n /**\n * Whether is a file or an image\n * @default 'file'\n */\n type?: DropZoneFileType;\n /** Sets an active state */\n active?: boolean;\n /** Sets an error state */\n error?: boolean;\n /**\n * Displays an outline border\n * @default true\n */\n outline?: boolean;\n /**\n * Displays an overlay on hover\n * @default true\n */\n overlay?: boolean;\n /** Text that appears in the overlay */\n overlayText?: string;\n /** Text that appears in the overlay when set in error state */\n errorOverlayText?: string;\n /**\n * Allows multiple files to be uploaded at once\n * @default true\n */\n allowMultiple?: boolean;\n /** Sets a disabled state */\n disabled?: boolean;\n /** The child elements to render in the dropzone. */\n children?: string | React.ReactNode;\n /** Allows a file to be dropped anywhere on the page */\n dropOnPage?: boolean;\n /** Sets the default file dialog state */\n openFileDialog?: boolean;\n /** Allows child content to adjust height */\n variableHeight?: boolean;\n /** Adds custom validations */\n customValidator?(file: File): boolean;\n /** Callback triggered on click */\n onClick?(event: React.MouseEvent): void;\n /** Callback triggered on any file drop */\n onDrop?(files: File[], acceptedFiles: File[], rejectedFiles: File[]): void;\n /** Callback triggered when at least one of the files dropped was accepted */\n onDropAccepted?(acceptedFiles: File[]): void;\n /** Callback triggered when at least one of the files dropped was rejected */\n onDropRejected?(rejectedFiles: File[]): void;\n /** Callback triggered when one or more files are dragging over the drag area */\n onDragOver?(): void;\n /** Callback triggered when one or more files entered the drag area */\n onDragEnter?(): void;\n /** Callback triggered when one or more files left the drag area */\n onDragLeave?(): void;\n /** Callback triggered when the file dialog is canceled */\n onFileDialogClose?(): void;\n}" } }, - "DataTableProps": { - "polaris-react/src/components/DataTable/DataTable.tsx": { - "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", - "name": "DataTableProps", + "DropZoneInputProps": { + "polaris-react/src/components/DropZone/DropZone.tsx": { + "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", + "name": "DropZoneInputProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", + "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", "syntaxKind": "PropertySignature", - "name": "columnContentTypes", - "value": "ColumnContentType[]", - "description": "List of data types, which determines content alignment for each column. Data types are \"text,\" which aligns left, or \"numeric,\" which aligns right." + "name": "id", + "value": "string", + "description": "" }, { - "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", + "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", "syntaxKind": "PropertySignature", - "name": "headings", - "value": "React.ReactNode[]", - "description": "List of column headings." + "name": "accept", + "value": "string", + "description": "", + "isOptional": true }, { - "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", + "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", "syntaxKind": "PropertySignature", - "name": "totals", - "value": "any[]", - "description": "List of numeric column totals, highlighted in the table’s header below column headings. Use empty strings as placeholders for columns with no total.", - "isOptional": true + "name": "disabled", + "value": "boolean", + "description": "" }, { - "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", + "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", "syntaxKind": "PropertySignature", - "name": "totalsName", - "value": "{ singular: React.ReactNode; plural: React.ReactNode; }", - "description": "Custom totals row heading", - "isOptional": true + "name": "type", + "value": "DropZoneFileType", + "description": "" }, { - "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", + "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", "syntaxKind": "PropertySignature", - "name": "showTotalsInFooter", + "name": "multiple", "value": "boolean", - "description": "Placement of totals row within table", + "description": "" + }, + { + "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", + "syntaxKind": "PropertySignature", + "name": "openFileDialog", + "value": "boolean", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", + "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", + "syntaxKind": "MethodSignature", + "name": "onChange", + "value": "(event: any) => void", + "description": "" + }, + { + "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", + "syntaxKind": "MethodSignature", + "name": "onFocus", + "value": "() => void", + "description": "" + }, + { + "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", + "syntaxKind": "MethodSignature", + "name": "onBlur", + "value": "() => void", + "description": "" + }, + { + "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", + "syntaxKind": "MethodSignature", + "name": "onFileDialogClose", + "value": "() => void", + "description": "", + "isOptional": true + } + ], + "value": "interface DropZoneInputProps {\n id: string;\n accept?: string;\n disabled: boolean;\n type: DropZoneFileType;\n multiple: boolean;\n openFileDialog?: boolean;\n onChange(event: DragEvent | React.ChangeEvent): void;\n onFocus(): void;\n onBlur(): void;\n onFileDialogClose?(): void;\n}" + } + }, + "DropZoneContextType": { + "polaris-react/src/components/DropZone/context.tsx": { + "filePath": "polaris-react/src/components/DropZone/context.tsx", + "name": "DropZoneContextType", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/DropZone/context.tsx", "syntaxKind": "PropertySignature", - "name": "rows", - "value": "any[][]", - "description": "Lists of data points which map to table body rows." + "name": "disabled", + "value": "boolean", + "description": "" }, { - "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", + "filePath": "polaris-react/src/components/DropZone/context.tsx", "syntaxKind": "PropertySignature", - "name": "hideScrollIndicator", + "name": "focused", "value": "boolean", - "description": "Hide column visibility and navigation buttons above the header when the table horizontally collapses to be scrollable.", - "isOptional": true, - "defaultValue": "false" + "description": "" }, { - "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", + "filePath": "polaris-react/src/components/DropZone/context.tsx", "syntaxKind": "PropertySignature", - "name": "truncate", + "name": "measuring", "value": "boolean", - "description": "Truncate content in first column instead of wrapping.", - "isOptional": true, - "defaultValue": "true" + "description": "" }, { - "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", + "filePath": "polaris-react/src/components/DropZone/context.tsx", "syntaxKind": "PropertySignature", - "name": "verticalAlign", - "value": "VerticalAlign", - "description": "Vertical alignment of content in the cells.", - "isOptional": true, - "defaultValue": "'top'" + "name": "allowMultiple", + "value": "boolean", + "description": "" }, { - "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", + "filePath": "polaris-react/src/components/DropZone/context.tsx", "syntaxKind": "PropertySignature", - "name": "footerContent", - "value": "any", - "description": "Content centered in the full width cell of the table footer row.", + "name": "size", + "value": "string", + "description": "" + }, + { + "filePath": "polaris-react/src/components/DropZone/context.tsx", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "string", + "description": "" + } + ], + "value": "interface DropZoneContextType {\n disabled: boolean;\n focused: boolean;\n measuring: boolean;\n allowMultiple: boolean;\n size: string;\n type: string;\n}" + } + }, + "EmptySearchResultProps": { + "polaris-react/src/components/EmptySearchResult/EmptySearchResult.tsx": { + "filePath": "polaris-react/src/components/EmptySearchResult/EmptySearchResult.tsx", + "name": "EmptySearchResultProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/EmptySearchResult/EmptySearchResult.tsx", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "" + }, + { + "filePath": "polaris-react/src/components/EmptySearchResult/EmptySearchResult.tsx", + "syntaxKind": "PropertySignature", + "name": "description", + "value": "string", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", + "filePath": "polaris-react/src/components/EmptySearchResult/EmptySearchResult.tsx", "syntaxKind": "PropertySignature", - "name": "hoverable", + "name": "withIllustration", "value": "boolean", - "description": "Table row has hover state. Defaults to true.", + "description": "", "isOptional": true - }, + } + ], + "value": "export interface EmptySearchResultProps {\n title: string;\n description?: string;\n withIllustration?: boolean;\n}" + } + }, + "EmptyStateProps": { + "polaris-react/src/components/EmptyState/EmptyState.tsx": { + "filePath": "polaris-react/src/components/EmptyState/EmptyState.tsx", + "name": "EmptyStateProps", + "description": "", + "members": [ { - "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", + "filePath": "polaris-react/src/components/EmptyState/EmptyState.tsx", "syntaxKind": "PropertySignature", - "name": "sortable", - "value": "boolean[]", - "description": "List of booleans, which maps to whether sorting is enabled or not for each column. Defaults to false for all columns.", + "name": "heading", + "value": "string", + "description": "The empty state heading", "isOptional": true }, { - "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", + "filePath": "polaris-react/src/components/EmptyState/EmptyState.tsx", "syntaxKind": "PropertySignature", - "name": "defaultSortDirection", - "value": "SortDirection", - "description": "The direction to sort the table rows on first click or keypress of a sortable column heading. Defaults to ascending.", - "isOptional": true, - "defaultValue": "'ascending'" + "name": "image", + "value": "string", + "description": "The path to the image to display.\nThe image should have ~40px of white space above when empty state is used within a card, modal, or navigation component" }, { - "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", + "filePath": "polaris-react/src/components/EmptyState/EmptyState.tsx", "syntaxKind": "PropertySignature", - "name": "initialSortColumnIndex", - "value": "number", - "description": "The index of the heading that the table rows are initially sorted by. Defaults to the first column.", - "isOptional": true, - "defaultValue": "0" - }, - { - "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", - "syntaxKind": "MethodSignature", - "name": "onSort", - "value": "(headingIndex: number, direction: SortDirection) => void", - "description": "Callback fired on click or keypress of a sortable column heading.", + "name": "largeImage", + "value": "string", + "description": "The path to the image to display on large screens", "isOptional": true }, { - "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", + "filePath": "polaris-react/src/components/EmptyState/EmptyState.tsx", "syntaxKind": "PropertySignature", - "name": "increasedTableDensity", + "name": "imageContained", "value": "boolean", - "description": "Increased density", + "description": "Whether or not to limit the image to the size of its container on large screens", "isOptional": true }, { - "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", + "filePath": "polaris-react/src/components/EmptyState/EmptyState.tsx", "syntaxKind": "PropertySignature", - "name": "hasZebraStripingOnData", + "name": "fullWidth", "value": "boolean", - "description": "Add zebra striping to data rows", + "description": "Whether or not the content should span the full width of its container", "isOptional": true }, { - "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", + "filePath": "polaris-react/src/components/EmptyState/EmptyState.tsx", "syntaxKind": "PropertySignature", - "name": "stickyHeader", - "value": "boolean", - "description": "Header becomes sticky and pins to top of table when scrolling", + "name": "children", + "value": "React.ReactNode", + "description": "Elements to display inside empty state", "isOptional": true }, { - "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", + "filePath": "polaris-react/src/components/EmptyState/EmptyState.tsx", "syntaxKind": "PropertySignature", - "name": "hasFixedFirstColumn", - "value": "boolean", - "description": "", - "isOptional": true, - "deprecationMessage": "Add a fixed first column on horizontal scroll. Use fixedFirstColumns={n} instead." + "name": "action", + "value": "ComplexAction", + "description": "Primary action for empty state", + "isOptional": true }, { - "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", + "filePath": "polaris-react/src/components/EmptyState/EmptyState.tsx", "syntaxKind": "PropertySignature", - "name": "fixedFirstColumns", - "value": "number", - "description": "Add fixed columns on horizontal scroll.", + "name": "secondaryAction", + "value": "ComplexAction", + "description": "Secondary action for empty state", "isOptional": true }, { - "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", + "filePath": "polaris-react/src/components/EmptyState/EmptyState.tsx", "syntaxKind": "PropertySignature", - "name": "firstColumnMinWidth", - "value": "string", - "description": "Specify a min width for the first column if neccessary", + "name": "footerContent", + "value": "React.ReactNode", + "description": "Secondary elements to display below empty state actions", "isOptional": true } ], - "value": "export interface DataTableProps {\n /** List of data types, which determines content alignment for each column. Data types are \"text,\" which aligns left, or \"numeric,\" which aligns right. */\n columnContentTypes: ColumnContentType[];\n /** List of column headings. */\n headings: React.ReactNode[];\n /** List of numeric column totals, highlighted in the table’s header below column headings. Use empty strings as placeholders for columns with no total. */\n totals?: TableData[];\n /** Custom totals row heading */\n totalsName?: {\n singular: React.ReactNode;\n plural: React.ReactNode;\n };\n /** Placement of totals row within table */\n showTotalsInFooter?: boolean;\n /** Lists of data points which map to table body rows. */\n rows: TableData[][];\n /** Hide column visibility and navigation buttons above the header when the table horizontally collapses to be scrollable.\n * @default false\n */\n hideScrollIndicator?: boolean;\n /** Truncate content in first column instead of wrapping.\n * @default true\n */\n truncate?: boolean;\n /** Vertical alignment of content in the cells.\n * @default 'top'\n */\n verticalAlign?: VerticalAlign;\n /** Content centered in the full width cell of the table footer row. */\n footerContent?: TableData;\n /** Table row has hover state. Defaults to true. */\n hoverable?: boolean;\n /** List of booleans, which maps to whether sorting is enabled or not for each column. Defaults to false for all columns. */\n sortable?: boolean[];\n /**\n * The direction to sort the table rows on first click or keypress of a sortable column heading. Defaults to ascending.\n * @default 'ascending'\n */\n defaultSortDirection?: SortDirection;\n /**\n * The index of the heading that the table rows are initially sorted by. Defaults to the first column.\n * @default 0\n */\n initialSortColumnIndex?: number;\n /** Callback fired on click or keypress of a sortable column heading. */\n onSort?(headingIndex: number, direction: SortDirection): void;\n /** Increased density */\n increasedTableDensity?: boolean;\n /** Add zebra striping to data rows */\n hasZebraStripingOnData?: boolean;\n /** Header becomes sticky and pins to top of table when scrolling */\n stickyHeader?: boolean;\n /** @deprecated Add a fixed first column on horizontal scroll. Use fixedFirstColumns={n} instead. */\n hasFixedFirstColumn?: boolean;\n /** Add fixed columns on horizontal scroll. */\n fixedFirstColumns?: number;\n /** Specify a min width for the first column if neccessary */\n firstColumnMinWidth?: string;\n}" + "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": { @@ -15546,224 +15624,85 @@ "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 - }, - { - "filePath": "polaris-react/src/components/Page/Page.tsx", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "Page title, in large type", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Page/Page.tsx", - "syntaxKind": "PropertySignature", - "name": "subtitle", - "value": "string", - "description": "Page subtitle, in regular type", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Page/Page.tsx", - "syntaxKind": "PropertySignature", - "name": "titleMetadata", - "value": "React.ReactNode", - "description": "Important and non-interactive status information shown immediately after the title.", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Page/Page.tsx", - "syntaxKind": "PropertySignature", - "name": "compactTitle", - "value": "boolean", - "description": "Removes spacing between title and subtitle", - "isOptional": true - } - ], - "value": "export interface PageProps extends HeaderProps {\n /** The contents of the page */\n children?: React.ReactNode;\n /** Remove the normal max-width on the page */\n fullWidth?: boolean;\n /** Decreases the maximum layout width. Intended for single-column layouts */\n narrowWidth?: boolean;\n /** Displays a divider between the page header and the page content */\n divider?: boolean;\n}" - } - }, - "PageActionsProps": { - "polaris-react/src/components/PageActions/PageActions.tsx": { - "filePath": "polaris-react/src/components/PageActions/PageActions.tsx", - "name": "PageActionsProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/PageActions/PageActions.tsx", - "syntaxKind": "PropertySignature", - "name": "primaryAction", - "value": "any", - "description": "The primary action for the page", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/PageActions/PageActions.tsx", - "syntaxKind": "PropertySignature", - "name": "secondaryActions", - "value": "any", - "description": "The secondary actions for the page", - "isOptional": true - } - ], - "value": "export interface PageActionsProps {\n /** The primary action for the page */\n primaryAction?: (DisableableAction & LoadableAction) | React.ReactNode;\n /** The secondary actions for the page */\n secondaryActions?: ComplexAction[] | React.ReactNode;\n}" - } - }, - "MaybeJSX": { - "polaris-react/src/components/PageActions/PageActions.tsx": { - "filePath": "polaris-react/src/components/PageActions/PageActions.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "MaybeJSX", - "value": "JSX.Element | null", - "description": "" - }, - "polaris-react/src/components/Page/components/Header/Header.tsx": { - "filePath": "polaris-react/src/components/Page/components/Header/Header.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "MaybeJSX", - "value": "JSX.Element | null", - "description": "" - } - }, - "MediaQueryContextType": { - "polaris-react/src/components/PolarisTestProvider/PolarisTestProvider.tsx": { - "filePath": "polaris-react/src/components/PolarisTestProvider/PolarisTestProvider.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "MediaQueryContextType", - "value": "NonNullable<\n React.ContextType\n>", - "description": "" - }, - "polaris-react/src/utilities/media-query/context.tsx": { - "filePath": "polaris-react/src/utilities/media-query/context.tsx", - "name": "MediaQueryContextType", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/utilities/media-query/context.tsx", - "syntaxKind": "PropertySignature", - "name": "isNavigationCollapsed", - "value": "boolean", - "description": "" - } - ], - "value": "export interface MediaQueryContextType {\n isNavigationCollapsed: boolean;\n}" - } - }, - "WithPolarisTestProviderOptions": { - "polaris-react/src/components/PolarisTestProvider/PolarisTestProvider.tsx": { - "filePath": "polaris-react/src/components/PolarisTestProvider/PolarisTestProvider.tsx", - "name": "WithPolarisTestProviderOptions", - "description": "When writing a custom mounting function `mountWithAppContext(node, options)`\nthis is the type of the options object. These values are customizable when\nyou call the app", - "members": [ - { - "filePath": "polaris-react/src/components/PolarisTestProvider/PolarisTestProvider.tsx", - "syntaxKind": "PropertySignature", - "name": "i18n", - "value": "TranslationDictionary | TranslationDictionary[]", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/PolarisTestProvider/PolarisTestProvider.tsx", - "syntaxKind": "PropertySignature", - "name": "link", - "value": "LinkLikeComponent", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/PolarisTestProvider/PolarisTestProvider.tsx", - "syntaxKind": "PropertySignature", - "name": "mediaQuery", - "value": "Partial", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/PolarisTestProvider/PolarisTestProvider.tsx", - "syntaxKind": "PropertySignature", - "name": "features", - "value": "FeaturesConfig", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/PolarisTestProvider/PolarisTestProvider.tsx", - "syntaxKind": "PropertySignature", - "name": "frame", - "value": "Partial", - "description": "", - "isOptional": true - } - ], - "value": "export interface WithPolarisTestProviderOptions {\n // Contexts provided by AppProvider\n i18n?: ConstructorParameters[0];\n link?: LinkLikeComponent;\n mediaQuery?: Partial;\n features?: FeaturesConfig;\n // Contexts provided by Frame\n frame?: Partial;\n}" - } - }, - "PolarisTestProviderProps": { - "polaris-react/src/components/PolarisTestProvider/PolarisTestProvider.tsx": { - "filePath": "polaris-react/src/components/PolarisTestProvider/PolarisTestProvider.tsx", - "name": "PolarisTestProviderProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/PolarisTestProvider/PolarisTestProvider.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactElement", - "description": "" - }, - { - "filePath": "polaris-react/src/components/PolarisTestProvider/PolarisTestProvider.tsx", - "syntaxKind": "PropertySignature", - "name": "strict", - "value": "boolean", - "description": "", + "description": "Callback that returns true when secondary actions are rolled up into action groups, and false when not", "isOptional": true }, { - "filePath": "polaris-react/src/components/PolarisTestProvider/PolarisTestProvider.tsx", + "filePath": "polaris-react/src/components/Page/Page.tsx", "syntaxKind": "PropertySignature", - "name": "i18n", - "value": "TranslationDictionary | TranslationDictionary[]", - "description": "", + "name": "title", + "value": "string", + "description": "Page title, in large type", "isOptional": true }, { - "filePath": "polaris-react/src/components/PolarisTestProvider/PolarisTestProvider.tsx", + "filePath": "polaris-react/src/components/Page/Page.tsx", "syntaxKind": "PropertySignature", - "name": "link", - "value": "LinkLikeComponent", - "description": "", + "name": "subtitle", + "value": "string", + "description": "Page subtitle, in regular type", "isOptional": true }, { - "filePath": "polaris-react/src/components/PolarisTestProvider/PolarisTestProvider.tsx", + "filePath": "polaris-react/src/components/Page/Page.tsx", "syntaxKind": "PropertySignature", - "name": "mediaQuery", - "value": "Partial", - "description": "", + "name": "titleMetadata", + "value": "React.ReactNode", + "description": "Important and non-interactive status information shown immediately after the title.", "isOptional": true }, { - "filePath": "polaris-react/src/components/PolarisTestProvider/PolarisTestProvider.tsx", + "filePath": "polaris-react/src/components/Page/Page.tsx", "syntaxKind": "PropertySignature", - "name": "features", - "value": "FeaturesConfig", - "description": "", + "name": "compactTitle", + "value": "boolean", + "description": "Removes spacing between title and subtitle", + "isOptional": true + } + ], + "value": "export interface PageProps extends HeaderProps {\n /** The contents of the page */\n children?: React.ReactNode;\n /** Remove the normal max-width on the page */\n fullWidth?: boolean;\n /** Decreases the maximum layout width. Intended for single-column layouts */\n narrowWidth?: boolean;\n /** Displays a divider between the page header and the page content */\n divider?: boolean;\n}" + } + }, + "PageActionsProps": { + "polaris-react/src/components/PageActions/PageActions.tsx": { + "filePath": "polaris-react/src/components/PageActions/PageActions.tsx", + "name": "PageActionsProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/PageActions/PageActions.tsx", + "syntaxKind": "PropertySignature", + "name": "primaryAction", + "value": "any", + "description": "The primary action for the page", "isOptional": true }, { - "filePath": "polaris-react/src/components/PolarisTestProvider/PolarisTestProvider.tsx", + "filePath": "polaris-react/src/components/PageActions/PageActions.tsx", "syntaxKind": "PropertySignature", - "name": "frame", - "value": "Partial", - "description": "", + "name": "secondaryActions", + "value": "any", + "description": "The secondary actions for the page", "isOptional": true } ], - "value": "export interface PolarisTestProviderProps\n extends WithPolarisTestProviderOptions {\n children: React.ReactElement;\n strict?: boolean;\n}" + "value": "export interface PageActionsProps {\n /** The primary action for the page */\n primaryAction?: (DisableableAction & LoadableAction) | React.ReactNode;\n /** The secondary actions for the page */\n secondaryActions?: ComplexAction[] | React.ReactNode;\n}" + } + }, + "MaybeJSX": { + "polaris-react/src/components/PageActions/PageActions.tsx": { + "filePath": "polaris-react/src/components/PageActions/PageActions.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "MaybeJSX", + "value": "JSX.Element | null", + "description": "" + }, + "polaris-react/src/components/Page/components/Header/Header.tsx": { + "filePath": "polaris-react/src/components/Page/components/Header/Header.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "MaybeJSX", + "value": "JSX.Element | null", + "description": "" } }, "AccessibilityLabels": { @@ -15904,6 +15843,145 @@ "value": "export interface PaginationProps {\n /** Keyboard shortcuts for the next button */\n nextKeys?: Key[];\n /** Keyboard shortcuts for the previous button */\n previousKeys?: Key[];\n /** Tooltip for the next button */\n nextTooltip?: string;\n /** Tooltip for the previous button */\n previousTooltip?: string;\n /** The URL of the next page */\n nextURL?: string;\n /** The URL of the previous page */\n previousURL?: string;\n /** Whether there is a next page to show */\n hasNext?: boolean;\n /** Whether there is a previous page to show */\n hasPrevious?: boolean;\n /** Accessible label for the pagination */\n accessibilityLabel?: string;\n /** Accessible labels for the buttons and UnstyledLinks */\n accessibilityLabels?: AccessibilityLabels;\n /** Callback when next button is clicked */\n onNext?(): void;\n /** Callback when previous button is clicked */\n onPrevious?(): void;\n /** Text to provide more context in between the arrow buttons */\n label?: React.ReactNode;\n}" } }, + "MediaQueryContextType": { + "polaris-react/src/components/PolarisTestProvider/PolarisTestProvider.tsx": { + "filePath": "polaris-react/src/components/PolarisTestProvider/PolarisTestProvider.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "MediaQueryContextType", + "value": "NonNullable<\n React.ContextType\n>", + "description": "" + }, + "polaris-react/src/utilities/media-query/context.tsx": { + "filePath": "polaris-react/src/utilities/media-query/context.tsx", + "name": "MediaQueryContextType", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/utilities/media-query/context.tsx", + "syntaxKind": "PropertySignature", + "name": "isNavigationCollapsed", + "value": "boolean", + "description": "" + } + ], + "value": "export interface MediaQueryContextType {\n isNavigationCollapsed: boolean;\n}" + } + }, + "WithPolarisTestProviderOptions": { + "polaris-react/src/components/PolarisTestProvider/PolarisTestProvider.tsx": { + "filePath": "polaris-react/src/components/PolarisTestProvider/PolarisTestProvider.tsx", + "name": "WithPolarisTestProviderOptions", + "description": "When writing a custom mounting function `mountWithAppContext(node, options)`\nthis is the type of the options object. These values are customizable when\nyou call the app", + "members": [ + { + "filePath": "polaris-react/src/components/PolarisTestProvider/PolarisTestProvider.tsx", + "syntaxKind": "PropertySignature", + "name": "i18n", + "value": "TranslationDictionary | TranslationDictionary[]", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/PolarisTestProvider/PolarisTestProvider.tsx", + "syntaxKind": "PropertySignature", + "name": "link", + "value": "LinkLikeComponent", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/PolarisTestProvider/PolarisTestProvider.tsx", + "syntaxKind": "PropertySignature", + "name": "mediaQuery", + "value": "Partial", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/PolarisTestProvider/PolarisTestProvider.tsx", + "syntaxKind": "PropertySignature", + "name": "features", + "value": "FeaturesConfig", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/PolarisTestProvider/PolarisTestProvider.tsx", + "syntaxKind": "PropertySignature", + "name": "frame", + "value": "Partial", + "description": "", + "isOptional": true + } + ], + "value": "export interface WithPolarisTestProviderOptions {\n // Contexts provided by AppProvider\n i18n?: ConstructorParameters[0];\n link?: LinkLikeComponent;\n mediaQuery?: Partial;\n features?: FeaturesConfig;\n // Contexts provided by Frame\n frame?: Partial;\n}" + } + }, + "PolarisTestProviderProps": { + "polaris-react/src/components/PolarisTestProvider/PolarisTestProvider.tsx": { + "filePath": "polaris-react/src/components/PolarisTestProvider/PolarisTestProvider.tsx", + "name": "PolarisTestProviderProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/PolarisTestProvider/PolarisTestProvider.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactElement", + "description": "" + }, + { + "filePath": "polaris-react/src/components/PolarisTestProvider/PolarisTestProvider.tsx", + "syntaxKind": "PropertySignature", + "name": "strict", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/PolarisTestProvider/PolarisTestProvider.tsx", + "syntaxKind": "PropertySignature", + "name": "i18n", + "value": "TranslationDictionary | TranslationDictionary[]", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/PolarisTestProvider/PolarisTestProvider.tsx", + "syntaxKind": "PropertySignature", + "name": "link", + "value": "LinkLikeComponent", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/PolarisTestProvider/PolarisTestProvider.tsx", + "syntaxKind": "PropertySignature", + "name": "mediaQuery", + "value": "Partial", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/PolarisTestProvider/PolarisTestProvider.tsx", + "syntaxKind": "PropertySignature", + "name": "features", + "value": "FeaturesConfig", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/PolarisTestProvider/PolarisTestProvider.tsx", + "syntaxKind": "PropertySignature", + "name": "frame", + "value": "Partial", + "description": "", + "isOptional": true + } + ], + "value": "export interface PolarisTestProviderProps\n extends WithPolarisTestProviderOptions {\n children: React.ReactElement;\n strict?: boolean;\n}" + } + }, "PopoverProps": { "polaris-react/src/components/Popover/Popover.tsx": { "filePath": "polaris-react/src/components/Popover/Popover.tsx", @@ -17474,57 +17552,19 @@ "syntaxKind": "PropertySignature", "name": "action", "value": "ComplexAction", - "description": "Card header actions", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/SettingToggle/SettingToggle.tsx", - "syntaxKind": "PropertySignature", - "name": "enabled", - "value": "boolean", - "description": "Sets toggle state to activated or deactivated", - "isOptional": true - } - ], - "value": "export interface SettingToggleProps {\n /** Inner content of the card */\n children?: React.ReactNode;\n /** Card header actions */\n action?: ComplexAction;\n /** Sets toggle state to activated or deactivated */\n enabled?: boolean;\n}" - } - }, - "SkeletonBodyTextProps": { - "polaris-react/src/components/SkeletonBodyText/SkeletonBodyText.tsx": { - "filePath": "polaris-react/src/components/SkeletonBodyText/SkeletonBodyText.tsx", - "name": "SkeletonBodyTextProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/SkeletonBodyText/SkeletonBodyText.tsx", - "syntaxKind": "PropertySignature", - "name": "lines", - "value": "number", - "description": "Number of lines to display", - "isOptional": true, - "defaultValue": "3" - } - ], - "value": "export interface SkeletonBodyTextProps {\n /**\n * Number of lines to display\n * @default 3\n */\n lines?: number;\n}" - } - }, - "SkeletonDisplayTextProps": { - "polaris-react/src/components/SkeletonDisplayText/SkeletonDisplayText.tsx": { - "filePath": "polaris-react/src/components/SkeletonDisplayText/SkeletonDisplayText.tsx", - "name": "SkeletonDisplayTextProps", - "description": "", - "members": [ + "description": "Card header actions", + "isOptional": true + }, { - "filePath": "polaris-react/src/components/SkeletonDisplayText/SkeletonDisplayText.tsx", + "filePath": "polaris-react/src/components/SettingToggle/SettingToggle.tsx", "syntaxKind": "PropertySignature", - "name": "size", - "value": "Size", - "description": "Size of the text", - "isOptional": true, - "defaultValue": "'medium'" + "name": "enabled", + "value": "boolean", + "description": "Sets toggle state to activated or deactivated", + "isOptional": true } ], - "value": "export interface SkeletonDisplayTextProps {\n /**\n * Size of the text\n * @default 'medium'\n */\n size?: Size;\n}" + "value": "export interface SettingToggleProps {\n /** Inner content of the card */\n children?: React.ReactNode;\n /** Card header actions */\n action?: ComplexAction;\n /** Sets toggle state to activated or deactivated */\n enabled?: boolean;\n}" } }, "SheetProps": { @@ -17589,6 +17629,44 @@ "value": "export interface SheetProps {\n /** Whether or not the sheet is open */\n open: boolean;\n /** The child elements to render in the sheet */\n children: React.ReactNode;\n /** Callback when the backdrop is clicked or `ESC` is pressed */\n onClose(): void;\n /** Callback when the sheet has completed entering */\n onEntered?(): void;\n /** Callback when the sheet has started to exit */\n onExit?(): void;\n /** ARIA label for sheet */\n accessibilityLabel: string;\n /** The element or the RefObject that activates the Sheet */\n activator?: React.RefObject | React.ReactElement;\n}" } }, + "SkeletonBodyTextProps": { + "polaris-react/src/components/SkeletonBodyText/SkeletonBodyText.tsx": { + "filePath": "polaris-react/src/components/SkeletonBodyText/SkeletonBodyText.tsx", + "name": "SkeletonBodyTextProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/SkeletonBodyText/SkeletonBodyText.tsx", + "syntaxKind": "PropertySignature", + "name": "lines", + "value": "number", + "description": "Number of lines to display", + "isOptional": true, + "defaultValue": "3" + } + ], + "value": "export interface SkeletonBodyTextProps {\n /**\n * Number of lines to display\n * @default 3\n */\n lines?: number;\n}" + } + }, + "SkeletonDisplayTextProps": { + "polaris-react/src/components/SkeletonDisplayText/SkeletonDisplayText.tsx": { + "filePath": "polaris-react/src/components/SkeletonDisplayText/SkeletonDisplayText.tsx", + "name": "SkeletonDisplayTextProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/SkeletonDisplayText/SkeletonDisplayText.tsx", + "syntaxKind": "PropertySignature", + "name": "size", + "value": "Size", + "description": "Size of the text", + "isOptional": true, + "defaultValue": "'medium'" + } + ], + "value": "export interface SkeletonDisplayTextProps {\n /**\n * Size of the text\n * @default 'medium'\n */\n size?: Size;\n}" + } + }, "SkeletonPageProps": { "polaris-react/src/components/SkeletonPage/SkeletonPage.tsx": { "filePath": "polaris-react/src/components/SkeletonPage/SkeletonPage.tsx", @@ -17647,6 +17725,24 @@ "value": "export interface SkeletonPageProps {\n /** Page title, in large type */\n title?: string;\n /** Remove the normal max-width on the page */\n fullWidth?: boolean;\n /** Decreases the maximum layout width. Intended for single-column layouts */\n narrowWidth?: boolean;\n /** Shows a skeleton over the primary action */\n primaryAction?: boolean;\n /** Shows a skeleton over the breadcrumb */\n breadcrumbs?: boolean;\n /** The child elements to render in the skeleton page. */\n children?: React.ReactNode;\n}" } }, + "SkeletonTabsProps": { + "polaris-react/src/components/SkeletonTabs/SkeletonTabs.tsx": { + "filePath": "polaris-react/src/components/SkeletonTabs/SkeletonTabs.tsx", + "name": "SkeletonTabsProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/SkeletonTabs/SkeletonTabs.tsx", + "syntaxKind": "PropertySignature", + "name": "count", + "value": "number", + "description": "", + "isOptional": true + } + ], + "value": "export interface SkeletonTabsProps {\n count?: number;\n}" + } + }, "SkeletonThumbnailProps": { "polaris-react/src/components/SkeletonThumbnail/SkeletonThumbnail.tsx": { "filePath": "polaris-react/src/components/SkeletonThumbnail/SkeletonThumbnail.tsx", @@ -17666,24 +17762,6 @@ "value": "export interface SkeletonThumbnailProps {\n /**\n * Size of the thumbnail\n * @default 'medium'\n */\n size?: Size;\n}" } }, - "SkeletonTabsProps": { - "polaris-react/src/components/SkeletonTabs/SkeletonTabs.tsx": { - "filePath": "polaris-react/src/components/SkeletonTabs/SkeletonTabs.tsx", - "name": "SkeletonTabsProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/SkeletonTabs/SkeletonTabs.tsx", - "syntaxKind": "PropertySignature", - "name": "count", - "value": "number", - "description": "", - "isOptional": true - } - ], - "value": "export interface SkeletonTabsProps {\n count?: number;\n}" - } - }, "SpinnerProps": { "polaris-react/src/components/Spinner/Spinner.tsx": { "filePath": "polaris-react/src/components/Spinner/Spinner.tsx", @@ -21967,182 +22045,22 @@ ], "value": "export interface FocusManagerContextType {\n trapFocusList: string[];\n add: (id: string) => void;\n remove: (id: string) => boolean;\n}" } - }, - "PortalsManager": { - "polaris-react/src/utilities/portals/context.tsx": { - "filePath": "polaris-react/src/utilities/portals/context.tsx", - "name": "PortalsManager", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/utilities/portals/context.tsx", - "syntaxKind": "PropertySignature", - "name": "container", - "value": "HTMLDivElement", - "description": "" - } - ], - "value": "export interface PortalsManager {\n container: PortalsContainerElement;\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": "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}" - } - }, - "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 - }, + }, + "PortalsManager": { + "polaris-react/src/utilities/portals/context.tsx": { + "filePath": "polaris-react/src/utilities/portals/context.tsx", + "name": "PortalsManager", + "description": "", + "members": [ { - "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", + "filePath": "polaris-react/src/utilities/portals/context.tsx", "syntaxKind": "PropertySignature", - "name": "sections", - "value": "ActionListSection[]", - "description": "Collection of sectioned action items", - "isOptional": true + "name": "container", + "value": "HTMLDivElement", + "description": "" } ], - "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}" + "value": "export interface PortalsManager {\n container: PortalsContainerElement;\n}" } }, "ItemProps": { @@ -22509,177 +22427,402 @@ "value": "interface MeasuredActions {\n showable: MenuActionDescriptor[];\n rolledUp: (MenuActionDescriptor | MenuGroupDescriptor)[];\n}" } }, - "MappedAction": { - "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx": { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", - "name": "MappedAction", + "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/Autocomplete/components/MappedAction/MappedAction.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", "syntaxKind": "PropertySignature", - "name": "wrapOverflow", + "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": "", + "description": "Whether or not the menu is open", "isOptional": true }, { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "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": "accessibilityLabel", + "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": "Visually hidden text for screen readers", + "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/Autocomplete/components/MappedAction/MappedAction.tsx", + "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, - "deprecationMessage": "Badge component" + "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}" + } + }, + "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/Autocomplete/components/MappedAction/MappedAction.tsx", + "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "helpText", + "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": "Additional hint text to display with item", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "icon", - "value": "any", + "name": "secondary", + "value": "boolean", "description": "", - "isOptional": true, - "deprecationMessage": "Source of the icon" + "isOptional": true }, { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "image", - "value": "string", + "name": "fullWidth", + "value": "boolean", "description": "", - "isOptional": true, - "deprecationMessage": "Image source" + "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/Autocomplete/components/MappedAction/MappedAction.tsx", + "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": "prefix", + "name": "children", "value": "React.ReactNode", - "description": "Prefix source", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "suffix", - "value": "React.ReactNode", - "description": "Suffix source", + "name": "flush", + "value": "boolean", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "ellipsis", + "name": "subdued", "value": "boolean", - "description": "Add an ellipsis suffix to action content", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "active", + "name": "titleHidden", "value": "boolean", - "description": "Whether the action is active or not", + "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/Autocomplete/components/MappedAction/MappedAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "role", - "value": "string", - "description": "Defines a role for the action", + "name": "icon", + "value": "any", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "Whether or not the action is disabled", + "name": "title", + "value": "string", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the action", + "name": "fill", + "value": "boolean", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "content", - "value": "string", - "description": "Content the action displays", + "name": "rollup", + "value": "{ after: number; view: string; hide: string; activePath: string; }", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "A destination to link to, rendered in the action", + "name": "action", + "value": "{ icon: any; accessibilityLabel: string; onClick(): void; tooltip?: TooltipProps; }", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "external", + "name": "separator", "value": "boolean", - "description": "Forces url to open in a new tab", + "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/Autocomplete/components/MappedAction/MappedAction.tsx", - "syntaxKind": "MethodSignature", - "name": "onAction", - "value": "() => void", - "description": "Callback when an action takes place", + "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}" + } + }, + "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/Autocomplete/components/MappedAction/MappedAction.tsx", - "syntaxKind": "MethodSignature", - "name": "onMouseEnter", - "value": "() => void", - "description": "Callback when mouse enter", + "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/Autocomplete/components/MappedAction/MappedAction.tsx", - "syntaxKind": "MethodSignature", - "name": "onTouchStart", - "value": "() => void", - "description": "Callback when element is touched", + "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/Autocomplete/components/MappedAction/MappedAction.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", "syntaxKind": "PropertySignature", - "name": "destructive", - "value": "boolean", - "description": "Destructive action", + "name": "sections", + "value": "ActionListSection[]", + "description": "Collection of sectioned action items", "isOptional": true } ], - "value": "interface MappedAction extends ActionListItemDescriptor {\n wrapOverflow?: boolean;\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": { @@ -23058,285 +23201,186 @@ "value": "interface SecondaryAction {\n url: string;\n accessibilityLabel: string;\n icon: IconProps['source'];\n onClick?(): void;\n tooltip?: TooltipProps;\n}" } }, - "SectionProps": { - "polaris-react/src/components/ActionList/components/Section/Section.tsx": { - "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", - "name": "SectionProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "section", - "value": "ActionListSection", - "description": "Section of action items" - }, - { - "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "hasMultipleSections", - "value": "boolean", - "description": "Should there be multiple sections" - }, - { - "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "actionRole", - "value": "string", - "description": "Defines a specific role attribute for each action in the list", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "onActionAnyItem", - "value": "() => void", - "description": "Callback when any item is clicked or keypressed", - "isOptional": true - } - ], - "value": "export interface SectionProps {\n /** Section of action items */\n section: ActionListSection;\n /** Should there be multiple sections */\n hasMultipleSections: boolean;\n /** Defines a specific role attribute for each action in the list */\n actionRole?: 'option' | 'menuitem' | string;\n /** Callback when any item is clicked or keypressed */\n onActionAnyItem?: ActionListItemDescriptor['onAction'];\n}" - }, - "polaris-react/src/components/Layout/components/Section/Section.tsx": { - "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", - "name": "SectionProps", + "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": "" + } + }, + "MappedAction": { + "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx": { + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "name": "MappedAction", "description": "", "members": [ { - "filePath": "polaris-react/src/components/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", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", "syntaxKind": "PropertySignature", - "name": "fullWidth", + "name": "wrapOverflow", "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", "syntaxKind": "PropertySignature", - "name": "oneHalf", - "value": "boolean", - "description": "", + "name": "accessibilityLabel", + "value": "string", + "description": "Visually hidden text for screen readers", "isOptional": true }, { - "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", "syntaxKind": "PropertySignature", - "name": "oneThird", - "value": "boolean", + "name": "badge", + "value": "{ status: \"new\"; content: string; }", "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": [ + "isOptional": true, + "deprecationMessage": "Badge component" + }, { - "filePath": "polaris-react/src/components/Listbox/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", "syntaxKind": "PropertySignature", - "name": "divider", - "value": "boolean", - "description": "", + "name": "helpText", + "value": "React.ReactNode", + "description": "Additional hint text to display with item", "isOptional": true }, { - "filePath": "polaris-react/src/components/Listbox/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "ReactNode", + "name": "icon", + "value": "any", "description": "", - "isOptional": true + "isOptional": true, + "deprecationMessage": "Source of the icon" }, { - "filePath": "polaris-react/src/components/Listbox/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.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": [ + "name": "image", + "value": "string", + "description": "", + "isOptional": true, + "deprecationMessage": "Image source" + }, { - "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", "syntaxKind": "PropertySignature", - "name": "children", + "name": "prefix", "value": "React.ReactNode", - "description": "", + "description": "Prefix source", "isOptional": true }, { - "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", "syntaxKind": "PropertySignature", - "name": "flush", - "value": "boolean", - "description": "", + "name": "suffix", + "value": "React.ReactNode", + "description": "Suffix source", "isOptional": true }, { - "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", "syntaxKind": "PropertySignature", - "name": "subdued", + "name": "ellipsis", "value": "boolean", - "description": "", + "description": "Add an ellipsis suffix to action content", "isOptional": true }, { - "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", "syntaxKind": "PropertySignature", - "name": "titleHidden", + "name": "active", "value": "boolean", - "description": "", + "description": "Whether the action is active or not", "isOptional": true - } - ], - "value": "export interface SectionProps {\n children?: React.ReactNode;\n flush?: boolean;\n subdued?: boolean;\n titleHidden?: boolean;\n}" - }, - "polaris-react/src/components/Navigation/components/Section/Section.tsx": { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", - "name": "SectionProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "items", - "value": "ItemProps[]", - "description": "" }, { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", "syntaxKind": "PropertySignature", - "name": "icon", - "value": "any", - "description": "", + "name": "role", + "value": "string", + "description": "Defines a role for the action", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "", + "name": "disabled", + "value": "boolean", + "description": "Whether or not the action is disabled", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", "syntaxKind": "PropertySignature", - "name": "fill", - "value": "boolean", - "description": "", + "name": "id", + "value": "string", + "description": "A unique identifier for the action", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", "syntaxKind": "PropertySignature", - "name": "rollup", - "value": "{ after: number; view: string; hide: string; activePath: string; }", - "description": "", + "name": "content", + "value": "string", + "description": "Content the action displays", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", "syntaxKind": "PropertySignature", - "name": "action", - "value": "{ icon: any; accessibilityLabel: string; onClick(): void; tooltip?: TooltipProps; }", - "description": "", + "name": "url", + "value": "string", + "description": "A destination to link to, rendered in the action", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", "syntaxKind": "PropertySignature", - "name": "separator", + "name": "external", "value": "boolean", - "description": "", + "description": "Forces url to open in a new tab", "isOptional": true - } - ], - "value": "export interface SectionProps {\n items: ItemProps[];\n icon?: IconProps['source'];\n title?: string;\n fill?: boolean;\n rollup?: {\n after: number;\n view: string;\n hide: string;\n activePath: string;\n };\n action?: {\n icon: IconProps['source'];\n accessibilityLabel: string;\n onClick(): void;\n tooltip?: TooltipProps;\n };\n separator?: boolean;\n}" - }, - "polaris-react/src/components/Popover/components/Section/Section.tsx": { - "filePath": "polaris-react/src/components/Popover/components/Section/Section.tsx", - "name": "SectionProps", - "description": "", - "members": [ + }, { - "filePath": "polaris-react/src/components/Popover/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", + "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 - } - ], - "value": "export interface SectionProps {\n children?: React.ReactNode;\n}" - } - }, - "MappedOption": { - "polaris-react/src/components/Autocomplete/components/MappedOption/MappedOption.tsx": { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedOption/MappedOption.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "MappedOption", - "value": "ArrayElement & {\n selected: boolean;\n singleSelection: boolean;\n}", - "description": "" - } - }, - "PipProps": { - "polaris-react/src/components/Badge/components/Pip/Pip.tsx": { - "filePath": "polaris-react/src/components/Badge/components/Pip/Pip.tsx", - "name": "PipProps", - "description": "", - "members": [ + }, { - "filePath": "polaris-react/src/components/Badge/components/Pip/Pip.tsx", - "syntaxKind": "PropertySignature", - "name": "status", - "value": "Status", - "description": "", + "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/Badge/components/Pip/Pip.tsx", - "syntaxKind": "PropertySignature", - "name": "progress", - "value": "Progress", - "description": "", + "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/Badge/components/Pip/Pip.tsx", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", "syntaxKind": "PropertySignature", - "name": "accessibilityLabelOverride", - "value": "string", - "description": "", + "name": "destructive", + "value": "boolean", + "description": "Destructive action", "isOptional": true } ], - "value": "export interface PipProps {\n status?: Status;\n progress?: Progress;\n accessibilityLabelOverride?: string;\n}" + "value": "interface MappedAction extends ActionListItemDescriptor {\n wrapOverflow?: boolean;\n}" } }, "BulkActionButtonProps": { @@ -23469,6 +23513,40 @@ "value": "export interface CardHeaderProps {\n title?: React.ReactNode;\n actions?: DisableableAction[];\n children?: React.ReactNode;\n}" } }, + "PipProps": { + "polaris-react/src/components/Badge/components/Pip/Pip.tsx": { + "filePath": "polaris-react/src/components/Badge/components/Pip/Pip.tsx", + "name": "PipProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Badge/components/Pip/Pip.tsx", + "syntaxKind": "PropertySignature", + "name": "status", + "value": "Status", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Badge/components/Pip/Pip.tsx", + "syntaxKind": "PropertySignature", + "name": "progress", + "value": "Progress", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Badge/components/Pip/Pip.tsx", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabelOverride", + "value": "string", + "description": "", + "isOptional": true + } + ], + "value": "export interface PipProps {\n status?: Status;\n progress?: Progress;\n accessibilityLabelOverride?: string;\n}" + } + }, "CardSectionProps": { "polaris-react/src/components/Card/components/Section/Section.tsx": { "filePath": "polaris-react/src/components/Card/components/Section/Section.tsx", @@ -23535,24 +23613,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", @@ -23581,7 +23641,25 @@ "description": "" } ], - "value": "export interface AlphaPickerProps {\n color: HSBColor;\n alpha: number;\n onChange(hue: number): void;\n}" + "value": "export interface AlphaPickerProps {\n color: HSBColor;\n alpha: 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}" } }, "HuePickerProps": { @@ -23673,41 +23751,6 @@ "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": "" - } - }, - "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}" - } - }, "DayProps": { "polaris-react/src/components/DatePicker/components/Day/Day.tsx": { "filePath": "polaris-react/src/components/DatePicker/components/Day/Day.tsx", @@ -23964,6 +24007,15 @@ "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}" } }, + "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": "" + } + }, "WeekdayProps": { "polaris-react/src/components/DatePicker/components/Weekday/Weekday.tsx": { "filePath": "polaris-react/src/components/DatePicker/components/Weekday/Weekday.tsx", @@ -24293,6 +24345,32 @@ "value": "export interface CellProps {\n children?: ReactNode;\n className?: string;\n flush?: 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", @@ -25205,29 +25283,38 @@ "value": "export interface TextOptionProps {\n children: React.ReactNode;\n // Whether the option is selected\n selected?: boolean;\n // Whether the option is disabled\n disabled?: boolean;\n}" } }, - "CloseButtonProps": { - "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx": { - "filePath": "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx", - "name": "CloseButtonProps", + "FooterProps": { + "polaris-react/src/components/Modal/components/Footer/Footer.tsx": { + "filePath": "polaris-react/src/components/Modal/components/Footer/Footer.tsx", + "name": "FooterProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx", + "filePath": "polaris-react/src/components/Modal/components/Footer/Footer.tsx", "syntaxKind": "PropertySignature", - "name": "titleHidden", - "value": "boolean", - "description": "", + "name": "primaryAction", + "value": "ComplexAction", + "description": "Primary action", "isOptional": true }, { - "filePath": "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx", - "syntaxKind": "MethodSignature", - "name": "onClick", - "value": "() => void", - "description": "" + "filePath": "polaris-react/src/components/Modal/components/Footer/Footer.tsx", + "syntaxKind": "PropertySignature", + "name": "secondaryActions", + "value": "ComplexAction[]", + "description": "Collection of secondary actions", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Modal/components/Footer/Footer.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "The content to display inside modal", + "isOptional": true } ], - "value": "export interface CloseButtonProps {\n titleHidden?: boolean;\n onClick(): void;\n}" + "value": "export interface FooterProps {\n /** Primary action */\n primaryAction?: ComplexAction;\n /** Collection of secondary actions */\n secondaryActions?: ComplexAction[];\n /** The content to display inside modal */\n children?: React.ReactNode;\n}" } }, "DialogProps": { @@ -25327,38 +25414,29 @@ "value": "export interface DialogProps {\n labelledBy?: string;\n instant?: boolean;\n children?: React.ReactNode;\n limitHeight?: boolean;\n large?: boolean;\n small?: boolean;\n onClose(): void;\n onEntered?(): void;\n onExited?(): void;\n in?: boolean;\n fullScreen?: boolean;\n}" } }, - "FooterProps": { - "polaris-react/src/components/Modal/components/Footer/Footer.tsx": { - "filePath": "polaris-react/src/components/Modal/components/Footer/Footer.tsx", - "name": "FooterProps", + "CloseButtonProps": { + "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx": { + "filePath": "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx", + "name": "CloseButtonProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/Modal/components/Footer/Footer.tsx", - "syntaxKind": "PropertySignature", - "name": "primaryAction", - "value": "ComplexAction", - "description": "Primary action", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Modal/components/Footer/Footer.tsx", + "filePath": "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx", "syntaxKind": "PropertySignature", - "name": "secondaryActions", - "value": "ComplexAction[]", - "description": "Collection of secondary actions", + "name": "titleHidden", + "value": "boolean", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Modal/components/Footer/Footer.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "The content to display inside modal", - "isOptional": true + "filePath": "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx", + "syntaxKind": "MethodSignature", + "name": "onClick", + "value": "() => void", + "description": "" } ], - "value": "export interface FooterProps {\n /** Primary action */\n primaryAction?: ComplexAction;\n /** Collection of secondary actions */\n secondaryActions?: ComplexAction[];\n /** The content to display inside modal */\n children?: React.ReactNode;\n}" + "value": "export interface CloseButtonProps {\n titleHidden?: boolean;\n onClick(): void;\n}" } }, "ItemURLDetails": { @@ -25542,6 +25620,56 @@ ] } }, + "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 + } + ], + "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}" + } + }, "PrimaryAction": { "polaris-react/src/components/Page/components/Header/Header.tsx": { "filePath": "polaris-react/src/components/Page/components/Header/Header.tsx", @@ -25664,56 +25792,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 - } - ], - "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}" - } - }, "PopoverCloseSource": { "polaris-react/src/components/Popover/components/PopoverOverlay/PopoverOverlay.tsx": { "filePath": "polaris-react/src/components/Popover/components/PopoverOverlay/PopoverOverlay.tsx",