Skip to content

Commit

Permalink
docs: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
marcelovicentegc committed Nov 28, 2023
1 parent bf9009f commit 4605b9b
Show file tree
Hide file tree
Showing 99 changed files with 694 additions and 251 deletions.
6 changes: 6 additions & 0 deletions packages/next-docs/pages/components/_meta.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
{
"use-virtualizer-model-return": "UseVirtualizerModelReturn",
"action": "Action",
"alert": "Alert",
"bleed": "Bleed",
Expand All @@ -17,6 +18,7 @@
"compose": "Compose",
"container": "Container",
"content": "Content",
"contextual-help": "ContextualHelp",
"field": "Field",
"field-label": "FieldLabel",
"field-message": "FieldMessage",
Expand Down Expand Up @@ -73,10 +75,14 @@
"text": "Text",
"text-input": "TextInput",
"textarea": "Textarea",
"toast-stack": "ToastStack",
"tooltip": "Tooltip",
"tooltip-anchor": "TooltipAnchor",
"tooltip-arrow": "TooltipArrow",
"tooltip-popover": "TooltipPopover",
"virtual": "Virtual",
"virtual-container": "VirtualContainer",
"virtual-item": "VirtualItem",
"visually-hidden": "VisuallyHidden",
"hooks": "Hooks"
}
2 changes: 1 addition & 1 deletion packages/next-docs/pages/components/action/props.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@

#### Defined in

