@hmcts/annotation-ui-lib
Version:
PDF Viewer and ability to highlight text with and comment tracking
95 lines • 3.84 kB
JSON
[
{
"name": "rows",
"type": "array",
"required": true,
"description": "Array of row item objects",
"params": [
{
"name": "key.text",
"type": "string",
"required": true,
"description": "If `html` is set, this is not required. Text to use within the each key. If `html` is provided, the `text` argument will be ignored."
},
{
"name": "key.html",
"type": "string",
"required": true
},
{
"name": "key.classes",
"type": "string",
"required": false,
"description": "Classes to add to the key wrapper"
},
{
"name": "value.text",
"type": "string",
"required": true,
"description": "If `html` is set, this is not required. Text to use within the each value. If `html` is provided, the `text` argument will be ignored."
},
{
"name": "value.html",
"type": "string",
"required": true,
"description": "If `text` is set, this is not required. HTML to use within the each value. If `html` is provided, the `text` argument will be ignored."
},
{
"name": "value.classes",
"type": "string",
"required": false,
"description": "Classes to add to the value wrapper"
},
{
"name": "actions.items",
"type": "array",
"required": false,
"description": "Array of action item objects",
"params": [
{
"name": "classes",
"type": "string",
"required": false,
"description": "Classes to add to the actions wrapper"
},
{
"name": "href",
"type": "string",
"required": true,
"description": "The value of the link href attribute for an action item"
},
{
"name": "text",
"type": "string",
"required": true,
"description": "If `html` is set, this is not required. Text to use within each action item. If `html` is provided, the `text` argument will be ignored."
},
{
"name": "html",
"type": "string",
"required": true,
"description": "If `text` is set, this is not required. HTML to use within the each action item. If `html` is provided, the `text` argument will be ignored."
},
{
"name": "visuallyHiddenText",
"type": "string",
"required": false,
"description": "Actions rely on context from the surrounding content so may require additional accessible text, text supplied to this option is appended to the end, use `html` for more complicated scenarios."
}
]
}
]
},
{
"name": "classes",
"type": "string",
"required": false,
"description": "Classes to add to the container."
},
{
"name": "attributes",
"type": "object",
"required": false,
"description": "HTML attributes (for example data attributes) to add to the container."
}
]