Skip to content

Commit

Permalink
Docs(web-react): Added styleProps in the Tabs README API Tables #DS-977
Browse files Browse the repository at this point in the history
- UNSAFE_className and UNSAFE_style added to API tables for
TabsContent, TabItem, TabList and TabPane
  • Loading branch information
pavelklibani committed Nov 15, 2023
1 parent 63fefcb commit e27e8bc
Showing 1 changed file with 22 additions and 14 deletions.
36 changes: 22 additions & 14 deletions packages/web-react/src/components/Tabs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,20 +89,24 @@ Tab list

#### API

| Name | Type | Default | Required | Description |
| ---------- | ----- | ------- | -------- | --------------- |
| `children` | `any` ||| Child component |
| Name | Type | Default | Required | Description |
| ------------------ | --------------- | ------- | -------- | ------------------------- |
| `children` | `any` ||| Child component |
| `UNSAFE_className` | `string` ||| Wrapper custom class name |
| `UNSAFE_style` | `CSSProperties` ||| Wrapper custom style |

### TabItem

Tab list item

#### API

| Name | Type | Default | Required | Description |
| ---------- | ---------------------- | ------- | -------- | --------------------- |
| `forTab` | [`string` \| `number`] ||| Identification of tab |
| `children` | `any` ||| Child component |
| Name | Type | Default | Required | Description |
| ------------------ | ---------------------- | ------- | -------- | ------------------------- |
| `forTab` | [`string` \| `number`] ||| Identification of tab |
| `children` | `any` ||| Child component |
| `UNSAFE_className` | `string` ||| Wrapper custom class name |
| `UNSAFE_style` | `CSSProperties` ||| Wrapper custom style |

### TabLink

Expand All @@ -122,19 +126,23 @@ Tab content wrapper

#### API

| Name | Type | Default | Required | Description |
| ---------- | ----- | ------- | -------- | --------------- |
| `children` | `any` ||| Child component |
| Name | Type | Default | Required | Description |
| ------------------ | --------------- | ------- | -------- | ------------------------- |
| `children` | `any` ||| Child component |
| `UNSAFE_className` | `string` ||| Wrapper custom class name |
| `UNSAFE_style` | `CSSProperties` ||| Wrapper custom style |

### TabPane

Tab content item

#### API

| Name | Type | Default | Required | Description |
| ---------- | ---------------------- | ------- | -------- | --------------------- |
| `tabId` | [`string` \| `number`] ||| Identification of tab |
| `children` | `any` ||| Child component |
| Name | Type | Default | Required | Description |
| ------------------ | ---------------------- | ------- | -------- | ------------------------- |
| `tabId` | [`string` \| `number`] ||| Identification of tab |
| `children` | `any` ||| Child component |
| `UNSAFE_className` | `string` ||| Wrapper custom class name |
| `UNSAFE_style` | `CSSProperties` ||| Wrapper custom style |

For detailed information see [Tabs](https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web/src/scss/components/Tabs/README.md) component.

0 comments on commit e27e8bc

Please sign in to comment.