diff --git a/package.json b/package.json index 32d6919b14..8cc6a1ce93 100644 --- a/package.json +++ b/package.json @@ -30,7 +30,7 @@ "build:storybook": "pnpm build && pnpm storybook build", "chromatic": "chromatic --exit-zero-on-changes --build-script-name=build:storybook", "docs": "npm --prefix packages/admin-ui-docs run start", - "generate-docs": "typedoc --plugin typedoc-plugin-markdown && node scripts/typedoc-to-nextra.js", + "generate-docs": "typedoc --plugin typedoc-plugin-markdown --hideBreadcrumbs && node scripts/typedoc-to-nextra.js", "next-docs": "npm --prefix packages/next-docs run dev", "build:docs": "npm --prefix packages/admin-ui-docs run build-docs", "build:next-docs": "npm --prefix packages/next-docs run build-docs", diff --git a/packages/next-docs/pages/components/_meta.json b/packages/next-docs/pages/components/_meta.json index 0ab9fdb48b..134ac23309 100644 --- a/packages/next-docs/pages/components/_meta.json +++ b/packages/next-docs/pages/components/_meta.json @@ -14,7 +14,6 @@ "combobox-item": "ComboboxItem", "combobox-list": "ComboboxList", "combobox-popover": "ComboboxPopover", - "combobox-provider": "ComboboxProvider", "composable": "Composable", "compose": "Compose", "container": "Container", @@ -40,7 +39,6 @@ "locale-provider": "LocaleProvider", "menu": "Menu", "menu-item": "MenuItem", - "menu-provider": "MenuProvider", "menu-separator": "MenuSeparator", "menu-trigger": "MenuTrigger", "modal": "Modal", @@ -48,7 +46,6 @@ "pagination": "Pagination", "popover": "Popover", "popover-dismiss": "PopoverDismiss", - "popover-provider": "PopoverProvider", "popover-trigger": "PopoverTrigger", "radio": "Radio", "radio-group": "RadioGroup", @@ -60,7 +57,6 @@ "select-option": "SelectOption", "select-option-check": "SelectOptionCheck", "select-popover": "SelectPopover", - "select-provider": "SelectProvider", "simple-table": "SimpleTable", "skeleton": "Skeleton", "spinner": "Spinner", @@ -68,7 +64,6 @@ "tab": "Tab", "tab-list": "TabList", "tab-panel": "TabPanel", - "tab-provider": "TabProvider", "table": "Table", "table-body": "TableBody", "table-cell": "TableCell", @@ -83,6 +78,5 @@ "tooltip-anchor": "TooltipAnchor", "tooltip-arrow": "TooltipArrow", "tooltip-popover": "TooltipPopover", - "tooltip-provider": "TooltipProvider", "visually-hidden": "VisuallyHidden" } diff --git a/packages/next-docs/pages/components/alert/props.mdx b/packages/next-docs/pages/components/alert/props.mdx new file mode 100644 index 0000000000..c0a0a1b531 --- /dev/null +++ b/packages/next-docs/pages/components/alert/props.mdx @@ -0,0 +1,34 @@ +# AlertProps + +## Hierarchy + +- `ComponentPropsWithoutRef`\<`"div"`\> + + ↳ **`AlertProps`** + +## Table of contents + +### Properties + +- [onDismiss](AlertProps.md#ondismiss) +- [variant](AlertProps.md#variant) + +## Properties + +### onDismiss + +• `Optional` **onDismiss**: `MouseEventHandler`\<`HTMLButtonElement`\> + +#### Defined in + +[packages/components/src/alert/alert.tsx:74](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/alert/alert.tsx#L74) + +--- + +### variant + +• `Optional` **variant**: `AlertVariant` + +#### Defined in + +[packages/components/src/alert/alert.tsx:73](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/alert/alert.tsx#L73) diff --git a/packages/next-docs/pages/components/bleed/props.mdx b/packages/next-docs/pages/components/bleed/props.mdx new file mode 100644 index 0000000000..3c9b022a02 --- /dev/null +++ b/packages/next-docs/pages/components/bleed/props.mdx @@ -0,0 +1,126 @@ +# BleedProps + +## Hierarchy + +- `ComponentPropsWithoutRef`\<`"div"`\> + + ↳ **`BleedProps`** + +## Table of contents + +### Properties + +- [bottom](BleedProps.md#bottom) +- [horizontal](BleedProps.md#horizontal) +- [left](BleedProps.md#left) +- [right](BleedProps.md#right) +- [top](BleedProps.md#top) +- [vertical](BleedProps.md#vertical) + +## Properties + +### bottom + +• `Optional` **bottom**: `string` \| `boolean` + +Bottom bleed + +**`Default`** + +```ts +"$space-0"; +``` + +#### Defined in + +[packages/components/src/bleed/bleed.tsx:68](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/bleed/bleed.tsx#L68) + +--- + +### horizontal + +• `Optional` **horizontal**: `string` \| `boolean` + +Horizontal bleed + +**`Default`** + +```ts +"$space-0"; +``` + +#### Defined in + +[packages/components/src/bleed/bleed.tsx:83](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/bleed/bleed.tsx#L83) + +--- + +### left + +• `Optional` **left**: `string` \| `boolean` + +Left bleed + +**`Default`** + +```ts +"$space-0"; +``` + +#### Defined in + +[packages/components/src/bleed/bleed.tsx:73](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/bleed/bleed.tsx#L73) + +--- + +### right + +• `Optional` **right**: `string` \| `boolean` + +Right bleed + +**`Default`** + +```ts +"$space-0"; +``` + +#### Defined in + +[packages/components/src/bleed/bleed.tsx:78](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/bleed/bleed.tsx#L78) + +--- + +### top + +• `Optional` **top**: `string` \| `boolean` + +Top bleed + +**`Default`** + +```ts +"$space-0"; +``` + +#### Defined in + +[packages/components/src/bleed/bleed.tsx:63](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/bleed/bleed.tsx#L63) + +--- + +### vertical + +• `Optional` **vertical**: `string` \| `boolean` + +Vertical bleed + +**`Default`** + +```ts +"$space-0"; +``` + +#### Defined in + +[packages/components/src/bleed/bleed.tsx:88](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/bleed/bleed.tsx#L88) diff --git a/packages/next-docs/pages/components/button/props.mdx b/packages/next-docs/pages/components/button/props.mdx new file mode 100644 index 0000000000..c4f94c5725 --- /dev/null +++ b/packages/next-docs/pages/components/button/props.mdx @@ -0,0 +1,105 @@ +# ButtonProps + +## Hierarchy + +- `ComponentPropsWithoutRef`\<`"button"`\> + + ↳ **`ButtonProps`** + + ↳↳ [`IconButtonProps`](IconButtonProps.md) + +## Table of contents + +### Properties + +- [asChild](ButtonProps.md#aschild) +- [children](ButtonProps.md#children) +- [loading](ButtonProps.md#loading) +- [size](ButtonProps.md#size) +- [variant](ButtonProps.md#variant) + +## Properties + +### asChild + +• `Optional` **asChild**: `boolean` + +Merge button props with immediate child. + +**`Default`** + +```ts +false; +``` + +#### Defined in + +[packages/components/src/button/button.tsx:95](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/button/button.tsx#L95) + +--- + +### children + +• **children**: `ReactNode` + +#### Overrides + +ComponentPropsWithoutRef.children + +#### Defined in + +[packages/components/src/button/button.tsx:70](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/button/button.tsx#L70) + +--- + +### loading + +• `Optional` **loading**: `boolean` + +Disable the button and show a spinner. + +**`Default`** + +```ts +false; +``` + +#### Defined in + +[packages/components/src/button/button.tsx:90](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/button/button.tsx#L90) + +--- + +### size + +• `Optional` **size**: `"normal"` \| `"large"` + +Increase or decrease padding. + +**`Default`** + +```ts +normal; +``` + +#### Defined in + +[packages/components/src/button/button.tsx:75](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/button/button.tsx#L75) + +--- + +### variant + +• `Optional` **variant**: `"primary"` \| `"secondary"` \| `"tertiary"` \| `"critical"` \| `"criticalTertiary"` + +Change between color combinations. + +**`Default`** + +```ts +"secondary"; +``` + +#### Defined in + +[packages/components/src/button/button.tsx:80](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/button/button.tsx#L80) diff --git a/packages/next-docs/pages/components/center/props.mdx b/packages/next-docs/pages/components/center/props.mdx index 331787a83a..a58b3891e1 100644 --- a/packages/next-docs/pages/components/center/props.mdx +++ b/packages/next-docs/pages/components/center/props.mdx @@ -4,4 +4,4 @@ #### Defined in -[packages/components/src/center/center.tsx:12](https://github.com/vtex/shoreline/blob/cc3cbcc20/packages/components/src/center/center.tsx#L12) +[packages/components/src/center/center.tsx:12](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/center/center.tsx#L12) diff --git a/packages/next-docs/pages/components/checkbox-field/props.mdx b/packages/next-docs/pages/components/checkbox-field/props.mdx new file mode 100644 index 0000000000..b9b3720b8b --- /dev/null +++ b/packages/next-docs/pages/components/checkbox-field/props.mdx @@ -0,0 +1,87 @@ +# CheckboxFieldProps + +## Hierarchy + +- `AriaCheckboxProps` + + ↳ **`CheckboxFieldProps`** + +## Table of contents + +### Properties + +- [error](CheckboxFieldProps.md#error) +- [errorText](CheckboxFieldProps.md#errortext) +- [helpText](CheckboxFieldProps.md#helptext) +- [indeterminate](CheckboxFieldProps.md#indeterminate) +- [value](CheckboxFieldProps.md#value) + +## Properties + +### error + +• `Optional` **error**: `boolean` + +Whether the field contains an error or not + +**`Default`** + +```ts +false; +``` + +#### Defined in + +[packages/components/src/checkbox/checkbox-field.tsx:52](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/checkbox/checkbox-field.tsx#L52) + +--- + +### errorText + +• `Optional` **errorText**: `ReactNode` + +Error message + +#### Defined in + +[packages/components/src/checkbox/checkbox-field.tsx:56](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/checkbox/checkbox-field.tsx#L56) + +--- + +### helpText + +• `Optional` **helpText**: `ReactNode` + +Help message + +#### Defined in + +[packages/components/src/checkbox/checkbox-field.tsx:60](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/checkbox/checkbox-field.tsx#L60) + +--- + +### indeterminate + +• `Optional` **indeterminate**: `boolean` + +#### Inherited from + +AriaCheckboxProps.indeterminate + +#### Defined in + +[packages/components/src/checkbox/use-aria-checkbox.ts:87](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/checkbox/use-aria-checkbox.ts#L87) + +--- + +### value + +• `Optional` **value**: `string` + +#### Inherited from + +AriaCheckboxProps.value + +#### Defined in + +[packages/components/src/checkbox/use-aria-checkbox.ts:88](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/checkbox/use-aria-checkbox.ts#L88) diff --git a/packages/next-docs/pages/components/checkbox-group/props.mdx b/packages/next-docs/pages/components/checkbox-group/props.mdx new file mode 100644 index 0000000000..e369f0907e --- /dev/null +++ b/packages/next-docs/pages/components/checkbox-group/props.mdx @@ -0,0 +1,67 @@ +# CheckboxGroupProps + +## Hierarchy + +- `ComponentPropsWithoutRef`\<`"div"`\> + + ↳ **`CheckboxGroupProps`** + +## Table of contents + +### Properties + +- [direction](CheckboxGroupProps.md#direction) +- [error](CheckboxGroupProps.md#error) +- [errorText](CheckboxGroupProps.md#errortext) +- [helpText](CheckboxGroupProps.md#helptext) +- [label](CheckboxGroupProps.md#label) + +## Properties + +### direction + +• `Optional` **direction**: `"row"` \| `"column"` + +#### Defined in + +[packages/components/src/checkbox/checkbox-group.tsx:45](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/checkbox/checkbox-group.tsx#L45) + +--- + +### error + +• `Optional` **error**: `boolean` + +#### Defined in + +[packages/components/src/checkbox/checkbox-group.tsx:41](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/checkbox/checkbox-group.tsx#L41) + +--- + +### errorText + +• `Optional` **errorText**: `ReactNode` + +#### Defined in + +[packages/components/src/checkbox/checkbox-group.tsx:43](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/checkbox/checkbox-group.tsx#L43) + +--- + +### helpText + +• `Optional` **helpText**: `ReactNode` + +#### Defined in + +[packages/components/src/checkbox/checkbox-group.tsx:42](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/checkbox/checkbox-group.tsx#L42) + +--- + +### label + +• **label**: `ReactNode` + +#### Defined in + +[packages/components/src/checkbox/checkbox-group.tsx:44](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/checkbox/checkbox-group.tsx#L44) diff --git a/packages/next-docs/pages/components/checkbox/props.mdx b/packages/next-docs/pages/components/checkbox/props.mdx new file mode 100644 index 0000000000..9e26b5d8cd --- /dev/null +++ b/packages/next-docs/pages/components/checkbox/props.mdx @@ -0,0 +1,61 @@ +# CheckboxProps + +## Hierarchy + +- `AriaCheckboxProps` + + ↳ **`CheckboxProps`** + +## Table of contents + +### Properties + +- [error](CheckboxProps.md#error) +- [indeterminate](CheckboxProps.md#indeterminate) +- [value](CheckboxProps.md#value) + +## Properties + +### error + +• `Optional` **error**: `boolean` + +Whether the field contains an error or not + +**`Default`** + +```ts +false; +``` + +#### Defined in + +[packages/components/src/checkbox/checkbox.tsx:65](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/checkbox/checkbox.tsx#L65) + +--- + +### indeterminate + +• `Optional` **indeterminate**: `boolean` + +#### Inherited from + +AriaCheckboxProps.indeterminate + +#### Defined in + +[packages/components/src/checkbox/use-aria-checkbox.ts:87](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/checkbox/use-aria-checkbox.ts#L87) + +--- + +### value + +• `Optional` **value**: `string` + +#### Inherited from + +AriaCheckboxProps.value + +#### Defined in + +[packages/components/src/checkbox/use-aria-checkbox.ts:88](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/checkbox/use-aria-checkbox.ts#L88) diff --git a/packages/next-docs/pages/components/clickable-bubble/props.mdx b/packages/next-docs/pages/components/clickable-bubble/props.mdx new file mode 100644 index 0000000000..f62e445c5d --- /dev/null +++ b/packages/next-docs/pages/components/clickable-bubble/props.mdx @@ -0,0 +1,19 @@ +# ClickableBubbleProps + +## Table of contents + +### Properties + +- [children](ClickableBubbleProps.md#children) + +## Properties + +### children + +• **children**: `ReactNode` + +Children to bubble event + +#### Defined in + +[packages/components/src/clickable/clickable-bubble.tsx:25](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/clickable/clickable-bubble.tsx#L25) diff --git a/packages/next-docs/pages/components/clickable/props.mdx b/packages/next-docs/pages/components/clickable/props.mdx new file mode 100644 index 0000000000..15031d4af1 --- /dev/null +++ b/packages/next-docs/pages/components/clickable/props.mdx @@ -0,0 +1,31 @@ +# ClickableProps + +## Hierarchy + +- `ComponentPropsWithoutRef`\<`"div"`\> + + ↳ **`ClickableProps`** + +## Table of contents + +### Properties + +- [asChild](ClickableProps.md#aschild) + +## Properties + +### asChild + +• `Optional` **asChild**: `boolean` + +Enable children composition + +**`Default`** + +```ts +false; +``` + +#### Defined in + +[packages/components/src/clickable/clickable.tsx:52](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/clickable/clickable.tsx#L52) diff --git a/packages/next-docs/pages/components/combobox-item/props.mdx b/packages/next-docs/pages/components/combobox-item/props.mdx new file mode 100644 index 0000000000..79a9a2d280 --- /dev/null +++ b/packages/next-docs/pages/components/combobox-item/props.mdx @@ -0,0 +1,33 @@ +# ComboboxItemProps + +## Hierarchy + +- `ComponentPropsWithoutRef`\<`"div"`\> + +- `Options` + + ↳ **`ComboboxItemProps`** + +## Table of contents + +### Properties + +- [asChild](ComboboxItemProps.md#aschild) + +## Properties + +### asChild + +• `Optional` **asChild**: `boolean` + +Enable children composition + +**`Default`** + +```ts +false; +``` + +#### Defined in + +[packages/components/src/combobox/combobox-item.tsx:32](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/combobox/combobox-item.tsx#L32) diff --git a/packages/next-docs/pages/components/combobox-list/props.mdx b/packages/next-docs/pages/components/combobox-list/props.mdx new file mode 100644 index 0000000000..73cf401b40 --- /dev/null +++ b/packages/next-docs/pages/components/combobox-list/props.mdx @@ -0,0 +1,31 @@ +# ComboboxListProps + +## Hierarchy + +- `ComponentPropsWithoutRef`\<`"div"`\> + + ↳ **`ComboboxListProps`** + +## Table of contents + +### Properties + +- [asChild](ComboboxListProps.md#aschild) + +## Properties + +### asChild + +• `Optional` **asChild**: `boolean` + +Enable children composition + +**`Default`** + +```ts +false; +``` + +#### Defined in + +[packages/components/src/combobox/combobox-list.tsx:27](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/combobox/combobox-list.tsx#L27) diff --git a/packages/next-docs/pages/components/combobox-popover/props.mdx b/packages/next-docs/pages/components/combobox-popover/props.mdx new file mode 100644 index 0000000000..c21a4a732e --- /dev/null +++ b/packages/next-docs/pages/components/combobox-popover/props.mdx @@ -0,0 +1,33 @@ +# ComboboxPopoverProps + +## Hierarchy + +- `ComponentPropsWithoutRef`\<`"div"`\> + +- `Options` + + ↳ **`ComboboxPopoverProps`** + +## Table of contents + +### Properties + +- [asChild](ComboboxPopoverProps.md#aschild) + +## Properties + +### asChild + +• `Optional` **asChild**: `boolean` + +Enable children composition + +**`Default`** + +```ts +false; +``` + +#### Defined in + +[packages/components/src/combobox/combobox-popover.tsx:32](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/combobox/combobox-popover.tsx#L32) diff --git a/packages/next-docs/pages/components/combobox/props.mdx b/packages/next-docs/pages/components/combobox/props.mdx new file mode 100644 index 0000000000..56acd7db90 --- /dev/null +++ b/packages/next-docs/pages/components/combobox/props.mdx @@ -0,0 +1,33 @@ +# ComboboxProps + +## Hierarchy + +- `ComponentPropsWithoutRef`\<`"input"`\> + +- `Options` + + ↳ **`ComboboxProps`** + +## Table of contents + +### Properties + +- [asChild](ComboboxProps.md#aschild) + +## Properties + +### asChild + +• `Optional` **asChild**: `boolean` + +Enable children composition + +**`Default`** + +```ts +false; +``` + +#### Defined in + +[packages/components/src/combobox/combobox.tsx:32](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/combobox/combobox.tsx#L32) diff --git a/packages/next-docs/pages/components/composable/code.mdx b/packages/next-docs/pages/components/composable/code.mdx index aec50b639d..dd20acb566 100644 --- a/packages/next-docs/pages/components/composable/code.mdx +++ b/packages/next-docs/pages/components/composable/code.mdx @@ -29,4 +29,4 @@ function Button({ asChild, children, ...props }) { #### Defined in -[packages/components/src/compose/composable.tsx:17](https://github.com/vtex/shoreline/blob/cc3cbcc20/packages/components/src/compose/composable.tsx#L17) +[packages/components/src/compose/composable.tsx:17](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/compose/composable.tsx#L17) diff --git a/packages/next-docs/pages/components/composable/props.mdx b/packages/next-docs/pages/components/composable/props.mdx new file mode 100644 index 0000000000..e99e058347 --- /dev/null +++ b/packages/next-docs/pages/components/composable/props.mdx @@ -0,0 +1,28 @@ +# ComposableProps + +## Table of contents + +### Properties + +- [children](ComposableProps.md#children) +- [render](ComposableProps.md#render) + +## Properties + +### children + +• **children**: `ReactNode` + +#### Defined in + +[packages/components/src/compose/composable.tsx:29](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/compose/composable.tsx#L29) + +--- + +### render + +• `Optional` **render**: `RenderProps` + +#### Defined in + +[packages/components/src/compose/composable.tsx:28](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/compose/composable.tsx#L28) diff --git a/packages/next-docs/pages/components/compose/props.mdx b/packages/next-docs/pages/components/compose/props.mdx new file mode 100644 index 0000000000..97c387bc66 --- /dev/null +++ b/packages/next-docs/pages/components/compose/props.mdx @@ -0,0 +1,27 @@ +# ComposeProps + +## Hierarchy + +- `HTMLAttributes`\<`HTMLElement`\> + + ↳ **`ComposeProps`** + +## Table of contents + +### Properties + +- [children](ComposeProps.md#children) + +## Properties + +### children + +• `Optional` **children**: `ReactNode` + +#### Overrides + +HTMLAttributes.children + +#### Defined in + +[packages/components/src/compose/compose.tsx:33](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/compose/compose.tsx#L33) diff --git a/packages/next-docs/pages/components/container/props.mdx b/packages/next-docs/pages/components/container/props.mdx new file mode 100644 index 0000000000..00345bb5c5 --- /dev/null +++ b/packages/next-docs/pages/components/container/props.mdx @@ -0,0 +1,31 @@ +# ContainerProps + +## Hierarchy + +- `ComponentPropsWithoutRef`\<`"div"`\> + + ↳ **`ContainerProps`** + +## Table of contents + +### Properties + +- [as](ContainerProps.md#as) + +## Properties + +### as + +• `Optional` **as**: `ContentContainerAs` + +Select the rendered html tag + +**`Default`** + +```ts +"div"; +``` + +#### Defined in + +[packages/components/src/content/container.tsx:30](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/content/container.tsx#L30) diff --git a/packages/next-docs/pages/components/content/props.mdx b/packages/next-docs/pages/components/content/props.mdx new file mode 100644 index 0000000000..a61c551eaa --- /dev/null +++ b/packages/next-docs/pages/components/content/props.mdx @@ -0,0 +1,50 @@ +# ContentProps + +## Hierarchy + +- `ComponentPropsWithoutRef`\<`"div"`\> + + ↳ **`ContentProps`** + +## Table of contents + +### Properties + +- [as](ContentProps.md#as) +- [narrow](ContentProps.md#narrow) + +## Properties + +### as + +• `Optional` **as**: `ContentContainerAs` + +Select the rendered html tag + +**`Default`** + +```ts +"div"; +``` + +#### Defined in + +[packages/components/src/content/content.tsx:31](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/content/content.tsx#L31) + +--- + +### narrow + +• `Optional` **narrow**: `boolean` + +Decrease the space token in top and bottom padding. + +**`Default`** + +```ts +false; +``` + +#### Defined in + +[packages/components/src/content/content.tsx:36](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/content/content.tsx#L36) diff --git a/packages/next-docs/pages/components/field-label/props.mdx b/packages/next-docs/pages/components/field-label/props.mdx new file mode 100644 index 0000000000..1af0d09608 --- /dev/null +++ b/packages/next-docs/pages/components/field-label/props.mdx @@ -0,0 +1,34 @@ +# FieldLabelProps + +## Hierarchy + +- `ComponentPropsWithoutRef`\<`"label"`\> + + ↳ **`FieldLabelProps`** + +## Table of contents + +### Properties + +- [disabled](FieldLabelProps.md#disabled) +- [optional](FieldLabelProps.md#optional) + +## Properties + +### disabled + +• `Optional` **disabled**: `boolean` + +#### Defined in + +[packages/components/src/field/field-label.tsx:30](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/field/field-label.tsx#L30) + +--- + +### optional + +• `Optional` **optional**: `boolean` + +#### Defined in + +[packages/components/src/field/field-label.tsx:31](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/field/field-label.tsx#L31) diff --git a/packages/next-docs/pages/components/field-message/props.mdx b/packages/next-docs/pages/components/field-message/props.mdx new file mode 100644 index 0000000000..677ddd6792 --- /dev/null +++ b/packages/next-docs/pages/components/field-message/props.mdx @@ -0,0 +1,57 @@ +# FieldMessageProps + +## Hierarchy + +- `ComponentPropsWithoutRef`\<`"div"`\> + + ↳ **`FieldMessageProps`** + +## Table of contents + +### Properties + +- [error](FieldMessageProps.md#error) +- [errorText](FieldMessageProps.md#errortext) +- [helpText](FieldMessageProps.md#helptext) + +## Properties + +### error + +• `Optional` **error**: `boolean` + +Whether the field contains an error or not + +**`Default`** + +```ts +false; +``` + +#### Defined in + +[packages/components/src/field/field-message.tsx:40](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/field/field-message.tsx#L40) + +--- + +### errorText + +• `Optional` **errorText**: `ReactNode` + +Error text message + +#### Defined in + +[packages/components/src/field/field-message.tsx:35](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/field/field-message.tsx#L35) + +--- + +### helpText + +• `Optional` **helpText**: `ReactNode` + +Help text message + +#### Defined in + +[packages/components/src/field/field-message.tsx:31](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/field/field-message.tsx#L31) diff --git a/packages/next-docs/pages/components/field/props.mdx b/packages/next-docs/pages/components/field/props.mdx new file mode 100644 index 0000000000..6eb48d29bd --- /dev/null +++ b/packages/next-docs/pages/components/field/props.mdx @@ -0,0 +1,23 @@ +# FieldProps + +## Hierarchy + +- `ComponentPropsWithoutRef`\<`"div"`\> + + ↳ **`FieldProps`** + +## Table of contents + +### Properties + +- [variant](FieldProps.md#variant) + +## Properties + +### variant + +• `Optional` **variant**: `"group"` \| `"default"` \| `"control"` + +#### Defined in + +[packages/components/src/field/field.tsx:19](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/field/field.tsx#L19) diff --git a/packages/next-docs/pages/components/filter-apply/props.mdx b/packages/next-docs/pages/components/filter-apply/props.mdx index 57c48ebdde..29b6a8c20f 100644 --- a/packages/next-docs/pages/components/filter-apply/props.mdx +++ b/packages/next-docs/pages/components/filter-apply/props.mdx @@ -4,4 +4,4 @@ #### Defined in -[packages/components/src/filter/filter-apply.tsx:38](https://github.com/vtex/shoreline/blob/cc3cbcc20/packages/components/src/filter/filter-apply.tsx#L38) +[packages/components/src/filter/filter-apply.tsx:38](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/filter/filter-apply.tsx#L38) diff --git a/packages/next-docs/pages/components/filter-clear/props.mdx b/packages/next-docs/pages/components/filter-clear/props.mdx index 044e4ccf76..470fcf3894 100644 --- a/packages/next-docs/pages/components/filter-clear/props.mdx +++ b/packages/next-docs/pages/components/filter-clear/props.mdx @@ -4,4 +4,4 @@ #### Defined in -[packages/components/src/filter/filter-clear.tsx:37](https://github.com/vtex/shoreline/blob/cc3cbcc20/packages/components/src/filter/filter-clear.tsx#L37) +[packages/components/src/filter/filter-clear.tsx:37](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/filter/filter-clear.tsx#L37) diff --git a/packages/next-docs/pages/components/filter-list/props.mdx b/packages/next-docs/pages/components/filter-list/props.mdx index 053f046403..b555fe1010 100644 --- a/packages/next-docs/pages/components/filter-list/props.mdx +++ b/packages/next-docs/pages/components/filter-list/props.mdx @@ -4,4 +4,4 @@ #### Defined in -[packages/components/src/filter/filter-list.tsx:37](https://github.com/vtex/shoreline/blob/cc3cbcc20/packages/components/src/filter/filter-list.tsx#L37) +[packages/components/src/filter/filter-list.tsx:37](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/filter/filter-list.tsx#L37) diff --git a/packages/next-docs/pages/components/filter-option/props.mdx b/packages/next-docs/pages/components/filter-option/props.mdx index bd2c7d7f05..d32cbe714d 100644 --- a/packages/next-docs/pages/components/filter-option/props.mdx +++ b/packages/next-docs/pages/components/filter-option/props.mdx @@ -4,4 +4,4 @@ #### Defined in -[packages/components/src/filter/filter-option.tsx:51](https://github.com/vtex/shoreline/blob/cc3cbcc20/packages/components/src/filter/filter-option.tsx#L51) +[packages/components/src/filter/filter-option.tsx:51](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/filter/filter-option.tsx#L51) diff --git a/packages/next-docs/pages/components/filter-popover/props.mdx b/packages/next-docs/pages/components/filter-popover/props.mdx new file mode 100644 index 0000000000..723a6993c5 --- /dev/null +++ b/packages/next-docs/pages/components/filter-popover/props.mdx @@ -0,0 +1,53 @@ +# FilterPopoverProps + +## Hierarchy + +- [`PopoverProps`](PopoverProps.md) + + ↳ **`FilterPopoverProps`** + +## Table of contents + +### Properties + +- [asChild](FilterPopoverProps.md#aschild) +- [messages](FilterPopoverProps.md#messages) + +## Properties + +### asChild + +• `Optional` **asChild**: `boolean` + +Children composition + +**`Default`** + +```ts +false; +``` + +#### Inherited from + +[PopoverProps](PopoverProps.md).[asChild](PopoverProps.md#aschild) + +#### Defined in + +[packages/components/src/popover/popover.tsx:39](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/popover/popover.tsx#L39) + +--- + +### messages + +• `Optional` **messages**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------- | +| `apply` | `string` | +| `clear` | `string` | + +#### Defined in + +[packages/components/src/filter/filter-popover.tsx:62](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/filter/filter-popover.tsx#L62) diff --git a/packages/next-docs/pages/components/filter-provider/code.mdx b/packages/next-docs/pages/components/filter-provider/code.mdx index 39cdac8b93..f705c9d73a 100644 --- a/packages/next-docs/pages/components/filter-provider/code.mdx +++ b/packages/next-docs/pages/components/filter-provider/code.mdx @@ -25,4 +25,4 @@ Provides context to Filter #### Defined in -[packages/components/src/filter/filter-provider.tsx:17](https://github.com/vtex/shoreline/blob/cc3cbcc20/packages/components/src/filter/filter-provider.tsx#L17) +[packages/components/src/filter/filter-provider.tsx:17](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/filter/filter-provider.tsx#L17) diff --git a/packages/next-docs/pages/components/filter-provider/props.mdx b/packages/next-docs/pages/components/filter-provider/props.mdx new file mode 100644 index 0000000000..2f0ac3284d --- /dev/null +++ b/packages/next-docs/pages/components/filter-provider/props.mdx @@ -0,0 +1,116 @@ +# FilterProviderProps + +## Table of contents + +### Properties + +- [children](FilterProviderProps.md#children) +- [defaultOpen](FilterProviderProps.md#defaultopen) +- [defaultSearchValue](FilterProviderProps.md#defaultsearchvalue) +- [defaultValue](FilterProviderProps.md#defaultvalue) +- [open](FilterProviderProps.md#open) +- [searchValue](FilterProviderProps.md#searchvalue) +- [setOpen](FilterProviderProps.md#setopen) +- [setSearchValue](FilterProviderProps.md#setsearchvalue) +- [setValue](FilterProviderProps.md#setvalue) +- [value](FilterProviderProps.md#value) + +## Properties + +### children + +• **children**: `ReactNode` + +#### Defined in + +[packages/components/src/filter/filter-provider.tsx:80](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/filter/filter-provider.tsx#L80) + +--- + +### defaultOpen + +• `Optional` **defaultOpen**: `boolean` + +#### Defined in + +[packages/components/src/filter/filter-provider.tsx:83](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/filter/filter-provider.tsx#L83) + +--- + +### defaultSearchValue + +• `Optional` **defaultSearchValue**: `string` + +#### Defined in + +[packages/components/src/filter/filter-provider.tsx:86](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/filter/filter-provider.tsx#L86) + +--- + +### defaultValue + +• `Optional` **defaultValue**: `string` \| `string`[] + +#### Defined in + +[packages/components/src/filter/filter-provider.tsx:91](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/filter/filter-provider.tsx#L91) + +--- + +### open + +• `Optional` **open**: `boolean` + +#### Defined in + +[packages/components/src/filter/filter-provider.tsx:81](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/filter/filter-provider.tsx#L81) + +--- + +### searchValue + +• `Optional` **searchValue**: `string` + +#### Defined in + +[packages/components/src/filter/filter-provider.tsx:84](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/filter/filter-provider.tsx#L84) + +--- + +### setOpen + +• `Optional` **setOpen**: `Dispatch`\<`SetStateAction`\<`boolean`\>\> + +#### Defined in + +[packages/components/src/filter/filter-provider.tsx:82](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/filter/filter-provider.tsx#L82) + +--- + +### setSearchValue + +• `Optional` **setSearchValue**: `Dispatch`\<`SetStateAction`\<`string`\>\> + +#### Defined in + +[packages/components/src/filter/filter-provider.tsx:85](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/filter/filter-provider.tsx#L85) + +--- + +### setValue + +• `Optional` **setValue**: `Dispatch`\<`SetStateAction`\<`string`\>\> \| `Dispatch`\<`SetStateAction`\<`string`[]\>\> + +#### Defined in + +[packages/components/src/filter/filter-provider.tsx:88](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/filter/filter-provider.tsx#L88) + +--- + +### value + +• `Optional` **value**: `string` \| `string`[] + +#### Defined in + +[packages/components/src/filter/filter-provider.tsx:87](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/filter/filter-provider.tsx#L87) diff --git a/packages/next-docs/pages/components/filter-trigger/props.mdx b/packages/next-docs/pages/components/filter-trigger/props.mdx index adfa95b34d..4942148470 100644 --- a/packages/next-docs/pages/components/filter-trigger/props.mdx +++ b/packages/next-docs/pages/components/filter-trigger/props.mdx @@ -4,4 +4,4 @@ #### Defined in -[packages/components/src/filter/filter-trigger.tsx:29](https://github.com/vtex/shoreline/blob/cc3cbcc20/packages/components/src/filter/filter-trigger.tsx#L29) +[packages/components/src/filter/filter-trigger.tsx:29](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/filter/filter-trigger.tsx#L29) diff --git a/packages/next-docs/pages/components/filter-value/props.mdx b/packages/next-docs/pages/components/filter-value/props.mdx index 3fe2f3d095..9f638faf69 100644 --- a/packages/next-docs/pages/components/filter-value/props.mdx +++ b/packages/next-docs/pages/components/filter-value/props.mdx @@ -4,4 +4,4 @@ #### Defined in -[packages/components/src/filter/filter-value.tsx:29](https://github.com/vtex/shoreline/blob/cc3cbcc20/packages/components/src/filter/filter-value.tsx#L29) +[packages/components/src/filter/filter-value.tsx:29](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/filter/filter-value.tsx#L29) diff --git a/packages/next-docs/pages/components/filter/props.mdx b/packages/next-docs/pages/components/filter/props.mdx new file mode 100644 index 0000000000..9d47ec5fa3 --- /dev/null +++ b/packages/next-docs/pages/components/filter/props.mdx @@ -0,0 +1,157 @@ +# FilterProps + +## Hierarchy + +- `InheritedProps` + + ↳ **`FilterProps`** + +## Table of contents + +### Properties + +- [children](FilterProps.md#children) +- [className](FilterProps.md#classname) +- [defaultSearchValue](FilterProps.md#defaultsearchvalue) +- [defaultValue](FilterProps.md#defaultvalue) +- [label](FilterProps.md#label) +- [messages](FilterProps.md#messages) +- [searchValue](FilterProps.md#searchvalue) +- [setSearchValue](FilterProps.md#setsearchvalue) +- [setValue](FilterProps.md#setvalue) +- [value](FilterProps.md#value) + +## Properties + +### children + +• **children**: `ReactNode` + +#### Defined in + +[packages/components/src/filter/filter.tsx:67](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/filter/filter.tsx#L67) + +--- + +### className + +• `Optional` **className**: `string` + +#### Defined in + +[packages/components/src/filter/filter.tsx:68](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/filter/filter.tsx#L68) + +--- + +### defaultSearchValue + +• `Optional` **defaultSearchValue**: `string` + +#### Inherited from + +InheritedProps.defaultSearchValue + +#### Defined in + +[packages/components/src/filter/filter-provider.tsx:86](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/filter/filter-provider.tsx#L86) + +--- + +### defaultValue + +• `Optional` **defaultValue**: `string` \| `string`[] + +#### Inherited from + +InheritedProps.defaultValue + +#### Defined in + +[packages/components/src/filter/filter-provider.tsx:91](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/filter/filter-provider.tsx#L91) + +--- + +### label + +• **label**: `string` + +#### Defined in + +[packages/components/src/filter/filter.tsx:66](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/filter/filter.tsx#L66) + +--- + +### messages + +• `Optional` **messages**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------- | +| `apply` | `string` | +| `clear` | `string` | + +#### Inherited from + +InheritedProps.messages + +#### Defined in + +[packages/components/src/filter/filter-popover.tsx:62](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/filter/filter-popover.tsx#L62) + +--- + +### searchValue + +• `Optional` **searchValue**: `string` + +#### Inherited from + +InheritedProps.searchValue + +#### Defined in + +[packages/components/src/filter/filter-provider.tsx:84](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/filter/filter-provider.tsx#L84) + +--- + +### setSearchValue + +• `Optional` **setSearchValue**: `Dispatch`\<`SetStateAction`\<`string`\>\> + +#### Inherited from + +InheritedProps.setSearchValue + +#### Defined in + +[packages/components/src/filter/filter-provider.tsx:85](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/filter/filter-provider.tsx#L85) + +--- + +### setValue + +• `Optional` **setValue**: `Dispatch`\<`SetStateAction`\<`string`\>\> \| `Dispatch`\<`SetStateAction`\<`string`[]\>\> + +#### Inherited from + +InheritedProps.setValue + +#### Defined in + +[packages/components/src/filter/filter-provider.tsx:88](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/filter/filter-provider.tsx#L88) + +--- + +### value + +• `Optional` **value**: `string` \| `string`[] + +#### Inherited from + +InheritedProps.value + +#### Defined in + +[packages/components/src/filter/filter-provider.tsx:87](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/filter/filter-provider.tsx#L87) diff --git a/packages/next-docs/pages/components/flex/props.mdx b/packages/next-docs/pages/components/flex/props.mdx index a02b7ee873..fdccb6a2ae 100644 --- a/packages/next-docs/pages/components/flex/props.mdx +++ b/packages/next-docs/pages/components/flex/props.mdx @@ -4,4 +4,4 @@ #### Defined in -[packages/components/src/flex/flex.tsx:52](https://github.com/vtex/shoreline/blob/cc3cbcc20/packages/components/src/flex/flex.tsx#L52) +[packages/components/src/flex/flex.tsx:52](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/flex/flex.tsx#L52) diff --git a/packages/next-docs/pages/components/grid-cell/props.mdx b/packages/next-docs/pages/components/grid-cell/props.mdx index 109627e00a..d98f16d30d 100644 --- a/packages/next-docs/pages/components/grid-cell/props.mdx +++ b/packages/next-docs/pages/components/grid-cell/props.mdx @@ -4,4 +4,4 @@ #### Defined in -[packages/components/src/grid/grid-cell.tsx:42](https://github.com/vtex/shoreline/blob/cc3cbcc20/packages/components/src/grid/grid-cell.tsx#L42) +[packages/components/src/grid/grid-cell.tsx:42](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/grid/grid-cell.tsx#L42) diff --git a/packages/next-docs/pages/components/grid/props.mdx b/packages/next-docs/pages/components/grid/props.mdx index d95221c2e8..3521228bf3 100644 --- a/packages/next-docs/pages/components/grid/props.mdx +++ b/packages/next-docs/pages/components/grid/props.mdx @@ -4,4 +4,4 @@ #### Defined in -[packages/components/src/grid/grid.tsx:44](https://github.com/vtex/shoreline/blob/cc3cbcc20/packages/components/src/grid/grid.tsx#L44) +[packages/components/src/grid/grid.tsx:44](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/grid/grid.tsx#L44) diff --git a/packages/next-docs/pages/components/icon-button/props.mdx b/packages/next-docs/pages/components/icon-button/props.mdx new file mode 100644 index 0000000000..99f862f7f6 --- /dev/null +++ b/packages/next-docs/pages/components/icon-button/props.mdx @@ -0,0 +1,130 @@ +# IconButtonProps + +## Hierarchy + +- [`ButtonProps`](ButtonProps.md) + + ↳ **`IconButtonProps`** + +## Table of contents + +### Properties + +- [asChild](IconButtonProps.md#aschild) +- [children](IconButtonProps.md#children) +- [label](IconButtonProps.md#label) +- [loading](IconButtonProps.md#loading) +- [size](IconButtonProps.md#size) +- [variant](IconButtonProps.md#variant) + +## Properties + +### asChild + +• `Optional` **asChild**: `boolean` + +Merge button props with immediate child. + +**`Default`** + +```ts +false; +``` + +#### Inherited from + +[ButtonProps](ButtonProps.md).[asChild](ButtonProps.md#aschild) + +#### Defined in + +[packages/components/src/button/button.tsx:95](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/button/button.tsx#L95) + +--- + +### children + +• **children**: `ReactNode` + +#### Inherited from + +[ButtonProps](ButtonProps.md).[children](ButtonProps.md#children) + +#### Defined in + +[packages/components/src/button/button.tsx:70](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/button/button.tsx#L70) + +--- + +### label + +• **label**: `ReactNode` + +#### Defined in + +[packages/components/src/icon-button/icon-button.tsx:33](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/icon-button/icon-button.tsx#L33) + +--- + +### loading + +• `Optional` **loading**: `boolean` + +Disable the button and show a spinner. + +**`Default`** + +```ts +false; +``` + +#### Inherited from + +[ButtonProps](ButtonProps.md).[loading](ButtonProps.md#loading) + +#### Defined in + +[packages/components/src/button/button.tsx:90](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/button/button.tsx#L90) + +--- + +### size + +• `Optional` **size**: `"normal"` \| `"large"` + +Increase or decrease padding. + +**`Default`** + +```ts +normal; +``` + +#### Inherited from + +[ButtonProps](ButtonProps.md).[size](ButtonProps.md#size) + +#### Defined in + +[packages/components/src/button/button.tsx:75](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/button/button.tsx#L75) + +--- + +### variant + +• `Optional` **variant**: `"primary"` \| `"secondary"` \| `"tertiary"` \| `"critical"` \| `"criticalTertiary"` + +Change between color combinations. + +**`Default`** + +```ts +"secondary"; +``` + +#### Inherited from + +[ButtonProps](ButtonProps.md).[variant](ButtonProps.md#variant) + +#### Defined in + +[packages/components/src/button/button.tsx:80](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/button/button.tsx#L80) diff --git a/packages/next-docs/pages/components/interfaces/code.mdx b/packages/next-docs/pages/components/interfaces/code.mdx index 13f217bd5b..234b02222a 100644 --- a/packages/next-docs/pages/components/interfaces/code.mdx +++ b/packages/next-docs/pages/components/interfaces/code.mdx @@ -1,5 +1,3 @@ -[shoreline](README.md) / Modules - # shoreline ## Table of contents @@ -60,7 +58,6 @@ - [TabListProps](interfaces/TabListProps.md) - [TabPanelProps](interfaces/TabPanelProps.md) - [TabProps](interfaces/TabProps.md) -- [TabProviderProps](interfaces/TabProviderProps.md) - [TableBodyProps](interfaces/TableBodyProps.md) - [TableCellProps](interfaces/TableCellProps.md) - [TableHeaderCellProps](interfaces/TableHeaderCellProps.md) @@ -74,7 +71,6 @@ - [TooltipArrowProps](interfaces/TooltipArrowProps.md) - [TooltipPopoverProps](interfaces/TooltipPopoverProps.md) - [TooltipProps](interfaces/TooltipProps.md) -- [TooltipProviderProps](interfaces/TooltipProviderProps.md) - [VisuallyHiddenProps](interfaces/VisuallyHiddenProps.md) ### Type Aliases @@ -115,7 +111,6 @@ - [ComboboxItem](modules.md#comboboxitem) - [ComboboxList](modules.md#comboboxlist) - [ComboboxPopover](modules.md#comboboxpopover) -- [ComboboxProvider](modules.md#comboboxprovider) - [Composable](modules.md#composable) - [Compose](modules.md#compose) - [Container](modules.md#container) @@ -141,7 +136,6 @@ - [LocaleProvider](modules.md#localeprovider) - [Menu](modules.md#menu) - [MenuItem](modules.md#menuitem) -- [MenuProvider](modules.md#menuprovider) - [MenuSeparator](modules.md#menuseparator) - [MenuTrigger](modules.md#menutrigger) - [Modal](modules.md#modal) @@ -149,7 +143,6 @@ - [Pagination](modules.md#pagination) - [Popover](modules.md#popover) - [PopoverDismiss](modules.md#popoverdismiss) -- [PopoverProvider](modules.md#popoverprovider) - [PopoverTrigger](modules.md#popovertrigger) - [Radio](modules.md#radio) - [RadioGroup](modules.md#radiogroup) @@ -161,7 +154,6 @@ - [SelectOption](modules.md#selectoption) - [SelectOptionCheck](modules.md#selectoptioncheck) - [SelectPopover](modules.md#selectpopover) -- [SelectProvider](modules.md#selectprovider) - [SimpleTable](modules.md#simpletable) - [Skeleton](modules.md#skeleton) - [Spinner](modules.md#spinner) @@ -169,7 +161,6 @@ - [Tab](modules.md#tab) - [TabList](modules.md#tablist) - [TabPanel](modules.md#tabpanel) -- [TabProvider](modules.md#tabprovider) - [Table](modules.md#table) - [TableBody](modules.md#tablebody) - [TableCell](modules.md#tablecell) @@ -184,7 +175,6 @@ - [TooltipAnchor](modules.md#tooltipanchor) - [TooltipArrow](modules.md#tooltiparrow) - [TooltipPopover](modules.md#tooltippopover) -- [TooltipProvider](modules.md#tooltipprovider) - [VisuallyHidden](modules.md#visuallyhidden) - [createMessageHook](modules.md#createmessagehook) - [get](modules.md#get) @@ -193,11 +183,7 @@ - [isComposable](modules.md#iscomposable) - [useFilterContext](modules.md#usefiltercontext) - [useLocale](modules.md#uselocale) -- [usePopoverContext](modules.md#usepopovercontext) -- [usePopoverStore](modules.md#usepopoverstore) - [useRadioState](modules.md#useradiostate) -- [useSelectContext](modules.md#useselectcontext) -- [useSelectStore](modules.md#useselectstore) ## Type Aliases @@ -207,4 +193,4 @@ #### Defined in -[packages/components/src/action/action.tsx:34](https://github.com/vtex/shoreline/blob/cc3cbcc20/packages/components/src/action/action.tsx#L34) +[packages/components/src/action/action.tsx:34](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/action/action.tsx#L34) diff --git a/packages/next-docs/pages/components/link-box/props.mdx b/packages/next-docs/pages/components/link-box/props.mdx new file mode 100644 index 0000000000..fa14a88130 --- /dev/null +++ b/packages/next-docs/pages/components/link-box/props.mdx @@ -0,0 +1,75 @@ +# LinkBoxProps + +## Hierarchy + +- `Omit`\<[`ClickableProps`](ClickableProps.md), `"onClick"`\> + + ↳ **`LinkBoxProps`** + +## Table of contents + +### Properties + +- [asChild](LinkBoxProps.md#aschild) +- [href](LinkBoxProps.md#href) +- [target](LinkBoxProps.md#target) + +## Properties + +### asChild + +• `Optional` **asChild**: `boolean` + +Enable children composition + +**`Default`** + +```ts +false; +``` + +#### Inherited from + +Omit.asChild + +#### Defined in + +[packages/components/src/clickable/clickable.tsx:52](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/clickable/clickable.tsx#L52) + +--- + +### href + +• **href**: `string` + +The URL that the hyperlink points to. + +**`See`** + +https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#href + +#### Defined in + +[packages/components/src/link-box/link-box.tsx:43](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/link-box/link-box.tsx#L43) + +--- + +### target + +• `Optional` **target**: `NavigationTarget` + +Where to display the linked URL + +**`Default`** + +```ts +"_parent"; +``` + +**`See`** + +https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#target + +#### Defined in + +[packages/components/src/link-box/link-box.tsx:49](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/link-box/link-box.tsx#L49) diff --git a/packages/next-docs/pages/components/link/props.mdx b/packages/next-docs/pages/components/link/props.mdx new file mode 100644 index 0000000000..3c7bbba12d --- /dev/null +++ b/packages/next-docs/pages/components/link/props.mdx @@ -0,0 +1,31 @@ +# LinkProps + +## Hierarchy + +- `ComponentPropsWithoutRef`\<`"a"`\> + + ↳ **`LinkProps`** + +## Table of contents + +### Properties + +- [asChild](LinkProps.md#aschild) + +## Properties + +### asChild + +• `Optional` **asChild**: `boolean` + +Enable children composition + +**`Default`** + +```ts +false; +``` + +#### Defined in + +[packages/components/src/link/link.tsx:27](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/link/link.tsx#L27) diff --git a/packages/next-docs/pages/components/locale-provider/code.mdx b/packages/next-docs/pages/components/locale-provider/code.mdx index a067442968..6b1d4b5cf7 100644 --- a/packages/next-docs/pages/components/locale-provider/code.mdx +++ b/packages/next-docs/pages/components/locale-provider/code.mdx @@ -22,4 +22,4 @@ Provides the locale #### Defined in -[packages/components/src/locale/locale-provider.tsx:12](https://github.com/vtex/shoreline/blob/cc3cbcc20/packages/components/src/locale/locale-provider.tsx#L12) +[packages/components/src/locale/locale-provider.tsx:12](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/locale/locale-provider.tsx#L12) diff --git a/packages/next-docs/pages/components/locale-provider/props.mdx b/packages/next-docs/pages/components/locale-provider/props.mdx new file mode 100644 index 0000000000..93d44da628 --- /dev/null +++ b/packages/next-docs/pages/components/locale-provider/props.mdx @@ -0,0 +1,34 @@ +# LocaleProviderProps + +## Table of contents + +### Properties + +- [children](LocaleProviderProps.md#children) +- [locale](LocaleProviderProps.md#locale) + +## Properties + +### children + +• `Optional` **children**: `ReactNode` + +#### Defined in + +[packages/components/src/locale/locale-provider.tsx:26](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/locale/locale-provider.tsx#L26) + +--- + +### locale + +• `Optional` **locale**: `string` + +The BCP47 language code for the locale. + +**`Link`** + +https://www.ietf.org/rfc/bcp/bcp47.txt + +#### Defined in + +[packages/components/src/locale/locale-provider.tsx:25](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/locale/locale-provider.tsx#L25) diff --git a/packages/next-docs/pages/components/menu-item/props.mdx b/packages/next-docs/pages/components/menu-item/props.mdx new file mode 100644 index 0000000000..0e78b530fe --- /dev/null +++ b/packages/next-docs/pages/components/menu-item/props.mdx @@ -0,0 +1,69 @@ +# MenuItemProps + +## Hierarchy + +- `ComponentPropsWithoutRef`\<`"div"`\> + + ↳ **`MenuItemProps`** + +## Table of contents + +### Properties + +- [asChild](MenuItemProps.md#aschild) +- [critical](MenuItemProps.md#critical) +- [disabled](MenuItemProps.md#disabled) + +## Properties + +### asChild + +• `Optional` **asChild**: `boolean` + +Children composition + +**`Default`** + +```ts +false; +``` + +#### Defined in + +[packages/components/src/menu/menu-item.tsx:36](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/menu/menu-item.tsx#L36) + +--- + +### critical + +• `Optional` **critical**: `boolean` + +Wether is critical + +**`Default`** + +```ts +false; +``` + +#### Defined in + +[packages/components/src/menu/menu-item.tsx:41](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/menu/menu-item.tsx#L41) + +--- + +### disabled + +• `Optional` **disabled**: `boolean` + +Wether is disabled + +**`Default`** + +```ts +false; +``` + +#### Defined in + +[packages/components/src/menu/menu-item.tsx:46](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/menu/menu-item.tsx#L46) diff --git a/packages/next-docs/pages/components/menu-separator/props.mdx b/packages/next-docs/pages/components/menu-separator/props.mdx index fc0922724c..0ab5230191 100644 --- a/packages/next-docs/pages/components/menu-separator/props.mdx +++ b/packages/next-docs/pages/components/menu-separator/props.mdx @@ -4,4 +4,4 @@ #### Defined in -[packages/components/src/menu/menu-separator.tsx:11](https://github.com/vtex/shoreline/blob/cc3cbcc20/packages/components/src/menu/menu-separator.tsx#L11) +[packages/components/src/menu/menu-separator.tsx:11](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/menu/menu-separator.tsx#L11) diff --git a/packages/next-docs/pages/components/menu/props.mdx b/packages/next-docs/pages/components/menu/props.mdx new file mode 100644 index 0000000000..9b05766611 --- /dev/null +++ b/packages/next-docs/pages/components/menu/props.mdx @@ -0,0 +1,31 @@ +# MenuProps + +## Hierarchy + +- `ComponentPropsWithoutRef`\<`"div"`\> + + ↳ **`MenuProps`** + +## Table of contents + +### Properties + +- [asChild](MenuProps.md#aschild) + +## Properties + +### asChild + +• `Optional` **asChild**: `boolean` + +Children composition + +**`Default`** + +```ts +false; +``` + +#### Defined in + +[packages/components/src/menu/menu.tsx:30](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/menu/menu.tsx#L30) diff --git a/packages/next-docs/pages/components/modal-header/props.mdx b/packages/next-docs/pages/components/modal-header/props.mdx index 9e1c99a5f1..dfa175924e 100644 --- a/packages/next-docs/pages/components/modal-header/props.mdx +++ b/packages/next-docs/pages/components/modal-header/props.mdx @@ -4,4 +4,4 @@ #### Defined in -[packages/components/src/modal/modal-header.tsx:31](https://github.com/vtex/shoreline/blob/cc3cbcc20/packages/components/src/modal/modal-header.tsx#L31) +[packages/components/src/modal/modal-header.tsx:31](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/modal/modal-header.tsx#L31) diff --git a/packages/next-docs/pages/components/modal/props.mdx b/packages/next-docs/pages/components/modal/props.mdx new file mode 100644 index 0000000000..e7bb27d47c --- /dev/null +++ b/packages/next-docs/pages/components/modal/props.mdx @@ -0,0 +1,48 @@ +# ModalProps + +## Hierarchy + +- `ComponentPropsWithoutRef`\<`"div"`\> + + ↳ **`ModalProps`** + +## Table of contents + +### Properties + +- [onClose](ModalProps.md#onclose) +- [open](ModalProps.md#open) + +## Properties + +### onClose + +• `Optional` **onClose**: (`event`: `Event`) => `void` + +#### Type declaration + +▸ (`event`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `Event` | + +##### Returns + +`void` + +#### Defined in + +[packages/components/src/modal/modal.tsx:27](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/modal/modal.tsx#L27) + +--- + +### open + +• `Optional` **open**: `boolean` + +#### Defined in + +[packages/components/src/modal/modal.tsx:28](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/modal/modal.tsx#L28) diff --git a/packages/next-docs/pages/components/pagination/props.mdx b/packages/next-docs/pages/components/pagination/props.mdx new file mode 100644 index 0000000000..2fe4faa9d7 --- /dev/null +++ b/packages/next-docs/pages/components/pagination/props.mdx @@ -0,0 +1,107 @@ +# PaginationProps + +## Hierarchy + +- `ComponentPropsWithoutRef`\<`"div"`\> + + ↳ **`PaginationProps`** + +## Table of contents + +### Properties + +- [onPageChange](PaginationProps.md#onpagechange) +- [onSizeChange](PaginationProps.md#onsizechange) +- [page](PaginationProps.md#page) +- [size](PaginationProps.md#size) +- [sizeOptions](PaginationProps.md#sizeoptions) +- [total](PaginationProps.md#total) + +## Properties + +### onPageChange + +• `Optional` **onPageChange**: (`page`: `number`, `type`: `"next"` \| `"prev"`) => `void` + +#### Type declaration + +▸ (`page`, `type`): `void` + +##### Parameters + +| Name | Type | +| :----- | :------------------- | +| `page` | `number` | +| `type` | `"next"` \| `"prev"` | + +##### Returns + +`void` + +#### Defined in + +[packages/components/src/pagination/pagination.tsx:114](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/pagination/pagination.tsx#L114) + +--- + +### onSizeChange + +• `Optional` **onSizeChange**: (`size`: `number`) => `void` + +#### Type declaration + +▸ (`size`): `void` + +##### Parameters + +| Name | Type | +| :----- | :------- | +| `size` | `number` | + +##### Returns + +`void` + +#### Defined in + +[packages/components/src/pagination/pagination.tsx:115](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/pagination/pagination.tsx#L115) + +--- + +### page + +• **page**: `number` + +#### Defined in + +[packages/components/src/pagination/pagination.tsx:118](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/pagination/pagination.tsx#L118) + +--- + +### size + +• **size**: `number` + +#### Defined in + +[packages/components/src/pagination/pagination.tsx:117](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/pagination/pagination.tsx#L117) + +--- + +### sizeOptions + +• `Optional` **sizeOptions**: `number`[] + +#### Defined in + +[packages/components/src/pagination/pagination.tsx:116](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/pagination/pagination.tsx#L116) + +--- + +### total + +• **total**: `number` + +#### Defined in + +[packages/components/src/pagination/pagination.tsx:119](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/pagination/pagination.tsx#L119) diff --git a/packages/next-docs/pages/components/popover-dismiss/props.mdx b/packages/next-docs/pages/components/popover-dismiss/props.mdx new file mode 100644 index 0000000000..24adf702ab --- /dev/null +++ b/packages/next-docs/pages/components/popover-dismiss/props.mdx @@ -0,0 +1,31 @@ +# PopoverDismissProps + +## Hierarchy + +- `ComponentPropsWithoutRef`\<`"button"`\> + + ↳ **`PopoverDismissProps`** + +## Table of contents + +### Properties + +- [asChild](PopoverDismissProps.md#aschild) + +## Properties + +### asChild + +• `Optional` **asChild**: `boolean` + +Children composition + +**`Default`** + +```ts +false; +``` + +#### Defined in + +[packages/components/src/popover/popover-dismiss.tsx:38](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/popover/popover-dismiss.tsx#L38) diff --git a/packages/next-docs/pages/components/popover-trigger/props.mdx b/packages/next-docs/pages/components/popover-trigger/props.mdx new file mode 100644 index 0000000000..0c87fd7263 --- /dev/null +++ b/packages/next-docs/pages/components/popover-trigger/props.mdx @@ -0,0 +1,31 @@ +# PopoverTriggerProps + +## Hierarchy + +- `ComponentPropsWithoutRef`\<`"button"`\> + + ↳ **`PopoverTriggerProps`** + +## Table of contents + +### Properties + +- [asChild](PopoverTriggerProps.md#aschild) + +## Properties + +### asChild + +• `Optional` **asChild**: `boolean` + +Children composition + +**`Default`** + +```ts +false; +``` + +#### Defined in + +[packages/components/src/popover/popover-trigger.tsx:38](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/popover/popover-trigger.tsx#L38) diff --git a/packages/next-docs/pages/components/popover/props.mdx b/packages/next-docs/pages/components/popover/props.mdx new file mode 100644 index 0000000000..d87edbf39b --- /dev/null +++ b/packages/next-docs/pages/components/popover/props.mdx @@ -0,0 +1,33 @@ +# PopoverProps + +## Hierarchy + +- `ComponentPropsWithoutRef`\<`"div"`\> + + ↳ **`PopoverProps`** + + ↳↳ [`FilterPopoverProps`](FilterPopoverProps.md) + +## Table of contents + +### Properties + +- [asChild](PopoverProps.md#aschild) + +## Properties + +### asChild + +• `Optional` **asChild**: `boolean` + +Children composition + +**`Default`** + +```ts +false; +``` + +#### Defined in + +[packages/components/src/popover/popover.tsx:39](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/popover/popover.tsx#L39) diff --git a/packages/next-docs/pages/components/radio-group/props.mdx b/packages/next-docs/pages/components/radio-group/props.mdx new file mode 100644 index 0000000000..9a4ce1afe8 --- /dev/null +++ b/packages/next-docs/pages/components/radio-group/props.mdx @@ -0,0 +1,93 @@ +# RadioGroupProps + +## Hierarchy + +- `ComponentPropsWithoutRef`\<`"div"`\> + + ↳ **`RadioGroupProps`** + +## Table of contents + +### Properties + +- [className](RadioGroupProps.md#classname) +- [direction](RadioGroupProps.md#direction) +- [error](RadioGroupProps.md#error) +- [errorText](RadioGroupProps.md#errortext) +- [helpText](RadioGroupProps.md#helptext) +- [label](RadioGroupProps.md#label) +- [state](RadioGroupProps.md#state) + +## Properties + +### className + +• `Optional` **className**: `string` + +#### Overrides + +ComponentPropsWithoutRef.className + +#### Defined in + +[packages/components/src/radio/radio-group.tsx:61](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/radio/radio-group.tsx#L61) + +--- + +### direction + +• `Optional` **direction**: `"row"` \| `"column"` + +#### Defined in + +[packages/components/src/radio/radio-group.tsx:66](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/radio/radio-group.tsx#L66) + +--- + +### error + +• `Optional` **error**: `boolean` + +#### Defined in + +[packages/components/src/radio/radio-group.tsx:62](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/radio/radio-group.tsx#L62) + +--- + +### errorText + +• `Optional` **errorText**: `string` + +#### Defined in + +[packages/components/src/radio/radio-group.tsx:64](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/radio/radio-group.tsx#L64) + +--- + +### helpText + +• `Optional` **helpText**: `string` + +#### Defined in + +[packages/components/src/radio/radio-group.tsx:63](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/radio/radio-group.tsx#L63) + +--- + +### label + +• **label**: `ReactNode` + +#### Defined in + +[packages/components/src/radio/radio-group.tsx:65](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/radio/radio-group.tsx#L65) + +--- + +### state + +• `Optional` **state**: `RadioStore` + +#### Defined in + +[packages/components/src/radio/radio-group.tsx:67](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/radio/radio-group.tsx#L67) diff --git a/packages/next-docs/pages/components/radio/props.mdx b/packages/next-docs/pages/components/radio/props.mdx new file mode 100644 index 0000000000..3de4866922 --- /dev/null +++ b/packages/next-docs/pages/components/radio/props.mdx @@ -0,0 +1,38 @@ +# RadioProps + +## Hierarchy + +- `ComponentPropsWithoutRef`\<`"input"`\> + + ↳ **`RadioProps`** + +## Table of contents + +### Properties + +- [error](RadioProps.md#error) +- [value](RadioProps.md#value) + +## Properties + +### error + +• `Optional` **error**: `boolean` + +#### Defined in + +[packages/components/src/radio/radio.tsx:43](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/radio/radio.tsx#L43) + +--- + +### value + +• **value**: `string` + +#### Overrides + +ComponentPropsWithoutRef.value + +#### Defined in + +[packages/components/src/radio/radio.tsx:44](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/radio/radio.tsx#L44) diff --git a/packages/next-docs/pages/components/scroll-area/props.mdx b/packages/next-docs/pages/components/scroll-area/props.mdx new file mode 100644 index 0000000000..71d7bc8944 --- /dev/null +++ b/packages/next-docs/pages/components/scroll-area/props.mdx @@ -0,0 +1,50 @@ +# ScrollAreaProps + +## Hierarchy + +- `DivProps` + + ↳ **`ScrollAreaProps`** + +## Table of contents + +### Properties + +- [scrollHideDelay](ScrollAreaProps.md#scrollhidedelay) +- [type](ScrollAreaProps.md#type) + +## Properties + +### scrollHideDelay + +• `Optional` **scrollHideDelay**: `number` + +Timeout (in ms) to hide the scrollbar + +**`Default`** + +```ts +600; +``` + +#### Defined in + +[packages/components/src/scroll-area/scroll-area.tsx:54](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/scroll-area/scroll-area.tsx#L54) + +--- + +### type + +• `Optional` **type**: `"hover"` \| `"auto"` \| `"always"` \| `"scroll"` + +Scroll type + +**`Default`** + +```ts +"hover"; +``` + +#### Defined in + +[packages/components/src/scroll-area/scroll-area.tsx:49](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/scroll-area/scroll-area.tsx#L49) diff --git a/packages/next-docs/pages/components/search/props.mdx b/packages/next-docs/pages/components/search/props.mdx new file mode 100644 index 0000000000..3d82779d38 --- /dev/null +++ b/packages/next-docs/pages/components/search/props.mdx @@ -0,0 +1,58 @@ +# SearchProps + +## Hierarchy + +- `ComponentPropsWithoutRef`\<`"input"`\> + + ↳ **`SearchProps`** + +## Table of contents + +### Properties + +- [loading](SearchProps.md#loading) +- [onClear](SearchProps.md#onclear) + +## Properties + +### loading + +• `Optional` **loading**: `boolean` + +Whether component is loading or not + +**`Default`** + +```ts +false; +``` + +#### Defined in + +[packages/components/src/search/search.tsx:70](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/search/search.tsx#L70) + +--- + +### onClear + +• `Optional` **onClear**: () => `void` + +#### Type declaration + +▸ (): `void` + +Callback when the input is cleared + +##### Returns + +`void` + +**`Default`** + +```ts +undefined; +``` + +#### Defined in + +[packages/components/src/search/search.tsx:75](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/search/search.tsx#L75) diff --git a/packages/next-docs/pages/components/select-field/props.mdx b/packages/next-docs/pages/components/select-field/props.mdx new file mode 100644 index 0000000000..0e613d49b1 --- /dev/null +++ b/packages/next-docs/pages/components/select-field/props.mdx @@ -0,0 +1,82 @@ +# SelectFieldProps + +## Hierarchy + +- `ComponentPropsWithoutRef`\<`"select"`\> + + ↳ **`SelectFieldProps`** + +## Table of contents + +### Properties + +- [disabled](SelectFieldProps.md#disabled) +- [error](SelectFieldProps.md#error) +- [errorText](SelectFieldProps.md#errortext) +- [helpText](SelectFieldProps.md#helptext) +- [label](SelectFieldProps.md#label) +- [optional](SelectFieldProps.md#optional) + +## Properties + +### disabled + +• `Optional` **disabled**: `boolean` + +#### Overrides + +ComponentPropsWithoutRef.disabled + +#### Defined in + +[packages/components/src/select-field/select-field.tsx:82](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/select-field/select-field.tsx#L82) + +--- + +### error + +• `Optional` **error**: `boolean` + +#### Defined in + +[packages/components/src/select-field/select-field.tsx:78](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/select-field/select-field.tsx#L78) + +--- + +### errorText + +• `Optional` **errorText**: `ReactNode` + +#### Defined in + +[packages/components/src/select-field/select-field.tsx:80](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/select-field/select-field.tsx#L80) + +--- + +### helpText + +• `Optional` **helpText**: `ReactNode` + +#### Defined in + +[packages/components/src/select-field/select-field.tsx:81](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/select-field/select-field.tsx#L81) + +--- + +### label + +• `Optional` **label**: `ReactNode` + +#### Defined in + +[packages/components/src/select-field/select-field.tsx:79](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/select-field/select-field.tsx#L79) + +--- + +### optional + +• `Optional` **optional**: `boolean` + +#### Defined in + +[packages/components/src/select-field/select-field.tsx:83](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/select-field/select-field.tsx#L83) diff --git a/packages/next-docs/pages/components/select-list/props.mdx b/packages/next-docs/pages/components/select-list/props.mdx new file mode 100644 index 0000000000..9310ed771e --- /dev/null +++ b/packages/next-docs/pages/components/select-list/props.mdx @@ -0,0 +1,48 @@ +# SelectListProps + +## Hierarchy + +- `ComponentPropsWithoutRef`\<`"div"`\> + + ↳ **`SelectListProps`** + +## Table of contents + +### Properties + +- [alwaysVisible](SelectListProps.md#alwaysvisible) +- [asChild](SelectListProps.md#aschild) + +## Properties + +### alwaysVisible + +• `Optional` **alwaysVisible**: `boolean` + +**`Default`** + +```ts +false; +``` + +#### Defined in + +[packages/components/src/select/select-list.tsx:41](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/select/select-list.tsx#L41) + +--- + +### asChild + +• `Optional` **asChild**: `boolean` + +Enable children composition + +**`Default`** + +```ts +false; +``` + +#### Defined in + +[packages/components/src/select/select-list.tsx:36](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/select/select-list.tsx#L36) diff --git a/packages/next-docs/pages/components/select-option-check/props.mdx b/packages/next-docs/pages/components/select-option-check/props.mdx new file mode 100644 index 0000000000..fa05b48243 --- /dev/null +++ b/packages/next-docs/pages/components/select-option-check/props.mdx @@ -0,0 +1,17 @@ +# SelectOptionCheckProps + +## Table of contents + +### Properties + +- [className](SelectOptionCheckProps.md#classname) + +## Properties + +### className + +• `Optional` **className**: `string` + +#### Defined in + +[packages/components/src/select/select-option-check.tsx:17](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/select/select-option-check.tsx#L17) diff --git a/packages/next-docs/pages/components/select-option/props.mdx b/packages/next-docs/pages/components/select-option/props.mdx new file mode 100644 index 0000000000..314b00a65f --- /dev/null +++ b/packages/next-docs/pages/components/select-option/props.mdx @@ -0,0 +1,63 @@ +# SelectOptionProps + +## Hierarchy + +- `ComponentPropsWithoutRef`\<`"div"`\> + + ↳ **`SelectOptionProps`** + +## Table of contents + +### Properties + +- [asChild](SelectOptionProps.md#aschild) +- [hideOnClick](SelectOptionProps.md#hideonclick) +- [value](SelectOptionProps.md#value) + +## Properties + +### asChild + +• `Optional` **asChild**: `boolean` + +Enable children composition + +**`Default`** + +```ts +false; +``` + +#### Defined in + +[packages/components/src/select/select-option.tsx:30](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/select/select-option.tsx#L30) + +--- + +### hideOnClick + +• `Optional` **hideOnClick**: `boolean` + +Whether to hide the select when this item is clicked. By default, it's true when the value prop is also provided. + +**`Default`** + +```ts +true; +``` + +#### Defined in + +[packages/components/src/select/select-option.tsx:39](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/select/select-option.tsx#L39) + +--- + +### value + +• `Optional` **value**: `string` + +Option value + +#### Defined in + +[packages/components/src/select/select-option.tsx:34](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/select/select-option.tsx#L34) diff --git a/packages/next-docs/pages/components/select-popover/props.mdx b/packages/next-docs/pages/components/select-popover/props.mdx new file mode 100644 index 0000000000..61ac05dc01 --- /dev/null +++ b/packages/next-docs/pages/components/select-popover/props.mdx @@ -0,0 +1,31 @@ +# SelectPopoverProps + +## Hierarchy + +- `ComponentPropsWithoutRef`\<`"div"`\> + + ↳ **`SelectPopoverProps`** + +## Table of contents + +### Properties + +- [asChild](SelectPopoverProps.md#aschild) + +## Properties + +### asChild + +• `Optional` **asChild**: `boolean` + +Enable children composition + +**`Default`** + +```ts +false; +``` + +#### Defined in + +[packages/components/src/select/select-popover.tsx:27](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/select/select-popover.tsx#L27) diff --git a/packages/next-docs/pages/components/select/props.mdx b/packages/next-docs/pages/components/select/props.mdx new file mode 100644 index 0000000000..484d45847a --- /dev/null +++ b/packages/next-docs/pages/components/select/props.mdx @@ -0,0 +1,31 @@ +# SelectProps + +## Hierarchy + +- `ComponentPropsWithoutRef`\<`"button"`\> + + ↳ **`SelectProps`** + +## Table of contents + +### Properties + +- [asChild](SelectProps.md#aschild) + +## Properties + +### asChild + +• `Optional` **asChild**: `boolean` + +Enable children composition + +**`Default`** + +```ts +false; +``` + +#### Defined in + +[packages/components/src/select/select.tsx:28](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/select/select.tsx#L28) diff --git a/packages/next-docs/pages/components/simple-table/props.mdx b/packages/next-docs/pages/components/simple-table/props.mdx new file mode 100644 index 0000000000..5475c34d28 --- /dev/null +++ b/packages/next-docs/pages/components/simple-table/props.mdx @@ -0,0 +1,245 @@ +# SimpleTableProps\ + +## Type parameters + +| Name | +| :--- | +| `T` | + +## Hierarchy + +- [`TableProps`](TableProps.md) + +- `TsMirrorProps`\<`T`\> + + ↳ **`SimpleTableProps`** + +## Table of contents + +### Properties + +- [asChild](SimpleTableProps.md#aschild) +- [columnWidths](SimpleTableProps.md#columnwidths) +- [density](SimpleTableProps.md#density) +- [options](SimpleTableProps.md#options) +- [renderDetail](SimpleTableProps.md#renderdetail) +- [rowClick](SimpleTableProps.md#rowclick) +- [setSort](SimpleTableProps.md#setsort) +- [sort](SimpleTableProps.md#sort) +- [sortable](SimpleTableProps.md#sortable) +- [stickyColumn](SimpleTableProps.md#stickycolumn) +- [stickyHeader](SimpleTableProps.md#stickyheader) + +## Properties + +### asChild + +• `Optional` **asChild**: `boolean` + +If true, the Table component will be rendered as a child of the Compose component + +**`Default`** + +```ts +false; +``` + +#### Inherited from + +[TableProps](TableProps.md).[asChild](TableProps.md#aschild) + +#### Defined in + +[packages/components/src/table/table.tsx:59](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/table/table.tsx#L59) + +--- + +### columnWidths + +• `Optional` **columnWidths**: `string`[] + +Array of column widths + +When using the Table component + +**`Default`** + +```ts +[] + +When using the SimpleTable component +``` + +**`Default`** + +```ts +[repeat(${columns.length}, var(--sl-table-default-column-width))] +``` + +#### Inherited from + +[TableProps](TableProps.md).[columnWidths](TableProps.md#columnwidths) + +#### Defined in + +[packages/components/src/table/table.tsx:54](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/table/table.tsx#L54) + +--- + +### density + +• `Optional` **density**: `"default"` \| `"comfortable"` \| `"compact"` + +The density of the table + +**`Default`** + +```ts +"default"; +``` + +#### Inherited from + +[TableProps](TableProps.md).[density](TableProps.md#density) + +#### Defined in + +[packages/components/src/table/table.tsx:74](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/table/table.tsx#L74) + +--- + +### options + +• `Optional` **options**: `Options`\<`T`\> + +Other TanStack/Table options + +**`See`** + +https://tanstack.com/table/v8/docs/api/core/table + +#### Defined in + +[packages/components/src/simple-table/simple-table.tsx:195](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/simple-table/simple-table.tsx#L195) + +--- + +### renderDetail + +• `Optional` **renderDetail**: (`row`: `Row`\<`T`\>) => `ReactNode` + +#### Type declaration + +▸ (`row`): `ReactNode` + +Renders function for the detail row + +##### Parameters + +| Name | Type | +| :---- | :----------- | +| `row` | `Row`\<`T`\> | + +##### Returns + +`ReactNode` + +#### Defined in + +[packages/components/src/simple-table/simple-table.tsx:199](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/simple-table/simple-table.tsx#L199) + +--- + +### rowClick + +• `Optional` **rowClick**: \{ `getHref`: (`row`: `Row`\<`T`\>) => `string` ; `target?`: `NavigationTarget` ; `type`: `"link"` } \| \{ `onClick`: (`row`: `Row`\<`T`\>) => `void` ; `type`: `"action"` } + +#### Defined in + +[packages/components/src/simple-table/simple-table.tsx:216](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/simple-table/simple-table.tsx#L216) + +--- + +### setSort + +• `Optional` **setSort**: `OnChangeFn`\<`SortingState`\> + +Setter for SortingState for controlled sort usage + +#### Defined in + +[packages/components/src/simple-table/simple-table.tsx:212](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/simple-table/simple-table.tsx#L212) + +--- + +### sort + +• `Optional` **sort**: `SortingState` + +SortingState for controlled sort usage + +#### Defined in + +[packages/components/src/simple-table/simple-table.tsx:208](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/simple-table/simple-table.tsx#L208) + +--- + +### sortable + +• `Optional` **sortable**: `boolean` + +Defines if columns will be sortable + +**`Default`** + +```ts +false; +``` + +#### Defined in + +[packages/components/src/simple-table/simple-table.tsx:204](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/simple-table/simple-table.tsx#L204) + +--- + +### stickyColumn + +• `Optional` **stickyColumn**: `boolean` + +If true, the first column will be sticky + +**`Default`** + +```ts +false; +``` + +#### Inherited from + +[TableProps](TableProps.md).[stickyColumn](TableProps.md#stickycolumn) + +#### Defined in + +[packages/components/src/table/table.tsx:69](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/table/table.tsx#L69) + +--- + +### stickyHeader + +• `Optional` **stickyHeader**: `boolean` + +If true, the header will be sticky + +**`Default`** + +```ts +false; +``` + +#### Inherited from + +[TableProps](TableProps.md).[stickyHeader](TableProps.md#stickyheader) + +#### Defined in + +[packages/components/src/table/table.tsx:64](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/table/table.tsx#L64) diff --git a/packages/next-docs/pages/components/skeleton/props.mdx b/packages/next-docs/pages/components/skeleton/props.mdx new file mode 100644 index 0000000000..f76342975a --- /dev/null +++ b/packages/next-docs/pages/components/skeleton/props.mdx @@ -0,0 +1,31 @@ +# SkeletonProps + +## Hierarchy + +- `ComponentPropsWithoutRef`\<`"div"`\> + + ↳ **`SkeletonProps`** + +## Table of contents + +### Properties + +- [shape](SkeletonProps.md#shape) + +## Properties + +### shape + +• `Optional` **shape**: `"circle"` \| `"rect"` + +Skeleton shape + +**`Default`** + +```ts +rect; +``` + +#### Defined in + +[packages/components/src/skeleton/skeleton.tsx:25](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/skeleton/skeleton.tsx#L25) diff --git a/packages/next-docs/pages/components/spinner/props.mdx b/packages/next-docs/pages/components/spinner/props.mdx index b74b08baf6..1170261a75 100644 --- a/packages/next-docs/pages/components/spinner/props.mdx +++ b/packages/next-docs/pages/components/spinner/props.mdx @@ -1,21 +1,50 @@ -# Props +# SpinnerProps -## Optional Props +## Hierarchy -### `Common Props (div)` +- `ComponentPropsWithoutRef`\<`"div"`\> -All built-in browser components, such as `
`, support some [common props and events.](https://react.dev/reference/react-dom/components/common) + ↳ **`SpinnerProps`** -### `size` +## Table of contents -- Type: `number` -- Default: `24` +### Properties -Increase or decrease the size of the shape. +- [description](SpinnerProps.md#description) +- [size](SpinnerProps.md#size) -### `description` +## Properties -- Type: `string` -- Default: `'loading'` +### description + +• `Optional` **description**: `string` Specify a description that would be used to best describe the loading state + +**`Default`** + +```ts +"loading"; +``` + +#### Defined in + +[packages/components/src/spinner/spinner.tsx:43](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/spinner/spinner.tsx#L43) + +--- + +### size + +• `Optional` **size**: `number` + +Increase or decrease the size of the shape + +**`Default`** + +```ts +16; +``` + +#### Defined in + +[packages/components/src/spinner/spinner.tsx:48](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/spinner/spinner.tsx#L48) diff --git a/packages/next-docs/pages/components/stack/props.mdx b/packages/next-docs/pages/components/stack/props.mdx new file mode 100644 index 0000000000..35dfc1022a --- /dev/null +++ b/packages/next-docs/pages/components/stack/props.mdx @@ -0,0 +1,88 @@ +# StackProps + +## Hierarchy + +- `ComponentPropsWithoutRef`\<`"div"`\> + + ↳ **`StackProps`** + +## Table of contents + +### Properties + +- [align](StackProps.md#align) +- [direction](StackProps.md#direction) +- [fluid](StackProps.md#fluid) +- [space](StackProps.md#space) + +## Properties + +### align + +• `Optional` **align**: `"end"` \| `"start"` + +items alignment + +**`Default`** + +```ts +start; +``` + +#### Defined in + +[packages/components/src/stack/stack.tsx:58](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/stack/stack.tsx#L58) + +--- + +### direction + +• `Optional` **direction**: `"row"` \| `"column"` + +direction of items + +**`Default`** + +```ts +column; +``` + +#### Defined in + +[packages/components/src/stack/stack.tsx:43](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/stack/stack.tsx#L43) + +--- + +### fluid + +• `Optional` **fluid**: `boolean` + +if the items should grow in width to match the container + +**`Default`** + +```ts +false; +``` + +#### Defined in + +[packages/components/src/stack/stack.tsx:48](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/stack/stack.tsx#L48) + +--- + +### space + +• `Optional` **space**: `string` + +space between items + +**`Default`** + +```ts +0; +``` + +#### Defined in + +[packages/components/src/stack/stack.tsx:53](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/stack/stack.tsx#L53) diff --git a/packages/next-docs/pages/components/tab-list/props.mdx b/packages/next-docs/pages/components/tab-list/props.mdx new file mode 100644 index 0000000000..7f4d280d53 --- /dev/null +++ b/packages/next-docs/pages/components/tab-list/props.mdx @@ -0,0 +1,31 @@ +# TabListProps + +## Hierarchy + +- `ComponentPropsWithoutRef`\<`"div"`\> + + ↳ **`TabListProps`** + +## Table of contents + +### Properties + +- [asChild](TabListProps.md#aschild) + +## Properties + +### asChild + +• `Optional` **asChild**: `boolean` + +Enable children composition + +**`Default`** + +```ts +false; +``` + +#### Defined in + +[packages/components/src/tab/tab-list.tsx:42](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/tab/tab-list.tsx#L42) diff --git a/packages/next-docs/pages/components/tab-panel/props.mdx b/packages/next-docs/pages/components/tab-panel/props.mdx new file mode 100644 index 0000000000..cc7258dc63 --- /dev/null +++ b/packages/next-docs/pages/components/tab-panel/props.mdx @@ -0,0 +1,44 @@ +# TabPanelProps + +## Hierarchy + +- `ComponentPropsWithoutRef`\<`"div"`\> + + ↳ **`TabPanelProps`** + +## Table of contents + +### Properties + +- [asChild](TabPanelProps.md#aschild) +- [tabId](TabPanelProps.md#tabid) + +## Properties + +### asChild + +• `Optional` **asChild**: `boolean` + +Enable children composition + +**`Default`** + +```ts +false; +``` + +#### Defined in + +[packages/components/src/tab/tab-panel.tsx:42](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/tab/tab-panel.tsx#L42) + +--- + +### tabId + +• `Optional` **tabId**: `string` + +The id of the tab that controls this panel. By default, this value will be inferred based on the order of the tabs and the panels. + +#### Defined in + +[packages/components/src/tab/tab-panel.tsx:46](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/tab/tab-panel.tsx#L46) diff --git a/packages/next-docs/pages/components/tab-provider/props.mdx b/packages/next-docs/pages/components/tab-provider/props.mdx new file mode 100644 index 0000000000..1e5e30fecc --- /dev/null +++ b/packages/next-docs/pages/components/tab-provider/props.mdx @@ -0,0 +1,482 @@ +# Interface: TabProviderProps + +## Hierarchy + +- `TabStoreProps` + + ↳ **`TabProviderProps`** + +## Table of contents + +### Properties + +- [activeId](TabProviderProps.md#activeid) +- [children](TabProviderProps.md#children) +- [defaultActiveId](TabProviderProps.md#defaultactiveid) +- [defaultItems](TabProviderProps.md#defaultitems) +- [defaultSelectedId](TabProviderProps.md#defaultselectedid) +- [focusLoop](TabProviderProps.md#focusloop) +- [focusShift](TabProviderProps.md#focusshift) +- [focusWrap](TabProviderProps.md#focuswrap) +- [includesBaseElement](TabProviderProps.md#includesbaseelement) +- [items](TabProviderProps.md#items) +- [orientation](TabProviderProps.md#orientation) +- [rtl](TabProviderProps.md#rtl) +- [selectOnMove](TabProviderProps.md#selectonmove) +- [selectedId](TabProviderProps.md#selectedid) +- [setActiveId](TabProviderProps.md#setactiveid) +- [setItems](TabProviderProps.md#setitems) +- [setSelectedId](TabProviderProps.md#setselectedid) +- [store](TabProviderProps.md#store) +- [virtualFocus](TabProviderProps.md#virtualfocus) + +## Properties + +### activeId + +• `Optional` **activeId**: `null` \| `string` + +The current focused item `id`. + +- `null` focuses the base composite element and users will be able to + navigate out of it using arrow keys. +- If `activeId` is initially set to `null`, the `includesBaseElement` prop + will also default to `true`, which means the base composite element + itself will have focus and users will be able to navigate to it using + arrow keys. + +#### Inherited from + +TabStoreProps.activeId + +#### Defined in + +node_modules/.pnpm/@ariakit+core@0.3.4/node_modules/@ariakit/core/cjs/composite/composite-store.d.ts:122 + +--- + +### children + +• `Optional` **children**: `ReactNode` + +#### Defined in + +node_modules/.pnpm/@ariakit+react-core@0.3.5_react-dom@18.2.0_react@18.2.0/node_modules/@ariakit/react-core/cjs/tab/tab-provider.d.ts:20 + +--- + +### defaultActiveId + +• `Optional` **defaultActiveId**: `null` \| `string` + +The composite item id that should be active by default when the composite +widget is rendered. If `null`, the composite element itself will have focus +and users will be able to navigate to it using arrow keys. If `undefined`, +the first enabled item will be focused. + +#### Inherited from + +TabStoreProps.defaultActiveId + +#### Defined in + +node_modules/.pnpm/@ariakit+core@0.3.4/node_modules/@ariakit/core/cjs/composite/composite-store.d.ts:202 + +--- + +### defaultItems + +• `Optional` **defaultItems**: `Item`[] + +The defaut value for the `items` state. + +**`Default`** + +```ts +[]; +``` + +#### Inherited from + +TabStoreProps.defaultItems + +#### Defined in + +node_modules/.pnpm/@ariakit+core@0.3.4/node_modules/@ariakit/core/cjs/collection/collection-store.d.ts:61 + +--- + +### defaultSelectedId + +• `Optional` **defaultSelectedId**: `null` \| `string` + +The id of the tab whose panel is currently visible. If it's `undefined`, it +will be automatically set to the first enabled tab. + +#### Inherited from + +TabStoreProps.defaultSelectedId + +#### Defined in + +node_modules/.pnpm/@ariakit+core@0.3.4/node_modules/@ariakit/core/cjs/tab/tab-store.d.ts:83 + +--- + +### focusLoop + +• `Optional` **focusLoop**: `boolean` \| `Orientation` + +**`Default`** + +```ts +true; +``` + +#### Inherited from + +TabStoreProps.focusLoop + +#### Defined in + +node_modules/.pnpm/@ariakit+core@0.3.4/node_modules/@ariakit/core/cjs/tab/tab-store.d.ts:22 + +--- + +### focusShift + +• `Optional` **focusShift**: `boolean` + +**Works only on two-dimensional composites**. If enabled, moving up or down +when there's no next item or when the next item is disabled will shift to +the item right before it. + +**`Default`** + +```ts +false; +``` + +#### Inherited from + +TabStoreProps.focusShift + +#### Defined in + +node_modules/.pnpm/@ariakit+core@0.3.4/node_modules/@ariakit/core/cjs/composite/composite-store.d.ts:102 + +--- + +### focusWrap + +• `Optional` **focusWrap**: `boolean` \| `Orientation` + +**Works only on two-dimensional composites**. If enabled, moving to the +next item from the last one in a row or column will focus the first item in +the next row or column and vice-versa. + +- `true` wraps between rows and columns. +- `horizontal` wraps only between rows. +- `vertical` wraps only between columns. +- If `focusLoop` matches the value of `focusWrap`, it'll wrap between the + last item in the last row or column and the first item in the first row + or column and vice-versa. + +**`Default`** + +```ts +false; +``` + +#### Inherited from + +TabStoreProps.focusWrap + +#### Defined in + +node_modules/.pnpm/@ariakit+core@0.3.4/node_modules/@ariakit/core/cjs/composite/composite-store.d.ts:95 + +--- + +### includesBaseElement + +• `Optional` **includesBaseElement**: `boolean` + +Indicates whether the composite element should be included in the focus +order. + +**`Default`** + +```ts +false; +``` + +#### Inherited from + +TabStoreProps.includesBaseElement + +#### Defined in + +node_modules/.pnpm/@ariakit+core@0.3.4/node_modules/@ariakit/core/cjs/composite/composite-store.d.ts:112 + +--- + +### items + +• `Optional` **items**: `Item`[] + +Lists all the items with their meta data. This state is automatically +updated when an item is registered or unregistered with the `registerItem` +function. + +#### Inherited from + +TabStoreProps.items + +#### Defined in + +node_modules/.pnpm/@ariakit+core@0.3.4/node_modules/@ariakit/core/cjs/collection/collection-store.d.ts:18 + +--- + +### orientation + +• `Optional` **orientation**: `Orientation` + +**`Default`** + +```ts +"horizontal"; +``` + +#### Inherited from + +TabStoreProps.orientation + +#### Defined in + +node_modules/.pnpm/@ariakit+core@0.3.4/node_modules/@ariakit/core/cjs/tab/tab-store.d.ts:18 + +--- + +### rtl + +• `Optional` **rtl**: `boolean` + +Determines how the `next` and `previous` functions will behave. If `rtl` is +set to `true`, they will be inverted. This only affects the composite +widget behavior. You still need to set `dir="rtl"` on HTML/CSS. + +**`Default`** + +```ts +false; +``` + +#### Inherited from + +TabStoreProps.rtl + +#### Defined in + +node_modules/.pnpm/@ariakit+core@0.3.4/node_modules/@ariakit/core/cjs/composite/composite-store.d.ts:53 + +--- + +### selectOnMove + +• `Optional` **selectOnMove**: `boolean` + +Whether the tab should be selected when it receives focus. If it's set to +`false`, the tab will be selected only when it's clicked. + +Live examples: + +- [Tab with React Router](https://ariakit.org/examples/tab-react-router) + +**`Default`** + +```ts +true; +``` + +#### Inherited from + +TabStoreProps.selectOnMove + +#### Defined in + +node_modules/.pnpm/@ariakit+core@0.3.4/node_modules/@ariakit/core/cjs/tab/tab-store.d.ts:39 + +--- + +### selectedId + +• `Optional` **selectedId**: `null` \| `string` + +The id of the tab whose panel is currently visible. If it's `undefined`, it +will be automatically set to the first enabled tab. + +Live examples: + +- [Tab with React Router](https://ariakit.org/examples/tab-react-router) + +#### Inherited from + +TabStoreProps.selectedId + +#### Defined in + +node_modules/.pnpm/@ariakit+core@0.3.4/node_modules/@ariakit/core/cjs/tab/tab-store.d.ts:30 + +--- + +### setActiveId + +• `Optional` **setActiveId**: (`activeId`: `undefined` \| `null` \| `string`) => `void` + +#### Type declaration + +▸ (`activeId`): `void` + +A callback that gets called when the `activeId` state changes. + +##### Parameters + +| Name | Type | Description | +| :--------- | :-------------------------------- | :----------------- | +| `activeId` | `undefined` \| `null` \| `string` | The new active id. | + +##### Returns + +`void` + +**`Example`** + +```ts +const [activeId, setActiveId] = useState(null); +const composite = useCompositeStore({ activeId, setActiveId }); +``` + +#### Inherited from + +TabStoreProps.setActiveId + +#### Defined in + +node_modules/.pnpm/@ariakit+react-core@0.3.5_react-dom@18.2.0_react@18.2.0/node_modules/@ariakit/react-core/cjs/composite/composite-store.d.ts:35 + +--- + +### setItems + +• `Optional` **setItems**: (...`args`: [items: Item[]]) => `void` + +#### Type declaration + +▸ (`...args`): `void` + +A callback that gets called when the `items` state changes. + +##### Parameters + +| Name | Type | +| :-------- | :-------------- | +| `...args` | [items: Item[]] | + +##### Returns + +`void` + +**`Example`** + +```ts +const [items, setItems] = useState([]); +const collection = useCollectionStore({ items, setItems }); +``` + +#### Inherited from + +TabStoreProps.setItems + +#### Defined in + +node_modules/.pnpm/@ariakit+react-core@0.3.5_react-dom@18.2.0_react@18.2.0/node_modules/@ariakit/react-core/cjs/collection/collection-store.d.ts:32 + +--- + +### setSelectedId + +• `Optional` **setSelectedId**: (`selectedId`: `undefined` \| `null` \| `string`) => `void` + +#### Type declaration + +▸ (`selectedId`): `void` + +Function that will be called when the `selectedId` state changes. + +##### Parameters + +| Name | Type | Description | +| :----------- | :-------------------------------- | :------------------- | +| `selectedId` | `undefined` \| `null` \| `string` | The new selected id. | + +##### Returns + +`void` + +#### Inherited from + +TabStoreProps.setSelectedId + +#### Defined in + +node_modules/.pnpm/@ariakit+react-core@0.3.5_react-dom@18.2.0_react@18.2.0/node_modules/@ariakit/react-core/cjs/tab/tab-store.d.ts:70 + +--- + +### store + +• `Optional` **store**: `Store`\<`Partial`\<`TabStoreState`\>\> + +Another store object that will be kept in sync with the original store. + +#### Inherited from + +TabStoreProps.store + +#### Defined in + +node_modules/.pnpm/@ariakit+core@0.3.4/node_modules/@ariakit/core/cjs/utils/store.d.ts:50 + +--- + +### virtualFocus + +• `Optional` **virtualFocus**: `boolean` + +If enabled, the composite element will act as an +[aria-activedescendant](https://www.w3.org/WAI/ARIA/apg/practices/keyboard-interface/#kbd_focus_activedescendant) +container instead of [roving +tabindex](https://www.w3.org/WAI/ARIA/apg/practices/keyboard-interface/#kbd_roving_tabindex). +DOM focus will remain on the composite element while its items receive +virtual focus. + +Live examples: + +- [Multi-selectable + Combobox](https://ariakit.org/examples/combobox-multiple) + +**`Default`** + +```ts +false; +``` + +#### Inherited from + +TabStoreProps.virtualFocus + +#### Defined in + +node_modules/.pnpm/@ariakit+core@0.3.4/node_modules/@ariakit/core/cjs/composite/composite-store.d.ts:34 diff --git a/packages/next-docs/pages/components/tab/props.mdx b/packages/next-docs/pages/components/tab/props.mdx new file mode 100644 index 0000000000..752543e1cb --- /dev/null +++ b/packages/next-docs/pages/components/tab/props.mdx @@ -0,0 +1,31 @@ +# TabProps + +## Hierarchy + +- `ComponentPropsWithoutRef`\<`"button"`\> + + ↳ **`TabProps`** + +## Table of contents + +### Properties + +- [asChild](TabProps.md#aschild) + +## Properties + +### asChild + +• `Optional` **asChild**: `boolean` + +Enable children composition + +**`Default`** + +```ts +false; +``` + +#### Defined in + +[packages/components/src/tab/tab.tsx:44](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/tab/tab.tsx#L44) diff --git a/packages/next-docs/pages/components/table-body/props.mdx b/packages/next-docs/pages/components/table-body/props.mdx new file mode 100644 index 0000000000..ac02e060ce --- /dev/null +++ b/packages/next-docs/pages/components/table-body/props.mdx @@ -0,0 +1,23 @@ +# TableBodyProps + +## Hierarchy + +- `ComponentPropsWithoutRef`\<`"div"`\> + + ↳ **`TableBodyProps`** + +## Table of contents + +### Properties + +- [asChild](TableBodyProps.md#aschild) + +## Properties + +### asChild + +• `Optional` **asChild**: `boolean` + +#### Defined in + +[packages/components/src/table/table-body.tsx:18](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/table/table-body.tsx#L18) diff --git a/packages/next-docs/pages/components/table-cell/props.mdx b/packages/next-docs/pages/components/table-cell/props.mdx new file mode 100644 index 0000000000..ba27d0cf4a --- /dev/null +++ b/packages/next-docs/pages/components/table-cell/props.mdx @@ -0,0 +1,23 @@ +# TableCellProps + +## Hierarchy + +- `ComponentPropsWithoutRef`\<`"div"`\> + + ↳ **`TableCellProps`** + +## Table of contents + +### Properties + +- [asChild](TableCellProps.md#aschild) + +## Properties + +### asChild + +• `Optional` **asChild**: `boolean` + +#### Defined in + +[packages/components/src/table/table-cell.tsx:16](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/table/table-cell.tsx#L16) diff --git a/packages/next-docs/pages/components/table-header-cell/props.mdx b/packages/next-docs/pages/components/table-header-cell/props.mdx new file mode 100644 index 0000000000..07aedddf5f --- /dev/null +++ b/packages/next-docs/pages/components/table-header-cell/props.mdx @@ -0,0 +1,34 @@ +# TableHeaderCellProps + +## Hierarchy + +- `ComponentPropsWithoutRef`\<`"div"`\> + + ↳ **`TableHeaderCellProps`** + +## Table of contents + +### Properties + +- [asChild](TableHeaderCellProps.md#aschild) +- [sortable](TableHeaderCellProps.md#sortable) + +## Properties + +### asChild + +• `Optional` **asChild**: `boolean` + +#### Defined in + +[packages/components/src/table/table-header-cell.tsx:24](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/table/table-header-cell.tsx#L24) + +--- + +### sortable + +• `Optional` **sortable**: `boolean` + +#### Defined in + +[packages/components/src/table/table-header-cell.tsx:25](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/table/table-header-cell.tsx#L25) diff --git a/packages/next-docs/pages/components/table-header/props.mdx b/packages/next-docs/pages/components/table-header/props.mdx new file mode 100644 index 0000000000..6597c0dd55 --- /dev/null +++ b/packages/next-docs/pages/components/table-header/props.mdx @@ -0,0 +1,23 @@ +# TableHeaderProps + +## Hierarchy + +- `ComponentPropsWithoutRef`\<`"div"`\> + + ↳ **`TableHeaderProps`** + +## Table of contents + +### Properties + +- [asChild](TableHeaderProps.md#aschild) + +## Properties + +### asChild + +• `Optional` **asChild**: `boolean` + +#### Defined in + +[packages/components/src/table/table-header.tsx:23](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/table/table-header.tsx#L23) diff --git a/packages/next-docs/pages/components/table-row/props.mdx b/packages/next-docs/pages/components/table-row/props.mdx new file mode 100644 index 0000000000..a443723b8c --- /dev/null +++ b/packages/next-docs/pages/components/table-row/props.mdx @@ -0,0 +1,56 @@ +# TableRowProps + +## Hierarchy + +- `ComponentPropsWithoutRef`\<`"div"`\> + + ↳ **`TableRowProps`** + +## Table of contents + +### Properties + +- [asChild](TableRowProps.md#aschild) +- [dimOnHover](TableRowProps.md#dimonhover) +- [expanded](TableRowProps.md#expanded) +- [selected](TableRowProps.md#selected) + +## Properties + +### asChild + +• `Optional` **asChild**: `boolean` + +#### Defined in + +[packages/components/src/table/table-row.tsx:34](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/table/table-row.tsx#L34) + +--- + +### dimOnHover + +• `Optional` **dimOnHover**: `boolean` + +#### Defined in + +[packages/components/src/table/table-row.tsx:35](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/table/table-row.tsx#L35) + +--- + +### expanded + +• `Optional` **expanded**: `boolean` + +#### Defined in + +[packages/components/src/table/table-row.tsx:33](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/table/table-row.tsx#L33) + +--- + +### selected + +• `Optional` **selected**: `boolean` + +#### Defined in + +[packages/components/src/table/table-row.tsx:32](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/table/table-row.tsx#L32) diff --git a/packages/next-docs/pages/components/table/props.mdx b/packages/next-docs/pages/components/table/props.mdx new file mode 100644 index 0000000000..a6aeec1e7e --- /dev/null +++ b/packages/next-docs/pages/components/table/props.mdx @@ -0,0 +1,119 @@ +# TableProps + +## Hierarchy + +- `ComponentPropsWithoutRef`\<`"div"`\> + + ↳ **`TableProps`** + + ↳↳ [`SimpleTableProps`](SimpleTableProps.md) + +## Table of contents + +### Properties + +- [asChild](TableProps.md#aschild) +- [columnWidths](TableProps.md#columnwidths) +- [density](TableProps.md#density) +- [stickyColumn](TableProps.md#stickycolumn) +- [stickyHeader](TableProps.md#stickyheader) + +## Properties + +### asChild + +• `Optional` **asChild**: `boolean` + +If true, the Table component will be rendered as a child of the Compose component + +**`Default`** + +```ts +false; +``` + +#### Defined in + +[packages/components/src/table/table.tsx:59](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/table/table.tsx#L59) + +--- + +### columnWidths + +• `Optional` **columnWidths**: `string`[] + +Array of column widths + +When using the Table component + +**`Default`** + +```ts +[] + +When using the SimpleTable component +``` + +**`Default`** + +```ts +[repeat(${columns.length}, var(--sl-table-default-column-width))] +``` + +#### Defined in + +[packages/components/src/table/table.tsx:54](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/table/table.tsx#L54) + +--- + +### density + +• `Optional` **density**: `"default"` \| `"comfortable"` \| `"compact"` + +The density of the table + +**`Default`** + +```ts +"default"; +``` + +#### Defined in + +[packages/components/src/table/table.tsx:74](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/table/table.tsx#L74) + +--- + +### stickyColumn + +• `Optional` **stickyColumn**: `boolean` + +If true, the first column will be sticky + +**`Default`** + +```ts +false; +``` + +#### Defined in + +[packages/components/src/table/table.tsx:69](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/table/table.tsx#L69) + +--- + +### stickyHeader + +• `Optional` **stickyHeader**: `boolean` + +If true, the header will be sticky + +**`Default`** + +```ts +false; +``` + +#### Defined in + +[packages/components/src/table/table.tsx:64](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/table/table.tsx#L64) diff --git a/packages/next-docs/pages/components/tag/props.mdx b/packages/next-docs/pages/components/tag/props.mdx new file mode 100644 index 0000000000..92ef702dd6 --- /dev/null +++ b/packages/next-docs/pages/components/tag/props.mdx @@ -0,0 +1,49 @@ +# TagProps + +## Hierarchy + +- `ComponentPropsWithoutRef`\<`"div"`\> + + ↳ **`TagProps`** + +## Table of contents + +### Properties + +- [color](TagProps.md#color) +- [size](TagProps.md#size) +- [variant](TagProps.md#variant) + +## Properties + +### color + +• `Optional` **color**: `"blue"` \| `"cyan"` \| `"gray"` \| `"green"` \| `"orange"` \| `"pink"` \| `"purple"` \| `"red"` \| `"teal"` \| `"yellow"` + +#### Overrides + +ComponentPropsWithoutRef.color + +#### Defined in + +[packages/components/src/tag/tag.tsx:33](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/tag/tag.tsx#L33) + +--- + +### size + +• `Optional` **size**: `"normal"` \| `"large"` + +#### Defined in + +[packages/components/src/tag/tag.tsx:44](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/tag/tag.tsx#L44) + +--- + +### variant + +• `Optional` **variant**: `"primary"` \| `"secondary"` + +#### Defined in + +[packages/components/src/tag/tag.tsx:32](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/tag/tag.tsx#L32) diff --git a/packages/next-docs/pages/components/text-input/props.mdx b/packages/next-docs/pages/components/text-input/props.mdx new file mode 100644 index 0000000000..30bf242095 --- /dev/null +++ b/packages/next-docs/pages/components/text-input/props.mdx @@ -0,0 +1,113 @@ +# TextInputProps + +## Hierarchy + +- `Omit`\<`ComponentPropsWithoutRef`\<`"input"`\>, `"prefix"`\> + + ↳ **`TextInputProps`** + +## Table of contents + +### Properties + +- [disabled](TextInputProps.md#disabled) +- [error](TextInputProps.md#error) +- [errorText](TextInputProps.md#errortext) +- [helpText](TextInputProps.md#helptext) +- [label](TextInputProps.md#label) +- [prefix](TextInputProps.md#prefix) +- [suffix](TextInputProps.md#suffix) + +## Properties + +### disabled + +• `Optional` **disabled**: `boolean` + +Whether is disabled or not + +**`Default`** + +```ts +false; +``` + +#### Overrides + +Omit.disabled + +#### Defined in + +[packages/components/src/text-input/text-input.tsx:67](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/text-input/text-input.tsx#L67) + +--- + +### error + +• `Optional` **error**: `boolean` + +Whether there is an error + +**`Default`** + +```ts +false; +``` + +#### Defined in + +[packages/components/src/text-input/text-input.tsx:62](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/text-input/text-input.tsx#L62) + +--- + +### errorText + +• `Optional` **errorText**: `string` + +#### Defined in + +[packages/components/src/text-input/text-input.tsx:77](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/text-input/text-input.tsx#L77) + +--- + +### helpText + +• `Optional` **helpText**: `string` + +#### Defined in + +[packages/components/src/text-input/text-input.tsx:78](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/text-input/text-input.tsx#L78) + +--- + +### label + +• **label**: `string` + +#### Defined in + +[packages/components/src/text-input/text-input.tsx:76](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/text-input/text-input.tsx#L76) + +--- + +### prefix + +• `Optional` **prefix**: `ReactNode` + +Node added before input space + +#### Defined in + +[packages/components/src/text-input/text-input.tsx:71](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/text-input/text-input.tsx#L71) + +--- + +### suffix + +• `Optional` **suffix**: `ReactNode` + +Node added before input space + +#### Defined in + +[packages/components/src/text-input/text-input.tsx:75](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/text-input/text-input.tsx#L75) diff --git a/packages/next-docs/pages/components/text/code.mdx b/packages/next-docs/pages/components/text/code.mdx index 2e42f0037c..926ac608c7 100644 --- a/packages/next-docs/pages/components/text/code.mdx +++ b/packages/next-docs/pages/components/text/code.mdx @@ -6,280 +6,11 @@ #### Parameters -| Name | Type | Description | -| :-------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `props` | `Object` | - | -| `props.about?` | `string` | - | -| `props.accessKey?` | `string` | - | -| `props.aria-activedescendant?` | `string` | Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. | -| `props.aria-atomic?` | `Booleanish` | Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute. | -| `props.aria-autocomplete?` | `"list"` \| `"none"` \| `"inline"` \| `"both"` | Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made. | -| `props.aria-braillelabel?` | `string` | Defines a string value that labels the current element, which is intended to be converted into Braille. **`See`** aria-label. | -| `props.aria-brailleroledescription?` | `string` | Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille. **`See`** aria-roledescription. | -| `props.aria-busy?` | `Booleanish` | - | -| `props.aria-checked?` | `boolean` \| `"true"` \| `"false"` \| `"mixed"` | Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. **`See`** - aria-pressed - aria-selected. | -| `props.aria-colcount?` | `number` | Defines the total number of columns in a table, grid, or treegrid. **`See`** aria-colindex. | -| `props.aria-colindex?` | `number` | Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid. **`See`** - aria-colcount - aria-colspan. | -| `props.aria-colindextext?` | `string` | Defines a human readable text alternative of aria-colindex. **`See`** aria-rowindextext. | -| `props.aria-colspan?` | `number` | Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. **`See`** - aria-colindex - aria-rowspan. | -| `props.aria-controls?` | `string` | Identifies the element (or elements) whose contents or presence are controlled by the current element. **`See`** aria-owns. | -| `props.aria-current?` | `boolean` \| `"time"` \| `"true"` \| `"false"` \| `"page"` \| `"step"` \| `"location"` \| `"date"` | Indicates the element that represents the current item within a container or set of related elements. | -| `props.aria-describedby?` | `string` | Identifies the element (or elements) that describes the object. **`See`** aria-labelledby | -| `props.aria-description?` | `string` | Defines a string value that describes or annotates the current element. **`See`** related aria-describedby. | -| `props.aria-details?` | `string` | Identifies the element that provides a detailed, extended description for the object. **`See`** aria-describedby. | -| `props.aria-disabled?` | `Booleanish` | Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. **`See`** - aria-hidden - aria-readonly. | -| `props.aria-dropeffect?` | `"link"` \| `"none"` \| `"copy"` \| `"execute"` \| `"move"` \| `"popup"` | Indicates what functions can be performed when a dragged object is released on the drop target. **`Deprecated`** in ARIA 1.1 | -| `props.aria-errormessage?` | `string` | Identifies the element that provides an error message for the object. **`See`** - aria-invalid - aria-describedby. | -| `props.aria-expanded?` | `Booleanish` | Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. | -| `props.aria-flowto?` | `string` | Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order. | -| `props.aria-grabbed?` | `Booleanish` | Indicates an element's "grabbed" state in a drag-and-drop operation. **`Deprecated`** in ARIA 1.1 | -| `props.aria-haspopup?` | `boolean` \| `"dialog"` \| `"menu"` \| `"true"` \| `"false"` \| `"grid"` \| `"listbox"` \| `"tree"` | Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element. | -| `props.aria-hidden?` | `Booleanish` | Indicates whether the element is exposed to an accessibility API. **`See`** aria-disabled. | -| `props.aria-invalid?` | `boolean` \| `"true"` \| `"false"` \| `"grammar"` \| `"spelling"` | Indicates the entered value does not conform to the format expected by the application. **`See`** aria-errormessage. | -| `props.aria-keyshortcuts?` | `string` | Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. | -| `props.aria-label?` | `string` | Defines a string value that labels the current element. **`See`** aria-labelledby. | -| `props.aria-labelledby?` | `string` | Identifies the element (or elements) that labels the current element. **`See`** aria-describedby. | -| `props.aria-level?` | `number` | Defines the hierarchical level of an element within a structure. | -| `props.aria-live?` | `"off"` \| `"assertive"` \| `"polite"` | Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region. | -| `props.aria-modal?` | `Booleanish` | Indicates whether an element is modal when displayed. | -| `props.aria-multiline?` | `Booleanish` | Indicates whether a text box accepts multiple lines of input or only a single line. | -| `props.aria-multiselectable?` | `Booleanish` | Indicates that the user may select more than one item from the current selectable descendants. | -| `props.aria-orientation?` | `"horizontal"` \| `"vertical"` | Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous. | -| `props.aria-owns?` | `string` | Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship. **`See`** aria-controls. | -| `props.aria-placeholder?` | `string` | Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format. | -| `props.aria-posinset?` | `number` | Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. **`See`** aria-setsize. | -| `props.aria-pressed?` | `boolean` \| `"true"` \| `"false"` \| `"mixed"` | Indicates the current "pressed" state of toggle buttons. **`See`** - aria-checked - aria-selected. | -| `props.aria-readonly?` | `Booleanish` | Indicates that the element is not editable, but is otherwise operable. **`See`** aria-disabled. | -| `props.aria-relevant?` | `"text"` \| `"additions"` \| `"additions removals"` \| `"additions text"` \| `"all"` \| `"removals"` \| `"removals additions"` \| `"removals text"` \| `"text additions"` \| `"text removals"` | Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. **`See`** aria-atomic. | -| `props.aria-required?` | `Booleanish` | Indicates that user input is required on the element before a form may be submitted. | -| `props.aria-roledescription?` | `string` | Defines a human-readable, author-localized description for the role of an element. | -| `props.aria-rowcount?` | `number` | Defines the total number of rows in a table, grid, or treegrid. **`See`** aria-rowindex. | -| `props.aria-rowindex?` | `number` | Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid. **`See`** - aria-rowcount - aria-rowspan. | -| `props.aria-rowindextext?` | `string` | Defines a human readable text alternative of aria-rowindex. **`See`** aria-colindextext. | -| `props.aria-rowspan?` | `number` | Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. **`See`** - aria-rowindex - aria-colspan. | -| `props.aria-selected?` | `Booleanish` | Indicates the current "selected" state of various widgets. **`See`** - aria-checked - aria-pressed. | -| `props.aria-setsize?` | `number` | Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. **`See`** aria-posinset. | -| `props.aria-sort?` | `"none"` \| `"ascending"` \| `"descending"` \| `"other"` | Indicates if items in a table or grid are sorted in ascending or descending order. | -| `props.aria-valuemax?` | `number` | Defines the maximum allowed value for a range widget. | -| `props.aria-valuemin?` | `number` | Defines the minimum allowed value for a range widget. | -| `props.aria-valuenow?` | `number` | Defines the current value for a range widget. **`See`** aria-valuetext. | -| `props.aria-valuetext?` | `string` | Defines the human readable text alternative of aria-valuenow for a range widget. | -| `props.as?` | `"div"` \| `"h1"` \| `"h2"` \| `"h3"` \| `"h4"` \| `"h5"` \| `"h6"` \| `"label"` \| `"p"` \| `"span"` | - | -| `props.autoCapitalize?` | `string` | - | -| `props.autoCorrect?` | `string` | - | -| `props.autoFocus?` | `boolean` | - | -| `props.autoSave?` | `string` | - | -| `props.children?` | `ReactNode` | - | -| `props.className?` | `string` | - | -| `props.color?` | `string` | - | -| `props.content?` | `string` | - | -| `props.contentEditable?` | `Booleanish` \| `"inherit"` | - | -| `props.contextMenu?` | `string` | - | -| `props.dangerouslySetInnerHTML?` | `Object` | - | -| `props.dangerouslySetInnerHTML.__html` | `string` \| `TrustedHTML` | - | -| `props.datatype?` | `string` | - | -| `props.defaultChecked?` | `boolean` | - | -| `props.defaultValue?` | `string` \| `number` \| readonly `string`[] | - | -| `props.dir?` | `string` | - | -| `props.draggable?` | `Booleanish` | - | -| `props.hidden?` | `boolean` | - | -| `props.id?` | `string` | - | -| `props.inlist?` | `any` | - | -| `props.inputMode?` | `"search"` \| `"text"` \| `"none"` \| `"tel"` \| `"url"` \| `"email"` \| `"numeric"` \| `"decimal"` | Hints at the type of data that might be entered by the user while editing the element or its contents **`See`** https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute | -| `props.is?` | `string` | Specify that a standard HTML element should behave like a defined custom built-in element **`See`** https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is | -| `props.itemID?` | `string` | - | -| `props.itemProp?` | `string` | - | -| `props.itemRef?` | `string` | - | -| `props.itemScope?` | `boolean` | - | -| `props.itemType?` | `string` | - | -| `props.key?` | `null` \| `Key` | - | -| `props.lang?` | `string` | - | -| `props.nonce?` | `string` | - | -| `props.onAbort?` | `ReactEventHandler`\<`HTMLDivElement`\> \| `ReactEventHandler`\<`HTMLSpanElement`\> \| `ReactEventHandler`\<`HTMLHeadingElement`\> \| `ReactEventHandler`\<`HTMLParagraphElement`\> \| `ReactEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onAbortCapture?` | `ReactEventHandler`\<`HTMLDivElement`\> \| `ReactEventHandler`\<`HTMLSpanElement`\> \| `ReactEventHandler`\<`HTMLHeadingElement`\> \| `ReactEventHandler`\<`HTMLParagraphElement`\> \| `ReactEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onAnimationEnd?` | `AnimationEventHandler`\<`HTMLDivElement`\> \| `AnimationEventHandler`\<`HTMLSpanElement`\> \| `AnimationEventHandler`\<`HTMLHeadingElement`\> \| `AnimationEventHandler`\<`HTMLParagraphElement`\> \| `AnimationEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onAnimationEndCapture?` | `AnimationEventHandler`\<`HTMLDivElement`\> \| `AnimationEventHandler`\<`HTMLSpanElement`\> \| `AnimationEventHandler`\<`HTMLHeadingElement`\> \| `AnimationEventHandler`\<`HTMLParagraphElement`\> \| `AnimationEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onAnimationIteration?` | `AnimationEventHandler`\<`HTMLDivElement`\> \| `AnimationEventHandler`\<`HTMLSpanElement`\> \| `AnimationEventHandler`\<`HTMLHeadingElement`\> \| `AnimationEventHandler`\<`HTMLParagraphElement`\> \| `AnimationEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onAnimationIterationCapture?` | `AnimationEventHandler`\<`HTMLDivElement`\> \| `AnimationEventHandler`\<`HTMLSpanElement`\> \| `AnimationEventHandler`\<`HTMLHeadingElement`\> \| `AnimationEventHandler`\<`HTMLParagraphElement`\> \| `AnimationEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onAnimationStart?` | `AnimationEventHandler`\<`HTMLDivElement`\> \| `AnimationEventHandler`\<`HTMLSpanElement`\> \| `AnimationEventHandler`\<`HTMLHeadingElement`\> \| `AnimationEventHandler`\<`HTMLParagraphElement`\> \| `AnimationEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onAnimationStartCapture?` | `AnimationEventHandler`\<`HTMLDivElement`\> \| `AnimationEventHandler`\<`HTMLSpanElement`\> \| `AnimationEventHandler`\<`HTMLHeadingElement`\> \| `AnimationEventHandler`\<`HTMLParagraphElement`\> \| `AnimationEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onAuxClick?` | `MouseEventHandler`\<`HTMLDivElement`\> \| `MouseEventHandler`\<`HTMLSpanElement`\> \| `MouseEventHandler`\<`HTMLHeadingElement`\> \| `MouseEventHandler`\<`HTMLParagraphElement`\> \| `MouseEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onAuxClickCapture?` | `MouseEventHandler`\<`HTMLDivElement`\> \| `MouseEventHandler`\<`HTMLSpanElement`\> \| `MouseEventHandler`\<`HTMLHeadingElement`\> \| `MouseEventHandler`\<`HTMLParagraphElement`\> \| `MouseEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onBeforeInput?` | `FormEventHandler`\<`HTMLDivElement`\> \| `FormEventHandler`\<`HTMLSpanElement`\> \| `FormEventHandler`\<`HTMLHeadingElement`\> \| `FormEventHandler`\<`HTMLParagraphElement`\> \| `FormEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onBeforeInputCapture?` | `FormEventHandler`\<`HTMLDivElement`\> \| `FormEventHandler`\<`HTMLSpanElement`\> \| `FormEventHandler`\<`HTMLHeadingElement`\> \| `FormEventHandler`\<`HTMLParagraphElement`\> \| `FormEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onBlur?` | `FocusEventHandler`\<`HTMLDivElement`\> \| `FocusEventHandler`\<`HTMLSpanElement`\> \| `FocusEventHandler`\<`HTMLHeadingElement`\> \| `FocusEventHandler`\<`HTMLParagraphElement`\> \| `FocusEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onBlurCapture?` | `FocusEventHandler`\<`HTMLDivElement`\> \| `FocusEventHandler`\<`HTMLSpanElement`\> \| `FocusEventHandler`\<`HTMLHeadingElement`\> \| `FocusEventHandler`\<`HTMLParagraphElement`\> \| `FocusEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onCanPlay?` | `ReactEventHandler`\<`HTMLDivElement`\> \| `ReactEventHandler`\<`HTMLSpanElement`\> \| `ReactEventHandler`\<`HTMLHeadingElement`\> \| `ReactEventHandler`\<`HTMLParagraphElement`\> \| `ReactEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onCanPlayCapture?` | `ReactEventHandler`\<`HTMLDivElement`\> \| `ReactEventHandler`\<`HTMLSpanElement`\> \| `ReactEventHandler`\<`HTMLHeadingElement`\> \| `ReactEventHandler`\<`HTMLParagraphElement`\> \| `ReactEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onCanPlayThrough?` | `ReactEventHandler`\<`HTMLDivElement`\> \| `ReactEventHandler`\<`HTMLSpanElement`\> \| `ReactEventHandler`\<`HTMLHeadingElement`\> \| `ReactEventHandler`\<`HTMLParagraphElement`\> \| `ReactEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onCanPlayThroughCapture?` | `ReactEventHandler`\<`HTMLDivElement`\> \| `ReactEventHandler`\<`HTMLSpanElement`\> \| `ReactEventHandler`\<`HTMLHeadingElement`\> \| `ReactEventHandler`\<`HTMLParagraphElement`\> \| `ReactEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onChange?` | `FormEventHandler`\<`HTMLDivElement`\> \| `FormEventHandler`\<`HTMLSpanElement`\> \| `FormEventHandler`\<`HTMLHeadingElement`\> \| `FormEventHandler`\<`HTMLParagraphElement`\> \| `FormEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onChangeCapture?` | `FormEventHandler`\<`HTMLDivElement`\> \| `FormEventHandler`\<`HTMLSpanElement`\> \| `FormEventHandler`\<`HTMLHeadingElement`\> \| `FormEventHandler`\<`HTMLParagraphElement`\> \| `FormEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onClick?` | `MouseEventHandler`\<`HTMLDivElement`\> \| `MouseEventHandler`\<`HTMLSpanElement`\> \| `MouseEventHandler`\<`HTMLHeadingElement`\> \| `MouseEventHandler`\<`HTMLParagraphElement`\> \| `MouseEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onClickCapture?` | `MouseEventHandler`\<`HTMLDivElement`\> \| `MouseEventHandler`\<`HTMLSpanElement`\> \| `MouseEventHandler`\<`HTMLHeadingElement`\> \| `MouseEventHandler`\<`HTMLParagraphElement`\> \| `MouseEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onCompositionEnd?` | `CompositionEventHandler`\<`HTMLDivElement`\> \| `CompositionEventHandler`\<`HTMLSpanElement`\> \| `CompositionEventHandler`\<`HTMLHeadingElement`\> \| `CompositionEventHandler`\<`HTMLParagraphElement`\> \| `CompositionEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onCompositionEndCapture?` | `CompositionEventHandler`\<`HTMLDivElement`\> \| `CompositionEventHandler`\<`HTMLSpanElement`\> \| `CompositionEventHandler`\<`HTMLHeadingElement`\> \| `CompositionEventHandler`\<`HTMLParagraphElement`\> \| `CompositionEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onCompositionStart?` | `CompositionEventHandler`\<`HTMLDivElement`\> \| `CompositionEventHandler`\<`HTMLSpanElement`\> \| `CompositionEventHandler`\<`HTMLHeadingElement`\> \| `CompositionEventHandler`\<`HTMLParagraphElement`\> \| `CompositionEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onCompositionStartCapture?` | `CompositionEventHandler`\<`HTMLDivElement`\> \| `CompositionEventHandler`\<`HTMLSpanElement`\> \| `CompositionEventHandler`\<`HTMLHeadingElement`\> \| `CompositionEventHandler`\<`HTMLParagraphElement`\> \| `CompositionEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onCompositionUpdate?` | `CompositionEventHandler`\<`HTMLDivElement`\> \| `CompositionEventHandler`\<`HTMLSpanElement`\> \| `CompositionEventHandler`\<`HTMLHeadingElement`\> \| `CompositionEventHandler`\<`HTMLParagraphElement`\> \| `CompositionEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onCompositionUpdateCapture?` | `CompositionEventHandler`\<`HTMLDivElement`\> \| `CompositionEventHandler`\<`HTMLSpanElement`\> \| `CompositionEventHandler`\<`HTMLHeadingElement`\> \| `CompositionEventHandler`\<`HTMLParagraphElement`\> \| `CompositionEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onContextMenu?` | `MouseEventHandler`\<`HTMLDivElement`\> \| `MouseEventHandler`\<`HTMLSpanElement`\> \| `MouseEventHandler`\<`HTMLHeadingElement`\> \| `MouseEventHandler`\<`HTMLParagraphElement`\> \| `MouseEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onContextMenuCapture?` | `MouseEventHandler`\<`HTMLDivElement`\> \| `MouseEventHandler`\<`HTMLSpanElement`\> \| `MouseEventHandler`\<`HTMLHeadingElement`\> \| `MouseEventHandler`\<`HTMLParagraphElement`\> \| `MouseEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onCopy?` | `ClipboardEventHandler`\<`HTMLDivElement`\> \| `ClipboardEventHandler`\<`HTMLSpanElement`\> \| `ClipboardEventHandler`\<`HTMLHeadingElement`\> \| `ClipboardEventHandler`\<`HTMLParagraphElement`\> \| `ClipboardEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onCopyCapture?` | `ClipboardEventHandler`\<`HTMLDivElement`\> \| `ClipboardEventHandler`\<`HTMLSpanElement`\> \| `ClipboardEventHandler`\<`HTMLHeadingElement`\> \| `ClipboardEventHandler`\<`HTMLParagraphElement`\> \| `ClipboardEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onCut?` | `ClipboardEventHandler`\<`HTMLDivElement`\> \| `ClipboardEventHandler`\<`HTMLSpanElement`\> \| `ClipboardEventHandler`\<`HTMLHeadingElement`\> \| `ClipboardEventHandler`\<`HTMLParagraphElement`\> \| `ClipboardEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onCutCapture?` | `ClipboardEventHandler`\<`HTMLDivElement`\> \| `ClipboardEventHandler`\<`HTMLSpanElement`\> \| `ClipboardEventHandler`\<`HTMLHeadingElement`\> \| `ClipboardEventHandler`\<`HTMLParagraphElement`\> \| `ClipboardEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onDoubleClick?` | `MouseEventHandler`\<`HTMLDivElement`\> \| `MouseEventHandler`\<`HTMLSpanElement`\> \| `MouseEventHandler`\<`HTMLHeadingElement`\> \| `MouseEventHandler`\<`HTMLParagraphElement`\> \| `MouseEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onDoubleClickCapture?` | `MouseEventHandler`\<`HTMLDivElement`\> \| `MouseEventHandler`\<`HTMLSpanElement`\> \| `MouseEventHandler`\<`HTMLHeadingElement`\> \| `MouseEventHandler`\<`HTMLParagraphElement`\> \| `MouseEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onDrag?` | `DragEventHandler`\<`HTMLDivElement`\> \| `DragEventHandler`\<`HTMLSpanElement`\> \| `DragEventHandler`\<`HTMLHeadingElement`\> \| `DragEventHandler`\<`HTMLParagraphElement`\> \| `DragEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onDragCapture?` | `DragEventHandler`\<`HTMLDivElement`\> \| `DragEventHandler`\<`HTMLSpanElement`\> \| `DragEventHandler`\<`HTMLHeadingElement`\> \| `DragEventHandler`\<`HTMLParagraphElement`\> \| `DragEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onDragEnd?` | `DragEventHandler`\<`HTMLDivElement`\> \| `DragEventHandler`\<`HTMLSpanElement`\> \| `DragEventHandler`\<`HTMLHeadingElement`\> \| `DragEventHandler`\<`HTMLParagraphElement`\> \| `DragEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onDragEndCapture?` | `DragEventHandler`\<`HTMLDivElement`\> \| `DragEventHandler`\<`HTMLSpanElement`\> \| `DragEventHandler`\<`HTMLHeadingElement`\> \| `DragEventHandler`\<`HTMLParagraphElement`\> \| `DragEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onDragEnter?` | `DragEventHandler`\<`HTMLDivElement`\> \| `DragEventHandler`\<`HTMLSpanElement`\> \| `DragEventHandler`\<`HTMLHeadingElement`\> \| `DragEventHandler`\<`HTMLParagraphElement`\> \| `DragEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onDragEnterCapture?` | `DragEventHandler`\<`HTMLDivElement`\> \| `DragEventHandler`\<`HTMLSpanElement`\> \| `DragEventHandler`\<`HTMLHeadingElement`\> \| `DragEventHandler`\<`HTMLParagraphElement`\> \| `DragEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onDragExit?` | `DragEventHandler`\<`HTMLDivElement`\> \| `DragEventHandler`\<`HTMLSpanElement`\> \| `DragEventHandler`\<`HTMLHeadingElement`\> \| `DragEventHandler`\<`HTMLParagraphElement`\> \| `DragEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onDragExitCapture?` | `DragEventHandler`\<`HTMLDivElement`\> \| `DragEventHandler`\<`HTMLSpanElement`\> \| `DragEventHandler`\<`HTMLHeadingElement`\> \| `DragEventHandler`\<`HTMLParagraphElement`\> \| `DragEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onDragLeave?` | `DragEventHandler`\<`HTMLDivElement`\> \| `DragEventHandler`\<`HTMLSpanElement`\> \| `DragEventHandler`\<`HTMLHeadingElement`\> \| `DragEventHandler`\<`HTMLParagraphElement`\> \| `DragEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onDragLeaveCapture?` | `DragEventHandler`\<`HTMLDivElement`\> \| `DragEventHandler`\<`HTMLSpanElement`\> \| `DragEventHandler`\<`HTMLHeadingElement`\> \| `DragEventHandler`\<`HTMLParagraphElement`\> \| `DragEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onDragOver?` | `DragEventHandler`\<`HTMLDivElement`\> \| `DragEventHandler`\<`HTMLSpanElement`\> \| `DragEventHandler`\<`HTMLHeadingElement`\> \| `DragEventHandler`\<`HTMLParagraphElement`\> \| `DragEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onDragOverCapture?` | `DragEventHandler`\<`HTMLDivElement`\> \| `DragEventHandler`\<`HTMLSpanElement`\> \| `DragEventHandler`\<`HTMLHeadingElement`\> \| `DragEventHandler`\<`HTMLParagraphElement`\> \| `DragEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onDragStart?` | `DragEventHandler`\<`HTMLDivElement`\> \| `DragEventHandler`\<`HTMLSpanElement`\> \| `DragEventHandler`\<`HTMLHeadingElement`\> \| `DragEventHandler`\<`HTMLParagraphElement`\> \| `DragEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onDragStartCapture?` | `DragEventHandler`\<`HTMLDivElement`\> \| `DragEventHandler`\<`HTMLSpanElement`\> \| `DragEventHandler`\<`HTMLHeadingElement`\> \| `DragEventHandler`\<`HTMLParagraphElement`\> \| `DragEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onDrop?` | `DragEventHandler`\<`HTMLDivElement`\> \| `DragEventHandler`\<`HTMLSpanElement`\> \| `DragEventHandler`\<`HTMLHeadingElement`\> \| `DragEventHandler`\<`HTMLParagraphElement`\> \| `DragEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onDropCapture?` | `DragEventHandler`\<`HTMLDivElement`\> \| `DragEventHandler`\<`HTMLSpanElement`\> \| `DragEventHandler`\<`HTMLHeadingElement`\> \| `DragEventHandler`\<`HTMLParagraphElement`\> \| `DragEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onDurationChange?` | `ReactEventHandler`\<`HTMLDivElement`\> \| `ReactEventHandler`\<`HTMLSpanElement`\> \| `ReactEventHandler`\<`HTMLHeadingElement`\> \| `ReactEventHandler`\<`HTMLParagraphElement`\> \| `ReactEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onDurationChangeCapture?` | `ReactEventHandler`\<`HTMLDivElement`\> \| `ReactEventHandler`\<`HTMLSpanElement`\> \| `ReactEventHandler`\<`HTMLHeadingElement`\> \| `ReactEventHandler`\<`HTMLParagraphElement`\> \| `ReactEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onEmptied?` | `ReactEventHandler`\<`HTMLDivElement`\> \| `ReactEventHandler`\<`HTMLSpanElement`\> \| `ReactEventHandler`\<`HTMLHeadingElement`\> \| `ReactEventHandler`\<`HTMLParagraphElement`\> \| `ReactEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onEmptiedCapture?` | `ReactEventHandler`\<`HTMLDivElement`\> \| `ReactEventHandler`\<`HTMLSpanElement`\> \| `ReactEventHandler`\<`HTMLHeadingElement`\> \| `ReactEventHandler`\<`HTMLParagraphElement`\> \| `ReactEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onEncrypted?` | `ReactEventHandler`\<`HTMLDivElement`\> \| `ReactEventHandler`\<`HTMLSpanElement`\> \| `ReactEventHandler`\<`HTMLHeadingElement`\> \| `ReactEventHandler`\<`HTMLParagraphElement`\> \| `ReactEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onEncryptedCapture?` | `ReactEventHandler`\<`HTMLDivElement`\> \| `ReactEventHandler`\<`HTMLSpanElement`\> \| `ReactEventHandler`\<`HTMLHeadingElement`\> \| `ReactEventHandler`\<`HTMLParagraphElement`\> \| `ReactEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onEnded?` | `ReactEventHandler`\<`HTMLDivElement`\> \| `ReactEventHandler`\<`HTMLSpanElement`\> \| `ReactEventHandler`\<`HTMLHeadingElement`\> \| `ReactEventHandler`\<`HTMLParagraphElement`\> \| `ReactEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onEndedCapture?` | `ReactEventHandler`\<`HTMLDivElement`\> \| `ReactEventHandler`\<`HTMLSpanElement`\> \| `ReactEventHandler`\<`HTMLHeadingElement`\> \| `ReactEventHandler`\<`HTMLParagraphElement`\> \| `ReactEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onError?` | `ReactEventHandler`\<`HTMLDivElement`\> \| `ReactEventHandler`\<`HTMLSpanElement`\> \| `ReactEventHandler`\<`HTMLHeadingElement`\> \| `ReactEventHandler`\<`HTMLParagraphElement`\> \| `ReactEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onErrorCapture?` | `ReactEventHandler`\<`HTMLDivElement`\> \| `ReactEventHandler`\<`HTMLSpanElement`\> \| `ReactEventHandler`\<`HTMLHeadingElement`\> \| `ReactEventHandler`\<`HTMLParagraphElement`\> \| `ReactEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onFocus?` | `FocusEventHandler`\<`HTMLDivElement`\> \| `FocusEventHandler`\<`HTMLSpanElement`\> \| `FocusEventHandler`\<`HTMLHeadingElement`\> \| `FocusEventHandler`\<`HTMLParagraphElement`\> \| `FocusEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onFocusCapture?` | `FocusEventHandler`\<`HTMLDivElement`\> \| `FocusEventHandler`\<`HTMLSpanElement`\> \| `FocusEventHandler`\<`HTMLHeadingElement`\> \| `FocusEventHandler`\<`HTMLParagraphElement`\> \| `FocusEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onGotPointerCapture?` | `PointerEventHandler`\<`HTMLDivElement`\> \| `PointerEventHandler`\<`HTMLSpanElement`\> \| `PointerEventHandler`\<`HTMLHeadingElement`\> \| `PointerEventHandler`\<`HTMLParagraphElement`\> \| `PointerEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onGotPointerCaptureCapture?` | `PointerEventHandler`\<`HTMLDivElement`\> \| `PointerEventHandler`\<`HTMLSpanElement`\> \| `PointerEventHandler`\<`HTMLHeadingElement`\> \| `PointerEventHandler`\<`HTMLParagraphElement`\> \| `PointerEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onInput?` | `FormEventHandler`\<`HTMLDivElement`\> \| `FormEventHandler`\<`HTMLSpanElement`\> \| `FormEventHandler`\<`HTMLHeadingElement`\> \| `FormEventHandler`\<`HTMLParagraphElement`\> \| `FormEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onInputCapture?` | `FormEventHandler`\<`HTMLDivElement`\> \| `FormEventHandler`\<`HTMLSpanElement`\> \| `FormEventHandler`\<`HTMLHeadingElement`\> \| `FormEventHandler`\<`HTMLParagraphElement`\> \| `FormEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onInvalid?` | `FormEventHandler`\<`HTMLDivElement`\> \| `FormEventHandler`\<`HTMLSpanElement`\> \| `FormEventHandler`\<`HTMLHeadingElement`\> \| `FormEventHandler`\<`HTMLParagraphElement`\> \| `FormEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onInvalidCapture?` | `FormEventHandler`\<`HTMLDivElement`\> \| `FormEventHandler`\<`HTMLSpanElement`\> \| `FormEventHandler`\<`HTMLHeadingElement`\> \| `FormEventHandler`\<`HTMLParagraphElement`\> \| `FormEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onKeyDown?` | `KeyboardEventHandler`\<`HTMLDivElement`\> \| `KeyboardEventHandler`\<`HTMLSpanElement`\> \| `KeyboardEventHandler`\<`HTMLHeadingElement`\> \| `KeyboardEventHandler`\<`HTMLParagraphElement`\> \| `KeyboardEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onKeyDownCapture?` | `KeyboardEventHandler`\<`HTMLDivElement`\> \| `KeyboardEventHandler`\<`HTMLSpanElement`\> \| `KeyboardEventHandler`\<`HTMLHeadingElement`\> \| `KeyboardEventHandler`\<`HTMLParagraphElement`\> \| `KeyboardEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onKeyPress?` | `KeyboardEventHandler`\<`HTMLDivElement`\> \| `KeyboardEventHandler`\<`HTMLSpanElement`\> \| `KeyboardEventHandler`\<`HTMLHeadingElement`\> \| `KeyboardEventHandler`\<`HTMLParagraphElement`\> \| `KeyboardEventHandler`\<`HTMLLabelElement`\> | **`Deprecated`** | -| `props.onKeyPressCapture?` | `KeyboardEventHandler`\<`HTMLDivElement`\> \| `KeyboardEventHandler`\<`HTMLSpanElement`\> \| `KeyboardEventHandler`\<`HTMLHeadingElement`\> \| `KeyboardEventHandler`\<`HTMLParagraphElement`\> \| `KeyboardEventHandler`\<`HTMLLabelElement`\> | **`Deprecated`** | -| `props.onKeyUp?` | `KeyboardEventHandler`\<`HTMLDivElement`\> \| `KeyboardEventHandler`\<`HTMLSpanElement`\> \| `KeyboardEventHandler`\<`HTMLHeadingElement`\> \| `KeyboardEventHandler`\<`HTMLParagraphElement`\> \| `KeyboardEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onKeyUpCapture?` | `KeyboardEventHandler`\<`HTMLDivElement`\> \| `KeyboardEventHandler`\<`HTMLSpanElement`\> \| `KeyboardEventHandler`\<`HTMLHeadingElement`\> \| `KeyboardEventHandler`\<`HTMLParagraphElement`\> \| `KeyboardEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onLoad?` | `ReactEventHandler`\<`HTMLDivElement`\> \| `ReactEventHandler`\<`HTMLSpanElement`\> \| `ReactEventHandler`\<`HTMLHeadingElement`\> \| `ReactEventHandler`\<`HTMLParagraphElement`\> \| `ReactEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onLoadCapture?` | `ReactEventHandler`\<`HTMLDivElement`\> \| `ReactEventHandler`\<`HTMLSpanElement`\> \| `ReactEventHandler`\<`HTMLHeadingElement`\> \| `ReactEventHandler`\<`HTMLParagraphElement`\> \| `ReactEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onLoadStart?` | `ReactEventHandler`\<`HTMLDivElement`\> \| `ReactEventHandler`\<`HTMLSpanElement`\> \| `ReactEventHandler`\<`HTMLHeadingElement`\> \| `ReactEventHandler`\<`HTMLParagraphElement`\> \| `ReactEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onLoadStartCapture?` | `ReactEventHandler`\<`HTMLDivElement`\> \| `ReactEventHandler`\<`HTMLSpanElement`\> \| `ReactEventHandler`\<`HTMLHeadingElement`\> \| `ReactEventHandler`\<`HTMLParagraphElement`\> \| `ReactEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onLoadedData?` | `ReactEventHandler`\<`HTMLDivElement`\> \| `ReactEventHandler`\<`HTMLSpanElement`\> \| `ReactEventHandler`\<`HTMLHeadingElement`\> \| `ReactEventHandler`\<`HTMLParagraphElement`\> \| `ReactEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onLoadedDataCapture?` | `ReactEventHandler`\<`HTMLDivElement`\> \| `ReactEventHandler`\<`HTMLSpanElement`\> \| `ReactEventHandler`\<`HTMLHeadingElement`\> \| `ReactEventHandler`\<`HTMLParagraphElement`\> \| `ReactEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onLoadedMetadata?` | `ReactEventHandler`\<`HTMLDivElement`\> \| `ReactEventHandler`\<`HTMLSpanElement`\> \| `ReactEventHandler`\<`HTMLHeadingElement`\> \| `ReactEventHandler`\<`HTMLParagraphElement`\> \| `ReactEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onLoadedMetadataCapture?` | `ReactEventHandler`\<`HTMLDivElement`\> \| `ReactEventHandler`\<`HTMLSpanElement`\> \| `ReactEventHandler`\<`HTMLHeadingElement`\> \| `ReactEventHandler`\<`HTMLParagraphElement`\> \| `ReactEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onLostPointerCapture?` | `PointerEventHandler`\<`HTMLDivElement`\> \| `PointerEventHandler`\<`HTMLSpanElement`\> \| `PointerEventHandler`\<`HTMLHeadingElement`\> \| `PointerEventHandler`\<`HTMLParagraphElement`\> \| `PointerEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onLostPointerCaptureCapture?` | `PointerEventHandler`\<`HTMLDivElement`\> \| `PointerEventHandler`\<`HTMLSpanElement`\> \| `PointerEventHandler`\<`HTMLHeadingElement`\> \| `PointerEventHandler`\<`HTMLParagraphElement`\> \| `PointerEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onMouseDown?` | `MouseEventHandler`\<`HTMLDivElement`\> \| `MouseEventHandler`\<`HTMLSpanElement`\> \| `MouseEventHandler`\<`HTMLHeadingElement`\> \| `MouseEventHandler`\<`HTMLParagraphElement`\> \| `MouseEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onMouseDownCapture?` | `MouseEventHandler`\<`HTMLDivElement`\> \| `MouseEventHandler`\<`HTMLSpanElement`\> \| `MouseEventHandler`\<`HTMLHeadingElement`\> \| `MouseEventHandler`\<`HTMLParagraphElement`\> \| `MouseEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onMouseEnter?` | `MouseEventHandler`\<`HTMLDivElement`\> \| `MouseEventHandler`\<`HTMLSpanElement`\> \| `MouseEventHandler`\<`HTMLHeadingElement`\> \| `MouseEventHandler`\<`HTMLParagraphElement`\> \| `MouseEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onMouseLeave?` | `MouseEventHandler`\<`HTMLDivElement`\> \| `MouseEventHandler`\<`HTMLSpanElement`\> \| `MouseEventHandler`\<`HTMLHeadingElement`\> \| `MouseEventHandler`\<`HTMLParagraphElement`\> \| `MouseEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onMouseMove?` | `MouseEventHandler`\<`HTMLDivElement`\> \| `MouseEventHandler`\<`HTMLSpanElement`\> \| `MouseEventHandler`\<`HTMLHeadingElement`\> \| `MouseEventHandler`\<`HTMLParagraphElement`\> \| `MouseEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onMouseMoveCapture?` | `MouseEventHandler`\<`HTMLDivElement`\> \| `MouseEventHandler`\<`HTMLSpanElement`\> \| `MouseEventHandler`\<`HTMLHeadingElement`\> \| `MouseEventHandler`\<`HTMLParagraphElement`\> \| `MouseEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onMouseOut?` | `MouseEventHandler`\<`HTMLDivElement`\> \| `MouseEventHandler`\<`HTMLSpanElement`\> \| `MouseEventHandler`\<`HTMLHeadingElement`\> \| `MouseEventHandler`\<`HTMLParagraphElement`\> \| `MouseEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onMouseOutCapture?` | `MouseEventHandler`\<`HTMLDivElement`\> \| `MouseEventHandler`\<`HTMLSpanElement`\> \| `MouseEventHandler`\<`HTMLHeadingElement`\> \| `MouseEventHandler`\<`HTMLParagraphElement`\> \| `MouseEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onMouseOver?` | `MouseEventHandler`\<`HTMLDivElement`\> \| `MouseEventHandler`\<`HTMLSpanElement`\> \| `MouseEventHandler`\<`HTMLHeadingElement`\> \| `MouseEventHandler`\<`HTMLParagraphElement`\> \| `MouseEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onMouseOverCapture?` | `MouseEventHandler`\<`HTMLDivElement`\> \| `MouseEventHandler`\<`HTMLSpanElement`\> \| `MouseEventHandler`\<`HTMLHeadingElement`\> \| `MouseEventHandler`\<`HTMLParagraphElement`\> \| `MouseEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onMouseUp?` | `MouseEventHandler`\<`HTMLDivElement`\> \| `MouseEventHandler`\<`HTMLSpanElement`\> \| `MouseEventHandler`\<`HTMLHeadingElement`\> \| `MouseEventHandler`\<`HTMLParagraphElement`\> \| `MouseEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onMouseUpCapture?` | `MouseEventHandler`\<`HTMLDivElement`\> \| `MouseEventHandler`\<`HTMLSpanElement`\> \| `MouseEventHandler`\<`HTMLHeadingElement`\> \| `MouseEventHandler`\<`HTMLParagraphElement`\> \| `MouseEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onPaste?` | `ClipboardEventHandler`\<`HTMLDivElement`\> \| `ClipboardEventHandler`\<`HTMLSpanElement`\> \| `ClipboardEventHandler`\<`HTMLHeadingElement`\> \| `ClipboardEventHandler`\<`HTMLParagraphElement`\> \| `ClipboardEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onPasteCapture?` | `ClipboardEventHandler`\<`HTMLDivElement`\> \| `ClipboardEventHandler`\<`HTMLSpanElement`\> \| `ClipboardEventHandler`\<`HTMLHeadingElement`\> \| `ClipboardEventHandler`\<`HTMLParagraphElement`\> \| `ClipboardEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onPause?` | `ReactEventHandler`\<`HTMLDivElement`\> \| `ReactEventHandler`\<`HTMLSpanElement`\> \| `ReactEventHandler`\<`HTMLHeadingElement`\> \| `ReactEventHandler`\<`HTMLParagraphElement`\> \| `ReactEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onPauseCapture?` | `ReactEventHandler`\<`HTMLDivElement`\> \| `ReactEventHandler`\<`HTMLSpanElement`\> \| `ReactEventHandler`\<`HTMLHeadingElement`\> \| `ReactEventHandler`\<`HTMLParagraphElement`\> \| `ReactEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onPlay?` | `ReactEventHandler`\<`HTMLDivElement`\> \| `ReactEventHandler`\<`HTMLSpanElement`\> \| `ReactEventHandler`\<`HTMLHeadingElement`\> \| `ReactEventHandler`\<`HTMLParagraphElement`\> \| `ReactEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onPlayCapture?` | `ReactEventHandler`\<`HTMLDivElement`\> \| `ReactEventHandler`\<`HTMLSpanElement`\> \| `ReactEventHandler`\<`HTMLHeadingElement`\> \| `ReactEventHandler`\<`HTMLParagraphElement`\> \| `ReactEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onPlaying?` | `ReactEventHandler`\<`HTMLDivElement`\> \| `ReactEventHandler`\<`HTMLSpanElement`\> \| `ReactEventHandler`\<`HTMLHeadingElement`\> \| `ReactEventHandler`\<`HTMLParagraphElement`\> \| `ReactEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onPlayingCapture?` | `ReactEventHandler`\<`HTMLDivElement`\> \| `ReactEventHandler`\<`HTMLSpanElement`\> \| `ReactEventHandler`\<`HTMLHeadingElement`\> \| `ReactEventHandler`\<`HTMLParagraphElement`\> \| `ReactEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onPointerCancel?` | `PointerEventHandler`\<`HTMLDivElement`\> \| `PointerEventHandler`\<`HTMLSpanElement`\> \| `PointerEventHandler`\<`HTMLHeadingElement`\> \| `PointerEventHandler`\<`HTMLParagraphElement`\> \| `PointerEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onPointerCancelCapture?` | `PointerEventHandler`\<`HTMLDivElement`\> \| `PointerEventHandler`\<`HTMLSpanElement`\> \| `PointerEventHandler`\<`HTMLHeadingElement`\> \| `PointerEventHandler`\<`HTMLParagraphElement`\> \| `PointerEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onPointerDown?` | `PointerEventHandler`\<`HTMLDivElement`\> \| `PointerEventHandler`\<`HTMLSpanElement`\> \| `PointerEventHandler`\<`HTMLHeadingElement`\> \| `PointerEventHandler`\<`HTMLParagraphElement`\> \| `PointerEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onPointerDownCapture?` | `PointerEventHandler`\<`HTMLDivElement`\> \| `PointerEventHandler`\<`HTMLSpanElement`\> \| `PointerEventHandler`\<`HTMLHeadingElement`\> \| `PointerEventHandler`\<`HTMLParagraphElement`\> \| `PointerEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onPointerEnter?` | `PointerEventHandler`\<`HTMLDivElement`\> \| `PointerEventHandler`\<`HTMLSpanElement`\> \| `PointerEventHandler`\<`HTMLHeadingElement`\> \| `PointerEventHandler`\<`HTMLParagraphElement`\> \| `PointerEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onPointerEnterCapture?` | `PointerEventHandler`\<`HTMLDivElement`\> \| `PointerEventHandler`\<`HTMLSpanElement`\> \| `PointerEventHandler`\<`HTMLHeadingElement`\> \| `PointerEventHandler`\<`HTMLParagraphElement`\> \| `PointerEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onPointerLeave?` | `PointerEventHandler`\<`HTMLDivElement`\> \| `PointerEventHandler`\<`HTMLSpanElement`\> \| `PointerEventHandler`\<`HTMLHeadingElement`\> \| `PointerEventHandler`\<`HTMLParagraphElement`\> \| `PointerEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onPointerLeaveCapture?` | `PointerEventHandler`\<`HTMLDivElement`\> \| `PointerEventHandler`\<`HTMLSpanElement`\> \| `PointerEventHandler`\<`HTMLHeadingElement`\> \| `PointerEventHandler`\<`HTMLParagraphElement`\> \| `PointerEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onPointerMove?` | `PointerEventHandler`\<`HTMLDivElement`\> \| `PointerEventHandler`\<`HTMLSpanElement`\> \| `PointerEventHandler`\<`HTMLHeadingElement`\> \| `PointerEventHandler`\<`HTMLParagraphElement`\> \| `PointerEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onPointerMoveCapture?` | `PointerEventHandler`\<`HTMLDivElement`\> \| `PointerEventHandler`\<`HTMLSpanElement`\> \| `PointerEventHandler`\<`HTMLHeadingElement`\> \| `PointerEventHandler`\<`HTMLParagraphElement`\> \| `PointerEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onPointerOut?` | `PointerEventHandler`\<`HTMLDivElement`\> \| `PointerEventHandler`\<`HTMLSpanElement`\> \| `PointerEventHandler`\<`HTMLHeadingElement`\> \| `PointerEventHandler`\<`HTMLParagraphElement`\> \| `PointerEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onPointerOutCapture?` | `PointerEventHandler`\<`HTMLDivElement`\> \| `PointerEventHandler`\<`HTMLSpanElement`\> \| `PointerEventHandler`\<`HTMLHeadingElement`\> \| `PointerEventHandler`\<`HTMLParagraphElement`\> \| `PointerEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onPointerOver?` | `PointerEventHandler`\<`HTMLDivElement`\> \| `PointerEventHandler`\<`HTMLSpanElement`\> \| `PointerEventHandler`\<`HTMLHeadingElement`\> \| `PointerEventHandler`\<`HTMLParagraphElement`\> \| `PointerEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onPointerOverCapture?` | `PointerEventHandler`\<`HTMLDivElement`\> \| `PointerEventHandler`\<`HTMLSpanElement`\> \| `PointerEventHandler`\<`HTMLHeadingElement`\> \| `PointerEventHandler`\<`HTMLParagraphElement`\> \| `PointerEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onPointerUp?` | `PointerEventHandler`\<`HTMLDivElement`\> \| `PointerEventHandler`\<`HTMLSpanElement`\> \| `PointerEventHandler`\<`HTMLHeadingElement`\> \| `PointerEventHandler`\<`HTMLParagraphElement`\> \| `PointerEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onPointerUpCapture?` | `PointerEventHandler`\<`HTMLDivElement`\> \| `PointerEventHandler`\<`HTMLSpanElement`\> \| `PointerEventHandler`\<`HTMLHeadingElement`\> \| `PointerEventHandler`\<`HTMLParagraphElement`\> \| `PointerEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onProgress?` | `ReactEventHandler`\<`HTMLDivElement`\> \| `ReactEventHandler`\<`HTMLSpanElement`\> \| `ReactEventHandler`\<`HTMLHeadingElement`\> \| `ReactEventHandler`\<`HTMLParagraphElement`\> \| `ReactEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onProgressCapture?` | `ReactEventHandler`\<`HTMLDivElement`\> \| `ReactEventHandler`\<`HTMLSpanElement`\> \| `ReactEventHandler`\<`HTMLHeadingElement`\> \| `ReactEventHandler`\<`HTMLParagraphElement`\> \| `ReactEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onRateChange?` | `ReactEventHandler`\<`HTMLDivElement`\> \| `ReactEventHandler`\<`HTMLSpanElement`\> \| `ReactEventHandler`\<`HTMLHeadingElement`\> \| `ReactEventHandler`\<`HTMLParagraphElement`\> \| `ReactEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onRateChangeCapture?` | `ReactEventHandler`\<`HTMLDivElement`\> \| `ReactEventHandler`\<`HTMLSpanElement`\> \| `ReactEventHandler`\<`HTMLHeadingElement`\> \| `ReactEventHandler`\<`HTMLParagraphElement`\> \| `ReactEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onReset?` | `FormEventHandler`\<`HTMLDivElement`\> \| `FormEventHandler`\<`HTMLSpanElement`\> \| `FormEventHandler`\<`HTMLHeadingElement`\> \| `FormEventHandler`\<`HTMLParagraphElement`\> \| `FormEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onResetCapture?` | `FormEventHandler`\<`HTMLDivElement`\> \| `FormEventHandler`\<`HTMLSpanElement`\> \| `FormEventHandler`\<`HTMLHeadingElement`\> \| `FormEventHandler`\<`HTMLParagraphElement`\> \| `FormEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onResize?` | `ReactEventHandler`\<`HTMLDivElement`\> \| `ReactEventHandler`\<`HTMLSpanElement`\> \| `ReactEventHandler`\<`HTMLHeadingElement`\> \| `ReactEventHandler`\<`HTMLParagraphElement`\> \| `ReactEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onResizeCapture?` | `ReactEventHandler`\<`HTMLDivElement`\> \| `ReactEventHandler`\<`HTMLSpanElement`\> \| `ReactEventHandler`\<`HTMLHeadingElement`\> \| `ReactEventHandler`\<`HTMLParagraphElement`\> \| `ReactEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onScroll?` | `UIEventHandler`\<`HTMLDivElement`\> \| `UIEventHandler`\<`HTMLSpanElement`\> \| `UIEventHandler`\<`HTMLHeadingElement`\> \| `UIEventHandler`\<`HTMLParagraphElement`\> \| `UIEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onScrollCapture?` | `UIEventHandler`\<`HTMLDivElement`\> \| `UIEventHandler`\<`HTMLSpanElement`\> \| `UIEventHandler`\<`HTMLHeadingElement`\> \| `UIEventHandler`\<`HTMLParagraphElement`\> \| `UIEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onSeeked?` | `ReactEventHandler`\<`HTMLDivElement`\> \| `ReactEventHandler`\<`HTMLSpanElement`\> \| `ReactEventHandler`\<`HTMLHeadingElement`\> \| `ReactEventHandler`\<`HTMLParagraphElement`\> \| `ReactEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onSeekedCapture?` | `ReactEventHandler`\<`HTMLDivElement`\> \| `ReactEventHandler`\<`HTMLSpanElement`\> \| `ReactEventHandler`\<`HTMLHeadingElement`\> \| `ReactEventHandler`\<`HTMLParagraphElement`\> \| `ReactEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onSeeking?` | `ReactEventHandler`\<`HTMLDivElement`\> \| `ReactEventHandler`\<`HTMLSpanElement`\> \| `ReactEventHandler`\<`HTMLHeadingElement`\> \| `ReactEventHandler`\<`HTMLParagraphElement`\> \| `ReactEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onSeekingCapture?` | `ReactEventHandler`\<`HTMLDivElement`\> \| `ReactEventHandler`\<`HTMLSpanElement`\> \| `ReactEventHandler`\<`HTMLHeadingElement`\> \| `ReactEventHandler`\<`HTMLParagraphElement`\> \| `ReactEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onSelect?` | `ReactEventHandler`\<`HTMLDivElement`\> \| `ReactEventHandler`\<`HTMLSpanElement`\> \| `ReactEventHandler`\<`HTMLHeadingElement`\> \| `ReactEventHandler`\<`HTMLParagraphElement`\> \| `ReactEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onSelectCapture?` | `ReactEventHandler`\<`HTMLDivElement`\> \| `ReactEventHandler`\<`HTMLSpanElement`\> \| `ReactEventHandler`\<`HTMLHeadingElement`\> \| `ReactEventHandler`\<`HTMLParagraphElement`\> \| `ReactEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onStalled?` | `ReactEventHandler`\<`HTMLDivElement`\> \| `ReactEventHandler`\<`HTMLSpanElement`\> \| `ReactEventHandler`\<`HTMLHeadingElement`\> \| `ReactEventHandler`\<`HTMLParagraphElement`\> \| `ReactEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onStalledCapture?` | `ReactEventHandler`\<`HTMLDivElement`\> \| `ReactEventHandler`\<`HTMLSpanElement`\> \| `ReactEventHandler`\<`HTMLHeadingElement`\> \| `ReactEventHandler`\<`HTMLParagraphElement`\> \| `ReactEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onSubmit?` | `FormEventHandler`\<`HTMLDivElement`\> \| `FormEventHandler`\<`HTMLSpanElement`\> \| `FormEventHandler`\<`HTMLHeadingElement`\> \| `FormEventHandler`\<`HTMLParagraphElement`\> \| `FormEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onSubmitCapture?` | `FormEventHandler`\<`HTMLDivElement`\> \| `FormEventHandler`\<`HTMLSpanElement`\> \| `FormEventHandler`\<`HTMLHeadingElement`\> \| `FormEventHandler`\<`HTMLParagraphElement`\> \| `FormEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onSuspend?` | `ReactEventHandler`\<`HTMLDivElement`\> \| `ReactEventHandler`\<`HTMLSpanElement`\> \| `ReactEventHandler`\<`HTMLHeadingElement`\> \| `ReactEventHandler`\<`HTMLParagraphElement`\> \| `ReactEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onSuspendCapture?` | `ReactEventHandler`\<`HTMLDivElement`\> \| `ReactEventHandler`\<`HTMLSpanElement`\> \| `ReactEventHandler`\<`HTMLHeadingElement`\> \| `ReactEventHandler`\<`HTMLParagraphElement`\> \| `ReactEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onTimeUpdate?` | `ReactEventHandler`\<`HTMLDivElement`\> \| `ReactEventHandler`\<`HTMLSpanElement`\> \| `ReactEventHandler`\<`HTMLHeadingElement`\> \| `ReactEventHandler`\<`HTMLParagraphElement`\> \| `ReactEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onTimeUpdateCapture?` | `ReactEventHandler`\<`HTMLDivElement`\> \| `ReactEventHandler`\<`HTMLSpanElement`\> \| `ReactEventHandler`\<`HTMLHeadingElement`\> \| `ReactEventHandler`\<`HTMLParagraphElement`\> \| `ReactEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onTouchCancel?` | `TouchEventHandler`\<`HTMLDivElement`\> \| `TouchEventHandler`\<`HTMLSpanElement`\> \| `TouchEventHandler`\<`HTMLHeadingElement`\> \| `TouchEventHandler`\<`HTMLParagraphElement`\> \| `TouchEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onTouchCancelCapture?` | `TouchEventHandler`\<`HTMLDivElement`\> \| `TouchEventHandler`\<`HTMLSpanElement`\> \| `TouchEventHandler`\<`HTMLHeadingElement`\> \| `TouchEventHandler`\<`HTMLParagraphElement`\> \| `TouchEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onTouchEnd?` | `TouchEventHandler`\<`HTMLDivElement`\> \| `TouchEventHandler`\<`HTMLSpanElement`\> \| `TouchEventHandler`\<`HTMLHeadingElement`\> \| `TouchEventHandler`\<`HTMLParagraphElement`\> \| `TouchEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onTouchEndCapture?` | `TouchEventHandler`\<`HTMLDivElement`\> \| `TouchEventHandler`\<`HTMLSpanElement`\> \| `TouchEventHandler`\<`HTMLHeadingElement`\> \| `TouchEventHandler`\<`HTMLParagraphElement`\> \| `TouchEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onTouchMove?` | `TouchEventHandler`\<`HTMLDivElement`\> \| `TouchEventHandler`\<`HTMLSpanElement`\> \| `TouchEventHandler`\<`HTMLHeadingElement`\> \| `TouchEventHandler`\<`HTMLParagraphElement`\> \| `TouchEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onTouchMoveCapture?` | `TouchEventHandler`\<`HTMLDivElement`\> \| `TouchEventHandler`\<`HTMLSpanElement`\> \| `TouchEventHandler`\<`HTMLHeadingElement`\> \| `TouchEventHandler`\<`HTMLParagraphElement`\> \| `TouchEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onTouchStart?` | `TouchEventHandler`\<`HTMLDivElement`\> \| `TouchEventHandler`\<`HTMLSpanElement`\> \| `TouchEventHandler`\<`HTMLHeadingElement`\> \| `TouchEventHandler`\<`HTMLParagraphElement`\> \| `TouchEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onTouchStartCapture?` | `TouchEventHandler`\<`HTMLDivElement`\> \| `TouchEventHandler`\<`HTMLSpanElement`\> \| `TouchEventHandler`\<`HTMLHeadingElement`\> \| `TouchEventHandler`\<`HTMLParagraphElement`\> \| `TouchEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onTransitionEnd?` | `TransitionEventHandler`\<`HTMLDivElement`\> \| `TransitionEventHandler`\<`HTMLSpanElement`\> \| `TransitionEventHandler`\<`HTMLHeadingElement`\> \| `TransitionEventHandler`\<`HTMLParagraphElement`\> \| `TransitionEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onTransitionEndCapture?` | `TransitionEventHandler`\<`HTMLDivElement`\> \| `TransitionEventHandler`\<`HTMLSpanElement`\> \| `TransitionEventHandler`\<`HTMLHeadingElement`\> \| `TransitionEventHandler`\<`HTMLParagraphElement`\> \| `TransitionEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onVolumeChange?` | `ReactEventHandler`\<`HTMLDivElement`\> \| `ReactEventHandler`\<`HTMLSpanElement`\> \| `ReactEventHandler`\<`HTMLHeadingElement`\> \| `ReactEventHandler`\<`HTMLParagraphElement`\> \| `ReactEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onVolumeChangeCapture?` | `ReactEventHandler`\<`HTMLDivElement`\> \| `ReactEventHandler`\<`HTMLSpanElement`\> \| `ReactEventHandler`\<`HTMLHeadingElement`\> \| `ReactEventHandler`\<`HTMLParagraphElement`\> \| `ReactEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onWaiting?` | `ReactEventHandler`\<`HTMLDivElement`\> \| `ReactEventHandler`\<`HTMLSpanElement`\> \| `ReactEventHandler`\<`HTMLHeadingElement`\> \| `ReactEventHandler`\<`HTMLParagraphElement`\> \| `ReactEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onWaitingCapture?` | `ReactEventHandler`\<`HTMLDivElement`\> \| `ReactEventHandler`\<`HTMLSpanElement`\> \| `ReactEventHandler`\<`HTMLHeadingElement`\> \| `ReactEventHandler`\<`HTMLParagraphElement`\> \| `ReactEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onWheel?` | `WheelEventHandler`\<`HTMLDivElement`\> \| `WheelEventHandler`\<`HTMLSpanElement`\> \| `WheelEventHandler`\<`HTMLHeadingElement`\> \| `WheelEventHandler`\<`HTMLParagraphElement`\> \| `WheelEventHandler`\<`HTMLLabelElement`\> | - | -| `props.onWheelCapture?` | `WheelEventHandler`\<`HTMLDivElement`\> \| `WheelEventHandler`\<`HTMLSpanElement`\> \| `WheelEventHandler`\<`HTMLHeadingElement`\> \| `WheelEventHandler`\<`HTMLParagraphElement`\> \| `WheelEventHandler`\<`HTMLLabelElement`\> | - | -| `props.placeholder?` | `string` | - | -| `props.prefix?` | `string` | - | -| `props.property?` | `string` | - | -| `props.radioGroup?` | `string` | - | -| `props.ref?` | `Ref`\<`unknown`\> | Allows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (or call the ref with `null` if you passed a callback ref). **`See`** https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom | -| `props.rel?` | `string` | - | -| `props.resource?` | `string` | - | -| `props.results?` | `number` | - | -| `props.rev?` | `string` | - | -| `props.role?` | `AriaRole` | - | -| `props.security?` | `string` | - | -| `props.slot?` | `string` | - | -| `props.spellCheck?` | `Booleanish` | - | -| `props.style?` | `CSSProperties` | - | -| `props.suppressContentEditableWarning?` | `boolean` | - | -| `props.suppressHydrationWarning?` | `boolean` | - | -| `props.tabIndex?` | `number` | - | -| `props.title?` | `string` | - | -| `props.translate?` | `"yes"` \| `"no"` | - | -| `props.typeof?` | `string` | - | -| `props.unselectable?` | `"on"` \| `"off"` | - | -| `props.variant?` | `"body"` \| `"action"` \| `"emphasis"` \| `"caption1"` \| `"caption2"` \| `"display1"` \| `"display2"` \| `"display3"` \| `"display4"` | Text variant **`Default`** `ts 'body' ` | -| `props.vocab?` | `string` | - | +| Name | Type | Description | +| :--------------- | :------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------- | +| `props` | `Object` | - | +| `props.as?` | `"div"` \| `"h1"` \| `"h2"` \| `"h3"` \| `"h4"` \| `"h5"` \| `"h6"` \| `"label"` \| `"p"` \| `"span"` | - | +| `props.variant?` | `"body"` \| `"action"` \| `"emphasis"` \| `"caption1"` \| `"caption2"` \| `"display1"` \| `"display2"` \| `"display3"` \| `"display4"` | Text variant **`Default`** `ts 'body' ` | #### Returns diff --git a/packages/next-docs/pages/components/text/props.mdx b/packages/next-docs/pages/components/text/props.mdx index b17d715a84..abcef9ef93 100644 --- a/packages/next-docs/pages/components/text/props.mdx +++ b/packages/next-docs/pages/components/text/props.mdx @@ -4,7 +4,7 @@ #### Defined in -[packages/components/src/text/text.tsx:59](https://github.com/vtex/shoreline/blob/cc3cbcc20/packages/components/src/text/text.tsx#L59) +[packages/components/src/text/text.tsx:59](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/text/text.tsx#L59) ## Variables @@ -14,7 +14,7 @@ #### Defined in -[packages/components/src/filter/filter-context.ts:5](https://github.com/vtex/shoreline/blob/cc3cbcc20/packages/components/src/filter/filter-context.ts#L5) +[packages/components/src/filter/filter-context.ts:5](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/filter/filter-context.ts#L5) ## Functions diff --git a/packages/next-docs/pages/components/textarea/props.mdx b/packages/next-docs/pages/components/textarea/props.mdx new file mode 100644 index 0000000000..41d143c67a --- /dev/null +++ b/packages/next-docs/pages/components/textarea/props.mdx @@ -0,0 +1,56 @@ +# TextareaProps + +## Hierarchy + +- `ComponentPropsWithoutRef`\<`"textarea"`\> + + ↳ **`TextareaProps`** + +## Table of contents + +### Properties + +- [error](TextareaProps.md#error) +- [errorText](TextareaProps.md#errortext) +- [helpText](TextareaProps.md#helptext) +- [label](TextareaProps.md#label) + +## Properties + +### error + +• `Optional` **error**: `boolean` + +#### Defined in + +[packages/components/src/textarea/textarea.tsx:65](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/textarea/textarea.tsx#L65) + +--- + +### errorText + +• `Optional` **errorText**: `ReactNode` + +#### Defined in + +[packages/components/src/textarea/textarea.tsx:68](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/textarea/textarea.tsx#L68) + +--- + +### helpText + +• `Optional` **helpText**: `ReactNode` + +#### Defined in + +[packages/components/src/textarea/textarea.tsx:67](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/textarea/textarea.tsx#L67) + +--- + +### label + +• `Optional` **label**: `ReactNode` + +#### Defined in + +[packages/components/src/textarea/textarea.tsx:66](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/textarea/textarea.tsx#L66) diff --git a/packages/next-docs/pages/components/tooltip-anchor/props.mdx b/packages/next-docs/pages/components/tooltip-anchor/props.mdx new file mode 100644 index 0000000000..4b2e27de61 --- /dev/null +++ b/packages/next-docs/pages/components/tooltip-anchor/props.mdx @@ -0,0 +1,23 @@ +# TooltipAnchorProps + +## Hierarchy + +- `ComponentPropsWithoutRef`\<`"div"`\> + + ↳ **`TooltipAnchorProps`** + +## Table of contents + +### Properties + +- [asChild](TooltipAnchorProps.md#aschild) + +## Properties + +### asChild + +• `Optional` **asChild**: `boolean` + +#### Defined in + +[packages/components/src/tooltip/tooltip-anchor.tsx:32](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/tooltip/tooltip-anchor.tsx#L32) diff --git a/packages/next-docs/pages/components/tooltip-arrow/props.mdx b/packages/next-docs/pages/components/tooltip-arrow/props.mdx new file mode 100644 index 0000000000..4f098ccedb --- /dev/null +++ b/packages/next-docs/pages/components/tooltip-arrow/props.mdx @@ -0,0 +1,23 @@ +# TooltipArrowProps + +## Hierarchy + +- `ComponentPropsWithoutRef`\<`"div"`\> + + ↳ **`TooltipArrowProps`** + +## Table of contents + +### Properties + +- [asChild](TooltipArrowProps.md#aschild) + +## Properties + +### asChild + +• `Optional` **asChild**: `boolean` + +#### Defined in + +[packages/components/src/tooltip/tooltip-arrow.tsx:30](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/tooltip/tooltip-arrow.tsx#L30) diff --git a/packages/next-docs/pages/components/tooltip-popover/props.mdx b/packages/next-docs/pages/components/tooltip-popover/props.mdx new file mode 100644 index 0000000000..9c256b69a9 --- /dev/null +++ b/packages/next-docs/pages/components/tooltip-popover/props.mdx @@ -0,0 +1,34 @@ +# TooltipPopoverProps + +## Hierarchy + +- `ComponentPropsWithoutRef`\<`"div"`\> + + ↳ **`TooltipPopoverProps`** + +## Table of contents + +### Properties + +- [asChild](TooltipPopoverProps.md#aschild) +- [gutter](TooltipPopoverProps.md#gutter) + +## Properties + +### asChild + +• `Optional` **asChild**: `boolean` + +#### Defined in + +[packages/components/src/tooltip/tooltip-popover.tsx:33](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/tooltip/tooltip-popover.tsx#L33) + +--- + +### gutter + +• `Optional` **gutter**: `number` + +#### Defined in + +[packages/components/src/tooltip/tooltip-popover.tsx:34](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/tooltip/tooltip-popover.tsx#L34) diff --git a/packages/next-docs/pages/components/tooltip-provider/props.mdx b/packages/next-docs/pages/components/tooltip-provider/props.mdx new file mode 100644 index 0000000000..2a66f2965f --- /dev/null +++ b/packages/next-docs/pages/components/tooltip-provider/props.mdx @@ -0,0 +1,374 @@ +# Interface: TooltipProviderProps + +## Hierarchy + +- `TooltipStoreProps` + + ↳ **`TooltipProviderProps`** + +## Table of contents + +### Properties + +- [animated](TooltipProviderProps.md#animated) +- [children](TooltipProviderProps.md#children) +- [defaultOpen](TooltipProviderProps.md#defaultopen) +- [disclosure](TooltipProviderProps.md#disclosure) +- [hideTimeout](TooltipProviderProps.md#hidetimeout) +- [open](TooltipProviderProps.md#open) +- [placement](TooltipProviderProps.md#placement) +- [popover](TooltipProviderProps.md#popover) +- [setMounted](TooltipProviderProps.md#setmounted) +- [setOpen](TooltipProviderProps.md#setopen) +- [showTimeout](TooltipProviderProps.md#showtimeout) +- [skipTimeout](TooltipProviderProps.md#skiptimeout) +- [store](TooltipProviderProps.md#store) +- [timeout](TooltipProviderProps.md#timeout) +- [type](TooltipProviderProps.md#type) + +## Properties + +### animated + +• `Optional` **animated**: `number` \| `boolean` + +Determines whether the content should animate when it is shown or hidden. + +- If `true`, the `animating` state will be `true` when the content is shown + or hidden and it will wait for `stopAnimation` to be called or a CSS + animation/transition to end before becoming `false`. +- If it's set to a number, the `animating` state will be `true` when the + content is shown or hidden and it will wait for the number of + milliseconds to pass before becoming `false`. + +Live examples: + +- [Animated Combobox](https://ariakit.org/examples/combobox-animated) +- [Animated Dialog](https://ariakit.org/examples/dialog-animated) +- [Animated Select](https://ariakit.org/examples/select-animated) + +**`Default`** + +```ts +false; +``` + +#### Inherited from + +TooltipStoreProps.animated + +#### Defined in + +node_modules/.pnpm/@ariakit+core@0.3.4/node_modules/@ariakit/core/cjs/disclosure/disclosure-store.d.ts:44 + +--- + +### children + +• `Optional` **children**: `ReactNode` + +#### Defined in + +node_modules/.pnpm/@ariakit+react-core@0.3.5_react-dom@18.2.0_react@18.2.0/node_modules/@ariakit/react-core/cjs/tooltip/tooltip-provider.d.ts:16 + +--- + +### defaultOpen + +• `Optional` **defaultOpen**: `boolean` + +The default visibility state of the content. + +**`Default`** + +```ts +false; +``` + +#### Inherited from + +TooltipStoreProps.defaultOpen + +#### Defined in + +node_modules/.pnpm/@ariakit+core@0.3.4/node_modules/@ariakit/core/cjs/disclosure/disclosure-store.d.ts:115 + +--- + +### disclosure + +• `Optional` **disclosure**: `null` \| `DisclosureStore` + +A reference to another disclosure store that controls another disclosure +component to keep them in sync. Element states like `contentElement` and +`disclosureElement` won't be synced. For that, use the `store` prop +instead. + +#### Inherited from + +TooltipStoreProps.disclosure + +#### Defined in + +node_modules/.pnpm/@ariakit+core@0.3.4/node_modules/@ariakit/core/cjs/disclosure/disclosure-store.d.ts:122 + +--- + +### hideTimeout + +• `Optional` **hideTimeout**: `number` + +**`Default`** + +```ts +0; +``` + +#### Inherited from + +TooltipStoreProps.hideTimeout + +#### Defined in + +node_modules/.pnpm/@ariakit+core@0.3.4/node_modules/@ariakit/core/cjs/tooltip/tooltip-store.d.ts:23 + +--- + +### open + +• `Optional` **open**: `boolean` + +The visibility state of the content. + +Live examples: + +- [Dialog with React + Router](https://ariakit.org/examples/dialog-react-router) + +**`Default`** + +```ts +false; +``` + +#### Inherited from + +TooltipStoreProps.open + +#### Defined in + +node_modules/.pnpm/@ariakit+core@0.3.4/node_modules/@ariakit/core/cjs/disclosure/disclosure-store.d.ts:16 + +--- + +### placement + +• `Optional` **placement**: `Placement` + +**`Default`** + +```ts +"top"; +``` + +#### Inherited from + +TooltipStoreProps.placement + +#### Defined in + +node_modules/.pnpm/@ariakit+core@0.3.4/node_modules/@ariakit/core/cjs/tooltip/tooltip-store.d.ts:21 + +--- + +### popover + +• `Optional` **popover**: `null` \| `PopoverStore` + +A reference to another popover store that's controlling another popover to +keep them in sync. + +#### Inherited from + +TooltipStoreProps.popover + +#### Defined in + +node_modules/.pnpm/@ariakit+core@0.3.4/node_modules/@ariakit/core/cjs/popover/popover-store.d.ts:65 + +--- + +### setMounted + +• `Optional` **setMounted**: (`mounted`: `boolean`) => `void` + +#### Type declaration + +▸ (`mounted`): `void` + +A callback that gets called when the `mounted` state changes. + +##### Parameters + +| Name | Type | Description | +| :-------- | :-------- | :--------------------- | +| `mounted` | `boolean` | The new mounted value. | + +##### Returns + +`void` + +**`Example`** + +```ts +const [mounted, setMounted] = useState(false); +const disclosure = useDisclosureStore({ setMounted }); +``` + +#### Inherited from + +TooltipStoreProps.setMounted + +#### Defined in + +node_modules/.pnpm/@ariakit+react-core@0.3.5_react-dom@18.2.0_react@18.2.0/node_modules/@ariakit/react-core/cjs/disclosure/disclosure-store.d.ts:33 + +--- + +### setOpen + +• `Optional` **setOpen**: (`open`: `boolean`) => `void` + +#### Type declaration + +▸ (`open`): `void` + +A callback that gets called when the `open` state changes. + +##### Parameters + +| Name | Type | Description | +| :----- | :-------- | :------------------ | +| `open` | `boolean` | The new open value. | + +##### Returns + +`void` + +**`Example`** + +```ts +const [open, setOpen] = useState(false); +const disclosure = useDisclosureStore({ open, setOpen }); +``` + +#### Inherited from + +TooltipStoreProps.setOpen + +#### Defined in + +node_modules/.pnpm/@ariakit+react-core@0.3.5_react-dom@18.2.0_react@18.2.0/node_modules/@ariakit/react-core/cjs/disclosure/disclosure-store.d.ts:25 + +--- + +### showTimeout + +• `Optional` **showTimeout**: `number` + +The amount of time in milliseconds to wait before **showing** the popover. +It defaults to the value passed to `timeout`. + +#### Inherited from + +TooltipStoreProps.showTimeout + +#### Defined in + +node_modules/.pnpm/@ariakit+core@0.3.4/node_modules/@ariakit/core/cjs/hovercard/hovercard-store.d.ts:24 + +--- + +### skipTimeout + +• `Optional` **skipTimeout**: `number` + +The amount of time after a tooltip is hidden while all tooltips on the +page can be shown immediately, without waiting for the show timeout. + +**`Default`** + +```ts +300; +``` + +#### Inherited from + +TooltipStoreProps.skipTimeout + +#### Defined in + +node_modules/.pnpm/@ariakit+core@0.3.4/node_modules/@ariakit/core/cjs/tooltip/tooltip-store.d.ts:19 + +--- + +### store + +• `Optional` **store**: `Store`\<`Partial`\<`TooltipStoreState`\>\> + +Another store object that will be kept in sync with the original store. + +#### Inherited from + +TooltipStoreProps.store + +#### Defined in + +node_modules/.pnpm/@ariakit+core@0.3.4/node_modules/@ariakit/core/cjs/utils/store.d.ts:50 + +--- + +### timeout + +• `Optional` **timeout**: `number` + +The amount of time in milliseconds to wait before showing and hiding the +popover. To control the delay for showing and hiding separately, use +`showTimeout` and `hideTimeout`. + +**`Default`** + +```ts +500; +``` + +#### Inherited from + +TooltipStoreProps.timeout + +#### Defined in + +node_modules/.pnpm/@ariakit+core@0.3.4/node_modules/@ariakit/core/cjs/hovercard/hovercard-store.d.ts:19 + +--- + +### type + +• `Optional` **type**: `"label"` \| `"description"` + +Determines whether the tooltip is being used as a label or a description +for the anchor element. + +**`Default`** + +```ts +"description"; +``` + +#### Inherited from + +TooltipStoreProps.type + +#### Defined in + +node_modules/.pnpm/@ariakit+core@0.3.4/node_modules/@ariakit/core/cjs/tooltip/tooltip-store.d.ts:13 diff --git a/packages/next-docs/pages/components/tooltip/props.mdx b/packages/next-docs/pages/components/tooltip/props.mdx new file mode 100644 index 0000000000..92735d561d --- /dev/null +++ b/packages/next-docs/pages/components/tooltip/props.mdx @@ -0,0 +1,25 @@ +# TooltipProps + +## Hierarchy + +- `InheritedProps` + + ↳ **`TooltipProps`** + +## Table of contents + +### Properties + +- [text](TooltipProps.md#text) + +## Properties + +### text + +• **text**: `ReactNode` + +Text displayed on the popover + +#### Defined in + +[packages/components/src/tooltip/tooltip.tsx:61](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/tooltip/tooltip.tsx#L61) diff --git a/packages/next-docs/pages/components/visually-hidden/props.mdx b/packages/next-docs/pages/components/visually-hidden/props.mdx index c9df7a5e8b..1beb34de98 100644 --- a/packages/next-docs/pages/components/visually-hidden/props.mdx +++ b/packages/next-docs/pages/components/visually-hidden/props.mdx @@ -1,8 +1,17 @@ -# Props +# VisuallyHiddenProps -## Optional Props +## Table of contents -### `children` +### Properties -- Type: `React.ReactNode` -- Default: `undefined` +- [children](VisuallyHiddenProps.md#children) + +## Properties + +### children + +• `Optional` **children**: `ReactNode` + +#### Defined in + +[packages/components/src/visually-hidden/visually-hidden.tsx:19](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/visually-hidden/visually-hidden.tsx#L19) diff --git a/packages/next-docs/pages/hooks/_meta.json b/packages/next-docs/pages/hooks/_meta.json index 7c29cf7cb7..f308e68f63 100644 --- a/packages/next-docs/pages/hooks/_meta.json +++ b/packages/next-docs/pages/hooks/_meta.json @@ -1,9 +1,5 @@ { "use-filter-context": "useFilterContext", "use-locale": "useLocale", - "use-popover-context": "usePopoverContext", - "use-popover-store": "usePopoverStore", - "use-radio-state": "useRadioState", - "use-select-context": "useSelectContext", - "use-select-store": "useSelectStore" + "use-radio-state": "useRadioState" } diff --git a/packages/next-docs/pages/hooks/use-filter-context/code.mdx b/packages/next-docs/pages/hooks/use-filter-context/code.mdx index e80ec1f5da..4a42b1d63d 100644 --- a/packages/next-docs/pages/hooks/use-filter-context/code.mdx +++ b/packages/next-docs/pages/hooks/use-filter-context/code.mdx @@ -16,4 +16,4 @@ const filter = useFilterContext(); #### Defined in -[packages/components/src/filter/filter-context.ts:12](https://github.com/vtex/shoreline/blob/cc3cbcc20/packages/components/src/filter/filter-context.ts#L12) +[packages/components/src/filter/filter-context.ts:12](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/filter/filter-context.ts#L12) diff --git a/packages/next-docs/pages/hooks/use-locale/code.mdx b/packages/next-docs/pages/hooks/use-locale/code.mdx index 4ddf643028..82ae4f5ab2 100644 --- a/packages/next-docs/pages/hooks/use-locale/code.mdx +++ b/packages/next-docs/pages/hooks/use-locale/code.mdx @@ -16,4 +16,4 @@ const locale = useLocale(); #### Defined in -[packages/components/src/locale/use-locale.ts:9](https://github.com/vtex/shoreline/blob/cc3cbcc20/packages/components/src/locale/use-locale.ts#L9) +[packages/components/src/locale/use-locale.ts:9](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/locale/use-locale.ts#L9) diff --git a/packages/next-docs/pages/hooks/use-radio-state/code.mdx b/packages/next-docs/pages/hooks/use-radio-state/code.mdx index cffd8551fb..dcf30112a4 100644 --- a/packages/next-docs/pages/hooks/use-radio-state/code.mdx +++ b/packages/next-docs/pages/hooks/use-radio-state/code.mdx @@ -14,4 +14,4 @@ #### Defined in -[packages/components/src/radio/radio-group.tsx:70](https://github.com/vtex/shoreline/blob/cc3cbcc20/packages/components/src/radio/radio-group.tsx#L70) +[packages/components/src/radio/radio-group.tsx:70](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/radio/radio-group.tsx#L70) diff --git a/scripts/typedoc-to-nextra.js b/scripts/typedoc-to-nextra.js index ad8f6f4acd..73cdcec0e0 100644 --- a/scripts/typedoc-to-nextra.js +++ b/scripts/typedoc-to-nextra.js @@ -11,7 +11,7 @@ const path = require('path') * Copy a folder recursively * * @param {string} source - * @param {string} target + * @param {string} target? */ function copyFolderRecursiveSync(source, target) { const targetFolder = path.join(target, path.basename(source)) @@ -44,33 +44,35 @@ function splitIntoMultipleFiles() { const cwd = process.cwd() const rootFile = fs.readFileSync(`${cwd}/__tmpDocs/modules.md`, 'utf8') + const interfacesFiles = fs.readdirSync(`${cwd}/__tmpDocs/interfaces`) + // typedoc-plugin-markdown generates a single file with all the docs separated by "___" - const files = rootFile.split('___') + const methods = rootFile.split('___') const components = [] const hooks = [] - for (const file of files) { + for (const method of methods) { try { - const content = file.split('\n') - const componentName = content + const content = method.split('\n') + const methodName = content // Find the line that starts with "###", which is the component/method/hook name .find((line) => line.startsWith('###')) .replace('###', '') .trim() // Means that this is a component - const isPascalCase = /^[A-Z][a-zA-Z0-9]*$/.test(componentName) + const isPascalCase = /^[A-Z][a-zA-Z0-9]*$/.test(methodName) // Means that this is a hook, matches camelCase methods starting with "use" - const isHook = /^use[A-Z][a-zA-Z0-9]*$/.test(componentName) + const isHook = /^use[A-Z][a-zA-Z0-9]*$/.test(methodName) // Check if element is a component. This is a bit hacky, but it works // since typedoc classifies type-declared type as type aliases under // the modules.md file, while it separates interface-declared types // under the interfaces folder - const isTypeAlias = componentName.includes('Props') + const isTypeAlias = methodName.includes('Props') if (isHook && !isTypeAlias) { - const kebabCaseName = componentName + const kebabCaseName = methodName .replace(/([a-z0-9])([A-Z])/g, '$1-$2') .toLowerCase() @@ -82,17 +84,17 @@ function splitIntoMultipleFiles() { const filePath = `${folderPath}/code.mdx` - fs.writeFileSync(filePath, file) + fs.writeFileSync(filePath, method) prettify(filePath) - hooks.push(componentName) + hooks.push(methodName) continue } if (isPascalCase && !isHook && !isTypeAlias) { - const kebabCaseName = componentName + const kebabCaseName = methodName .replace(/([a-z0-9])([A-Z])/g, '$1-$2') .toLowerCase() @@ -104,17 +106,37 @@ function splitIntoMultipleFiles() { const filePath = `${folderPath}/code.mdx` - fs.writeFileSync(filePath, file) + fs.writeFileSync(filePath, method) prettify(filePath) - components.push(componentName) + components.push(methodName) + + const correspondingInterface = interfacesFiles.find( + (i) => i.replace('.md', '').replace('Props', '') === methodName + ) + + if (correspondingInterface) { + const interfaceFile = fs.readFileSync( + `${cwd}/__tmpDocs/interfaces/${correspondingInterface}`, + 'utf8' + ) + + const interfaceFilePath = `${folderPath}/props.mdx` + + fs.writeFileSync( + interfaceFilePath, + interfaceFile.replace('Interface: ', '') + ) + + prettify(interfaceFilePath) + } continue } if (isTypeAlias && !isHook) { - const kebabCaseName = componentName + const kebabCaseName = methodName .replace(/([a-z0-9])([A-Z])/g, '$1-$2') .toLowerCase() .replace('-props', '') @@ -127,17 +149,12 @@ function splitIntoMultipleFiles() { const filePath = `${folderPath}/props.mdx` - fs.writeFileSync(filePath, file) + fs.writeFileSync(filePath, method) prettify(filePath) continue } - - // TODO: Double check what kind of files are these and where they should be placed - // const filePath = `${cwd}/__tmpDocs/${componentName}.md` - // fs.writeFileSync(filePath, file) - // prettify(filePath) } catch (error) { console.error(error) } diff --git a/typedoc.json b/typedoc.json index f69a46cce4..cd45701b6e 100644 --- a/typedoc.json +++ b/typedoc.json @@ -8,6 +8,8 @@ "exclude": [ "packages/components/src/**/*+(index|.vitest|.e2e|.test|.stories).(ts|tsx)" ], + "excludeExternals": true, + "externalPattern": ["**/node_modules/**"], "tsconfig": "packages/components/tsconfig.json", "out": "__tmpDocs" }