Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(Forms): lists component specific props 1st #2892

Merged
merged 1 commit into from
Nov 13, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ import DataValueReadwriteProperties from '../../data-value-readwrite-properties.

## Properties

<DataValueReadwriteProperties type="Array<number | string>" />

### Component-specific props

| Property | Type | Description |
Expand All @@ -16,3 +14,5 @@ import DataValueReadwriteProperties from '../../data-value-readwrite-properties.
| `optionsLayout` | `string` | _(optional)_ Layout for the list of options. Can be `horizontal` or `vertical` |
| `children` | `React.Node` | _(optional)_ For providing Option components |
| [Space](/uilib/layout/space/properties) | Various | _(optional)_ Spacing properties like `top` or `bottom` are supported. |

<DataValueReadwriteProperties type="Array<number | string>" />
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ import DataValueReadwriteProperties from '../../data-value-readwrite-properties.

## Properties

<DataValueReadwriteProperties type="boolean" />

### Component-specific props

| Property | Type | Description |
Expand All @@ -16,3 +14,5 @@ import DataValueReadwriteProperties from '../../data-value-readwrite-properties.
| `falseText` | `string` | Text to show in the UI when value is `false`. |
| `variant` | `string` | Choice of input feature. Can be: `checkbox`, `button`, `checkbox-button` or `buttons` |
| [Space](/uilib/layout/space/properties) | Various | _(optional)_ Spacing properties like `top` or `bottom` are supported. |

<DataValueReadwriteProperties type="boolean" />
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ import DataValueReadwriteProperties from '../../data-value-readwrite-properties.

## Properties

<DataValueReadwriteProperties type="number" />

### Component-specific props

| Property | Type | Description |
Expand All @@ -27,3 +25,5 @@ import DataValueReadwriteProperties from '../../data-value-readwrite-properties.
| `help` | `object` | _(optional)_ Provide a help button. Object consisting of `title` and `contents` |
| `autoComplete` | `on` or `string` | _(optional)_ For HTML `autocomplete` [attributes](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete). |
| [Space](/uilib/layout/space/properties) | Various | _(optional)_ Spacing properties like `top` or `bottom` are supported. |

<DataValueReadwriteProperties type="number" />
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ import DataValueReadwriteProperties from '../../data-value-readwrite-properties.

## Properties

<DataValueReadwriteProperties type="number | string" />

### Component-specific props

| Property | Type | Description |
Expand All @@ -19,3 +17,5 @@ import DataValueReadwriteProperties from '../../data-value-readwrite-properties.
| `clear` | `boolean` | _(optional)_ True to have a clear-option to remove selected option as value |
| `children` | `React.Node` | _(optional)_ For providing Option components |
| [Space](/uilib/layout/space/properties) | Various | _(optional)_ Spacing properties like `top` or `bottom` are supported. |

<DataValueReadwriteProperties type="number | string" />
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ import DataValueReadwriteProperties from '../../data-value-readwrite-properties.

## Properties

<DataValueReadwriteProperties type="any" />

### Component-specific props

| Property | Type | Description |
Expand All @@ -18,3 +16,5 @@ import DataValueReadwriteProperties from '../../data-value-readwrite-properties.
| `textOff` | `string` | _(optional)_ Text to show in the UI when in the "off-state". |
| `variant` | `string` | _(optional)_ Choice of input feature. Can be: `checkbox`, `button`, `checkbox-button` or `buttons` |
| [Space](/uilib/layout/space/properties) | Various | _(optional)_ Spacing properties like `top` or `bottom` are supported. |

<DataValueReadwriteProperties type="any" />
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@ import DataValueReadwriteProperties from '../../data-value-readwrite-properties.

## Properties

<DataValueReadwriteProperties type="string" />

### Component-specific props

| Property | Type | Description |
| --------------------------------------- | --------- | ------------------------------------------------------------------------------- |
| `validate` | `boolean` | _(optional)_ Using this prop you can disable the default validation. |
| `help` | `object` | _(optional)_ Provide a help button. Object consisting of `title` and `contents` |
| [Space](/uilib/layout/space/properties) | Various | _(optional)_ Spacing properties like `top` or `bottom` are supported. |

<DataValueReadwriteProperties type="string" />
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@ import DataValueReadwriteProperties from '../../data-value-readwrite-properties.

