vertumnus
/
primevue-mirror
mirror of https://github.com/primefaces/primevue.git
1
0
Fork 0
Code Packages Releases Activity

Update API doc

pull/3913/head
GitHub Actions Bot 2023-04-28 13:40:19 +00:00
parent 3bae8de47e
commit 9985119c70
1 changed files with 152 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

152
doc/common/apidoc/index.json
View File

@ -28715,6 +28715,127 @@
"methodDescription": "Defines methods that can be accessed by the component's reference.",
"typeDescription": "Defines the custom types used by the module.",
"values": {
"ToastPassThroughMethodOptions": {
"description": "Custom passthrough(pt) option method.",
"relatedProp": "",
"props": [
{
"name": "props",
"optional": false,
"readonly": false,
"type": "ToastProps",
"default": ""
},
{
"name": "state",
"optional": false,
"readonly": false,
"type": "ToastState",
"default": ""
}
],
"methods": []
},
"ToastPassThroughOptions": {
"description": "Custom passthrough(pt) options.",
"relatedProp": "ToastProps.pt",
"props": [
{
"name": "root",
"optional": true,
"readonly": false,
"type": "ToastPassThroughOptionType",
"default": "",
"description": "Uses to pass attributes to the root's DOM element."
},
{
"name": "container",
"optional": true,
"readonly": false,
"type": "ToastPassThroughOptionType",
"default": "",
"description": "Uses to pass attributes to the container's DOM element."
},
{
"name": "content",
"optional": true,
"readonly": false,
"type": "ToastPassThroughOptionType",
"default": "",
"description": "Uses to pass attributes to the content's DOM element."
},
{
"name": "icon",
"optional": true,
"readonly": false,
"type": "ToastPassThroughOptionType",
"default": "",
"description": "Uses to pass attributes to the icon's DOM element."
},
{
"name": "text",
"optional": true,
"readonly": false,
"type": "ToastPassThroughOptionType",
"default": "",
"description": "Uses to pass attributes to the text's DOM element."
},
{
"name": "summary",
"optional": true,
"readonly": false,
"type": "ToastPassThroughOptionType",
"default": "",
"description": "Uses to pass attributes to the summary's DOM element."
},
{
"name": "detail",
"optional": true,
"readonly": false,
"type": "ToastPassThroughOptionType",
"default": "",
"description": "Uses to pass attributes to the detail's DOM element."
},
{
"name": "buttonContainer",
"optional": true,
"readonly": false,
"type": "ToastPassThroughOptionType",
"default": "",
"description": "Uses to pass attributes to the button container's DOM element."
},
{
"name": "button",
"optional": true,
"readonly": false,
"type": "ToastPassThroughOptionType",
"default": "",
"description": "Uses to pass attributes to the button's DOM element."
},
{
"name": "buttonIcon",
"optional": true,
"readonly": false,
"type": "ToastPassThroughOptionType",
"default": "",
"description": "Uses to pass attributes to the button icon's DOM element."
}
],
"methods": []
},
"ToastPassThroughAttributes": {
"description": "Custom passthrough attributes for each DOM elements",
"relatedProp": "",
"props": [
{
"name": "[key: string]",
"optional": false,
"readonly": false,
"type": "any"
}
],
"methods": []
},
"ToastMessageOptions": {
"description": "Defines message options in Toast component.",
"relatedProp": "",
@ -28799,6 +28920,21 @@
],
"methods": []
},
"ToastState": {
"description": "Defines current inline state in Toast component.",
"relatedProp": "",
"props": [
{
"name": "messages",
"optional": false,
"readonly": false,
"type": "any[]",
"default": "",
"description": "Current messages."
}
],
"methods": []
},
"ToastProps": {
"description": "Defines valid properties in Toast component.",
"relatedProp": "",
@ -28896,6 +29032,14 @@
"default": "",
"description": "Uses to pass all properties of the HTMLButtonElement to the close button.",
"deprecated": "since v3.26.0. Use 'pt' property."
},
{
"name": "pt",
"optional": true,
"readonly": false,
"type": "ToastPassThroughOptions",
"default": "",
"description": "Uses to pass attributes to DOM elements inside the component."
}
],
"methods": []
@ -28966,6 +29110,14 @@
]
}
}
},
"types": {
"description": "Defines the custom types used by the module.",
"values": {
"ToastPassThroughOptionType": {
"values": "ToastPassThroughAttributes | (options: ToastPassThroughMethodOptions) => ToastPassThroughAttributes | null | undefined"
}
}
}
},
"toastservice-usetoast": {