Skip to content

Commit

Permalink
add witdth to doku
Browse files Browse the repository at this point in the history
  • Loading branch information
@sebald
sebald committed May 14, 2022
1 parent da5f2ea commit bb14498
Show file tree
Hide file tree
Showing 8 changed files with 23 additions and 16 deletions.
13 changes: 7 additions & 6 deletions docs/content/components/checkbox.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,13 @@ import { Checkbox, CheckboxGroup } from '@marigold/components';

## Props

| Name | Type | Default | Description |
| :----------------- | :-------- | :---------- | :----------------------------------------------------------------------------------------------------------------- |
| `variant` | `string` | | Use a different _variant_ from theme |
| `size` | `string` | `'level-1'` | Use a different _size_ from theme |
| `error` (optional) | `boolean` | `false` | If `true`, the checkbox is considered invalid and if set the `errorMessage` is shown instead of the `description`. |
| ... | | | Yes you can use all regular attributes of `input`! |
| Name | Type | Default | Description |
| :------------------- | :-------- | :---------- | :----------------------------------------------------------------------------------------------------------------- |
| `variant` (optional) | `string` | | Use a different _variant_ from theme |
| `size` (optional) | `string` | `'level-1'` | Use a different _size_ from theme |
| `error` (optional) | `boolean` | `false` | If `true`, the checkbox is considered invalid and if set the `errorMessage` is shown instead of the `description`. |
| `width` (optional) | `string` | `100%` | Control the width of the field. |
| ... | | | Yes you can use all regular attributes of `input`! |

## Examples

Expand Down
1 change: 1 addition & 0 deletions docs/content/components/number-field.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ import { NumberField } from '@marigold/components';
| `readOnly` (optional) | `boolean` | `false` | If `true`, the input is readOnly. |
| `onChange` (optional) | `function` | | A callback function that is called with the input's current `value` when the input value changes. |
| `formatOptions` (optional) | `Intl.NumberFormatOptions` | | Apply formatting. See [`Intl.NumberFormatOptions`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat) for available options. |
| `width` (optional) | `string` | `100%` | Control the width of the field. |
| ... | | | Yes you can use all regular attributes of `input`! |

## Examples
Expand Down
13 changes: 7 additions & 6 deletions docs/content/components/radio.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,12 +32,13 @@ import { Radio } from '@marigold/components';

## Props

| Name | Type | Default | Description |
| :----------------- | :-------- | :---------- | :----------------------------------------------------------------------------------------------------------------- |
| `variant` | `string` | | Use a different _variant_ from theme |
| `size` | `string` | `'level-1'` | Use a different _size_ from theme |
| `error` (optional) | `boolean` | `false` | If `true`, the checkbox is considered invalid and if set the `errorMessage` is shown instead of the `description`. |
| ... | | | Yes you can use all regular attributes of `input`! |
| Name | Type | Default | Description |
| :------------------- | :-------- | :---------- | :----------------------------------------------------------------------------------------------------------------- |
| `variant` (optional) | `string` | | Use a different _variant_ from theme |
| `size` (optional) | `string` | `'level-1'` | Use a different _size_ from theme |
| `error` (optional) | `boolean` | `false` | If `true`, the checkbox is considered invalid and if set the `errorMessage` is shown instead of the `description`. |
| `width` (optional) | `string` | `100%` | Control the width of the field. |
| ... | | | Yes you can use all regular attributes of `input`! |

## Examples

Expand Down
1 change: 1 addition & 0 deletions docs/content/components/select.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ import { Select } from '@marigold/components';
| `errorMessage` (optional) | `string` | |
| `width` (optional) | `ResponsiveStyleValue<number⎮string>` | |
| `onSelectionChange` (optional) | `(key: Key) => any` | |
| `width` (optional) | `string` | `100%` |

## Examples

Expand Down
2 changes: 1 addition & 1 deletion docs/content/components/slider.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,12 +35,12 @@ import { Slider } from '@marigold/components';
| Property | Type | Default | Description |
| :------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------- | :------ | :-------------------------------------------------------------- |
| `disabled` (optional) | `boolean` | `false` | If `true`, the slider is disabled. |
| `width` (optional) | `string, boolean` | `100%` | The slider's width value. |
| `value` (optional) | `number[]` | | The slider's value (controlled). |
| `defaultValue` (optional) | `number[]` | | The slider's default value (uncontrolled). |
| `maxValue` (optional) | `number` | `100` | The slider's maximum value. |
| `step` (optional) | `number` | | The slider's step value. |
| `formatOptions` (optional) | [`Intl.NumberFormatOptions`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat) | | The slider's step value. |
| `width` (optional) | `string` | `100%` | Control the width of the field. |
| ... | | | Yes you can use all regular attributes of `input type = range`! |

## Examples
Expand Down
5 changes: 3 additions & 2 deletions docs/content/components/switch.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,13 @@ import { Switch } from '@marigold/components';

## Props

| Property | Type | Default |
| :-------------------- | :-------- | :------ |
| Property | Type | Default | Description |
| :-------------------- | :-------- | :------ | ------------------------------- |
| `variant` (optional) | `string` | `` |
| `disabled` (optional) | `boolean` | `false` |
| `checked` (optional) | `boolean` | `false` |
| `size` (optional) | `string` | `` |
| `width` (optional) | `string` | `100%` | Control the width of the field. |

## Examples

Expand Down
3 changes: 2 additions & 1 deletion docs/content/components/text-area.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,8 @@ import { TextArea } from '@marigold/components';
| `required` (optional) | `boolean` | `false` | If `true`, the input is required. |
| `readOnly` (optional) | `boolean` | `false` | If `true`, the input is readOnly. |
| `onChange` (optional) | `function` | | A callback function that is called with the input's current `value` when the input value changes. |
| others | | | Yes you can use all regular attributes of `textarea`! |
| `width` (optional) | `string` | `100%` | Control the width of the field. |
| ... | | | Yes you can use all regular attributes of `textarea`! |

## Examples

Expand Down
1 change: 1 addition & 0 deletions docs/content/components/text-field.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ import { TextField } from '@marigold/components';
| `readOnly` (optional) | `boolean` | `false` | If `true`, the input is readOnly. |
| `type` (optional) | `string` | `text` | The type of the input field. |
| `onChange` (optional) | `function` | | A callback function that is called with the input's current `value` when the input value changes. |
| `width` (optional) | `string` | `100%` | Control the width of the field. |
| ... | | | Yes you can use all regular attributes of `input`! |

## Examples
Expand Down

0 comments on commit bb14498

Please sign in to comment.