Update API doc

pull/7160/head
GitHub Actions Bot 2025-01-28 19:58:04 +00:00
parent 303959438a
commit ecde5f788c
4 changed files with 37 additions and 16 deletions

View File

@ -78968,6 +78968,23 @@
} }
} }
}, },
"primevue/src/utils/Utils": {
"functions": {
"description": "Defines the custom functions used by the module.",
"values": {
"blockBodyScroll": {
"name": "blockBodyScroll",
"parameters": [],
"returnType": "void"
},
"unblockBodyScroll": {
"name": "unblockBodyScroll",
"parameters": [],
"returnType": "void"
}
}
}
},
"virtualscroller": { "virtualscroller": {
"description": "VirtualScroller is a performant approach to handle huge data efficiently.\n\n[Live Demo](https://www.primevue.org/virtualscroller/)", "description": "VirtualScroller is a performant approach to handle huge data efficiently.\n\n[Live Demo](https://www.primevue.org/virtualscroller/)",
"components": { "components": {

View File

@ -1,2 +1,2 @@
export declare function blockBodyScroll() : void; export declare function blockBodyScroll(): void;
export declare function unblockBodyScroll() : void; export declare function unblockBodyScroll(): void;

View File

@ -1,5 +1,5 @@
import { $dt } from "@primeuix/styled"; import { $dt } from '@primeuix/styled';
import * as utils from "@primeuix/utils"; import * as utils from '@primeuix/utils';
export function blockBodyScroll() { export function blockBodyScroll() {
utils.blockBodyScroll({ variableName: $dt('scrollbar.width').name }); utils.blockBodyScroll({ variableName: $dt('scrollbar.width').name });

View File

@ -237,7 +237,7 @@ importers:
devDependencies: devDependencies:
'@nuxt/devtools': '@nuxt/devtools':
specifier: ^0.8.5 specifier: ^0.8.5
version: 0.8.5(nuxt@3.3.2(@types/node@18.19.74)(db0@0.2.3)(encoding@0.1.13)(eslint@8.57.1)(ioredis@5.4.2)(magicast@0.3.5)(optionator@0.9.4)(rollup@4.32.1)(terser@5.37.0)(typescript@5.7.3))(rollup@4.32.1) version: 0.8.5(nuxt@3.3.2(@types/node@18.19.74)(db0@0.2.3)(encoding@0.1.13)(eslint@8.57.1)(ioredis@5.4.2)(magicast@0.3.5)(optionator@0.9.4)(rollup@4.32.1)(terser@5.37.0)(typescript@5.7.3))(rollup@4.32.1)(vite@6.0.11(@types/node@18.19.74)(jiti@2.4.2)(terser@5.37.0)(yaml@2.7.0))
'@nuxt/eslint-config': '@nuxt/eslint-config':
specifier: ^0.2.0 specifier: ^0.2.0
version: 0.2.0(eslint@8.57.1) version: 0.2.0(eslint@8.57.1)
@ -2011,8 +2011,8 @@ packages:
'@redocly/ajv@8.11.2': '@redocly/ajv@8.11.2':
resolution: {integrity: sha512-io1JpnwtIcvojV7QKDUSIuMN/ikdOUd1ReEnUnMKGfDVridQZ31J0MmIuqwuRjWDZfmvr+Q0MqCcfHM2gTivOg==} resolution: {integrity: sha512-io1JpnwtIcvojV7QKDUSIuMN/ikdOUd1ReEnUnMKGfDVridQZ31J0MmIuqwuRjWDZfmvr+Q0MqCcfHM2gTivOg==}
'@redocly/config@0.20.2': '@redocly/config@0.20.3':
resolution: {integrity: sha512-b9sP9IOV0AW6ZZGh+fgffhU9xvMRSvVodPLWzoW1GvoxhUja3ZbPOCrI54VBowPocZ+9a7pIqNt0Ge32Sh34pA==} resolution: {integrity: sha512-Nyyv1Bj7GgYwj/l46O0nkH1GTKWbO3Ixe7KFcn021aZipkZd+z8Vlu1BwkhqtVgivcKaClaExtWU/lDHkjBzag==}
'@redocly/openapi-core@1.27.2': '@redocly/openapi-core@1.27.2':
resolution: {integrity: sha512-qVrDc27DHpeO2NRCMeRdb4299nijKQE3BY0wrA+WUHlOLScorIi/y7JzammLk22IaTvjR9Mv9aTAdjE1aUwJnA==} resolution: {integrity: sha512-qVrDc27DHpeO2NRCMeRdb4299nijKQE3BY0wrA+WUHlOLScorIi/y7JzammLk22IaTvjR9Mv9aTAdjE1aUwJnA==}
@ -8270,12 +8270,13 @@ snapshots:
'@nuxt/devalue@2.0.2': {} '@nuxt/devalue@2.0.2': {}
'@nuxt/devtools-kit@0.8.5(magicast@0.3.5)(nuxt@3.3.2(@types/node@18.19.74)(db0@0.2.3)(encoding@0.1.13)(eslint@8.57.1)(ioredis@5.4.2)(magicast@0.3.5)(optionator@0.9.4)(rollup@4.32.1)(terser@5.37.0)(typescript@5.7.3))(rollup@4.32.1)': '@nuxt/devtools-kit@0.8.5(magicast@0.3.5)(nuxt@3.3.2(@types/node@18.19.74)(db0@0.2.3)(encoding@0.1.13)(eslint@8.57.1)(ioredis@5.4.2)(magicast@0.3.5)(optionator@0.9.4)(rollup@4.32.1)(terser@5.37.0)(typescript@5.7.3))(rollup@4.32.1)(vite@6.0.11(@types/node@18.19.74)(jiti@2.4.2)(terser@5.37.0)(yaml@2.7.0))':
dependencies: dependencies:
'@nuxt/kit': 3.15.3(magicast@0.3.5)(rollup@4.32.1) '@nuxt/kit': 3.15.3(magicast@0.3.5)(rollup@4.32.1)
'@nuxt/schema': 3.15.3 '@nuxt/schema': 3.15.3
execa: 7.2.0 execa: 7.2.0
nuxt: 3.3.2(@types/node@18.19.74)(db0@0.2.3)(encoding@0.1.13)(eslint@8.57.1)(ioredis@5.4.2)(magicast@0.3.5)(optionator@0.9.4)(rollup@4.32.1)(terser@5.37.0)(typescript@5.7.3) nuxt: 3.3.2(@types/node@18.19.74)(db0@0.2.3)(encoding@0.1.13)(eslint@8.57.1)(ioredis@5.4.2)(magicast@0.3.5)(optionator@0.9.4)(rollup@4.32.1)(terser@5.37.0)(typescript@5.7.3)
vite: 6.0.11(@types/node@18.19.74)(jiti@2.4.2)(terser@5.37.0)(yaml@2.7.0)
transitivePeerDependencies: transitivePeerDependencies:
- magicast - magicast
- rollup - rollup
@ -8294,10 +8295,10 @@ snapshots:
rc9: 2.1.2 rc9: 2.1.2
semver: 7.6.3 semver: 7.6.3
'@nuxt/devtools@0.8.5(nuxt@3.3.2(@types/node@18.19.74)(db0@0.2.3)(encoding@0.1.13)(eslint@8.57.1)(ioredis@5.4.2)(magicast@0.3.5)(optionator@0.9.4)(rollup@4.32.1)(terser@5.37.0)(typescript@5.7.3))(rollup@4.32.1)': '@nuxt/devtools@0.8.5(nuxt@3.3.2(@types/node@18.19.74)(db0@0.2.3)(encoding@0.1.13)(eslint@8.57.1)(ioredis@5.4.2)(magicast@0.3.5)(optionator@0.9.4)(rollup@4.32.1)(terser@5.37.0)(typescript@5.7.3))(rollup@4.32.1)(vite@6.0.11(@types/node@18.19.74)(jiti@2.4.2)(terser@5.37.0)(yaml@2.7.0))':
dependencies: dependencies:
'@antfu/utils': 0.7.10 '@antfu/utils': 0.7.10
'@nuxt/devtools-kit': 0.8.5(magicast@0.3.5)(nuxt@3.3.2(@types/node@18.19.74)(db0@0.2.3)(encoding@0.1.13)(eslint@8.57.1)(ioredis@5.4.2)(magicast@0.3.5)(optionator@0.9.4)(rollup@4.32.1)(terser@5.37.0)(typescript@5.7.3))(rollup@4.32.1) '@nuxt/devtools-kit': 0.8.5(magicast@0.3.5)(nuxt@3.3.2(@types/node@18.19.74)(db0@0.2.3)(encoding@0.1.13)(eslint@8.57.1)(ioredis@5.4.2)(magicast@0.3.5)(optionator@0.9.4)(rollup@4.32.1)(terser@5.37.0)(typescript@5.7.3))(rollup@4.32.1)(vite@6.0.11(@types/node@18.19.74)(jiti@2.4.2)(terser@5.37.0)(yaml@2.7.0))
'@nuxt/devtools-wizard': 0.8.5 '@nuxt/devtools-wizard': 0.8.5
'@nuxt/kit': 3.15.3(magicast@0.3.5)(rollup@4.32.1) '@nuxt/kit': 3.15.3(magicast@0.3.5)(rollup@4.32.1)
birpc: 0.2.19 birpc: 0.2.19
@ -8328,8 +8329,9 @@ snapshots:
simple-git: 3.27.0 simple-git: 3.27.0
sirv: 2.0.4 sirv: 2.0.4
unimport: 3.14.6(rollup@4.32.1) unimport: 3.14.6(rollup@4.32.1)
vite-plugin-inspect: 0.7.42(@nuxt/kit@3.15.3(magicast@0.3.5)(rollup@4.32.1))(rollup@4.32.1) vite: 6.0.11(@types/node@18.19.74)(jiti@2.4.2)(terser@5.37.0)(yaml@2.7.0)
vite-plugin-vue-inspector: 3.7.2 vite-plugin-inspect: 0.7.42(@nuxt/kit@3.15.3(magicast@0.3.5)(rollup@4.32.1))(rollup@4.32.1)(vite@6.0.11(@types/node@18.19.74)(jiti@2.4.2)(terser@5.37.0)(yaml@2.7.0))
vite-plugin-vue-inspector: 3.7.2(vite@6.0.11(@types/node@18.19.74)(jiti@2.4.2)(terser@5.37.0)(yaml@2.7.0))
wait-on: 7.2.0 wait-on: 7.2.0
which: 3.0.1 which: 3.0.1
ws: 8.18.0 ws: 8.18.0
@ -8829,12 +8831,12 @@ snapshots:
require-from-string: 2.0.2 require-from-string: 2.0.2
uri-js-replace: 1.0.1 uri-js-replace: 1.0.1
'@redocly/config@0.20.2': {} '@redocly/config@0.20.3': {}
'@redocly/openapi-core@1.27.2(encoding@0.1.13)(supports-color@9.4.0)': '@redocly/openapi-core@1.27.2(encoding@0.1.13)(supports-color@9.4.0)':
dependencies: dependencies:
'@redocly/ajv': 8.11.2 '@redocly/ajv': 8.11.2
'@redocly/config': 0.20.2 '@redocly/config': 0.20.3
colorette: 1.4.0 colorette: 1.4.0
https-proxy-agent: 7.0.6(supports-color@9.4.0) https-proxy-agent: 7.0.6(supports-color@9.4.0)
js-levenshtein: 1.1.6 js-levenshtein: 1.1.6
@ -14100,7 +14102,7 @@ snapshots:
optionator: 0.9.4 optionator: 0.9.4
typescript: 5.7.3 typescript: 5.7.3
vite-plugin-inspect@0.7.42(@nuxt/kit@3.15.3(magicast@0.3.5)(rollup@4.32.1))(rollup@4.32.1): vite-plugin-inspect@0.7.42(@nuxt/kit@3.15.3(magicast@0.3.5)(rollup@4.32.1))(rollup@4.32.1)(vite@6.0.11(@types/node@18.19.74)(jiti@2.4.2)(terser@5.37.0)(yaml@2.7.0)):
dependencies: dependencies:
'@antfu/utils': 0.7.10 '@antfu/utils': 0.7.10
'@rollup/pluginutils': 5.1.4(rollup@4.32.1) '@rollup/pluginutils': 5.1.4(rollup@4.32.1)
@ -14110,13 +14112,14 @@ snapshots:
open: 9.1.0 open: 9.1.0
picocolors: 1.1.1 picocolors: 1.1.1
sirv: 2.0.4 sirv: 2.0.4
vite: 6.0.11(@types/node@18.19.74)(jiti@2.4.2)(terser@5.37.0)(yaml@2.7.0)
optionalDependencies: optionalDependencies:
'@nuxt/kit': 3.15.3(magicast@0.3.5)(rollup@4.32.1) '@nuxt/kit': 3.15.3(magicast@0.3.5)(rollup@4.32.1)
transitivePeerDependencies: transitivePeerDependencies:
- rollup - rollup
- supports-color - supports-color
vite-plugin-vue-inspector@3.7.2: vite-plugin-vue-inspector@3.7.2(vite@6.0.11(@types/node@18.19.74)(jiti@2.4.2)(terser@5.37.0)(yaml@2.7.0)):
dependencies: dependencies:
'@babel/core': 7.26.7 '@babel/core': 7.26.7
'@babel/plugin-proposal-decorators': 7.25.9(@babel/core@7.26.7) '@babel/plugin-proposal-decorators': 7.25.9(@babel/core@7.26.7)
@ -14127,6 +14130,7 @@ snapshots:
'@vue/compiler-dom': 3.5.13 '@vue/compiler-dom': 3.5.13
kolorist: 1.8.0 kolorist: 1.8.0
magic-string: 0.30.17 magic-string: 0.30.17
vite: 6.0.11(@types/node@18.19.74)(jiti@2.4.2)(terser@5.37.0)(yaml@2.7.0)
transitivePeerDependencies: transitivePeerDependencies:
- supports-color - supports-color