[packages/components/src/action/action.tsx:34](https://github.com/vtex/shoreline/blob/7e966c5a4/packages/components/src/action/action.tsx#L34)
[packages/components/src/action/action.tsx:34](https://github.com/vtex/shoreline/blob/bf9009f50/packages/components/src/action/action.tsx#L34)
4 changes: 2 additions & 2 deletions packages/next-docs/pages/components/alert/props.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

#### Defined in

[packages/components/src/alert/alert.tsx:74](https://github.com/vtex/shoreline/blob/7e966c5a4/packages/components/src/alert/alert.tsx#L74)
[packages/components/src/alert/alert.tsx:74](https://github.com/vtex/shoreline/blob/bf9009f50/packages/components/src/alert/alert.tsx#L74)

---

Expand All @@ -24,4 +24,4 @@

#### Defined in

[packages/components/src/alert/alert.tsx:73](https://github.com/vtex/shoreline/blob/7e966c5a4/packages/components/src/alert/alert.tsx#L73)
[packages/components/src/alert/alert.tsx:73](https://github.com/vtex/shoreline/blob/bf9009f50/packages/components/src/alert/alert.tsx#L73)
12 changes: 6 additions & 6 deletions packages/next-docs/pages/components/bleed/props.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Bottom bleed

#### Defined in

[packages/components/src/bleed/bleed.tsx:68](https://github.com/vtex/shoreline/blob/7e966c5a4/packages/components/src/bleed/bleed.tsx#L68)
[packages/components/src/bleed/bleed.tsx:68](https://github.com/vtex/shoreline/blob/bf9009f50/packages/components/src/bleed/bleed.tsx#L68)

---

Expand All @@ -40,7 +40,7 @@ Horizontal bleed

#### Defined in

[packages/components/src/bleed/bleed.tsx:83](https://github.com/vtex/shoreline/blob/7e966c5a4/packages/components/src/bleed/bleed.tsx#L83)
[packages/components/src/bleed/bleed.tsx:83](https://github.com/vtex/shoreline/blob/bf9009f50/packages/components/src/bleed/bleed.tsx#L83)

---

Expand All @@ -58,7 +58,7 @@ Left bleed

#### Defined in

[packages/components/src/bleed/bleed.tsx:73](https://github.com/vtex/shoreline/blob/7e966c5a4/packages/components/src/bleed/bleed.tsx#L73)
[packages/components/src/bleed/bleed.tsx:73](https://github.com/vtex/shoreline/blob/bf9009f50/packages/components/src/bleed/bleed.tsx#L73)

---

Expand All @@ -76,7 +76,7 @@ Right bleed

#### Defined in

[packages/components/src/bleed/bleed.tsx:78](https://github.com/vtex/shoreline/blob/7e966c5a4/packages/components/src/bleed/bleed.tsx#L78)
[packages/components/src/bleed/bleed.tsx:78](https://github.com/vtex/shoreline/blob/bf9009f50/packages/components/src/bleed/bleed.tsx#L78)

---

Expand All @@ -94,7 +94,7 @@ Top bleed

#### Defined in

[packages/components/src/bleed/bleed.tsx:63](https://github.com/vtex/shoreline/blob/7e966c5a4/packages/components/src/bleed/bleed.tsx#L63)
[packages/components/src/bleed/bleed.tsx:63](https://github.com/vtex/shoreline/blob/bf9009f50/packages/components/src/bleed/bleed.tsx#L63)

---

Expand All @@ -112,4 +112,4 @@ Vertical bleed

#### Defined in

[packages/components/src/bleed/bleed.tsx:88](https://github.com/vtex/shoreline/blob/7e966c5a4/packages/components/src/bleed/bleed.tsx#L88)
[packages/components/src/bleed/bleed.tsx:88](https://github.com/vtex/shoreline/blob/bf9009f50/packages/components/src/bleed/bleed.tsx#L88)
10 changes: 5 additions & 5 deletions packages/next-docs/pages/components/button/props.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ false;

#### Defined in

[packages/components/src/button/button.tsx:95](https://github.com/vtex/shoreline/blob/7e966c5a4/packages/components/src/button/button.tsx#L95)
[packages/components/src/button/button.tsx:95](https://github.com/vtex/shoreline/blob/bf9009f50/packages/components/src/button/button.tsx#L95)

---

Expand All @@ -38,7 +38,7 @@ ComponentPropsWithoutRef.children

#### Defined in

[packages/components/src/button/button.tsx:70](https://github.com/vtex/shoreline/blob/7e966c5a4/packages/components/src/button/button.tsx#L70)
[packages/components/src/button/button.tsx:70](https://github.com/vtex/shoreline/blob/bf9009f50/packages/components/src/button/button.tsx#L70)

---

Expand All @@ -56,7 +56,7 @@ false;

#### Defined in

[packages/components/src/button/button.tsx:90](https://github.com/vtex/shoreline/blob/7e966c5a4/packages/components/src/button/button.tsx#L90)
[packages/components/src/button/button.tsx:90](https://github.com/vtex/shoreline/blob/bf9009f50/packages/components/src/button/button.tsx#L90)

---

Expand All @@ -74,7 +74,7 @@ Increase or decrease padding.

#### Defined in

[packages/components/src/button/button.tsx:75](https://github.com/vtex/shoreline/blob/7e966c5a4/packages/components/src/button/button.tsx#L75)
[packages/components/src/button/button.tsx:75](https://github.com/vtex/shoreline/blob/bf9009f50/packages/components/src/button/button.tsx#L75)

---

Expand All @@ -92,4 +92,4 @@ Change between color combinations.

#### Defined in

[packages/components/src/button/button.tsx:80](https://github.com/vtex/shoreline/blob/7e966c5a4/packages/components/src/button/button.tsx#L80)
[packages/components/src/button/button.tsx:80](https://github.com/vtex/shoreline/blob/bf9009f50/packages/components/src/button/button.tsx#L80)
2 changes: 1 addition & 1 deletion packages/next-docs/pages/components/center/props.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@

#### Defined in

[packages/components/src/center/center.tsx:12](https://github.com/vtex/shoreline/blob/7e966c5a4/packages/components/src/center/center.tsx#L12)
[packages/components/src/center/center.tsx:12](https://github.com/vtex/shoreline/blob/bf9009f50/packages/components/src/center/center.tsx#L12)
10 changes: 5 additions & 5 deletions packages/next-docs/pages/components/checkbox-field/props.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ false;

#### Defined in

[packages/components/src/checkbox/checkbox-field.tsx:52](https://github.com/vtex/shoreline/blob/7e966c5a4/packages/components/src/checkbox/checkbox-field.tsx#L52)
[packages/components/src/checkbox/checkbox-field.tsx:52](https://github.com/vtex/shoreline/blob/bf9009f50/packages/components/src/checkbox/checkbox-field.tsx#L52)

---

Expand All @@ -34,7 +34,7 @@ Error message

#### Defined in

[packages/components/src/checkbox/checkbox-field.tsx:56](https://github.com/vtex/shoreline/blob/7e966c5a4/packages/components/src/checkbox/checkbox-field.tsx#L56)
[packages/components/src/checkbox/checkbox-field.tsx:56](https://github.com/vtex/shoreline/blob/bf9009f50/packages/components/src/checkbox/checkbox-field.tsx#L56)

---

Expand All @@ -46,7 +46,7 @@ Help message

#### Defined in

[packages/components/src/checkbox/checkbox-field.tsx:60](https://github.com/vtex/shoreline/blob/7e966c5a4/packages/components/src/checkbox/checkbox-field.tsx#L60)
[packages/components/src/checkbox/checkbox-field.tsx:60](https://github.com/vtex/shoreline/blob/bf9009f50/packages/components/src/checkbox/checkbox-field.tsx#L60)

---

Expand All @@ -60,7 +60,7 @@ AriaCheckboxProps.indeterminate

#### Defined in

[packages/components/src/checkbox/use-aria-checkbox.ts:87](https://github.com/vtex/shoreline/blob/7e966c5a4/packages/components/src/checkbox/use-aria-checkbox.ts#L87)
[packages/components/src/checkbox/use-aria-checkbox.ts:87](https://github.com/vtex/shoreline/blob/bf9009f50/packages/components/src/checkbox/use-aria-checkbox.ts#L87)

---

Expand All @@ -74,4 +74,4 @@ AriaCheckboxProps.value

#### Defined in

[packages/components/src/checkbox/use-aria-checkbox.ts:88](https://github.com/vtex/shoreline/blob/7e966c5a4/packages/components/src/checkbox/use-aria-checkbox.ts#L88)
[packages/components/src/checkbox/use-aria-checkbox.ts:88](https://github.com/vtex/shoreline/blob/bf9009f50/packages/components/src/checkbox/use-aria-checkbox.ts#L88)
10 changes: 5 additions & 5 deletions packages/next-docs/pages/components/checkbox-group/props.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

#### Defined in

[packages/components/src/checkbox/checkbox-group.tsx:45](https://github.com/vtex/shoreline/blob/7e966c5a4/packages/components/src/checkbox/checkbox-group.tsx#L45)
[packages/components/src/checkbox/checkbox-group.tsx:48](https://github.com/vtex/shoreline/blob/bf9009f50/packages/components/src/checkbox/checkbox-group.tsx#L48)

---

Expand All @@ -24,7 +24,7 @@

#### Defined in

[packages/components/src/checkbox/checkbox-group.tsx:41](https://github.com/vtex/shoreline/blob/7e966c5a4/packages/components/src/checkbox/checkbox-group.tsx#L41)
[packages/components/src/checkbox/checkbox-group.tsx:44](https://github.com/vtex/shoreline/blob/bf9009f50/packages/components/src/checkbox/checkbox-group.tsx#L44)

---

Expand All @@ -34,7 +34,7 @@

#### Defined in

[packages/components/src/checkbox/checkbox-group.tsx:43](https://github.com/vtex/shoreline/blob/7e966c5a4/packages/components/src/checkbox/checkbox-group.tsx#L43)
[packages/components/src/checkbox/checkbox-group.tsx:46](https://github.com/vtex/shoreline/blob/bf9009f50/packages/components/src/checkbox/checkbox-group.tsx#L46)

---

Expand All @@ -44,7 +44,7 @@

#### Defined in

[packages/components/src/checkbox/checkbox-group.tsx:42](https://github.com/vtex/shoreline/blob/7e966c5a4/packages/components/src/checkbox/checkbox-group.tsx#L42)
[packages/components/src/checkbox/checkbox-group.tsx:45](https://github.com/vtex/shoreline/blob/bf9009f50/packages/components/src/checkbox/checkbox-group.tsx#L45)

---

Expand All @@ -54,4 +54,4 @@

#### Defined in

[packages/components/src/checkbox/checkbox-group.tsx:44](https://github.com/vtex/shoreline/blob/7e966c5a4/packages/components/src/checkbox/checkbox-group.tsx#L44)
[packages/components/src/checkbox/checkbox-group.tsx:47](https://github.com/vtex/shoreline/blob/bf9009f50/packages/components/src/checkbox/checkbox-group.tsx#L47)
6 changes: 3 additions & 3 deletions packages/next-docs/pages/components/checkbox/props.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ false;

#### Defined in

[packages/components/src/checkbox/checkbox.tsx:65](https://github.com/vtex/shoreline/blob/7e966c5a4/packages/components/src/checkbox/checkbox.tsx#L65)
[packages/components/src/checkbox/checkbox.tsx:65](https://github.com/vtex/shoreline/blob/bf9009f50/packages/components/src/checkbox/checkbox.tsx#L65)

---

Expand All @@ -36,7 +36,7 @@ AriaCheckboxProps.indeterminate

#### Defined in

[packages/components/src/checkbox/use-aria-checkbox.ts:87](https://github.com/vtex/shoreline/blob/7e966c5a4/packages/components/src/checkbox/use-aria-checkbox.ts#L87)
[packages/components/src/checkbox/use-aria-checkbox.ts:87](https://github.com/vtex/shoreline/blob/bf9009f50/packages/components/src/checkbox/use-aria-checkbox.ts#L87)

---

Expand All @@ -50,4 +50,4 @@ AriaCheckboxProps.value

#### Defined in

[packages/components/src/checkbox/use-aria-checkbox.ts:88](https://github.com/vtex/shoreline/blob/7e966c5a4/packages/components/src/checkbox/use-aria-checkbox.ts#L88)
[packages/components/src/checkbox/use-aria-checkbox.ts:88](https://github.com/vtex/shoreline/blob/bf9009f50/packages/components/src/checkbox/use-aria-checkbox.ts#L88)
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ Children to bubble event

#### Defined in

[packages/components/src/clickable/clickable-bubble.tsx:25](https://github.com/vtex/shoreline/blob/7e966c5a4/packages/components/src/clickable/clickable-bubble.tsx#L25)
[packages/components/src/clickable/clickable-bubble.tsx:25](https://github.com/vtex/shoreline/blob/bf9009f50/packages/components/src/clickable/clickable-bubble.tsx#L25)
2 changes: 1 addition & 1 deletion packages/next-docs/pages/components/clickable/props.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,4 @@ false;

#### Defined in

[packages/components/src/clickable/clickable.tsx:52](https://github.com/vtex/shoreline/blob/7e966c5a4/packages/components/src/clickable/clickable.tsx#L52)
[packages/components/src/clickable/clickable.tsx:52](https://github.com/vtex/shoreline/blob/bf9009f50/packages/components/src/clickable/clickable.tsx#L52)
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,4 @@ false;

#### Defined in

[packages/components/src/combobox/combobox-item.tsx:32](https://github.com/vtex/shoreline/blob/7e966c5a4/packages/components/src/combobox/combobox-item.tsx#L32)
[packages/components/src/combobox/combobox-item.tsx:32](https://github.com/vtex/shoreline/blob/bf9009f50/packages/components/src/combobox/combobox-item.tsx#L32)
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,4 @@ false;

#### Defined in

[packages/components/src/combobox/combobox-list.tsx:27](https://github.com/vtex/shoreline/blob/7e966c5a4/packages/components/src/combobox/combobox-list.tsx#L27)
[packages/components/src/combobox/combobox-list.tsx:27](https://github.com/vtex/shoreline/blob/bf9009f50/packages/components/src/combobox/combobox-list.tsx#L27)
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,4 @@ false;

#### Defined in

[packages/components/src/combobox/combobox-popover.tsx:32](https://github.com/vtex/shoreline/blob/7e966c5a4/packages/components/src/combobox/combobox-popover.tsx#L32)
[packages/components/src/combobox/combobox-popover.tsx:32](https://github.com/vtex/shoreline/blob/bf9009f50/packages/components/src/combobox/combobox-popover.tsx#L32)
2 changes: 1 addition & 1 deletion packages/next-docs/pages/components/combobox/props.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,4 @@ false;

#### Defined in

[packages/components/src/combobox/combobox.tsx:32](https://github.com/vtex/shoreline/blob/7e966c5a4/packages/components/src/combobox/combobox.tsx#L32)
[packages/components/src/combobox/combobox.tsx:32](https://github.com/vtex/shoreline/blob/bf9009f50/packages/components/src/combobox/combobox.tsx#L32)
2 changes: 1 addition & 1 deletion packages/next-docs/pages/components/composable/code.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -66,4 +66,4 @@ Prefix <Composable>{children}</Composable>

#### Defined in

[packages/components/src/compose/composable.tsx:17](https://github.com/vtex/shoreline/blob/7e966c5a4/packages/components/src/compose/composable.tsx#L17)
[packages/components/src/compose/composable.tsx:17](https://github.com/vtex/shoreline/blob/bf9009f50/packages/components/src/compose/composable.tsx#L17)
4 changes: 2 additions & 2 deletions packages/next-docs/pages/components/composable/props.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

#### Defined in

[packages/components/src/compose/composable.tsx:29](https://github.com/vtex/shoreline/blob/7e966c5a4/packages/components/src/compose/composable.tsx#L29)
[packages/components/src/compose/composable.tsx:29](https://github.com/vtex/shoreline/blob/bf9009f50/packages/components/src/compose/composable.tsx#L29)

---

Expand All @@ -18,4 +18,4 @@

#### Defined in

[packages/components/src/compose/composable.tsx:28](https://github.com/vtex/shoreline/blob/7e966c5a4/packages/components/src/compose/composable.tsx#L28)
[packages/components/src/compose/composable.tsx:28](https://github.com/vtex/shoreline/blob/bf9009f50/packages/components/src/compose/composable.tsx#L28)
2 changes: 1 addition & 1 deletion packages/next-docs/pages/components/compose/props.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ HTMLAttributes.children

#### Defined in

[packages/components/src/compose/compose.tsx:33](https://github.com/vtex/shoreline/blob/7e966c5a4/packages/components/src/compose/compose.tsx#L33)
[packages/components/src/compose/compose.tsx:33](https://github.com/vtex/shoreline/blob/bf9009f50/packages/components/src/compose/compose.tsx#L33)
2 changes: 1 addition & 1 deletion packages/next-docs/pages/components/container/props.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,4 @@ Select the rendered html tag

#### Defined in

[packages/components/src/content/container.tsx:30](https://github.com/vtex/shoreline/blob/7e966c5a4/packages/components/src/content/container.tsx#L30)
[packages/components/src/content/container.tsx:31](https://github.com/vtex/shoreline/blob/bf9009f50/packages/components/src/content/container.tsx#L31)
4 changes: 2 additions & 2 deletions packages/next-docs/pages/components/content/props.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Select the rendered html tag

#### Defined in

[packages/components/src/content/content.tsx:31](https://github.com/vtex/shoreline/blob/7e966c5a4/packages/components/src/content/content.tsx#L31)
[packages/components/src/content/content.tsx:31](https://github.com/vtex/shoreline/blob/bf9009f50/packages/components/src/content/content.tsx#L31)

---

Expand All @@ -40,4 +40,4 @@ false;

#### Defined in

[packages/components/src/content/content.tsx:36](https://github.com/vtex/shoreline/blob/7e966c5a4/packages/components/src/content/content.tsx#L36)
[packages/components/src/content/content.tsx:36](https://github.com/vtex/shoreline/blob/bf9009f50/packages/components/src/content/content.tsx#L36)
57 changes: 57 additions & 0 deletions packages/next-docs/pages/components/contextual-help/code.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
### ContextualHelp

**ContextualHelp**(`props`): `null` \| `ReactElement`\<`any`, `string` \| `JSXElementConstructor`\<`any`\>\>

Shows the user information relative to a context

#### Parameters

| Name | Type |
| :------ | :--------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `props` | [`ContextualHelpProps`](/components/contextual-help/props.md) & `RefAttributes`\<[`HTMLDivElement`](https://developer.mozilla.org/docs/Web/API/HTMLDivElement)\> |

#### Returns

`null` \| `ReactElement`\<`any`, `string` \| `JSXElementConstructor`\<`any`\>\>

**`Example`**

```tsx copy showLineNumbers filename="example.tsx"
<ContextualHelp label="Meaningful label">Help message</ContextualHelp>
```

import {
SandpackProvider,
SandpackLayout,
SandpackCodeEditor,
SandpackPreview,
} from '@codesandbox/sandpack-react'

<SandpackProvider
template="react"
theme="dark"
customSetup={{ dependencies: { '@vtex/shoreline-components': '^0.x' } }}
files={{'/App.js': `import React from 'react'
import { ContextualHelp } from '@vtex/shoreline-components'
export default function App() {
return (<>
<ContextualHelp label="Meaningful label">
Help message
</ContextualHelp>
</>
)}`,
}}

>

<SandpackLayout>
<SandpackCodeEditor />
<SandpackPreview />
</SandpackLayout>

</SandpackProvider>

#### Defined in

node_modules/.pnpm/@types+react@18.2.14/node_modules/@types/react/ts5.0/index.d.ts:355
Loading

0 comments on commit 4605b9b

Please sign in to comment.