Update API doc
parent
922f19e445
commit
7c0354c1e7
|
@ -13089,6 +13089,13 @@
|
|||
"type": "any",
|
||||
"default": ""
|
||||
},
|
||||
{
|
||||
"name": "imagediff",
|
||||
"optional": true,
|
||||
"readonly": false,
|
||||
"type": "any",
|
||||
"default": ""
|
||||
},
|
||||
{
|
||||
"name": "inlinemessage",
|
||||
"optional": true,
|
||||
|
@ -30448,6 +30455,233 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"imagediff": {
|
||||
"description": "ImageDiff\n\n[Live Demo](https://www.primevue.org/imagediff/)",
|
||||
"components": {
|
||||
"default": {
|
||||
"description": "ImageDiff",
|
||||
"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": {
|
||||
"ImageDiffPassThroughMethodOptions": {
|
||||
"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": "ImageDiffProps",
|
||||
"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": []
|
||||
},
|
||||
"ImageDiffPassThroughOptions": {
|
||||
"description": "Custom passthrough(pt) options.",
|
||||
"relatedProp": "ImageDiffProps.pt",
|
||||
"props": [
|
||||
{
|
||||
"name": "root",
|
||||
"optional": true,
|
||||
"readonly": false,
|
||||
"type": "ImageDiffPassThroughOptionType",
|
||||
"default": "",
|
||||
"description": "Used to pass attributes to the root's DOM element."
|
||||
}
|
||||
],
|
||||
"methods": []
|
||||
},
|
||||
"ImageDiffPassThroughAttributes": {
|
||||
"description": "Custom passthrough attributes for each DOM elements",
|
||||
"relatedProp": "",
|
||||
"props": [
|
||||
{
|
||||
"name": "[key: string]",
|
||||
"optional": false,
|
||||
"readonly": false,
|
||||
"type": "any"
|
||||
}
|
||||
],
|
||||
"methods": []
|
||||
},
|
||||
"ImageDiffProps": {
|
||||
"description": "Defines valid properties in ImageDiff 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<ImageDiffPassThroughOptions>",
|
||||
"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": []
|
||||
},
|
||||
"ImageDiffSlots": {
|
||||
"description": "Defines valid slots in ImageDiff slots.",
|
||||
"relatedProp": "",
|
||||
"props": [],
|
||||
"methods": []
|
||||
},
|
||||
"ImageDiffEmitsOptions": {
|
||||
"relatedProp": "",
|
||||
"props": [],
|
||||
"methods": []
|
||||
}
|
||||
}
|
||||
},
|
||||
"tokens": {
|
||||
"description": "Define design tokens used by the component.",
|
||||
"values": {
|
||||
"ImageDiffPassThroughMethodOptions": {
|
||||
"description": "Custom passthrough(pt) option method.",
|
||||
"props": []
|
||||
},
|
||||
"ImageDiffPassThroughOptions": {
|
||||
"description": "Custom passthrough(pt) options.",
|
||||
"props": []
|
||||
},
|
||||
"ImageDiffPassThroughAttributes": {
|
||||
"description": "Custom passthrough attributes for each DOM elements",
|
||||
"props": []
|
||||
},
|
||||
"ImageDiffProps": {
|
||||
"description": "Defines valid properties in ImageDiff component.",
|
||||
"props": []
|
||||
},
|
||||
"ImageDiffSlots": {
|
||||
"description": "Defines valid slots in ImageDiff slots.",
|
||||
"props": []
|
||||
},
|
||||
"ImageDiffEmitsOptions": {
|
||||
"props": []
|
||||
}
|
||||
}
|
||||
},
|
||||
"types": {
|
||||
"description": "Defines the custom types used by the module.",
|
||||
"values": {
|
||||
"ImageDiffPassThroughOptionType": {
|
||||
"values": "ImageDiffPassThroughAttributes | (options: ImageDiffPassThroughMethodOptions) => undefined | string | null | undefined"
|
||||
},
|
||||
"ImageDiffPassThroughTransitionType": {
|
||||
"values": "TransitionProps | (options: ImageDiffPassThroughMethodOptions) => TransitionProps | undefined"
|
||||
},
|
||||
"ImageDiffEmits": {
|
||||
"values": "EmitFn<ImageDiffEmitsOptions>"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"imagediffstyle": {
|
||||
"description": "ImageDiff\n\n[Live Demo](https://www.primevue.org/imagediff/)",
|
||||
"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": {
|
||||
"ImageDiffStyle": {
|
||||
"relatedProp": "",
|
||||
"props": [],
|
||||
"methods": [],
|
||||
"extendedTypes": "default"
|
||||
}
|
||||
}
|
||||
},
|
||||
"tokens": {
|
||||
"description": "Define design tokens used by the component.",
|
||||
"values": {
|
||||
"ImageDiffStyle": {
|
||||
"props": []
|
||||
}
|
||||
}
|
||||
},
|
||||
"enumerations": {
|
||||
"values": {
|
||||
"ImageDiffClasses": {
|
||||
"members": [
|
||||
{
|
||||
"name": "root",
|
||||
"optional": false,
|
||||
"readonly": false,
|
||||
"value": "\"p-imagediff\"",
|
||||
"description": "Class name of the root element"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"inlinemessage": {
|
||||
"description": "InlineMessage component is useful in cases where a single message needs to be displayed related to an element such as forms. It has one property, severity of the message.\n\n[Live Demo](https://www.primevue.org/inlinemessage/)",
|
||||
"components": {
|
||||
|
|
Loading…
Reference in New Issue