From 36e60b638e7cc570a9df0bb16145fc620881442f Mon Sep 17 00:00:00 2001 From: GitHub Actions Bot <> Date: Thu, 3 Oct 2024 18:41:16 +0000 Subject: [PATCH] Update API doc --- apps/showcase/doc/common/apidoc/index.json | 208 +++++++++++++++++++-- pnpm-lock.yaml | 8 +- 2 files changed, 196 insertions(+), 20 deletions(-) diff --git a/apps/showcase/doc/common/apidoc/index.json b/apps/showcase/doc/common/apidoc/index.json index 227c0c575..43bf1339f 100644 --- a/apps/showcase/doc/common/apidoc/index.json +++ b/apps/showcase/doc/common/apidoc/index.json @@ -30455,11 +30455,11 @@ } } }, - "ImageCompare": { - "description": "ImageCompare\n\n[Live Demo](https://www.primevue.org/ImageCompare/)", + "imagecompare": { + "description": "ImageCompare compares two images side by side with a slider.\n\n[Live Demo](https://www.primevue.org/imagecompare)", "components": { "default": { - "description": "ImageCompare", + "description": "ImageCompare compares two images side by side with a slider.", "methods": { "description": "Defines methods that can be accessed by the component's reference.", "values": [] @@ -30530,6 +30530,22 @@ "type": "ImageComparePassThroughOptionType", "default": "", "description": "Used to pass attributes to the root's DOM element." + }, + { + "name": "slider", + "optional": true, + "readonly": false, + "type": "ImageComparePassThroughOptionType", + "default": "", + "description": "Used to pass attributes to the slider's DOM element." + }, + { + "name": "hooks", + "optional": true, + "readonly": false, + "type": "any", + "default": "", + "description": "Used to manage all lifecycle hooks." } ], "methods": [] @@ -30551,6 +30567,30 @@ "description": "Defines valid properties in ImageCompare component.", "relatedProp": "", "props": [ + { + "name": "tabindex", + "optional": true, + "readonly": false, + "type": "number", + "default": "0", + "description": "Index of the element in tabbing order." + }, + { + "name": "ariaLabel", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Defines a string value that labels an interactive element." + }, + { + "name": "ariaLabelledby", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Identifier of the underlying input element." + }, { "name": "dt", "optional": true, @@ -30587,12 +30627,26 @@ "methods": [] }, "ImageCompareSlots": { - "description": "Defines valid slots in ImageCompare slots.", + "description": "Defines valid slots in ImageCompare component.", "relatedProp": "", "props": [], - "methods": [] + "methods": [ + { + "name": "left", + "parameters": [], + "returnType": "VNode[]", + "description": "Custom left template." + }, + { + "name": "right", + "parameters": [], + "returnType": "VNode[]", + "description": "Custom right template." + } + ] }, "ImageCompareEmitsOptions": { + "description": "Defines valid emits in ImageCompare component.", "relatedProp": "", "props": [], "methods": [] @@ -30619,10 +30673,11 @@ "props": [] }, "ImageCompareSlots": { - "description": "Defines valid slots in ImageCompare slots.", + "description": "Defines valid slots in ImageCompare component.", "props": [] }, "ImageCompareEmitsOptions": { + "description": "Defines valid emits in ImageCompare component.", "props": [] } } @@ -30633,24 +30688,21 @@ "ImageComparePassThroughOptionType": { "values": "ImageComparePassThroughAttributes | (options: ImageComparePassThroughMethodOptions) => undefined | string | null | undefined" }, - "ImageComparePassThroughTransitionType": { - "values": "TransitionProps | (options: ImageComparePassThroughMethodOptions) => TransitionProps | undefined" - }, "ImageCompareEmits": { "values": "EmitFn" } } } }, - "imagediffstyle": { - "description": "ImageDiff\n\n[Live Demo](https://www.primevue.org/imagediff/)", + "imagecomparestyle": { + "description": "ImageCompare compares two images side by side with a slider.\n\n[Live Demo](https://www.primevue.org/imagecompare/)", "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": { + "ImageCompareStyle": { "relatedProp": "", "props": [], "methods": [], @@ -30661,21 +30713,28 @@ "tokens": { "description": "Define design tokens used by the component.", "values": { - "ImageDiffStyle": { + "ImageCompareStyle": { "props": [] } } }, "enumerations": { "values": { - "ImageDiffClasses": { + "ImageCompareClasses": { "members": [ { "name": "root", "optional": false, "readonly": false, - "value": "\"p-imagediff\"", + "value": "\"p-imagecompare\"", "description": "Class name of the root element" + }, + { + "name": "slider", + "optional": false, + "readonly": false, + "value": "\"p-imagecompare-slider\"", + "description": "Class name of the slider element" } ] } @@ -81733,6 +81792,14 @@ "ImageCompareDesignTokens": { "relatedProp": "", "props": [ + { + "name": "handle", + "optional": true, + "readonly": false, + "type": "Object", + "default": "", + "description": "Used to pass tokens of the handle section" + }, { "name": "colorScheme", "optional": true, @@ -81750,7 +81817,116 @@ "description": "Define design tokens used by the component.", "values": { "ImageCompareDesignTokens": { - "props": [] + "props": [ + { + "name": "handle.size", + "token": "imagecompare.handle.size", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Size of handle" + }, + { + "name": "handle.background", + "token": "imagecompare.handle.background", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Background of handle" + }, + { + "name": "border.width", + "token": "imagecompare.handle.border.width", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Border width of handle" + }, + { + "name": "border.style", + "token": "imagecompare.handle.border.style", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Border style of handle" + }, + { + "name": "border.color", + "token": "imagecompare.handle.border.color", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Border color of handle" + }, + { + "name": "border.radius", + "token": "imagecompare.handle.border.radius", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Border radius of handle" + }, + { + "name": "handle.transitionDuration", + "token": "imagecompare.handle.transition.duration", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Transition duration of handle" + }, + { + "name": "focusRing.width", + "token": "imagecompare.handle.focus.ring.width", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Focus ring width of handle" + }, + { + "name": "focusRing.style", + "token": "imagecompare.handle.focus.ring.style", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Focus ring style of handle" + }, + { + "name": "focusRing.color", + "token": "imagecompare.handle.focus.ring.color", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Focus ring color of handle" + }, + { + "name": "focusRing.offset", + "token": "imagecompare.handle.focus.ring.offset", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Focus ring offset of handle" + }, + { + "name": "focusRing.shadow", + "token": "imagecompare.handle.focus.ring.shadow", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Focus ring shadow of handle" + } + ] } } } diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index c5700af06..12a0d214e 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -3463,8 +3463,8 @@ packages: ee-first@1.1.1: resolution: {integrity: sha512-WMwm9LhRUo+WUaRN+vRuETqG89IgZphVSNkdFgeb6sS/E4OrDIN7t48CAewSHXc6C8lefD8KKfr5vY61brQlow==} - electron-to-chromium@1.5.31: - resolution: {integrity: sha512-QcDoBbQeYt0+3CWcK/rEbuHvwpbT/8SV9T3OSgs6cX1FlcUAkgrkqbg9zLnDrMM/rLamzQwal4LYFCiWk861Tg==} + electron-to-chromium@1.5.32: + resolution: {integrity: sha512-M+7ph0VGBQqqpTT2YrabjNKSQ2fEl9PVx6AK3N558gDH9NO8O6XN9SXXFWRo9u9PbEg/bWq+tjXQr+eXmxubCw==} emoji-regex@8.0.0: resolution: {integrity: sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==} @@ -9894,7 +9894,7 @@ snapshots: browserslist@4.24.0: dependencies: caniuse-lite: 1.0.30001666 - electron-to-chromium: 1.5.31 + electron-to-chromium: 1.5.32 node-releases: 2.0.18 update-browserslist-db: 1.1.1(browserslist@4.24.0) @@ -10513,7 +10513,7 @@ snapshots: ee-first@1.1.1: {} - electron-to-chromium@1.5.31: {} + electron-to-chromium@1.5.32: {} emoji-regex@8.0.0: {}