From ec1d85af1bcf7ffdd5fd97be1445f5ee5841086c Mon Sep 17 00:00:00 2001 From: GitHub Actions Bot <> Date: Tue, 1 Oct 2024 09:36:14 +0000 Subject: [PATCH] Update API doc --- apps/showcase/doc/common/apidoc/index.json | 270 +++++++++++++++++++++ pnpm-lock.yaml | 31 +-- 2 files changed, 283 insertions(+), 18 deletions(-) diff --git a/apps/showcase/doc/common/apidoc/index.json b/apps/showcase/doc/common/apidoc/index.json index 2a1826c8b..0316233b3 100644 --- a/apps/showcase/doc/common/apidoc/index.json +++ b/apps/showcase/doc/common/apidoc/index.json @@ -34858,6 +34858,276 @@ } } }, + "keyfilter": { + "description": "KeyFilter is a built-in feature of InputText to restrict user input based on a regular expression.\n\n[Live Demo](https://primevue.org/keyfilter)", + "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": { + "KeyFilterOptions": { + "description": "Defines options of KeyFilter.", + "relatedProp": "", + "props": [ + { + "name": "pattern", + "optional": true, + "readonly": false, + "type": "RegExp", + "default": "null", + "description": "Sets the pattern for key filtering." + }, + { + "name": "validateOnly", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "When enabled, instead of blocking keys, input is validated internally to test against the regular expression." + }, + { + "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", + "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": [] + }, + "KeyFilterDirectivePassThroughOptions": { + "description": "Custom passthrough(pt) options.", + "relatedProp": "KeyFilterOptions.pt", + "props": [ + { + "name": "root", + "optional": true, + "readonly": false, + "type": "KeyFilterDirectivePassThroughOptionType", + "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": [] + }, + "KeyFilterDirectivePassThroughAttributes": { + "description": "Custom passthrough attributes for each DOM elements", + "relatedProp": "", + "props": [ + { + "name": "[key: string]", + "optional": false, + "readonly": false, + "type": "any" + } + ], + "methods": [] + }, + "KeyFilterModifiers": { + "description": "Defines modifiers of KeyFilter directive.", + "relatedProp": "", + "props": [ + { + "name": "pint", + "optional": true, + "readonly": false, + "type": "RegExp", + "default": "false", + "description": "Positive integer pattern for KeyFilter directive." + }, + { + "name": "int", + "optional": true, + "readonly": false, + "type": "RegExp", + "default": "false", + "description": "Integer pattern for KeyFilter directive." + }, + { + "name": "pnum", + "optional": true, + "readonly": false, + "type": "RegExp", + "default": "false", + "description": "Positive number pattern for KeyFilter directive." + }, + { + "name": "money", + "optional": true, + "readonly": false, + "type": "RegExp", + "default": "false", + "description": "Money pattern for KeyFilter directive." + }, + { + "name": "num", + "optional": true, + "readonly": false, + "type": "RegExp", + "default": "false", + "description": "Number pattern for KeyFilter directive." + }, + { + "name": "hex", + "optional": true, + "readonly": false, + "type": "RegExp", + "default": "false", + "description": "Hexadecimal pattern for KeyFilter directive." + }, + { + "name": "email", + "optional": true, + "readonly": false, + "type": "RegExp", + "default": "false", + "description": "Email pattern for KeyFilter directive." + }, + { + "name": "alpha", + "optional": true, + "readonly": false, + "type": "RegExp", + "default": "false", + "description": "Alphabetic pattern for KeyFilter directive." + }, + { + "name": "alphanum", + "optional": true, + "readonly": false, + "type": "RegExp", + "default": "false", + "description": "Alphanumeric pattern for KeyFilter directive." + } + ], + "methods": [] + }, + "KeyFilterDirectiveBinding": { + "description": "Binding of KeyFilter directive.", + "relatedProp": "", + "props": [ + { + "name": "value", + "optional": true, + "readonly": false, + "type": "string | KeyFilterOptions", + "default": "", + "description": "Value of the KeyFilter." + }, + { + "name": "modifiers", + "optional": true, + "readonly": false, + "type": "KeyFilterModifiers", + "default": "", + "description": "Modifiers of the KeyFilter." + } + ], + "methods": [], + "extendedTypes": "Omit" + } + } + }, + "tokens": { + "description": "Define design tokens used by the component.", + "values": { + "KeyFilterOptions": { + "description": "Defines options of KeyFilter.", + "props": [] + }, + "KeyFilterDirectivePassThroughOptions": { + "description": "Custom passthrough(pt) options.", + "props": [] + }, + "KeyFilterDirectivePassThroughAttributes": { + "description": "Custom passthrough attributes for each DOM elements", + "props": [] + }, + "KeyFilterModifiers": { + "description": "Defines modifiers of KeyFilter directive.", + "props": [] + }, + "KeyFilterDirectiveBinding": { + "description": "Binding of KeyFilter directive.", + "props": [] + } + } + }, + "types": { + "description": "Defines the custom types used by the module.", + "values": { + "KeyFilterDirectivePassThroughOptionType": { + "values": "KeyFilterDirectivePassThroughAttributes | null | undefined" + } + } + } + }, + "keyfilterstyle": { + "description": "KeyFilter is a built-in feature of InputText to restrict user input based on a regular expression.\n\n[Live Demo](https://primevue.org/keyfilter)", + "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": { + "KeyFilterStyle": { + "relatedProp": "", + "props": [], + "methods": [], + "extendedTypes": "default" + } + } + }, + "tokens": { + "description": "Define design tokens used by the component.", + "values": { + "KeyFilterStyle": { + "props": [] + } + } + }, + "enumerations": { + "values": { + "KeyFilterClasses": { + "members": [] + } + } + } + }, "knob": { "description": "Knob is a form component to define number inputs with a dial.\n\n[Live Demo](https://www.primevue.org/knob/)", "components": { diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index f2afeb8ce..745a65469 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)(vite@5.4.8(@types/node@18.19.54)(sass@1.79.4)(terser@5.34.1))(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)(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)(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) + 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) '@primevue/themes': specifier: workspace:* version: link:../themes @@ -8426,13 +8426,12 @@ 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)(vite@5.4.8(@types/node@18.19.54)(sass@1.79.4)(terser@5.34.1))(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)(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 @@ -8452,10 +8451,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)(vite@5.4.8(@types/node@18.19.54)(sass@1.79.4)(terser@5.34.1))(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)(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)(vite@5.4.8(@types/node@18.19.54)(sass@1.79.4)(terser@5.34.1))(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)(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 @@ -8486,9 +8485,8 @@ snapshots: simple-git: 3.27.0 sirv: 2.0.4 unimport: 3.13.1(rollup@4.23.0)(webpack-sources@3.2.3) - 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)) + 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 wait-on: 7.2.0 which: 3.0.1 ws: 8.18.0 @@ -8773,7 +8771,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)(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)': + '@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)': 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) @@ -8799,8 +8797,7 @@ snapshots: ufo: 1.5.4 unenv: 1.10.0 unplugin: 1.14.1(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) + 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) vue: 3.5.10(typescript@5.6.2) vue-router: 4.4.5(vue@3.5.10(typescript@5.6.2)) optionalDependencies: @@ -14113,7 +14110,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@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): dependencies: '@antfu/utils': 0.7.10 '@rollup/pluginutils': 5.1.2(rollup@4.23.0) @@ -14123,14 +14120,13 @@ 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@5.4.8(@types/node@18.19.54)(sass@1.79.4)(terser@5.34.1)): + vite-plugin-vue-inspector@3.7.2: dependencies: '@babel/core': 7.25.2 '@babel/plugin-proposal-decorators': 7.24.7(@babel/core@7.25.2) @@ -14141,7 +14137,6 @@ 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 @@ -14179,9 +14174,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)(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): + 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): 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)(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) + '@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) transitivePeerDependencies: - '@cucumber/cucumber' - '@jest/globals'