Update API doc
GitHub Actions Bot
parent
1d79237d11
commit
bdf1197db5
|
|
@ -2835,7 +2835,7 @@
|
||||||
"optional": true,
|
"optional": true,
|
||||||
"readonly": false,
|
"readonly": false,
|
||||||
"type": "boolean",
|
"type": "boolean",
|
||||||
"default": "false",
|
"default": "null",
|
||||||
"description": "Spans 100% width of the container when enabled."
|
"description": "Spans 100% width of the container when enabled."
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
|
|
@ -5725,7 +5725,7 @@
|
||||||
"optional": true,
|
"optional": true,
|
||||||
"readonly": false,
|
"readonly": false,
|
||||||
"type": "boolean",
|
"type": "boolean",
|
||||||
"default": "false",
|
"default": "null",
|
||||||
"description": "Spans 100% width of the container when enabled."
|
"description": "Spans 100% width of the container when enabled."
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
|
|
@ -8336,7 +8336,7 @@
|
||||||
"optional": true,
|
"optional": true,
|
||||||
"readonly": false,
|
"readonly": false,
|
||||||
"type": "boolean",
|
"type": "boolean",
|
||||||
"default": "false",
|
"default": "null",
|
||||||
"description": "Spans 100% width of the container when enabled."
|
"description": "Spans 100% width of the container when enabled."
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
|
|
@ -21090,7 +21090,7 @@
|
||||||
"optional": true,
|
"optional": true,
|
||||||
"readonly": false,
|
"readonly": false,
|
||||||
"type": "boolean",
|
"type": "boolean",
|
||||||
"default": "false",
|
"default": "null",
|
||||||
"description": "Spans 100% width of the container when enabled."
|
"description": "Spans 100% width of the container when enabled."
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
|
|
@ -27483,6 +27483,251 @@
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
"fluid": {
|
||||||
|
"description": "Fluid spans 100% width of the container.\n\n[Live Demo](https://www.primevue.org/fluid/)",
|
||||||
|
"components": {
|
||||||
|
"default": {
|
||||||
|
"description": "Fluid spans 100% width of the container.",
|
||||||
|
"methods": {
|
||||||
|
"description": "Defines methods that can be accessed by the component's reference.",
|
||||||
|
"values": []
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"interfaces": {
|
||||||
|
"description": "Defines the custom interfaces used by the module.",
|
||||||
|
"eventDescription": "Defines the custom events used by the component's emit.",
|
||||||
|
"methodDescription": "Defines methods that can be accessed by the component's reference.",
|
||||||
|
"typeDescription": "Defines the custom types used by the module.",
|
||||||
|
"values": {
|
||||||
|
"FluidPassThroughMethodOptions": {
|
||||||
|
"description": "Custom passthrough(pt) option method.",
|
||||||
|
"relatedProp": "",
|
||||||
|
"props": [
|
||||||
|
{
|
||||||
|
"name": "instance",
|
||||||
|
"optional": false,
|
||||||
|
"readonly": false,
|
||||||
|
"type": "any",
|
||||||
|
"default": "",
|
||||||
|
"description": "Defines instance."
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "props",
|
||||||
|
"optional": false,
|
||||||
|
"readonly": false,
|
||||||
|
"type": "FluidProps",
|
||||||
|
"default": "",
|
||||||
|
"description": "Defines valid properties."
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "attrs",
|
||||||
|
"optional": false,
|
||||||
|
"readonly": false,
|
||||||
|
"type": "any",
|
||||||
|
"default": "",
|
||||||
|
"description": "Defines valid attributes."
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "parent",
|
||||||
|
"optional": false,
|
||||||
|
"readonly": false,
|
||||||
|
"type": "any",
|
||||||
|
"default": "",
|
||||||
|
"description": "Defines parent options."
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "global",
|
||||||
|
"optional": false,
|
||||||
|
"readonly": false,
|
||||||
|
"type": "undefined | object",
|
||||||
|
"default": "",
|
||||||
|
"description": "Defines passthrough(pt) options in global config."
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"methods": []
|
||||||
|
},
|
||||||
|
"FluidPassThroughOptions": {
|
||||||
|
"description": "Custom passthrough(pt) options.",
|
||||||
|
"relatedProp": "FluidProps.pt",
|
||||||
|
"props": [
|
||||||
|
{
|
||||||
|
"name": "root",
|
||||||
|
"optional": true,
|
||||||
|
"readonly": false,
|
||||||
|
"type": "FluidPassThroughOptionType",
|
||||||
|
"default": "",
|
||||||
|
"description": "Used to pass attributes to the root's DOM element."
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "hooks",
|
||||||
|
"optional": true,
|
||||||
|
"readonly": false,
|
||||||
|
"type": "any",
|
||||||
|
"default": "",
|
||||||
|
"description": "Used to manage all lifecycle hooks."
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"methods": []
|
||||||
|
},
|
||||||
|
"FluidPassThroughAttributes": {
|
||||||
|
"description": "Custom passthrough attributes for each DOM elements",
|
||||||
|
"relatedProp": "",
|
||||||
|
"props": [
|
||||||
|
{
|
||||||
|
"name": "[key: string]",
|
||||||
|
"optional": false,
|
||||||
|
"readonly": false,
|
||||||
|
"type": "any"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"methods": []
|
||||||
|
},
|
||||||
|
"FluidProps": {
|
||||||
|
"description": "Defines valid properties in Fluid component.",
|
||||||
|
"relatedProp": "",
|
||||||
|
"props": [
|
||||||
|
{
|
||||||
|
"name": "dt",
|
||||||
|
"optional": true,
|
||||||
|
"readonly": false,
|
||||||
|
"type": "any",
|
||||||
|
"default": "",
|
||||||
|
"description": "It generates scoped CSS variables using design tokens for the component."
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "pt",
|
||||||
|
"optional": true,
|
||||||
|
"readonly": false,
|
||||||
|
"type": "PassThrough<FluidPassThroughOptions>",
|
||||||
|
"default": "",
|
||||||
|
"description": "Used to pass attributes to DOM elements inside the component."
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "ptOptions",
|
||||||
|
"optional": true,
|
||||||
|
"readonly": false,
|
||||||
|
"type": "any",
|
||||||
|
"default": "",
|
||||||
|
"description": "Used to configure passthrough(pt) options of the component."
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "unstyled",
|
||||||
|
"optional": true,
|
||||||
|
"readonly": false,
|
||||||
|
"type": "boolean",
|
||||||
|
"default": "false",
|
||||||
|
"description": "When enabled, it removes component related styles in the core."
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"methods": []
|
||||||
|
},
|
||||||
|
"FluidSlots": {
|
||||||
|
"description": "Defines valid slots in Fluid component.",
|
||||||
|
"relatedProp": "",
|
||||||
|
"props": [
|
||||||
|
{
|
||||||
|
"name": "default",
|
||||||
|
"optional": false,
|
||||||
|
"readonly": false,
|
||||||
|
"type": "Function",
|
||||||
|
"default": ""
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"methods": []
|
||||||
|
},
|
||||||
|
"FluidEmitsOptions": {
|
||||||
|
"description": "Defines valid emits in Fluid component.",
|
||||||
|
"relatedProp": "",
|
||||||
|
"props": [],
|
||||||
|
"methods": []
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"tokens": {
|
||||||
|
"description": "Define design tokens used by the component.",
|
||||||
|
"values": {
|
||||||
|
"FluidPassThroughMethodOptions": {
|
||||||
|
"description": "Custom passthrough(pt) option method.",
|
||||||
|
"props": []
|
||||||
|
},
|
||||||
|
"FluidPassThroughOptions": {
|
||||||
|
"description": "Custom passthrough(pt) options.",
|
||||||
|
"props": []
|
||||||
|
},
|
||||||
|
"FluidPassThroughAttributes": {
|
||||||
|
"description": "Custom passthrough attributes for each DOM elements",
|
||||||
|
"props": []
|
||||||
|
},
|
||||||
|
"FluidProps": {
|
||||||
|
"description": "Defines valid properties in Fluid component.",
|
||||||
|
"props": []
|
||||||
|
},
|
||||||
|
"FluidSlots": {
|
||||||
|
"description": "Defines valid slots in Fluid component.",
|
||||||
|
"props": []
|
||||||
|
},
|
||||||
|
"FluidEmitsOptions": {
|
||||||
|
"description": "Defines valid emits in Fluid component.",
|
||||||
|
"props": []
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"types": {
|
||||||
|
"description": "Defines the custom types used by the module.",
|
||||||
|
"values": {
|
||||||
|
"FluidPassThroughOptionType": {
|
||||||
|
"values": "FluidPassThroughAttributes | (options: FluidPassThroughMethodOptions) => undefined | string | null | undefined"
|
||||||
|
},
|
||||||
|
"FluidPassThroughTransitionType": {
|
||||||
|
"values": "TransitionProps | (options: FluidPassThroughMethodOptions) => TransitionProps | undefined"
|
||||||
|
},
|
||||||
|
"FluidEmits": {
|
||||||
|
"values": "EmitFn<FluidEmitsOptions>"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"fluidstyle": {
|
||||||
|
"description": "Fluid spans 100% width of the container.\n\n[Live Demo](https://www.primevue.org/fluid/)",
|
||||||
|
"interfaces": {
|
||||||
|
"description": "Defines the custom interfaces used by the module.",
|
||||||
|
"eventDescription": "Defines the custom events used by the component's emit.",
|
||||||
|
"methodDescription": "Defines methods that can be accessed by the component's reference.",
|
||||||
|
"typeDescription": "Defines the custom types used by the module.",
|
||||||
|
"values": {
|
||||||
|
"FluidStyle": {
|
||||||
|
"relatedProp": "",
|
||||||
|
"props": [],
|
||||||
|
"methods": [],
|
||||||
|
"extendedTypes": "default"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"tokens": {
|
||||||
|
"description": "Define design tokens used by the component.",
|
||||||
|
"values": {
|
||||||
|
"FluidStyle": {
|
||||||
|
"props": []
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"enumerations": {
|
||||||
|
"values": {
|
||||||
|
"FluidClasses": {
|
||||||
|
"members": [
|
||||||
|
{
|
||||||
|
"name": "root",
|
||||||
|
"optional": false,
|
||||||
|
"readonly": false,
|
||||||
|
"value": "\"p-fluid\"",
|
||||||
|
"description": "Class name of the root element"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
"focustrap": {
|
"focustrap": {
|
||||||
"description": "Focus Trap keeps focus within a certain DOM element while tabbing.\n\n[Live Demo](https://primevue.org/focustrap)",
|
"description": "Focus Trap keeps focus within a certain DOM element while tabbing.\n\n[Live Demo](https://primevue.org/focustrap)",
|
||||||
"interfaces": {
|
"interfaces": {
|
||||||
|
|
@ -31247,7 +31492,7 @@
|
||||||
"optional": true,
|
"optional": true,
|
||||||
"readonly": false,
|
"readonly": false,
|
||||||
"type": "boolean",
|
"type": "boolean",
|
||||||
"default": "false",
|
"default": "null",
|
||||||
"description": "Spans 100% width of the container when enabled."
|
"description": "Spans 100% width of the container when enabled."
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
|
|
@ -32110,7 +32355,7 @@
|
||||||
"optional": true,
|
"optional": true,
|
||||||
"readonly": false,
|
"readonly": false,
|
||||||
"type": "boolean",
|
"type": "boolean",
|
||||||
"default": "false",
|
"default": "null",
|
||||||
"description": "Spans 100% width of the container when enabled."
|
"description": "Spans 100% width of the container when enabled."
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
|
|
@ -32880,7 +33125,7 @@
|
||||||
"optional": true,
|
"optional": true,
|
||||||
"readonly": false,
|
"readonly": false,
|
||||||
"type": "boolean",
|
"type": "boolean",
|
||||||
"default": "false",
|
"default": "null",
|
||||||
"description": "Spans 100% width of the container when enabled."
|
"description": "Spans 100% width of the container when enabled."
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
|
|
@ -34025,7 +34270,7 @@
|
||||||
"optional": true,
|
"optional": true,
|
||||||
"readonly": false,
|
"readonly": false,
|
||||||
"type": "boolean",
|
"type": "boolean",
|
||||||
"default": "false",
|
"default": "null",
|
||||||
"description": "Spans 100% width of the container when enabled."
|
"description": "Spans 100% width of the container when enabled."
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
|
|
@ -39882,7 +40127,7 @@
|
||||||
"optional": true,
|
"optional": true,
|
||||||
"readonly": false,
|
"readonly": false,
|
||||||
"type": "boolean",
|
"type": "boolean",
|
||||||
"default": "false",
|
"default": "null",
|
||||||
"description": "Spans 100% width of the container when enabled."
|
"description": "Spans 100% width of the container when enabled."
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
|
|
@ -45589,7 +45834,7 @@
|
||||||
"optional": true,
|
"optional": true,
|
||||||
"readonly": false,
|
"readonly": false,
|
||||||
"type": "boolean",
|
"type": "boolean",
|
||||||
"default": "false",
|
"default": "null",
|
||||||
"description": "Spans 100% width of the container when enabled."
|
"description": "Spans 100% width of the container when enabled."
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
|
|
@ -51126,7 +51371,7 @@
|
||||||
"optional": true,
|
"optional": true,
|
||||||
"readonly": false,
|
"readonly": false,
|
||||||
"type": "boolean",
|
"type": "boolean",
|
||||||
"default": "false",
|
"default": "null",
|
||||||
"description": "Spans 100% width of the container when enabled."
|
"description": "Spans 100% width of the container when enabled."
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
|
|
@ -54274,7 +54519,7 @@
|
||||||
"optional": true,
|
"optional": true,
|
||||||
"readonly": false,
|
"readonly": false,
|
||||||
"type": "boolean",
|
"type": "boolean",
|
||||||
"default": "false",
|
"default": "null",
|
||||||
"description": "Spans 100% width of the container when enabled."
|
"description": "Spans 100% width of the container when enabled."
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
|
|
@ -61332,7 +61577,7 @@
|
||||||
"optional": true,
|
"optional": true,
|
||||||
"readonly": false,
|
"readonly": false,
|
||||||
"type": "boolean",
|
"type": "boolean",
|
||||||
"default": "false",
|
"default": "null",
|
||||||
"description": "Spans 100% width of the container when enabled."
|
"description": "Spans 100% width of the container when enabled."
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
|
|
@ -66563,7 +66808,7 @@
|
||||||
"optional": true,
|
"optional": true,
|
||||||
"readonly": false,
|
"readonly": false,
|
||||||
"type": "boolean",
|
"type": "boolean",
|
||||||
"default": "false",
|
"default": "null",
|
||||||
"description": "Spans 100% width of the container when enabled."
|
"description": "Spans 100% width of the container when enabled."
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue