Update API doc

pull/3892/head
GitHub Actions Bot 2023-04-21 13:23:20 +00:00
parent ebe86df393
commit c50efe4bbf
1 changed files with 58 additions and 0 deletions

View File

@ -3621,6 +3621,48 @@
"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": {
"BadgePassThroughMethodOptions": {
"description": "Custom passthrough(pt) option method.",
"relatedProp": "",
"props": [
{
"name": "props",
"optional": false,
"readonly": false,
"type": "BadgeProps",
"default": ""
}
],
"methods": []
},
"BadgePassThroughAttributes": {
"description": "Custom passthrough attributes for each DOM elements",
"relatedProp": "",
"props": [
{
"name": "[key: string]",
"optional": false,
"readonly": false,
"type": "any"
}
],
"methods": []
},
"BadgePassThroughOptions": {
"description": "Custom passthrough(pt) options.",
"relatedProp": "BadgeProps.pt",
"props": [
{
"name": "root",
"optional": true,
"readonly": false,
"type": "BadgePassThroughOptionType",
"default": "",
"description": "Uses to pass attributes to the root's DOM element."
}
],
"methods": []
},
"BadgeProps": { "BadgeProps": {
"description": "Defines valid properties in Badge component.", "description": "Defines valid properties in Badge component.",
"relatedProp": "", "relatedProp": "",
@ -3648,6 +3690,14 @@
"type": "null | \"large\" | \"xlarge\"", "type": "null | \"large\" | \"xlarge\"",
"default": "", "default": "",
"description": "Size of the badge, valid options are 'large' and 'xlarge'." "description": "Size of the badge, valid options are 'large' and 'xlarge'."
},
{
"name": "pt",
"optional": true,
"readonly": false,
"type": "BadgePassThroughOptions",
"default": "",
"description": "Uses to pass attributes to DOM elements inside the component."
} }
], ],
"methods": [] "methods": []
@ -3672,6 +3722,14 @@
"methods": [] "methods": []
} }
} }
},
"types": {
"description": "Defines the custom types used by the module.",
"values": {
"BadgePassThroughOptionType": {
"values": "BadgePassThroughAttributes | (options: BadgePassThroughMethodOptions) => BadgePassThroughAttributes | null | undefined"
}
}
} }
}, },
"badgedirective": { "badgedirective": {