From 33a96974c526d1fb6f2971632b70d7123c48add0 Mon Sep 17 00:00:00 2001
From: GitHub Actions Bot <>
Date: Wed, 2 Oct 2024 07:04:27 +0000
Subject: [PATCH] Update API doc
---
apps/showcase/doc/common/apidoc/index.json | 46 ++++++++++++++++++-
pnpm-lock.yaml | 51 ++++++++++++----------
2 files changed, 73 insertions(+), 24 deletions(-)
diff --git a/apps/showcase/doc/common/apidoc/index.json b/apps/showcase/doc/common/apidoc/index.json
index 595c3fb7f..1eb3f9b6b 100644
--- a/apps/showcase/doc/common/apidoc/index.json
+++ b/apps/showcase/doc/common/apidoc/index.json
@@ -64560,6 +64560,22 @@
"default": "",
"description": "Used to pass attributes to the slider's DOM element."
},
+ {
+ "name": "handle",
+ "optional": true,
+ "readonly": false,
+ "type": "ToggleSwitchPassThroughOptionType",
+ "default": "",
+ "description": "Used to pass attributes to the handle's DOM element."
+ },
+ {
+ "name": "icon",
+ "optional": true,
+ "readonly": false,
+ "type": "ToggleSwitchPassThroughOptionType",
+ "default": "",
+ "description": "Used to pass attributes to the icon's DOM element."
+ },
{
"name": "hooks",
"optional": true,
@@ -64745,7 +64761,21 @@
"ToggleSwitchSlots": {
"relatedProp": "",
"props": [],
- "methods": []
+ "methods": [
+ {
+ "name": "icon",
+ "parameters": [
+ {
+ "name": "scope",
+ "optional": false,
+ "type": "{\n \t checked: boolean, // Current checked state of the item as a boolean.\n }",
+ "description": "icon slot's params."
+ }
+ ],
+ "returnType": "VNode[]",
+ "description": "Custom icon template."
+ }
+ ]
},
"ToggleSwitchEmitsOptions": {
"description": "Defines valid emits in ToggleSwitch component.",
@@ -64900,6 +64930,20 @@
"readonly": false,
"value": "\"p-toggleswitch-slider\"",
"description": "Class name of the slider element"
+ },
+ {
+ "name": "handle",
+ "optional": false,
+ "readonly": false,
+ "value": "\"p-toggleswitch-handle\"",
+ "description": "Class name of the handle element"
+ },
+ {
+ "name": "icon",
+ "optional": false,
+ "readonly": false,
+ "value": "\"p-toggleswitch-handle\"",
+ "description": "Class name of the icon element"
}
]
}
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
index ededc1217..5a1238246 100644
--- a/pnpm-lock.yaml
+++ b/pnpm-lock.yaml
@@ -194,7 +194,7 @@ importers:
devDependencies:
'@nuxt/devtools':
specifier: ^0.8.5
- version: 0.8.5(nuxt@3.3.2(@types/node@18.19.54)(encoding@0.1.13)(eslint@8.57.1)(ioredis@5.4.1)(magicast@0.3.5)(optionator@0.9.4)(rollup@4.23.0)(sass@1.79.4)(terser@5.34.1)(typescript@5.6.2)(webpack-sources@3.2.3))(rollup@4.23.0)(webpack-sources@3.2.3)
+ version: 0.8.5(nuxt@3.3.2(@types/node@18.19.54)(encoding@0.1.13)(eslint@8.57.1)(ioredis@5.4.1)(magicast@0.3.5)(optionator@0.9.4)(rollup@4.23.0)(sass@1.79.4)(terser@5.34.1)(typescript@5.6.2)(webpack-sources@3.2.3))(rollup@4.23.0)(vite@5.4.8(@types/node@18.19.54)(sass@1.79.4)(terser@5.34.1))(webpack-sources@3.2.3)
'@nuxt/eslint-config':
specifier: ^0.2.0
version: 0.2.0(eslint@8.57.1)
@@ -206,7 +206,7 @@ importers:
version: 3.13.2(rollup@4.23.0)(webpack-sources@3.2.3)
'@nuxt/test-utils':
specifier: ^3.7.3
- version: 3.14.2(@vue/test-utils@2.4.6)(h3@1.12.0)(magicast@0.3.5)(nitropack@2.9.7(encoding@0.1.13)(magicast@0.3.5)(webpack-sources@3.2.3))(rollup@4.23.0)(vitest@1.6.0(@types/node@18.19.54)(sass@1.79.4)(terser@5.34.1))(vue-router@4.4.5(vue@3.5.10(typescript@5.6.2)))(vue@3.5.10(typescript@5.6.2))(webpack-sources@3.2.3)
+ version: 3.14.2(@vue/test-utils@2.4.6)(h3@1.12.0)(magicast@0.3.5)(nitropack@2.9.7(encoding@0.1.13)(magicast@0.3.5)(webpack-sources@3.2.3))(rollup@4.23.0)(vite@5.4.8(@types/node@18.19.54)(sass@1.79.4)(terser@5.34.1))(vitest@1.6.0(@types/node@18.19.54)(sass@1.79.4)(terser@5.34.1))(vue-router@4.4.5(vue@3.5.10(typescript@5.6.2)))(vue@3.5.10(typescript@5.6.2))(webpack-sources@3.2.3)
'@primevue/themes':
specifier: workspace:*
version: link:../themes
@@ -2954,8 +2954,8 @@ packages:
caniuse-api@3.0.0:
resolution: {integrity: sha512-bsTwuIg/BZZK/vreVTYYbSWoe2F+71P7K5QGEX+pT250DZbfU1MQ5prOKpPR+LL6uWKK3KMwMCAS74QB3Um1uw==}
- caniuse-lite@1.0.30001664:
- resolution: {integrity: sha512-AmE7k4dXiNKQipgn7a2xg558IRqPN3jMQY/rOsbxDhrd0tyChwbITBfiwtnqz8bi2M5mIWbxAYBvk7W7QBUS2g==}
+ caniuse-lite@1.0.30001666:
+ resolution: {integrity: sha512-gD14ICmoV5ZZM1OdzPWmpx+q4GyefaK06zi8hmfHV5xe4/2nOQX3+Dw5o+fSqOws2xVwL9j+anOPFwHzdEdV4g==}
chai@4.5.0:
resolution: {integrity: sha512-RITGBfijLkBddZvnn8jdqoTypxvqbOLYQkGGxXzeFjVHvudaPw0HNFD9x928/eUwYWd2dPCugVqspGALTZZQKw==}
@@ -3466,8 +3466,8 @@ packages:
ee-first@1.1.1:
resolution: {integrity: sha512-WMwm9LhRUo+WUaRN+vRuETqG89IgZphVSNkdFgeb6sS/E4OrDIN7t48CAewSHXc6C8lefD8KKfr5vY61brQlow==}
- electron-to-chromium@1.5.30:
- resolution: {integrity: sha512-sXI35EBN4lYxzc/pIGorlymYNzDBOqkSlVRe6MkgBsW/hW1tpC/HDJ2fjG7XnjakzfLEuvdmux0Mjs6jHq4UOA==}
+ electron-to-chromium@1.5.31:
+ resolution: {integrity: sha512-QcDoBbQeYt0+3CWcK/rEbuHvwpbT/8SV9T3OSgs6cX1FlcUAkgrkqbg9zLnDrMM/rLamzQwal4LYFCiWk861Tg==}
emoji-regex@8.0.0:
resolution: {integrity: sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==}
@@ -8426,12 +8426,13 @@ snapshots:
'@nuxt/devalue@2.0.2': {}
- '@nuxt/devtools-kit@0.8.5(magicast@0.3.5)(nuxt@3.3.2(@types/node@18.19.54)(encoding@0.1.13)(eslint@8.57.1)(ioredis@5.4.1)(magicast@0.3.5)(optionator@0.9.4)(rollup@4.23.0)(sass@1.79.4)(terser@5.34.1)(typescript@5.6.2)(webpack-sources@3.2.3))(rollup@4.23.0)(webpack-sources@3.2.3)':
+ '@nuxt/devtools-kit@0.8.5(magicast@0.3.5)(nuxt@3.3.2(@types/node@18.19.54)(encoding@0.1.13)(eslint@8.57.1)(ioredis@5.4.1)(magicast@0.3.5)(optionator@0.9.4)(rollup@4.23.0)(sass@1.79.4)(terser@5.34.1)(typescript@5.6.2)(webpack-sources@3.2.3))(rollup@4.23.0)(vite@5.4.8(@types/node@18.19.54)(sass@1.79.4)(terser@5.34.1))(webpack-sources@3.2.3)':
dependencies:
'@nuxt/kit': 3.13.2(magicast@0.3.5)(rollup@4.23.0)(webpack-sources@3.2.3)
'@nuxt/schema': 3.13.2(rollup@4.23.0)(webpack-sources@3.2.3)
execa: 7.2.0
nuxt: 3.3.2(@types/node@18.19.54)(encoding@0.1.13)(eslint@8.57.1)(ioredis@5.4.1)(magicast@0.3.5)(optionator@0.9.4)(rollup@4.23.0)(sass@1.79.4)(terser@5.34.1)(typescript@5.6.2)(webpack-sources@3.2.3)
+ vite: 5.4.8(@types/node@18.19.54)(sass@1.79.4)(terser@5.34.1)
transitivePeerDependencies:
- magicast
- rollup
@@ -8451,10 +8452,10 @@ snapshots:
rc9: 2.1.2
semver: 7.6.3
- '@nuxt/devtools@0.8.5(nuxt@3.3.2(@types/node@18.19.54)(encoding@0.1.13)(eslint@8.57.1)(ioredis@5.4.1)(magicast@0.3.5)(optionator@0.9.4)(rollup@4.23.0)(sass@1.79.4)(terser@5.34.1)(typescript@5.6.2)(webpack-sources@3.2.3))(rollup@4.23.0)(webpack-sources@3.2.3)':
+ '@nuxt/devtools@0.8.5(nuxt@3.3.2(@types/node@18.19.54)(encoding@0.1.13)(eslint@8.57.1)(ioredis@5.4.1)(magicast@0.3.5)(optionator@0.9.4)(rollup@4.23.0)(sass@1.79.4)(terser@5.34.1)(typescript@5.6.2)(webpack-sources@3.2.3))(rollup@4.23.0)(vite@5.4.8(@types/node@18.19.54)(sass@1.79.4)(terser@5.34.1))(webpack-sources@3.2.3)':
dependencies:
'@antfu/utils': 0.7.10
- '@nuxt/devtools-kit': 0.8.5(magicast@0.3.5)(nuxt@3.3.2(@types/node@18.19.54)(encoding@0.1.13)(eslint@8.57.1)(ioredis@5.4.1)(magicast@0.3.5)(optionator@0.9.4)(rollup@4.23.0)(sass@1.79.4)(terser@5.34.1)(typescript@5.6.2)(webpack-sources@3.2.3))(rollup@4.23.0)(webpack-sources@3.2.3)
+ '@nuxt/devtools-kit': 0.8.5(magicast@0.3.5)(nuxt@3.3.2(@types/node@18.19.54)(encoding@0.1.13)(eslint@8.57.1)(ioredis@5.4.1)(magicast@0.3.5)(optionator@0.9.4)(rollup@4.23.0)(sass@1.79.4)(terser@5.34.1)(typescript@5.6.2)(webpack-sources@3.2.3))(rollup@4.23.0)(vite@5.4.8(@types/node@18.19.54)(sass@1.79.4)(terser@5.34.1))(webpack-sources@3.2.3)
'@nuxt/devtools-wizard': 0.8.5
'@nuxt/kit': 3.13.2(magicast@0.3.5)(rollup@4.23.0)(webpack-sources@3.2.3)
birpc: 0.2.17
@@ -8485,8 +8486,9 @@ snapshots:
simple-git: 3.27.0
sirv: 2.0.4
unimport: 3.13.1(rollup@4.23.0)(webpack-sources@3.2.3)
- vite-plugin-inspect: 0.7.42(@nuxt/kit@3.13.2(magicast@0.3.5)(rollup@4.23.0)(webpack-sources@3.2.3))(rollup@4.23.0)
- vite-plugin-vue-inspector: 3.7.2
+ vite: 5.4.8(@types/node@18.19.54)(sass@1.79.4)(terser@5.34.1)
+ vite-plugin-inspect: 0.7.42(@nuxt/kit@3.13.2(magicast@0.3.5)(rollup@4.23.0)(webpack-sources@3.2.3))(rollup@4.23.0)(vite@5.4.8(@types/node@18.19.54)(sass@1.79.4)(terser@5.34.1))
+ vite-plugin-vue-inspector: 3.7.2(vite@5.4.8(@types/node@18.19.54)(sass@1.79.4)(terser@5.34.1))
wait-on: 7.2.0
which: 3.0.1
ws: 8.18.0
@@ -8771,7 +8773,7 @@ snapshots:
- supports-color
- webpack-sources
- '@nuxt/test-utils@3.14.2(@vue/test-utils@2.4.6)(h3@1.12.0)(magicast@0.3.5)(nitropack@2.9.7(encoding@0.1.13)(magicast@0.3.5)(webpack-sources@3.2.3))(rollup@4.23.0)(vitest@1.6.0(@types/node@18.19.54)(sass@1.79.4)(terser@5.34.1))(vue-router@4.4.5(vue@3.5.10(typescript@5.6.2)))(vue@3.5.10(typescript@5.6.2))(webpack-sources@3.2.3)':
+ '@nuxt/test-utils@3.14.2(@vue/test-utils@2.4.6)(h3@1.12.0)(magicast@0.3.5)(nitropack@2.9.7(encoding@0.1.13)(magicast@0.3.5)(webpack-sources@3.2.3))(rollup@4.23.0)(vite@5.4.8(@types/node@18.19.54)(sass@1.79.4)(terser@5.34.1))(vitest@1.6.0(@types/node@18.19.54)(sass@1.79.4)(terser@5.34.1))(vue-router@4.4.5(vue@3.5.10(typescript@5.6.2)))(vue@3.5.10(typescript@5.6.2))(webpack-sources@3.2.3)':
dependencies:
'@nuxt/kit': 3.13.2(magicast@0.3.5)(rollup@4.23.0)(webpack-sources@3.2.3)
'@nuxt/schema': 3.13.2(rollup@4.23.0)(webpack-sources@3.2.3)
@@ -8797,7 +8799,8 @@ snapshots:
ufo: 1.5.4
unenv: 1.10.0
unplugin: 1.14.1(webpack-sources@3.2.3)
- vitest-environment-nuxt: 1.0.1(@vue/test-utils@2.4.6)(h3@1.12.0)(magicast@0.3.5)(nitropack@2.9.7(encoding@0.1.13)(magicast@0.3.5)(webpack-sources@3.2.3))(rollup@4.23.0)(vitest@1.6.0(@types/node@18.19.54)(sass@1.79.4)(terser@5.34.1))(vue-router@4.4.5(vue@3.5.10(typescript@5.6.2)))(vue@3.5.10(typescript@5.6.2))(webpack-sources@3.2.3)
+ vite: 5.4.8(@types/node@18.19.54)(sass@1.79.4)(terser@5.34.1)
+ vitest-environment-nuxt: 1.0.1(@vue/test-utils@2.4.6)(h3@1.12.0)(magicast@0.3.5)(nitropack@2.9.7(encoding@0.1.13)(magicast@0.3.5)(webpack-sources@3.2.3))(rollup@4.23.0)(vite@5.4.8(@types/node@18.19.54)(sass@1.79.4)(terser@5.34.1))(vitest@1.6.0(@types/node@18.19.54)(sass@1.79.4)(terser@5.34.1))(vue-router@4.4.5(vue@3.5.10(typescript@5.6.2)))(vue@3.5.10(typescript@5.6.2))(webpack-sources@3.2.3)
vue: 3.5.10(typescript@5.6.2)
vue-router: 4.4.5(vue@3.5.10(typescript@5.6.2))
optionalDependencies:
@@ -9807,7 +9810,7 @@ snapshots:
autoprefixer@10.4.20(postcss@8.4.47):
dependencies:
browserslist: 4.24.0
- caniuse-lite: 1.0.30001664
+ caniuse-lite: 1.0.30001666
fraction.js: 4.3.7
normalize-range: 0.1.2
picocolors: 1.1.0
@@ -9896,8 +9899,8 @@ snapshots:
browserslist@4.24.0:
dependencies:
- caniuse-lite: 1.0.30001664
- electron-to-chromium: 1.5.30
+ caniuse-lite: 1.0.30001666
+ electron-to-chromium: 1.5.31
node-releases: 2.0.18
update-browserslist-db: 1.1.1(browserslist@4.24.0)
@@ -9979,11 +9982,11 @@ snapshots:
caniuse-api@3.0.0:
dependencies:
browserslist: 4.24.0
- caniuse-lite: 1.0.30001664
+ caniuse-lite: 1.0.30001666
lodash.memoize: 4.1.2
lodash.uniq: 4.5.0
- caniuse-lite@1.0.30001664: {}
+ caniuse-lite@1.0.30001666: {}
chai@4.5.0:
dependencies:
@@ -10516,7 +10519,7 @@ snapshots:
ee-first@1.1.1: {}
- electron-to-chromium@1.5.30: {}
+ electron-to-chromium@1.5.31: {}
emoji-regex@8.0.0: {}
@@ -14110,7 +14113,7 @@ snapshots:
optionator: 0.9.4
typescript: 5.6.2
- vite-plugin-inspect@0.7.42(@nuxt/kit@3.13.2(magicast@0.3.5)(rollup@4.23.0)(webpack-sources@3.2.3))(rollup@4.23.0):
+ vite-plugin-inspect@0.7.42(@nuxt/kit@3.13.2(magicast@0.3.5)(rollup@4.23.0)(webpack-sources@3.2.3))(rollup@4.23.0)(vite@5.4.8(@types/node@18.19.54)(sass@1.79.4)(terser@5.34.1)):
dependencies:
'@antfu/utils': 0.7.10
'@rollup/pluginutils': 5.1.2(rollup@4.23.0)
@@ -14120,13 +14123,14 @@ snapshots:
open: 9.1.0
picocolors: 1.1.0
sirv: 2.0.4
+ vite: 5.4.8(@types/node@18.19.54)(sass@1.79.4)(terser@5.34.1)
optionalDependencies:
'@nuxt/kit': 3.13.2(magicast@0.3.5)(rollup@4.23.0)(webpack-sources@3.2.3)
transitivePeerDependencies:
- rollup
- supports-color
- vite-plugin-vue-inspector@3.7.2:
+ vite-plugin-vue-inspector@3.7.2(vite@5.4.8(@types/node@18.19.54)(sass@1.79.4)(terser@5.34.1)):
dependencies:
'@babel/core': 7.25.2
'@babel/plugin-proposal-decorators': 7.24.7(@babel/core@7.25.2)
@@ -14137,6 +14141,7 @@ snapshots:
'@vue/compiler-dom': 3.5.10
kolorist: 1.8.0
magic-string: 0.30.11
+ vite: 5.4.8(@types/node@18.19.54)(sass@1.79.4)(terser@5.34.1)
transitivePeerDependencies:
- supports-color
@@ -14174,9 +14179,9 @@ snapshots:
sass: 1.79.4
terser: 5.34.1
- vitest-environment-nuxt@1.0.1(@vue/test-utils@2.4.6)(h3@1.12.0)(magicast@0.3.5)(nitropack@2.9.7(encoding@0.1.13)(magicast@0.3.5)(webpack-sources@3.2.3))(rollup@4.23.0)(vitest@1.6.0(@types/node@18.19.54)(sass@1.79.4)(terser@5.34.1))(vue-router@4.4.5(vue@3.5.10(typescript@5.6.2)))(vue@3.5.10(typescript@5.6.2))(webpack-sources@3.2.3):
+ vitest-environment-nuxt@1.0.1(@vue/test-utils@2.4.6)(h3@1.12.0)(magicast@0.3.5)(nitropack@2.9.7(encoding@0.1.13)(magicast@0.3.5)(webpack-sources@3.2.3))(rollup@4.23.0)(vite@5.4.8(@types/node@18.19.54)(sass@1.79.4)(terser@5.34.1))(vitest@1.6.0(@types/node@18.19.54)(sass@1.79.4)(terser@5.34.1))(vue-router@4.4.5(vue@3.5.10(typescript@5.6.2)))(vue@3.5.10(typescript@5.6.2))(webpack-sources@3.2.3):
dependencies:
- '@nuxt/test-utils': 3.14.2(@vue/test-utils@2.4.6)(h3@1.12.0)(magicast@0.3.5)(nitropack@2.9.7(encoding@0.1.13)(magicast@0.3.5)(webpack-sources@3.2.3))(rollup@4.23.0)(vitest@1.6.0(@types/node@18.19.54)(sass@1.79.4)(terser@5.34.1))(vue-router@4.4.5(vue@3.5.10(typescript@5.6.2)))(vue@3.5.10(typescript@5.6.2))(webpack-sources@3.2.3)
+ '@nuxt/test-utils': 3.14.2(@vue/test-utils@2.4.6)(h3@1.12.0)(magicast@0.3.5)(nitropack@2.9.7(encoding@0.1.13)(magicast@0.3.5)(webpack-sources@3.2.3))(rollup@4.23.0)(vite@5.4.8(@types/node@18.19.54)(sass@1.79.4)(terser@5.34.1))(vitest@1.6.0(@types/node@18.19.54)(sass@1.79.4)(terser@5.34.1))(vue-router@4.4.5(vue@3.5.10(typescript@5.6.2)))(vue@3.5.10(typescript@5.6.2))(webpack-sources@3.2.3)
transitivePeerDependencies:
- '@cucumber/cucumber'
- '@jest/globals'