Update API doc

pull/6674/head
GitHub Actions Bot 2024-10-28 11:13:27 +00:00
parent 3840fa3599
commit 2dfd360e78
3 changed files with 89 additions and 61 deletions

View File

@ -41417,7 +41417,7 @@
"name": "variant", "name": "variant",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "\"outlined\" | \"text\"", "type": "\"outlined\" | \"simple\"",
"default": "outlined", "default": "outlined",
"description": "Specifies the input variant of the component." "description": "Specifies the input variant of the component."
} }
@ -88123,6 +88123,14 @@
"default": "", "default": "",
"description": "Used to pass tokens of the outlined section" "description": "Used to pass tokens of the outlined section"
}, },
{
"name": "simple",
"optional": true,
"readonly": false,
"type": "Object",
"default": "",
"description": "Used to pass tokens of the simple section"
},
{ {
"name": "info", "name": "info",
"optional": true, "optional": true,
@ -88398,6 +88406,15 @@
"default": "", "default": "",
"description": "Root border width of outlined" "description": "Root border width of outlined"
}, },
{
"name": "content.padding",
"token": "message.simple.content.padding",
"optional": true,
"readonly": false,
"type": "string",
"default": "",
"description": "Content padding of simple"
},
{ {
"name": "info.background", "name": "info.background",
"token": "message.info.background", "token": "message.info.background",
@ -88480,13 +88497,13 @@
"description": "Outlined border color of info" "description": "Outlined border color of info"
}, },
{ {
"name": "plain.color", "name": "simple.color",
"token": "message.info.plain.color", "token": "message.info.simple.color",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "string", "type": "string",
"default": "", "default": "",
"description": "Plain color of info" "description": "Simple color of info"
}, },
{ {
"name": "success.background", "name": "success.background",
@ -88570,13 +88587,13 @@
"description": "Outlined border color of success" "description": "Outlined border color of success"
}, },
{ {
"name": "plain.color", "name": "simple.color",
"token": "message.success.plain.color", "token": "message.success.simple.color",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "string", "type": "string",
"default": "", "default": "",
"description": "Plain color of success" "description": "Simple color of success"
}, },
{ {
"name": "warn.background", "name": "warn.background",
@ -88660,13 +88677,13 @@
"description": "Outlined border color of warn" "description": "Outlined border color of warn"
}, },
{ {
"name": "plain.color", "name": "simple.color",
"token": "message.warn.plain.color", "token": "message.warn.simple.color",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "string", "type": "string",
"default": "", "default": "",
"description": "Plain color of warn" "description": "Simple color of warn"
}, },
{ {
"name": "error.background", "name": "error.background",
@ -88750,13 +88767,13 @@
"description": "Outlined border color of error" "description": "Outlined border color of error"
}, },
{ {
"name": "plain.color", "name": "simple.color",
"token": "message.error.plain.color", "token": "message.error.simple.color",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "string", "type": "string",
"default": "", "default": "",
"description": "Plain color of error" "description": "Simple color of error"
}, },
{ {
"name": "secondary.background", "name": "secondary.background",
@ -88840,13 +88857,13 @@
"description": "Outlined border color of secondary" "description": "Outlined border color of secondary"
}, },
{ {
"name": "plain.color", "name": "simple.color",
"token": "message.secondary.plain.color", "token": "message.secondary.simple.color",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "string", "type": "string",
"default": "", "default": "",
"description": "Plain color of secondary" "description": "Simple color of secondary"
}, },
{ {
"name": "contrast.background", "name": "contrast.background",
@ -88930,13 +88947,13 @@
"description": "Outlined border color of contrast" "description": "Outlined border color of contrast"
}, },
{ {
"name": "plain.color", "name": "simple.color",
"token": "message.contrast.plain.color", "token": "message.contrast.simple.color",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "string", "type": "string",
"default": "", "default": "",
"description": "Plain color of contrast" "description": "Simple color of contrast"
} }
] ]
} }

View File

