From 3aa01bed96ad7cc52321b91642acb202c5aab926 Mon Sep 17 00:00:00 2001 From: Lo Kim Date: Wed, 1 Feb 2023 15:05:39 -0500 Subject: [PATCH 1/4] Add `LegacyStack` component --- .../components/LegacyStack/LegacyStack.scss | 136 ++++++++++++++++++ .../LegacyStack/LegacyStack.stories.tsx | 96 +++++++++++++ .../components/LegacyStack/LegacyStack.tsx | 69 +++++++++ .../LegacyStack/components/Item/Item.tsx | 20 +++ .../LegacyStack/components/Item/index.ts | 1 + .../LegacyStack/components/index.ts | 1 + .../src/components/LegacyStack/index.ts | 1 + .../LegacyStack/tests/LegacyStack.test.tsx | 16 +++ polaris-react/src/index.ts | 3 + 9 files changed, 343 insertions(+) create mode 100644 polaris-react/src/components/LegacyStack/LegacyStack.scss create mode 100644 polaris-react/src/components/LegacyStack/LegacyStack.stories.tsx create mode 100644 polaris-react/src/components/LegacyStack/LegacyStack.tsx create mode 100644 polaris-react/src/components/LegacyStack/components/Item/Item.tsx create mode 100644 polaris-react/src/components/LegacyStack/components/Item/index.ts create mode 100644 polaris-react/src/components/LegacyStack/components/index.ts create mode 100644 polaris-react/src/components/LegacyStack/index.ts create mode 100644 polaris-react/src/components/LegacyStack/tests/LegacyStack.test.tsx diff --git a/polaris-react/src/components/LegacyStack/LegacyStack.scss b/polaris-react/src/components/LegacyStack/LegacyStack.scss new file mode 100644 index 00000000000..407d083137d --- /dev/null +++ b/polaris-react/src/components/LegacyStack/LegacyStack.scss @@ -0,0 +1,136 @@ +.LegacyStack { + // stylelint-disable-next-line -- Polaris component custom properties + --pc-stack-spacing: var(--p-space-4); + // stylelint-disable-next-line -- generated by polaris-migrator DO NOT COPY + display: flex; + flex-wrap: wrap; + // stylelint-disable-next-line -- generated by polaris-migrator DO NOT COPY + align-items: stretch; + // stylelint-disable-next-line -- generated by polaris-migrator DO NOT COPY + margin-top: calc(-1 * var(--pc-stack-spacing)); + // stylelint-disable-next-line -- generated by polaris-migrator DO NOT COPY + margin-left: calc(-1 * var(--pc-stack-spacing)); + + > .Item { + // stylelint-disable-next-line -- generated by polaris-migrator DO NOT COPY + margin-top: var(--pc-stack-spacing); + // stylelint-disable-next-line -- generated by polaris-migrator DO NOT COPY + margin-left: var(--pc-stack-spacing); + max-width: 100%; + } +} + +.noWrap { + flex-wrap: nowrap; +} + +.spacingNone { + // stylelint-disable-next-line -- Polaris component custom properties + --pc-stack-spacing: var(--p-space-0); +} + +.spacingExtraTight { + // stylelint-disable-next-line -- Polaris component custom properties + --pc-stack-spacing: var(--p-space-1); +} + +.spacingTight { + // stylelint-disable-next-line -- Polaris component custom properties + --pc-stack-spacing: var(--p-space-2); +} + +.spacingBaseTight { + // stylelint-disable-next-line -- Polaris component custom properties + --pc-stack-spacing: var(--p-space-3); +} + +.spacingLoose { + // stylelint-disable-next-line -- Polaris component custom properties + --pc-stack-spacing: var(--p-space-5); +} + +.spacingExtraLoose { + // stylelint-disable-next-line -- Polaris component custom properties + --pc-stack-spacing: var(--p-space-8); +} + +.distributionLeading { + // stylelint-disable-next-line -- generated by polaris-migrator DO NOT COPY + justify-content: flex-start; +} + +.distributionTrailing { + // stylelint-disable-next-line -- generated by polaris-migrator DO NOT COPY + justify-content: flex-end; +} + +.distributionCenter { + // stylelint-disable-next-line -- generated by polaris-migrator DO NOT COPY + justify-content: center; +} + +.distributionEqualSpacing { + // stylelint-disable-next-line -- generated by polaris-migrator DO NOT COPY + justify-content: space-between; +} + +.distributionFill > .Item { + // stylelint-disable-next-line -- generated by polaris-migrator DO NOT COPY + flex: 1 1 auto; +} + +.distributionFillEvenly > .Item { + // stylelint-disable-next-line -- generated by polaris-migrator DO NOT COPY + flex: 1 1 auto; + + @supports (min-width: fit-content) { + // stylelint-disable-next-line -- generated by polaris-migrator DO NOT COPY + flex: 1 0 0%; + min-width: fit-content; + } +} + +.alignmentLeading { + // stylelint-disable-next-line -- generated by polaris-migrator DO NOT COPY + align-items: flex-start; +} + +.alignmentTrailing { + // stylelint-disable-next-line -- generated by polaris-migrator DO NOT COPY + align-items: flex-end; +} + +.alignmentCenter { + // stylelint-disable-next-line -- generated by polaris-migrator DO NOT COPY + align-items: center; +} + +.alignmentFill { + // stylelint-disable-next-line -- generated by polaris-migrator DO NOT COPY + align-items: stretch; +} + +.alignmentBaseline { + // stylelint-disable-next-line -- generated by polaris-migrator DO NOT COPY + align-items: baseline; +} + +.vertical { + flex-direction: column; + margin-left: var(--p-space-0); + + > .Item { + margin-left: var(--p-space-0); + } +} + +.Item { + // stylelint-disable-next-line -- generated by polaris-migrator DO NOT COPY + flex: 0 0 auto; + min-width: 0; +} + +.Item-fill { + // stylelint-disable-next-line -- generated by polaris-migrator DO NOT COPY + flex: 1 1 auto; +} diff --git a/polaris-react/src/components/LegacyStack/LegacyStack.stories.tsx b/polaris-react/src/components/LegacyStack/LegacyStack.stories.tsx new file mode 100644 index 00000000000..f007841ac34 --- /dev/null +++ b/polaris-react/src/components/LegacyStack/LegacyStack.stories.tsx @@ -0,0 +1,96 @@ +import React from 'react'; +import type {ComponentMeta} from '@storybook/react'; +import {Badge, Text, LegacyStack} from '@shopify/polaris'; + +export default { + component: LegacyStack, +} as ComponentMeta; + +export function Default() { + return ( + + Paid + Processing + Fulfilled + Completed + + ); +} + +export function NonWrapping() { + return ( + + Paid + Processing + Fulfilled + Completed + + ); +} + +export function Spacing() { + return ( + + Paid + Fulfilled + + ); +} + +export function VerticalCentering() { + return ( + + + Order +
+ #1136 +
+ was paid + + Paid + Fulfilled + + ); +} + +export function FillAvailableSpaceProportionally() { + return ( + + + Order #1136 + + Paid + Fulfilled + + ); +} + +export function WhereItemsFillSpaceEvenly() { + return ( + + + Order #1136 + + Paid + Fulfilled + + ); +} + +export function WhereASingleItemFillsTheRemainingSpace() { + return ( + + + + Order #1136 + + + + Paid + + + Fulfilled + + + ); +} diff --git a/polaris-react/src/components/LegacyStack/LegacyStack.tsx b/polaris-react/src/components/LegacyStack/LegacyStack.tsx new file mode 100644 index 00000000000..f5a69208ea9 --- /dev/null +++ b/polaris-react/src/components/LegacyStack/LegacyStack.tsx @@ -0,0 +1,69 @@ +import React, {memo, NamedExoticComponent} from 'react'; + +import {classNames, variationName} from '../../utilities/css'; +import {elementChildren, wrapWithComponent} from '../../utilities/components'; + +import {Item} from './components'; +import styles from './LegacyStack.scss'; + +type Spacing = + | 'extraTight' + | 'tight' + | 'baseTight' + | 'loose' + | 'extraLoose' + | 'none'; + +type Alignment = 'leading' | 'trailing' | 'center' | 'fill' | 'baseline'; + +type Distribution = + | 'equalSpacing' + | 'leading' + | 'trailing' + | 'center' + | 'fill' + | 'fillEvenly'; + +export interface LegacyStackProps { + /** Elements to display inside stack */ + children?: React.ReactNode; + /** Wrap stack elements to additional rows as needed on small screens (Defaults to true) */ + wrap?: boolean; + /** Stack the elements vertically */ + vertical?: boolean; + /** Adjust spacing between elements */ + spacing?: Spacing; + /** Adjust vertical alignment of elements */ + alignment?: Alignment; + /** Adjust horizontal alignment of elements */ + distribution?: Distribution; +} + +export const LegacyStack = memo(function Stack({ + children, + vertical, + spacing, + distribution, + alignment, + wrap, +}: LegacyStackProps) { + const className = classNames( + styles.LegacyStack, + vertical && styles.vertical, + spacing && styles[variationName('spacing', spacing)], + distribution && styles[variationName('distribution', distribution)], + alignment && styles[variationName('alignment', alignment)], + wrap === false && styles.noWrap, + ); + + const itemMarkup = elementChildren(children).map((child, index) => { + const props = {key: index}; + return wrapWithComponent(child, Item, props); + }); + + return
{itemMarkup}
; +}) as NamedExoticComponent & { + Item: typeof Item; +}; + +LegacyStack.Item = Item; diff --git a/polaris-react/src/components/LegacyStack/components/Item/Item.tsx b/polaris-react/src/components/LegacyStack/components/Item/Item.tsx new file mode 100644 index 00000000000..450131f7a5a --- /dev/null +++ b/polaris-react/src/components/LegacyStack/components/Item/Item.tsx @@ -0,0 +1,20 @@ +import React from 'react'; + +import {classNames} from '../../../../utilities/css'; +import styles from '../../LegacyStack.scss'; + +export interface LegacyItemProps { + /** Elements to display inside item */ + children?: React.ReactNode; + /** Fill the remaining horizontal space in the stack with the item */ + fill?: boolean; + /** + * @default false + */ +} + +export function Item({children, fill}: LegacyItemProps) { + const className = classNames(styles.Item, fill && styles['Item-fill']); + + return
{children}
; +} diff --git a/polaris-react/src/components/LegacyStack/components/Item/index.ts b/polaris-react/src/components/LegacyStack/components/Item/index.ts new file mode 100644 index 00000000000..c924835a042 --- /dev/null +++ b/polaris-react/src/components/LegacyStack/components/Item/index.ts @@ -0,0 +1 @@ +export * from './Item'; diff --git a/polaris-react/src/components/LegacyStack/components/index.ts b/polaris-react/src/components/LegacyStack/components/index.ts new file mode 100644 index 00000000000..c924835a042 --- /dev/null +++ b/polaris-react/src/components/LegacyStack/components/index.ts @@ -0,0 +1 @@ +export * from './Item'; diff --git a/polaris-react/src/components/LegacyStack/index.ts b/polaris-react/src/components/LegacyStack/index.ts new file mode 100644 index 00000000000..b0c1ee0ff64 --- /dev/null +++ b/polaris-react/src/components/LegacyStack/index.ts @@ -0,0 +1 @@ +export * from './LegacyStack'; diff --git a/polaris-react/src/components/LegacyStack/tests/LegacyStack.test.tsx b/polaris-react/src/components/LegacyStack/tests/LegacyStack.test.tsx new file mode 100644 index 00000000000..9551352e7f0 --- /dev/null +++ b/polaris-react/src/components/LegacyStack/tests/LegacyStack.test.tsx @@ -0,0 +1,16 @@ +import React from 'react'; +import {mountWithApp} from 'tests/utilities'; + +import {LegacyStack} from '../LegacyStack'; + +describe('', () => { + const renderChildren = () => [0, 1].map((i) =>
Child {i}
); + + it('renders its children', () => { + const legacyStack = mountWithApp( + {renderChildren()}, + ); + + expect(legacyStack).toContainReactComponentTimes(LegacyStack.Item, 2); + }); +}); diff --git a/polaris-react/src/index.ts b/polaris-react/src/index.ts index 6232c86d92d..94564f11111 100644 --- a/polaris-react/src/index.ts +++ b/polaris-react/src/index.ts @@ -249,6 +249,9 @@ export type { LegacyCardSubsectionProps, } from './components/LegacyCard'; +export {LegacyStack} from './components/LegacyStack'; +export type {LegacyStackProps} from './components/LegacyStack'; + export {Link} from './components/Link'; export type {LinkProps} from './components/Link'; From 11ce4678f512e16f4a16a5c8290f0171afee5ec2 Mon Sep 17 00:00:00 2001 From: Lo Kim Date: Wed, 1 Feb 2023 15:06:32 -0500 Subject: [PATCH 2/4] [polaris.shopify.com] Add `LegacyStack` component page and examples --- .../content/components/legacy-stack.md | 77 ++++++++++++++++++ .../pages/examples/legacy-stack-default.tsx | 16 ++++ ...ck-fill-available-space-proportionally.tsx | 17 ++++ .../examples/legacy-stack-non-wrapping.tsx | 16 ++++ .../pages/examples/legacy-stack-spacing.tsx | 14 ++++ .../legacy-stack-vertical-centering.tsx | 21 +++++ ...-single-item-fills-the-remaining-space.tsx | 23 ++++++ ...cy-stack-where-items-fill-space-evenly.tsx | 17 ++++ .../public/images/components/legacy-stack.png | Bin 0 -> 8562 bytes 9 files changed, 201 insertions(+) create mode 100644 polaris.shopify.com/content/components/legacy-stack.md create mode 100644 polaris.shopify.com/pages/examples/legacy-stack-default.tsx create mode 100644 polaris.shopify.com/pages/examples/legacy-stack-fill-available-space-proportionally.tsx create mode 100644 polaris.shopify.com/pages/examples/legacy-stack-non-wrapping.tsx create mode 100644 polaris.shopify.com/pages/examples/legacy-stack-spacing.tsx create mode 100644 polaris.shopify.com/pages/examples/legacy-stack-vertical-centering.tsx create mode 100644 polaris.shopify.com/pages/examples/legacy-stack-where-a-single-item-fills-the-remaining-space.tsx create mode 100644 polaris.shopify.com/pages/examples/legacy-stack-where-items-fill-space-evenly.tsx create mode 100644 polaris.shopify.com/public/images/components/legacy-stack.png diff --git a/polaris.shopify.com/content/components/legacy-stack.md b/polaris.shopify.com/content/components/legacy-stack.md new file mode 100644 index 00000000000..5b5c492fc1f --- /dev/null +++ b/polaris.shopify.com/content/components/legacy-stack.md @@ -0,0 +1,77 @@ +--- +title: LegacyStack +description: This is the legacy version of the Stack component which is in the process of being updated to a more flexible and composable API. Use to lay out a horizontal row of components or to achieve no-fuss vertical centering. A stack is made of flexible items that wrap each of the stack’s children. Options provide control of the wrapping, spacing, and relative size of the items in the stack. +category: Structure +keywords: + - rows + - vertical centering + - horizontal row of components + - flexible items + - flexbox + - row of components + - stack spacing + - vertical centering + - fill available space + - fill space + - equal width + - right-aligned stack + - stack layout + - layout + - legacy stack +examples: + - fileName: legacy-stack-default.tsx + title: Default + description: Use to quickly lay out a horizontal row of components and maintain their relative sizes. On small screens, children rows wrap down to additional rows as needed. + - fileName: legacy-stack-non-wrapping.tsx + title: Non-wrapping + description: Use to create a stack where the children will not wrap to new rows on small screens. As noted above, the wrap option defaults to true. This means you must explicitly set it to false to turn it off. + - fileName: legacy-stack-spacing.tsx + title: Spacing + description: Use to control spacing of items in a stack in standard increments. Use tight for less spacing, loose for more spacing, or none to remove normal spacing altogether. + - fileName: legacy-stack-vertical-centering.tsx + title: Vertical centering + description: Use to vertically center a set of items that have different heights. + - fileName: legacy-stack-fill-available-space-proportionally.tsx + title: Fill available space proportionally + description: Use to have the stack’s items fill the horizontal space in the container but maintain their relative proportions. + - fileName: legacy-stack-where-items-fill-space-evenly.tsx + title: Where items fill space evenly + description: Use to have the stack’s items fill the horizontal space in the container and be equal widths, regardless of their content. + - fileName: legacy-stack-where-a-single-item-fills-the-remaining-space.tsx + title: Where a single item fills the remaining space + description: Use for aligning buttons or secondary content to the right edge of another element, allowing it to wrap below on small screens. +--- + +## Best practices + +Stacks should: + +- Be used for small-scale layout tasks when you want a row of components that should wrap on small screen widths +- Be used to vertically center two elements +- Not be used for complex or unique arrangements of components +- Not be used for large-scale page layout + +--- + +## Stack item + +The stack component will treat multiple elements wrapped in a stack item component as one item. By default, each individual element is treated as one stack item. Use the fill prop on a single stack item component to make it fill the rest of the available horizontal space. See the “Stack where a single item fills the remaining space” example. + +### Stack item properties + +| Prop | Type | Description | Default | +| -------- | ------- | -------------------------------------------------------------- | ------- | +| fill | boolean | Fill the available horizontal space in the stack with the item | false | +| children | any | Elements to display inside stack item | | + +--- + +## Related components + +- To create the large-scale structure of pages, [use the layout component](https://polaris.shopify.com/components/layout) + +--- + +## Accessibility + +The stack component is for alignment only and doesn’t provide any structural information for assistive technologies. To convey relationships between specific items, consider using the [list component](https://polaris.shopify.com/components/list). diff --git a/polaris.shopify.com/pages/examples/legacy-stack-default.tsx b/polaris.shopify.com/pages/examples/legacy-stack-default.tsx new file mode 100644 index 00000000000..7427a026a36 --- /dev/null +++ b/polaris.shopify.com/pages/examples/legacy-stack-default.tsx @@ -0,0 +1,16 @@ +import {LegacyStack, Badge} from '@shopify/polaris'; +import React from 'react'; +import {withPolarisExample} from '../../src/components/PolarisExampleWrapper'; + +function LegacyStackExample() { + return ( + + Paid + Processing + Fulfilled + Completed + + ); +} + +export default withPolarisExample(LegacyStackExample); diff --git a/polaris.shopify.com/pages/examples/legacy-stack-fill-available-space-proportionally.tsx b/polaris.shopify.com/pages/examples/legacy-stack-fill-available-space-proportionally.tsx new file mode 100644 index 00000000000..f7fdb2cd7d3 --- /dev/null +++ b/polaris.shopify.com/pages/examples/legacy-stack-fill-available-space-proportionally.tsx @@ -0,0 +1,17 @@ +import {LegacyStack, Badge, Text} from '@shopify/polaris'; +import React from 'react'; +import {withPolarisExample} from '../../src/components/PolarisExampleWrapper'; + +function LegacyStackExample() { + return ( + + + Order #1136 + + Paid + Fulfilled + + ); +} + +export default withPolarisExample(LegacyStackExample); diff --git a/polaris.shopify.com/pages/examples/legacy-stack-non-wrapping.tsx b/polaris.shopify.com/pages/examples/legacy-stack-non-wrapping.tsx new file mode 100644 index 00000000000..ae83dff8ee6 --- /dev/null +++ b/polaris.shopify.com/pages/examples/legacy-stack-non-wrapping.tsx @@ -0,0 +1,16 @@ +import {LegacyStack, Badge} from '@shopify/polaris'; +import React from 'react'; +import {withPolarisExample} from '../../src/components/PolarisExampleWrapper'; + +function LegacyStackExample() { + return ( + + Paid + Processing + Fulfilled + Completed + + ); +} + +export default withPolarisExample(LegacyStackExample); diff --git a/polaris.shopify.com/pages/examples/legacy-stack-spacing.tsx b/polaris.shopify.com/pages/examples/legacy-stack-spacing.tsx new file mode 100644 index 00000000000..5cf4a973edb --- /dev/null +++ b/polaris.shopify.com/pages/examples/legacy-stack-spacing.tsx @@ -0,0 +1,14 @@ +import {LegacyStack, Badge} from '@shopify/polaris'; +import React from 'react'; +import {withPolarisExample} from '../../src/components/PolarisExampleWrapper'; + +function LegacyStackExample() { + return ( + + Paid + Fulfilled + + ); +} + +export default withPolarisExample(LegacyStackExample); diff --git a/polaris.shopify.com/pages/examples/legacy-stack-vertical-centering.tsx b/polaris.shopify.com/pages/examples/legacy-stack-vertical-centering.tsx new file mode 100644 index 00000000000..89ed6ab3c49 --- /dev/null +++ b/polaris.shopify.com/pages/examples/legacy-stack-vertical-centering.tsx @@ -0,0 +1,21 @@ +import {LegacyStack, Badge, Text} from '@shopify/polaris'; +import React from 'react'; +import {withPolarisExample} from '../../src/components/PolarisExampleWrapper'; + +function LegacyStackExample() { + return ( + + + Order +
+ #1136 +
+ was paid + + Paid + Fulfilled + + ); +} + +export default withPolarisExample(LegacyStackExample); diff --git a/polaris.shopify.com/pages/examples/legacy-stack-where-a-single-item-fills-the-remaining-space.tsx b/polaris.shopify.com/pages/examples/legacy-stack-where-a-single-item-fills-the-remaining-space.tsx new file mode 100644 index 00000000000..53821939dea --- /dev/null +++ b/polaris.shopify.com/pages/examples/legacy-stack-where-a-single-item-fills-the-remaining-space.tsx @@ -0,0 +1,23 @@ +import {LegacyStack, Badge, Text} from '@shopify/polaris'; +import React from 'react'; +import {withPolarisExample} from '../../src/components/PolarisExampleWrapper'; + +function LegacyStackExample() { + return ( + + + + Order #1136 + + + + Paid + + + Fulfilled + + + ); +} + +export default withPolarisExample(LegacyStackExample); diff --git a/polaris.shopify.com/pages/examples/legacy-stack-where-items-fill-space-evenly.tsx b/polaris.shopify.com/pages/examples/legacy-stack-where-items-fill-space-evenly.tsx new file mode 100644 index 00000000000..aa629bfbdbc --- /dev/null +++ b/polaris.shopify.com/pages/examples/legacy-stack-where-items-fill-space-evenly.tsx @@ -0,0 +1,17 @@ +import {LegacyStack, Badge, Text} from '@shopify/polaris'; +import React from 'react'; +import {withPolarisExample} from '../../src/components/PolarisExampleWrapper'; + +function LegacyStackExample() { + return ( + + + Order #1136 + + Paid + Fulfilled + + ); +} + +export default withPolarisExample(LegacyStackExample); diff --git a/polaris.shopify.com/public/images/components/legacy-stack.png b/polaris.shopify.com/public/images/components/legacy-stack.png new file mode 100644 index 0000000000000000000000000000000000000000..521e95bfdf7c450b85fa7c9a3094994e38c56ec2 GIT binary patch literal 8562 zcmeHNYfuwc6uujY5Rsr@5rYPh@iq9u7eO$*f`~2DQmM%lFja}QA~A-d0!oxnwIsxG ze8d5XtsQ8`j0RC&1`-iMg#@LJm4FbQ2?2`1kdOcg-H>*sKRVOD{jocbDsGM4O=?sJN;y+!s1@qG?+!c{kT^zgyDPJrfwpAZ+wS^$8=1pvr50+9Uz0A%k30Ldc& z$*BM!-~a(iFiJ$g0SpctokcaJrKN*LV@9<^auAQl-)w4XLic={m6g?EwOUW5r$5dn z5|azCuD6mVcg~KDjV03rX2+S(!`2nVm*U*q+`);7i4>2qnrQ{CdfG6OVhN{Uz_seb-SK%wa%frAvtKk{Q#myL?-fCR^HZagxglC`*y-iaggaJHnJl+FPlap&*Y&J)j3zpD| zwihaBPlX%vge1aAMqa0k7;0;4`$vL+ zGwxE>30&p*5{^4|h_#`R(aIsO+y|uZirz>w8!%2>#V;#eQ(tSf+Aa6WV{(@27)8sy zH*Ix03Q?2$IkG5}?L}qf<>j_)S3fl{aO8Gd)vl1^1SmsQHBK0LR)4vCV=0gp74UeL zP#1ru6=DX3I^#ta5FmHYOX+_5 z-gR}=rjl(bnia}LPY^D9J#@Tn?te%RpmkgHP}d*&h1uv@p+W|s%|9icnQyE9ewgsYIl^E7%+}LfCg#-3hvgn$<$1L6ZSM%9F m$lg*$43KrO1 Date: Wed, 1 Feb 2023 15:06:58 -0500 Subject: [PATCH 3/4] Add changeset --- .changeset/calm-hats-cover.md | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 .changeset/calm-hats-cover.md diff --git a/.changeset/calm-hats-cover.md b/.changeset/calm-hats-cover.md new file mode 100644 index 00000000000..1f853b2b94e --- /dev/null +++ b/.changeset/calm-hats-cover.md @@ -0,0 +1,6 @@ +--- +'@shopify/polaris': minor +'polaris.shopify.com': minor +--- + +Added `LegacyStack` component From dbf36c3fca5618270b6d56760b23486915aa53c8 Mon Sep 17 00:00:00 2001 From: Lo Kim Date: Fri, 3 Feb 2023 08:32:42 -0500 Subject: [PATCH 4/4] [polaris.shopify.com] Run `get-props` script --- polaris.shopify.com/src/data/props.json | 3475 ++++++++++++----------- 1 file changed, 1790 insertions(+), 1685 deletions(-) diff --git a/polaris.shopify.com/src/data/props.json b/polaris.shopify.com/src/data/props.json index c6957a71cc7..7dca71c9bb3 100644 --- a/polaris.shopify.com/src/data/props.json +++ b/polaris.shopify.com/src/data/props.json @@ -3822,6 +3822,41 @@ "value": "export interface Features {}" } }, + "IdGenerator": { + "polaris-react/src/utilities/unique-id/unique-id-factory.ts": { + "filePath": "polaris-react/src/utilities/unique-id/unique-id-factory.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "IdGenerator", + "value": "() => string", + "description": "" + } + }, + "IdGeneratorFactory": { + "polaris-react/src/utilities/unique-id/unique-id-factory.ts": { + "filePath": "polaris-react/src/utilities/unique-id/unique-id-factory.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "IdGeneratorFactory", + "value": "(prefix: string) => IdGenerator", + "description": "" + } + }, + "Options": { + "polaris-react/src/utilities/focus-manager/hooks.ts": { + "filePath": "polaris-react/src/utilities/focus-manager/hooks.ts", + "name": "Options", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/utilities/focus-manager/hooks.ts", + "syntaxKind": "PropertySignature", + "name": "trapping", + "value": "boolean", + "description": "" + } + ], + "value": "interface Options {\n trapping: boolean;\n}" + } + }, "Logo": { "polaris-react/src/utilities/frame/types.ts": { "filePath": "polaris-react/src/utilities/frame/types.ts", @@ -4268,41 +4303,6 @@ "description": "" } }, - "IdGenerator": { - "polaris-react/src/utilities/unique-id/unique-id-factory.ts": { - "filePath": "polaris-react/src/utilities/unique-id/unique-id-factory.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "IdGenerator", - "value": "() => string", - "description": "" - } - }, - "IdGeneratorFactory": { - "polaris-react/src/utilities/unique-id/unique-id-factory.ts": { - "filePath": "polaris-react/src/utilities/unique-id/unique-id-factory.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "IdGeneratorFactory", - "value": "(prefix: string) => IdGenerator", - "description": "" - } - }, - "Options": { - "polaris-react/src/utilities/focus-manager/hooks.ts": { - "filePath": "polaris-react/src/utilities/focus-manager/hooks.ts", - "name": "Options", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/utilities/focus-manager/hooks.ts", - "syntaxKind": "PropertySignature", - "name": "trapping", - "value": "boolean", - "description": "" - } - ], - "value": "interface Options {\n trapping: boolean;\n}" - } - }, "LinkLikeComponentProps": { "polaris-react/src/utilities/link/types.ts": { "filePath": "polaris-react/src/utilities/link/types.ts", @@ -7652,57 +7652,6 @@ "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", @@ -7791,6 +7740,13 @@ "value": "'extraTight' | 'tight' | 'loose'", "description": "" }, + "polaris-react/src/components/LegacyStack/LegacyStack.tsx": { + "filePath": "polaris-react/src/components/LegacyStack/LegacyStack.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Spacing", + "value": "'extraTight' | 'tight' | 'baseTight' | 'loose' | 'extraLoose' | 'none'", + "description": "" + }, "polaris-react/src/components/List/List.tsx": { "filePath": "polaris-react/src/components/List/List.tsx", "syntaxKind": "TypeAliasDeclaration", @@ -7857,6 +7813,57 @@ "value": "export interface AlphaCardProps {\n children?: React.ReactNode;\n /** Background color\n * @default 'surface'\n */\n background?: CardBackgroundColorTokenScale;\n /** The spacing around the card\n * @default {xs: '4', sm: '5'}\n * @example\n * padding='4'\n * padding={{xs: '2', sm: '3', md: '4', lg: '5', xl: '6'}}\n */\n padding?: Spacing;\n /** Border radius value above a set breakpoint */\n roundedAbove?: BreakpointsAlias;\n}" } }, + "ActionListProps": { + "polaris-react/src/components/ActionList/ActionList.tsx": { + "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", + "name": "ActionListProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", + "syntaxKind": "PropertySignature", + "name": "items", + "value": "readonly ActionListItemDescriptor[]", + "description": "Collection of actions for list", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", + "syntaxKind": "PropertySignature", + "name": "sections", + "value": "readonly ActionListSection[]", + "description": "Collection of sectioned action items", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", + "syntaxKind": "PropertySignature", + "name": "actionRole", + "value": "string", + "description": "Defines a specific role attribute for each action in the list", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", + "syntaxKind": "PropertySignature", + "name": "onActionAnyItem", + "value": "() => void", + "description": "Callback when any item is clicked or keypressed", + "isOptional": true + } + ], + "value": "export interface ActionListProps {\n /** Collection of actions for list */\n items?: readonly ActionListItemDescriptor[];\n /** Collection of sectioned action items */\n sections?: readonly ActionListSection[];\n /** Defines a specific role attribute for each action in the list */\n actionRole?: 'menuitem' | string;\n /** Callback when any item is clicked or keypressed */\n onActionAnyItem?: ActionListItemDescriptor['onAction'];\n}" + } + }, + "ActionListItemProps": { + "polaris-react/src/components/ActionList/ActionList.tsx": { + "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "ActionListItemProps", + "value": "ItemProps", + "description": "" + } + }, "Props": { "polaris-react/src/components/AfterInitialMount/AfterInitialMount.tsx": { "filePath": "polaris-react/src/components/AfterInitialMount/AfterInitialMount.tsx", @@ -10221,6 +10228,23 @@ "value": "export interface BoxProps extends React.AriaAttributes {\n children?: React.ReactNode;\n /** HTML Element type\n * @default 'div'\n */\n as?: Element;\n /** Background color */\n background?: BackgroundColors;\n /** Border style */\n border?: BorderTokenAlias;\n /** Vertical end border style */\n borderBlockEnd?: BorderTokenAlias;\n /** Horizontal start border style */\n borderInlineStart?: BorderTokenAlias;\n /** Horizontal end border style */\n borderInlineEnd?: BorderTokenAlias;\n /** Vertical start border style */\n borderBlockStart?: BorderTokenAlias;\n /** Border radius */\n borderRadius?: BorderRadiusTokenScale;\n /** Vertical end horizontal start border radius */\n borderRadiusEndStart?: BorderRadiusTokenScale;\n /** Vertical end horizontal end border radius */\n borderRadiusEndEnd?: BorderRadiusTokenScale;\n /** Vertical start horizontal start border radius */\n borderRadiusStartStart?: BorderRadiusTokenScale;\n /** Vertical start horizontal end border radius */\n borderRadiusStartEnd?: BorderRadiusTokenScale;\n /** Border width */\n borderWidth?: ShapeBorderWidthScale;\n /** Vertical start border width */\n borderBlockStartWidth?: ShapeBorderWidthScale;\n /** Vertical end border width */\n borderBlockEndWidth?: ShapeBorderWidthScale;\n /** Horizontal start border width */\n borderInlineStartWidth?: ShapeBorderWidthScale;\n /** Horizontal end border width */\n borderInlineEndWidth?: ShapeBorderWidthScale;\n /** Color of children */\n color?: ColorTokenScale;\n /** HTML id attribute */\n id?: string;\n /** Minimum height of container */\n minHeight?: string;\n /** Minimum width of container */\n minWidth?: string;\n /** Maximum width of container */\n maxWidth?: string;\n /** Clip horizontal content of children */\n overflowX?: Overflow;\n /** Clip vertical content of children */\n overflowY?: Overflow;\n /** Spacing around children. Accepts a spacing token or an object of spacing tokens for different screen sizes.\n * @example\n * padding='4'\n * padding={{xs: '2', sm: '3', md: '4', lg: '5', xl: '6'}}\n */\n padding?: Spacing;\n /** Vertical start spacing around children. Accepts a spacing token or an object of spacing tokens for different screen sizes.\n * @example\n * paddingBlockStart='4'\n * paddingBlockStart={{xs: '2', sm: '3', md: '4', lg: '5', xl: '6'}}\n */\n paddingBlockStart?: Spacing;\n /** Vertical end spacing around children. Accepts a spacing token or an object of spacing tokens for different screen sizes.\n * @example\n * paddingBlockEnd='4'\n * paddingBlockEnd={{xs: '2', sm: '3', md: '4', lg: '5', xl: '6'}}\n */\n paddingBlockEnd?: Spacing;\n /** Horizontal start spacing around children. Accepts a spacing token or an object of spacing tokens for different screen sizes.\n * @example\n * paddingInlineStart='4'\n * paddingInlineStart={{xs: '2', sm: '3', md: '4', lg: '5', xl: '6'}}\n */\n paddingInlineStart?: Spacing;\n /** Horizontal end spacing around children. Accepts a spacing token or an object of spacing tokens for different screen sizes.\n * @example\n * paddingInlineEnd='4'\n * paddingInlineEnd={{xs: '2', sm: '3', md: '4', lg: '5', xl: '6'}}\n */\n paddingInlineEnd?: Spacing;\n /** Aria role */\n role?: Extract<\n React.AriaRole,\n 'status' | 'presentation' | 'menu' | 'listbox' | 'combobox'\n >;\n /** Shadow on box */\n shadow?: DepthShadowAlias;\n /** Set tab order */\n tabIndex?: Extract['tabIndex'], number>;\n /** Width of container */\n width?: string;\n // These could be moved to new layout component(s) in the future\n /** Position of box */\n position?: Position;\n /** Top position of box */\n insetBlockStart?: Spacing;\n /** Bottom position of box */\n insetBlockEnd?: Spacing;\n /** Left position of box */\n insetInlineStart?: Spacing;\n /** Right position of box */\n insetInlineEnd?: Spacing;\n /** Opacity of box */\n opacity?: string;\n /** Outline style */\n outline?: BorderTokenAlias;\n /** Visually hide the contents during print */\n printHidden?: boolean;\n /** Visually hide the contents (still announced by screenreader) */\n visuallyHidden?: boolean;\n /** z-index of box */\n zIndex?: string;\n}" } }, + "BreadcrumbsProps": { + "polaris-react/src/components/Breadcrumbs/Breadcrumbs.tsx": { + "filePath": "polaris-react/src/components/Breadcrumbs/Breadcrumbs.tsx", + "name": "BreadcrumbsProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Breadcrumbs/Breadcrumbs.tsx", + "syntaxKind": "PropertySignature", + "name": "breadcrumbs", + "value": "LinkAction | CallbackAction | (LinkAction | CallbackAction)[]", + "description": "Collection of breadcrumbs" + } + ], + "value": "export interface BreadcrumbsProps {\n /** Collection of breadcrumbs */\n breadcrumbs: (CallbackAction | LinkAction) | (CallbackAction | LinkAction)[];\n}" + } + }, "BulkAction": { "polaris-react/src/components/BulkActions/BulkActions.tsx": { "filePath": "polaris-react/src/components/BulkActions/BulkActions.tsx", @@ -10435,122 +10459,47 @@ "description": "" } }, - "BreadcrumbsProps": { - "polaris-react/src/components/Breadcrumbs/Breadcrumbs.tsx": { - "filePath": "polaris-react/src/components/Breadcrumbs/Breadcrumbs.tsx", - "name": "BreadcrumbsProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Breadcrumbs/Breadcrumbs.tsx", - "syntaxKind": "PropertySignature", - "name": "breadcrumbs", - "value": "LinkAction | CallbackAction | (LinkAction | CallbackAction)[]", - "description": "Collection of breadcrumbs" - } - ], - "value": "export interface BreadcrumbsProps {\n /** Collection of breadcrumbs */\n breadcrumbs: (CallbackAction | LinkAction) | (CallbackAction | LinkAction)[];\n}" - } - }, - "ButtonGroupProps": { - "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx": { - "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", - "name": "ButtonGroupProps", + "ButtonProps": { + "polaris-react/src/components/Button/Button.tsx": { + "filePath": "polaris-react/src/components/Button/Button.tsx", + "name": "ButtonProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", + "filePath": "polaris-react/src/components/Button/Button.tsx", "syntaxKind": "PropertySignature", - "name": "spacing", - "value": "Spacing", - "description": "Determines the space between button group items", + "name": "children", + "value": "string | string[]", + "description": "The content to display inside the button", "isOptional": true }, { - "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", + "filePath": "polaris-react/src/components/Button/Button.tsx", "syntaxKind": "PropertySignature", - "name": "segmented", + "name": "primary", "value": "boolean", - "description": "Join buttons as segmented group", + "description": "Provides extra visual weight and identifies the primary action in a set of buttons", "isOptional": true }, { - "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", + "filePath": "polaris-react/src/components/Button/Button.tsx", "syntaxKind": "PropertySignature", - "name": "fullWidth", + "name": "destructive", "value": "boolean", - "description": "Buttons will stretch/shrink to occupy the full width", + "description": "Indicates a dangerous or potentially negative action", "isOptional": true }, { - "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", + "filePath": "polaris-react/src/components/Button/Button.tsx", "syntaxKind": "PropertySignature", - "name": "connectedTop", - "value": "boolean", - "description": "Remove top left and right border radius", - "isOptional": true + "name": "size", + "value": "\"medium\" | \"large\" | \"slim\"", + "description": "Changes the size of the button, giving it more or less padding", + "isOptional": true, + "defaultValue": "'medium'" }, { - "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", - "syntaxKind": "PropertySignature", - "name": "noWrap", - "value": "boolean", - "description": "Prevent buttons in button group from wrapping to next line", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "Button components", - "isOptional": true - } - ], - "value": "export interface ButtonGroupProps {\n /** Determines the space between button group items */\n spacing?: Spacing;\n /** Join buttons as segmented group */\n segmented?: boolean;\n /** Buttons will stretch/shrink to occupy the full width */\n fullWidth?: boolean;\n /** Remove top left and right border radius */\n connectedTop?: boolean;\n /** Prevent buttons in button group from wrapping to next line */\n noWrap?: boolean;\n /** Button components */\n children?: React.ReactNode;\n}" - } - }, - "ButtonProps": { - "polaris-react/src/components/Button/Button.tsx": { - "filePath": "polaris-react/src/components/Button/Button.tsx", - "name": "ButtonProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Button/Button.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "string | string[]", - "description": "The content to display inside the button", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Button/Button.tsx", - "syntaxKind": "PropertySignature", - "name": "primary", - "value": "boolean", - "description": "Provides extra visual weight and identifies the primary action in a set of buttons", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Button/Button.tsx", - "syntaxKind": "PropertySignature", - "name": "destructive", - "value": "boolean", - "description": "Indicates a dangerous or potentially negative action", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Button/Button.tsx", - "syntaxKind": "PropertySignature", - "name": "size", - "value": "\"medium\" | \"large\" | \"slim\"", - "description": "Changes the size of the button, giving it more or less padding", - "isOptional": true, - "defaultValue": "'medium'" - }, - { - "filePath": "polaris-react/src/components/Button/Button.tsx", + "filePath": "polaris-react/src/components/Button/Button.tsx", "syntaxKind": "PropertySignature", "name": "textAlign", "value": "\"start\" | \"end\" | \"center\" | \"left\" | \"right\"", @@ -10867,6 +10816,64 @@ "description": "" } }, + "ButtonGroupProps": { + "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx": { + "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", + "name": "ButtonGroupProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "spacing", + "value": "Spacing", + "description": "Determines the space between button group items", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "segmented", + "value": "boolean", + "description": "Join buttons as segmented group", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "fullWidth", + "value": "boolean", + "description": "Buttons will stretch/shrink to occupy the full width", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "connectedTop", + "value": "boolean", + "description": "Remove top left and right border radius", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "noWrap", + "value": "boolean", + "description": "Prevent buttons in button group from wrapping to next line", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "Button components", + "isOptional": true + } + ], + "value": "export interface ButtonGroupProps {\n /** Determines the space between button group items */\n spacing?: Spacing;\n /** Join buttons as segmented group */\n segmented?: boolean;\n /** Buttons will stretch/shrink to occupy the full width */\n fullWidth?: boolean;\n /** Remove top left and right border radius */\n connectedTop?: boolean;\n /** Prevent buttons in button group from wrapping to next line */\n noWrap?: boolean;\n /** Button components */\n children?: React.ReactNode;\n}" + } + }, "CalloutCardProps": { "polaris-react/src/components/CalloutCard/CalloutCard.tsx": { "filePath": "polaris-react/src/components/CalloutCard/CalloutCard.tsx", @@ -10940,64 +10947,6 @@ "value": "export interface CaptionProps {\n /** The content to use as a graph label or timestamp */\n children?: React.ReactNode;\n}" } }, - "CheckableButtonProps": { - "polaris-react/src/components/CheckableButton/CheckableButton.tsx": { - "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx", - "name": "CheckableButtonProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx", - "syntaxKind": "PropertySignature", - "name": "label", - "value": "string", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx", - "syntaxKind": "PropertySignature", - "name": "selected", - "value": "boolean | \"indeterminate\"", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx", - "syntaxKind": "MethodSignature", - "name": "onToggleAll", - "value": "() => void", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx", - "syntaxKind": "PropertySignature", - "name": "ariaLive", - "value": "\"off\" | \"polite\"", - "description": "", - "isOptional": true - } - ], - "value": "export interface CheckableButtonProps {\n accessibilityLabel?: string;\n label?: string;\n selected?: boolean | 'indeterminate';\n disabled?: boolean;\n onToggleAll?(): void;\n ariaLive?: 'off' | 'polite';\n}" - } - }, "CardProps": { "polaris-react/src/components/Card/Card.tsx": { "filePath": "polaris-react/src/components/Card/Card.tsx", @@ -11088,6 +11037,64 @@ "value": "export interface CardProps {\n /** Title content for the card */\n title?: React.ReactNode;\n /** Inner content of the card */\n children?: React.ReactNode;\n /** A less prominent card */\n subdued?: boolean;\n /** Auto wrap content in section */\n sectioned?: boolean;\n /** Card header actions */\n actions?: DisableableAction[];\n /** Primary action in the card footer */\n primaryFooterAction?: ComplexAction;\n /** Secondary actions in the card footer */\n secondaryFooterActions?: ComplexAction[];\n /** The content of the disclosure button rendered when there is more than one secondary footer action */\n secondaryFooterActionsDisclosureText?: string;\n /** Alignment of the footer actions on the card, defaults to right */\n footerActionAlignment?: 'right' | 'left';\n /** Allow the card to be hidden when printing */\n hideOnPrint?: boolean;\n}" } }, + "CheckableButtonProps": { + "polaris-react/src/components/CheckableButton/CheckableButton.tsx": { + "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx", + "name": "CheckableButtonProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx", + "syntaxKind": "PropertySignature", + "name": "selected", + "value": "boolean | \"indeterminate\"", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx", + "syntaxKind": "MethodSignature", + "name": "onToggleAll", + "value": "() => void", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx", + "syntaxKind": "PropertySignature", + "name": "ariaLive", + "value": "\"off\" | \"polite\"", + "description": "", + "isOptional": true + } + ], + "value": "export interface CheckableButtonProps {\n accessibilityLabel?: string;\n label?: string;\n selected?: boolean | 'indeterminate';\n disabled?: boolean;\n onToggleAll?(): void;\n ariaLive?: 'off' | 'polite';\n}" + } + }, "CheckboxState": { "polaris-react/src/components/Checkbox/Checkbox.stories.tsx": { "filePath": "polaris-react/src/components/Checkbox/Checkbox.stories.tsx", @@ -11729,101 +11736,28 @@ "value": "export interface ColorPickerProps {\n /** ID for the element */\n id?: string;\n /** The currently selected color */\n color: Color;\n /** Allow user to select an alpha value */\n allowAlpha?: boolean;\n /** Allow HuePicker to take the full width */\n fullWidth?: boolean;\n /** Callback when color is selected */\n onChange(color: HSBAColor): void;\n}" } }, - "ComboboxProps": { - "polaris-react/src/components/Combobox/Combobox.tsx": { - "filePath": "polaris-react/src/components/Combobox/Combobox.tsx", - "name": "ComboboxProps", + "Columns": { + "polaris-react/src/components/Columns/Columns.tsx": { + "filePath": "polaris-react/src/components/Columns/Columns.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Columns", + "value": "{\n [Breakpoint in BreakpointsAlias]?: number | string;\n}", + "description": "" + }, + "polaris-react/src/components/Grid/Grid.tsx": { + "filePath": "polaris-react/src/components/Grid/Grid.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Columns", + "value": "{\n [Breakpoint in Breakpoints]?: number;\n}", + "description": "" + }, + "polaris-react/src/components/Grid/components/Cell/Cell.tsx": { + "filePath": "polaris-react/src/components/Grid/components/Cell/Cell.tsx", + "name": "Columns", "description": "", "members": [ { - "filePath": "polaris-react/src/components/Combobox/Combobox.tsx", - "syntaxKind": "PropertySignature", - "name": "activator", - "value": "React.ReactElement", - "description": "The text field component to activate the Popover" - }, - { - "filePath": "polaris-react/src/components/Combobox/Combobox.tsx", - "syntaxKind": "PropertySignature", - "name": "allowMultiple", - "value": "boolean", - "description": "Allows more than one option to be selected", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Combobox/Combobox.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "any", - "description": "The content to display inside the popover", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Combobox/Combobox.tsx", - "syntaxKind": "PropertySignature", - "name": "preferredPosition", - "value": "PreferredPosition", - "description": "The preferred direction to open the popover", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Combobox/Combobox.tsx", - "syntaxKind": "PropertySignature", - "name": "willLoadMoreOptions", - "value": "boolean", - "description": "Whether or not more options are available to lazy load when the bottom of the listbox reached. Use the hasMoreResults boolean provided by the GraphQL API of the paginated data.", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Combobox/Combobox.tsx", - "syntaxKind": "PropertySignature", - "name": "height", - "value": "string", - "description": "Height to set on the Popover Pane.", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Combobox/Combobox.tsx", - "syntaxKind": "MethodSignature", - "name": "onScrolledToBottom", - "value": "() => void", - "description": "Callback fired when the bottom of the lisbox is reached. Use to lazy load when listbox option data is paginated.", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Combobox/Combobox.tsx", - "syntaxKind": "MethodSignature", - "name": "onClose", - "value": "() => void", - "description": "Callback fired when the popover closes", - "isOptional": true - } - ], - "value": "export interface ComboboxProps {\n /** The text field component to activate the Popover */\n activator: React.ReactElement;\n /** Allows more than one option to be selected */\n allowMultiple?: boolean;\n /** The content to display inside the popover */\n children?: React.ReactElement | null;\n /** The preferred direction to open the popover */\n preferredPosition?: PopoverProps['preferredPosition'];\n /** Whether or not more options are available to lazy load when the bottom of the listbox reached. Use the hasMoreResults boolean provided by the GraphQL API of the paginated data. */\n willLoadMoreOptions?: boolean;\n /** Height to set on the Popover Pane. */\n height?: string;\n /** Callback fired when the bottom of the lisbox is reached. Use to lazy load when listbox option data is paginated. */\n onScrolledToBottom?(): void;\n /** Callback fired when the popover closes */\n onClose?(): void;\n}" - } - }, - "Columns": { - "polaris-react/src/components/Columns/Columns.tsx": { - "filePath": "polaris-react/src/components/Columns/Columns.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Columns", - "value": "{\n [Breakpoint in BreakpointsAlias]?: number | string;\n}", - "description": "" - }, - "polaris-react/src/components/Grid/Grid.tsx": { - "filePath": "polaris-react/src/components/Grid/Grid.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Columns", - "value": "{\n [Breakpoint in Breakpoints]?: number;\n}", - "description": "" - }, - "polaris-react/src/components/Grid/components/Cell/Cell.tsx": { - "filePath": "polaris-react/src/components/Grid/components/Cell/Cell.tsx", - "name": "Columns", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Grid/components/Cell/Cell.tsx", + "filePath": "polaris-react/src/components/Grid/components/Cell/Cell.tsx", "syntaxKind": "PropertySignature", "name": "xs", "value": "2 | 5 | 1 | 4 | 3 | 6", @@ -11902,6 +11836,79 @@ "value": "export interface ColumnsProps {\n children?: React.ReactNode;\n /** The number of columns to display\n * @default {xs: 6, sm: 6, md: 6, lg: 6, xl: 6}\n */\n columns?: Columns;\n /** The spacing between children. Accepts a spacing token or an object of spacing tokens for different screen sizes.\n * @default '4'\n * @example\n * gap='2'\n * gap={{xs: '1', sm: '2', md: '3', lg: '4', xl: '5'}}\n */\n gap?: Gap;\n}" } }, + "ComboboxProps": { + "polaris-react/src/components/Combobox/Combobox.tsx": { + "filePath": "polaris-react/src/components/Combobox/Combobox.tsx", + "name": "ComboboxProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Combobox/Combobox.tsx", + "syntaxKind": "PropertySignature", + "name": "activator", + "value": "React.ReactElement", + "description": "The text field component to activate the Popover" + }, + { + "filePath": "polaris-react/src/components/Combobox/Combobox.tsx", + "syntaxKind": "PropertySignature", + "name": "allowMultiple", + "value": "boolean", + "description": "Allows more than one option to be selected", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Combobox/Combobox.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "any", + "description": "The content to display inside the popover", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Combobox/Combobox.tsx", + "syntaxKind": "PropertySignature", + "name": "preferredPosition", + "value": "PreferredPosition", + "description": "The preferred direction to open the popover", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Combobox/Combobox.tsx", + "syntaxKind": "PropertySignature", + "name": "willLoadMoreOptions", + "value": "boolean", + "description": "Whether or not more options are available to lazy load when the bottom of the listbox reached. Use the hasMoreResults boolean provided by the GraphQL API of the paginated data.", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Combobox/Combobox.tsx", + "syntaxKind": "PropertySignature", + "name": "height", + "value": "string", + "description": "Height to set on the Popover Pane.", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Combobox/Combobox.tsx", + "syntaxKind": "MethodSignature", + "name": "onScrolledToBottom", + "value": "() => void", + "description": "Callback fired when the bottom of the lisbox is reached. Use to lazy load when listbox option data is paginated.", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Combobox/Combobox.tsx", + "syntaxKind": "MethodSignature", + "name": "onClose", + "value": "() => void", + "description": "Callback fired when the popover closes", + "isOptional": true + } + ], + "value": "export interface ComboboxProps {\n /** The text field component to activate the Popover */\n activator: React.ReactElement;\n /** Allows more than one option to be selected */\n allowMultiple?: boolean;\n /** The content to display inside the popover */\n children?: React.ReactElement | null;\n /** The preferred direction to open the popover */\n preferredPosition?: PopoverProps['preferredPosition'];\n /** Whether or not more options are available to lazy load when the bottom of the listbox reached. Use the hasMoreResults boolean provided by the GraphQL API of the paginated data. */\n willLoadMoreOptions?: boolean;\n /** Height to set on the Popover Pane. */\n height?: string;\n /** Callback fired when the bottom of the lisbox is reached. Use to lazy load when listbox option data is paginated. */\n onScrolledToBottom?(): void;\n /** Callback fired when the popover closes */\n onClose?(): void;\n}" + } + }, "ConnectedProps": { "polaris-react/src/components/Connected/Connected.tsx": { "filePath": "polaris-react/src/components/Connected/Connected.tsx", @@ -12144,250 +12151,250 @@ "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}" } }, - "Item": { - "polaris-react/src/components/DescriptionList/DescriptionList.tsx": { - "filePath": "polaris-react/src/components/DescriptionList/DescriptionList.tsx", - "name": "Item", + "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/DescriptionList/DescriptionList.tsx", + "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", "syntaxKind": "PropertySignature", - "name": "term", - "value": "React.ReactNode", - "description": "Title of the item" + "name": "id", + "value": "string", + "description": "ID for the element", + "isOptional": true }, { - "filePath": "polaris-react/src/components/DescriptionList/DescriptionList.tsx", + "filePath": "polaris-react/src/components/DatePicker/DatePicker.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": "selected", + "value": "Range | Date", + "description": "The selected date or range of dates", + "isOptional": true + }, { - "filePath": "polaris-react/src/components/ExceptionList/ExceptionList.tsx", + "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", "syntaxKind": "PropertySignature", - "name": "status", - "value": "\"warning\" | \"critical\"", - "description": "Set the color of the icon and title for the given item.", - "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/ExceptionList/ExceptionList.tsx", + "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", "syntaxKind": "PropertySignature", - "name": "icon", - "value": "any", - "description": "Icon displayed by the list item", - "isOptional": true + "name": "year", + "value": "number", + "description": "The year to show" }, { - "filePath": "polaris-react/src/components/ExceptionList/ExceptionList.tsx", + "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "Text displayed beside the icon", + "name": "allowRange", + "value": "boolean", + "description": "Allow a range of dates to be selected", "isOptional": true }, { - "filePath": "polaris-react/src/components/ExceptionList/ExceptionList.tsx", + "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", "syntaxKind": "PropertySignature", - "name": "description", - "value": "any", - "description": "Text displayed for the item", + "name": "disableDatesBefore", + "value": "Date", + "description": "Disable selecting dates before this.", "isOptional": true }, { - "filePath": "polaris-react/src/components/ExceptionList/ExceptionList.tsx", + "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", "syntaxKind": "PropertySignature", - "name": "truncate", - "value": "boolean", - "description": "Should the description be truncated at end of line", + "name": "disableDatesAfter", + "value": "Date", + "description": "Disable selecting dates after this.", "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/DatePicker/DatePicker.tsx", "syntaxKind": "PropertySignature", - "name": "items", - "value": "Item[]", - "description": "Collection of items for list" + "name": "disableSpecificDates", + "value": "Date[]", + "description": "Disable specific dates.", + "isOptional": true }, { - "filePath": "polaris-react/src/components/DescriptionList/DescriptionList.tsx", + "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", "syntaxKind": "PropertySignature", - "name": "spacing", - "value": "\"tight\" | \"loose\"", - "description": "Determines the spacing between list items", + "name": "multiMonth", + "value": "boolean", + "description": "The selection can span multiple months", "isOptional": true - } - ], - "value": "export interface DescriptionListProps {\n /** Collection of items for list */\n items: Item[];\n /** Determines the spacing between list items */\n spacing?: 'tight' | 'loose';\n}" - } - }, - "DisplayTextProps": { - "polaris-react/src/components/DisplayText/DisplayText.tsx": { - "filePath": "polaris-react/src/components/DisplayText/DisplayText.tsx", - "name": "DisplayTextProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/DisplayText/DisplayText.tsx", - "syntaxKind": "PropertySignature", - "name": "element", - "value": "HeadingTagName", - "description": "Name of element to use for text", - "isOptional": true, - "defaultValue": "'p'" }, { - "filePath": "polaris-react/src/components/DisplayText/DisplayText.tsx", + "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", "syntaxKind": "PropertySignature", - "name": "size", - "value": "Size", - "description": "Size of the text", + "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": "'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}" - } - }, - "DatePickerProps": { - "polaris-react/src/components/DatePicker/DatePicker.tsx": { - "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", - "name": "DatePickerProps", - "description": "", - "members": [ { "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", "syntaxKind": "PropertySignature", - "name": "id", + "name": "dayAccessibilityLabelPrefix", "value": "string", - "description": "ID for the element", + "description": "Visually hidden prefix text for selected days on single selection date pickers", "isOptional": true }, { "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", - "syntaxKind": "PropertySignature", - "name": "selected", - "value": "Range | Date", - "description": "The selected date or range of dates", + "syntaxKind": "MethodSignature", + "name": "onChange", + "value": "(date: Range) => void", + "description": "Callback when date is selected.", "isOptional": true }, { "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", + "syntaxKind": "MethodSignature", + "name": "onMonthChange", + "value": "(month: number, year: number) => void", + "description": "Callback when month is changed.", + "isOptional": true + } + ], + "value": "export interface DatePickerProps {\n /** ID for the element */\n id?: string;\n /** The selected date or range of dates */\n selected?: Date | Range;\n /** The month to show, from 0 to 11. 0 is January, 1 is February ... 11 is December */\n month: number;\n /** The year to show */\n year: number;\n /** Allow a range of dates to be selected */\n allowRange?: boolean;\n /** Disable selecting dates before this. */\n disableDatesBefore?: Date;\n /** Disable selecting dates after this. */\n disableDatesAfter?: Date;\n /** Disable specific dates. */\n disableSpecificDates?: Date[];\n /** The selection can span multiple months */\n multiMonth?: boolean;\n /**\n * First day of week, from 0 to 6. 0 is Sunday, 1 is Monday ... 6 is Saturday\n * @default 0\n */\n weekStartsOn?: number;\n /** Visually hidden prefix text for selected days on single selection date pickers */\n dayAccessibilityLabelPrefix?: string;\n /** Callback when date is selected. */\n onChange?(date: Range): void;\n /** Callback when month is changed. */\n onMonthChange?(month: number, year: number): void;\n}" + } + }, + "Item": { + "polaris-react/src/components/DescriptionList/DescriptionList.tsx": { + "filePath": "polaris-react/src/components/DescriptionList/DescriptionList.tsx", + "name": "Item", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/DescriptionList/DescriptionList.tsx", "syntaxKind": "PropertySignature", - "name": "month", - "value": "number", - "description": "The month to show, from 0 to 11. 0 is January, 1 is February ... 11 is December" + "name": "term", + "value": "React.ReactNode", + "description": "Title of the item" }, { - "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", + "filePath": "polaris-react/src/components/DescriptionList/DescriptionList.tsx", "syntaxKind": "PropertySignature", - "name": "year", - "value": "number", - "description": "The year to show" - }, + "name": "description", + "value": "React.ReactNode", + "description": "Item content" + } + ], + "value": "interface Item {\n /** Title of the item */\n term: React.ReactNode;\n /** Item content */\n description: React.ReactNode;\n}" + }, + "polaris-react/src/components/ExceptionList/ExceptionList.tsx": { + "filePath": "polaris-react/src/components/ExceptionList/ExceptionList.tsx", + "name": "Item", + "description": "", + "members": [ { - "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", + "filePath": "polaris-react/src/components/ExceptionList/ExceptionList.tsx", "syntaxKind": "PropertySignature", - "name": "allowRange", - "value": "boolean", - "description": "Allow a range of dates to be selected", + "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/DatePicker/DatePicker.tsx", + "filePath": "polaris-react/src/components/ExceptionList/ExceptionList.tsx", "syntaxKind": "PropertySignature", - "name": "disableDatesBefore", - "value": "Date", - "description": "Disable selecting dates before this.", + "name": "icon", + "value": "any", + "description": "Icon displayed by the list item", "isOptional": true }, { - "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", + "filePath": "polaris-react/src/components/ExceptionList/ExceptionList.tsx", "syntaxKind": "PropertySignature", - "name": "disableDatesAfter", - "value": "Date", - "description": "Disable selecting dates after this.", + "name": "title", + "value": "string", + "description": "Text displayed beside the icon", "isOptional": true }, { - "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", + "filePath": "polaris-react/src/components/ExceptionList/ExceptionList.tsx", "syntaxKind": "PropertySignature", - "name": "disableSpecificDates", - "value": "Date[]", - "description": "Disable specific dates.", + "name": "description", + "value": "any", + "description": "Text displayed for the item", "isOptional": true }, { - "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", + "filePath": "polaris-react/src/components/ExceptionList/ExceptionList.tsx", "syntaxKind": "PropertySignature", - "name": "multiMonth", + "name": "truncate", "value": "boolean", - "description": "The selection can span multiple months", + "description": "Should the description be truncated at end of line", "isOptional": true - }, + } + ], + "value": "interface Item {\n /** Set the color of the icon and title for the given item. */\n status?: 'critical' | 'warning';\n /** Icon displayed by the list item */\n icon?: IconProps['source'];\n /** Text displayed beside the icon */\n title?: string;\n /** Text displayed for the item */\n description?: Description;\n /** Should the description be truncated at end of line */\n truncate?: boolean;\n}" + } + }, + "DescriptionListProps": { + "polaris-react/src/components/DescriptionList/DescriptionList.tsx": { + "filePath": "polaris-react/src/components/DescriptionList/DescriptionList.tsx", + "name": "DescriptionListProps", + "description": "", + "members": [ { - "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", + "filePath": "polaris-react/src/components/DescriptionList/DescriptionList.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" + "name": "items", + "value": "Item[]", + "description": "Collection of items for list" }, { - "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", + "filePath": "polaris-react/src/components/DescriptionList/DescriptionList.tsx", "syntaxKind": "PropertySignature", - "name": "dayAccessibilityLabelPrefix", - "value": "string", - "description": "Visually hidden prefix text for selected days on single selection date pickers", + "name": "spacing", + "value": "\"tight\" | \"loose\"", + "description": "Determines the spacing between list items", "isOptional": true + } + ], + "value": "export interface DescriptionListProps {\n /** Collection of items for list */\n items: Item[];\n /** Determines the spacing between list items */\n spacing?: 'tight' | 'loose';\n}" + } + }, + "DisplayTextProps": { + "polaris-react/src/components/DisplayText/DisplayText.tsx": { + "filePath": "polaris-react/src/components/DisplayText/DisplayText.tsx", + "name": "DisplayTextProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/DisplayText/DisplayText.tsx", + "syntaxKind": "PropertySignature", + "name": "element", + "value": "HeadingTagName", + "description": "Name of element to use for text", + "isOptional": true, + "defaultValue": "'p'" }, { - "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", - "syntaxKind": "MethodSignature", - "name": "onChange", - "value": "(date: Range) => void", - "description": "Callback when date is selected.", - "isOptional": true + "filePath": "polaris-react/src/components/DisplayText/DisplayText.tsx", + "syntaxKind": "PropertySignature", + "name": "size", + "value": "Size", + "description": "Size of the text", + "isOptional": true, + "defaultValue": "'medium'" }, { - "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", - "syntaxKind": "MethodSignature", - "name": "onMonthChange", - "value": "(month: number, year: number) => void", - "description": "Callback when month is changed.", + "filePath": "polaris-react/src/components/DisplayText/DisplayText.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "Content to display", "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}" + "value": "export interface DisplayTextProps {\n /**\n * Name of element to use for text\n * @default 'p'\n */\n element?: HeadingTagName;\n /**\n * Size of the text\n * @default 'medium'\n */\n size?: Size;\n /** Content to display */\n children?: React.ReactNode;\n}" } }, "DividerProps": { @@ -13277,6 +13284,24 @@ "description": "" } }, + "FooterHelpProps": { + "polaris-react/src/components/FooterHelp/FooterHelp.tsx": { + "filePath": "polaris-react/src/components/FooterHelp/FooterHelp.tsx", + "name": "FooterHelpProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/FooterHelp/FooterHelp.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "The content to display inside the layout.", + "isOptional": true + } + ], + "value": "export interface FooterHelpProps {\n /** The content to display inside the layout. */\n children?: React.ReactNode;\n}" + } + }, "Enctype": { "polaris-react/src/components/Form/Form.tsx": { "filePath": "polaris-react/src/components/Form/Form.tsx", @@ -13409,14 +13434,14 @@ "value": "export interface FormProps {\n /** Space separated list of character encodings */\n acceptCharset?: string;\n /** Where to send form-data on submittal */\n action?: string;\n /** Grants the browser the ability to autocomplete input elements */\n autoComplete?: boolean;\n /** The content to display inside the form. */\n children?: React.ReactNode;\n /** Media type when submitting content to server */\n encType?: Enctype;\n /** Toggles if form submits on Enter keypress. Defaults to true. */\n implicitSubmit?: boolean;\n /** Method used to submit form */\n method?: Method;\n /** A unique name for the form */\n name?: string;\n /** Whether or not form is validated when submitting */\n noValidate?: boolean;\n /** Blocks the default form action */\n preventDefault?: boolean;\n /** Where to display response after form submittal */\n target?: Target;\n /** Callback when form is submitted */\n onSubmit(event: React.FormEvent): void;\n}" } }, - "FooterHelpProps": { - "polaris-react/src/components/FooterHelp/FooterHelp.tsx": { - "filePath": "polaris-react/src/components/FooterHelp/FooterHelp.tsx", - "name": "FooterHelpProps", + "FormLayoutProps": { + "polaris-react/src/components/FormLayout/FormLayout.tsx": { + "filePath": "polaris-react/src/components/FormLayout/FormLayout.tsx", + "name": "FormLayoutProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/FooterHelp/FooterHelp.tsx", + "filePath": "polaris-react/src/components/FormLayout/FormLayout.tsx", "syntaxKind": "PropertySignature", "name": "children", "value": "React.ReactNode", @@ -13424,25 +13449,7 @@ "isOptional": true } ], - "value": "export interface FooterHelpProps {\n /** The content to display inside the layout. */\n children?: React.ReactNode;\n}" - } - }, - "FormLayoutProps": { - "polaris-react/src/components/FormLayout/FormLayout.tsx": { - "filePath": "polaris-react/src/components/FormLayout/FormLayout.tsx", - "name": "FormLayoutProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/FormLayout/FormLayout.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "The content to display inside the layout.", - "isOptional": true - } - ], - "value": "export interface FormLayoutProps {\n /** The content to display inside the layout. */\n children?: React.ReactNode;\n}" + "value": "export interface FormLayoutProps {\n /** The content to display inside the layout. */\n children?: React.ReactNode;\n}" } }, "FrameProps": { @@ -14578,6 +14585,32 @@ "value": "export interface LabelledProps {\n /** A unique identifier for the label */\n id: LabelProps['id'];\n /** Text for the label */\n label: React.ReactNode;\n /** Error to display beneath the label */\n error?: Error | boolean;\n /** An action */\n action?: Action;\n /** Additional hint text to display */\n helpText?: React.ReactNode;\n /** Content to display inside the connected */\n children?: React.ReactNode;\n /** Visually hide the label */\n labelHidden?: boolean;\n /** Visual required indicator for the label */\n requiredIndicator?: boolean;\n}" } }, + "LayoutProps": { + "polaris-react/src/components/Layout/Layout.tsx": { + "filePath": "polaris-react/src/components/Layout/Layout.tsx", + "name": "LayoutProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Layout/Layout.tsx", + "syntaxKind": "PropertySignature", + "name": "sectioned", + "value": "boolean", + "description": "Automatically adds sections to layout.", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Layout/Layout.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "The content to display inside the layout.", + "isOptional": true + } + ], + "value": "export interface LayoutProps {\n /** Automatically adds sections to layout. */\n sectioned?: boolean;\n /** The content to display inside the layout. */\n children?: React.ReactNode;\n}" + } + }, "LegacyCardProps": { "polaris-react/src/components/LegacyCard/LegacyCard.tsx": { "filePath": "polaris-react/src/components/LegacyCard/LegacyCard.tsx", @@ -14668,30 +14701,129 @@ "value": "export interface LegacyCardProps {\n /** Title content for the card */\n title?: React.ReactNode;\n /** Inner content of the card */\n children?: React.ReactNode;\n /** A less prominent card */\n subdued?: boolean;\n /** Auto wrap content in section */\n sectioned?: boolean;\n /** Card header actions */\n actions?: DisableableAction[];\n /** Primary action in the card footer */\n primaryFooterAction?: ComplexAction;\n /** Secondary actions in the card footer */\n secondaryFooterActions?: ComplexAction[];\n /** The content of the disclosure button rendered when there is more than one secondary footer action */\n secondaryFooterActionsDisclosureText?: string;\n /** Alignment of the footer actions on the card, defaults to right */\n footerActionAlignment?: 'right' | 'left';\n /** Allow the card to be hidden when printing */\n hideOnPrint?: boolean;\n}" } }, - "LayoutProps": { - "polaris-react/src/components/Layout/Layout.tsx": { - "filePath": "polaris-react/src/components/Layout/Layout.tsx", - "name": "LayoutProps", + "Alignment": { + "polaris-react/src/components/LegacyStack/LegacyStack.tsx": { + "filePath": "polaris-react/src/components/LegacyStack/LegacyStack.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Alignment", + "value": "'leading' | 'trailing' | 'center' | 'fill' | 'baseline'", + "description": "" + }, + "polaris-react/src/components/OptionList/OptionList.tsx": { + "filePath": "polaris-react/src/components/OptionList/OptionList.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Alignment", + "value": "'top' | 'center' | 'bottom'", + "description": "" + }, + "polaris-react/src/components/ResourceItem/ResourceItem.tsx": { + "filePath": "polaris-react/src/components/ResourceItem/ResourceItem.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Alignment", + "value": "'leading' | 'trailing' | 'center' | 'fill' | 'baseline'", + "description": "" + }, + "polaris-react/src/components/Stack/Stack.tsx": { + "filePath": "polaris-react/src/components/Stack/Stack.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Alignment", + "value": "'leading' | 'trailing' | 'center' | 'fill' | 'baseline'", + "description": "" + }, + "polaris-react/src/components/Text/Text.tsx": { + "filePath": "polaris-react/src/components/Text/Text.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Alignment", + "value": "'start' | 'center' | 'end' | 'justify'", + "description": "" + }, + "polaris-react/src/components/TextField/TextField.tsx": { + "filePath": "polaris-react/src/components/TextField/TextField.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Alignment", + "value": "'left' | 'center' | 'right'", + "description": "" + }, + "polaris-react/src/components/OptionList/components/Option/Option.tsx": { + "filePath": "polaris-react/src/components/OptionList/components/Option/Option.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Alignment", + "value": "'top' | 'center' | 'bottom'", + "description": "" + } + }, + "Distribution": { + "polaris-react/src/components/LegacyStack/LegacyStack.tsx": { + "filePath": "polaris-react/src/components/LegacyStack/LegacyStack.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Distribution", + "value": "'equalSpacing' | 'leading' | 'trailing' | 'center' | 'fill' | 'fillEvenly'", + "description": "" + }, + "polaris-react/src/components/Stack/Stack.tsx": { + "filePath": "polaris-react/src/components/Stack/Stack.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Distribution", + "value": "'equalSpacing' | 'leading' | 'trailing' | 'center' | 'fill' | 'fillEvenly'", + "description": "" + } + }, + "LegacyStackProps": { + "polaris-react/src/components/LegacyStack/LegacyStack.tsx": { + "filePath": "polaris-react/src/components/LegacyStack/LegacyStack.tsx", + "name": "LegacyStackProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/Layout/Layout.tsx", + "filePath": "polaris-react/src/components/LegacyStack/LegacyStack.tsx", "syntaxKind": "PropertySignature", - "name": "sectioned", + "name": "children", + "value": "React.ReactNode", + "description": "Elements to display inside stack", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/LegacyStack/LegacyStack.tsx", + "syntaxKind": "PropertySignature", + "name": "wrap", "value": "boolean", - "description": "Automatically adds sections to layout.", + "description": "Wrap stack elements to additional rows as needed on small screens (Defaults to true)", "isOptional": true }, { - "filePath": "polaris-react/src/components/Layout/Layout.tsx", + "filePath": "polaris-react/src/components/LegacyStack/LegacyStack.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "The content to display inside the layout.", + "name": "vertical", + "value": "boolean", + "description": "Stack the elements vertically", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/LegacyStack/LegacyStack.tsx", + "syntaxKind": "PropertySignature", + "name": "spacing", + "value": "Spacing", + "description": "Adjust spacing between elements", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/LegacyStack/LegacyStack.tsx", + "syntaxKind": "PropertySignature", + "name": "alignment", + "value": "Alignment", + "description": "Adjust vertical alignment of elements", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/LegacyStack/LegacyStack.tsx", + "syntaxKind": "PropertySignature", + "name": "distribution", + "value": "Distribution", + "description": "Adjust horizontal alignment of elements", "isOptional": true } ], - "value": "export interface LayoutProps {\n /** Automatically adds sections to layout. */\n sectioned?: boolean;\n /** The content to display inside the layout. */\n children?: React.ReactNode;\n}" + "value": "export interface LegacyStackProps {\n /** Elements to display inside stack */\n children?: React.ReactNode;\n /** Wrap stack elements to additional rows as needed on small screens (Defaults to true) */\n wrap?: boolean;\n /** Stack the elements vertically */\n vertical?: boolean;\n /** Adjust spacing between elements */\n spacing?: Spacing;\n /** Adjust vertical alignment of elements */\n alignment?: Alignment;\n /** Adjust horizontal alignment of elements */\n distribution?: Distribution;\n}" } }, "LinkProps": { @@ -14776,6 +14908,96 @@ "value": "export interface LinkProps {\n /** ID for the link */\n id?: string;\n /** The url to link to */\n url?: string;\n /** The content to display inside the link */\n children?: React.ReactNode;\n /** Makes the link open in a new tab */\n external?: boolean;\n /** Makes the link color the same as the current text color and adds an underline */\n monochrome?: boolean;\n /** Removes text decoration underline to the link*/\n removeUnderline?: boolean;\n /** Callback when a link is clicked */\n onClick?(): void;\n /** Descriptive text to be read to screenreaders */\n accessibilityLabel?: string;\n /** Indicates whether or not the link is the primary navigation link when rendered inside of an `IndexTable.Row` */\n dataPrimaryLink?: boolean;\n}" } }, + "Type": { + "polaris-react/src/components/List/List.tsx": { + "filePath": "polaris-react/src/components/List/List.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Type", + "value": "'bullet' | 'number'", + "description": "" + }, + "polaris-react/src/components/TextField/TextField.tsx": { + "filePath": "polaris-react/src/components/TextField/TextField.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Type", + "value": "'text' | 'email' | 'number' | 'password' | 'search' | 'tel' | 'url' | 'date' | 'datetime-local' | 'month' | 'time' | 'week' | 'currency'", + "description": "" + } + }, + "ListProps": { + "polaris-react/src/components/List/List.tsx": { + "filePath": "polaris-react/src/components/List/List.tsx", + "name": "ListProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/List/List.tsx", + "syntaxKind": "PropertySignature", + "name": "spacing", + "value": "Spacing", + "description": "Determines the space between list items", + "isOptional": true, + "defaultValue": "'loose'" + }, + { + "filePath": "polaris-react/src/components/List/List.tsx", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "Type", + "description": "Type of list to display", + "isOptional": true, + "defaultValue": "'bullet'" + }, + { + "filePath": "polaris-react/src/components/List/List.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "List item elements", + "isOptional": true + } + ], + "value": "export interface ListProps {\n /**\n * Determines the space between list items\n * @default 'loose'\n */\n spacing?: Spacing;\n /**\n * Type of list to display\n * @default 'bullet'\n */\n type?: Type;\n /** List item elements */\n children?: React.ReactNode;\n}" + }, + "polaris-react/src/components/Tabs/components/List/List.tsx": { + "filePath": "polaris-react/src/components/Tabs/components/List/List.tsx", + "name": "ListProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Tabs/components/List/List.tsx", + "syntaxKind": "PropertySignature", + "name": "focusIndex", + "value": "number", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Tabs/components/List/List.tsx", + "syntaxKind": "PropertySignature", + "name": "disclosureTabs", + "value": "TabDescriptor[]", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Tabs/components/List/List.tsx", + "syntaxKind": "MethodSignature", + "name": "onClick", + "value": "(id: string) => void", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Tabs/components/List/List.tsx", + "syntaxKind": "MethodSignature", + "name": "onKeyPress", + "value": "(event: React.KeyboardEvent) => void", + "description": "", + "isOptional": true + } + ], + "value": "export interface ListProps {\n focusIndex: number;\n disclosureTabs: TabDescriptor[];\n onClick?(id: string): void;\n onKeyPress?(event: React.KeyboardEvent): void;\n}" + } + }, "AutoSelection": { "polaris-react/src/components/Listbox/Listbox.tsx": { "filePath": "polaris-react/src/components/Listbox/Listbox.tsx", @@ -14876,94 +15098,36 @@ "description": "" } }, - "Type": { - "polaris-react/src/components/List/List.tsx": { - "filePath": "polaris-react/src/components/List/List.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Type", - "value": "'bullet' | 'number'", - "description": "" + "LoadingProps": { + "polaris-react/src/components/Loading/Loading.tsx": { + "filePath": "polaris-react/src/components/Loading/Loading.tsx", + "name": "LoadingProps", + "description": "", + "members": [], + "value": "export interface LoadingProps {}" }, - "polaris-react/src/components/TextField/TextField.tsx": { - "filePath": "polaris-react/src/components/TextField/TextField.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Type", - "value": "'text' | 'email' | 'number' | 'password' | 'search' | 'tel' | 'url' | 'date' | 'datetime-local' | 'month' | 'time' | 'week' | 'currency'", - "description": "" - } - }, - "ListProps": { - "polaris-react/src/components/List/List.tsx": { - "filePath": "polaris-react/src/components/List/List.tsx", - "name": "ListProps", + "polaris-react/src/components/Listbox/components/Loading/Loading.tsx": { + "filePath": "polaris-react/src/components/Listbox/components/Loading/Loading.tsx", + "name": "LoadingProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/List/List.tsx", - "syntaxKind": "PropertySignature", - "name": "spacing", - "value": "Spacing", - "description": "Determines the space between list items", - "isOptional": true, - "defaultValue": "'loose'" - }, - { - "filePath": "polaris-react/src/components/List/List.tsx", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "Type", - "description": "Type of list to display", - "isOptional": true, - "defaultValue": "'bullet'" - }, - { - "filePath": "polaris-react/src/components/List/List.tsx", + "filePath": "polaris-react/src/components/Listbox/components/Loading/Loading.tsx", "syntaxKind": "PropertySignature", "name": "children", "value": "React.ReactNode", - "description": "List item elements", + "description": "", "isOptional": true - } - ], - "value": "export interface ListProps {\n /**\n * Determines the space between list items\n * @default 'loose'\n */\n spacing?: Spacing;\n /**\n * Type of list to display\n * @default 'bullet'\n */\n type?: Type;\n /** List item elements */\n children?: React.ReactNode;\n}" - }, - "polaris-react/src/components/Tabs/components/List/List.tsx": { - "filePath": "polaris-react/src/components/Tabs/components/List/List.tsx", - "name": "ListProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Tabs/components/List/List.tsx", - "syntaxKind": "PropertySignature", - "name": "focusIndex", - "value": "number", - "description": "" }, { - "filePath": "polaris-react/src/components/Tabs/components/List/List.tsx", + "filePath": "polaris-react/src/components/Listbox/components/Loading/Loading.tsx", "syntaxKind": "PropertySignature", - "name": "disclosureTabs", - "value": "TabDescriptor[]", + "name": "accessibilityLabel", + "value": "string", "description": "" - }, - { - "filePath": "polaris-react/src/components/Tabs/components/List/List.tsx", - "syntaxKind": "MethodSignature", - "name": "onClick", - "value": "(id: string) => void", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Tabs/components/List/List.tsx", - "syntaxKind": "MethodSignature", - "name": "onKeyPress", - "value": "(event: React.KeyboardEvent) => void", - "description": "", - "isOptional": true } ], - "value": "export interface ListProps {\n focusIndex: number;\n disclosureTabs: TabDescriptor[];\n onClick?(id: string): void;\n onKeyPress?(event: React.KeyboardEvent): void;\n}" + "value": "export interface LoadingProps {\n children?: React.ReactNode;\n accessibilityLabel: string;\n}" } }, "MediaCardProps": { @@ -15039,38 +15203,6 @@ "value": "interface MediaCardProps {\n /** The visual media to display in the card */\n children: React.ReactNode;\n /** Heading content */\n title: React.ReactNode;\n /** Body content */\n description: string;\n /** Main call to action, rendered as a basic button */\n primaryAction?: ComplexAction;\n /** Secondary call to action, rendered as a plain button */\n secondaryAction?: ComplexAction;\n /** Action list items to render in ellipsis popover */\n popoverActions?: ActionListItemDescriptor[];\n /** Whether or not card content should be laid out vertically\n * @default false\n */\n portrait?: boolean;\n /** Size of the visual media in the card\n * @default 'medium'\n */\n size?: Size;\n}" } }, - "LoadingProps": { - "polaris-react/src/components/Loading/Loading.tsx": { - "filePath": "polaris-react/src/components/Loading/Loading.tsx", - "name": "LoadingProps", - "description": "", - "members": [], - "value": "export interface LoadingProps {}" - }, - "polaris-react/src/components/Listbox/components/Loading/Loading.tsx": { - "filePath": "polaris-react/src/components/Listbox/components/Loading/Loading.tsx", - "name": "LoadingProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Listbox/components/Loading/Loading.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Listbox/components/Loading/Loading.tsx", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "" - } - ], - "value": "export interface LoadingProps {\n children?: React.ReactNode;\n accessibilityLabel: string;\n}" - } - }, "MessageIndicatorProps": { "polaris-react/src/components/MessageIndicator/MessageIndicator.tsx": { "filePath": "polaris-react/src/components/MessageIndicator/MessageIndicator.tsx", @@ -15433,6 +15565,94 @@ "value": "interface NavigationContextType {\n location: string;\n onNavigationDismiss?(): void;\n withinContentContainer?: boolean;\n}" } }, + "OptionListProps": { + "polaris-react/src/components/OptionList/OptionList.tsx": { + "filePath": "polaris-react/src/components/OptionList/OptionList.tsx", + "name": "OptionListProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/OptionList/OptionList.tsx", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the option list", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/OptionList/OptionList.tsx", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "List title", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/OptionList/OptionList.tsx", + "syntaxKind": "PropertySignature", + "name": "options", + "value": "OptionDescriptor[]", + "description": "Collection of options to be listed", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/OptionList/OptionList.tsx", + "syntaxKind": "PropertySignature", + "name": "role", + "value": "string", + "description": "Defines a specific role attribute for the list itself", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/OptionList/OptionList.tsx", + "syntaxKind": "PropertySignature", + "name": "optionRole", + "value": "string", + "description": "Defines a specific role attribute for each option in the list", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/OptionList/OptionList.tsx", + "syntaxKind": "PropertySignature", + "name": "sections", + "value": "SectionDescriptor[]", + "description": "Sections containing a header and related options", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/OptionList/OptionList.tsx", + "syntaxKind": "PropertySignature", + "name": "selected", + "value": "string[]", + "description": "The selected options" + }, + { + "filePath": "polaris-react/src/components/OptionList/OptionList.tsx", + "syntaxKind": "PropertySignature", + "name": "allowMultiple", + "value": "boolean", + "description": "Allow more than one option to be selected", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/OptionList/OptionList.tsx", + "syntaxKind": "PropertySignature", + "name": "verticalAlign", + "value": "Alignment", + "description": "Vertically align child content to the center, top, or bottom.", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/OptionList/OptionList.tsx", + "syntaxKind": "MethodSignature", + "name": "onChange", + "value": "(selected: string[]) => void", + "description": "Callback when selection is changed" + } + ], + "value": "export interface OptionListProps {\n /** A unique identifier for the option list */\n id?: string;\n /** List title */\n title?: string;\n /** Collection of options to be listed */\n options?: OptionDescriptor[];\n /** Defines a specific role attribute for the list itself */\n role?: 'listbox' | 'combobox' | string;\n /** Defines a specific role attribute for each option in the list */\n optionRole?: string;\n /** Sections containing a header and related options */\n sections?: SectionDescriptor[];\n /** The selected options */\n selected: string[];\n /** Allow more than one option to be selected */\n allowMultiple?: boolean;\n /** Vertically align child content to the center, top, or bottom. */\n verticalAlign?: Alignment;\n /** Callback when selection is changed */\n onChange(selected: string[]): void;\n}" + } + }, "PageProps": { "polaris-react/src/components/Page/Page.tsx": { "filePath": "polaris-react/src/components/Page/Page.tsx", @@ -15580,136 +15800,46 @@ "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}" } }, - "Alignment": { - "polaris-react/src/components/OptionList/OptionList.tsx": { - "filePath": "polaris-react/src/components/OptionList/OptionList.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Alignment", - "value": "'top' | 'center' | 'bottom'", - "description": "" - }, - "polaris-react/src/components/ResourceItem/ResourceItem.tsx": { - "filePath": "polaris-react/src/components/ResourceItem/ResourceItem.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Alignment", - "value": "'leading' | 'trailing' | 'center' | 'fill' | 'baseline'", - "description": "" - }, - "polaris-react/src/components/Stack/Stack.tsx": { - "filePath": "polaris-react/src/components/Stack/Stack.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Alignment", - "value": "'leading' | 'trailing' | 'center' | 'fill' | 'baseline'", - "description": "" - }, - "polaris-react/src/components/Text/Text.tsx": { - "filePath": "polaris-react/src/components/Text/Text.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Alignment", - "value": "'start' | 'center' | 'end' | 'justify'", - "description": "" - }, - "polaris-react/src/components/TextField/TextField.tsx": { - "filePath": "polaris-react/src/components/TextField/TextField.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Alignment", - "value": "'left' | 'center' | 'right'", - "description": "" - }, - "polaris-react/src/components/OptionList/components/Option/Option.tsx": { - "filePath": "polaris-react/src/components/OptionList/components/Option/Option.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Alignment", - "value": "'top' | 'center' | 'bottom'", - "description": "" - } - }, - "OptionListProps": { - "polaris-react/src/components/OptionList/OptionList.tsx": { - "filePath": "polaris-react/src/components/OptionList/OptionList.tsx", - "name": "OptionListProps", + "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/OptionList/OptionList.tsx", + "filePath": "polaris-react/src/components/PageActions/PageActions.tsx", "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the option list", + "name": "primaryAction", + "value": "any", + "description": "The primary action for the page", "isOptional": true }, { - "filePath": "polaris-react/src/components/OptionList/OptionList.tsx", + "filePath": "polaris-react/src/components/PageActions/PageActions.tsx", "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "List title", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/OptionList/OptionList.tsx", - "syntaxKind": "PropertySignature", - "name": "options", - "value": "OptionDescriptor[]", - "description": "Collection of options to be listed", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/OptionList/OptionList.tsx", - "syntaxKind": "PropertySignature", - "name": "role", - "value": "string", - "description": "Defines a specific role attribute for the list itself", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/OptionList/OptionList.tsx", - "syntaxKind": "PropertySignature", - "name": "optionRole", - "value": "string", - "description": "Defines a specific role attribute for each option in the list", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/OptionList/OptionList.tsx", - "syntaxKind": "PropertySignature", - "name": "sections", - "value": "SectionDescriptor[]", - "description": "Sections containing a header and related options", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/OptionList/OptionList.tsx", - "syntaxKind": "PropertySignature", - "name": "selected", - "value": "string[]", - "description": "The selected options" - }, - { - "filePath": "polaris-react/src/components/OptionList/OptionList.tsx", - "syntaxKind": "PropertySignature", - "name": "allowMultiple", - "value": "boolean", - "description": "Allow more than one option to be selected", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/OptionList/OptionList.tsx", - "syntaxKind": "PropertySignature", - "name": "verticalAlign", - "value": "Alignment", - "description": "Vertically align child content to the center, top, or bottom.", + "name": "secondaryActions", + "value": "any", + "description": "The secondary actions for the page", "isOptional": true - }, - { - "filePath": "polaris-react/src/components/OptionList/OptionList.tsx", - "syntaxKind": "MethodSignature", - "name": "onChange", - "value": "(selected: string[]) => void", - "description": "Callback when selection is changed" } ], - "value": "export interface OptionListProps {\n /** A unique identifier for the option list */\n id?: string;\n /** List title */\n title?: string;\n /** Collection of options to be listed */\n options?: OptionDescriptor[];\n /** Defines a specific role attribute for the list itself */\n role?: 'listbox' | 'combobox' | string;\n /** Defines a specific role attribute for each option in the list */\n optionRole?: string;\n /** Sections containing a header and related options */\n sections?: SectionDescriptor[];\n /** The selected options */\n selected: string[];\n /** Allow more than one option to be selected */\n allowMultiple?: boolean;\n /** Vertically align child content to the center, top, or bottom. */\n verticalAlign?: Alignment;\n /** Callback when selection is changed */\n onChange(selected: string[]): void;\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": { @@ -15850,48 +15980,6 @@ "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}" } }, - "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", @@ -17805,6 +17893,25 @@ "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", @@ -17863,25 +17970,6 @@ "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}" } }, - "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}" - } - }, "SkeletonTabsProps": { "polaris-react/src/components/SkeletonTabs/SkeletonTabs.tsx": { "filePath": "polaris-react/src/components/SkeletonTabs/SkeletonTabs.tsx", @@ -17998,15 +18086,6 @@ "value": "export interface SpinnerProps {\n onChange: HandleStepFn;\n onClick?(event: React.MouseEvent): void;\n onMouseDown(onChange: HandleStepFn): void;\n onMouseUp(): void;\n onBlur(event: React.FocusEvent): void;\n}" } }, - "Distribution": { - "polaris-react/src/components/Stack/Stack.tsx": { - "filePath": "polaris-react/src/components/Stack/Stack.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Distribution", - "value": "'equalSpacing' | 'leading' | 'trailing' | 'center' | 'fill' | 'fillEvenly'", - "description": "" - } - }, "StackProps": { "polaris-react/src/components/Stack/Stack.tsx": { "filePath": "polaris-react/src/components/Stack/Stack.tsx", @@ -18074,6 +18153,33 @@ "description": "" } }, + "SubheadingProps": { + "polaris-react/src/components/Subheading/Subheading.tsx": { + "filePath": "polaris-react/src/components/Subheading/Subheading.tsx", + "name": "SubheadingProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Subheading/Subheading.tsx", + "syntaxKind": "PropertySignature", + "name": "element", + "value": "HeadingTagName", + "description": "The element name to use for the subheading", + "isOptional": true, + "defaultValue": "'h3'" + }, + { + "filePath": "polaris-react/src/components/Subheading/Subheading.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "Text to display in subheading", + "isOptional": true + } + ], + "value": "export interface SubheadingProps {\n /**\n * The element name to use for the subheading\n * @default 'h3'\n */\n element?: HeadingTagName;\n /** Text to display in subheading */\n children?: React.ReactNode;\n}" + } + }, "TabsProps": { "polaris-react/src/components/Tabs/Tabs.tsx": { "filePath": "polaris-react/src/components/Tabs/Tabs.tsx", @@ -18130,31 +18236,13 @@ "value": "export interface TabsProps {\n /** Content to display in tabs */\n children?: React.ReactNode;\n /** Index of selected tab */\n selected: number;\n /** List of tabs */\n tabs: TabDescriptor[];\n /** Fit tabs to container */\n fitted?: boolean;\n /** Text to replace disclosures horizontal dots */\n disclosureText?: string;\n /** Callback when tab is selected */\n onSelect?(selectedTabIndex: number): void;\n}" } }, - "SubheadingProps": { - "polaris-react/src/components/Subheading/Subheading.tsx": { - "filePath": "polaris-react/src/components/Subheading/Subheading.tsx", - "name": "SubheadingProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Subheading/Subheading.tsx", - "syntaxKind": "PropertySignature", - "name": "element", - "value": "HeadingTagName", - "description": "The element name to use for the subheading", - "isOptional": true, - "defaultValue": "'h3'" - }, - { - "filePath": "polaris-react/src/components/Subheading/Subheading.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "Text to display in subheading", - "isOptional": true - } - ], - "value": "export interface SubheadingProps {\n /**\n * The element name to use for the subheading\n * @default 'h3'\n */\n element?: HeadingTagName;\n /** Text to display in subheading */\n children?: React.ReactNode;\n}" + "TagProps": { + "polaris-react/src/components/Tag/Tag.tsx": { + "filePath": "polaris-react/src/components/Tag/Tag.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "TagProps", + "value": "NonMutuallyExclusiveProps & (\n | {onClick?(): void; onRemove?: undefined; url?: undefined}\n | {onClick?: undefined; onRemove?(): void; url?: string}\n )", + "description": "" } }, "Variant": { @@ -18288,96 +18376,12 @@ "value": "export interface TextContainerProps {\n /** The amount of vertical spacing children will get between them */\n spacing?: Spacing;\n /** The content to render in the text container. */\n children?: React.ReactNode;\n}" } }, - "TagProps": { - "polaris-react/src/components/Tag/Tag.tsx": { - "filePath": "polaris-react/src/components/Tag/Tag.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "TagProps", - "value": "NonMutuallyExclusiveProps & (\n | {onClick?(): void; onRemove?: undefined; url?: undefined}\n | {onClick?: undefined; onRemove?(): void; url?: string}\n )", - "description": "" - } - }, - "Variation": { - "polaris-react/src/components/TextStyle/TextStyle.tsx": { - "filePath": "polaris-react/src/components/TextStyle/TextStyle.tsx", + "InputMode": { + "polaris-react/src/components/TextField/TextField.tsx": { + "filePath": "polaris-react/src/components/TextField/TextField.tsx", "syntaxKind": "TypeAliasDeclaration", - "name": "Variation", - "value": "'positive' | 'negative' | 'warning' | 'strong' | 'subdued' | 'code'", - "description": "" - } - }, - "VariationValue": { - "polaris-react/src/components/TextStyle/TextStyle.tsx": { - "filePath": "polaris-react/src/components/TextStyle/TextStyle.tsx", - "syntaxKind": "EnumDeclaration", - "name": "VariationValue", - "value": "enum VariationValue {\n Positive = 'positive',\n Negative = 'negative',\n Warning = 'warning',\n Strong = 'strong',\n Subdued = 'subdued',\n Code = 'code',\n}", - "members": [ - { - "filePath": "polaris-react/src/components/TextStyle/TextStyle.tsx", - "name": "Positive", - "value": "positive" - }, - { - "filePath": "polaris-react/src/components/TextStyle/TextStyle.tsx", - "name": "Negative", - "value": "negative" - }, - { - "filePath": "polaris-react/src/components/TextStyle/TextStyle.tsx", - "name": "Warning", - "value": "warning" - }, - { - "filePath": "polaris-react/src/components/TextStyle/TextStyle.tsx", - "name": "Strong", - "value": "strong" - }, - { - "filePath": "polaris-react/src/components/TextStyle/TextStyle.tsx", - "name": "Subdued", - "value": "subdued" - }, - { - "filePath": "polaris-react/src/components/TextStyle/TextStyle.tsx", - "name": "Code", - "value": "code" - } - ] - } - }, - "TextStyleProps": { - "polaris-react/src/components/TextStyle/TextStyle.tsx": { - "filePath": "polaris-react/src/components/TextStyle/TextStyle.tsx", - "name": "TextStyleProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/TextStyle/TextStyle.tsx", - "syntaxKind": "PropertySignature", - "name": "variation", - "value": "Variation", - "description": "Give text additional visual meaning", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/TextStyle/TextStyle.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "The content that should get the intended styling", - "isOptional": true - } - ], - "value": "export interface TextStyleProps {\n /** Give text additional visual meaning */\n variation?: Variation;\n /** The content that should get the intended styling */\n children?: React.ReactNode;\n}" - } - }, - "InputMode": { - "polaris-react/src/components/TextField/TextField.tsx": { - "filePath": "polaris-react/src/components/TextField/TextField.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "InputMode", - "value": "'none' | 'text' | 'decimal' | 'numeric' | 'tel' | 'search' | 'email' | 'url'", + "name": "InputMode", + "value": "'none' | 'text' | 'decimal' | 'numeric' | 'tel' | 'search' | 'email' | 'url'", "description": "" } }, @@ -18497,6 +18501,81 @@ "description": "" } }, + "Variation": { + "polaris-react/src/components/TextStyle/TextStyle.tsx": { + "filePath": "polaris-react/src/components/TextStyle/TextStyle.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Variation", + "value": "'positive' | 'negative' | 'warning' | 'strong' | 'subdued' | 'code'", + "description": "" + } + }, + "VariationValue": { + "polaris-react/src/components/TextStyle/TextStyle.tsx": { + "filePath": "polaris-react/src/components/TextStyle/TextStyle.tsx", + "syntaxKind": "EnumDeclaration", + "name": "VariationValue", + "value": "enum VariationValue {\n Positive = 'positive',\n Negative = 'negative',\n Warning = 'warning',\n Strong = 'strong',\n Subdued = 'subdued',\n Code = 'code',\n}", + "members": [ + { + "filePath": "polaris-react/src/components/TextStyle/TextStyle.tsx", + "name": "Positive", + "value": "positive" + }, + { + "filePath": "polaris-react/src/components/TextStyle/TextStyle.tsx", + "name": "Negative", + "value": "negative" + }, + { + "filePath": "polaris-react/src/components/TextStyle/TextStyle.tsx", + "name": "Warning", + "value": "warning" + }, + { + "filePath": "polaris-react/src/components/TextStyle/TextStyle.tsx", + "name": "Strong", + "value": "strong" + }, + { + "filePath": "polaris-react/src/components/TextStyle/TextStyle.tsx", + "name": "Subdued", + "value": "subdued" + }, + { + "filePath": "polaris-react/src/components/TextStyle/TextStyle.tsx", + "name": "Code", + "value": "code" + } + ] + } + }, + "TextStyleProps": { + "polaris-react/src/components/TextStyle/TextStyle.tsx": { + "filePath": "polaris-react/src/components/TextStyle/TextStyle.tsx", + "name": "TextStyleProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/TextStyle/TextStyle.tsx", + "syntaxKind": "PropertySignature", + "name": "variation", + "value": "Variation", + "description": "Give text additional visual meaning", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/TextStyle/TextStyle.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "The content that should get the intended styling", + "isOptional": true + } + ], + "value": "export interface TextStyleProps {\n /** Give text additional visual meaning */\n variation?: Variation;\n /** The content that should get the intended styling */\n children?: React.ReactNode;\n}" + } + }, "ThumbnailProps": { "polaris-react/src/components/Thumbnail/Thumbnail.tsx": { "filePath": "polaris-react/src/components/Thumbnail/Thumbnail.tsx", @@ -18789,23 +18868,6 @@ "value": "export interface TopBarProps {\n /** Toggles whether or not a navigation component has been provided. Controls the presence of the mobile nav toggle button */\n showNavigationToggle?: boolean;\n /** Accepts a user component that is made available as a static member of the top bar component and renders as the primary menu */\n userMenu?: React.ReactNode;\n /** Accepts a menu component that is made available as a static member of the top bar component */\n secondaryMenu?: React.ReactNode;\n /** Accepts a component that is used to help users switch between different contexts */\n contextControl?: React.ReactNode;\n /** Accepts a search field component that is made available as a `TextField` static member of the top bar component */\n searchField?: React.ReactNode;\n /** Accepts a search results component that is ideally composed of a card component containing a list of actionable search results */\n searchResults?: React.ReactNode;\n /** A boolean property indicating whether search results are currently visible. */\n searchResultsVisible?: boolean;\n /** Whether or not the search results overlay has a visible backdrop */\n searchResultsOverlayVisible?: boolean;\n /** A callback function that handles the dismissal of search results */\n onSearchResultsDismiss?: SearchProps['onDismiss'];\n /** A callback function that handles hiding and showing mobile navigation */\n onNavigationToggle?(): void;\n /** Accepts a component that is used to supplement the logo markup */\n logoSuffix?: React.ReactNode;\n}" } }, - "TruncateProps": { - "polaris-react/src/components/Truncate/Truncate.tsx": { - "filePath": "polaris-react/src/components/Truncate/Truncate.tsx", - "name": "TruncateProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Truncate/Truncate.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "" - } - ], - "value": "export interface TruncateProps {\n children: React.ReactNode;\n}" - } - }, "TrapFocusProps": { "polaris-react/src/components/TrapFocus/TrapFocus.tsx": { "filePath": "polaris-react/src/components/TrapFocus/TrapFocus.tsx", @@ -18832,6 +18894,23 @@ "value": "export interface TrapFocusProps {\n trapping?: boolean;\n children?: React.ReactNode;\n}" } }, + "TruncateProps": { + "polaris-react/src/components/Truncate/Truncate.tsx": { + "filePath": "polaris-react/src/components/Truncate/Truncate.tsx", + "name": "TruncateProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Truncate/Truncate.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "" + } + ], + "value": "export interface TruncateProps {\n children: React.ReactNode;\n}" + } + }, "UnstyledButtonProps": { "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx": { "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", @@ -19047,74 +19126,6 @@ "value": "export interface UnstyledButtonProps extends BaseButton {\n /** The content to display inside the button */\n children?: React.ReactNode;\n /** A custom class name to apply styles to button */\n className?: string;\n [key: string]: any;\n}" } }, - "VideoThumbnailProps": { - "polaris-react/src/components/VideoThumbnail/VideoThumbnail.tsx": { - "filePath": "polaris-react/src/components/VideoThumbnail/VideoThumbnail.tsx", - "name": "VideoThumbnailProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/VideoThumbnail/VideoThumbnail.tsx", - "syntaxKind": "PropertySignature", - "name": "thumbnailUrl", - "value": "string", - "description": "URL source for thumbnail image." - }, - { - "filePath": "polaris-react/src/components/VideoThumbnail/VideoThumbnail.tsx", - "syntaxKind": "PropertySignature", - "name": "videoLength", - "value": "number", - "description": "Length of video in seconds.", - "isOptional": true, - "defaultValue": "0" - }, - { - "filePath": "polaris-react/src/components/VideoThumbnail/VideoThumbnail.tsx", - "syntaxKind": "PropertySignature", - "name": "videoProgress", - "value": "number", - "description": "Video progress in seconds. Displays a progress bar at the bottom of the thumbnail. Only renders when videoLength is also set.", - "isOptional": true, - "defaultValue": "0" - }, - { - "filePath": "polaris-react/src/components/VideoThumbnail/VideoThumbnail.tsx", - "syntaxKind": "PropertySignature", - "name": "showVideoProgress", - "value": "boolean", - "description": "Indicate whether to allow video progress to be displayed", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "polaris-react/src/components/VideoThumbnail/VideoThumbnail.tsx", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "Custom ARIA label for play button.", - "isOptional": true, - "defaultValue": "'Play video of length {human readable duration}'" - }, - { - "filePath": "polaris-react/src/components/VideoThumbnail/VideoThumbnail.tsx", - "syntaxKind": "MethodSignature", - "name": "onClick", - "value": "() => void", - "description": "Callback on click or keypress of thumbnail. Use to trigger render of the video player in your chosen format, for example within a modal or fullscreen container." - }, - { - "filePath": "polaris-react/src/components/VideoThumbnail/VideoThumbnail.tsx", - "syntaxKind": "MethodSignature", - "name": "onBeforeStartPlaying", - "value": "() => void", - "description": "Callback on mouse enter, focus, or touch start of thumbnail. Use to trigger video preload.", - "isOptional": true - } - ], - "value": "export interface VideoThumbnailProps {\n /** URL source for thumbnail image. */\n thumbnailUrl: string;\n /**\n * Length of video in seconds.\n * @default 0\n */\n videoLength?: number;\n /**\n * Video progress in seconds. Displays a progress bar at the bottom of the thumbnail. Only renders when videoLength is also set.\n * @default 0\n */\n videoProgress?: number;\n /**\n * Indicate whether to allow video progress to be displayed\n * @default false\n */\n showVideoProgress?: boolean;\n /** Custom ARIA label for play button.\n * @default 'Play video of length {human readable duration}'\n */\n accessibilityLabel?: string;\n /** Callback on click or keypress of thumbnail. Use to trigger render of the video player in your chosen format, for example within a modal or fullscreen container. */\n onClick(): void;\n /** Callback on mouse enter, focus, or touch start of thumbnail. Use to trigger video preload. */\n onBeforeStartPlaying?(): void;\n}" - } - }, "UnstyledLinkProps": { "polaris-react/src/components/UnstyledLink/UnstyledLink.tsx": { "filePath": "polaris-react/src/components/UnstyledLink/UnstyledLink.tsx", @@ -22032,14 +22043,82 @@ "value": "export interface UnstyledLinkProps extends LinkLikeComponentProps {}" } }, - "VisuallyHiddenProps": { - "polaris-react/src/components/VisuallyHidden/VisuallyHidden.tsx": { - "filePath": "polaris-react/src/components/VisuallyHidden/VisuallyHidden.tsx", - "name": "VisuallyHiddenProps", + "VideoThumbnailProps": { + "polaris-react/src/components/VideoThumbnail/VideoThumbnail.tsx": { + "filePath": "polaris-react/src/components/VideoThumbnail/VideoThumbnail.tsx", + "name": "VideoThumbnailProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/VisuallyHidden/VisuallyHidden.tsx", + "filePath": "polaris-react/src/components/VideoThumbnail/VideoThumbnail.tsx", + "syntaxKind": "PropertySignature", + "name": "thumbnailUrl", + "value": "string", + "description": "URL source for thumbnail image." + }, + { + "filePath": "polaris-react/src/components/VideoThumbnail/VideoThumbnail.tsx", + "syntaxKind": "PropertySignature", + "name": "videoLength", + "value": "number", + "description": "Length of video in seconds.", + "isOptional": true, + "defaultValue": "0" + }, + { + "filePath": "polaris-react/src/components/VideoThumbnail/VideoThumbnail.tsx", + "syntaxKind": "PropertySignature", + "name": "videoProgress", + "value": "number", + "description": "Video progress in seconds. Displays a progress bar at the bottom of the thumbnail. Only renders when videoLength is also set.", + "isOptional": true, + "defaultValue": "0" + }, + { + "filePath": "polaris-react/src/components/VideoThumbnail/VideoThumbnail.tsx", + "syntaxKind": "PropertySignature", + "name": "showVideoProgress", + "value": "boolean", + "description": "Indicate whether to allow video progress to be displayed", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "polaris-react/src/components/VideoThumbnail/VideoThumbnail.tsx", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "Custom ARIA label for play button.", + "isOptional": true, + "defaultValue": "'Play video of length {human readable duration}'" + }, + { + "filePath": "polaris-react/src/components/VideoThumbnail/VideoThumbnail.tsx", + "syntaxKind": "MethodSignature", + "name": "onClick", + "value": "() => void", + "description": "Callback on click or keypress of thumbnail. Use to trigger render of the video player in your chosen format, for example within a modal or fullscreen container." + }, + { + "filePath": "polaris-react/src/components/VideoThumbnail/VideoThumbnail.tsx", + "syntaxKind": "MethodSignature", + "name": "onBeforeStartPlaying", + "value": "() => void", + "description": "Callback on mouse enter, focus, or touch start of thumbnail. Use to trigger video preload.", + "isOptional": true + } + ], + "value": "export interface VideoThumbnailProps {\n /** URL source for thumbnail image. */\n thumbnailUrl: string;\n /**\n * Length of video in seconds.\n * @default 0\n */\n videoLength?: number;\n /**\n * Video progress in seconds. Displays a progress bar at the bottom of the thumbnail. Only renders when videoLength is also set.\n * @default 0\n */\n videoProgress?: number;\n /**\n * Indicate whether to allow video progress to be displayed\n * @default false\n */\n showVideoProgress?: boolean;\n /** Custom ARIA label for play button.\n * @default 'Play video of length {human readable duration}'\n */\n accessibilityLabel?: string;\n /** Callback on click or keypress of thumbnail. Use to trigger render of the video player in your chosen format, for example within a modal or fullscreen container. */\n onClick(): void;\n /** Callback on mouse enter, focus, or touch start of thumbnail. Use to trigger video preload. */\n onBeforeStartPlaying?(): void;\n}" + } + }, + "VisuallyHiddenProps": { + "polaris-react/src/components/VisuallyHidden/VisuallyHidden.tsx": { + "filePath": "polaris-react/src/components/VisuallyHidden/VisuallyHidden.tsx", + "name": "VisuallyHiddenProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/VisuallyHidden/VisuallyHidden.tsx", "syntaxKind": "PropertySignature", "name": "children", "value": "React.ReactNode", @@ -22264,6 +22343,156 @@ "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}" + } + }, + "MeasuredActions": { + "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx": { + "filePath": "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx", + "name": "MeasuredActions", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx", + "syntaxKind": "PropertySignature", + "name": "showable", + "value": "MenuActionDescriptor[]", + "description": "" + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx", + "syntaxKind": "PropertySignature", + "name": "rolledUp", + "value": "(MenuActionDescriptor | MenuGroupDescriptor)[]", + "description": "" + } + ], + "value": "interface MeasuredActions {\n showable: MenuActionDescriptor[];\n rolledUp: (MenuActionDescriptor | MenuGroupDescriptor)[];\n}" + } + }, "ItemProps": { "polaris-react/src/components/ActionList/components/Item/Item.tsx": { "filePath": "polaris-react/src/components/ActionList/components/Item/Item.tsx", @@ -22629,456 +22858,26 @@ "value": "interface ItemProps {\n children?: React.ReactNode;\n}" } }, - "SectionProps": { - "polaris-react/src/components/ActionList/components/Section/Section.tsx": { - "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", - "name": "SectionProps", + "SecondaryAction": { + "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx": { + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "name": "SecondaryAction", "description": "", "members": [ { - "filePath": "polaris-react/src/components/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", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "actionRole", - "value": "string", - "description": "Defines a specific role attribute for each action in the list", + "name": "helpText", + "value": "React.ReactNode", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "onActionAnyItem", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onAction", "value": "() => void", - "description": "Callback when any item is clicked or keypressed", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "isFirst", - "value": "boolean", - "description": "Whether it is the first in a group of sections", - "isOptional": true - } - ], - "value": "export interface SectionProps {\n /** Section of action items */\n section: ActionListSection;\n /** Should there be multiple sections */\n hasMultipleSections: boolean;\n /** Defines a specific role attribute for each action in the list */\n actionRole?: 'option' | 'menuitem' | string;\n /** Callback when any item is clicked or keypressed */\n onActionAnyItem?: ActionListItemDescriptor['onAction'];\n /** Whether it is the first in a group of sections */\n isFirst?: boolean;\n}" - }, - "polaris-react/src/components/Layout/components/Section/Section.tsx": { - "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", - "name": "SectionProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "secondary", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "fullWidth", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "oneHalf", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "oneThird", - "value": "boolean", - "description": "", - "isOptional": true - } - ], - "value": "export interface SectionProps {\n children?: React.ReactNode;\n secondary?: boolean;\n fullWidth?: boolean;\n oneHalf?: boolean;\n oneThird?: boolean;\n}" - }, - "polaris-react/src/components/Listbox/components/Section/Section.tsx": { - "filePath": "polaris-react/src/components/Listbox/components/Section/Section.tsx", - "name": "SectionProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Listbox/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "divider", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Listbox/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "ReactNode", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Listbox/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "ReactNode", - "description": "" - } - ], - "value": "interface SectionProps {\n divider?: boolean;\n children?: ReactNode;\n title: ReactNode;\n}" - }, - "polaris-react/src/components/Modal/components/Section/Section.tsx": { - "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", - "name": "SectionProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "flush", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "subdued", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "titleHidden", - "value": "boolean", - "description": "", - "isOptional": true - } - ], - "value": "export interface SectionProps {\n children?: React.ReactNode;\n flush?: boolean;\n subdued?: boolean;\n titleHidden?: boolean;\n}" - }, - "polaris-react/src/components/Navigation/components/Section/Section.tsx": { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", - "name": "SectionProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "items", - "value": "ItemProps[]", - "description": "" - }, - { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "icon", - "value": "any", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "fill", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "rollup", - "value": "{ after: number; view: string; hide: string; activePath: string; }", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "action", - "value": "{ icon: any; accessibilityLabel: string; onClick(): void; tooltip?: TooltipProps; }", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "separator", - "value": "boolean", - "description": "", - "isOptional": true - } - ], - "value": "export interface SectionProps {\n items: ItemProps[];\n icon?: IconProps['source'];\n title?: string;\n fill?: boolean;\n rollup?: {\n after: number;\n view: string;\n hide: string;\n activePath: string;\n };\n action?: {\n icon: IconProps['source'];\n accessibilityLabel: string;\n onClick(): void;\n tooltip?: TooltipProps;\n };\n separator?: boolean;\n}" - }, - "polaris-react/src/components/Popover/components/Section/Section.tsx": { - "filePath": "polaris-react/src/components/Popover/components/Section/Section.tsx", - "name": "SectionProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Popover/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", - "isOptional": true - } - ], - "value": "export interface SectionProps {\n children?: React.ReactNode;\n}" - } - }, - "MeasuredActions": { - "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx": { - "filePath": "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx", - "name": "MeasuredActions", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx", - "syntaxKind": "PropertySignature", - "name": "showable", - "value": "MenuActionDescriptor[]", - "description": "" - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx", - "syntaxKind": "PropertySignature", - "name": "rolledUp", - "value": "(MenuActionDescriptor | MenuGroupDescriptor)[]", - "description": "" - } - ], - "value": "interface MeasuredActions {\n showable: MenuActionDescriptor[];\n rolledUp: (MenuActionDescriptor | MenuGroupDescriptor)[];\n}" - } - }, - "MenuGroupProps": { - "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx": { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "name": "MenuGroupProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "Visually hidden menu description for screen readers", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "PropertySignature", - "name": "active", - "value": "boolean", - "description": "Whether or not the menu is open", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "MethodSignature", - "name": "onClick", - "value": "(openActions: () => void) => void", - "description": "Callback when the menu is clicked", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "MethodSignature", - "name": "onOpen", - "value": "(title: string) => void", - "description": "Callback for opening the MenuGroup by title" - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "MethodSignature", - "name": "onClose", - "value": "(title: string) => void", - "description": "Callback for closing the MenuGroup by title" - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "MethodSignature", - "name": "getOffsetWidth", - "value": "(width: number) => void", - "description": "Callback for getting the offsetWidth of the MenuGroup", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "PropertySignature", - "name": "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 - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", - "syntaxKind": "PropertySignature", - "name": "sections", - "value": "ActionListSection[]", - "description": "Collection of sectioned action items", - "isOptional": true - } - ], - "value": "export interface RollupActionsProps {\n /** Accessibilty label */\n accessibilityLabel?: string;\n /** Collection of actions for the list */\n items?: ActionListItemDescriptor[];\n /** Collection of sectioned action items */\n sections?: ActionListSection[];\n}" - } - }, - "SecondaryAction": { - "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx": { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "name": "SecondaryAction", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "PropertySignature", - "name": "helpText", - "value": "React.ReactNode", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "MethodSignature", - "name": "onAction", - "value": "() => void", - "description": "", + "description": "", "isOptional": true }, { @@ -23323,117 +23122,397 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "MethodSignature", - "name": "onFocus", - "value": "() => void", - "description": "Callback when button becomes focussed", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onFocus", + "value": "() => void", + "description": "Callback when button becomes focussed", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onBlur", + "value": "() => void", + "description": "Callback when focus leaves button", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onKeyPress", + "value": "(event: React.KeyboardEvent) => void", + "description": "Callback when a keypress event is registered on the button", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onKeyUp", + "value": "(event: React.KeyboardEvent) => void", + "description": "Callback when a keyup event is registered on the button", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onKeyDown", + "value": "(event: React.KeyboardEvent) => void", + "description": "Callback when a keydown event is registered on the button", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onMouseEnter", + "value": "() => void", + "description": "Callback when mouse enter", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onTouchStart", + "value": "() => void", + "description": "Callback when element is touched", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onPointerDown", + "value": "() => void", + "description": "Callback when pointerdown event is being triggered", + "isOptional": true + } + ], + "value": "interface SecondaryAction extends ButtonProps {\n helpText?: React.ReactNode;\n onAction?(): void;\n getOffsetWidth?(width: number): void;\n}" + }, + "polaris-react/src/components/Navigation/components/Item/Item.tsx": { + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "name": "SecondaryAction", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "syntaxKind": "PropertySignature", + "name": "icon", + "value": "any", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "syntaxKind": "PropertySignature", + "name": "url", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "syntaxKind": "MethodSignature", + "name": "onClick", + "value": "() => void", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "syntaxKind": "PropertySignature", + "name": "tooltip", + "value": "TooltipProps", + "description": "", + "isOptional": true + } + ], + "value": "interface SecondaryAction {\n accessibilityLabel: string;\n icon: IconProps['source'];\n url?: string;\n onClick?(): void;\n tooltip?: TooltipProps;\n}" + } + }, + "RollupActionsProps": { + "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx": { + "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", + "name": "RollupActionsProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "Accessibilty label", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", + "syntaxKind": "PropertySignature", + "name": "items", + "value": "ActionListItemDescriptor[]", + "description": "Collection of actions for the list", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", + "syntaxKind": "PropertySignature", + "name": "sections", + "value": "ActionListSection[]", + "description": "Collection of sectioned action items", + "isOptional": true + } + ], + "value": "export interface RollupActionsProps {\n /** Accessibilty label */\n accessibilityLabel?: string;\n /** Collection of actions for the list */\n items?: ActionListItemDescriptor[];\n /** Collection of sectioned action items */\n sections?: ActionListSection[];\n}" + } + }, + "SectionProps": { + "polaris-react/src/components/ActionList/components/Section/Section.tsx": { + "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", + "name": "SectionProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "section", + "value": "ActionListSection", + "description": "Section of action items" + }, + { + "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "hasMultipleSections", + "value": "boolean", + "description": "Should there be multiple sections" + }, + { + "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "actionRole", + "value": "string", + "description": "Defines a specific role attribute for each action in the list", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "onActionAnyItem", + "value": "() => void", + "description": "Callback when any item is clicked or keypressed", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "isFirst", + "value": "boolean", + "description": "Whether it is the first in a group of sections", + "isOptional": true + } + ], + "value": "export interface SectionProps {\n /** Section of action items */\n section: ActionListSection;\n /** Should there be multiple sections */\n hasMultipleSections: boolean;\n /** Defines a specific role attribute for each action in the list */\n actionRole?: 'option' | 'menuitem' | string;\n /** Callback when any item is clicked or keypressed */\n onActionAnyItem?: ActionListItemDescriptor['onAction'];\n /** Whether it is the first in a group of sections */\n isFirst?: boolean;\n}" + }, + "polaris-react/src/components/Layout/components/Section/Section.tsx": { + "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", + "name": "SectionProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "secondary", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "fullWidth", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "oneHalf", + "value": "boolean", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "MethodSignature", - "name": "onBlur", - "value": "() => void", - "description": "Callback when focus leaves button", + "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/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "MethodSignature", - "name": "onKeyPress", - "value": "(event: React.KeyboardEvent) => void", - "description": "Callback when a keypress event is registered on the button", + "filePath": "polaris-react/src/components/Listbox/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "divider", + "value": "boolean", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "MethodSignature", - "name": "onKeyUp", - "value": "(event: React.KeyboardEvent) => void", - "description": "Callback when a keyup event is registered on the button", + "filePath": "polaris-react/src/components/Listbox/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "ReactNode", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "MethodSignature", - "name": "onKeyDown", - "value": "(event: React.KeyboardEvent) => void", - "description": "Callback when a keydown event is registered on the button", + "filePath": "polaris-react/src/components/Listbox/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "ReactNode", + "description": "" + } + ], + "value": "interface SectionProps {\n divider?: boolean;\n children?: ReactNode;\n title: ReactNode;\n}" + }, + "polaris-react/src/components/Modal/components/Section/Section.tsx": { + "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", + "name": "SectionProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "MethodSignature", - "name": "onMouseEnter", - "value": "() => void", - "description": "Callback when mouse enter", + "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "flush", + "value": "boolean", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "MethodSignature", - "name": "onTouchStart", - "value": "() => void", - "description": "Callback when element is touched", + "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "subdued", + "value": "boolean", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "MethodSignature", - "name": "onPointerDown", - "value": "() => void", - "description": "Callback when pointerdown event is being triggered", + "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "titleHidden", + "value": "boolean", + "description": "", "isOptional": true } ], - "value": "interface SecondaryAction extends ButtonProps {\n helpText?: React.ReactNode;\n onAction?(): void;\n getOffsetWidth?(width: number): void;\n}" + "value": "export interface SectionProps {\n children?: React.ReactNode;\n flush?: boolean;\n subdued?: boolean;\n titleHidden?: boolean;\n}" }, - "polaris-react/src/components/Navigation/components/Item/Item.tsx": { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "name": "SecondaryAction", + "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/Item/Item.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", + "name": "items", + "value": "ItemProps[]", "description": "" }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", "syntaxKind": "PropertySignature", "name": "icon", "value": "any", - "description": "" + "description": "", + "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "url", + "name": "title", "value": "string", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "syntaxKind": "MethodSignature", - "name": "onClick", - "value": "() => void", + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "fill", + "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "tooltip", - "value": "TooltipProps", + "name": "rollup", + "value": "{ after: number; view: string; hide: string; activePath: string; }", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "action", + "value": "{ icon: any; accessibilityLabel: string; onClick(): void; tooltip?: TooltipProps; }", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "separator", + "value": "boolean", "description": "", "isOptional": true } ], - "value": "interface SecondaryAction {\n accessibilityLabel: string;\n icon: IconProps['source'];\n url?: string;\n onClick?(): void;\n tooltip?: TooltipProps;\n}" + "value": "export interface SectionProps {\n items: ItemProps[];\n icon?: IconProps['source'];\n title?: string;\n fill?: boolean;\n rollup?: {\n after: number;\n view: string;\n hide: string;\n activePath: string;\n };\n action?: {\n icon: IconProps['source'];\n accessibilityLabel: string;\n onClick(): void;\n tooltip?: TooltipProps;\n };\n separator?: boolean;\n}" + }, + "polaris-react/src/components/Popover/components/Section/Section.tsx": { + "filePath": "polaris-react/src/components/Popover/components/Section/Section.tsx", + "name": "SectionProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Popover/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "", + "isOptional": true + } + ], + "value": "export interface SectionProps {\n children?: React.ReactNode;\n}" } }, "MappedAction": { @@ -24950,47 +25029,120 @@ "description": "" }, { - "filePath": "polaris-react/src/components/IndexTable/components/Row/Row.tsx", + "filePath": "polaris-react/src/components/IndexTable/components/Row/Row.tsx", + "syntaxKind": "PropertySignature", + "name": "subdued", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/IndexTable/components/Row/Row.tsx", + "syntaxKind": "PropertySignature", + "name": "status", + "value": "RowStatus", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/IndexTable/components/Row/Row.tsx", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/IndexTable/components/Row/Row.tsx", + "syntaxKind": "MethodSignature", + "name": "onNavigation", + "value": "(id: string) => void", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/IndexTable/components/Row/Row.tsx", + "syntaxKind": "MethodSignature", + "name": "onClick", + "value": "() => void", + "description": "", + "isOptional": true + } + ], + "value": "export interface RowProps {\n children: React.ReactNode;\n id: string;\n selected?: boolean;\n position: number;\n subdued?: boolean;\n status?: RowStatus;\n disabled?: boolean;\n onNavigation?(id: string): void;\n onClick?(): void;\n}" + } + }, + "ScrollContainerProps": { + "polaris-react/src/components/IndexTable/components/ScrollContainer/ScrollContainer.tsx": { + "filePath": "polaris-react/src/components/IndexTable/components/ScrollContainer/ScrollContainer.tsx", + "name": "ScrollContainerProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/IndexTable/components/ScrollContainer/ScrollContainer.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "" + }, + { + "filePath": "polaris-react/src/components/IndexTable/components/ScrollContainer/ScrollContainer.tsx", + "syntaxKind": "PropertySignature", + "name": "scrollableContainerRef", + "value": "React.RefObject", + "description": "" + }, + { + "filePath": "polaris-react/src/components/IndexTable/components/ScrollContainer/ScrollContainer.tsx", + "syntaxKind": "MethodSignature", + "name": "onScroll", + "value": "(canScrollLeft: boolean, canScrollRight: boolean) => void", + "description": "" + } + ], + "value": "export interface ScrollContainerProps {\n children: React.ReactNode;\n scrollableContainerRef: React.RefObject;\n onScroll(canScrollLeft: boolean, canScrollRight: boolean): void;\n}" + } + }, + "AnnotatedSectionProps": { + "polaris-react/src/components/Layout/components/AnnotatedSection/AnnotatedSection.tsx": { + "filePath": "polaris-react/src/components/Layout/components/AnnotatedSection/AnnotatedSection.tsx", + "name": "AnnotatedSectionProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Layout/components/AnnotatedSection/AnnotatedSection.tsx", "syntaxKind": "PropertySignature", - "name": "subdued", - "value": "boolean", + "name": "children", + "value": "React.ReactNode", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/IndexTable/components/Row/Row.tsx", + "filePath": "polaris-react/src/components/Layout/components/AnnotatedSection/AnnotatedSection.tsx", "syntaxKind": "PropertySignature", - "name": "status", - "value": "RowStatus", + "name": "title", + "value": "React.ReactNode", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/IndexTable/components/Row/Row.tsx", + "filePath": "polaris-react/src/components/Layout/components/AnnotatedSection/AnnotatedSection.tsx", "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/IndexTable/components/Row/Row.tsx", - "syntaxKind": "MethodSignature", - "name": "onNavigation", - "value": "(id: string) => void", + "name": "description", + "value": "React.ReactNode", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/IndexTable/components/Row/Row.tsx", - "syntaxKind": "MethodSignature", - "name": "onClick", - "value": "() => void", + "filePath": "polaris-react/src/components/Layout/components/AnnotatedSection/AnnotatedSection.tsx", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", "description": "", "isOptional": true } ], - "value": "export interface RowProps {\n children: React.ReactNode;\n id: string;\n selected?: boolean;\n position: number;\n subdued?: boolean;\n status?: RowStatus;\n disabled?: boolean;\n onNavigation?(id: string): void;\n onClick?(): void;\n}" + "value": "export interface AnnotatedSectionProps {\n children?: React.ReactNode;\n title?: React.ReactNode;\n description?: React.ReactNode;\n id?: string;\n}" } }, "LegacyCardHeaderProps": { @@ -25093,37 +25245,6 @@ "value": "export interface LegacyCardSectionProps {\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}" } }, - "ScrollContainerProps": { - "polaris-react/src/components/IndexTable/components/ScrollContainer/ScrollContainer.tsx": { - "filePath": "polaris-react/src/components/IndexTable/components/ScrollContainer/ScrollContainer.tsx", - "name": "ScrollContainerProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/IndexTable/components/ScrollContainer/ScrollContainer.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "" - }, - { - "filePath": "polaris-react/src/components/IndexTable/components/ScrollContainer/ScrollContainer.tsx", - "syntaxKind": "PropertySignature", - "name": "scrollableContainerRef", - "value": "React.RefObject", - "description": "" - }, - { - "filePath": "polaris-react/src/components/IndexTable/components/ScrollContainer/ScrollContainer.tsx", - "syntaxKind": "MethodSignature", - "name": "onScroll", - "value": "(canScrollLeft: boolean, canScrollRight: boolean) => void", - "description": "" - } - ], - "value": "export interface ScrollContainerProps {\n children: React.ReactNode;\n scrollableContainerRef: React.RefObject;\n onScroll(canScrollLeft: boolean, canScrollRight: boolean): void;\n}" - } - }, "LegacyCardSubsectionProps": { "polaris-react/src/components/LegacyCard/components/Subsection/Subsection.tsx": { "filePath": "polaris-react/src/components/LegacyCard/components/Subsection/Subsection.tsx", @@ -25142,46 +25263,30 @@ "value": "export interface LegacyCardSubsectionProps {\n children?: React.ReactNode;\n}" } }, - "AnnotatedSectionProps": { - "polaris-react/src/components/Layout/components/AnnotatedSection/AnnotatedSection.tsx": { - "filePath": "polaris-react/src/components/Layout/components/AnnotatedSection/AnnotatedSection.tsx", - "name": "AnnotatedSectionProps", + "LegacyItemProps": { + "polaris-react/src/components/LegacyStack/components/Item/Item.tsx": { + "filePath": "polaris-react/src/components/LegacyStack/components/Item/Item.tsx", + "name": "LegacyItemProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/Layout/components/AnnotatedSection/AnnotatedSection.tsx", + "filePath": "polaris-react/src/components/LegacyStack/components/Item/Item.tsx", "syntaxKind": "PropertySignature", "name": "children", "value": "React.ReactNode", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Layout/components/AnnotatedSection/AnnotatedSection.tsx", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "React.ReactNode", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Layout/components/AnnotatedSection/AnnotatedSection.tsx", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "React.ReactNode", - "description": "", + "description": "Elements to display inside item", "isOptional": true }, { - "filePath": "polaris-react/src/components/Layout/components/AnnotatedSection/AnnotatedSection.tsx", + "filePath": "polaris-react/src/components/LegacyStack/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "", + "name": "fill", + "value": "boolean", + "description": "Fill the remaining horizontal space in the stack with the item", "isOptional": true } ], - "value": "export interface AnnotatedSectionProps {\n children?: React.ReactNode;\n title?: React.ReactNode;\n description?: React.ReactNode;\n id?: string;\n}" + "value": "export interface LegacyItemProps {\n /** Elements to display inside item */\n children?: React.ReactNode;\n /** Fill the remaining horizontal space in the stack with the item */\n fill?: boolean;\n /**\n * @default false\n */\n}" } }, "ActionProps": { @@ -25652,40 +25757,6 @@ "value": "export interface CloseButtonProps {\n pressed?: boolean;\n titleHidden?: boolean;\n onClick(): void;\n}" } }, - "FooterProps": { - "polaris-react/src/components/Modal/components/Footer/Footer.tsx": { - "filePath": "polaris-react/src/components/Modal/components/Footer/Footer.tsx", - "name": "FooterProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Modal/components/Footer/Footer.tsx", - "syntaxKind": "PropertySignature", - "name": "primaryAction", - "value": "ComplexAction", - "description": "Primary action", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Modal/components/Footer/Footer.tsx", - "syntaxKind": "PropertySignature", - "name": "secondaryActions", - "value": "ComplexAction[]", - "description": "Collection of secondary actions", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Modal/components/Footer/Footer.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "The content to display inside modal", - "isOptional": true - } - ], - "value": "export interface FooterProps {\n /** Primary action */\n primaryAction?: ComplexAction;\n /** Collection of secondary actions */\n secondaryActions?: ComplexAction[];\n /** The content to display inside modal */\n children?: React.ReactNode;\n}" - } - }, "CSSTransitionProps": { "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx": { "filePath": "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx", @@ -25800,6 +25871,40 @@ "value": "export interface DialogProps {\n labelledBy?: string;\n instant?: boolean;\n children?: React.ReactNode;\n limitHeight?: boolean;\n large?: boolean;\n small?: boolean;\n onClose(): void;\n onEntered?(): void;\n onExited?(): void;\n in?: boolean;\n fullScreen?: boolean;\n setClosing?: Dispatch>;\n}" } }, + "FooterProps": { + "polaris-react/src/components/Modal/components/Footer/Footer.tsx": { + "filePath": "polaris-react/src/components/Modal/components/Footer/Footer.tsx", + "name": "FooterProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Modal/components/Footer/Footer.tsx", + "syntaxKind": "PropertySignature", + "name": "primaryAction", + "value": "ComplexAction", + "description": "Primary action", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Modal/components/Footer/Footer.tsx", + "syntaxKind": "PropertySignature", + "name": "secondaryActions", + "value": "ComplexAction[]", + "description": "Collection of secondary actions", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Modal/components/Footer/Footer.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "The content to display inside modal", + "isOptional": true + } + ], + "value": "export interface FooterProps {\n /** Primary action */\n primaryAction?: ComplexAction;\n /** Collection of secondary actions */\n secondaryActions?: ComplexAction[];\n /** The content to display inside modal */\n children?: React.ReactNode;\n}" + } + }, "ItemURLDetails": { "polaris-react/src/components/Navigation/components/Item/Item.tsx": { "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", @@ -27433,48 +27538,6 @@ "value": "interface SecondaryProps {\n expanded: boolean;\n children?: React.ReactNode;\n id?: string;\n}" } }, - "TitleProps": { - "polaris-react/src/components/Page/components/Header/components/Title/Title.tsx": { - "filePath": "polaris-react/src/components/Page/components/Header/components/Title/Title.tsx", - "name": "TitleProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Page/components/Header/components/Title/Title.tsx", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "Page title, in large type", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Page/components/Header/components/Title/Title.tsx", - "syntaxKind": "PropertySignature", - "name": "subtitle", - "value": "string", - "description": "Page subtitle, in regular type", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Page/components/Header/components/Title/Title.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/components/Header/components/Title/Title.tsx", - "syntaxKind": "PropertySignature", - "name": "compactTitle", - "value": "boolean", - "description": "Removes spacing between title and subtitle", - "isOptional": true - } - ], - "value": "export interface TitleProps {\n /** Page title, in large type */\n title?: string;\n /** Page subtitle, in regular type*/\n subtitle?: string;\n /** Important and non-interactive status information shown immediately after the title. */\n titleMetadata?: React.ReactNode;\n /** Removes spacing between title and subtitle */\n compactTitle?: boolean;\n}" - } - }, "MessageProps": { "polaris-react/src/components/TopBar/components/Menu/components/Message/Message.tsx": { "filePath": "polaris-react/src/components/TopBar/components/Menu/components/Message/Message.tsx", @@ -27520,5 +27583,47 @@ ], "value": "export interface MessageProps {\n title: string;\n description: string;\n action: {onClick(): void; content: string};\n link: {to: string; content: string};\n badge?: {content: string; status: BadgeProps['status']};\n}" } + }, + "TitleProps": { + "polaris-react/src/components/Page/components/Header/components/Title/Title.tsx": { + "filePath": "polaris-react/src/components/Page/components/Header/components/Title/Title.tsx", + "name": "TitleProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Page/components/Header/components/Title/Title.tsx", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "Page title, in large type", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Page/components/Header/components/Title/Title.tsx", + "syntaxKind": "PropertySignature", + "name": "subtitle", + "value": "string", + "description": "Page subtitle, in regular type", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Page/components/Header/components/Title/Title.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/components/Header/components/Title/Title.tsx", + "syntaxKind": "PropertySignature", + "name": "compactTitle", + "value": "boolean", + "description": "Removes spacing between title and subtitle", + "isOptional": true + } + ], + "value": "export interface TitleProps {\n /** Page title, in large type */\n title?: string;\n /** Page subtitle, in regular type*/\n subtitle?: string;\n /** Important and non-interactive status information shown immediately after the title. */\n titleMetadata?: React.ReactNode;\n /** Removes spacing between title and subtitle */\n compactTitle?: boolean;\n}" + } } } \ No newline at end of file