Skip to content

Commit

Permalink
docs: update component READMEs (#5824)
Browse files Browse the repository at this point in the history 
This PR was automatically generated by the update-doc GitHub action

Co-authored-by: jcfranco <jcfranco@users.noreply.github.com>
  • Loading branch information
@calcite-admin @jcfranco
calcite-admin and jcfranco authored Nov 29, 2022
1 parent 32ad03f commit 3250af0
Show file tree
Hide file tree
Showing 3 changed files with 64 additions and 57 deletions.
1 change: 1 addition & 0 deletions src/components/input-number/readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
| Property | Attribute | Description | Type | Default |
| ------------------ | -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------- |
| `alignment` | `alignment` | Specifies the text alignment of the component's value. | `"end" \| "start"` | `"start"` |
| `autocomplete` | `autocomplete` | Specifies the type of content to autocomplete, for use in forms. Read the native attribute's documentation on MDN for more info. | `string` | `undefined` |
| `autofocus` | `autofocus` | When `true`, the component is focused on page load. | `boolean` | `false` |
| `clearable` | `clearable` | When `true`, a clear button is displayed when the component has a value. | `boolean` | `false` |
| `disabled` | `disabled` | When `true`, interaction is prevented and the component is displayed with lower opacity. | `boolean` | `false` |
Expand Down
50 changes: 26 additions & 24 deletions src/components/input-text/readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,30 +4,32 @@

## Properties

| Property | Attribute | Description | Type | Default |
| ------------- | --------------- | --------------------------------------------------------------------------------------------------------------------- | -------------------------------- | --------------------- |
| `alignment` | `alignment` | Specifies the text alignment of the component's value. | `"end" \| "start"` | `"start"` |
| `autofocus` | `autofocus` | When `true`, the component is focused on page load. | `boolean` | `false` |
| `clearable` | `clearable` | When `true`, a clear button is displayed when the component has a value. | `boolean` | `false` |
| `disabled` | `disabled` | When `true`, interaction is prevented and the component is displayed with lower opacity. | `boolean` | `false` |
| `hidden` | `hidden` | When `true`, the component will not be visible. | `boolean` | `false` |
| `icon` | `icon` | When `true`, shows a default recommended icon. Alternatively, pass a Calcite UI Icon name to display a specific icon. | `boolean \| string` | `undefined` |
| `iconFlipRtl` | `icon-flip-rtl` | When `true`, the icon will be flipped when the element direction is right-to-left (`"rtl"`). | `boolean` | `false` |
| `intlClear` | `intl-clear` | A text label that will appear on the clear button for screen readers. | `string` | `undefined` |
| `intlLoading` | `intl-loading` | Accessible name that will appear while loading. | `string` | `COMMON_TEXT.loading` |
| `label` | `label` | Accessible name for the component's button or hyperlink. | `string` | `undefined` |
| `loading` | `loading` | When `true`, the component is in the loading state and `calcite-progress` is displayed. | `boolean` | `false` |
| `maxLength` | `max-length` | Specifies the maximum length of text for the component's value. | `number` | `undefined` |
| `minLength` | `min-length` | Specifies the minimum length of text for the component's value. | `number` | `undefined` |
| `name` | `name` | Specifies the name of the component. | `string` | `undefined` |
| `placeholder` | `placeholder` | Specifies placeholder text for the component. | `string` | `undefined` |
| `prefixText` | `prefix-text` | Adds text to the start of the component. | `string` | `undefined` |
| `readOnly` | `read-only` | When `true`, the component's value can be read, but cannot be modified. | `boolean` | `false` |
| `required` | `required` | When `true`, the component must have a value in order for the form to submit. | `boolean` | `false` |
| `scale` | `scale` | Specifies the size of the component. | `"l" \| "m" \| "s"` | `"m"` |
| `status` | `status` | Specifies the status of the input field, which determines message and icons. | `"idle" \| "invalid" \| "valid"` | `"idle"` |
| `suffixText` | `suffix-text` | Adds text to the end of the component. | `string` | `undefined` |
| `value` | `value` | The component's value. | `string` | `""` |
| Property | Attribute | Description | Type | Default |
| -------------- | --------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- | --------------------- |
| `alignment` | `alignment` | Specifies the text alignment of the component's value. | `"end" \| "start"` | `"start"` |
| `autocomplete` | `autocomplete` | Specifies the type of content to autocomplete, for use in forms. Read the native attribute's documentation on MDN for more info. | `string` | `undefined` |
| `autofocus` | `autofocus` | When `true`, the component is focused on page load. | `boolean` | `false` |
| `clearable` | `clearable` | When `true`, a clear button is displayed when the component has a value. | `boolean` | `false` |
| `disabled` | `disabled` | When `true`, interaction is prevented and the component is displayed with lower opacity. | `boolean` | `false` |
| `hidden` | `hidden` | When `true`, the component will not be visible. | `boolean` | `false` |
| `icon` | `icon` | When `true`, shows a default recommended icon. Alternatively, pass a Calcite UI Icon name to display a specific icon. | `boolean \| string` | `undefined` |
| `iconFlipRtl` | `icon-flip-rtl` | When `true`, the icon will be flipped when the element direction is right-to-left (`"rtl"`). | `boolean` | `false` |
| `intlClear` | `intl-clear` | A text label that will appear on the clear button for screen readers. | `string` | `undefined` |
| `intlLoading` | `intl-loading` | Accessible name that will appear while loading. | `string` | `COMMON_TEXT.loading` |
| `label` | `label` | Accessible name for the component's button or hyperlink. | `string` | `undefined` |
| `loading` | `loading` | When `true`, the component is in the loading state and `calcite-progress` is displayed. | `boolean` | `false` |
| `maxLength` | `max-length` | Specifies the maximum length of text for the component's value. | `number` | `undefined` |
| `minLength` | `min-length` | Specifies the minimum length of text for the component's value. | `number` | `undefined` |
| `name` | `name` | Specifies the name of the component. | `string` | `undefined` |
| `pattern` | `pattern` | Specifies a regex pattern the component's `value` must match for validation. Read the native attribute's documentation on MDN for more info. | `string` | `undefined` |
| `placeholder` | `placeholder` | Specifies placeholder text for the component. | `string` | `undefined` |
| `prefixText` | `prefix-text` | Adds text to the start of the component. | `string` | `undefined` |
| `readOnly` | `read-only` | When `true`, the component's value can be read, but cannot be modified. | `boolean` | `false` |
| `required` | `required` | When `true`, the component must have a value in order for the form to submit. | `boolean` | `false` |
| `scale` | `scale` | Specifies the size of the component. | `"l" \| "m" \| "s"` | `"m"` |
| `status` | `status` | Specifies the status of the input field, which determines message and icons. | `"idle" \| "invalid" \| "valid"` | `"idle"` |
| `suffixText` | `suffix-text` | Adds text to the end of the component. | `string` | `undefined` |
| `value` | `value` | The component's value. | `string` | `""` |

## Events

Expand Down
Loading

0 comments on commit 3250af0

Please sign in to comment.