@ -240,6 +240,22 @@ export interface MessageDesignTokens extends ColorSchemeDesignToken<MessageDesig
borderWidth?: string; borderWidth?: string;
}; };
}; };
/**
* Used to pass tokens of the simple section
*/
simple?: {
/**
* Content of simple
*/
content?: {
/**
* Content padding of simple
*
* @designToken message.simple.content.padding
*/
padding?: string;
};
};
/** /**
* Used to pass tokens of the info section * Used to pass tokens of the info section
*/ */
@ -314,13 +330,13 @@ export interface MessageDesignTokens extends ColorSchemeDesignToken<MessageDesig
borderColor?: string; borderColor?: string;
}; };
/** /**
* Plain of info * Simple of info
*/ */
plain?: { simple?: {
/** /**
* Plain color of info * Simple color of info
* *
* @designToken message.info.plain.color * @designToken message.info.simple.color
*/ */
color?: string; color?: string;
}; };
@ -399,13 +415,13 @@ export interface MessageDesignTokens extends ColorSchemeDesignToken<MessageDesig
borderColor?: string; borderColor?: string;
}; };
/** /**
* Plain of success * Simple of success
*/ */
plain?: { simple?: {
/** /**
* Plain color of success * Simple color of success
* *
* @designToken message.success.plain.color * @designToken message.success.simple.color
*/ */
color?: string; color?: string;
}; };
@ -484,13 +500,13 @@ export interface MessageDesignTokens extends ColorSchemeDesignToken<MessageDesig
borderColor?: string; borderColor?: string;
}; };
/** /**
* Plain of warn * Simple of warn
*/ */
plain?: { simple?: {
/** /**
* Plain color of warn * Simple color of warn
* *
* @designToken message.warn.plain.color * @designToken message.warn.simple.color
*/ */
color?: string; color?: string;
}; };
@ -569,13 +585,13 @@ export interface MessageDesignTokens extends ColorSchemeDesignToken<MessageDesig
borderColor?: string; borderColor?: string;
}; };
/** /**
* Plain of error * Simple of error
*/ */
plain?: { simple?: {
/** /**
* Plain color of error * Simple color of error
* *
* @designToken message.error.plain.color * @designToken message.error.simple.color
*/ */
color?: string; color?: string;
}; };
@ -654,13 +670,13 @@ export interface MessageDesignTokens extends ColorSchemeDesignToken<MessageDesig
borderColor?: string; borderColor?: string;
}; };
/** /**
* Plain of secondary * Simple of secondary
*/ */
plain?: { simple?: {
/** /**
* Plain color of secondary * Simple color of secondary
* *
* @designToken message.secondary.plain.color * @designToken message.secondary.simple.color
*/ */
color?: string; color?: string;
}; };
@ -739,13 +755,13 @@ export interface MessageDesignTokens extends ColorSchemeDesignToken<MessageDesig
borderColor?: string; borderColor?: string;
}; };
/** /**
* Plain of contrast * Simple of contrast
*/ */
plain?: { simple?: {
/** /**
* Plain color of contrast * Simple color of contrast
* *
* @designToken message.contrast.plain.color * @designToken message.contrast.simple.color
*/ */
color?: string; color?: string;
}; };

View File

