Update API doc

pull/4077/head
GitHub Actions Bot 2023-06-22 13:53:55 +00:00
parent a6e8c4d163
commit 0746ad86ac
1 changed files with 155 additions and 0 deletions

View File

@ -19758,6 +19758,145 @@
"methodDescription": "Defines methods that can be accessed by the component's reference.", "methodDescription": "Defines methods that can be accessed by the component's reference.",
"typeDescription": "Defines the custom types used by the module.", "typeDescription": "Defines the custom types used by the module.",
"values": { "values": {
"FocusTrapPassThroughHooksOptions": {
"description": "Custom passthrough(pt) hooks options.",
"relatedProp": "",
"props": [
{
"name": "created",
"optional": true,
"readonly": false,
"type": "DirectiveBinding<any>",
"default": "",
"description": "Called before bound element's attributes or event listeners are applied."
},
{
"name": "beforeMount",
"optional": true,
"readonly": false,
"type": "DirectiveBinding<any>",
"default": "",
"description": "Called right before the element is inserted into the DOM."
},
{
"name": "mounted",
"optional": true,
"readonly": false,
"type": "DirectiveBinding<any>",
"default": "",
"description": "Called when the bound element's parent component and all its children are mounted."
},
{
"name": "beforeUpdate",
"optional": true,
"readonly": false,
"type": "DirectiveBinding<any>",
"default": "",
"description": "Called before the parent component is updated."
},
{
"name": "updated",
"optional": true,
"readonly": false,
"type": "DirectiveBinding<any>",
"default": "",
"description": "Called after the parent component and all of its children have updated all of its children have updated."
},
{
"name": "beforeUnmount",
"optional": true,
"readonly": false,
"type": "DirectiveBinding<any>",
"default": "",
"description": "Called before the parent component is unmounted."
},
{
"name": "unmounted",
"optional": true,
"readonly": false,
"type": "DirectiveBinding<any>",
"default": "",
"description": "Called when the parent component is unmounted."
}
],
"methods": []
},
"FocusTrapPassThroughCSSOptions": {
"description": "Custom passthrough(pt) css options.",
"relatedProp": "",
"props": [
{
"name": "class",
"optional": true,
"readonly": false,
"type": "any",
"default": "",
"description": "Style class of the element."
},
{
"name": "style",
"optional": true,
"readonly": false,
"type": "any",
"default": "",
"description": "Inline style of the element."
}
],
"methods": []
},
"FocusTrapPassThroughDirectiveOptions": {
"relatedProp": "",
"props": [
{
"name": "hooks",
"optional": true,
"readonly": false,
"type": "FocusTrapPassThroughHooksOptions",
"default": "",
"description": "Uses to pass attributes to the life cycle hooks."
},
{
"name": "css",
"optional": true,
"readonly": false,
"type": "FocusTrapPassThroughCSSOptions",
"default": "",
"description": "Uses to pass attributes to the styles."
}
],
"methods": []
},
"FocusTrapPassThroughOptions": {
"description": "Custom passthrough(pt) options.",
"relatedProp": "FocusTrapOptions.pt",
"props": [
{
"name": "root",
"optional": true,
"readonly": false,
"type": "FocusTrapPassThroughDirectiveOptions",
"default": "",
"description": "Uses to pass attributes to the root's DOM element."
},
{
"name": "firstFocusableElement",
"optional": true,
"readonly": false,
"type": "FocusTrapPassThroughDirectiveOptions",
"default": "",
"description": "Uses to pass attributes to the first focusable element's DOM element."
},
{
"name": "lastFocusableElement",
"optional": true,
"readonly": false,
"type": "FocusTrapPassThroughDirectiveOptions",
"default": "",
"description": "Uses to pass attributes to the last focusable element's DOM element."
}
],
"methods": []
},
"FocusTrapOptions": { "FocusTrapOptions": {
"description": "Defines options of FocusTrap.", "description": "Defines options of FocusTrap.",
"relatedProp": "", "relatedProp": "",
@ -19769,6 +19908,22 @@
"type": "boolean", "type": "boolean",
"default": "false", "default": "false",
"description": "When present, it specifies that the directive should be disabled." "description": "When present, it specifies that the directive should be disabled."
},
{
"name": "autoFocus",
"optional": true,
"readonly": false,
"type": "boolean",
"default": "true",
"description": "When When disabled, focustrap will not focus by default."
},
{
"name": "pt",
"optional": true,
"readonly": false,
"type": "FocusTrapPassThroughOptions",
"default": "",
"description": "Uses to pass attributes to DOM elements inside the component."
} }
], ],
"methods": [] "methods": []