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

Update API doc

pull/4186/head
GitHub Actions Bot 2023-07-10 09:35:37 +00:00
parent 63b5b8be8e
commit 386ae86a66
2 changed files with 161 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -4261,7 +4261,7 @@
"name": "hooks", "name": "hooks",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "DirectiveHooks", "type": "DirectiveHooks<any, any>",
"default": "", "default": "",
"description": "Uses to manage all lifecycle hooks" "description": "Uses to manage all lifecycle hooks"
} }
@ -4367,42 +4367,42 @@
"props": [], "props": [],
"methods": [ "methods": [
{ {
"name": "beforeCreate", "name": "onBeforeCreate",
"parameters": [], "parameters": [],
"returnType": "void" "returnType": "void"
}, },
{ {
"name": "created", "name": "onCreated",
"parameters": [], "parameters": [],
"returnType": "void" "returnType": "void"
}, },
{ {
"name": "beforeMount", "name": "onBeforeMount",
"parameters": [], "parameters": [],
"returnType": "void" "returnType": "void"
}, },
{ {
"name": "mounted", "name": "onMounted",
"parameters": [], "parameters": [],
"returnType": "void" "returnType": "void"
}, },
{ {
"name": "beforeUpdate", "name": "onBeforeUpdate",
"parameters": [], "parameters": [],
"returnType": "void" "returnType": "void"
}, },
{ {
"name": "updated", "name": "onUpdated",
"parameters": [], "parameters": [],
"returnType": "void" "returnType": "void"
}, },
{ {
"name": "beforeUnmount", "name": "onBeforeUnmount",
"parameters": [], "parameters": [],
"returnType": "void" "returnType": "void"
}, },
{ {
"name": "unmounted", "name": "onUnmounted",
"parameters": [], "parameters": [],
"returnType": "void" "returnType": "void"
} }
@ -4459,11 +4459,155 @@
"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": {
"DirectiveInstance": {
"relatedProp": "",
"props": [
{
"name": "$name",
"optional": false,
"readonly": false,
"type": "undefined | string",
"default": ""
},
{
"name": "$host",
"optional": false,
"readonly": false,
"type": "T",
"default": ""
},
{
"name": "$binding",
"optional": false,
"readonly": false,
"type": "DirectiveBinding<V>",
"default": ""
},
{
"name": "$el",
"optional": false,
"readonly": false,
"type": "undefined | HTMLElement",
"default": ""
},
{
"name": "$css",
"optional": true,
"readonly": false,
"type": "Object",
"default": ""
},
{
"name": "defaultPT",
"optional": false,
"readonly": false,
"type": "any",
"default": ""
},
{
"name": "isUnstyled",
"optional": false,
"readonly": false,
"type": "boolean",
"default": ""
},
{
"name": "[key: string]",
"optional": false,
"readonly": false,
"type": "any"
}
],
"methods": []
},
"DirectiveOptions": {
"relatedProp": "",
"props": [
{
"name": "el",
"optional": false,
"readonly": false,
"type": "T",
"default": ""
},
{
"name": "binding",
"optional": false,
"readonly": false,
"type": "DirectiveBinding<V>",
"default": ""
},
{
"name": "vnode",
"optional": false,
"readonly": false,
"type": "VNode<any, T, Object>",
"default": ""
},
{
"name": "prevVNode",
"optional": false,
"readonly": false,
"type": "Prev",
"default": ""
}
],
"methods": []
},
"DirectiveHooks": { "DirectiveHooks": {
"relatedProp": "", "relatedProp": "",
"props": [], "props": [
"methods": [], {
"extendedTypes": "Omit<ObjectDirective, \"getSSRProps\" | \"deep\">" "name": "onCreated",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onBeforeMount",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onMounted",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onBeforeUpdate",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onUpdated",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onBeforeUnmount",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onUnmounted",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
}
],
"methods": []
}, },
"BaseDirectivePassThroughOptions": { "BaseDirectivePassThroughOptions": {
"relatedProp": "", "relatedProp": "",
@ -4472,7 +4616,7 @@
"name": "hooks", "name": "hooks",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "DirectiveHooks", "type": "DirectiveHooks<any, any>",
"default": "" "default": ""
} }
], ],
@ -20432,7 +20576,7 @@
"name": "hooks", "name": "hooks",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "DirectiveHooks", "type": "DirectiveHooks<any, any>",
"default": "", "default": "",
"description": "Uses to manage all lifecycle hooks" "description": "Uses to manage all lifecycle hooks"
} }
@ -33035,7 +33179,7 @@
"name": "hooks", "name": "hooks",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "DirectiveHooks", "type": "DirectiveHooks<any, any>",
"default": "", "default": "",
"description": "Uses to manage all lifecycle hooks" "description": "Uses to manage all lifecycle hooks"
} }
@ -36376,7 +36520,7 @@
"name": "hooks", "name": "hooks",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "DirectiveHooks", "type": "DirectiveHooks<any, any>",
"default": "", "default": "",
"description": "Uses to manage all lifecycle hooks" "description": "Uses to manage all lifecycle hooks"
} }
@ -39872,7 +40016,7 @@
"name": "hooks", "name": "hooks",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "DirectiveHooks", "type": "DirectiveHooks<any, any>",
"default": "", "default": "",
"description": "Uses to manage all lifecycle hooks" "description": "Uses to manage all lifecycle hooks"
} }

1
package-lock.json generated
View File

@ -18695,7 +18695,6 @@
"@babel/core": { "@babel/core": {
"version": "7.22.6", "version": "7.22.6",
"resolved": "https://registry.npmjs.org/@babel/core/-/core-7.22.6.tgz", "resolved": "https://registry.npmjs.org/@babel/core/-/core-7.22.6.tgz",
"integrity": "sha512-HPIyDa6n+HKw5dEuway3vVAhBboYCtREBMp+IWeseZy6TFtzn6MHkCH2KKYUOC/vKKwgSMHQW4htBOrmuRPXfw==",
"dev": true, "dev": true,
"requires": { "requires": {
"@ampproject/remapping": "^2.2.0", "@ampproject/remapping": "^2.2.0",