@synergy-design-system/metadata 1.0.0 → 3.0.1

package/data/layers/interface/component/component:syn-textarea.json

@@ -0,0 +1,532 @@
+{
+  "attributes": [
+    {
+      "description": "Controls whether and how text input is automatically capitalized as it is entered by the user.",
+      "fieldName": "autocapitalize",
+      "name": "autocapitalize",
+      "reflects": false,
+      "type": "'off' | 'none' | 'on' | 'sentences' | 'words' | 'characters'"
+    },
+    {
+      "description": "Specifies what permission the browser has to provide assistance in filling out form field values. Refer to\n[this page on MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete) for available values.",
+      "fieldName": "autocomplete",
+      "name": "autocomplete",
+      "reflects": false,
+      "type": "string"
+    },
+    {
+      "description": "Indicates whether the browser's autocorrect feature is on or off.",
+      "fieldName": "autocorrect",
+      "name": "autocorrect",
+      "reflects": true,
+      "type": "boolean"
+    },
+    {
+      "description": "Indicates that the input should receive focus on page load.",
+      "fieldName": "autofocus",
+      "name": "autofocus",
+      "reflects": false,
+      "type": "boolean"
+    },
+    {
+      "default": "false",
+      "description": "Disables the textarea.",
+      "fieldName": "disabled",
+      "name": "disabled",
+      "reflects": true,
+      "type": "boolean"
+    },
+    {
+      "description": "Used to customize the label or icon of the Enter key on virtual keyboards.",
+      "fieldName": "enterkeyhint",
+      "name": "enterkeyhint",
+      "reflects": false,
+      "type": "'enter' | 'done' | 'go' | 'next' | 'previous' | 'search' | 'send'"
+    },
+    {
+      "default": "''",
+      "description": "By default, form controls are associated with the nearest containing `<form>` element. This attribute allows you\nto place the form control outside of a form and associate it with the form that has this `id`. The form must be in\nthe same document or shadow root for this to work.",
+      "fieldName": "form",
+      "name": "form",
+      "reflects": true,
+      "type": "string"
+    },
+    {
+      "default": "''",
+      "description": "The textarea's help text. If you need to display HTML, use the `help-text` slot instead.",
+      "fieldName": "helpText",
+      "name": "help-text",
+      "reflects": false,
+      "type": "string"
+    },
+    {
+      "description": "Tells the browser what type of data will be entered by the user, allowing it to display the appropriate virtual\nkeyboard on supportive devices.",
+      "fieldName": "inputmode",
+      "name": "inputmode",
+      "reflects": false,
+      "type": "'none' | 'text' | 'decimal' | 'numeric' | 'tel' | 'search' | 'email' | 'url'"
+    },
+    {
+      "default": "''",
+      "description": "The textarea's label. If you need to display HTML, use the `label` slot instead.",
+      "fieldName": "label",
+      "name": "label",
+      "reflects": false,
+      "type": "string"
+    },
+    {
+      "description": "The maximum length of input that will be considered valid.",
+      "fieldName": "maxlength",
+      "name": "maxlength",
+      "reflects": false,
+      "type": "number"
+    },
+    {
+      "description": "The minimum length of input that will be considered valid.",
+      "fieldName": "minlength",
+      "name": "minlength",
+      "reflects": false,
+      "type": "number"
+    },
+    {
+      "default": "''",
+      "description": "The name of the textarea, submitted as a name/value pair with form data.",
+      "fieldName": "name",
+      "name": "name",
+      "reflects": false,
+      "type": "string"
+    },
+    {
+      "default": "''",
+      "description": "Placeholder text to show as a hint when the input is empty.",
+      "fieldName": "placeholder",
+      "name": "placeholder",
+      "reflects": false,
+      "type": "string"
+    },
+    {
+      "default": "false",
+      "description": "Makes the textarea readonly.",
+      "fieldName": "readonly",
+      "name": "readonly",
+      "reflects": true,
+      "type": "boolean"
+    },
+    {
+      "default": "false",
+      "description": "Makes the textarea a required field.",
+      "fieldName": "required",
+      "name": "required",
+      "reflects": true,
+      "type": "boolean"
+    },
+    {
+      "default": "'vertical'",
+      "description": "Controls how the textarea can be resized.",
+      "fieldName": "resize",
+      "name": "resize",
+      "reflects": false,
+      "type": "'none' | 'vertical' | 'auto'"
+    },
+    {
+      "default": "4",
+      "description": "The number of rows to display by default.",
+      "fieldName": "rows",
+      "name": "rows",
+      "reflects": false,
+      "type": "number"
+    },
+    {
+      "default": "'medium'",
+      "description": "The textarea's size.",
+      "fieldName": "size",
+      "name": "size",
+      "reflects": true,
+      "type": "'small' | 'medium' | 'large'"
+    },
+    {
+      "default": "true",
+      "description": "Enables spell checking on the textarea.",
+      "fieldName": "spellcheck",
+      "name": "spellcheck",
+      "reflects": false,
+      "type": "boolean"
+    },
+    {
+      "default": "''",
+      "description": "",
+      "fieldName": "title",
+      "name": "title",
+      "reflects": true,
+      "type": "string"
+    },
+    {
+      "default": "''",
+      "description": "The current value of the textarea, submitted as a name/value pair with form data.",
+      "fieldName": "value",
+      "name": "value",
+      "reflects": false,
+      "type": "string"
+    }
+  ],
+  "cssParts": [
+    {
+      "description": "The component's base wrapper.",
+      "name": "base"
+    },
+    {
+      "description": "The form control that wraps the label, input, and help text.",
+      "name": "form-control"
+    },
+    {
+      "description": "The help text's wrapper.",
+      "name": "form-control-help-text"
+    },
+    {
+      "description": "The input's wrapper.",
+      "name": "form-control-input"
+    },
+    {
+      "description": "The label's wrapper.",
+      "name": "form-control-label"
+    },
+    {
+      "description": "The internal `<textarea>` control.",
+      "name": "textarea"
+    }
+  ],
+  "dependencies": [],
+  "documentation": "https://synergy-design-system.github.io/?path=/docs/components-syn-textarea--docs",
+  "events": [
+    {
+      "description": "Emitted when the control loses focus.",
+      "name": "syn-blur",
+      "type": "SynBlurEvent"
+    },
+    {
+      "description": "Emitted when an alteration to the control's value is committed by the user.",
+      "name": "syn-change",
+      "type": "SynChangeEvent"
+    },
+    {
+      "description": "Emitted when the control gains focus.",
+      "name": "syn-focus",
+      "type": "SynFocusEvent"
+    },
+    {
+      "description": "Emitted when the control receives input.",
+      "name": "syn-input",
+      "type": "SynInputEvent"
+    },
+    {
+      "description": "Emitted when the form control has been checked for validity and its constraints aren't satisfied.",
+      "name": "syn-invalid",
+      "type": "SynInvalidEvent"
+    }
+  ],
+  "figmaComponentId": "41337-204379",
+  "methods": [
+    {
+      "description": "Removes focus from the textarea.",
+      "name": "blur",
+      "parameters": []
+    },
+    {
+      "description": "Checks for validity but does not show a validation message. Returns `true` when valid and `false` when invalid.",
+      "name": "checkValidity",
+      "parameters": []
+    },
+    {
+      "description": "Sets focus on the textarea.",
+      "name": "focus",
+      "parameters": [
+        {
+          "name": "options",
+          "type": "FocusOptions"
+        }
+      ]
+    },
+    {
+      "description": "Gets the associated form, if one exists.",
+      "name": "getForm",
+      "parameters": []
+    },
+    {
+      "description": "",
+      "name": "handleDisabledChange",
+      "parameters": []
+    },
+    {
+      "description": "",
+      "name": "handleRowsChange",
+      "parameters": []
+    },
+    {
+      "description": "",
+      "name": "handleValueChange",
+      "parameters": []
+    },
+    {
+      "description": "Checks for validity and shows the browser's validation message if the control is invalid.",
+      "name": "reportValidity",
+      "parameters": []
+    },
+    {
+      "description": "Gets or sets the textarea's scroll position.",
+      "name": "scrollPosition",
+      "parameters": [
+        {
+          "name": "position",
+          "type": "{ top?: number; left?: number }"
+        }
+      ]
+    },
+    {
+      "description": "Selects all the text in the textarea.",
+      "name": "select",
+      "parameters": []
+    },
+    {
+      "description": "Sets a custom validation message. Pass an empty string to restore validity.",
+      "name": "setCustomValidity",
+      "parameters": [
+        {
+          "name": "message",
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "description": "Replaces a range of text with a new string.",
+      "name": "setRangeText",
+      "parameters": [
+        {
+          "name": "replacement",
+          "type": "string"
+        },
+        {
+          "name": "start",
+          "type": "number"
+        },
+        {
+          "name": "end",
+          "type": "number"
+        },
+        {
+          "name": "selectMode",
+          "type": "'select' | 'start' | 'end' | 'preserve'"
+        }
+      ]
+    },
+    {
+      "description": "Sets the start and end positions of the text selection (0-based).",
+      "name": "setSelectionRange",
+      "parameters": [
+        {
+          "name": "selectionStart",
+          "type": "number"
+        },
+        {
+          "name": "selectionEnd",
+          "type": "number"
+        },
+        {
+          "name": "selectionDirection",
+          "type": "'forward' | 'backward' | 'none'"
+        }
+      ]
+    }
+  ],
+  "properties": [
+    {
+      "access": "public",
+      "description": "Controls whether and how text input is automatically capitalized as it is entered by the user.",
+      "name": "autocapitalize",
+      "type": "'off' | 'none' | 'on' | 'sentences' | 'words' | 'characters'"
+    },
+    {
+      "access": "public",
+      "description": "Specifies what permission the browser has to provide assistance in filling out form field values. Refer to\n[this page on MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete) for available values.",
+      "name": "autocomplete",
+      "type": "string"
+    },
+    {
+      "access": "public",
+      "description": "Indicates whether the browser's autocorrect feature is on or off.",
+      "name": "autocorrect",
+      "type": "boolean"
+    },
+    {
+      "access": "public",
+      "description": "Indicates that the input should receive focus on page load.",
+      "name": "autofocus",
+      "type": "boolean"
+    },
+    {
+      "access": "public",
+      "default": "''",
+      "description": "The default value of the form control. Primarily used for resetting the form control.",
+      "name": "defaultValue",
+      "type": "string"
+    },
+    {
+      "access": "public",
+      "default": "false",
+      "description": "Disables the textarea.",
+      "name": "disabled",
+      "type": "boolean"
+    },
+    {
+      "access": "public",
+      "description": "Used to customize the label or icon of the Enter key on virtual keyboards.",
+      "name": "enterkeyhint",
+      "type": "'enter' | 'done' | 'go' | 'next' | 'previous' | 'search' | 'send'"
+    },
+    {
+      "access": "public",
+      "default": "''",
+      "description": "By default, form controls are associated with the nearest containing `<form>` element. This attribute allows you\nto place the form control outside of a form and associate it with the form that has this `id`. The form must be in\nthe same document or shadow root for this to work.",
+      "name": "form",
+      "type": "string"
+    },
+    {
+      "access": "public",
+      "default": "''",
+      "description": "The textarea's help text. If you need to display HTML, use the `help-text` slot instead.",
+      "name": "helpText",
+      "type": "string"
+    },
+    {
+      "access": "public",
+      "description": "",
+      "name": "input",
+      "type": "HTMLTextAreaElement"
+    },
+    {
+      "access": "public",
+      "description": "Tells the browser what type of data will be entered by the user, allowing it to display the appropriate virtual\nkeyboard on supportive devices.",
+      "name": "inputmode",
+      "type": "'none' | 'text' | 'decimal' | 'numeric' | 'tel' | 'search' | 'email' | 'url'"
+    },
+    {
+      "access": "public",
+      "default": "''",
+      "description": "The textarea's label. If you need to display HTML, use the `label` slot instead.",
+      "name": "label",
+      "type": "string"
+    },
+    {
+      "access": "public",
+      "description": "The maximum length of input that will be considered valid.",
+      "name": "maxlength",
+      "type": "number"
+    },
+    {
+      "access": "public",
+      "description": "The minimum length of input that will be considered valid.",
+      "name": "minlength",
+      "type": "number"
+    },
+    {
+      "access": "public",
+      "default": "''",
+      "description": "The name of the textarea, submitted as a name/value pair with form data.",
+      "name": "name",
+      "type": "string"
+    },
+    {
+      "access": "public",
+      "default": "''",
+      "description": "Placeholder text to show as a hint when the input is empty.",
+      "name": "placeholder",
+      "type": "string"
+    },
+    {
+      "access": "public",
+      "default": "false",
+      "description": "Makes the textarea readonly.",
+      "name": "readonly",
+      "type": "boolean"
+    },
+    {
+      "access": "public",
+      "default": "false",
+      "description": "Makes the textarea a required field.",
+      "name": "required",
+      "type": "boolean"
+    },
+    {
+      "access": "public",
+      "default": "'vertical'",
+      "description": "Controls how the textarea can be resized.",
+      "name": "resize",
+      "type": "'none' | 'vertical' | 'auto'"
+    },
+    {
+      "access": "public",
+      "default": "4",
+      "description": "The number of rows to display by default.",
+      "name": "rows",
+      "type": "number"
+    },
+    {
+      "access": "public",
+      "default": "'medium'",
+      "description": "The textarea's size.",
+      "name": "size",
+      "type": "'small' | 'medium' | 'large'"
+    },
+    {
+      "access": "public",
+      "description": "",
+      "name": "sizeAdjuster",
+      "type": "HTMLTextAreaElement"
+    },
+    {
+      "access": "public",
+      "default": "true",
+      "description": "Enables spell checking on the textarea.",
+      "name": "spellcheck",
+      "type": "boolean"
+    },
+    {
+      "access": "public",
+      "default": "''",
+      "description": "",
+      "name": "title",
+      "type": "string"
+    },
+    {
+      "access": "readonly",
+      "description": "Gets the validation message",
+      "name": "validationMessage"
+    },
+    {
+      "access": "readonly",
+      "description": "Gets the validity state object",
+      "name": "validity"
+    },
+    {
+      "access": "public",
+      "default": "''",
+      "description": "The current value of the textarea, submitted as a name/value pair with form data.",
+      "name": "value",
+      "type": "string"
+    }
+  ],
+  "since": "2.0",
+  "slots": [
+    {
+      "description": "The textarea's label. Alternatively, you can use the `label` attribute.",
+      "name": "label"
+    },
+    {
+      "description": "Text that describes how to use the input. Alternatively, you can use the `help-text` attribute.",
+      "name": "help-text"
+    }
+  ],
+  "sourceModulePath": "components/textarea/textarea.js",
+  "status": "stable",
+  "summary": "Textareas collect data from the user and allow multiple lines of text.",
+  "tagName": "syn-textarea"
+}