Skip to content

Commit

Permalink
docs: generate interfaces/props from components
Browse files Browse the repository at this point in the history
  • Loading branch information
marcelovicentegc committed Nov 22, 2023
1 parent 9b5214c commit 9cdfd75
Show file tree
Hide file tree
Showing 92 changed files with 4,416 additions and 358 deletions.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
6 changes: 0 additions & 6 deletions packages/next-docs/pages/components/_meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@
"combobox-item": "ComboboxItem",
"combobox-list": "ComboboxList",
"combobox-popover": "ComboboxPopover",
"combobox-provider": "ComboboxProvider",
"composable": "Composable",
"compose": "Compose",
"container": "Container",
Expand All @@ -40,15 +39,13 @@
"locale-provider": "LocaleProvider",
"menu": "Menu",
"menu-item": "MenuItem",
"menu-provider": "MenuProvider",
"menu-separator": "MenuSeparator",
"menu-trigger": "MenuTrigger",
"modal": "Modal",
"modal-header": "ModalHeader",
"pagination": "Pagination",
"popover": "Popover",
"popover-dismiss": "PopoverDismiss",
"popover-provider": "PopoverProvider",
"popover-trigger": "PopoverTrigger",
"radio": "Radio",
"radio-group": "RadioGroup",
Expand All @@ -60,15 +57,13 @@
"select-option": "SelectOption",
"select-option-check": "SelectOptionCheck",
"select-popover": "SelectPopover",
"select-provider": "SelectProvider",
"simple-table": "SimpleTable",
"skeleton": "Skeleton",
"spinner": "Spinner",
"stack": "Stack",
"tab": "Tab",
"tab-list": "TabList",
"tab-panel": "TabPanel",
"tab-provider": "TabProvider",
"table": "Table",
"table-body": "TableBody",
"table-cell": "TableCell",
Expand All @@ -83,6 +78,5 @@
"tooltip-anchor": "TooltipAnchor",
"tooltip-arrow": "TooltipArrow",
"tooltip-popover": "TooltipPopover",
"tooltip-provider": "TooltipProvider",
"visually-hidden": "VisuallyHidden"
}
34 changes: 34 additions & 0 deletions packages/next-docs/pages/components/alert/props.mdx
Original file line number Diff line number Diff line change
@@ -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)
126 changes: 126 additions & 0 deletions packages/next-docs/pages/components/bleed/props.mdx
Original file line number Diff line number Diff line change
@@ -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)
105 changes: 105 additions & 0 deletions packages/next-docs/pages/components/button/props.mdx
Original file line number Diff line number Diff line change
@@ -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)
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/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)
Loading

0 comments on commit 9cdfd75

Please sign in to comment.