@ -234,7 +234,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.59)(encoding@0.1.13)(eslint@8.57.1)(ioredis@5.4.1)(magicast@0.3.5)(optionator@0.9.4)(rollup@4.24.2)(terser@5.36.0)(typescript@5.6.3))(rollup@4.24.2)(vite@5.4.10(@types/node@18.19.59)(terser@5.36.0)) version: 0.8.5(nuxt@3.3.2(@types/node@18.19.59)(encoding@0.1.13)(eslint@8.57.1)(ioredis@5.4.1)(magicast@0.3.5)(optionator@0.9.4)(rollup@4.24.2)(terser@5.36.0)(typescript@5.6.3))(rollup@4.24.2)
'@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)
@ -246,7 +246,7 @@ importers:
version: 3.13.2(rollup@4.24.2) version: 3.13.2(rollup@4.24.2)
'@nuxt/test-utils': '@nuxt/test-utils':
specifier: ^3.7.3 specifier: ^3.7.3
version: 3.14.4(@vue/test-utils@2.4.6)(h3@1.13.0)(magicast@0.3.5)(nitropack@2.9.7(encoding@0.1.13)(magicast@0.3.5))(rollup@4.24.2)(vite@5.4.10(@types/node@18.19.59)(terser@5.36.0))(vitest@1.6.0(@types/node@18.19.59)(terser@5.36.0))(vue-router@4.4.5(vue@3.5.12(typescript@5.6.3)))(vue@3.5.12(typescript@5.6.3)) version: 3.14.4(@vue/test-utils@2.4.6)(h3@1.13.0)(magicast@0.3.5)(nitropack@2.9.7(encoding@0.1.13)(magicast@0.3.5))(rollup@4.24.2)(vitest@1.6.0(@types/node@18.19.59)(terser@5.36.0))(vue-router@4.4.5(vue@3.5.12(typescript@5.6.3)))(vue@3.5.12(typescript@5.6.3))
'@primevue/themes': '@primevue/themes':
specifier: workspace:* specifier: workspace:*
version: link:../themes version: link:../themes
@ -8315,13 +8315,12 @@ 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.59)(encoding@0.1.13)(eslint@8.57.1)(ioredis@5.4.1)(magicast@0.3.5)(optionator@0.9.4)(rollup@4.24.2)(terser@5.36.0)(typescript@5.6.3))(rollup@4.24.2)(vite@5.4.10(@types/node@18.19.59)(terser@5.36.0))': '@nuxt/devtools-kit@0.8.5(magicast@0.3.5)(nuxt@3.3.2(@types/node@18.19.59)(encoding@0.1.13)(eslint@8.57.1)(ioredis@5.4.1)(magicast@0.3.5)(optionator@0.9.4)(rollup@4.24.2)(terser@5.36.0)(typescript@5.6.3))(rollup@4.24.2)':
dependencies: dependencies:
'@nuxt/kit': 3.13.2(magicast@0.3.5)(rollup@4.24.2) '@nuxt/kit': 3.13.2(magicast@0.3.5)(rollup@4.24.2)
'@nuxt/schema': 3.13.2(rollup@4.24.2) '@nuxt/schema': 3.13.2(rollup@4.24.2)
execa: 7.2.0 execa: 7.2.0
nuxt: 3.3.2(@types/node@18.19.59)(encoding@0.1.13)(eslint@8.57.1)(ioredis@5.4.1)(magicast@0.3.5)(optionator@0.9.4)(rollup@4.24.2)(terser@5.36.0)(typescript@5.6.3) nuxt: 3.3.2(@types/node@18.19.59)(encoding@0.1.13)(eslint@8.57.1)(ioredis@5.4.1)(magicast@0.3.5)(optionator@0.9.4)(rollup@4.24.2)(terser@5.36.0)(typescript@5.6.3)
vite: 5.4.10(@types/node@18.19.59)(terser@5.36.0)
transitivePeerDependencies: transitivePeerDependencies:
- magicast - magicast
- rollup - rollup
@ -8341,10 +8340,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.59)(encoding@0.1.13)(eslint@8.57.1)(ioredis@5.4.1)(magicast@0.3.5)(optionator@0.9.4)(rollup@4.24.2)(terser@5.36.0)(typescript@5.6.3))(rollup@4.24.2)(vite@5.4.10(@types/node@18.19.59)(terser@5.36.0))': '@nuxt/devtools@0.8.5(nuxt@3.3.2(@types/node@18.19.59)(encoding@0.1.13)(eslint@8.57.1)(ioredis@5.4.1)(magicast@0.3.5)(optionator@0.9.4)(rollup@4.24.2)(terser@5.36.0)(typescript@5.6.3))(rollup@4.24.2)':
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.59)(encoding@0.1.13)(eslint@8.57.1)(ioredis@5.4.1)(magicast@0.3.5)(optionator@0.9.4)(rollup@4.24.2)(terser@5.36.0)(typescript@5.6.3))(rollup@4.24.2)(vite@5.4.10(@types/node@18.19.59)(terser@5.36.0)) '@nuxt/devtools-kit': 0.8.5(magicast@0.3.5)(nuxt@3.3.2(@types/node@18.19.59)(encoding@0.1.13)(eslint@8.57.1)(ioredis@5.4.1)(magicast@0.3.5)(optionator@0.9.4)(rollup@4.24.2)(terser@5.36.0)(typescript@5.6.3))(rollup@4.24.2)
'@nuxt/devtools-wizard': 0.8.5 '@nuxt/devtools-wizard': 0.8.5
'@nuxt/kit': 3.13.2(magicast@0.3.5)(rollup@4.24.2) '@nuxt/kit': 3.13.2(magicast@0.3.5)(rollup@4.24.2)
birpc: 0.2.19 birpc: 0.2.19
@ -8375,9 +8374,8 @@ snapshots:
simple-git: 3.27.0 simple-git: 3.27.0
sirv: 2.0.4 sirv: 2.0.4
unimport: 3.13.1(rollup@4.24.2) unimport: 3.13.1(rollup@4.24.2)
vite: 5.4.10(@types/node@18.19.59)(terser@5.36.0) vite-plugin-inspect: 0.7.42(@nuxt/kit@3.13.2(magicast@0.3.5)(rollup@4.24.2))(rollup@4.24.2)
vite-plugin-inspect: 0.7.42(@nuxt/kit@3.13.2(magicast@0.3.5)(rollup@4.24.2))(rollup@4.24.2)(vite@5.4.10(@types/node@18.19.59)(terser@5.36.0)) vite-plugin-vue-inspector: 3.7.2
vite-plugin-vue-inspector: 3.7.2(vite@5.4.10(@types/node@18.19.59)(terser@5.36.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
@ -8687,7 +8685,7 @@ snapshots:
- supports-color - supports-color
- webpack-sources - webpack-sources
'@nuxt/test-utils@3.14.4(@vue/test-utils@2.4.6)(h3@1.13.0)(magicast@0.3.5)(nitropack@2.9.7(encoding@0.1.13)(magicast@0.3.5))(rollup@4.24.2)(vite@5.4.10(@types/node@18.19.59)(terser@5.36.0))(vitest@1.6.0(@types/node@18.19.59)(terser@5.36.0))(vue-router@4.4.5(vue@3.5.12(typescript@5.6.3)))(vue@3.5.12(typescript@5.6.3))': '@nuxt/test-utils@3.14.4(@vue/test-utils@2.4.6)(h3@1.13.0)(magicast@0.3.5)(nitropack@2.9.7(encoding@0.1.13)(magicast@0.3.5))(rollup@4.24.2)(vitest@1.6.0(@types/node@18.19.59)(terser@5.36.0))(vue-router@4.4.5(vue@3.5.12(typescript@5.6.3)))(vue@3.5.12(typescript@5.6.3))':
dependencies: dependencies:
'@nuxt/kit': 3.13.2(magicast@0.3.5)(rollup@4.24.2) '@nuxt/kit': 3.13.2(magicast@0.3.5)(rollup@4.24.2)
'@nuxt/schema': 3.13.2(rollup@4.24.2) '@nuxt/schema': 3.13.2(rollup@4.24.2)
@ -8713,8 +8711,7 @@ snapshots:
ufo: 1.5.4 ufo: 1.5.4
unenv: 1.10.0 unenv: 1.10.0
unplugin: 1.14.1(webpack-sources@3.2.3) unplugin: 1.14.1(webpack-sources@3.2.3)
vite: 5.4.10(@types/node@18.19.59)(terser@5.36.0) vitest-environment-nuxt: 1.0.1(@vue/test-utils@2.4.6)(h3@1.13.0)(magicast@0.3.5)(nitropack@2.9.7(encoding@0.1.13)(magicast@0.3.5))(rollup@4.24.2)(vitest@1.6.0(@types/node@18.19.59)(terser@5.36.0))(vue-router@4.4.5(vue@3.5.12(typescript@5.6.3)))(vue@3.5.12(typescript@5.6.3))
vitest-environment-nuxt: 1.0.1(@vue/test-utils@2.4.6)(h3@1.13.0)(magicast@0.3.5)(nitropack@2.9.7(encoding@0.1.13)(magicast@0.3.5))(rollup@4.24.2)(vite@5.4.10(@types/node@18.19.59)(terser@5.36.0))(vitest@1.6.0(@types/node@18.19.59)(terser@5.36.0))(vue-router@4.4.5(vue@3.5.12(typescript@5.6.3)))(vue@3.5.12(typescript@5.6.3))
vue: 3.5.12(typescript@5.6.3) vue: 3.5.12(typescript@5.6.3)
vue-router: 4.4.5(vue@3.5.12(typescript@5.6.3)) vue-router: 4.4.5(vue@3.5.12(typescript@5.6.3))
optionalDependencies: optionalDependencies:
@ -14234,7 +14231,7 @@ snapshots:
optionator: 0.9.4 optionator: 0.9.4
typescript: 5.6.3 typescript: 5.6.3
vite-plugin-inspect@0.7.42(@nuxt/kit@3.13.2(magicast@0.3.5)(rollup@4.24.2))(rollup@4.24.2)(vite@5.4.10(@types/node@18.19.59)(terser@5.36.0)): vite-plugin-inspect@0.7.42(@nuxt/kit@3.13.2(magicast@0.3.5)(rollup@4.24.2))(rollup@4.24.2):
dependencies: dependencies:
'@antfu/utils': 0.7.10 '@antfu/utils': 0.7.10
'@rollup/pluginutils': 5.1.3(rollup@4.24.2) '@rollup/pluginutils': 5.1.3(rollup@4.24.2)
@ -14244,14 +14241,13 @@ 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: 5.4.10(@types/node@18.19.59)(terser@5.36.0)
optionalDependencies: optionalDependencies:
'@nuxt/kit': 3.13.2(magicast@0.3.5)(rollup@4.24.2) '@nuxt/kit': 3.13.2(magicast@0.3.5)(rollup@4.24.2)
transitivePeerDependencies: transitivePeerDependencies:
- rollup - rollup
- supports-color - supports-color
vite-plugin-vue-inspector@3.7.2(vite@5.4.10(@types/node@18.19.59)(terser@5.36.0)): vite-plugin-vue-inspector@3.7.2:
dependencies: dependencies:
'@babel/core': 7.26.0 '@babel/core': 7.26.0
'@babel/plugin-proposal-decorators': 7.25.9(@babel/core@7.26.0) '@babel/plugin-proposal-decorators': 7.25.9(@babel/core@7.26.0)
@ -14262,7 +14258,6 @@ snapshots:
'@vue/compiler-dom': 3.5.12 '@vue/compiler-dom': 3.5.12
kolorist: 1.8.0 kolorist: 1.8.0
magic-string: 0.30.12 magic-string: 0.30.12
vite: 5.4.10(@types/node@18.19.59)(terser@5.36.0)
transitivePeerDependencies: transitivePeerDependencies:
- supports-color - supports-color
@ -14299,9 +14294,9 @@ snapshots:
fsevents: 2.3.3 fsevents: 2.3.3
terser: 5.36.0 terser: 5.36.0
vitest-environment-nuxt@1.0.1(@vue/test-utils@2.4.6)(h3@1.13.0)(magicast@0.3.5)(nitropack@2.9.7(encoding@0.1.13)(magicast@0.3.5))(rollup@4.24.2)(vite@5.4.10(@types/node@18.19.59)(terser@5.36.0))(vitest@1.6.0(@types/node@18.19.59)(terser@5.36.0))(vue-router@4.4.5(vue@3.5.12(typescript@5.6.3)))(vue@3.5.12(typescript@5.6.3)): vitest-environment-nuxt@1.0.1(@vue/test-utils@2.4.6)(h3@1.13.0)(magicast@0.3.5)(nitropack@2.9.7(encoding@0.1.13)(magicast@0.3.5))(rollup@4.24.2)(vitest@1.6.0(@types/node@18.19.59)(terser@5.36.0))(vue-router@4.4.5(vue@3.5.12(typescript@5.6.3)))(vue@3.5.12(typescript@5.6.3)):
dependencies: dependencies:
'@nuxt/test-utils': 3.14.4(@vue/test-utils@2.4.6)(h3@1.13.0)(magicast@0.3.5)(nitropack@2.9.7(encoding@0.1.13)(magicast@0.3.5))(rollup@4.24.2)(vite@5.4.10(@types/node@18.19.59)(terser@5.36.0))(vitest@1.6.0(@types/node@18.19.59)(terser@5.36.0))(vue-router@4.4.5(vue@3.5.12(typescript@5.6.3)))(vue@3.5.12(typescript@5.6.3)) '@nuxt/test-utils': 3.14.4(@vue/test-utils@2.4.6)(h3@1.13.0)(magicast@0.3.5)(nitropack@2.9.7(encoding@0.1.13)(magicast@0.3.5))(rollup@4.24.2)(vitest@1.6.0(@types/node@18.19.59)(terser@5.36.0))(vue-router@4.4.5(vue@3.5.12(typescript@5.6.3)))(vue@3.5.12(typescript@5.6.3))
transitivePeerDependencies: transitivePeerDependencies:
- '@cucumber/cucumber' - '@cucumber/cucumber'
- '@jest/globals' - '@jest/globals'