@hmcts/annotation-ui-lib
Version:
PDF Viewer and ability to highlight text with and comment tracking
83 lines • 2.57 kB
JSON
[
{
"name": "id",
"type": "string",
"required": true,
"description": "The id of the textarea."
},
{
"name": "describedBy",
"type": "string",
"required": false,
"description": "Text or element id to add to the `aria-describedby` attribute to provide description for screenreader users."
},
{
"name": "name",
"type": "string",
"required": true,
"description": "The name of the textarea, which is submitted with the form data."
},
{
"name": "rows",
"type": "string",
"required": false,
"description": "Optional number of textarea rows (default is 5 rows)."
},
{
"name": "value",
"type": "string",
"required": false,
"description": "Optional initial value of the textarea."
},
{
"name": "maxlength",
"type": "string",
"required": true,
"description": "If `maxwords` is set, this is not required. The maximum number of characters. If `maxwords` is provided, the `maxlength` argument will be ignored."
},
{
"name": "maxwords",
"type": "string",
"required": true,
"description": "If `maxlength` is set, this is not required. The maximum number of words. If `maxwords` is provided, the `maxlength` argument will be ignored."
},
{
"name": "threshold",
"type": "string",
"required": true,
"description": "The percentage value of the limit at which point the count message is displayed. If this attribute is set, the count message will be hidden by default."
},
{
"name": "label",
"type": "object",
"required": true,
"description": "Options for the label component.",
"isComponent": true
},
{
"name": "hint",
"type": "object",
"required": false,
"description": "Options for the hint component.",
"isComponent": true
},
{
"name": "errorMessage",
"type": "object",
"required": false,
"description": "Options for the errorMessage component (e.g. text).",
"isComponent": true
},
{
"name": "classes",
"type": "string",
"required": false,
"description": "Classes to add to the textarea."
},
{
"name": "attributes",
"type": "object",
"required": false,
"description": "HTML attributes (for example data attributes) to add to the textarea."
}
]