fix(text-area): export readonly prop (#1043)

Fixes #1009
This commit is contained in:
metonym 2022-01-26 19:19:49 -08:00 committed by GitHub
commit 3018c2b207
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 22 additions and 1 deletions

View file

@ -4110,6 +4110,7 @@ None.
| rows | <code>let</code> | No | <code>number</code> | <code>4</code> | Specify the number of rows | | rows | <code>let</code> | No | <code>number</code> | <code>4</code> | Specify the number of rows |
| light | <code>let</code> | No | <code>boolean</code> | <code>false</code> | Set to `true` to enable the light variant | | light | <code>let</code> | No | <code>boolean</code> | <code>false</code> | Set to `true` to enable the light variant |
| disabled | <code>let</code> | No | <code>boolean</code> | <code>false</code> | Set to `true` to disable the input | | disabled | <code>let</code> | No | <code>boolean</code> | <code>false</code> | Set to `true` to disable the input |
| readonly | <code>let</code> | No | <code>boolean</code> | <code>false</code> | Set to `true` to use the read-only variant |
| helperText | <code>let</code> | No | <code>string</code> | <code>""</code> | Specify the helper text | | helperText | <code>let</code> | No | <code>string</code> | <code>""</code> | Specify the helper text |
| labelText | <code>let</code> | No | <code>string</code> | <code>""</code> | Specify the label text | | labelText | <code>let</code> | No | <code>string</code> | <code>""</code> | Specify the label text |
| hideLabel | <code>let</code> | No | <code>boolean</code> | <code>false</code> | Set to `true` to visually hide the label text | | hideLabel | <code>let</code> | No | <code>boolean</code> | <code>false</code> | Set to `true` to visually hide the label text |

View file

@ -11386,6 +11386,17 @@
"constant": false, "constant": false,
"reactive": false "reactive": false
}, },
{
"name": "readonly",
"kind": "let",
"description": "Set to `true` to use the read-only variant",
"type": "boolean",
"value": "false",
"isFunction": false,
"isFunctionDeclaration": false,
"constant": false,
"reactive": false
},
{ {
"name": "helperText", "name": "helperText",
"kind": "let", "kind": "let",

View file

@ -17,6 +17,9 @@
/** Set to `true` to disable the input */ /** Set to `true` to disable the input */
export let disabled = false; export let disabled = false;
/** Set to `true` to use the read-only variant */
export let readonly = false;
/** Specify the helper text */ /** Specify the helper text */
export let helperText = ""; export let helperText = "";
@ -87,11 +90,11 @@
rows="{rows}" rows="{rows}"
value="{value ?? ''}" value="{value ?? ''}"
placeholder="{placeholder}" placeholder="{placeholder}"
readonly="{readonly}"
class:bx--text-area="{true}" class:bx--text-area="{true}"
class:bx--text-area--light="{light}" class:bx--text-area--light="{light}"
class:bx--text-area--invalid="{invalid}" class:bx--text-area--invalid="{invalid}"
{...$$restProps} {...$$restProps}
readonly="{$$restProps.readonly === true ? true : undefined}"
on:change on:change
on:input on:input
on:input="{({ target }) => { on:input="{({ target }) => {

View file

@ -39,6 +39,12 @@ export interface TextAreaProps
*/ */
disabled?: boolean; disabled?: boolean;
/**
* Set to `true` to use the read-only variant
* @default false
*/
readonly?: boolean;
/** /**
* Specify the helper text * Specify the helper text
* @default "" * @default ""