## Properties

<DataValueReadwriteProperties type="number" />

### Component-specific props

| Property | Type | Description |
| --------------------------------------- | -------- | ------------------------------------------------------------------------------- |
| `currency` | `string` | _(optional)_ Currency to show the value in. I.e `NOK` or `USD` |
| `help` | `object` | _(optional)_ Provide a help button. Object consisting of `title` and `contents` |
| [Space](/uilib/layout/space/properties) | Various | _(optional)_ Spacing properties like `top` or `bottom` are supported. |

<DataValueReadwriteProperties type="number" />
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ import DataValueReadwriteProperties from '../../data-value-readwrite-properties.

## Properties

<DataValueReadwriteProperties type="string" />

### Component-specific props

| Property | Type | Description |
| --------------------------------------- | -------- | ------------------------------------------------------------------------------- |
| `help` | `object` | _(optional)_ Provide a help button. Object consisting of `title` and `contents` |
| [Space](/uilib/layout/space/properties) | Various | _(optional)_ Spacing properties like `top` or `bottom` are supported. |

<DataValueReadwriteProperties type="string" />
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ import DataValueReadwriteProperties from '../../data-value-readwrite-properties.

## Properties

<DataValueReadwriteProperties type="string" />

### Component-specific props

| Property | Type | Description |
| --------------------------------------- | -------- | ------------------------------------------------------------------------------- |
| `help` | `object` | _(optional)_ Provide a help button. Object consisting of `title` and `contents` |
| [Space](/uilib/layout/space/properties) | Various | _(optional)_ Spacing properties like `top` or `bottom` are supported. |

<DataValueReadwriteProperties type="string" />
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@ import DataValueReadwriteProperties from '../../data-value-readwrite-properties.

## Properties

<DataValueReadwriteProperties type="string" />

### Component-specific props

| Property | Type | Description |
| --------------------------------------- | --------- | ------------------------------------------------------------------------------- |
| `validate` | `boolean` | _(optional)_ Using this prop you can disable the default validation. |
| `help` | `object` | _(optional)_ Provide a help button. Object consisting of `title` and `contents` |
| [Space](/uilib/layout/space/properties) | Various | _(optional)_ Spacing properties like `top` or `bottom` are supported. |

<DataValueReadwriteProperties type="string" />
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@ import DataValueReadwriteProperties from '../../data-value-readwrite-properties.

## Properties

<DataValueReadwriteProperties type="string" />

### Component-specific props

| Property | Type | Description |
| --------------------------------------- | --------- | ------------------------------------------------------------------------------- |
| `validate` | `boolean` | _(optional)_ Using this prop you can disable the default validation. |
| `help` | `object` | _(optional)_ Provide a help button. Object consisting of `title` and `contents` |
| [Space](/uilib/layout/space/properties) | Various | _(optional)_ Spacing properties like `top` or `bottom` are supported. |

<DataValueReadwriteProperties type="string" />
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ import DataValueReadwriteProperties from '../../data-value-readwrite-properties.

## Properties

<DataValueReadwriteProperties type="string" />

### Component-specific props

| Property | Type | Description |
Expand All @@ -20,3 +18,5 @@ import DataValueReadwriteProperties from '../../data-value-readwrite-properties.
| `numberMask` | Various | _(optional)_ See property `mask` of the [InputMasked](/uilib/components/input-masked/properties) component. |
| `width` | `string` or `false` | _(optional)_ `large` for predefined standard width, `stretch` for fill available width. |
| [Space](/uilib/layout/space/properties) | Various | _(optional)_ Spacing properties like `top` or `bottom` are supported. |

<DataValueReadwriteProperties type="string" />
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ showTabs: true

import DataValueReadwriteProperties from '../../data-value-readwrite-properties.mdx'

<DataValueReadwriteProperties />

### Component-specific props

| Property | Type | Description |
| --------------------------------------- | -------- | ------------------------------------------------------------------------------- |
| `help` | `object` | _(optional)_ Provide a help button. Object consisting of `title` and `contents` |
| [Space](/uilib/layout/space/properties) | Various | _(optional)_ Spacing properties like `top` or `bottom` are supported. |

<DataValueReadwriteProperties />
Loading