diff --git a/.eslintrc.cjs b/.eslintrc.cjs index 5ff9ea0b9..b1725e176 100644 --- a/.eslintrc.cjs +++ b/.eslintrc.cjs @@ -43,6 +43,9 @@ module.exports = { files: ['docs/**'], globals: { __ROLLBACK_LANG__: 'readonly' + }, + rules: { + 'import/order': 'off' } }, { diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 80bc0b6e2..731756062 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -12,10 +12,13 @@ Before submitting the PR, please make sure you do the following: --> ### Description + ### Linked Issues + ### Additional Context + diff --git a/.npmrc b/.npmrc index f3b569056..3bd3b7de7 100644 --- a/.npmrc +++ b/.npmrc @@ -1 +1 @@ -shell-emulator=true \ No newline at end of file +shell-emulator=true diff --git a/.vscode/settings.json b/.vscode/settings.json index e4bc7cea5..c569642b3 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -26,6 +26,7 @@ "xsl" ], "volar.inlayHints.eventArgumentInInlineHandlers": false, + "vue.inlayHints.inlineHandlerLeading": false, "[vue]": { "editor.defaultFormatter": "Vue.volar" }, diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6e280bc60..2a687019c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,49 +2,49 @@ First, thanks for being interested in contributing on this project! -## Development +## Pre-request -### Pre-request - -Before starting, you should ensure your mechine is having: +Before starting, ensure your mechine is having: Node >= 18 pnpm >= 8 -### Setup +## Setup -Fork this repo, the clone it to your local mechine and intsall the dependencies: +Fork [Vexip UI](https://github.com/vexip-ui/vexip-ui) and clone to your local mechine and install dependencies: ```sh pnpm install # pnpm i ``` -Then you need to build all packages under `common`: +Then you need to build once the packages under `common` (**IMPORTANT**): ```sh pnpm run build:common ``` -### Developing for Component +## Component Development -We use a vite project in `dev-server` for development. +We use a Vite project in `dev-server` a development server. -Using the following command you can start development server for specify component: +You can use the following command to start development server for specify component: ```sh pnpm run serve [component] ``` -You can also specify the port and language via additional command: +After the server is successfully started, the demos of the components specified under `docs/demos` will be used as development cases. + +The development server uses `8008` port and Chinese demos by default, you can add `-p` and `-l` parameters to the command to specify the port and language respectively: ```sh pnpm run serve [component] -p [port] -l [languagt] ``` -### Developing for Document +## Documentation Development -We alse use a vite project for documenting, you can start it locally: +We use [VitePress](https://vitepress.dev/) as the documentation framework. You can start it locally with the following command: ```sh pnpm run serve:docs @@ -52,13 +52,28 @@ pnpm run serve:docs ## Create New Component -you can create some templete files by: +You can quickly create a new component using template files: ```sh -pnpm run create [component-name] +pnpm run create [component] ``` -Then you need to update exports files by: +Wait patiently for the files to be created, then you can check the files in the following locations: + +- `components/[component]/index.ts` +- `components/[component]/props.ts` +- `components/[component]/css.ts` +- `components/[component]/style.ts` +- `components/[component]/[component].vue` +- `components/[component]/tests/ssr.spec.tsx` +- `components/[component]/tests/[component].spec.tsx` +- `docs/demos/[component]/basis/demo.en-US.vue` +- `docs/demos/[component]/basis/demo.zh-CN.vue` +- `docs/en-US/component/[component].md` +- `docs/zh-CN/component/[component].md` +- `style/[component].scss` + +After confirming, you can execute the bootstrap command and start developing the component and its documentation. ```sh pnpm run bootstrap diff --git a/LICENSE.md b/LICENSE.md index aa043170e..f21cafc44 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,6 +1,6 @@ The MIT License (MIT) -Copyright (c) 2019-present vexip-ui +Copyright (c) 2019-present vexip-ui and contributors Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts new file mode 100644 index 000000000..57879bc99 --- /dev/null +++ b/docs/.vitepress/config.ts @@ -0,0 +1,215 @@ +import { getPackageInfoSync, resolveModule } from 'local-pkg' +import { getGuideConfig } from './config/guide' +import { getComponentConfig } from './config/component' +import { highlight } from '../build/highlight' +import { markdownItSetup } from '../build/markdown' +import { toKebabCase } from '@vexip-ui/utils' +import * as compiler from '@vue/compiler-sfc' + +import type { UserConfig } from 'vitepress' +import type { ThemeConfig } from './theme/types' + +compiler.parseCache.max = 10000 + +export default >{ + srcExclude: ['demos', 'guides', 'README.md'], + ignoreDeadLinks: true, + titleTemplate: 'Vexip UI', + lastUpdated: true, + head: [ + ['meta', { 'http-equiv': 'Expires', content: '0' }], + ['meta', { 'http-equiv': 'Pragma', content: 'no-cache' }], + ['meta', { 'http-equiv': 'Cache', content: 'no-cache' }], + ['meta', { 'http-equiv': 'Cache-control', content: 'no-store,no-cache,must-revalidate' }], + ['link', { rel: 'icon', type: 'image/svg+xml', href: '/vexip-ui.svg' }] + ], + markdown: { + highlight, + config: markdownItSetup + }, + vue: { + template: { + ssr: true + }, + compiler: compiler as any + }, + themeConfig: { + /** + * 自定义配置信息 + * asideMenus 侧边栏菜单 + */ + asideMenus: getAsideMenus(), + + nav: [ + { key: 'guides', i18n: 'common.guides', link: '/guide/vexip-ui', activeMatch: '/guide/' }, + { + key: 'components', + i18n: 'common.components', + link: '/component/button', + activeMatch: '/component/' + }, + { key: 'playground', i18n: 'common.playground', link: 'https://playground.vexipui.com' } + ], + outline: { + '/guide/': 2, + '/component/': 3 + }, + editLink: { + pattern: 'https://github.com/vexip-ui/vexip-ui/edit/main/docs/:path' + }, + + footerLinks: [] + }, + locales: { + 'en-US': { + label: 'English', + lang: 'en-US', + themeConfig: { + footerLinks: getFooterLinks('en-US') + } + }, + 'zh-CN': { + label: '中文', + lang: 'zh-CN', + themeConfig: { + footerLinks: getFooterLinks('zh-CN') + } + } + } +} + +let version: string | undefined + +function queryLibVersion() { + if (version) return version + + try { + version = + getPackageInfoSync('vexip-ui')?.version ?? + getPackageInfoSync('vexip-ui', { paths: [resolveModule('vexip-ui') || process.cwd()] }) + ?.version + } catch (e) { + console.error(e) + } + + if (!version) { + throw new Error('[vexip-ui:docs] failed to load vexip-ui version, please check') + } + + return version +} + +function getAsideMenus(): ThemeConfig['asideMenus'] { + const versionPrefix = queryLibVersion().split('.').slice(0, 2).join('.') + '.' + + return { + '/guide/': getGuideConfig().map(group => { + return { + key: group.name, + i18n: `guide.${group.name}`, + items: group.guides.map(guide => { + return { + key: guide.name, + link: `/guide/${guide.name}`, + i18n: `guide.${guide.i18n}` + } + }) + } + }), + '/component/': getComponentConfig().map(group => { + return { + key: group.name, + i18n: `group.${group.name}`, + count: true, + items: group.components.map(component => ({ + key: component.name, + link: `/component/${toKebabCase(component.name)}`, + i18n: `component.${component.name}`, + tag: component.since?.startsWith(versionPrefix) ? 'New' : '', + origin: component.name + })) + } + }) + } +} + +function getFooterLinks(lang: 'zh-CN' | 'en-US'): ThemeConfig['footerLinks'] { + const t = (s: string) => `footer.${s}` + + return [ + { + i18n: t('resources'), + items: [ + { + text: 'Vexip Nuxt Module', + link: 'https://github.com/vexip-ui/nuxt' + }, + { + text: 'Vexip Lint Config', + subi18n: t('lintConfigSet'), + link: 'https://github.com/vexip-ui/lint-config' + }, + { + text: 'Create Vexip', + subi18n: t('createProject'), + link: 'https://github.com/vexip-ui/create-vexip' + }, + { + text: 'Grid Layout Plus', + subi18n: t('gridLayout'), + link: `https://grid-layout-plus.netlify.app/${lang === 'zh-CN' ? 'zh/' : ''}` + }, + { + text: 'vite-plugin-dts', + link: 'https://github.com/qmhc/vite-plugin-dts' + }, + { + text: 'vue-hooks-plus', + subi18n: t('hooksLib'), + link: `https://inhiblabcore.github.io/docs/hooks/${lang !== 'zh-CN' ? 'en/' : ''}` + }, + { + text: 'Vexip SFC Playground', + link: 'https://playground.vexipui.com/' + }, + { + text: 'RedBlues-1980', + subi18n: t('logoDesign'), + link: 'https://richuangangban1980.lofter.com/' + } + ] + }, + { + i18n: t('help'), + items: [ + { + text: 'GitHub', + link: 'https://github.com/vexip-ui/vexip-ui' + }, + { + i18n: t('changelog'), + link: 'https://github.com/vexip-ui/vexip-ui/blob/main/CHANGELOG.md' + }, + { + i18n: t('issue'), + link: 'https://github.com/vexip-ui/vexip-ui/issues' + }, + { + i18n: t('contribute'), + link: 'https://github.com/vexip-ui/vexip-ui/blob/main/CONTRIBUTING.md' + }, + { + i18n: t('qqGroup'), + link: 'https://jq.qq.com/?_wv=1027&k=5KlA84xG' + }, + { + i18n: t('sponsor'), + link: + lang === 'zh-CN' + ? '/zh-CN/guide/vexip-ui.html#%E8%B4%A1%E7%8C%AE' + : '/en-US/guide/vexip-ui.html#contributing' + } + ] + } + ] +} diff --git a/docs/router/components.ts b/docs/.vitepress/config/component.ts similarity index 100% rename from docs/router/components.ts rename to docs/.vitepress/config/component.ts diff --git a/docs/.vitepress/config/guide.ts b/docs/.vitepress/config/guide.ts new file mode 100644 index 000000000..acf036b66 --- /dev/null +++ b/docs/.vitepress/config/guide.ts @@ -0,0 +1,34 @@ +export interface GuideConfig { + name: string, + i18n: string +} + +export interface GuideGroup { + name: string, + guides: GuideConfig[] +} + +export function getGuideConfig(): GuideGroup[] { + return [ + { + name: 'introduction', + guides: [ + { name: 'vexip-ui', i18n: 'vexipui' }, + { name: 'getting-started', i18n: 'gettingStarted' }, + { name: 'name-origin', i18n: 'nameOrigin' }, + { name: 'logo-origin', i18n: 'logoOrigin' } + ] + }, + { + name: 'further', + guides: [ + { name: 'global-config', i18n: 'globalConfig' }, + { name: 'style-config', i18n: 'styleConfig' }, + { name: 'i18n', i18n: 'i18n' }, + { name: 'ssr', i18n: 'ssr' }, + { name: 'custom-form-control', i18n: 'customFormControl' }, + { name: 'development-guide', i18n: 'developmentGuide' } + ] + } + ] +} diff --git a/docs/.vitepress/shared.ts b/docs/.vitepress/shared.ts new file mode 100644 index 000000000..275486492 --- /dev/null +++ b/docs/.vitepress/shared.ts @@ -0,0 +1,16 @@ +import { ensureArray } from '@vexip-ui/utils' + +// e.g. http: https: +export const EXTERNAL_URL_RE = /^[a-z]+:/i + +export function isExternal(path: string) { + return EXTERNAL_URL_RE.test(path) +} + +export function ensureStartingSlash(path: string) { + return /^\//.test(path) ? path : `/${path}` +} + +export function removeExt(path: string, exts: string | string[] = ['md', 'html']) { + return path.replace(new RegExp(`\\.(${ensureArray(exts).join('|')})`), '') +} diff --git a/docs/.vitepress/theme/app.vue b/docs/.vitepress/theme/app.vue new file mode 100644 index 000000000..56c55450f --- /dev/null +++ b/docs/.vitepress/theme/app.vue @@ -0,0 +1,299 @@ + + + + + diff --git a/docs/common/demo-prefix.ts b/docs/.vitepress/theme/common/demo-prefix.ts similarity index 99% rename from docs/common/demo-prefix.ts rename to docs/.vitepress/theme/common/demo-prefix.ts index 619b995bf..a7b623c6e 100644 --- a/docs/common/demo-prefix.ts +++ b/docs/.vitepress/theme/common/demo-prefix.ts @@ -1,5 +1,4 @@ import { ref } from 'vue' - import { isClient, toCapitalCase } from '@vexip-ui/utils' const components = [ @@ -53,7 +52,6 @@ const components = [ 'LayoutAside', 'LayoutFooter', 'LayoutHeader', - 'LayoutMain', 'Linker', 'Masker', 'Menu', diff --git a/docs/.vitepress/theme/common/hash-target.ts b/docs/.vitepress/theme/common/hash-target.ts new file mode 100644 index 000000000..dbe278745 --- /dev/null +++ b/docs/.vitepress/theme/common/hash-target.ts @@ -0,0 +1,22 @@ +import { readonly, ref } from 'vue' +import { isClient } from '@vexip-ui/utils' + +const currentTarget = ref() + +if (isClient) { + window.addEventListener('hashchange', updateTarget) + window.addEventListener('popstate', updateTarget) + updateTarget() +} + +function updateTarget() { + const hash = location.hash + + if (!hash || hash === '#') { + currentTarget.value = '' + } else { + currentTarget.value = decodeURIComponent(hash.startsWith('#') ? hash.substring(1) : hash) + } +} + +export const hashTarget = readonly(currentTarget) diff --git a/docs/common/playground.ts b/docs/.vitepress/theme/common/playground.ts similarity index 100% rename from docs/common/playground.ts rename to docs/.vitepress/theme/common/playground.ts diff --git a/docs/common/series-color.ts b/docs/.vitepress/theme/common/series-color.ts similarity index 100% rename from docs/common/series-color.ts rename to docs/.vitepress/theme/common/series-color.ts diff --git a/docs/common/toc-anchor.ts b/docs/.vitepress/theme/common/toc-anchor.ts similarity index 93% rename from docs/common/toc-anchor.ts rename to docs/.vitepress/theme/common/toc-anchor.ts index 7f069f0f9..00a39d454 100644 --- a/docs/common/toc-anchor.ts +++ b/docs/.vitepress/theme/common/toc-anchor.ts @@ -15,7 +15,7 @@ export function ussTocAnchor(initLevel: 2 | 3 = 2, wrapper = ref()) Array.from( wrapper.value.querySelectorAll( - `.demo, :not(.demo__description) > .markdown h${level}.anchor > .anchor__title[id]` + `.demo, :not(.demo__description) > h${level}.anchor > .anchor__title[id]` ) ).forEach(el => { let id: string diff --git a/docs/.vitepress/theme/components/article.vue b/docs/.vitepress/theme/components/article.vue new file mode 100644 index 000000000..68f76b2d2 --- /dev/null +++ b/docs/.vitepress/theme/components/article.vue @@ -0,0 +1,166 @@ + + + + + diff --git a/docs/.vitepress/theme/components/aside-menu.vue b/docs/.vitepress/theme/components/aside-menu.vue new file mode 100644 index 000000000..c14decea0 --- /dev/null +++ b/docs/.vitepress/theme/components/aside-menu.vue @@ -0,0 +1,160 @@ + + + + + diff --git a/docs/common/audio-button.vue b/docs/.vitepress/theme/components/audio-button.vue similarity index 99% rename from docs/common/audio-button.vue rename to docs/.vitepress/theme/components/audio-button.vue index b5697db29..b9c7fff2c 100644 --- a/docs/common/audio-button.vue +++ b/docs/.vitepress/theme/components/audio-button.vue @@ -1,15 +1,5 @@ - - + + diff --git a/docs/.vitepress/theme/components/control-demo-after.vue b/docs/.vitepress/theme/components/control-demo-after.vue new file mode 100644 index 000000000..7de08116f --- /dev/null +++ b/docs/.vitepress/theme/components/control-demo-after.vue @@ -0,0 +1,104 @@ + + + diff --git a/docs/.vitepress/theme/components/control-demo.vue b/docs/.vitepress/theme/components/control-demo.vue new file mode 100644 index 000000000..e8f8cc105 --- /dev/null +++ b/docs/.vitepress/theme/components/control-demo.vue @@ -0,0 +1,78 @@ + + + diff --git a/docs/.vitepress/theme/components/demo.vue b/docs/.vitepress/theme/components/demo.vue new file mode 100644 index 000000000..cf814110b --- /dev/null +++ b/docs/.vitepress/theme/components/demo.vue @@ -0,0 +1,411 @@ + + + + + diff --git a/docs/.vitepress/theme/components/doc-search.vue b/docs/.vitepress/theme/components/doc-search.vue new file mode 100644 index 000000000..cbf235e92 --- /dev/null +++ b/docs/.vitepress/theme/components/doc-search.vue @@ -0,0 +1,123 @@ + + + + + diff --git a/docs/.vitepress/theme/components/header-nav.vue b/docs/.vitepress/theme/components/header-nav.vue new file mode 100644 index 000000000..5493dd64e --- /dev/null +++ b/docs/.vitepress/theme/components/header-nav.vue @@ -0,0 +1,82 @@ + + + + + diff --git a/docs/.vitepress/theme/components/header-sign.vue b/docs/.vitepress/theme/components/header-sign.vue new file mode 100644 index 000000000..27e5e874a --- /dev/null +++ b/docs/.vitepress/theme/components/header-sign.vue @@ -0,0 +1,84 @@ + + + + + diff --git a/docs/.vitepress/theme/components/header-suffix.vue b/docs/.vitepress/theme/components/header-suffix.vue new file mode 100644 index 000000000..5fddc4862 --- /dev/null +++ b/docs/.vitepress/theme/components/header-suffix.vue @@ -0,0 +1,103 @@ + + + + + diff --git a/docs/views/homepage.vue b/docs/.vitepress/theme/components/homepage.vue similarity index 77% rename from docs/views/homepage.vue rename to docs/.vitepress/theme/components/homepage.vue index 744eb4551..b832da943 100644 --- a/docs/views/homepage.vue +++ b/docs/.vitepress/theme/components/homepage.vue @@ -1,9 +1,53 @@ + + - + - - 粤ICP备2020125887号-1 - - - diff --git a/docs/.vitepress/theme/components/icon-demo.vue b/docs/.vitepress/theme/components/icon-demo.vue new file mode 100644 index 000000000..825b198db --- /dev/null +++ b/docs/.vitepress/theme/components/icon-demo.vue @@ -0,0 +1,24 @@ + + + diff --git a/docs/common/icon-demo/icon-loading.vue b/docs/.vitepress/theme/components/icon-loading.vue similarity index 100% rename from docs/common/icon-demo/icon-loading.vue rename to docs/.vitepress/theme/components/icon-loading.vue diff --git a/docs/common/major-color.vue b/docs/.vitepress/theme/components/major-color.vue similarity index 96% rename from docs/common/major-color.vue rename to docs/.vitepress/theme/components/major-color.vue index cd41d4872..89041ee24 100644 --- a/docs/common/major-color.vue +++ b/docs/.vitepress/theme/components/major-color.vue @@ -1,3 +1,40 @@ + + - - diff --git a/docs/.vitepress/theme/components/page-links.vue b/docs/.vitepress/theme/components/page-links.vue new file mode 100644 index 000000000..69283989f --- /dev/null +++ b/docs/.vitepress/theme/components/page-links.vue @@ -0,0 +1,118 @@ + + + + + diff --git a/docs/common/theme-switch.vue b/docs/.vitepress/theme/components/theme-switch.vue similarity index 78% rename from docs/common/theme-switch.vue rename to docs/.vitepress/theme/components/theme-switch.vue index 393113262..fd3567404 100644 --- a/docs/common/theme-switch.vue +++ b/docs/.vitepress/theme/components/theme-switch.vue @@ -1,33 +1,25 @@ - - + + diff --git a/docs/common/component-doc.vue b/docs/common/component-doc.vue deleted file mode 100644 index 34421e5d4..000000000 --- a/docs/common/component-doc.vue +++ /dev/null @@ -1,225 +0,0 @@ - - - - - diff --git a/docs/common/container.vue b/docs/common/container.vue deleted file mode 100644 index 621c341de..000000000 --- a/docs/common/container.vue +++ /dev/null @@ -1,167 +0,0 @@ - - - - - diff --git a/docs/common/demo.vue b/docs/common/demo.vue deleted file mode 100644 index 0e6c5b736..000000000 --- a/docs/common/demo.vue +++ /dev/null @@ -1,398 +0,0 @@ - - - - - diff --git a/docs/common/footer.vue b/docs/common/footer.vue deleted file mode 100644 index 65ef5b60d..000000000 --- a/docs/common/footer.vue +++ /dev/null @@ -1,16 +0,0 @@ - - - diff --git a/docs/common/guide-doc.vue b/docs/common/guide-doc.vue deleted file mode 100644 index 28fa2ee41..000000000 --- a/docs/common/guide-doc.vue +++ /dev/null @@ -1,67 +0,0 @@ - - - - - diff --git a/docs/common/header.vue b/docs/common/header.vue deleted file mode 100644 index dfd4fa0e1..000000000 --- a/docs/common/header.vue +++ /dev/null @@ -1,405 +0,0 @@ - - - - - diff --git a/docs/common/icon-demo/icon-demo.vue b/docs/common/icon-demo/icon-demo.vue deleted file mode 100644 index cbf8bba51..000000000 --- a/docs/common/icon-demo/icon-demo.vue +++ /dev/null @@ -1,27 +0,0 @@ - - - diff --git a/docs/common/icon-demo/index.ts b/docs/common/icon-demo/index.ts deleted file mode 100644 index ce0ee2fdb..000000000 --- a/docs/common/icon-demo/index.ts +++ /dev/null @@ -1 +0,0 @@ -export { default as IconDemo } from './icon-demo.vue' diff --git a/docs/common/markdown.vue b/docs/common/markdown.vue deleted file mode 100644 index 89a405d12..000000000 --- a/docs/common/markdown.vue +++ /dev/null @@ -1,125 +0,0 @@ - - - - - diff --git a/docs/common/meta-name.ts b/docs/common/meta-name.ts deleted file mode 100644 index 589430674..000000000 --- a/docs/common/meta-name.ts +++ /dev/null @@ -1,26 +0,0 @@ -import { useRoute } from 'vue-router' - -export function getMetaName( - language: string, - meta: Record = useRoute().meta, - suffix = true -) { - language = language || __ROLLBACK_LANG__ - - let prefixMeta: string | null = null - - switch (language) { - case 'zh-CN': - prefixMeta = 'cname' - } - - if (prefixMeta && meta[prefixMeta]) { - if (suffix) { - return `${meta[prefixMeta]} ${meta.name}` - } - - return meta[prefixMeta] - } - - return (meta.name as string) ?? '' -} diff --git a/docs/demos/alert/api.en-US.md b/docs/demos/alert/api.en-US.md deleted file mode 100644 index cd2fae144..000000000 --- a/docs/demos/alert/api.en-US.md +++ /dev/null @@ -1,32 +0,0 @@ -### Alert Props - -| Name | Type | Description | Default | Since | -| ------------- | --------------------------------------------- | ------------------------------------------------------------------------------------------------------------ | -------- | ------- | -| type | `'info' \| 'success' \| 'warning' \| 'error'` | The type of warning | `'info'` | - | -| title | `string` | Set the title of the warning message, it will be invalid after using the same name slot | `''` | - | -| colorful-text | `boolean` | Set whether the font has the same color as the type | `false` | - | -| icon | `boolean \| Record` | Set whether to display the icon, you can directly pass the icon to display | `false` | - | -| closable | `boolean` | Set whether the warning can be closed | `false` | - | -| icon-color | `string` | Set the color of the alert icon | `''` | - | -| no-border | `boolean` | Set whether to disable the border of the warning prompt | `false` | - | -| banner | `boolean` | Set whether to use as the form of the top announcement, the style will be adjusted accordingly after opening | `false` | - | -| manual | `boolean` | Set to not automatically collapse when alert are closed | `false` | `2.0.0` | -| scroll | `boolean` | Set whether the content scrolls | `false` | `2.0.4` | -| scroll-speed | `number` | Set the scroll speed of the content | `1` | `2.0.4` | - -### Alert Events - -| Name | Description | Parameters | Since | -| ---------- | ----------------------------------------------------------- | ---------- | ------- | -| close | Emitted when the warning prompt is closed, no return value | - | - | -| hide | Emitted when the warning prompt disappears, no return value | - | - | -| scroll-end | Emitted every time a content scroll ends | - | `2.0.4` | - -### Alert Slots - -| Name | Description | Parameters | Since | -| ------- | -------------------------------------------- | ---------- | ----- | -| default | Content slot for warning prompt | - | - | -| title | Title content slot for warning prompt | - | - | -| icon | Icon content slot for warning prompt | - | - | -| close | Close button content slot for warning prompt | - | - | diff --git a/docs/demos/alert/api.zh-CN.md b/docs/demos/alert/api.zh-CN.md deleted file mode 100644 index be1fe7d91..000000000 --- a/docs/demos/alert/api.zh-CN.md +++ /dev/null @@ -1,32 +0,0 @@ -### Alert 属性 - -| 名称 | 类型 | 说明 | 默认值 | 始于 | -| ------------- | --------------------------------------------- | ---------------------------------------------------- | -------- | ------- | -| type | `'info' \| 'success' \| 'warning' \| 'error'` | 警告提示的类型 | `'info'` | - | -| title | `string` | 设置警告提示标题，使用同名插槽后失效 | `''` | - | -| colorful-text | `boolean` | 设置字体是否具有和类型一致的颜色 | `false` | - | -| icon | `boolean \| Record` | 设置是否显示图标，可以直接传入图标进行显示 | `false` | - | -| closable | `boolean` | 设置警告提示是否可以被关闭 | `false` | - | -| icon-color | `string` | 设置警告提示图标的颜色 | `''` | - | -| no-border | `boolean` | 设置是否禁用警告提示的边框 | `false` | - | -| banner | `boolean` | 设置是否作为顶部通告的形式，开启后样式会有相应的调整 | `false` | - | -| manual | `boolean` | 设置在关闭警告时不自动收起 | `false` | `2.0.0` | -| scroll | `boolean` | 设置警告内容是否滚动 | `false` | `2.0.4` | -| scroll-speed | `number` | 设置警告内容滚动的速度 | `1` | `2.0.4` | - -### Alert 事件 - -| 名称 | 说明 | 参数 | 始于 | -| ---------- | -------------------------------- | ---- | ------- | -| close | 当警告提示被关闭时触发，无返回值 | - | - | -| hide | 当警告提示消失时触发，无返回值 | - | - | -| scroll-end | 每当一次滚动结束后触发 | - | `2.0.4` | - -### Alert 插槽 - -| 名称 | 说明 | 参数 | 始于 | -| ------- | -------------------------- | ---- | ---- | -| default | 警告提示的内容插槽 | - | - | -| title | 警告提示的标题内容插槽 | - | - | -| icon | 警告提示的图标内容插槽 | - | - | -| close | 警告提示的关闭按钮内容插槽 | - | - | diff --git a/docs/demos/alert/basis/desc.en-US.md b/docs/demos/alert/basis/desc.en-US.md deleted file mode 100644 index fac5acbef..000000000 --- a/docs/demos/alert/basis/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Basis Usage - -Create different types of alerts by setting the `type` prop to info, success, warning, error. diff --git a/docs/demos/alert/basis/desc.zh-CN.md b/docs/demos/alert/basis/desc.zh-CN.md deleted file mode 100644 index 82c59f244..000000000 --- a/docs/demos/alert/basis/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 基础用法 - -通过设置 `type` 属性为 info、success、warning、error 以创建不同类型的警告提示。 diff --git a/docs/demos/alert/carousel/desc.en-US.md b/docs/demos/alert/carousel/desc.en-US.md deleted file mode 100644 index e9cac40cc..000000000 --- a/docs/demos/alert/carousel/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Carousel Content - -This example shows how to make a carousel content in Alert with the Carousel component. diff --git a/docs/demos/alert/carousel/desc.zh-CN.md b/docs/demos/alert/carousel/desc.zh-CN.md deleted file mode 100644 index d6ccd15b5..000000000 --- a/docs/demos/alert/carousel/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 轮播通知 - -这个示例展示了如何结合 Carousel 组件开发一个内容轮播的警告。 diff --git a/docs/demos/alert/closable/desc.en-US.md b/docs/demos/alert/closable/desc.en-US.md deleted file mode 100644 index cb0600ba4..000000000 --- a/docs/demos/alert/closable/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Closable - -Add the `closable` prop to display a close button, click the close button to close the alert. diff --git a/docs/demos/alert/closable/desc.zh-CN.md b/docs/demos/alert/closable/desc.zh-CN.md deleted file mode 100644 index 82171932a..000000000 --- a/docs/demos/alert/closable/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 可关闭 - -添加 `closable` 属性可以显示关闭按钮，点击关闭按钮可关闭警告提示。 diff --git a/docs/demos/alert/close/desc.en-US.md b/docs/demos/alert/close/desc.en-US.md deleted file mode 100644 index 329a809dc..000000000 --- a/docs/demos/alert/close/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Custom Close - -Use the `close` slot to customize the content of the close button. diff --git a/docs/demos/alert/close/desc.zh-CN.md b/docs/demos/alert/close/desc.zh-CN.md deleted file mode 100644 index b1c1c088b..000000000 --- a/docs/demos/alert/close/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 自定义关闭 - -使用 `close` 插槽可以自定义关闭按钮的内容。 diff --git a/docs/demos/alert/colorful-text/desc.en-US.md b/docs/demos/alert/colorful-text/desc.en-US.md deleted file mode 100644 index 94bcf546f..000000000 --- a/docs/demos/alert/colorful-text/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Colorful Text - -Add the `colorful-text` prop to make the alert text colored accordingly. diff --git a/docs/demos/alert/colorful-text/desc.zh-CN.md b/docs/demos/alert/colorful-text/desc.zh-CN.md deleted file mode 100644 index 3955180c6..000000000 --- a/docs/demos/alert/colorful-text/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 有色的字体 - -添加 `colorful-text` 属性可以使警告的字体带有相应的颜色。 diff --git a/docs/demos/alert/demos-meta.json b/docs/demos/alert/demos-meta.json deleted file mode 100644 index e3c5056f1..000000000 --- a/docs/demos/alert/demos-meta.json +++ /dev/null @@ -1 +0,0 @@ -["basis", "title", "closable", "close", "icon", "colorful-text", "no-border", "scroll", "carousel"] diff --git a/docs/demos/alert/desc.en-US.md b/docs/demos/alert/desc.en-US.md deleted file mode 100644 index d28538f0b..000000000 --- a/docs/demos/alert/desc.en-US.md +++ /dev/null @@ -1 +0,0 @@ -Provide a static alert, showing the content that needs attention, it will not disappear automatically, and can be closed by the user by clicking. diff --git a/docs/demos/alert/desc.zh-CN.md b/docs/demos/alert/desc.zh-CN.md deleted file mode 100644 index 20b65979c..000000000 --- a/docs/demos/alert/desc.zh-CN.md +++ /dev/null @@ -1 +0,0 @@ -提供一个静态的警告提示，展现需要关注的内容，不会自动消失，可以由用户点击关闭。 diff --git a/docs/demos/alert/icon/desc.en-US.md b/docs/demos/alert/icon/desc.en-US.md deleted file mode 100644 index 8fe84107d..000000000 --- a/docs/demos/alert/icon/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Show Icon - -Add the `icon` prop to display the icon. If you specify an icon component, the specified icon will be used. diff --git a/docs/demos/alert/icon/desc.zh-CN.md b/docs/demos/alert/icon/desc.zh-CN.md deleted file mode 100644 index c5d4bb855..000000000 --- a/docs/demos/alert/icon/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 显示图标 - -添加 `icon` 属性可以显示图标，若指定一个图标组件，则会使用指定的图标。 diff --git a/docs/demos/alert/no-border/desc.en-US.md b/docs/demos/alert/no-border/desc.en-US.md deleted file mode 100644 index 98e90b52f..000000000 --- a/docs/demos/alert/no-border/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### No Border - -Add the `no-border` prop to disable borders, making it visually lighter in some light-toned themes. diff --git a/docs/demos/alert/no-border/desc.zh-CN.md b/docs/demos/alert/no-border/desc.zh-CN.md deleted file mode 100644 index cab4fa9d3..000000000 --- a/docs/demos/alert/no-border/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 无边框 - -添加 `no-border` 属性可以禁用边框，在一些浅色调主题中可以让视觉效果更轻。 diff --git a/docs/demos/alert/scroll/desc.en-US.md b/docs/demos/alert/scroll/desc.en-US.md deleted file mode 100644 index fba48f211..000000000 --- a/docs/demos/alert/scroll/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Auto Scroll - -Adding the `scroll` prop makes the content scroll automatically, and the scroll speed can be changed with the `scroll-speed` prop. diff --git a/docs/demos/alert/scroll/desc.zh-CN.md b/docs/demos/alert/scroll/desc.zh-CN.md deleted file mode 100644 index 5d04ca67e..000000000 --- a/docs/demos/alert/scroll/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 自动滚动 - -添加 `scroll` 属性可以使内容自动滚动，同时可以通过 `scroll-speed` 属性改变滚动速度。 diff --git a/docs/demos/alert/title/desc.en-US.md b/docs/demos/alert/title/desc.en-US.md deleted file mode 100644 index b915ef9b4..000000000 --- a/docs/demos/alert/title/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### With Title - -When you need to add a brief summary to the alert, you can set the `title` prop or slot with the same name to add a title. diff --git a/docs/demos/alert/title/desc.zh-CN.md b/docs/demos/alert/title/desc.zh-CN.md deleted file mode 100644 index d329bb32b..000000000 --- a/docs/demos/alert/title/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 带标题警告 - -当需要为警告添加一个简要的概括时，可以设置 `title` 属性或同名插槽添加一个标题。 diff --git a/docs/demos/anchor/api.en-US.md b/docs/demos/anchor/api.en-US.md deleted file mode 100644 index 91a41db70..000000000 --- a/docs/demos/anchor/api.en-US.md +++ /dev/null @@ -1,49 +0,0 @@ -### Preset Types - -```ts -interface AnchorLinkOptions { - to: string, - label: string, - title?: string, - children?: AnchorLinkOptions[] -} -``` - -### Anchor Props - -| Name | Type | Description | Default | Since | -| --------------- | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------- | ------- | -| active | `string` | The currently active anchor, can use `v-model` two-way binding | `''` | - | -| viewer | `unknown` | Set the container of the anchor point. When a string is passed in, it will try to select the element as a selector. When the value is `root`, it will get the root component. When the function is passed in, the return value will be used as the element. When the correct element cannot be obtained, the parent component will be traversed upward by default, trying to find the (Native)Scroll component or the (Native)Scroll component whose with `'scroll'` ref as the container, otherwise use the component's `$el` | `null` | - | -| offset | `number` | Set the offset of the anchor scroll capture | `8` | - | -| marker | `boolean` | Set whether to use marker to mark the currently active anchor | `false` | - | -| scroll-duration | `number` | Set the scroll duration of the container when the anchor is clicked, in milliseconds | `500` | - | -| options | `AnchorLinkOptions[]` | Quickly generate anchors with options | `[]` | `2.0.0` | -| force-active | `boolean` | When enabled, will force positioning whether the selected anchor is already active | `false` | `2.0.0` | - -### Anchor Events - -| Name | Description | Parameters | Since | -| ------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------ | ----- | -| change | Emitted when the anchor point is changed, returns the currently active anchor point, or an empty string if there is no active anchor point | `(active: string)` | - | - -### Anchor Slots - -| Name | Description | Parameters | Since | -| ------- | ----------------------------------------------- | ---------- | ----- | -| default | Anchor's content slot | - | - | -| marker | Activates the content slot of the anchor marker | - | - | - -### AnchorLink Props - -| Name | Type | Description | Default | Since | -| ----- | -------- | ---------------------------------------------------------------------------- | ------- | ----- | -| to | `string` | The element id pointed to by the anchor link lock, which must start with `#` | `''` | - | -| title | `string` | The title of the anchor link, same as the native `title` attribute | `''` | - | - -### AnchorLink Slots - -| Name | Description | Parameters | Since | -| ------- | ------------------------------------- | ---------- | ----- | -| default | content slot for anchor links | - | - | -| group | Slots for child links of anchor links | - | - | diff --git a/docs/demos/anchor/api.zh-CN.md b/docs/demos/anchor/api.zh-CN.md deleted file mode 100644 index 1fb4164b2..000000000 --- a/docs/demos/anchor/api.zh-CN.md +++ /dev/null @@ -1,49 +0,0 @@ -### 预设类型 - -```ts -interface AnchorLinkOptions { - to: string, - label: string, - title?: string, - children?: AnchorLinkOptions[] -} -``` - -### Anchor 属性 - -| 名称 | 类型 | 说明 | 默认值 | 始于 | -| --------------- | --------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | ------- | -| active | `string` | 当前激活的锚点，可以使用 `v-model` 双向绑定 | `''` | - | -| viewer | `unknown` | 设置锚点的容器，当传入字符串时会尝试作为选择器选取元素，其中值为 `root` 时会获取根组件，传入函数时则会将返回值作为元素，当无法获取正确的元素时，默认会向上遍历父组件，尝试寻找 (Native)Scroll 组件或 ref 为 `'scroll'` 的 (Native)Scroll 组件作为容器，否则使用组件的 `$el` | `null` | - | -| offset | `number` | 设置锚点滚动捕获的偏移量 | `8` | - | -| marker | `boolean` | 设置是否使用 marker 标记当前激活的锚点 | `false` | - | -| scroll-duration | `number` | 设置点击锚点时，容器的滚动持续时间，单位为毫秒 | `500` | - | -| options | `AnchorLinkOptions[]` | 通过选项快速生成锚点 | `[]` | `2.0.0` | -| force-active | `boolean` | 开启后，无论选择的锚点是否已处于激活状态，仍会强制定位 | `false` | `2.0.0` | - -### Anchor 事件 - -| 名称 | 说明 | 参数 | 始于 | -| ------ | ------------------------------------------------------------------ | ------------------ | ---- | -| change | 当锚点被改变时触发，返回当前激活的锚点，若无激活锚点则返回空字符串 | `(active: string)` | - | - -### Anchor 插槽 - -| 名称 | 说明 | 参数 | 始于 | -| ------- | ---------------------- | ---- | ---- | -| default | 锚点的内容插槽 | - | - | -| marker | 激活锚点标记的内容插槽 | - | - | - -### AnchorLink 属性 - -| 名称 | 类型 | 说明 | 默认值 | 始于 | -| ----- | -------- | -------------------------------------- | ------ | ---- | -| to | `string` | 锚点链接锁指向的元素 id，需以 `#` 开头 | `''` | - | -| title | `string` | 锚点链接的标题，同原生 `title` 属性 | `''` | - | - -### AnchorLink 插槽 - -| 名称 | 说明 | 参数 | 始于 | -| ------- | ---------------------- | ---- | ---- | -| default | 锚点链接的内容插槽 | - | - | -| group | 锚点链接的子链接的插槽 | - | - | diff --git a/docs/demos/anchor/basis/desc.en-US.md b/docs/demos/anchor/basis/desc.en-US.md deleted file mode 100644 index 00348b0a4..000000000 --- a/docs/demos/anchor/basis/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Basis Usage - -For basic usage, sublinks can be added using the `group` slot. diff --git a/docs/demos/anchor/basis/desc.zh-CN.md b/docs/demos/anchor/basis/desc.zh-CN.md deleted file mode 100644 index 5513b050f..000000000 --- a/docs/demos/anchor/basis/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 基础用法 - -基础的用法，利用 `group` 插槽可以添加子链接。 diff --git a/docs/demos/anchor/demos-meta.json b/docs/demos/anchor/demos-meta.json deleted file mode 100644 index 740da925f..000000000 --- a/docs/demos/anchor/demos-meta.json +++ /dev/null @@ -1 +0,0 @@ -["basis", "marker", "example", "options"] diff --git a/docs/demos/anchor/desc.en-US.md b/docs/demos/anchor/desc.en-US.md deleted file mode 100644 index 0e79583a4..000000000 --- a/docs/demos/anchor/desc.en-US.md +++ /dev/null @@ -1 +0,0 @@ -Often used to quickly locate a certain position on the page. diff --git a/docs/demos/anchor/desc.zh-CN.md b/docs/demos/anchor/desc.zh-CN.md deleted file mode 100644 index 55571f172..000000000 --- a/docs/demos/anchor/desc.zh-CN.md +++ /dev/null @@ -1 +0,0 @@ -常用于快速定位到页面的某个位置。 diff --git a/docs/demos/anchor/example/desc.en-US.md b/docs/demos/anchor/example/desc.en-US.md deleted file mode 100644 index 1c4cf46c1..000000000 --- a/docs/demos/anchor/example/desc.en-US.md +++ /dev/null @@ -1,5 +0,0 @@ -### Example - -This is a standalone complete use case. - -It can be combined with Scroll or NativeScrolling components, of course native scrolling is also possible. diff --git a/docs/demos/anchor/example/desc.zh-CN.md b/docs/demos/anchor/example/desc.zh-CN.md deleted file mode 100644 index ac4903ec3..000000000 --- a/docs/demos/anchor/example/desc.zh-CN.md +++ /dev/null @@ -1,5 +0,0 @@ -### 完整用例 - -这是一个独立的完整用例。 - -可以与滚动或原生滚动组件结合使用，当然真·原生滚动也是可以的。 diff --git a/docs/demos/anchor/marker/desc.en-US.md b/docs/demos/anchor/marker/desc.en-US.md deleted file mode 100644 index 45a2f4d56..000000000 --- a/docs/demos/anchor/marker/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Marker - -Adding `marker` prop will mark the currently active anchor link with a marker point. diff --git a/docs/demos/anchor/marker/desc.zh-CN.md b/docs/demos/anchor/marker/desc.zh-CN.md deleted file mode 100644 index 4d24be7cb..000000000 --- a/docs/demos/anchor/marker/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 标记点 - -加 `marker` 后会使用标记点标记当前激活的锚点。 diff --git a/docs/demos/anchor/options/desc.en-US.md b/docs/demos/anchor/options/desc.en-US.md deleted file mode 100644 index 60d5e428e..000000000 --- a/docs/demos/anchor/options/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Options - -If you want to keep things simple, you can use the `options` prop to generate anchors. diff --git a/docs/demos/anchor/options/desc.zh-CN.md b/docs/demos/anchor/options/desc.zh-CN.md deleted file mode 100644 index 10dcbdb9a..000000000 --- a/docs/demos/anchor/options/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 使用选项 - -如果你想简单一些，你可以使用 `options` 属性来生成锚点。 diff --git a/docs/demos/auto-complete/api.en-US.md b/docs/demos/auto-complete/api.en-US.md deleted file mode 100644 index f383819b8..000000000 --- a/docs/demos/auto-complete/api.en-US.md +++ /dev/null @@ -1,76 +0,0 @@ -### Preset Types - -```ts -export interface AutoCompleteKeyConfig { - value?: string, - disabled?: string, - divided?: string, - noTitle?: string, - group?: string, - children?: string -} - -type AutoCompleteRawOption = string | Record - -interface AutoCompleteOptionState { - value: string | number, - disabled: boolean, - divided: boolean, - noTitle: boolean, - hidden: boolean, - hitting: boolean, - group: boolean, - depth: number, - parent: AutoCompleteOptionState | null, - data: AutoCompleteRawOption -} - -type AutoCompleteFilter = (value: string | number, options: AutoCompleteOptionState) => boolean -``` - -### AutoComplete Props - -| Name | Type | Description | Default | Since | -| -------------- | ------------------------------------------------ | ------------------------------------------------------------------------------------------- | ----------- | ------- | -| value | `string \| number` | Value of Input control | `''` | - | -| options | `AutoCompleteRawOption[]` | list of options, can be a string or object conforming to `ObjectOption` | `[]` | - | -| filter | `boolean \| AutoCompleteFilter` | The method of filtering `options`, the built-in filter method is used when `true` is passed | `false` | - | -| prefix | `Record` | The prefix icon, invalid when using prefix slot | `null` | - | -| prefix-color | `string` | The color of the prefix content, affects the prefix slot | `''` | - | -| suffix | `Record` | The suffix icon, invalid when using suffix slot | `null` | - | -| suffix-color | `string` | The color of the suffix content, which affects the suffix slot | `''` | - | -| placeholder | `string` | Input control placeholder | `null` | - | -| size | `'small' \| 'default' \| 'large'` | Set input control size | `'default'` | - | -| state | `'default' \| 'success' \| 'error' \| 'warning'` | state of the input | `'default'` | - | -| disabled | `boolean` | Set whether to disable | `false` | - | -| drop-disabled | `boolean` | whether to allow drop-down list display | `false` | - | -| placement | `Placement` | The position where the option list appears, the optional value is the same as Popper.js | `'bottom'` | - | -| clearable | `boolean` | Set whether the value can be cleared | `false` | - | -| ignore-case | `boolean` | Set whether to ignore case when using built-in filtering | `false` | - | -| key-config | `AutoCompleteKeyConfig` | Set the key names of options when parsing `options` | `{}` | `2.0.0` | -| loading | `boolean` | Set whether is loading | `false` | `2.0.0` | -| loading-icon | `Record` | Set the loading icon | `Spinner` | `2.0.0` | -| loading-lock | `boolean` | Set whether to be read-only when loading | `false` | `2.0.0` | -| loading-effect | `string` | Set the effect animation for the loading icon | `false` | `2.0.0` | -| transparent | `boolean` | Set whether to be transparent | `false` | `2.0.2` | -| locale | `LocaleConfig['input']` | Set the locale config | `null` | `2.1.0` | - -### AutoComplete Events - -| Name | Description | Parameters | Since | -| ------ | ---------------------------------------------------------------------------------- | -------------------------------------------------------- | ----- | -| input | When input is triggered in the Input control, return the current input value | `(value: string)` | - | -| toggle | Emitted when the candidate list display state changes, returns the current state | `(visible: boolean)` | - | -| change | Emitted when the value changes and the focus disappears, returns the current value | `(value: number \| string, data: AutoCompleteRawOption)` | - | -| select | Emitted when an option is used, returns the current value | `(value: number \| string, data: AutoCompleteRawOption)` | - | -| enter | Emitted when Enter is pressed, returns the current value | `(value: number \| string)` | - | -| clear | Emitted when the clear button is used to clear, no return value | - | - | - -### AutoComplete Slots - -| Name | Description | Parameters | Since | -| ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------- | ----- | -| default | The slot of the option list. Using the slot to pass in options will invalidate the built-in option filtering, key selection and other functions. These functions need to be implemented manually | - | - | -| prefix | Slot to prepend icon content | - | - | -| suffix | Slot for suffix icon content | - | - | -| control | The slot of the input control, accepts 5 parameters, which are the current value and 4 event callback methods | `(value: number \| string, onInput: (event: string \| Event) => void, onChange: () => void, onEnter: () => void, onClear: () => void)` | - | diff --git a/docs/demos/auto-complete/api.zh-CN.md b/docs/demos/auto-complete/api.zh-CN.md deleted file mode 100644 index 88836d073..000000000 --- a/docs/demos/auto-complete/api.zh-CN.md +++ /dev/null @@ -1,76 +0,0 @@ -### 预设类型 - -```ts -export interface AutoCompleteKeyConfig { - value?: string, - disabled?: string, - divided?: string, - noTitle?: string, - group?: string, - children?: string -} - -type AutoCompleteRawOption = string | Record - -interface AutoCompleteOptionState { - value: string | number, - disabled: boolean, - divided: boolean, - noTitle: boolean, - hidden: boolean, - hitting: boolean, - group: boolean, - depth: number, - parent: AutoCompleteOptionState | null, - data: AutoCompleteRawOption -} - -type AutoCompleteFilter = (value: string | number, options: AutoCompleteOptionState) => boolean -``` - -### AutoComplete 属性 - -| 名称 | 类型 | 说明 | 默认值 | 始于 | -| -------------- | ------------------------------------------------ | ------------------------------------------------------- | ----------- | ------- | -| value | `string \| number` | Input 控件的值 | `''` | - | -| options | `AutoCompleteRawOption[]` | 可选项列表，可以是字符串或者符合 `ObjectOption` 的对象 | `[]` | - | -| filter | `boolean \| AutoCompleteFilter` | 过滤 `options` 的方法，传入 `ture` 时会使用内置比较方法 | `false` | - | -| prefix | `Record` | 前缀图标，使用前缀插槽时无效 | `null` | - | -| prefix-color | `string` | 前缀内容的颜色，会影响前缀插槽 | `''` | - | -| suffix | `Record` | 后缀图标，使用后缀插槽时无效 | `null` | - | -| suffix-color | `string` | 后缀内容的颜色，会影响后缀插槽 | `''` | - | -| placeholder | `string` | Input 控件占位符 | `null` | - | -| size | `'small' \| 'default' \| 'large'` | 设置输入控件大小 | `'default'` | - | -| state | `'default' \| 'success' \| 'error' \| 'warning'` | 输入框的状态 | `'default'` | - | -| disabled | `boolean` | 设置是否禁用 | `false` | - | -| drop-disabled | `boolean` | 是否允许下拉列表显示 | `false` | - | -| placement | `Placement` | 选项列表出现的位置，可选值同 Popper.js | `'bottom'` | - | -| clearable | `boolean` | 设置是否可以清空值 | `false` | - | -| ignore-case | `boolean` | 在使用内置的过滤时，设置是否忽略大小写 | `false` | - | -| key-config | `AutoCompleteKeyConfig` | 设置选项解析 `options` 时的各项键名 | `{}` | `2.0.0` | -| loading | `boolean` | 设置是否为加载中 | `false` | `2.0.0` | -| loading-icon | `Record` | 设置加载中的图标 | `Spinner` | `2.0.0` | -| loading-lock | `boolean` | 设置在加载中时是否为只读 | `false` | `2.0.0` | -| loading-effect | `string` | 设置加载中图标的效果动画 | `false` | `2.0.0` | -| transparent | `boolean` | 设置是否为透明模式 | `false` | `2.0.2` | -| locale | `LocaleConfig['input']` | 设置多语言配置 | `null` | `2.1.0` | - -### AutoComplete 事件 - -| 名称 | 说明 | 参数 | 始于 | -| ------ | ------------------------------------------- | -------------------------------------------------------- | ---- | -| input | 当在 Input 控件中输入触发，返回当前输入的值 | `(value: string)` | - | -| toggle | 当候选列表显示状态改变时触发，返回当前状态 | `(visible: boolean)` | - | -| change | 当值改变后并焦点消失时触发，返回当前的值 | `(value: number \| string, data: AutoCompleteRawOption)` | - | -| select | 当使用选项时触发，返回当前的值 | `(value: number \| string, data: AutoCompleteRawOption)` | - | -| enter | 当按下回车时触发，返回当前的值 | `(value: number \| string)` | - | -| clear | 当使用清空按钮清空时触发，无返回值 | - | - | - -### AutoComplete 插槽 - -| 名称 | 说明 | 参数 | 始于 | -| ------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | ---- | -| default | 选项列表的插槽，使用插槽传入选项会使内置的选项过滤、按键选值等功能失效，需要手动实现这些功能 | - | - | -| prefix | 前置图标内容的插槽 | - | - | -| suffix | 后缀图标内容的插槽 | - | - | -| control | 输入控件的插槽，接受 5 个参数，分别为当前值与 4 个事件回调方法 | `(value: number \| string, onInput: (event: string \| Event) => void, onChange: () => void, onEnter: () => void, onClear: () => void)` | - | diff --git a/docs/demos/auto-complete/basis/desc.en-US.md b/docs/demos/auto-complete/basis/desc.en-US.md deleted file mode 100644 index 4e5d5a6d8..000000000 --- a/docs/demos/auto-complete/basis/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Basis Usage - -The autocomplete data source is set via the `options` prop. diff --git a/docs/demos/auto-complete/basis/desc.zh-CN.md b/docs/demos/auto-complete/basis/desc.zh-CN.md deleted file mode 100644 index 8fb5437f9..000000000 --- a/docs/demos/auto-complete/basis/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 基础用法 - -通过 `options` 属性来设置自动完成的数据源。 diff --git a/docs/demos/auto-complete/clearable/desc.en-US.md b/docs/demos/auto-complete/clearable/desc.en-US.md deleted file mode 100644 index 02539414a..000000000 --- a/docs/demos/auto-complete/clearable/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Clearable - -Add the `clearable` prop to enable clearable functionality. diff --git a/docs/demos/auto-complete/clearable/desc.zh-CN.md b/docs/demos/auto-complete/clearable/desc.zh-CN.md deleted file mode 100644 index 4146afc1f..000000000 --- a/docs/demos/auto-complete/clearable/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 可清空 - -添加 `clearable` 属性可以开启可清空功能。 diff --git a/docs/demos/auto-complete/custom-key/desc.en-US.md b/docs/demos/auto-complete/custom-key/desc.en-US.md deleted file mode 100644 index ecec7c506..000000000 --- a/docs/demos/auto-complete/custom-key/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Custom Key - -You can specify the key values of the parsing options via `key-config` prop. diff --git a/docs/demos/auto-complete/custom-key/desc.zh-CN.md b/docs/demos/auto-complete/custom-key/desc.zh-CN.md deleted file mode 100644 index 410bee708..000000000 --- a/docs/demos/auto-complete/custom-key/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 自定义键 - -通过 `key-config` 可以指定解析选项的各项键值，毕竟有时候处理选项也挺麻烦的。 diff --git a/docs/demos/auto-complete/demos-meta.json b/docs/demos/auto-complete/demos-meta.json deleted file mode 100644 index 94462c7a5..000000000 --- a/docs/demos/auto-complete/demos-meta.json +++ /dev/null @@ -1 +0,0 @@ -["basis", "clearable", "filter", "option", "custom-key", "group", "loading"] diff --git a/docs/demos/auto-complete/desc.en-US.md b/docs/demos/auto-complete/desc.en-US.md deleted file mode 100644 index dda217717..000000000 --- a/docs/demos/auto-complete/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -Provides some options to help to quick complete when inputing, also can be used as a search input. - -You may be wondering how it is different from Select with filter options feature? Just remember two key words: input and select. diff --git a/docs/demos/auto-complete/desc.zh-CN.md b/docs/demos/auto-complete/desc.zh-CN.md deleted file mode 100644 index ac70a07a4..000000000 --- a/docs/demos/auto-complete/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -在输入时提供一些选项帮助快速完成，可以当搜索框用。 - -你或许会奇怪它和带搜索功能的 Select 有何不同？只需记住两个关键词：输入和选择。 diff --git a/docs/demos/auto-complete/filter/desc.en-US.md b/docs/demos/auto-complete/filter/desc.en-US.md deleted file mode 100644 index 3a3f6c2a3..000000000 --- a/docs/demos/auto-complete/filter/desc.en-US.md +++ /dev/null @@ -1,7 +0,0 @@ -### Filter Options - -You can set the `filter` property to enable option filtering when used as a search box. - -The built-in filter method will be enabled when set to `true`, or set to function to use custom filter method. - -Add the `ignore-case` prop to make the filter to ignore case when compare. diff --git a/docs/demos/auto-complete/filter/desc.zh-CN.md b/docs/demos/auto-complete/filter/desc.zh-CN.md deleted file mode 100644 index 83cdc1c1c..000000000 --- a/docs/demos/auto-complete/filter/desc.zh-CN.md +++ /dev/null @@ -1,7 +0,0 @@ -### 过滤选项 - -用作搜索框时可以设置 `filter` 属性来开启选项过滤。 - -当设置为 `true` 时将启用内置的过滤方法，当设置为函数时可以传入一个自定义的过滤方法。 - -添加 `ignore-case` 属性可以设置过滤时忽略大小写进行比较。 diff --git a/docs/demos/auto-complete/group/desc.en-US.md b/docs/demos/auto-complete/group/desc.en-US.md deleted file mode 100644 index b7655069f..000000000 --- a/docs/demos/auto-complete/group/desc.en-US.md +++ /dev/null @@ -1,5 +0,0 @@ -### Group Options - -When passing the options, set the `group` option to `true`, and place the child options under the `children` option to achieve grouping. - -The content of the group label can be customized via the `group` slot. diff --git a/docs/demos/auto-complete/group/desc.zh-CN.md b/docs/demos/auto-complete/group/desc.zh-CN.md deleted file mode 100644 index d204c794a..000000000 --- a/docs/demos/auto-complete/group/desc.zh-CN.md +++ /dev/null @@ -1,5 +0,0 @@ -### 选项分组 - -传入选项时，设置 `group` 选项为 `true`，并将子项放在 `children` 选项下，可以实现分组。 - -通过 `group` 插槽可以自定义组标签的内容。 diff --git a/docs/demos/auto-complete/loading/desc.en-US.md b/docs/demos/auto-complete/loading/desc.en-US.md deleted file mode 100644 index 99aa6ff75..000000000 --- a/docs/demos/auto-complete/loading/desc.en-US.md +++ /dev/null @@ -1,5 +0,0 @@ -### Loading - -The loading state of the auto-complete can be controlled through the `loading` prop. - -If you want to be read-only when loading, you need to add the `loading-lock` prop. diff --git a/docs/demos/auto-complete/loading/desc.zh-CN.md b/docs/demos/auto-complete/loading/desc.zh-CN.md deleted file mode 100644 index 7e89d71f7..000000000 --- a/docs/demos/auto-complete/loading/desc.zh-CN.md +++ /dev/null @@ -1,5 +0,0 @@ -### 加载状态 - -通过 `loading` 属性可以控制自动完成组件的加载状态。 - -如果你希望在加载中时为只读，你需要添加 `loading-lock` 属性。 diff --git a/docs/demos/auto-complete/option/demo.en-US.vue b/docs/demos/auto-complete/option/demo.en-US.vue index 6f2a2e1ca..014033c98 100644 --- a/docs/demos/auto-complete/option/demo.en-US.vue +++ b/docs/demos/auto-complete/option/demo.en-US.vue @@ -2,11 +2,11 @@ diff --git a/docs/demos/auto-complete/option/demo.zh-CN.vue b/docs/demos/auto-complete/option/demo.zh-CN.vue index 6f2a2e1ca..014033c98 100644 --- a/docs/demos/auto-complete/option/demo.zh-CN.vue +++ b/docs/demos/auto-complete/option/demo.zh-CN.vue @@ -2,11 +2,11 @@ diff --git a/docs/demos/auto-complete/option/desc.en-US.md b/docs/demos/auto-complete/option/desc.en-US.md deleted file mode 100644 index 7a26875c6..000000000 --- a/docs/demos/auto-complete/option/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Custom Option - -Custom option rendering can be implemented by using the Option component as a slot. diff --git a/docs/demos/auto-complete/option/desc.zh-CN.md b/docs/demos/auto-complete/option/desc.zh-CN.md deleted file mode 100644 index 512361e20..000000000 --- a/docs/demos/auto-complete/option/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 自定义选项 - -使用 Option 组件作为插槽可以实现自定义选项。 diff --git a/docs/demos/avatar/api.en-US.md b/docs/demos/avatar/api.en-US.md deleted file mode 100644 index bbc2e7ea1..000000000 --- a/docs/demos/avatar/api.en-US.md +++ /dev/null @@ -1,51 +0,0 @@ -### Avatar Props - -| Name | Type | Description | Default | Since | -| ------------ | ---------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | ----------- | ----- | -| size | `number \| 'small' \| 'default' \| 'large'` | The size of the avatar, the size of the group is used first when it is applied to the avatar group | `'default'` | - | -| src | `string` | The source address of the avatar image | `''` | - | -| icon | `Record` | The icon object of the avatar | `null` | - | -| circle | `boolean` | Set whether the avatar is a circle | `false` | - | -| alt | `string` | Set the `alt` attribute of the avatar image | `''` | - | -| fit | `'fill' \| 'contain' \| 'cover' \| 'none' \| 'scale-down'` | Set how to fill the image of the avatar, same as `object-fit` of `css` | `'cover'` | - | -| src-set | `string` | Set the `srcset` attribute of the avatar image | `''` | - | -| gap | `number` | Set the `px` value of the left and right inner borders of the text avatar | `4` | - | -| icon-scale | `number` | Set the scaling value of the avatar icon | `1.4` | - | -| fallback-src | `string` | The fallback source address when the avatar image fails to load | `''` | - | -| color | `string` | Set the color of the icon and text of the avatar | `null` | - | -| background | `string` | Set the background color of the avatar | `null` | - | - -### Alert Events - -| Name | Description | Parameters | Since | -| ----- | ----------------------------------------------------------------- | ---------------- | ----- | -| error | Emitted when the image used fails to load, returns an error event | `(event: Event)` | - | - -### Alert Slots - -| Name | Description | Parameters | Since | -| ------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------- | ----- | -| default | The text content slot of the avatar, it is valid only when the image is not used or the image is invalid, and the icon is not used | - | - | - -### AvatarGroup Props - -| Name | Type | Description | Default | Since | -| --------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------- | ----- | -| size | `number \| 'small' \| 'default' \| 'large'` | Set the size of the avatar in the group | `'default'` | - | -| options | `Array<({ src: string } \| { icon: Record } \| { text: string }) & Record>` | avatar group options | `[]` | - | -| circle | `boolean` | The size of the avatar group, which will override the size property of the avatars in the group | `false` | - | -| max | `number` | Set the maximum number of avatars to display | `null` | - | -| show-tip | `boolean` | Set whether to show the tip bubble for the excess part | `false` | - | -| tip-trigger | `'hover' \| 'click'` | How to trigger the tip bubble | `'hover'` | - | -| vertical | `boolean` | Set whether the avatar group is arranged vertically | `false` | - | -| offset | `number` | Set the offset of the avatar in the group | `null` | - | -| rest-color | `string` | Set the icon and text color of the extra avatar | `null` | - | -| rest-background | `string` | Set the background color of the rest-background avatar | `null` | - | - -### AlertGroup Slots - -| Name | Description | Parameters | Since | -| ------- | ----------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ----- | -| default | Slot for regular display avatar | `{ option: ({ src: string } \| { icon: Record } \| { text: string }) & Record, index: number }` | - | -| rest | Slot for overshoot avatar, receiving overshoot options and the number of overshoots | `{ options: Array<({ src: string } \| { icon: Record } \| { text: string }) & Record>, count: number }` | - | -| tip | Slot for the tip bubble, receiving options for the excess and the number of excess | `{ options: Array<({ src: string } \| { icon: Record } \| { text: string } ) & Record>, count: number }` | - | diff --git a/docs/demos/avatar/api.zh-CN.md b/docs/demos/avatar/api.zh-CN.md deleted file mode 100644 index efe0009de..000000000 --- a/docs/demos/avatar/api.zh-CN.md +++ /dev/null @@ -1,51 +0,0 @@ -### Avatar 属性 - -| 名称 | 类型 | 说明 | 默认值 | 始于 | -| ------------ | ---------------------------------------------------------- | ------------------------------------------------ | ----------- | ---- | -| size | `number \| 'small' \| 'default' \| 'large'` | 头像的大小，当作用在头像组时优先使用组的大小 | `'default'` | - | -| src | `string` | 头像图片的源地址 | `''` | - | -| icon | `Record` | 头像的图标对象 | `null` | - | -| circle | `boolean` | 设置头像是否为圆形 | `false` | - | -| alt | `string` | 设置头像图片的 `alt` 属性 | `''` | - | -| fit | `'fill' \| 'contain' \| 'cover' \| 'none' \| 'scale-down'` | 设置头像的图片如何填充，同 `css` 的 `object-fit` | `'cover'` | - | -| src-set | `string` | 设置头像图片的 `srcset` 属性 | `''` | - | -| gap | `number` | 设置文字头像左右两侧内边界的 `px` 值 | `4` | - | -| icon-scale | `number` | 设置头像图标的缩放值 | `1.4` | - | -| fallback-src | `string` | 头像图片加载失败时的后备源地址 | `''` | - | -| color | `string` | 设置头像的图标和文字的颜色 | `null` | - | -| background | `string` | 设置头像的背景颜色 | `null` | - | - -### Alert 事件 - -| 名称 | 说明 | 参数 | 始于 | -| ----- | ---------------------------------------- | ---------------- | ---- | -| error | 当使用的图片加载失败时触发，返回错误事件 | `(event: Event)` | - | - -### Alert 插槽 - -| 名称 | 说明 | 参数 | 始于 | -| ------- | ---------------------------------------------------------------- | ---- | ---- | -| default | 头像的文字内容插槽，当未使用图片或图片无效、且未使用图标时才有效 | - | - | - -### AvatarGroup 属性 - -| 名称 | 类型 | 说明 | 默认值 | 始于 | -| --------------- | ----------------------------------------------------------------------------------------------------- | ---------------------------------------- | ----------- | ---- | -| size | `number \| 'small' \| 'default' \| 'large'` | 设置组内头像的大小 | `'default'` | - | -| options | `Array<({ src: string } \| { icon: Record } \| { text: string }) & Record>` | 头像组的选项 | `[]` | - | -| circle | `boolean` | 头像组的大小，会覆盖组内的头像的大小属性 | `false` | - | -| max | `number` | 设置显示头像的最大个数 | `null` | - | -| show-tip | `boolean` | 设置是否为超出部分显示提示气泡 | `false` | - | -| tip-trigger | `'hover' \| 'click'` | 提示气泡的触发方式 | `'hover'` | - | -| vertical | `boolean` | 设置头像组是否为纵向排列 | `false` | - | -| offset | `number` | 设置组内头像的偏移量 | `null` | - | -| rest-color | `string` | 设置超出部分头像的图标和文字颜色 | `null` | - | -| rest-background | `string` | 设置超出部分头像的背景颜色 | `null` | - | - -### AlertGroup 插槽 - -| 名称 | 说明 | 参数 | 始于 | -| ------- | -------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | ---- | -| default | 常规显示的头像的插槽 | `{ option: ({ src: string } \| { icon: Record } \| { text: string }) & Record, index: number }` | - | -| rest | 超出部分头像的插槽，接收超出部分的选项和超出的数目 | `{ options: Array<({ src: string } \| { icon: Record } \| { text: string }) & Record>, count: number }` | - | -| tip | 提示气泡的插槽，接收超出部分的选项和超出的数目 | `{ options: Array<({ src: string } \| { icon: Record } \| { text: string }) & Record>, count: number }` | - | diff --git a/docs/demos/avatar/badge/desc.en-US.md b/docs/demos/avatar/badge/desc.en-US.md deleted file mode 100644 index a0fe77573..000000000 --- a/docs/demos/avatar/badge/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### With Badge - -Can be combined with Badge component. diff --git a/docs/demos/avatar/badge/desc.zh-CN.md b/docs/demos/avatar/badge/desc.zh-CN.md deleted file mode 100644 index c1ece3144..000000000 --- a/docs/demos/avatar/badge/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 添加徽标 - -可以与 Badge 组件结合使用。 diff --git a/docs/demos/avatar/basis/desc.en-US.md b/docs/demos/avatar/basis/desc.en-US.md deleted file mode 100644 index e07bb8e51..000000000 --- a/docs/demos/avatar/basis/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Basis Usage - -Three sizes are built in, or you can set `size` to a specific size. diff --git a/docs/demos/avatar/basis/desc.zh-CN.md b/docs/demos/avatar/basis/desc.zh-CN.md deleted file mode 100644 index dd13d7fda..000000000 --- a/docs/demos/avatar/basis/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 基础用法 - -内置了三种大小，或者你可以设置 `size` 为具体的大小。 diff --git a/docs/demos/avatar/circle/desc.en-US.md b/docs/demos/avatar/circle/desc.en-US.md deleted file mode 100644 index b196d1f80..000000000 --- a/docs/demos/avatar/circle/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Image Avatar - -Add the `circle` prop to make the avatar circle. diff --git a/docs/demos/avatar/circle/desc.zh-CN.md b/docs/demos/avatar/circle/desc.zh-CN.md deleted file mode 100644 index bfe022618..000000000 --- a/docs/demos/avatar/circle/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 圆形头像 - -添加 `circle` 属性可以让头像变成圆形。 diff --git a/docs/demos/avatar/demos-meta.json b/docs/demos/avatar/demos-meta.json deleted file mode 100644 index 5a05f21be..000000000 --- a/docs/demos/avatar/demos-meta.json +++ /dev/null @@ -1 +0,0 @@ -["basis", "circle", "icon", "text", "badge", "error", "group", "tip", "vertical"] diff --git a/docs/demos/avatar/desc.en-US.md b/docs/demos/avatar/desc.en-US.md deleted file mode 100644 index 7570db8e2..000000000 --- a/docs/demos/avatar/desc.en-US.md +++ /dev/null @@ -1 +0,0 @@ -The primary sign of an user, which can be displayed using picture, icon or text. diff --git a/docs/demos/avatar/desc.zh-CN.md b/docs/demos/avatar/desc.zh-CN.md deleted file mode 100644 index 602c07cbc..000000000 --- a/docs/demos/avatar/desc.zh-CN.md +++ /dev/null @@ -1 +0,0 @@ -用户的首要标志，可以使用图片、图标或文字进行展示。 diff --git a/docs/demos/avatar/error/desc.en-US.md b/docs/demos/avatar/error/desc.en-US.md deleted file mode 100644 index fafdf306e..000000000 --- a/docs/demos/avatar/error/desc.en-US.md +++ /dev/null @@ -1,5 +0,0 @@ -### Fallback - -When using an image, an error event will be emiited if the image load fails. - -it will try to reload using the value as the source address if you set `fallback-src` prop. diff --git a/docs/demos/avatar/error/desc.zh-CN.md b/docs/demos/avatar/error/desc.zh-CN.md deleted file mode 100644 index d25f76173..000000000 --- a/docs/demos/avatar/error/desc.zh-CN.md +++ /dev/null @@ -1,5 +0,0 @@ -### 回退行为 - -当使用图片时，加载失败会触发事件回调。 - -如果你设置了 `fallback-src` 那会尝试使用该值作为源地址重新加载。 diff --git a/docs/demos/avatar/group/desc.en-US.md b/docs/demos/avatar/group/desc.en-US.md deleted file mode 100644 index 157ef1cd5..000000000 --- a/docs/demos/avatar/group/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Avatar Group - -Combined with the AvatarGroup component, you can flexibly create avatar groups. diff --git a/docs/demos/avatar/group/desc.zh-CN.md b/docs/demos/avatar/group/desc.zh-CN.md deleted file mode 100644 index 6cfd99d6e..000000000 --- a/docs/demos/avatar/group/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 头像组 - -结合 AvatarGroup 组件可以灵活创建头像组。 diff --git a/docs/demos/avatar/icon/desc.en-US.md b/docs/demos/avatar/icon/desc.en-US.md deleted file mode 100644 index 51d27d2a8..000000000 --- a/docs/demos/avatar/icon/desc.en-US.md +++ /dev/null @@ -1,5 +0,0 @@ -### Icon Avatar - -Pass an icon to the `icon` prop to use the icon as an avatar. - -Set the value of `icon-scale` prop to adjust the scaling of the icon. diff --git a/docs/demos/avatar/icon/desc.zh-CN.md b/docs/demos/avatar/icon/desc.zh-CN.md deleted file mode 100644 index a21107b1c..000000000 --- a/docs/demos/avatar/icon/desc.zh-CN.md +++ /dev/null @@ -1,5 +0,0 @@ -### 图标头像 - -将图标传入 `icon` 属性可以使用图标作为头像。 - -设置 `icon-scale` 的值可以调整图标的缩放比例。 diff --git a/docs/demos/avatar/text/desc.en-US.md b/docs/demos/avatar/text/desc.en-US.md deleted file mode 100644 index d39a1b358..000000000 --- a/docs/demos/avatar/text/desc.en-US.md +++ /dev/null @@ -1,5 +0,0 @@ -### Text Avatar - -Using the default slot allows using text as an avatar, and the text is automatically scaled based on the avatar size. - -You can combine the `gap` prop to set the padding on both sides of the avatar. diff --git a/docs/demos/avatar/text/desc.zh-CN.md b/docs/demos/avatar/text/desc.zh-CN.md deleted file mode 100644 index a20c1c574..000000000 --- a/docs/demos/avatar/text/desc.zh-CN.md +++ /dev/null @@ -1,5 +0,0 @@ -### 文字头像 - -使用默认插槽可以将文字作为头像，并且文字会根据头像大小自动计算缩放比例。 - -可以结合 `gap` 属性设置头像两侧的内边距。 diff --git a/docs/demos/avatar/tip/desc.en-US.md b/docs/demos/avatar/tip/desc.en-US.md deleted file mode 100644 index 26ca7c8b0..000000000 --- a/docs/demos/avatar/tip/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Custom Tip - -the content of the tip bubble can be customized via the `tip` slot when using avatar group. diff --git a/docs/demos/avatar/tip/desc.zh-CN.md b/docs/demos/avatar/tip/desc.zh-CN.md deleted file mode 100644 index f14659b62..000000000 --- a/docs/demos/avatar/tip/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 自定义提示 - -使用头像组时，通过 `tip` 插槽可以自定义提示气泡的内容。 diff --git a/docs/demos/avatar/vertical/desc.en-US.md b/docs/demos/avatar/vertical/desc.en-US.md deleted file mode 100644 index de9e381c8..000000000 --- a/docs/demos/avatar/vertical/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Vertical Group - -Add the `vertical` prop to make the avatar group vertical. diff --git a/docs/demos/avatar/vertical/desc.zh-CN.md b/docs/demos/avatar/vertical/desc.zh-CN.md deleted file mode 100644 index 3232f61e1..000000000 --- a/docs/demos/avatar/vertical/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 纵向组 - -添加 `vertical` 属性可以使头像组变成纵向的。 diff --git a/docs/demos/badge/api.en-US.md b/docs/demos/badge/api.en-US.md deleted file mode 100644 index 53d14c2f5..000000000 --- a/docs/demos/badge/api.en-US.md +++ /dev/null @@ -1,23 +0,0 @@ -### Badge Props - -| Name | Type | Description | Default | Since | -| -------- | ------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------- | --------- | ----- | -| content | `number \| string` | The content of the logo | `null` | - | -| max | `number` | When the logo is a number, you can set the maximum value, after the maximum value is exceeded, it will be displayed as `` `${max}+` `` | `0` | - | -| disabled | `boolean` | Set whether the logo is disabled, no content will be displayed when disabled | `false` | - | -| is-dot | `boolean` | Set whether the logo is a status dot | `false` | - | -| type | `'error' \| 'primary' \| 'success' \| 'warning' \| 'info' \| 'disabled'` | Set the type of logo | `'error'` | - | -| color | `string` | Set the color of the logo, can be used when the built-in type cannot meet the needs | `null` | - | - -### Badge Events - -| Name | Description | Parameters | Since | -| ----------- | ------------------------------------------------- | ---------- | ----- | -| badge-click | Emitted when the logo is clicked, no return value | - | - | - -### Badge Slots - -| Name | Description | Parameters | Since | -| ------- | --------------------------------------- | ---------- | ----- | -| default | Content slot where logo needs to be set | - | - | -| content | Content slot for logo | - | - | diff --git a/docs/demos/badge/api.zh-CN.md b/docs/demos/badge/api.zh-CN.md deleted file mode 100644 index ff5637c51..000000000 --- a/docs/demos/badge/api.zh-CN.md +++ /dev/null @@ -1,23 +0,0 @@ -### Badge 属性 - -| 名称 | 类型 | 说明 | 默认值 | 始于 | -| -------- | ------------------------------------------------------------------------ | -------------------------------------------------------------------- | --------- | ---- | -| content | `number \| string` | 徽标的内容 | `null` | - | -| max | `number` | 当徽标为数字时，可以设置最大值，超过最大值后会显示为 `` `${max}+` `` | `0` | - | -| disabled | `boolean` | 设置徽标是否禁用，禁用后将不显示任何内容 | `false` | - | -| is-dot | `boolean` | 设置徽标是否为状态点 | `false` | - | -| type | `'error' \| 'primary' \| 'success' \| 'warning' \| 'info' \| 'disabled'` | 设置徽标的类型 | `'error'` | - | -| color | `string` | 设置徽标的颜色，可以在内置类型无法满足需求时使用 | `null` | - | - -### Badge 事件 - -| 名称 | 说明 | 参数 | 始于 | -| ----------- | -------------------------- | ---- | ---- | -| badge-click | 当点击徽标时触发，无返回值 | - | - | - -### Badge 插槽 - -| 名称 | 说明 | 参数 | 始于 | -| ------- | ---------------------- | ---- | ---- | -| default | 需要设置徽标的内容插槽 | - | - | -| content | 徽标的内容插槽 | - | - | diff --git a/docs/demos/badge/basis/desc.en-US.md b/docs/demos/badge/basis/desc.en-US.md deleted file mode 100644 index 07ef9f398..000000000 --- a/docs/demos/badge/basis/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Basis Usage - -The simplest usage, add a badge to an element. diff --git a/docs/demos/badge/basis/desc.zh-CN.md b/docs/demos/badge/basis/desc.zh-CN.md deleted file mode 100644 index 4019d13d6..000000000 --- a/docs/demos/badge/basis/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 基础用法 - -最简单的用法，为一个元素添加一个徽标。 diff --git a/docs/demos/badge/demos-meta.json b/docs/demos/badge/demos-meta.json deleted file mode 100644 index b1183d709..000000000 --- a/docs/demos/badge/demos-meta.json +++ /dev/null @@ -1 +0,0 @@ -["basis", "max", "status"] diff --git a/docs/demos/badge/desc.en-US.md b/docs/demos/badge/desc.en-US.md deleted file mode 100644 index e69de29bb..000000000 diff --git a/docs/demos/badge/desc.zh-CN.md b/docs/demos/badge/desc.zh-CN.md deleted file mode 100644 index e69de29bb..000000000 diff --git a/docs/demos/badge/max/desc.en-US.md b/docs/demos/badge/max/desc.en-US.md deleted file mode 100644 index e570291a4..000000000 --- a/docs/demos/badge/max/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Max Value - -A max value can be set via the `max` prop, and it will be displayed as a plus sign when the passing value exceeds this value. diff --git a/docs/demos/badge/max/desc.zh-CN.md b/docs/demos/badge/max/desc.zh-CN.md deleted file mode 100644 index 8e29e5c1a..000000000 --- a/docs/demos/badge/max/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 最大值 - -通过 `max` 属性可以设置一个最大值，当徽标的值超过该值后会显示为加号状态。 diff --git a/docs/demos/badge/status/desc.en-US.md b/docs/demos/badge/status/desc.en-US.md deleted file mode 100644 index 1e017917f..000000000 --- a/docs/demos/badge/status/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Status Point - -Adding the `is-dot` prop and not using slot allows you to set the badge as a status dot. diff --git a/docs/demos/badge/status/desc.zh-CN.md b/docs/demos/badge/status/desc.zh-CN.md deleted file mode 100644 index 394e165b2..000000000 --- a/docs/demos/badge/status/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 状态点 - -添加 `is-dot` 属性并且不使用插槽，可以将徽标设置为状态点。 diff --git a/docs/demos/breadcrumb/api.en-US.md b/docs/demos/breadcrumb/api.en-US.md deleted file mode 100644 index e3fcb4a9c..000000000 --- a/docs/demos/breadcrumb/api.en-US.md +++ /dev/null @@ -1,50 +0,0 @@ -### Preset Types - -```ts -interface BreadcrumbOptions { - label: string, - name?: string | (() => string) -} -``` - -### Breadcrumb Props - -| Name | Type | Description | Default | Since | -| --------- | --------------------------------- | --------------------------------------------------------- | ------- | ----- | -| separator | `string` | Set the breadcrumb separator | `'/'` | - | -| border | `boolean` | Set whether to enable border mode | `false` | - | -| options | `(string \| BreadcrumbOptions)[]` | Shortcut to set child elements, invalid after using slots | `[]` | - | - -### Breadcrumb Events - -| Name | Description | Parameters | Since | -| --------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------- | ----- | -| select | Emitted when a child element is clicked, returns the element's label (index) | `(label: string \| number)` | - | -| separator-click | Emitted when the separator of a child element is clicked, returns the label (index) of the element, usually used with border mode | `(label: string \| number)` | - | - -### Breadcrumb Slots - -| Name | Description | Parameters | Since | -| --------- | --------------------------------- | --------------------------- | ----- | -| default | child elements of the breadcrumb | - | - | -| separator | Slot for custom separator content | `(label: string \| number)` | - | - -### BreadcrumbItem Props - -| Name | Type | Description | Default | Since | -| ----- | ------------------ | --------------------------------------------------------------------------- | ------- | ----- | -| label | `string \| number` | The unique label of the element, the built-in index will be used if not set | `null` | - | - -### BreadcrumbItem Events - -| Name | Description | Parameters | Since | -| --------------- | --------------------------------------------------------------------------- | --------------------------- | ----- | -| select | Emitted when an element is clicked, returns the element's label | `(label: string \| number)` | - | -| separator-click | Emitted when an element's separator is clicked, returns the element's label | `(label: string \| number)` | - | - -### BreadcrumbItem Slots - -| Name | Description | Parameters | Since | -| --------- | ------------------------------------- | ---------- | ----- | -| default | The content of the breadcrumb element | - | - | -| separator | Slot for custom separator content | - | - | diff --git a/docs/demos/breadcrumb/api.zh-CN.md b/docs/demos/breadcrumb/api.zh-CN.md deleted file mode 100644 index d2289c199..000000000 --- a/docs/demos/breadcrumb/api.zh-CN.md +++ /dev/null @@ -1,50 +0,0 @@ -### 预设类型 - -```ts -interface BreadcrumbOptions { - label: string, - name?: string | (() => string) -} -``` - -### Breadcrumb 属性 - -| 名称 | 类型 | 说明 | 默认值 | 始于 | -| --------- | --------------------------------- | ------------------------------ | ------- | ---- | -| separator | `string` | 设置面包屑的分隔符 | `'/'` | - | -| border | `boolean` | 设置是否开启 border 模式 | `false` | - | -| options | `(string \| BreadcrumbOptions)[]` | 快捷设置子元素，使用插槽后失效 | `[]` | - | - -### Breadcrumb 事件 - -| 名称 | 说明 | 参数 | 始于 | -| --------------- | ----------------------------------------------------------------------------------- | --------------------------- | ---- | -| select | 当某个子元素被点击时触发，返回该元素的标签 (索引) | `(label: string \| number)` | - | -| separator-click | 当某个子元素的分隔符被点击时触发，返回该元素的标签 (索引)，一般配合 border 模式使用 | `(label: string \| number)` | - | - -### Breadcrumb 插槽 - -| 名称 | 说明 | 参数 | 始于 | -| --------- | ---------------------- | --------------------------- | ---- | -| default | 面包屑的子元素 | - | - | -| separator | 自定义分隔符内容的插槽 | `(label: string \| number)` | - | - -### BreadcrumbItem 属性 - -| 名称 | 类型 | 说明 | 默认值 | 始于 | -| ----- | ------------------ | ---------------------------------------- | ------ | ---- | -| label | `string \| number` | 元素的唯一标签，不设置时会使用内置的索引 | `null` | - | - -### BreadcrumbItem 事件 - -| 名称 | 说明 | 参数 | 始于 | -| --------------- | -------------------------------------------- | --------------------------- | ---- | -| select | 当元素被点击时触发，返回该元素的标签 | `(label: string \| number)` | - | -| separator-click | 当元素的分隔符被点击时触发，返回该元素的标签 | `(label: string \| number)` | - | - -### BreadcrumbItem 插槽 - -| 名称 | 说明 | 参数 | 始于 | -| --------- | ---------------------- | ---- | ---- | -| default | 面包屑元素的内容 | - | - | -| separator | 自定义分隔符内容的插槽 | - | - | diff --git a/docs/demos/breadcrumb/basis/desc.en-US.md b/docs/demos/breadcrumb/basis/desc.en-US.md deleted file mode 100644 index b43bfceae..000000000 --- a/docs/demos/breadcrumb/basis/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Basis Usage - -Simplest usage. diff --git a/docs/demos/breadcrumb/basis/desc.zh-CN.md b/docs/demos/breadcrumb/basis/desc.zh-CN.md deleted file mode 100644 index 1b4570316..000000000 --- a/docs/demos/breadcrumb/basis/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 基本使用 - -最简单的用法，没什么好说的。 diff --git a/docs/demos/breadcrumb/border/desc.en-US.md b/docs/demos/breadcrumb/border/desc.en-US.md deleted file mode 100644 index beb438f11..000000000 --- a/docs/demos/breadcrumb/border/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Border Mode - -Add the `border` prop to enable border mode. diff --git a/docs/demos/breadcrumb/border/desc.zh-CN.md b/docs/demos/breadcrumb/border/desc.zh-CN.md deleted file mode 100644 index 50240234d..000000000 --- a/docs/demos/breadcrumb/border/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 边框模式 - -添加 `border` 属性可以开启边框模式。 diff --git a/docs/demos/breadcrumb/demos-meta.json b/docs/demos/breadcrumb/demos-meta.json deleted file mode 100644 index 707dda733..000000000 --- a/docs/demos/breadcrumb/demos-meta.json +++ /dev/null @@ -1 +0,0 @@ -["basis", "options", "border", "example"] diff --git a/docs/demos/breadcrumb/desc.en-US.md b/docs/demos/breadcrumb/desc.en-US.md deleted file mode 100644 index fad03c3c2..000000000 --- a/docs/demos/breadcrumb/desc.en-US.md +++ /dev/null @@ -1 +0,0 @@ -Displays the current page's position in the system hierarchy, and can go back up. diff --git a/docs/demos/breadcrumb/desc.zh-CN.md b/docs/demos/breadcrumb/desc.zh-CN.md deleted file mode 100644 index 890e8a6fa..000000000 --- a/docs/demos/breadcrumb/desc.zh-CN.md +++ /dev/null @@ -1 +0,0 @@ -显示当前页面在系统层级结构中的位置，并能向上返回。 diff --git a/docs/demos/breadcrumb/example/desc.en-US.md b/docs/demos/breadcrumb/example/desc.en-US.md deleted file mode 100644 index b72b3678f..000000000 --- a/docs/demos/breadcrumb/example/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### File Navigation - -A use case similar to the breadcrumb navigation at the top of the Windows 10 file manager. diff --git a/docs/demos/breadcrumb/example/desc.zh-CN.md b/docs/demos/breadcrumb/example/desc.zh-CN.md deleted file mode 100644 index 5111dfee7..000000000 --- a/docs/demos/breadcrumb/example/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 文件导航 - -一个类似于 Windows 10 文件管理器顶部面包屑导航的用例。 diff --git a/docs/demos/breadcrumb/options/desc.en-US.md b/docs/demos/breadcrumb/options/desc.en-US.md deleted file mode 100644 index c14dae7d9..000000000 --- a/docs/demos/breadcrumb/options/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Using Options - -Breadcrumb items can be quickly created via the `options` prop. diff --git a/docs/demos/breadcrumb/options/desc.zh-CN.md b/docs/demos/breadcrumb/options/desc.zh-CN.md deleted file mode 100644 index bbca7006b..000000000 --- a/docs/demos/breadcrumb/options/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 使用选项 - -通过 `options` 属性可以快速创建面包屑。 diff --git a/docs/demos/bubble/api.en-US.md b/docs/demos/bubble/api.en-US.md deleted file mode 100644 index 3d6c9e5ae..000000000 --- a/docs/demos/bubble/api.en-US.md +++ /dev/null @@ -1,14 +0,0 @@ -### Bubble Props - -| Name | Type | Description | Default | Since | -| ------------- | ------------------- | ------------------------------------------------------------------------------------------------- | --------- | ----- | -| placement | `Placement` | The position of the bubble box, the optional value is the same as Popper.js | `'right'` | - | -| background | `string` | The background color of the bubble | `''` | - | -| shadow | `boolean \| string` | Whether the bubble uses shadow, when passed in string, it will be used as the color of the shadow | `false` | - | -| content-class | `ClassType` | Custom class name for bubble content | `null` | - | - -### Bubble Slots - -| Name | Description | Parameters | Since | -| ------- | ---------------------------------- | ---------- | ----- | -| default | Slot for the content of the bubble | - | - | diff --git a/docs/demos/bubble/api.zh-CN.md b/docs/demos/bubble/api.zh-CN.md deleted file mode 100644 index 3b474456c..000000000 --- a/docs/demos/bubble/api.zh-CN.md +++ /dev/null @@ -1,14 +0,0 @@ -### Bubble 属性 - -| 名称 | 类型 | 说明 | 默认值 | 始于 | -| ------------- | ------------------- | ---------------------------------------------- | --------- | ---- | -| placement | `Placement` | 气泡框出现的位置，可选值同 Popper.js | `'right'` | - | -| background | `string` | 气泡的背景颜色 | `''` | - | -| shadow | `boolean \| string` | 气泡是否使用阴影，传入字符串时会作为阴影的颜色 | `false` | - | -| content-class | `ClassType` | 气泡内容的自定义类名 | `null` | - | - -### Bubble 插槽 - -| 名称 | 说明 | 参数 | 始于 | -| ------- | ---------------- | ---- | ---- | -| default | 气泡的内容的插槽 | - | - | diff --git a/docs/demos/bubble/basis/desc.en-US.md b/docs/demos/bubble/basis/desc.en-US.md deleted file mode 100644 index ac10f7dcd..000000000 --- a/docs/demos/bubble/basis/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Basis Usage - -Just put a bubble. diff --git a/docs/demos/bubble/basis/desc.zh-CN.md b/docs/demos/bubble/basis/desc.zh-CN.md deleted file mode 100644 index 844528958..000000000 --- a/docs/demos/bubble/basis/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 基础用法 - -随便放一个气泡聊天框。 diff --git a/docs/demos/bubble/demos-meta.json b/docs/demos/bubble/demos-meta.json deleted file mode 100644 index 9fa3faf68..000000000 --- a/docs/demos/bubble/demos-meta.json +++ /dev/null @@ -1 +0,0 @@ -["basis", "example"] diff --git a/docs/demos/bubble/desc.en-US.md b/docs/demos/bubble/desc.en-US.md deleted file mode 100644 index e69de29bb..000000000 diff --git a/docs/demos/bubble/desc.zh-CN.md b/docs/demos/bubble/desc.zh-CN.md deleted file mode 100644 index e69de29bb..000000000 diff --git a/docs/demos/bubble/example/desc.en-US.md b/docs/demos/bubble/example/desc.en-US.md deleted file mode 100644 index 98b5fd6f2..000000000 --- a/docs/demos/bubble/example/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### A Example - -A sad chat. diff --git a/docs/demos/bubble/example/desc.zh-CN.md b/docs/demos/bubble/example/desc.zh-CN.md deleted file mode 100644 index 4374147b2..000000000 --- a/docs/demos/bubble/example/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 一个例子 - -一个悲伤的聊天记录。 diff --git a/docs/demos/button/api.en-US.md b/docs/demos/button/api.en-US.md deleted file mode 100644 index de22a5dfe..000000000 --- a/docs/demos/button/api.en-US.md +++ /dev/null @@ -1,36 +0,0 @@ -### Button Props - -| Name | Type | Description | Default | Since | -| -------------- | ----------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | ----------- | ------- | -| type | `'default' \| 'primary' \| 'info' \| 'success' \| 'warning' \| 'error'` | Set the button type | `'default'` | - | -| simple | `boolean` | Once set, the button will change to a minimalist style in light colors | `false` | - | -| ghost | `boolean` | Once set, the button will be styled with a transparent background color | `false` | - | -| text | `boolean` | Set whether it is a text button | `false` | `2.0.0` | -| dashed | `boolean` | Set whether it is a dashed button | `false` | `2.0.0` | -| size | `'small' \| 'default' \| 'large'` | The size of the button | `'default'` | - | -| disabled | `boolean` | Set whether it is a disabled button | `false` | - | -| loading | `boolean` | Set whether it is a loading button | `false` | - | -| circle | `boolean` | Set whether it is a circular button | `false` | - | -| icon | `Record` | Auxiliary icon of the button, it will switch to the loading icon when loading | `''` | - | -| loading-icon | `Record` | Icon displayed when loading state, with pulse effect | `Spinner` | - | -| loading-effect | `string` | After set, the original pulse effect of the loading icon will be displaced and rotated | `false` | - | -| button-type | `'button' \| 'submit' \| 'reset'` | Set the type attribute of the native button | `'button'` | - | -| block | `boolean` | Whether it is a block-level element, the width becomes 100% after setting | `false` | - | -| color | `string` | Set the major color of the button | `null` | `2.0.0` | -| tag | `string` | Set button rendering tag | `'button'` | `2.0.0` | -| no-pulse | `boolean` | Set whether to disable the pulse effect after clicking | `false` | `2.0.0` | -| badge | `number \| string` | set inner badge content | `null` | `2.0.4` | - -### Button Events - -| Name | Description | Parameters | Since | -| ----- | ------------------------------------------------------------------------- | --------------------- | ----- | -| click | Emitted when the button is left clicked, returns the clicked event object | `(event: MouseEvent)` | - | - -### Button Slots - -| Name | Description | Parameters | Since | -| ------- | ---------------------------------------------------------------------- | ---------- | ------- | -| default | Content slot for button | - | - | -| icon | Slot for button prefix icon | - | `2.0.0` | -| loading | Loading icon slot, used when you need more custom loading icon effects | - | - | diff --git a/docs/demos/button/api.zh-CN.md b/docs/demos/button/api.zh-CN.md deleted file mode 100644 index aa4573811..000000000 --- a/docs/demos/button/api.zh-CN.md +++ /dev/null @@ -1,36 +0,0 @@ -### Button 属性 - -| 名称 | 类型 | 说明 | 默认值 | 始于 | -| -------------- | ----------------------------------------------------------------------- | ---------------------------------------------- | ----------- | ------- | -| type | `'default' \| 'primary' \| 'info' \| 'success' \| 'warning' \| 'error'` | 设置按钮类型 | `'default'` | - | -| simple | `boolean` | 开启后，按钮将变为浅色系的简约风格 | `false` | - | -| ghost | `boolean` | 开启后，按钮将变成背景颜色透明的样式 | `false` | - | -| text | `boolean` | 设置是否为文本按钮 | `false` | `2.0.0` | -| dashed | `boolean` | 设置是否为虚线边框按钮 | `false` | `2.0.0` | -| size | `'small' \| 'default' \| 'large'` | 按钮的大小 | `'default'` | - | -| disabled | `boolean` | 设置是否为禁用状态 设置 | `false` | - | -| loading | `boolean` | 设置是否为加载状态 设置 | `false` | - | -| circle | `boolean` | 设置是否为圆形按钮 | `false` | - | -| icon | `Record` | 按钮的辅助图标，加载状态时会切换为加载图标 | `''` | - | -| loading-icon | `Record` | 加载状态时显示的图标，具有脉冲效果 | `Spinner` | - | -| loading-effect | `string` | 开启后，加载中图标原有的脉冲效果将变位旋转效果 | `false` | - | -| button-type | `'button' \| 'submit' \| 'reset'` | 设置原生 button 的 type 属性 | `'button'` | - | -| block | `boolean` | 是否为块级元素，设置后宽度变为 `100%` | `false` | - | -| color | `string` | 设置按钮的主题色 | `null` | `2.0.0` | -| tag | `string` | 设置按钮的渲染标签 | `'button'` | `2.0.0` | -| no-pulse | `boolean` | 设置是否禁用点击后的脉冲效果 | `false` | `2.0.0` | -| badge | `number \| string` | 设置内置徽标内容 | `null` | `2.0.4` | - -### Button 事件 - -| 名称 | 说明 | 参数 | 始于 | -| ----- | --------------------------------------- | --------------------- | ---- | -| click | 左键点击按钮时触发， 返回点击的事件对象 | `(event: MouseEvent)` | - | - -### Button 插槽 - -| 名称 | 说明 | 参数 | 始于 | -| ------- | ------------------------------------------------ | ---- | ------- | -| default | 按钮的内容插槽 | - | - | -| icon | 按钮前置图标的插槽 | - | `2.0.0` | -| loading | 加载图标的插槽，需要更多定制化加载图标效果时使用 | - | - | diff --git a/docs/demos/button/badge/desc.en-US.md b/docs/demos/button/badge/desc.en-US.md deleted file mode 100644 index 8540310ff..000000000 --- a/docs/demos/button/badge/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Inner Badge - -The inner badge can be set via the `badge` prop. diff --git a/docs/demos/button/badge/desc.zh-CN.md b/docs/demos/button/badge/desc.zh-CN.md deleted file mode 100644 index f43aaefa9..000000000 --- a/docs/demos/button/badge/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 内置徽标 - -通过 `badge` 属性可以设置内置的徽标。 diff --git a/docs/demos/button/basis/desc.en-US.md b/docs/demos/button/basis/desc.en-US.md deleted file mode 100644 index 081b8e051..000000000 --- a/docs/demos/button/basis/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Button Type - -By seting the `type` prop to: `primary`, `info`, `success`, `warning` and `error` to create button with different types. diff --git a/docs/demos/button/basis/desc.zh-CN.md b/docs/demos/button/basis/desc.zh-CN.md deleted file mode 100644 index 0ae579a20..000000000 --- a/docs/demos/button/basis/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 按钮类型 - -通过设置 `type` 属性的值为 `primary`、`info`、`success`、`warning` 和 `error` 来创建不同样式的按钮，不设置时为默认样式。 diff --git a/docs/demos/button/custom/desc.en-US.md b/docs/demos/button/custom/desc.en-US.md deleted file mode 100644 index cb5a2a158..000000000 --- a/docs/demos/button/custom/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Custom Color - -You can custom the major color throught the `color` prop. diff --git a/docs/demos/button/custom/desc.zh-CN.md b/docs/demos/button/custom/desc.zh-CN.md deleted file mode 100644 index 4a1a77587..000000000 --- a/docs/demos/button/custom/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 自定义颜色 - -通过 `color` 属性可以定制化按钮的主题色。 diff --git a/docs/demos/button/dashed/desc.en-US.md b/docs/demos/button/dashed/desc.en-US.md deleted file mode 100644 index e73fbc42a..000000000 --- a/docs/demos/button/dashed/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Dashed Button - -Add the `dashed` prop can change button to dashed. diff --git a/docs/demos/button/dashed/desc.zh-CN.md b/docs/demos/button/dashed/desc.zh-CN.md deleted file mode 100644 index 97c671c43..000000000 --- a/docs/demos/button/dashed/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 虚线按钮 - -添加 `dashed` 属性可以将按钮变成虚线边框按钮。 diff --git a/docs/demos/button/demos-meta.json b/docs/demos/button/demos-meta.json deleted file mode 100644 index e741a2812..000000000 --- a/docs/demos/button/demos-meta.json +++ /dev/null @@ -1,14 +0,0 @@ -[ - "basis", - "disabled", - "simple", - "ghost", - "text", - "dashed", - "badge", - "size", - "icon", - "loading", - "custom", - "group" -] diff --git a/docs/demos/button/desc.en-US.md b/docs/demos/button/desc.en-US.md deleted file mode 100644 index 9eb579445..000000000 --- a/docs/demos/button/desc.en-US.md +++ /dev/null @@ -1 +0,0 @@ -The basic general component is used to mark a set of operation commands, which are triggered by the user's click, respond to the user and complete the corresponding business logic. diff --git a/docs/demos/button/desc.zh-CN.md b/docs/demos/button/desc.zh-CN.md deleted file mode 100644 index 0c5df7802..000000000 --- a/docs/demos/button/desc.zh-CN.md +++ /dev/null @@ -1 +0,0 @@ -基础通用组件，用于标记一组操作命令，由用户点击触发，响应用户并完成相应的业务逻辑。 diff --git a/docs/demos/button/disabled/desc.en-US.md b/docs/demos/button/disabled/desc.en-US.md deleted file mode 100644 index a4033875f..000000000 --- a/docs/demos/button/disabled/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Disabled Button - -Adding the `disabled` prop to make the button disabled. diff --git a/docs/demos/button/disabled/desc.zh-CN.md b/docs/demos/button/disabled/desc.zh-CN.md deleted file mode 100644 index d72be4204..000000000 --- a/docs/demos/button/disabled/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 禁用状态 - -添加 `disabled` 属性即可让按钮处于禁用状态。 diff --git a/docs/demos/button/ghost/desc.en-US.md b/docs/demos/button/ghost/desc.en-US.md deleted file mode 100644 index 0ba9f2258..000000000 --- a/docs/demos/button/ghost/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Ghost Button - -The ghost button turns the background transparent and is often used on colored backgrounds. diff --git a/docs/demos/button/ghost/desc.zh-CN.md b/docs/demos/button/ghost/desc.zh-CN.md deleted file mode 100644 index ffc3fa324..000000000 --- a/docs/demos/button/ghost/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 幽灵按钮 - -幽灵按钮将背景变为透明，常用在有色背景上（为啥叫幽灵按钮呢，我也不知道）。 diff --git a/docs/demos/button/group/desc.en-US.md b/docs/demos/button/group/desc.en-US.md deleted file mode 100644 index a8d1efc6c..000000000 --- a/docs/demos/button/group/desc.en-US.md +++ /dev/null @@ -1,5 +0,0 @@ -### Button Group - -Using ButtonGroup can easily combine multiple buttons, which are mostly used in a series of functional button layouts. - -The ButtonGroup size and type can be set uniformly, and you can also set the type of each Button individually. diff --git a/docs/demos/button/group/desc.zh-CN.md b/docs/demos/button/group/desc.zh-CN.md deleted file mode 100644 index 74552e00e..000000000 --- a/docs/demos/button/group/desc.zh-CN.md +++ /dev/null @@ -1,5 +0,0 @@ -### 按钮组 - -使用按钮组可以轻松组合多个按钮，多用于一系列的功能按钮排版上。 - -可以统一设置按钮组大小和类型，每个按钮的类型你也可以单独设置。 diff --git a/docs/demos/button/icon/desc.en-US.md b/docs/demos/button/icon/desc.en-US.md deleted file mode 100644 index 71e824a5a..000000000 --- a/docs/demos/button/icon/desc.en-US.md +++ /dev/null @@ -1,5 +0,0 @@ -### Add Icon - -When you need to embed an icon inside a button, you can pass the icon component directly into the `icon` prop. - -If you don't mind the trouble, you can also use the Icon component directly in the slot. diff --git a/docs/demos/button/icon/desc.zh-CN.md b/docs/demos/button/icon/desc.zh-CN.md deleted file mode 100644 index 36638b2a9..000000000 --- a/docs/demos/button/icon/desc.zh-CN.md +++ /dev/null @@ -1,5 +0,0 @@ -### 添加图标 - -当需要在按钮内嵌入图标时，可以将图标组件直接传入 `icon` 属性。 - -如果你不嫌麻烦，直接在插槽内使用 Icon 组件也可以。 diff --git a/docs/demos/button/loading/desc.en-US.md b/docs/demos/button/loading/desc.en-US.md deleted file mode 100644 index e41955e2c..000000000 --- a/docs/demos/button/loading/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Loading Button - -Adding the `loading` prop to make the button in loading. diff --git a/docs/demos/button/loading/desc.zh-CN.md b/docs/demos/button/loading/desc.zh-CN.md deleted file mode 100644 index 5cbc4a17d..000000000 --- a/docs/demos/button/loading/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 加载状态 - -添加 `loading` 属性可以让按钮处于转圈圈状态。 diff --git a/docs/demos/button/simple/desc.en-US.md b/docs/demos/button/simple/desc.en-US.md deleted file mode 100644 index 52798fb40..000000000 --- a/docs/demos/button/simple/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Simple Button - -Simple buttons use light tones and are often used on minimalist pages. diff --git a/docs/demos/button/simple/desc.zh-CN.md b/docs/demos/button/simple/desc.zh-CN.md deleted file mode 100644 index ccc87c127..000000000 --- a/docs/demos/button/simple/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 简约风格 - -简约风格的按钮使用浅色系色调，常用在简约风格页面上。 diff --git a/docs/demos/button/size/desc.en-US.md b/docs/demos/button/size/desc.en-US.md deleted file mode 100644 index dc3276521..000000000 --- a/docs/demos/button/size/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Button Size - -There are three built-in sizes, which are set by `size`. diff --git a/docs/demos/button/size/desc.zh-CN.md b/docs/demos/button/size/desc.zh-CN.md deleted file mode 100644 index c85b62e8b..000000000 --- a/docs/demos/button/size/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 按钮大小 - -内置了三种大小，通过 `size` 来设置。 diff --git a/docs/demos/button/text/desc.en-US.md b/docs/demos/button/text/desc.en-US.md deleted file mode 100644 index 5be7f747f..000000000 --- a/docs/demos/button/text/desc.en-US.md +++ /dev/null @@ -1,5 +0,0 @@ -### Text Button - -Adding the `text` prop to make the button look like normal text. - -With the `tag` prop, you can make it look like a normal link. diff --git a/docs/demos/button/text/desc.zh-CN.md b/docs/demos/button/text/desc.zh-CN.md deleted file mode 100644 index 835642480..000000000 --- a/docs/demos/button/text/desc.zh-CN.md +++ /dev/null @@ -1,5 +0,0 @@ -### 文本按钮 - -添加 `text` 属性可以让按钮看起来和普通文字无异。 - -配合 `tag` 属性，你可以让它看起来像是个普通的超链接。 diff --git a/docs/demos/calendar/api.en-US.md b/docs/demos/calendar/api.en-US.md deleted file mode 100644 index f90493f23..000000000 --- a/docs/demos/calendar/api.en-US.md +++ /dev/null @@ -1,29 +0,0 @@ -### Calendar Props - -| Name | Type | Description | Default | Since | -| ------------- | -------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------- | ------- | -| value | `number \| string \| Date` | The date currently selected, can use `v-model` two-way binding | `null` | - | -| year | `number` | Current year of calendar, can use `v-model` two-way binding | `new Date().getFullYear()` | - | -| month | `number` | Current month of calendar, the optional value is 1 ~ 12, can use `v-model` two-way binding | `new Date().getMonth() + 1` | - | -| week-days | `string[]` | The label of the week number displayed in the calendar header, an array of size 7 needs to be passed in | `null` | - | -| week-start | `number` | Set the first day of the week in the calendar, the optional value is 0 ~ 7, where 0 is Sunday | `0` | - | -| today | `number \| string \| Date` | Set today's date in the calendar | `new Date()` | - | -| disabled-date | `(data: Date) => boolean` | whether is the disabled date of the calendar, receives the current date that needs to be judged as a parameter, returns true to disable | `() => false` | - | -| locale | `LocaleConfig['calendar']` | Set the locale config | `null` | `2.1.0` | - -### Calendar Events - -| Name | Description | Parameters | Since | -| ------------ | ------------------------------------------------------------------------------------- | ------------------------------- | ------- | -| select | Emitted when the date selected in the calendar changes, returns current selected date | `(date: Date)` | - | -| year-change | Emitted when the year of the calendar is changed, returns current year and month | `(year: number, month: number)` | `2.1.4` | -| month-change | Emitted when the month of the calendar is changed, returns current year and month | `(year: number, month: number)` | `2.1.4` | - -### Calendar Slots - -| Name | Description | Parameters | Since | -| ------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ----- | -| header | The header content slot of the calendar, which will replace the entire header of the calendar when used | - | - | -| title | Calendar's title content slot | - | - | -| week | Slot for calendar week number content, `week` parameter is the week number after `week-start` is processed | `{ label: string, index: number, week: number }` | - | -| content | Calendar cell content slot | `{ selected: boolean, date: Date, isPrev: boolean, isNext: boolean, isToday: boolean, disabled: boolean }` | - | diff --git a/docs/demos/calendar/api.zh-CN.md b/docs/demos/calendar/api.zh-CN.md deleted file mode 100644 index c5114cff0..000000000 --- a/docs/demos/calendar/api.zh-CN.md +++ /dev/null @@ -1,29 +0,0 @@ -### Calendar 属性 - -| 名称 | 类型 | 说明 | 默认值 | 始于 | -| ------------- | -------------------------- | ------------------------------------------------------------------ | --------------------------- | ------- | -| value | `number \| string \| Date` | 日历当前选中的日期，可以使用 `v-model` 双向绑定 | `null` | - | -| year | `number` | 日历当前所在的年份，可以使用 `v-model` 双向绑定 | `new Date().getFullYear()` | - | -| month | `number` | 日历当前所在的月份，可选值为 1 ~ 12，可以使用 `v-model` 双向绑定 | `new Date().getMonth() + 1` | - | -| week-days | `string[]` | 日历头部的星期数显示的标签，需传入一个大小为 7 的数组 | `null` | - | -| week-start | `number` | 设置日历每星期的第一天，可选值为 0 ~ 7，其中 0 为星期天 | `0` | - | -| today | `number \| string \| Date` | 设置日历的今天日期 | `new Date()` | - | -| disabled-date | `(data: Date) => boolean` | 是日历的禁用日期，接收当前需要判断的日期作为参数，返回 true 则禁用 | `() => false` | - | -| locale | `LocaleConfig['calendar']` | 设置多语言配置 | `null` | `2.1.0` | - -### Calendar 事件 - -| 名称 | 说明 | 参数 | 始于 | -| ------------ | ---------------------------------------------- | ------------------------------- | ------- | -| select | 在日历选中的日期变化时触发，返回当前选中的日期 | `(date: Date)` | - | -| year-change | 修改日历的年份时触发，返回当前的年月 | `(year: number, month: number)` | `2.1.4` | -| month-change | 修改日历的月份时触发，返回当前的年月 | `(year: number, month: number)` | `2.1.4` | - -### Calendar 插槽 - -| 名称 | 说明 | 参数 | 始于 | -| ------- | ----------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---- | -| header | 日历的头部内容插槽，使用后将替换日历的整个头部 | - | - | -| title | 日历的标题内容插槽 | - | - | -| week | 日历星期数内容的插槽，`week` 参数为处理了 `week-start` 后的星期数 | `{ label: string, index: number, week: number }` | - | -| content | 日历单元格内容插槽 | `{ selected: boolean, date: Date, isPrev: boolean, isNext: boolean, isToday: boolean, disabled: boolean }` | - | diff --git a/docs/demos/calendar/basis/desc.en-US.md b/docs/demos/calendar/basis/desc.en-US.md deleted file mode 100644 index 992b7fc71..000000000 --- a/docs/demos/calendar/basis/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Basis Usage - -The simplest usage, a pure calendar. diff --git a/docs/demos/calendar/basis/desc.zh-CN.md b/docs/demos/calendar/basis/desc.zh-CN.md deleted file mode 100644 index 7ae04fc63..000000000 --- a/docs/demos/calendar/basis/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 基础用法 - -最简单的用法，纯净版日历。 diff --git a/docs/demos/calendar/demos-meta.json b/docs/demos/calendar/demos-meta.json deleted file mode 100644 index 8b8c5468a..000000000 --- a/docs/demos/calendar/demos-meta.json +++ /dev/null @@ -1 +0,0 @@ -["basis", "week-start", "schedule"] diff --git a/docs/demos/calendar/desc.en-US.md b/docs/demos/calendar/desc.en-US.md deleted file mode 100644 index 16de38d59..000000000 --- a/docs/demos/calendar/desc.en-US.md +++ /dev/null @@ -1 +0,0 @@ -A container that displays data in the form of a calendar. It is generally used in occasions where data is divided by date, such as schedules, class schedules and so on. diff --git a/docs/demos/calendar/desc.zh-CN.md b/docs/demos/calendar/desc.zh-CN.md deleted file mode 100644 index e18995205..000000000 --- a/docs/demos/calendar/desc.zh-CN.md +++ /dev/null @@ -1 +0,0 @@ -将数据按照日历的形式展示的容器，一般用于数据按日期划分的场合，例如日程表、课表等等。 diff --git a/docs/demos/calendar/schedule/desc.en-US.md b/docs/demos/calendar/schedule/desc.en-US.md deleted file mode 100644 index 4735bff2b..000000000 --- a/docs/demos/calendar/schedule/desc.en-US.md +++ /dev/null @@ -1,5 +0,0 @@ -### Schedule - -The content of the rendered calendar cell can be customized via the `content` slot. - -If you think the native scroll bar is not cool, you can add a scroll component by yourself. diff --git a/docs/demos/calendar/schedule/desc.zh-CN.md b/docs/demos/calendar/schedule/desc.zh-CN.md deleted file mode 100644 index 77f98e006..000000000 --- a/docs/demos/calendar/schedule/desc.zh-CN.md +++ /dev/null @@ -1,5 +0,0 @@ -### 日程表 - -通过 `content` 插槽可以自定义渲染日历单元格的内容。 - -如果你觉得原生的滚动条不够酷，你可以自行添加一个滚动组件进去。 diff --git a/docs/demos/calendar/week-start/desc.en-US.md b/docs/demos/calendar/week-start/desc.en-US.md deleted file mode 100644 index f3869a383..000000000 --- a/docs/demos/calendar/week-start/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Week Start - -The first day of the week can be changed via the `week-start` prop. diff --git a/docs/demos/calendar/week-start/desc.zh-CN.md b/docs/demos/calendar/week-start/desc.zh-CN.md deleted file mode 100644 index ed85075b0..000000000 --- a/docs/demos/calendar/week-start/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 每周开始 - -设置 `week-start` 属性的值可以修改每周开始的第一天。 diff --git a/docs/demos/card/api.en-US.md b/docs/demos/card/api.en-US.md deleted file mode 100644 index 5912450e4..000000000 --- a/docs/demos/card/api.en-US.md +++ /dev/null @@ -1,15 +0,0 @@ -### Card Props - -| Name | Type | Description | Default | Since | -| ------------- | -------------------------------- | ------------------------------------------------ | ---------- | ----- | -| title | `string` | The title of the card, invalid when using a slot | `''` | - | -| shadow | `'always' \| 'hover' \| 'never'` | Set the shadow mode of the card | `'always'` | - | -| content-style | `Record` | Custom style for card content | `{}` | - | - -### Card Slots - -| Name | Description | Parameters | Since | -| ------- | ------------------------- | ---------- | ----- | -| default | Slot for card content | - | - | -| title | Slot for card title | - | - | -| extra | Slots for card expansions | - | - | diff --git a/docs/demos/card/api.zh-CN.md b/docs/demos/card/api.zh-CN.md deleted file mode 100644 index b9f725c76..000000000 --- a/docs/demos/card/api.zh-CN.md +++ /dev/null @@ -1,15 +0,0 @@ -### Card 属性 - -| 名称 | 类型 | 说明 | 默认值 | 始于 | -| ------------- | -------------------------------- | ---------------------------- | ---------- | ---- | -| title | `string` | 卡片的标题，当使用插槽时无效 | `''` | - | -| shadow | `'always' \| 'hover' \| 'never'` | 设置卡片的阴影模式 | `'always'` | - | -| content-style | `Record` | 卡片内容的自定义样式 | `{}` | - | - -### Card 插槽 - -| 名称 | 说明 | 参数 | 始于 | -| ------- | ------------------ | ---- | ---- | -| default | 卡片内容的插槽 | - | - | -| title | 卡片标题的插槽 | - | - | -| extra | 卡片拓展内容的插槽 | - | - | diff --git a/docs/demos/card/basis/desc.en-US.md b/docs/demos/card/basis/desc.en-US.md deleted file mode 100644 index 9be9865a2..000000000 --- a/docs/demos/card/basis/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Basis Usage - -A little card with title and content. diff --git a/docs/demos/card/basis/desc.zh-CN.md b/docs/demos/card/basis/desc.zh-CN.md deleted file mode 100644 index 6ca236903..000000000 --- a/docs/demos/card/basis/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 基础用法 - -包含标题和内容的小卡片。 diff --git a/docs/demos/card/demos-meta.json b/docs/demos/card/demos-meta.json deleted file mode 100644 index 5500e3f3b..000000000 --- a/docs/demos/card/demos-meta.json +++ /dev/null @@ -1 +0,0 @@ -["basis", "extra", "shadow"] diff --git a/docs/demos/card/desc.en-US.md b/docs/demos/card/desc.en-US.md deleted file mode 100644 index 0c80c5a86..000000000 --- a/docs/demos/card/desc.en-US.md +++ /dev/null @@ -1 +0,0 @@ -A basic container that can carry content such as text, lists, pictures, paragraphs, etc. It is often used for a group of content that needs to be browsed centrally. diff --git a/docs/demos/card/desc.zh-CN.md b/docs/demos/card/desc.zh-CN.md deleted file mode 100644 index 1c9ff6e05..000000000 --- a/docs/demos/card/desc.zh-CN.md +++ /dev/null @@ -1 +0,0 @@ -基础的容器，可承载文字、列表、图片、段落等内容，常用于需要集中浏览的一组内容。 diff --git a/docs/demos/card/extra/desc.en-US.md b/docs/demos/card/extra/desc.en-US.md deleted file mode 100644 index 2d5269b67..000000000 --- a/docs/demos/card/extra/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Extra Content - -Adding an `extra` slot allows you to add top-right custom content, typically used to add action buttons. diff --git a/docs/demos/card/extra/desc.zh-CN.md b/docs/demos/card/extra/desc.zh-CN.md deleted file mode 100644 index b79bbe78e..000000000 --- a/docs/demos/card/extra/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 拓展内容 - -添加 `extra` 插槽可以添加右上角自定义内容，通常用于添加操作按钮。 diff --git a/docs/demos/card/shadow/desc.en-US.md b/docs/demos/card/shadow/desc.en-US.md deleted file mode 100644 index 220ab7563..000000000 --- a/docs/demos/card/shadow/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Shadow Mode - -Set the value of the `shadow` prop to adjust the shadow mode of the card. diff --git a/docs/demos/card/shadow/desc.zh-CN.md b/docs/demos/card/shadow/desc.zh-CN.md deleted file mode 100644 index e119a97ce..000000000 --- a/docs/demos/card/shadow/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 阴影模式 - -设置 `shadow` 属性的值可以调整卡片的阴影模式。 diff --git a/docs/demos/carousel/active/desc.en-US.md b/docs/demos/carousel/active/desc.en-US.md deleted file mode 100644 index 8026cd87b..000000000 --- a/docs/demos/carousel/active/desc.en-US.md +++ /dev/null @@ -1,5 +0,0 @@ -### Active Element - -The default slot of the Item component can obtain whether the current element handles the active state through the `active` prop. - -Use this prop to easily add custom styles to active and inactive elements. diff --git a/docs/demos/carousel/active/desc.zh-CN.md b/docs/demos/carousel/active/desc.zh-CN.md deleted file mode 100644 index ba354874b..000000000 --- a/docs/demos/carousel/active/desc.zh-CN.md +++ /dev/null @@ -1,5 +0,0 @@ -### 聚焦元素 - -Item 组件默认插槽可以通过 `active` 属性获取当前元素是否处理激活状态。 - -使用该属性可以轻松地对激活与非激活的元素添加定制化样式。 diff --git a/docs/demos/carousel/album/desc.en-US.md b/docs/demos/carousel/album/desc.en-US.md deleted file mode 100644 index 067ae29b7..000000000 --- a/docs/demos/carousel/album/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Album Example - -Using the carousel component combined with some simple elements can achieve effects similar to photo albums and picture viewers (two-dimensional concentration detection). diff --git a/docs/demos/carousel/album/desc.zh-CN.md b/docs/demos/carousel/album/desc.zh-CN.md deleted file mode 100644 index bf8d7d31e..000000000 --- a/docs/demos/carousel/album/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 相册用例 - -使用轮播组件结合一些简单的元素即可实现类似相册、图片查看器的效果（二次元浓度检测）。 diff --git a/docs/demos/carousel/api.en-US.md b/docs/demos/carousel/api.en-US.md deleted file mode 100644 index ea435cee1..000000000 --- a/docs/demos/carousel/api.en-US.md +++ /dev/null @@ -1,41 +0,0 @@ -### Carousel Props - -| Name | Type | Description | Default | Since | -| ------------- | --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ----------- | ------- | -| active | `number` | The currently active element, can use `v-model` two-way binding | `0` | - | -| view-size | `number` | The number of items that can fit in the viewport | `3` | - | -| vertical | `boolean` | Set whether to enable vertical rotation mode | `false` | - | -| disabled | `boolean` | Set whether is disabled | `false` | - | -| loop | `boolean` | Whether to enable loop mode | `false` | - | -| arrow | `'outside' \| 'inside' \| 'none'` | Set how the arrow is displayed | `'outside'` | - | -| arrow-trigger | `'hover' \| 'always'` | The trigger mode of arrow display, optional values ​​are `hover`, `always`, only valid when the arrow type is `inside` | `'hover'` | - | -| autoplay | `boolean \| number` | Set the carousel to play automatically, the interval in milliseconds can be set when the value is passed in, the minimum valid value is 300 | `false` | - | -| pointer | `'outside' \| 'inside' \| 'none'` | How to display the pointer, optional values ​​are `outside`, `inside`, `none` | `'none'` | - | -| speed | `number` | The speed at which the element toggles the transition effect | `300` | - | -| active-offset | `number` | The offset to mark the activation of the item, when it is 0, the first element of the default window is active | `0` | - | -| height | `number \| string` | In `vertical` mode, the height can be set | `null` | - | -| ignore-hover | `boolean` | Whether to ignore mouse enter when `autoplay` is enabled | `false` | `2.0.3` | - -### Carousel Events - -| Name | Description | Parameters | Since | -| ------ | ---------------------------------------------------------------------------------------------------------- | ------------------ | ----- | -| change | Emitted when the active item changes, returns the index of the active element | `(active: number)` | - | -| prev | Emitted when the forward arrow is clicked to switch elements, returns the index of the active element | `(active: number)` | - | -| next | Emitted when the back arrow or autoplay toggle element is clicked, returns the index of the active element | `(active: number)` | - | -| select | Emitted when an element is clicked, returns the index of the clicked element | `(active: number)` | - | - -### Carousel Slots - -| Name | Description | Parameters | Since | -| ---------- | ---------------------------------------------------------------------------------------------------------------- | ----------------------- | ----- | -| default | Content slot for carousel | - | - | -| prev-arrow | The content slot of the forward scroll button, accepts a `disabled` parameter to identify whether it is disabled | `{ disabled: boolean }` | - | -| next-arrow | The content slot of the back scroll button, accepts a `disabled` parameter to identify whether it is disabled | `{ disabled: boolean }` | - | -| pointer | The content slot of the carousel marker, accepts an `active` parameter indicating whether it is active | `{ active: boolean }` | - | - -### CarouselItem Slots - -| Name | Description | Parameters | Since | -| ------- | -------------------------------------------------------------------------------------------------------- | --------------------- | ----- | -| default | The content slot of the carousel element, accepts an `active` parameter to indicate whether it is active | `{ active: boolean }` | - | diff --git a/docs/demos/carousel/api.zh-CN.md b/docs/demos/carousel/api.zh-CN.md deleted file mode 100644 index 08a376492..000000000 --- a/docs/demos/carousel/api.zh-CN.md +++ /dev/null @@ -1,41 +0,0 @@ -### Carousel 属性 - -| 名称 | 类型 | 说明 | 默认值 | 始于 | -| ------------- | --------------------------------- | ------------------------------------------------------------------------------ | ----------- | ------- | -| active | `number` | 当前激活的元素，可以使用 `v-model` 双向绑定 | `0` | - | -| view-size | `number` | 视窗中可容纳的 item 数 | `3` | - | -| vertical | `boolean` | 设置是否开启纵向轮播模式 | `false` | - | -| disabled | `boolean` | 是否为禁用状态 | `false` | - | -| loop | `boolean` | 是否开启循环轮播模式 | `false` | - | -| arrow | `'outside' \| 'inside' \| 'none'` | 箭头显示的方式 | `'outside'` | - | -| arrow-trigger | `'hover' \| 'always'` | 箭头显示的触发方式，可选值为 `hover`、`always`，仅当箭头类型为 `inside` 时有效 | `'hover'` | - | -| autoplay | `boolean \| number` | 设置轮播自动播放，传入数值时可以设置间隔毫秒数，最低有效值为 300 | `false` | - | -| pointer | `'outside' \| 'inside' \| 'none'` | 指示器显示的方式，可选值为 `outside`、`inside`、`none` | `'none'` | - | -| speed | `number` | 元素切换过渡效果的速度 | `300` | - | -| active-offset | `number` | 标记 item 激活的偏移量，为 0 时默认视窗第一个元素为激活状态 | `0` | - | -| height | `number \| string` | 在 `vertical` 模式下，可以设置高度 | `null` | - | -| ignore-hover | `boolean` | 开启自动轮播后是否忽略鼠标移入 | `false` | `2.0.3` | - -### Carousel 事件 - -| 名称 | 说明 | 参数 | 始于 | -| ------ | ------------------------------------------------------------ | ------------------ | ---- | -| change | 激活的 item 改变时触发，返回激活的元素的索引 | `(active: number)` | - | -| prev | 当点击向前箭头切换元素时触发，返回激活的元素的索引 | `(active: number)` | - | -| next | 当点击向后箭头或自动播放切换元素时触发，返回激活的元素的索引 | `(active: number)` | - | -| select | 当点击了元素时触发，返回点击的元素的索引 | `(active: number)` | - | - -### Carousel 插槽 - -| 名称 | 说明 | 参数 | 始于 | -| ---------- | ------------------------------------------------------------------ | --------------------- | ---- | -| default | 轮播的内容插槽 | - | - | -| prev-arrow | 向前滚动按钮的内容插槽，接受一个 `disabled` 参数标识是否为禁用状态 | `(disabled: boolean)` | - | -| next-arrow | 向后滚动按钮的内容插槽，接受一个 `disabled` 参数标识是否为禁用状态 | `(disabled: boolean)` | - | -| pointer | 轮播标记点的内容插槽，接受一个 `active` 参数标识是否为激活状态 | `(active: boolean)` | - | - -### CarouselItem 插槽 - -| 名称 | 说明 | 参数 | 始于 | -| ------- | ------------------------------------------------------------ | ------------------- | ---- | -| default | 轮播元素的内容插槽，接受一个 `active` 参数标识是否为激活状态 | `(active: boolean)` | - | diff --git a/docs/demos/carousel/autoplay/desc.en-US.md b/docs/demos/carousel/autoplay/desc.en-US.md deleted file mode 100644 index 803ad9498..000000000 --- a/docs/demos/carousel/autoplay/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Autoplay - -Add the `autoplay` prop to enable autoplay, returning to the first element when the last element is reached. diff --git a/docs/demos/carousel/autoplay/desc.zh-CN.md b/docs/demos/carousel/autoplay/desc.zh-CN.md deleted file mode 100644 index b670d6a44..000000000 --- a/docs/demos/carousel/autoplay/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 自动播放 - -添加 `autoplay` 属性可以开启自动播放，到最后一个元素时会回到第一个元素。 diff --git a/docs/demos/carousel/basis/desc.en-US.md b/docs/demos/carousel/basis/desc.en-US.md deleted file mode 100644 index 423109906..000000000 --- a/docs/demos/carousel/basis/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Basis Usage - -The default viewable area is 3 elements, which can be adjusted by setting the `view-size` property. diff --git a/docs/demos/carousel/basis/desc.zh-CN.md b/docs/demos/carousel/basis/desc.zh-CN.md deleted file mode 100644 index 39e02a9c2..000000000 --- a/docs/demos/carousel/basis/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 基础用法 - -默认的可视区域为 3 个元素，可以设置 `view-size` 属性进行调整。 diff --git a/docs/demos/carousel/demos-meta.json b/docs/demos/carousel/demos-meta.json deleted file mode 100644 index 3ff339fde..000000000 --- a/docs/demos/carousel/demos-meta.json +++ /dev/null @@ -1 +0,0 @@ -["basis", "autoplay", "loop", "active", "lantern", "vertical", "album"] diff --git a/docs/demos/carousel/desc.en-US.md b/docs/demos/carousel/desc.en-US.md deleted file mode 100644 index 915e2f7f0..000000000 --- a/docs/demos/carousel/desc.en-US.md +++ /dev/null @@ -1 +0,0 @@ -The carousel component can quickly build a carousel area, which is often used for flexible display of a set of horizontal content. diff --git a/docs/demos/carousel/desc.zh-CN.md b/docs/demos/carousel/desc.zh-CN.md deleted file mode 100644 index b12bb12e4..000000000 --- a/docs/demos/carousel/desc.zh-CN.md +++ /dev/null @@ -1 +0,0 @@ -轮播组件可以快速构建一个轮播的区域，常用与一组平级内容的灵活展示。 diff --git a/docs/demos/carousel/lantern/desc.en-US.md b/docs/demos/carousel/lantern/desc.en-US.md deleted file mode 100644 index 12ec569ff..000000000 --- a/docs/demos/carousel/lantern/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Lantern - -After setting the `view-size` prop to 1, a lantern effect can be formed. diff --git a/docs/demos/carousel/lantern/desc.zh-CN.md b/docs/demos/carousel/lantern/desc.zh-CN.md deleted file mode 100644 index 9b59fff39..000000000 --- a/docs/demos/carousel/lantern/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 走马灯 - -设置 `view-size` 属性为 1 后可以形成走马灯效果。 diff --git a/docs/demos/carousel/loop/desc.en-US.md b/docs/demos/carousel/loop/desc.en-US.md deleted file mode 100644 index 43b105904..000000000 --- a/docs/demos/carousel/loop/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Loop Carousel - -Adding the `loop` prop turns on a looping carousel, where the last element joins the first element, and vice versa. diff --git a/docs/demos/carousel/loop/desc.zh-CN.md b/docs/demos/carousel/loop/desc.zh-CN.md deleted file mode 100644 index a339d41a5..000000000 --- a/docs/demos/carousel/loop/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 循环轮播 - -添加 `loop` 属性可以开启循环轮播，到最后一个元素时会衔接第一个元素，反之亦然。 diff --git a/docs/demos/carousel/vertical/desc.en-US.md b/docs/demos/carousel/vertical/desc.en-US.md deleted file mode 100644 index 862e38b28..000000000 --- a/docs/demos/carousel/vertical/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Vertical Carousel - -The carousel can be vertical by adding the `vertical` prop. diff --git a/docs/demos/carousel/vertical/desc.zh-CN.md b/docs/demos/carousel/vertical/desc.zh-CN.md deleted file mode 100644 index 777eec728..000000000 --- a/docs/demos/carousel/vertical/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 纵向轮播 - -通过添加 `vertical` 属性可以使轮播变为纵向。 diff --git a/docs/demos/cascader/api.en-US.md b/docs/demos/cascader/api.en-US.md deleted file mode 100644 index 95e0984f9..000000000 --- a/docs/demos/cascader/api.en-US.md +++ /dev/null @@ -1,97 +0,0 @@ -### Preset Types - -```ts -type Data = Record -type CascaderValue = (string | number)[] | (string | number)[][] - -interface CascaderKeyConfig { - value?: string, - label?: string, - children?: string, - disabled?: string, - hasChild?: string -} - -interface CascaderOptionState { - id: number, - parent: number, - value: string | number, - fullValue: string, - label: string, - fullLabel: string, - children: CascaderOptionState[], - disabled: boolean, - hasChild: boolean, - checked: boolean, - partial: boolean, - loading: boolean, - loaded: boolean, - error: boolean, - childrenLoaded: boolean, - data: Data -} -``` - -### Cascader Props - -| Name | Type | Description | Default | Since | -| --------------- | ------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------- | ------- | -| size | `'small' \| 'default' \| 'large'` | size of cascade selector | `'default'` | - | -| state | `'default' \| 'success' \| 'error' \| 'warning'` | state of cascade selector | `'default'` | - | -| prefix | `Record` | prefix icon, invalid when using prefix slot | `null` | - | -| prefix-color | `string` | The color of the prefix content, affects the prefix slot | `''` | - | -| suffix | `Record` | suffix icon, invalid when using suffix slot | `null` | - | -| suffix-color | `string` | The color of the suffix content, which affects the suffix slot | `''` | - | -| no-suffix | `boolean` | Set whether to disable suffix icon | `false` | - | -| static-suffix | `boolean` | Set whether the suffix icon is static | `false` | - | -| visible | `boolean` | Set whether the option list is visible, you can use `v-model` two-way binding | `false` | - | -| options | `Data[]` | Set options for cascade selector | `[]` | - | -| value | `CascaderValue` | Cascading selector value, can use `v-model` two-way binding | `null` | - | -| disabled | `boolean` | set whether to disable cascade selector | `false` | - | -| multiple | `boolean` | Set whether to enable multiple selection mode | `false` | - | -| no-cascaded | `boolean` | Set whether to disassociate parent and child options, after disassociation, parent options can be selected separately | `false` | - | -| key-config | `CascaderKeyConfig` | Configure key names when parsing `options` | `{}` | - | -| separator | `string` | Set the connector of option value and label, the length is `1`, note that it will be used to build the full path of the option value internally | `/` | - | -| hover-trigger | `boolean` | Set whether to enable the mouse hover to trigger the expansion of the lower panel, invalid after enabling asynchronous loading | `false` | - | -| max-tag-count | `number` | In multi-select mode, set the maximum number of tags to display, when it is `0`, it will be dynamically calculated to ensure that it is displayed in one line | `0` | - | -| brief-label | `boolean` | Set whether to display the short label value | `false` | - | -| no-rest-tip | `boolean` | Set whether to disable the bubble tip for extra tabs | `false` | - | -| on-async-load | `(data: Data) => any[] \| Promise` | Set the callback function for asynchronous loading, after setting it will start asynchronous loading | `null` | - | -| merge-tags | `boolean` | In multi-select mode, set whether to display the parent option when all child options are selected, and enable it in asynchronous loading will change the way of passing values ​​ | `false` | - | -| tag-type | `TagType` | Set the type of label in multi-select mode | `null` | - | -| outside-close | `boolean` | Set whether to close the component by clicking outside | `false` | - | -| placeholder | `string` | same as native `palceholder` | `''` | - | -| clearable | `boolean` | Set whether the value can be cleared | `false` | - | -| transition-name | `string` | transition animation for options list | `'vxp-drop'` | - | -| placement | `Placement` | The placement of the option list, the optional value is the same as Popper.js | `'bottom-start'` | - | -| transfer | `boolean \| string` | Set the rendering position of the option list. When set to `true`, it will render to `` by default | `false` | - | -| empty-text | `string` | Prompt for empty options | `locale.empty` | - | -| loading | `boolean` | Set whether is loading | `false` | - | -| loading-icon | `Record` | Set the loading icon | `Spinner` | - | -| loading-lock | `boolean` | Set whether to be read-only when loading | `false` | - | -| loading-effect | `string` | Set the effect animation for the loading icon | `false` | `2.1.0` | -| transparent | `boolean` | Set whether to be transparent | `false` | `2.0.2` | -| locale | `LocaleConfig['select']` | Set the locale config | `null` | `2.1.0` | - -### Cascader Events - -| Name | Description | Parameters | Since | -| ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------- | ----- | -| toggle | Emitted when the option list display state changes, returns the current state | `(visible: boolean)` | - | -| select | Emitted when an option is selected, returns the value path and option data of the selected option | `(value: (string \| number)[], data: Data)` | - | -| cancel | Emitted when the option is canceled, only in multi-select mode, returns the value path and option data of the canceled option | `(value: (string \| number)[], data: Data)` | - | -| change | Emitted when the selected value changes, returns the value path and option data of the option, the value path array and option data array in multi-select mode | `(value: CascaderValue, data: Data[] \| Data[][])` | - | -| click-outside | Emitted when clicking outside the cascade selector, no return value | - | - | -| outside-close | Emitted when the option list is closed by clicking outside, no return value | - | - | -| clear | Emitted when the value is cleared by the clear button, no return value | - | - | - -### Cascader Slots - -| Name | Description | Parameters | Since | -| ------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | ----- | -| default | Slot for option content, where `hasChild` provided by parameter is the result of internal calculation | `{ option: CascaderOptionState, index: number, selected: boolean, canCheck: boolean, hasChild: boolean }` | - | -| label | Slot for option label value, where `hasChild` provided by parameter is the result of internal calculation | `{ option: CascaderOptionState, index: number, selected: boolean, canCheck: boolean, hasChild: boolean }` | - | -| prefix | Slot to prepend icon content | - | - | -| control | Slot for selector main control content | - | - | -| suffix | Slot for suffix icon content | - | - | -| empty | Slot for empty option prompt content | - | - | diff --git a/docs/demos/cascader/api.zh-CN.md b/docs/demos/cascader/api.zh-CN.md deleted file mode 100644 index 27c1bc198..000000000 --- a/docs/demos/cascader/api.zh-CN.md +++ /dev/null @@ -1,97 +0,0 @@ -### 预设类型 - -```ts -type Data = Record -type CascaderValue = (string | number)[] | (string | number)[][] - -interface CascaderKeyConfig { - value?: string, - label?: string, - children?: string, - disabled?: string, - hasChild?: string -} - -interface CascaderOptionState { - id: number, - parent: number, - value: string | number, - fullValue: string, - label: string, - fullLabel: string, - children: CascaderOptionState[], - disabled: boolean, - hasChild: boolean, - checked: boolean, - partial: boolean, - loading: boolean, - loaded: boolean, - error: boolean, - childrenLoaded: boolean, - data: Data -} -``` - -### Cascader 属性 - -| 名称 | 类型 | 说明 | 默认值 | 始于 | -| --------------- | ------------------------------------------------ | ---------------------------------------------------------------------------------------------------- | ---------------- | ------- | -| size | `'small' \| 'default' \| 'large'` | 联级选择器的大小 | `'default'` | - | -| state | `'default' \| 'success' \| 'error' \| 'warning'` | 联级选择器的状态 | `'default'` | - | -| prefix | `Record` | 前缀图标，使用前缀插槽时无效 | `null` | - | -| prefix-color | `string` | 前缀内容的颜色，会影响前缀插槽 | `''` | - | -| suffix | `Record` | 后缀图标，使用后缀插槽时无效 | `null` | - | -| suffix-color | `string` | 后缀内容的颜色，会影响后缀插槽 | `''` | - | -| no-suffix | `boolean` | 设置是否禁用后缀图标 | `false` | - | -| static-suffix | `boolean` | 设置后缀图标是否为静态的 | `false` | - | -| visible | `boolean` | 设置选项列表是否显，可以使用 `v-model` 双向绑定 | `false` | - | -| options | `Data[]` | 设置联级选择器的选项 | `[]` | - | -| value | `CascaderValue` | 联级选择器的值，可以使用 `v-model` 双向绑定 | `null` | - | -| disabled | `boolean` | 设置是否禁用联级选择器 | `false` | - | -| multiple | `boolean` | 设置是否开启多选模式 | `false` | - | -| no-cascaded | `boolean` | 设置是否解除父子选项的关联，解除后父选项可以被单独选择 | `false` | - | -| key-config | `CascaderKeyConfig` | 配置解析 `options` 时的各项键名 | `{}` | - | -| separator | `string` | 设置选项值和标签的连接符，要求长度为 `1`，注意其会被用于内部构建选项值完整路径 | `/` | - | -| hover-trigger | `boolean` | 设置是否开启鼠标移入触发展开下层面板，开启异步加载后无效 | `false` | - | -| max-tag-count | `number` | 在多选模式下，设置显示的最大标签数，为 `0` 时会动态计算以确保在一行内显示 | `0` | - | -| brief-label | `boolean` | 设置是否显示简短标签值 | `false` | - | -| no-rest-tip | `boolean` | 设置是否禁用额外标签的气泡提示 | `false` | - | -| on-async-load | `(data: Data) => any[] \| Promise` | 设置异步加载的回调函数，设置后将会开启异步加载 | `null` | - | -| merge-tags | `boolean` | 在多选模式下，设置是否在所有子级选项均被选择时显示为父级选项，在异步加载下开启会使传值方式会发生改变 | `false` | - | -| tag-type | `TagType` | 设置多选模式下标签的类型 | `null` | - | -| outside-close | `boolean` | 设置是否可以通过点击组件外部进行关闭 | `false` | - | -| placeholder | `string` | 同原生的 `palceholder` | `''` | - | -| clearable | `boolean` | 设置是否可以清空值 | `false` | - | -| transition-name | `string` | 选项列表的过渡动画 | `'vxp-drop'` | - | -| placement | `Placement` | 选项列表的出现位置，可选值同 Popper.js | `'bottom-start'` | - | -| transfer | `boolean \| string` | 设置选项列表的渲染位置，设置为 `true` 时默认渲染至 `` | `false` | - | -| empty-text | `string` | 设置空选项时的提示语 | `locale.empty` | - | -| loading | `boolean` | 设置是否为加载中 | `false` | - | -| loading-icon | `Record` | 设置加载中的图标 | `Spinner` | - | -| loading-lock | `boolean` | 设置在加载中时是否为只读 | `false` | - | -| loading-effect | `string` | 设置加载中图标的效果动画 | `false` | `2.1.0` | -| transparent | `boolean` | 设置是否为透明模式 | `false` | `2.0.2` | -| locale | `LocaleConfig['select']` | 设置多语言配置 | `null` | `2.1.0` | - -### Cascader 事件 - -| 名称 | 说明 | 参数 | 始于 | -| ------------- | ------------------------------------------------------------------------------------ | -------------------------------------------------- | ---- | -| toggle | 当选项列表显示状态改变时触发，返回当前的状态 | `(visible: boolean)` | - | -| select | 当选项被选时触发，返回被选选项的值路径和选项数据 | `(value: (string \| number)[], data: Data)` | - | -| cancel | 当选项被取消时触发，仅在多选模式下触发，返回被取消选项的值路径和选项数据 | `(value: (string \| number)[], data: Data)` | - | -| change | 当被选值改变时触发，返回选项的值路径和选项数据，多选模式下为值路径数组和选项数据数组 | `(value: CascaderValue, data: Data[] \| Data[][])` | - | -| click-outside | 当点击联级选择器外部是触发，无返回值 | - | - | -| outside-close | 当通过点击外部关闭选项列表时触发，无返回值 | - | - | -| clear | 当通过清除按钮清空值时触发，无返回值 | - | - | - -### Cascader 插槽 - -| 名称 | 说明 | 参数 | 始于 | -| ------- | -------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | ---- | -| default | 选项内容的插槽，其中参数提供的 `hasChild` 是内部计算后的结果 | `{ option: CascaderOptionState, index: number, selected: boolean, canCheck: boolean, hasChild: boolean }` | - | -| label | 选项标签值的插槽，其中参数提供的 `hasChild` 是内部计算后的结果 | `{ option: CascaderOptionState, index: number, selected: boolean, canCheck: boolean, hasChild: boolean }` | - | -| prefix | 前置图标内容的插槽 | - | - | -| control | 选择器主控件内容的插槽 | - | - | -| suffix | 后缀图标内容的插槽 | - | - | -| empty | 空选项提示内容的插槽 | - | - | diff --git a/docs/demos/cascader/async-load/desc.en-US.md b/docs/demos/cascader/async-load/desc.en-US.md deleted file mode 100644 index 24cfe084b..000000000 --- a/docs/demos/cascader/async-load/desc.en-US.md +++ /dev/null @@ -1,7 +0,0 @@ -### Async Load - -Binding a function with `on-async-load` prop enables asynchronous loading mode. - -Added `merge-tags` prop in multi-select mode to make parent options selectable if children are not fully loaded. - -Note that enabling `merge-tags` in asynchronous loading will cause the control value to be merged into the value of the parent option, which is different from the behavior of non-asynchronous loading. diff --git a/docs/demos/cascader/async-load/desc.zh-CN.md b/docs/demos/cascader/async-load/desc.zh-CN.md deleted file mode 100644 index 5018f0196..000000000 --- a/docs/demos/cascader/async-load/desc.zh-CN.md +++ /dev/null @@ -1,7 +0,0 @@ -### 异步加载 - -通过 `on-async-load` 属性可以开启异步加载模式。 - -在多选模式下添加 `merge-tags` 属性可以使得父选项在子级未完全加载完的情况下可被选择。 - -注意，在异步加载下开启 `merge-tags` 会使得控件的 `value` 也合并为父选项的值，这与非异步加载时的表现是不一样的。 diff --git a/docs/demos/cascader/basis/desc.en-US.md b/docs/demos/cascader/basis/desc.en-US.md deleted file mode 100644 index 009f9a709..000000000 --- a/docs/demos/cascader/basis/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Basis Usage - -In the simplest usage, options under the same parent must have different values. diff --git a/docs/demos/cascader/basis/desc.zh-CN.md b/docs/demos/cascader/basis/desc.zh-CN.md deleted file mode 100644 index 054385d46..000000000 --- a/docs/demos/cascader/basis/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 基础用法 - -最简单的用法，在同一个父级下的选项的值须均不相同。 diff --git a/docs/demos/cascader/brief-label/desc.en-US.md b/docs/demos/cascader/brief-label/desc.en-US.md deleted file mode 100644 index a20af2db0..000000000 --- a/docs/demos/cascader/brief-label/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Brief Label - -Adding the `brief-label` prop makes it possible to display only the last section of the label. diff --git a/docs/demos/cascader/brief-label/desc.zh-CN.md b/docs/demos/cascader/brief-label/desc.zh-CN.md deleted file mode 100644 index a992ffb16..000000000 --- a/docs/demos/cascader/brief-label/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 简短标签 - -添加 `brief-label` 属性可以使得显示的标签只保留最后一节。 diff --git a/docs/demos/cascader/clearable/desc.en-US.md b/docs/demos/cascader/clearable/desc.en-US.md deleted file mode 100644 index 446753fe2..000000000 --- a/docs/demos/cascader/clearable/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Clearable - -Add the `clearable` prop to enable clearing of values. diff --git a/docs/demos/cascader/clearable/desc.zh-CN.md b/docs/demos/cascader/clearable/desc.zh-CN.md deleted file mode 100644 index 353670a3a..000000000 --- a/docs/demos/cascader/clearable/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 可清空 - -添加 `clearable` 属性可以开启清空值功能。 diff --git a/docs/demos/cascader/demos-meta.json b/docs/demos/cascader/demos-meta.json deleted file mode 100644 index d6b1a4713..000000000 --- a/docs/demos/cascader/demos-meta.json +++ /dev/null @@ -1,13 +0,0 @@ -[ - "basis", - "hover", - "clearable", - "multiple", - "size", - "max-count", - "no-cascaded", - "brief-label", - "merged", - "async-load", - "loading" -] diff --git a/docs/demos/cascader/desc.en-US.md b/docs/demos/cascader/desc.en-US.md deleted file mode 100644 index f7808cbbd..000000000 --- a/docs/demos/cascader/desc.en-US.md +++ /dev/null @@ -1 +0,0 @@ -It is used when a series of selections are required from a set of related data sets, often in the selection of provinces, cities, classified things, etc. diff --git a/docs/demos/cascader/desc.zh-CN.md b/docs/demos/cascader/desc.zh-CN.md deleted file mode 100644 index ac3c79ea9..000000000 --- a/docs/demos/cascader/desc.zh-CN.md +++ /dev/null @@ -1 +0,0 @@ -当需要从一组相关联的数据集合进行一系列选择时使用，常用于在选择省市区、分类的事物等。 diff --git a/docs/demos/cascader/hover/desc.en-US.md b/docs/demos/cascader/hover/desc.en-US.md deleted file mode 100644 index f2b96d641..000000000 --- a/docs/demos/cascader/hover/desc.en-US.md +++ /dev/null @@ -1,5 +0,0 @@ -### Hover Trigger - -Add the `hover-trigger` prop to enable the mouseover trigger to expand the lower panel. - -This feature has no effect when asynchronous loading is enabled. diff --git a/docs/demos/cascader/hover/desc.zh-CN.md b/docs/demos/cascader/hover/desc.zh-CN.md deleted file mode 100644 index 124d0eba6..000000000 --- a/docs/demos/cascader/hover/desc.zh-CN.md +++ /dev/null @@ -1,5 +0,0 @@ -### 悬停触发 - -添加 `hover-trigger` 属性可以开启鼠标悬停触发展开下层面板。 - -该特性在开启了异步加载后无效。 diff --git a/docs/demos/cascader/loading/desc.en-US.md b/docs/demos/cascader/loading/desc.en-US.md deleted file mode 100644 index 93dc48731..000000000 --- a/docs/demos/cascader/loading/desc.en-US.md +++ /dev/null @@ -1,5 +0,0 @@ -### Loading - -The loading state of the cascader can be controlled through the `loading` prop. - -If you want to be read-only when loading, you need to add the `loading-lock` prop. diff --git a/docs/demos/cascader/loading/desc.zh-CN.md b/docs/demos/cascader/loading/desc.zh-CN.md deleted file mode 100644 index 8de56391f..000000000 --- a/docs/demos/cascader/loading/desc.zh-CN.md +++ /dev/null @@ -1,5 +0,0 @@ -### 加载状态 - -通过 `loading` 属性可以控制联级选择器的加载状态。 - -如果你希望在加载中时为只读，你需要添加 `loading-lock` 属性。 diff --git a/docs/demos/cascader/max-count/desc.en-US.md b/docs/demos/cascader/max-count/desc.en-US.md deleted file mode 100644 index 84c9fc9bb..000000000 --- a/docs/demos/cascader/max-count/desc.en-US.md +++ /dev/null @@ -1,7 +0,0 @@ -### Tag Count - -Use `max-tag-count` prop to set the maximum value of tags displayed in multi-select mode. - -When set to `0`, the maximum value is dynamically calculated inside the component to keep the label displayed on one line. - -If you want all labels to show at all times, just set it to `Infinity`. diff --git a/docs/demos/cascader/max-count/desc.zh-CN.md b/docs/demos/cascader/max-count/desc.zh-CN.md deleted file mode 100644 index 0cd0bc0f2..000000000 --- a/docs/demos/cascader/max-count/desc.zh-CN.md +++ /dev/null @@ -1,7 +0,0 @@ -### 标签数 - -通过 `max-tag-count` 属性可以设置多选模式下标签显示的最大值。 - -当设置为 `0` 时，组件内部会动态计算最大值以让标签维持在一行内显示。 - -如果你希望任何时候都显示所有标签，只需要将其设置为 `Infinity`。 diff --git a/docs/demos/cascader/merged/desc.en-US.md b/docs/demos/cascader/merged/desc.en-US.md deleted file mode 100644 index 28fef5bc4..000000000 --- a/docs/demos/cascader/merged/desc.en-US.md +++ /dev/null @@ -1,5 +0,0 @@ -### Merge Tags - -Add `merge-tags` prop in multi-select mode to enable merging tags. - -When on, when all children of an option are selected, the labels displayed as the parent option are merged. diff --git a/docs/demos/cascader/merged/desc.zh-CN.md b/docs/demos/cascader/merged/desc.zh-CN.md deleted file mode 100644 index 3291f54a4..000000000 --- a/docs/demos/cascader/merged/desc.zh-CN.md +++ /dev/null @@ -1,5 +0,0 @@ -### 合并标签 - -在多选模式下添加 `merge-tags` 属性可以开启合并标签功能。 - -开启后，当某个选项的所有子级都被选择时，会合并显示为父选项的标签。 diff --git a/docs/demos/cascader/multiple/desc.en-US.md b/docs/demos/cascader/multiple/desc.en-US.md deleted file mode 100644 index d70621584..000000000 --- a/docs/demos/cascader/multiple/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Multiple - -Add `multiple` prop to enable multiple selection mode. diff --git a/docs/demos/cascader/multiple/desc.zh-CN.md b/docs/demos/cascader/multiple/desc.zh-CN.md deleted file mode 100644 index 44437d5ca..000000000 --- a/docs/demos/cascader/multiple/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 多选模式 - -添加 `multiple` 属性可以开启多选模式。 diff --git a/docs/demos/cascader/no-cascaded/desc.en-US.md b/docs/demos/cascader/no-cascaded/desc.en-US.md deleted file mode 100644 index 60b8bbfe1..000000000 --- a/docs/demos/cascader/no-cascaded/desc.en-US.md +++ /dev/null @@ -1,5 +0,0 @@ -### No Cascaded Options - -Adding the `no-cascaded` attribute makes each option independently selectable. - -In this mode, it is best to ensure that the `label` of all parent-child options is different, otherwise it will cause ambiguity in the display. diff --git a/docs/demos/cascader/no-cascaded/desc.zh-CN.md b/docs/demos/cascader/no-cascaded/desc.zh-CN.md deleted file mode 100644 index e14e70d84..000000000 --- a/docs/demos/cascader/no-cascaded/desc.zh-CN.md +++ /dev/null @@ -1,5 +0,0 @@ -### 非关联选项 - -添加 `no-cascaded` 属性可以使得每个选项都是独立可选的。 - -在该模式下，最好保证所有的父子级选项的 `label` 均不相同，否则在显示上会引发歧义。 diff --git a/docs/demos/cascader/size/desc.en-US.md b/docs/demos/cascader/size/desc.en-US.md deleted file mode 100644 index 560718239..000000000 --- a/docs/demos/cascader/size/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Change Size - -You can change the size by setting the value of the `size` prop. Currently. diff --git a/docs/demos/cascader/size/desc.zh-CN.md b/docs/demos/cascader/size/desc.zh-CN.md deleted file mode 100644 index ff50416a0..000000000 --- a/docs/demos/cascader/size/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 改变尺寸 - -设置 `size` 属性的值可以改变尺寸。 diff --git a/docs/demos/checkbox/api.en-US.md b/docs/demos/checkbox/api.en-US.md deleted file mode 100644 index b6f125da2..000000000 --- a/docs/demos/checkbox/api.en-US.md +++ /dev/null @@ -1,43 +0,0 @@ -### Checkbox Props - -| Name | Type | Description | Default | Since | -| ------------ | ------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------- | ----------- | ------- | -| checked | `boolean` | Checked state of the checkbox, you can use `v-model` two-way binding | `false` | - | -| label | `string` | The label value of the checkbox, invalid after using the slot | `null` | - | -| value | `string \| number` | The value associated with the checkbox, generally used with the CheckboxGroup, and should be unique within the CheckboxGroup | `null` | - | -| label-class | `ClassType` | The class name of label element | `null` | - | -| size | `'small' \| 'default' \| 'large'` | The size of the checkbox | `'default'` | - | -| state | `'default' \| 'success' \| 'error' \| 'warning'` | The state of the checkbox | `'default'` | - | -| disabled | `boolean` | Set whether is disabled | `false` | - | -| border | `boolean` | Set whether has outer border | `false` | - | -| control | `boolean` | Set as a control, generally used with CheckboxGroup | `false` | - | -| partial | `boolean` | Whether it is a partial selection state, valid when control is `true` | `false` | - | -| loading | `boolean` | Set whether is loading | `false` | `2.0.0` | -| loading-lock | `boolean` | Set whether to be read-only when loading | `false` | `2.0.0` | - -### Checkbox Events - -| Name | Description | Parameters | Since | -| ------ | -------------------------------------------------------------------------- | -------------------- | ----- | -| change | Emitted when the checkbox checked state changes, returns the checked state | `(checked: boolean)` | - | - -### CheckboxGroup Props - -| Name | Type | Description | Default | Since | -| ------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ----------- | ------- | -| value | `(string \| number)[]` | Array of selected label values ​​for checkbox group, can use `v-model` two-way binding | `[]` | - | -| vertical | `boolean` | Set whether is vertical layout | `false` | - | -| size | `'small' \| 'default' \| 'large'` | The size of the checkbox in the group, which will override the `size` set by the checkbox individually | `'default'` | - | -| state | `'default' \| 'success' \| 'error' \| 'warning'` | The state of checkbox group | `'default'` | - | -| disabled | `boolean` | Whether the checkbox in the group is disabled, it will override the `disabled` set by the checkbox separately | `false` | - | -| border | `boolean` | Whether to set the outer border of the checkbox in the group | `false` | - | -| options | `(string \| { value: string \| number, label?: string, control?: boolean })[]` | Set options for selecting sub-check boxes, generally used to generate check box groups easily and quickly, after using slots invalid | `[]` | - | -| loading | `boolean` | Set whether is loading | `false` | `2.0.0` | -| loading-lock | `boolean` | Set whether to be read-only when loading | `false` | `2.0.0` | -| locale | `LocaleConfig['checkbox']` | Set the locale config | `null` | `2.1.0` | - -### CheckboxGroup Events - -| Name | Description | Parameters | Since | -| ------ | ------------------------------------------------------------------------------------------------------- | ------------------------------- | ----- | -| change | Emitted when the checked state of the checkbox changes, returns the label array of the checked checkbox | `(value: (string \| number)[])` | - | diff --git a/docs/demos/checkbox/api.zh-CN.md b/docs/demos/checkbox/api.zh-CN.md deleted file mode 100644 index a15b0de13..000000000 --- a/docs/demos/checkbox/api.zh-CN.md +++ /dev/null @@ -1,43 +0,0 @@ -### Checkbox 属性 - -| 名称 | 类型 | 说明 | 默认值 | 始于 | -| ------------ | ------------------------------------------------ | ---------------------------------------------------------------------- | ----------- | ------- | -| checked | `boolean` | 复选框的勾选状态，可以使用 `v-model` 双向绑定 | `false` | - | -| label | `string` | 复选框的标签值，使用插槽后失效 | `null` | - | -| value | `string \| number` | 复选框关联的值，一般配合 CheckboxGroup 使用，在 CheckboxGroup 内应唯一 | `null` | - | -| label-class | `ClassType` | 标签元素的类名 | `null` | - | -| size | `'small' \| 'default' \| 'large'` | 复选框的大小 | `'default'` | - | -| state | `'default' \| 'success' \| 'error' \| 'warning'` | 复选框的状态 | `'default'` | - | -| disabled | `boolean` | 设置是否为禁用状态 | `false` | - | -| border | `boolean` | 设置是否有外边框 | `false` | - | -| control | `boolean` | 设置为控制性质，一般配合 CheckboxGroup 使用 | `false` | - | -| partial | `boolean` | 是否为部分选择状态，control 为 `true` 时有效 | `false` | - | -| loading | `boolean` | 设置是否为加载中 | `false` | `2.0.0` | -| loading-lock | `boolean` | 设置在加载中时是否为只读 | `false` | `2.0.0` | - -### Checkbox 事件 - -| 名称 | 说明 | 参数 | 始于 | -| ------ | ---------------------------------------- | -------------------- | ---- | -| change | 在复选框勾选状态改变时触发，返回勾选状态 | `(checked: boolean)` | - | - -### CheckboxGroup 属性 - -| 名称 | 类型 | 说明 | 默认值 | 始于 | -| ------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------ | ----------- | ------- | -| value | `(string \| number)[]` | 复选框组被选中的 label 值组成的数组，可以使用 `v-model` 双向绑定 | `[]` | - | -| vertical | `boolean` | 是否为纵向排列 | `false` | - | -| size | `'small' \| 'default' \| 'large'` | 组内复选框的大小，会覆盖复选框单独设置的 `size` | `'default'` | - | -| state | `'default' \| 'success' \| 'error' \| 'warning'` | 复选框组的状态 | `'default'` | - | -| disabled | `boolean` | 组内复选框是否为禁用状态，会覆盖复选框单独设置的 `disabled` | `false` | - | -| border | `boolean` | 组内复选框是否设置外边框 | `false` | - | -| options | `(string \| { value: string \| number, label?: string, control?: boolean })[]` | 设置选子复选框的选项，一般用于简单快速生成复选框组，使用插槽后失效 | `[]` | - | -| loading | `boolean` | 设置是否为加载中 | `false` | `2.0.0` | -| loading-lock | `boolean` | 设置在加载中时是否为只读 | `false` | `2.0.0` | -| locale | `LocaleConfig['checkbox']` | 设置多语言配置 | `null` | `2.1.0` | - -### CheckboxGroup 事件 - -| 名称 | 说明 | 参数 | 始于 | -| ------ | --------------------------------------------------------- | ------------------------------- | ---- | -| change | 在复选框勾选状态改变时触发，返回勾选的复选框的 label 数组 | `(value: (string \| number)[])` | - | diff --git a/docs/demos/checkbox/basis/desc.en-US.md b/docs/demos/checkbox/basis/desc.en-US.md deleted file mode 100644 index 3c199aad1..000000000 --- a/docs/demos/checkbox/basis/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Basis Usage - -A simple Checkbox that might be used when switching something. diff --git a/docs/demos/checkbox/basis/desc.zh-CN.md b/docs/demos/checkbox/basis/desc.zh-CN.md deleted file mode 100644 index 766a55749..000000000 --- a/docs/demos/checkbox/basis/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 基础用法 - -一个简单的 Checkbox，开关某些东西的时候可能会这样用。 diff --git a/docs/demos/checkbox/demos-meta.json b/docs/demos/checkbox/demos-meta.json deleted file mode 100644 index 863a4276b..000000000 --- a/docs/demos/checkbox/demos-meta.json +++ /dev/null @@ -1 +0,0 @@ -["basis", "disabled", "size", "group", "vertical", "total", "layout", "options", "loading", "state"] diff --git a/docs/demos/checkbox/desc.en-US.md b/docs/demos/checkbox/desc.en-US.md deleted file mode 100644 index 03f25f84e..000000000 --- a/docs/demos/checkbox/desc.en-US.md +++ /dev/null @@ -1 +0,0 @@ -Use when you need to make multiple choices in a set of options, or when you need to represent a switch between two states. diff --git a/docs/demos/checkbox/desc.zh-CN.md b/docs/demos/checkbox/desc.zh-CN.md deleted file mode 100644 index 7d172b128..000000000 --- a/docs/demos/checkbox/desc.zh-CN.md +++ /dev/null @@ -1 +0,0 @@ -需要在一组选项中进行多项选择时使用，或是用于需要表示两种状态之间的切换的场合。 diff --git a/docs/demos/checkbox/disabled/desc.en-US.md b/docs/demos/checkbox/disabled/desc.en-US.md deleted file mode 100644 index af116270c..000000000 --- a/docs/demos/checkbox/disabled/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Disabled - -Add the `disabled` prop to set the disabled state. diff --git a/docs/demos/checkbox/disabled/desc.zh-CN.md b/docs/demos/checkbox/disabled/desc.zh-CN.md deleted file mode 100644 index 2a3e0b217..000000000 --- a/docs/demos/checkbox/disabled/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 禁用状态 - -添加 `disabled` 属性可以设置禁用状态。 diff --git a/docs/demos/checkbox/group/desc.en-US.md b/docs/demos/checkbox/group/desc.en-US.md deleted file mode 100644 index 842a7c3b3..000000000 --- a/docs/demos/checkbox/group/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Checkbox Group - -Use the CheckboxGroup to easily generate a series of checkboxes from an array structure. diff --git a/docs/demos/checkbox/group/desc.zh-CN.md b/docs/demos/checkbox/group/desc.zh-CN.md deleted file mode 100644 index 71cecb525..000000000 --- a/docs/demos/checkbox/group/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 复选框组 - -使用复选框组可以轻松的通过数组结构生成系列复选框。 diff --git a/docs/demos/checkbox/layout/desc.en-US.md b/docs/demos/checkbox/layout/desc.en-US.md deleted file mode 100644 index 7df90252c..000000000 --- a/docs/demos/checkbox/layout/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Flexible Layout - -Combined with the layout component, you can flexibly customize the layout of the checkbox group. diff --git a/docs/demos/checkbox/layout/desc.zh-CN.md b/docs/demos/checkbox/layout/desc.zh-CN.md deleted file mode 100644 index bbe4ef3b5..000000000 --- a/docs/demos/checkbox/layout/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 灵活布局 - -结合布局组件可以灵活地对复选框组进行自定义布局。 diff --git a/docs/demos/checkbox/loading/desc.en-US.md b/docs/demos/checkbox/loading/desc.en-US.md deleted file mode 100644 index 2eb4997c6..000000000 --- a/docs/demos/checkbox/loading/desc.en-US.md +++ /dev/null @@ -1,5 +0,0 @@ -### Loading - -The loading state of the checkbox can be controlled through the `loading` prop. - -If you want to be read-only when loading, you need to add the `loading-lock` prop. diff --git a/docs/demos/checkbox/loading/desc.zh-CN.md b/docs/demos/checkbox/loading/desc.zh-CN.md deleted file mode 100644 index 69802c278..000000000 --- a/docs/demos/checkbox/loading/desc.zh-CN.md +++ /dev/null @@ -1,5 +0,0 @@ -### 加载状态 - -通过 `loading` 属性可以控制多选框的加载状态。 - -如果你希望在加载中时为只读，你需要添加 `loading-lock` 属性。 diff --git a/docs/demos/checkbox/options/desc.en-US.md b/docs/demos/checkbox/options/desc.en-US.md deleted file mode 100644 index aad3b7ad4..000000000 --- a/docs/demos/checkbox/options/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Options - -A checkbox group can be quickly generated via the `options` prop. diff --git a/docs/demos/checkbox/options/desc.zh-CN.md b/docs/demos/checkbox/options/desc.zh-CN.md deleted file mode 100644 index 3da3fda64..000000000 --- a/docs/demos/checkbox/options/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 选项 - -通过 `options` 属性可以快速生成复选框组。 diff --git a/docs/demos/checkbox/size/desc.en-US.md b/docs/demos/checkbox/size/desc.en-US.md deleted file mode 100644 index e98e3044c..000000000 --- a/docs/demos/checkbox/size/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Checkbox Size - -There are three built-in sizes, which are set by `size`. diff --git a/docs/demos/checkbox/size/desc.zh-CN.md b/docs/demos/checkbox/size/desc.zh-CN.md deleted file mode 100644 index 86ab37322..000000000 --- a/docs/demos/checkbox/size/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 三种尺寸 - -三种尺寸却有四个，正常的。 diff --git a/docs/demos/checkbox/state/desc.en-US.md b/docs/demos/checkbox/state/desc.en-US.md deleted file mode 100644 index f7cd5feb1..000000000 --- a/docs/demos/checkbox/state/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Different States - -Different states can be set via `state`. diff --git a/docs/demos/checkbox/state/desc.zh-CN.md b/docs/demos/checkbox/state/desc.zh-CN.md deleted file mode 100644 index 16132f009..000000000 --- a/docs/demos/checkbox/state/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 不同状态 - -通过 `state` 可以设置不同的状态。 diff --git a/docs/demos/checkbox/total/desc.en-US.md b/docs/demos/checkbox/total/desc.en-US.md deleted file mode 100644 index 9e35a335a..000000000 --- a/docs/demos/checkbox/total/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Check all Control - -When you need to achieve check all, you only need to add a checkbox with the `control` prop to the checkbox group. diff --git a/docs/demos/checkbox/total/desc.zh-CN.md b/docs/demos/checkbox/total/desc.zh-CN.md deleted file mode 100644 index 499ddf9c3..000000000 --- a/docs/demos/checkbox/total/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 全选控件 - -在需要实现全选时，只需要在复选框组内添加一个具有 `control` 属性的复选框即可。 diff --git a/docs/demos/checkbox/vertical/desc.en-US.md b/docs/demos/checkbox/vertical/desc.en-US.md deleted file mode 100644 index cc710326f..000000000 --- a/docs/demos/checkbox/vertical/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Vertical Layout - -Add the `vertical` prop to CheckboxGroup to achieve vertical alignment. diff --git a/docs/demos/checkbox/vertical/desc.zh-CN.md b/docs/demos/checkbox/vertical/desc.zh-CN.md deleted file mode 100644 index b2c8aae53..000000000 --- a/docs/demos/checkbox/vertical/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 纵向布局 - -为 CheckboxGroup 添加 `vertical` 属性可以实现纵向排列。 diff --git a/docs/demos/collapse/accordion/desc.en-US.md b/docs/demos/collapse/accordion/desc.en-US.md deleted file mode 100644 index e1db9695f..000000000 --- a/docs/demos/collapse/accordion/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Accordion - -Adding the `accordion` prop enables accordion mode, in which only one panel can be expanded at a time. diff --git a/docs/demos/collapse/accordion/desc.zh-CN.md b/docs/demos/collapse/accordion/desc.zh-CN.md deleted file mode 100644 index 357d5042e..000000000 --- a/docs/demos/collapse/accordion/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 手风琴 - -添加 `accordion` 属性可以开启手风琴模式，该模式下每次只能展开一个面板。 diff --git a/docs/demos/collapse/api.en-US.md b/docs/demos/collapse/api.en-US.md deleted file mode 100644 index dbb7b4a63..000000000 --- a/docs/demos/collapse/api.en-US.md +++ /dev/null @@ -1,49 +0,0 @@ -### Collapse Props - -| Name | Type | Description | Default | Since | -| ---------- | ------------------------------------------ | ----------------------------------------------------------------------------------------------- | --------- | ----- | -| expanded | `string \| number \| (string \| number)[]` | Set the label value of the expanded panel, can be passed in an array when not in accordion mode | `null` | - | -| card | `boolean` | Set whether to be in card mode | `false` | - | -| accordion | `boolean` | Set whether to accordion mode | `false` | - | -| arrow-type | `'right' \| 'left' \| 'none'` | Set the type of the panel's indicator arrow | `'right'` | - | -| ghost | `boolean` | Set whether to set borderless mode | `false` | - | - -### Collapse Events - -| Name | Description | Parameters | Since | -| ------ | ------------------------------------------------------------------------------------------ | ---------------------------------- | ----- | -| change | Emitted when the expanded panel changes, returns the label of the currently expanded panel | `(expanded: (string \| number)[])` | - | - -### CollapsePanel Props - -| Name | Type | Description | Default | Since | -| ------------- | ----------------------------- | ------------------------------------------------------ | --------- | ----- | -| label | `string \| number` | The label value of panel, unique within the same group | `null` | - | -| title | `string` | The title of the panel | `''` | - | -| disabled | `boolean` | Set whether the panel is disabled | `false` | - | -| content-style | `Record` | The styles the content of the panel | `null` | - | -| expanded | `boolean` | Set whether the panel is expanded | `false` | - | -| card | `boolean` | Set whether to be in card mode | `false` | - | -| arrow-type | `'right' \| 'left' \| 'none'` | Set the type of the panel's indicator arrow | `'right'` | - | -| icon | `string` | Set the subordinate icon for the panel title | `''` | - | -| ghost | `boolean` | Set whether to be in borderless mode | `false` | - | - -### CollapsePanel Slots - -| Name | Description | Parameters | Since | -| ------- | -------------------------- | ---------- | ----- | -| default | Content slot for the panel | - | - | -| title | Title slot for the panel | - | - | - -### CollapseTransition Props - -| Name | Type | Description | Default | Since | -| ----------- | ----------------------------------- | ---------------------------------------------------------------------------------------- | --------------- | ----- | -| appear | `boolean` | Set whether will be passed to vue native transition component | `false` | - | -| mode | `'in-out' \| 'out-in' \| 'default'` | The transition mode, optional values are `default`, `out-in`, `in-out` | `'default '` | - | -| horizontal | `boolean` | Set whether to fold horizontally | `false` | - | -| duration | `number` | Set the duration of the folding transition effect in milliseconds, not less than `200ms` | `250` | - | -| timing | `string` | The timing function to set transition effect | `'ease-in-out'` | - | -| fade-effect | `boolean` | Set whether to have fade-in effect when folding | `false` | - | - -> The CollapseTransition component supports 'before-enter', 'enter', 'after-enter', 'before-leave', 'leave', 'after-leave' events. diff --git a/docs/demos/collapse/api.zh-CN.md b/docs/demos/collapse/api.zh-CN.md deleted file mode 100644 index de2426f43..000000000 --- a/docs/demos/collapse/api.zh-CN.md +++ /dev/null @@ -1,49 +0,0 @@ -### Collapse 属性 - -| 名称 | 类型 | 说明 | 默认值 | 始于 | -| ---------- | ------------------------------------------ | --------------------------------------------------- | --------- | ---- | -| expanded | `string \| number \| (string \| number)[]` | 设置展开的面板的 label 值，非手风琴模式时可传入数组 | `null` | - | -| card | `boolean` | 设置是否为卡片模式 | `false` | - | -| accordion | `boolean` | 设置是否为手风琴模式 | `false` | - | -| arrow-type | `'right' \| 'left' \| 'none'` | 设置面板的指示箭头的类型 | `'right'` | - | -| ghost | `boolean` | 设置是否为无边框模式 | `false` | - | - -### Collapse 事件 - -| 名称 | 说明 | 参数 | 始于 | -| ------ | ------------------------------------------------------ | ---------------------------------- | ---- | -| change | 当展开的面板发生变化时触发，返回当前展开的面板的 label | `(expanded: (string \| number)[])` | - | - -### CollapsePanel 属性 - -| 名称 | 类型 | 说明 | 默认值 | 始于 | -| ------------- | ----------------------------- | ----------------------------- | --------- | ---- | -| label | `string \| number` | 面板的 label 值，同一组内唯一 | `null` | - | -| title | `string` | 面板的标题 | `''` | - | -| disabled | `boolean` | 设置面板是否为禁用状态 | `false` | - | -| content-style | `Record` | 设置面板的内容的样式 | `null` | - | -| expanded | `boolean` | 设置面板是否展开 | `false` | - | -| card | `boolean` | 设置是否为卡片模式 | `false` | - | -| arrow-type | `'right' \| 'left' \| 'none'` | 设置面板的指示箭头的类型 | `'right'` | - | -| icon | `Record` | 设置面板标题的附属图标 | `''` | - | -| ghost | `boolean` | 设置是否为无边框模式 | `false` | - | - -### CollapsePanel 插槽 - -| 名称 | 说明 | 参数 | 始于 | -| ------- | -------------- | ---- | ---- | -| default | 面板的内容插槽 | - | - | -| title | 面板的标题插槽 | - | - | - -### CollapseTransition 属性 - -| 名称 | 类型 | 说明 | 默认值 | 始于 | -| ----------- | ----------------------------------- | -------------------------------------------------- | --------------- | ---- | -| appear | `boolean` | 将传递给 vue 原生的 transition 组件 | `false` | - | -| mode | `'in-out' \| 'out-in' \| 'default'` | 过渡的模式，可选值为 `default`、`out-in`、`in-out` | `'default'` | - | -| horizontal | `boolean` | 设置是否为横向折叠 | `false` | - | -| duration | `number` | 设置折叠过渡效果的持续毫秒数，不小于 `200ms` | `250` | - | -| timing | `string` | 设置过渡效果的动画函数 | `'ease-in-out'` | - | -| fade-effect | `boolean` | 设置是否在折叠的时候同时具有渐显隐效果 | `false` | - | - -> CollapseTransition 组件支持 'before-enter'、'enter'、'after-enter'、'before-leave'、'leave'、'after-leave' 事件。 diff --git a/docs/demos/collapse/arrow/desc.en-US.md b/docs/demos/collapse/arrow/desc.en-US.md deleted file mode 100644 index 1e4f04744..000000000 --- a/docs/demos/collapse/arrow/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Adjust Arrow - -Adding the value of the `arrow-type` prop can change the position of the panel arrow or hide the arrow. diff --git a/docs/demos/collapse/arrow/desc.zh-CN.md b/docs/demos/collapse/arrow/desc.zh-CN.md deleted file mode 100644 index 600cce762..000000000 --- a/docs/demos/collapse/arrow/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 调整箭头 - -添加 `arrow-type` 属性的值可以改变面板箭头的位置或者隐藏箭头。 diff --git a/docs/demos/collapse/basis/desc.en-US.md b/docs/demos/collapse/basis/desc.en-US.md deleted file mode 100644 index e3bcb7405..000000000 --- a/docs/demos/collapse/basis/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Basis Usage - -Each panel can expand and contract independently without affecting each other. diff --git a/docs/demos/collapse/basis/desc.zh-CN.md b/docs/demos/collapse/basis/desc.zh-CN.md deleted file mode 100644 index 956efa74c..000000000 --- a/docs/demos/collapse/basis/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 基础用法 - -每个面板可以独立展开收缩，不相互影响。 diff --git a/docs/demos/collapse/card/desc.en-US.md b/docs/demos/collapse/card/desc.en-US.md deleted file mode 100644 index 8dd6ba4ff..000000000 --- a/docs/demos/collapse/card/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Card Mode - -Add the `card` prop to enable card mode. diff --git a/docs/demos/collapse/card/desc.zh-CN.md b/docs/demos/collapse/card/desc.zh-CN.md deleted file mode 100644 index 5a4c549af..000000000 --- a/docs/demos/collapse/card/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 卡片模式 - -添加 `card` 属性可以开启卡片模式。 diff --git a/docs/demos/collapse/demos-meta.json b/docs/demos/collapse/demos-meta.json deleted file mode 100644 index 03195dff1..000000000 --- a/docs/demos/collapse/demos-meta.json +++ /dev/null @@ -1 +0,0 @@ -["basis", "card", "ghost", "accordion", "arrow", "single", "transition"] diff --git a/docs/demos/collapse/desc.en-US.md b/docs/demos/collapse/desc.en-US.md deleted file mode 100644 index e69de29bb..000000000 diff --git a/docs/demos/collapse/desc.zh-CN.md b/docs/demos/collapse/desc.zh-CN.md deleted file mode 100644 index e69de29bb..000000000 diff --git a/docs/demos/collapse/ghost/desc.en-US.md b/docs/demos/collapse/ghost/desc.en-US.md deleted file mode 100644 index e6edce8f4..000000000 --- a/docs/demos/collapse/ghost/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Borderless Mode - -Add `ghost` prop to enable borderless mode, this attribute has no effect in card mode. diff --git a/docs/demos/collapse/ghost/desc.zh-CN.md b/docs/demos/collapse/ghost/desc.zh-CN.md deleted file mode 100644 index a0ad22280..000000000 --- a/docs/demos/collapse/ghost/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 无边框模式 - -添加 `ghost` 属性可以开启无边框模式，该属性在卡片模式下无效。 diff --git a/docs/demos/collapse/single/desc.en-US.md b/docs/demos/collapse/single/desc.en-US.md deleted file mode 100644 index b6d885ffd..000000000 --- a/docs/demos/collapse/single/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Use Alone - -Not all cases require multiple panels to be juxtaposed, in which case the panel can be used alone to form an independent expandable panel. diff --git a/docs/demos/collapse/single/desc.zh-CN.md b/docs/demos/collapse/single/desc.zh-CN.md deleted file mode 100644 index a824af329..000000000 --- a/docs/demos/collapse/single/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 单独使用 - -并不是所有的情况都需要多个面板并列，这时 Pane 组件可以单独使用，形成一个独立可展开面板。 diff --git a/docs/demos/collapse/transition/desc.en-US.md b/docs/demos/collapse/transition/desc.en-US.md deleted file mode 100644 index 8825fa41c..000000000 --- a/docs/demos/collapse/transition/desc.en-US.md +++ /dev/null @@ -1,5 +0,0 @@ -### Transition Component - -A custom Transition component is used inside the accordion panel to implement the accordion transition effect. - -This component can be used independently to add collapsing transition effects to internal elements, while supporting all properties of native Transition. diff --git a/docs/demos/collapse/transition/desc.zh-CN.md b/docs/demos/collapse/transition/desc.zh-CN.md deleted file mode 100644 index 5d720022b..000000000 --- a/docs/demos/collapse/transition/desc.zh-CN.md +++ /dev/null @@ -1,5 +0,0 @@ -### 过渡组件 - -折叠面板内部使用了一个自定义的 Transition 组件实现折叠过渡效果。 - -该组件可以独立使用，为内部元素添加折叠过渡效果，同时支持原生 Transition 的所有属性。 diff --git a/docs/demos/color-picker/alpha/desc.en-US.md b/docs/demos/color-picker/alpha/desc.en-US.md deleted file mode 100644 index 7d5c1086b..000000000 --- a/docs/demos/color-picker/alpha/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Alpha - -Add the `alpha` prop to enable transparency selection. diff --git a/docs/demos/color-picker/alpha/desc.zh-CN.md b/docs/demos/color-picker/alpha/desc.zh-CN.md deleted file mode 100644 index 0aece5b8a..000000000 --- a/docs/demos/color-picker/alpha/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 透明度 - -添加 `alpha` 属性可以开启透明度选择功能。 diff --git a/docs/demos/color-picker/api.en-US.md b/docs/demos/color-picker/api.en-US.md deleted file mode 100644 index c79e7894c..000000000 --- a/docs/demos/color-picker/api.en-US.md +++ /dev/null @@ -1,62 +0,0 @@ -### ColorPicker Props - -| Name | Type | Description | Default | Since | -| -------------- | ---------------------------------- | --------------------------------------------------------------------------------------------- | ----------- | ------- | -| value | `string` | The value of the color picker, can use `v-model` two-way binding | `'#339af0'` | - | -| visible | `boolean` | Set the display state of the color control panel | `false` | - | -| format | `'rgb' \| 'hsl' \| 'hsv' \| 'hex'` | Type to format the color before updating value | `'rgb'` | - | -| size | `small \| default \| large` | The size of color picker | `'default'` | - | -| alpha | `boolean` | whether to use transparency selection | `false` | - | -| disabled | `boolean` | Set whether is disabled | `false` | - | -| no-input | `boolean` | Set whether to disable Input input color value | `false` | - | -| shortcut | `boolean \| string[]` | Set whether to use shortcut to select color, can specify the list when passing a string array | `false` | - | -| prefix | `Record` | The prefix icon, invalid when using prefix slot | `null` | `2.0.0` | -| prefix-color | `string` | The color of the prefix content, affects the prefix slot | `''` | `2.0.0` | -| suffix | `Record` | The suffix icon, invalid when using suffix slot | `null` | `2.0.0` | -| suffix-color | `string` | The color of the suffix content, which affects the suffix slot | `''` | `2.0.0` | -| no-suffix | `boolean` | Set whether to disable suffix icon | `false` | `2.0.0` | -| static-suffix | `boolean` | Set whether the suffix icon is static | `false` | `2.0.0` | -| loading | `boolean` | Set whether is loading | `false` | `2.0.0` | -| loading-icon | `Record` | Set the loading icon | `Spinner` | `2.0.0` | -| loading-lock | `boolean` | Set whether to be read-only when loading | `false` | `2.0.0` | -| loading-effect | `string` | Set the effect animation for the loading icon | `false` | `2.0.0` | -| locale | `LocaleConfig['colorPicker']` | Set the locale config | `null` | `2.1.0` | - -```js -const defaultShotcuts = [ - '#2d8cf0', - '#19be6b', - '#ff9900', - '#ed4014', - '#00b5ff', - '#19c919', - '#f9e31c', - '#ea1a1a', - '#9b1dea', - '#00c2b1', - '#ac7a33', - '#1d35ea', - '#8bc34a', - '#f16b62', - '#ea4ca3', - '#0d94aa', - '#febd79', - '#5d4037', - '#00bcd4', - '#f06292', - '#cddc39', - '#607d8b', - '#000000', - '#ffffff' -] -``` - -### ColorPicker Events - -| Name | Description | Parameters | Since | -| ------------- | ----------------------------------------------------------------------------------------------- | -------------------------------------------------------- | ----- | -| toggle | Emitted when the color control panel display state changes, returns the current state | `(visible: boolean)` | - | -| click-outside | Emitted when the outside of the control is clicked, no return value | - | - | -| outside-close | Emitted when the panel is closed by clicking outside the control, no return value | - | - | -| change | Emitted when the selected color changes, returns the formatted color value | `(color: string \| RGBAColor \| HSLAColor \| HSVAColor)` | - | -| shortcut | Emitted when a color is selected using the shortcut function, returns the formatted color value | `(color: string \| RGBAColor \| HSLAColor \| HSVAColor)` | - | diff --git a/docs/demos/color-picker/api.zh-CN.md b/docs/demos/color-picker/api.zh-CN.md deleted file mode 100644 index d62dbef89..000000000 --- a/docs/demos/color-picker/api.zh-CN.md +++ /dev/null @@ -1,62 +0,0 @@ -### ColorPicker 属性 - -| 名称 | 类型 | 说明 | 默认值 | 始于 | -| -------------- | ---------------------------------- | -------------------------------------------------------- | ----------- | ------- | -| value | `string` | 颜色选择器的值，可以使用 `v-model` 双向绑定 | `'#339af0'` | - | -| visible | `boolean` | 设置颜色控制面板的显示状态 | `false` | - | -| format | `'rgb' \| 'hsl' \| 'hsv' \| 'hex'` | 更新 value 前对颜色进行格式化的类型 | `'rgb'` | - | -| size | `small \| default \| large` | 颜色选择器的大小 | `'default'` | - | -| alpha | `boolean` | 是否使用透明度选择功能 | `false` | - | -| disabled | `boolean` | 是否为禁用状态 | `false` | - | -| no-input | `boolean` | 是否禁用 Input 输入颜色值 | `false` | - | -| shortcut | `boolean \| string[]` | 是否使用快捷选取颜色，传入字符串数组时可以定制化候选列表 | `false` | - | -| prefix | `Record` | 前缀图标，使用前缀插槽时无效 | `null` | `2.0.0` | -| prefix-color | `string` | 前缀内容的颜色，会影响前缀插槽 | `''` | `2.0.0` | -| suffix | `Record` | 后缀图标，使用后缀插槽时无效 | `null` | `2.0.0` | -| suffix-color | `string` | 后缀内容的颜色，会影响后缀插槽 | `''` | `2.0.0` | -| no-suffix | `boolean` | 设置是否禁用后缀图标 | `false` | `2.0.0` | -| static-suffix | `boolean` | 设置后缀图标是否为静态的 | `false` | `2.0.0` | -| loading | `boolean` | 设置是否为加载中 | `false` | `2.0.0` | -| loading-icon | `Record` | 设置加载中的图标 | `Spinner` | `2.0.0` | -| loading-lock | `boolean` | 设置在加载中时是否为只读 | `false` | `2.0.0` | -| loading-effect | `string` | 设置加载中图标的效果动画 | `false` | `2.0.0` | -| locale | `LocaleConfig['colorPicker']` | 设置多语言配置 | `null` | `2.1.0` | - -```js -const defaultShotcuts = [ - '#2d8cf0', - '#19be6b', - '#ff9900', - '#ed4014', - '#00b5ff', - '#19c919', - '#f9e31c', - '#ea1a1a', - '#9b1dea', - '#00c2b1', - '#ac7a33', - '#1d35ea', - '#8bc34a', - '#f16b62', - '#ea4ca3', - '#0d94aa', - '#febd79', - '#5d4037', - '#00bcd4', - '#f06292', - '#cddc39', - '#607d8b', - '#000000', - '#ffffff' -] -``` - -### ColorPicker 事件 - -| 名称 | 说明 | 参数 | 始于 | -| ------------- | -------------------------------------------------- | -------------------------------------------------------- | ---- | -| toggle | 颜色控制面板显示状态改变时触发，返回当前状态 | `(visible: boolean)` | - | -| click-outside | 当点击控件外部时触发，无返回值 | - | - | -| outside-close | 当点击控件外部触发面板关闭时触发，无返回值 | - | - | -| change | 当选择的颜色发生变化时触发，返回格式化后的颜色值 | `(color: string \| RGBAColor \| HSLAColor \| HSVAColor)` | - | -| shortcut | 当使用快捷功能选取颜色时触发，返回格式化后的颜色值 | `(color: string \| RGBAColor \| HSLAColor \| HSVAColor)` | - | diff --git a/docs/demos/color-picker/basis/desc.en-US.md b/docs/demos/color-picker/basis/desc.en-US.md deleted file mode 100644 index b43bfceae..000000000 --- a/docs/demos/color-picker/basis/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Basis Usage - -Simplest usage. diff --git a/docs/demos/color-picker/basis/desc.zh-CN.md b/docs/demos/color-picker/basis/desc.zh-CN.md deleted file mode 100644 index f1b7d31c8..000000000 --- a/docs/demos/color-picker/basis/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 基础用法 - -最简单的用法。 diff --git a/docs/demos/color-picker/demos-meta.json b/docs/demos/color-picker/demos-meta.json deleted file mode 100644 index c85e435fa..000000000 --- a/docs/demos/color-picker/demos-meta.json +++ /dev/null @@ -1 +0,0 @@ -["basis", "alpha", "shortcut", "prefix", "loading"] diff --git a/docs/demos/color-picker/desc.en-US.md b/docs/demos/color-picker/desc.en-US.md deleted file mode 100644 index bba3b30d6..000000000 --- a/docs/demos/color-picker/desc.en-US.md +++ /dev/null @@ -1 +0,0 @@ -Provides a picker that can be used to give the user quick and flexible selection of color values. diff --git a/docs/demos/color-picker/desc.zh-CN.md b/docs/demos/color-picker/desc.zh-CN.md deleted file mode 100644 index e7ead8c38..000000000 --- a/docs/demos/color-picker/desc.zh-CN.md +++ /dev/null @@ -1 +0,0 @@ -提供一个选择器可用于让用户快速灵活地选择颜色值。 diff --git a/docs/demos/color-picker/loading/desc.en-US.md b/docs/demos/color-picker/loading/desc.en-US.md deleted file mode 100644 index e96735e08..000000000 --- a/docs/demos/color-picker/loading/desc.en-US.md +++ /dev/null @@ -1,5 +0,0 @@ -### Loading - -The loading state of the color picker can be controlled through the `loading` prop. - -If you want to be read-only when loading, you need to add the `loading-lock` prop. diff --git a/docs/demos/color-picker/loading/desc.zh-CN.md b/docs/demos/color-picker/loading/desc.zh-CN.md deleted file mode 100644 index 08ba2ca6e..000000000 --- a/docs/demos/color-picker/loading/desc.zh-CN.md +++ /dev/null @@ -1,5 +0,0 @@ -### 加载状态 - -通过 `loading` 属性可以控制颜色选择器的加载状态。 - -如果你希望在加载中时为只读，你需要添加 `loading-lock` 属性。 diff --git a/docs/demos/color-picker/prefix/desc.en-US.md b/docs/demos/color-picker/prefix/desc.en-US.md deleted file mode 100644 index 7c03ff47a..000000000 --- a/docs/demos/color-picker/prefix/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Prefix Icon - -Prefix icon can be added to color picker by setting the `prefix` prop or using the slot of the same name. diff --git a/docs/demos/color-picker/prefix/desc.zh-CN.md b/docs/demos/color-picker/prefix/desc.zh-CN.md deleted file mode 100644 index 74421c8d6..000000000 --- a/docs/demos/color-picker/prefix/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 前置图标 - -设置 `prefix` 属性或者使用同名插槽，可以为选择器添加前置图标。 diff --git a/docs/demos/color-picker/shortcut/desc.en-US.md b/docs/demos/color-picker/shortcut/desc.en-US.md deleted file mode 100644 index 810c8b27d..000000000 --- a/docs/demos/color-picker/shortcut/desc.en-US.md +++ /dev/null @@ -1,5 +0,0 @@ -### Shortcuts - -Add the `shortcut` prop to use shortcuts. - -The list of shortcuts can be customized via passing a string array. diff --git a/docs/demos/color-picker/shortcut/desc.zh-CN.md b/docs/demos/color-picker/shortcut/desc.zh-CN.md deleted file mode 100644 index beed8a00d..000000000 --- a/docs/demos/color-picker/shortcut/desc.zh-CN.md +++ /dev/null @@ -1,5 +0,0 @@ -### 快捷方式 - -添加 `shortcut` 属性可以使用快捷方式。 - -传入一组有效的颜色值，可以自定义快捷方式列表。 diff --git a/docs/demos/config-provider/api.en-US.md b/docs/demos/config-provider/api.en-US.md deleted file mode 100644 index 1c3d02154..000000000 --- a/docs/demos/config-provider/api.en-US.md +++ /dev/null @@ -1,7 +0,0 @@ -### ConfigProvider Props - -| Name | Type | Description | Default | Since | -| ------ | ------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | ------- | -| props | `Record` | The component props configuration to be injected, the key value is the camel case name of the component, the value is the props configuration of the component, the injected values will override the component's original props default values | `{}` | - | -| locale | [`LocaleOptions`](https://github.com/vexip-ui/vexip-ui/blob/main/common/config/src/locale/helper.ts#L5) | The internationalization configuration to be injected | `{}` | - | -| icons | [`IconsOptions`](https://github.com/vexip-ui/vexip-ui/blob/main/common/config/src/icons.ts#L88) | The internal icons configuration to be injected | `{}` | `2.1.9` | diff --git a/docs/demos/config-provider/api.zh-CN.md b/docs/demos/config-provider/api.zh-CN.md deleted file mode 100644 index 1ddac9556..000000000 --- a/docs/demos/config-provider/api.zh-CN.md +++ /dev/null @@ -1,7 +0,0 @@ -### ConfigProvider 属性 - -| 名称 | 类型 | 说明 | 默认值 | 始于 | -| ------ | ------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ------ | ------- | -| props | `Record` | 需要注入的组件属性配置，键值为组件的驼峰命名，值为对应组件的属性配置，注入的属性将覆盖组件原有的属性默认值 | `{}` | - | -| locale | [`LocaleOptions`](https://github.com/vexip-ui/vexip-ui/blob/main/common/config/src/locale/helper.ts#L5) | 需要注入的国际化配置 | `{}` | - | -| icons | [`IconsOptions`](https://github.com/vexip-ui/vexip-ui/blob/main/common/config/src/icons.ts#L88) | 需要注入的内部图标配置 | `{}` | `2.1.9` | diff --git a/docs/demos/config-provider/basis/desc.en-US.md b/docs/demos/config-provider/basis/desc.en-US.md deleted file mode 100644 index 936c863af..000000000 --- a/docs/demos/config-provider/basis/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Basis Usage - -Provides config for all child components. diff --git a/docs/demos/config-provider/basis/desc.zh-CN.md b/docs/demos/config-provider/basis/desc.zh-CN.md deleted file mode 100644 index b8da0d4d9..000000000 --- a/docs/demos/config-provider/basis/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 基础用法 - -为所有子级组件提供配置注入。 diff --git a/docs/demos/config-provider/demos-meta.json b/docs/demos/config-provider/demos-meta.json deleted file mode 100644 index 1f2773bfa..000000000 --- a/docs/demos/config-provider/demos-meta.json +++ /dev/null @@ -1 +0,0 @@ -["basis", "nesting", "function"] diff --git a/docs/demos/config-provider/desc.en-US.md b/docs/demos/config-provider/desc.en-US.md deleted file mode 100644 index 450abb4ec..000000000 --- a/docs/demos/config-provider/desc.en-US.md +++ /dev/null @@ -1,5 +0,0 @@ -ConfigProvider is used to provide configurations for its internal components. - -When it is necessary to set the same property value for the same component in a large area, the ability to override the default value of ConfigProvider can quickly adjust the property. - -If you want global configuration, see [Global Config](/zh-CN/guides/global). diff --git a/docs/demos/config-provider/desc.zh-CN.md b/docs/demos/config-provider/desc.zh-CN.md deleted file mode 100644 index 78ad30a72..000000000 --- a/docs/demos/config-provider/desc.zh-CN.md +++ /dev/null @@ -1,5 +0,0 @@ -配置注入用于为其内部组件的提供各项配置。 - -当遇到需要大面积为同一种组件设置同一个属性值时，基于配置注入可覆写组件属性默认值的能力能够快速实现属性调整。 - -想了解全局配置请参考 [全局配置](/zh-CN/guides/global)。 diff --git a/docs/demos/config-provider/function/desc.en-US.md b/docs/demos/config-provider/function/desc.en-US.md deleted file mode 100644 index e01391a42..000000000 --- a/docs/demos/config-provider/function/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Function Default - -Some props are object type, you should use a function to return a new value to prevent accidental modification of the object. diff --git a/docs/demos/config-provider/function/desc.zh-CN.md b/docs/demos/config-provider/function/desc.zh-CN.md deleted file mode 100644 index 70be9e242..000000000 --- a/docs/demos/config-provider/function/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 函数默认值 - -某些属性为对象类型时，应该使用函数的方式返回一个全新的值，以防止发生对象被意外的修改。 diff --git a/docs/demos/config-provider/nesting/desc.en-US.md b/docs/demos/config-provider/nesting/desc.en-US.md deleted file mode 100644 index 9a6f35299..000000000 --- a/docs/demos/config-provider/nesting/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Nesting Usage - -It will auto dynamically merge the config provided by the upstream durning injection, and then provided to the lower. diff --git a/docs/demos/config-provider/nesting/desc.zh-CN.md b/docs/demos/config-provider/nesting/desc.zh-CN.md deleted file mode 100644 index 2d41eb9ad..000000000 --- a/docs/demos/config-provider/nesting/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 嵌套使用 - -配置注入时会动态合并上层提供的配置，再注入到下层。 diff --git a/docs/demos/confirm/api.en-US.md b/docs/demos/confirm/api.en-US.md deleted file mode 100644 index 5955026cd..000000000 --- a/docs/demos/confirm/api.en-US.md +++ /dev/null @@ -1,28 +0,0 @@ -### Preset Types - -```ts -type ConfirmType = 'default' | 'primary' | 'info' | 'success' | 'warning' | 'error' -type ConfirmAlign = 'left' | 'center' | 'right' -type ConfirmRenderFn = (options: ConfirmOptions, confirm: () => Promise, cancel: () => void) => any -``` - -### Confirm Options - -| Name | Type | Description | Default | Since | -| --------------- | ------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ---------------- | -------- | -| content | `string` | The prompt content of the confirm | `''` | - | -| className | `ClassType` | The custom class name for the confirm | `null` | - | -| style | `StyleType` | Inline style for the confirm | `null` | - | -| confirmType | `ConfirmType` | Confirm button type | `'primary'` | - | -| confirmText | `string` | The content of the confirm button | `locale.confirm` | - | -| cancelText | `string` | The content of the cancel button | `locale.cancel` | - | -| maskClose | `boolean` | Whether be closed by the mask | `false` | - | -| icon | `Record \| (() => any)` | The icon of the confirm, rendered as the render function when passed in the function | `null` | - | -| iconColor | `string` | The color of the icon of the confirm | `''` | - | -| onBeforeConfirm | `() => unknown` | Set the callback before confirm, supports async function and `Promise`, returns `false` will prevent closing | `null` | - | -| renderer | `ConfirmRenderFn` | Use render function to render custom renderer | `null` | - | -| parseHtml | `boolean` | Whether to parse content as html | `false` | `2.0.14` | -| title | `string` | Then title of the confirm | `''` | `2.0.15` | -| closable | `boolean` | Whether to have a close button | `false` | `2.0.15` | -| contentAlign | `ConfirmAlign` | Alignment of content | `'center'` | `2.0.15` | -| actionsAlign | `ConfirmAlign` | Alignment of action buttons | `'center'` | `2.0.15` | diff --git a/docs/demos/confirm/api.zh-CN.md b/docs/demos/confirm/api.zh-CN.md deleted file mode 100644 index 20229714c..000000000 --- a/docs/demos/confirm/api.zh-CN.md +++ /dev/null @@ -1,28 +0,0 @@ -### 预设类型 - -```ts -type ConfirmType = 'default' | 'primary' | 'info' | 'success' | 'warning' | 'error' -type ConfirmAlign = 'left' | 'center' | 'right' -type ConfirmRenderFn = (options: ConfirmOptions, confirm: () => Promise, cancel: () => void) => any -``` - -### Confirm 选项 - -| 名称 | 类型 | 说明 | 默认值 | 始于 | -| --------------- | ------------------------------------ | ----------------------------------------------------------------------------- | ---------------- | -------- | -| content | `string` | 确认框的提示内容 | `''` | - | -| className | `ClassType` | 提示的自定义类名 | `null` | - | -| style | `StyleType` | 确认框的内联样式 | `null` | - | -| confirmType | `ConfirmType` | 确认按钮的类型 | `'primary'` | - | -| confirmText | `string` | 确认按钮的内容 | `locale.confirm` | - | -| cancelText | `string` | 取消按钮的内容 | `locale.cancel` | - | -| maskClose | `boolean` | 是否可以通过遮罩关闭 | `false` | - | -| icon | `Record \| (() => any)` | 确认框的图标，传入函数时作为 render 函数渲染 | `null` | - | -| iconColor | `string` | 确认框的图标的颜色 | `''` | - | -| onBeforeConfirm | `() => unknown` | 设置确认框的确认前回调，支持异步函数和 `Promise`，返回值为 `false` 会阻止关闭 | `null` | - | -| renderer | `ConfirmRenderFn` | 使用 render 函数渲染自定义渲染 | `null` | - | -| parseHtml | `boolean` | 是否将 `content` 作为 html 解析 | `false` | `2.0.14` | -| title | `string` | 确认框的标题 | `''` | `2.0.15` | -| closable | `boolean` | 是否具有关闭按钮 | `false` | `2.0.15` | -| contentAlign | `ConfirmAlign` | 内容的对齐 | `'center'` | `2.0.15` | -| actionsAlign | `ConfirmAlign` | 操作按钮的对齐 | `'center'` | `2.0.15` | diff --git a/docs/demos/confirm/basis/desc.en-US.md b/docs/demos/confirm/basis/desc.en-US.md deleted file mode 100644 index 93725244a..000000000 --- a/docs/demos/confirm/basis/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Basis Usage - -Simplest usage. Confirm is using `Promise` inside, which can be used with `async/await`. diff --git a/docs/demos/confirm/basis/desc.zh-CN.md b/docs/demos/confirm/basis/desc.zh-CN.md deleted file mode 100644 index 124f37faa..000000000 --- a/docs/demos/confirm/basis/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 基础用法 - -最简单的用法，确认框内部使用 `Promise` 实现，可以结合 `async/await` 使用。 diff --git a/docs/demos/confirm/demos-meta.json b/docs/demos/confirm/demos-meta.json deleted file mode 100644 index 6c1f7b33a..000000000 --- a/docs/demos/confirm/demos-meta.json +++ /dev/null @@ -1 +0,0 @@ -["basis", "type", "text", "icon", "title"] diff --git a/docs/demos/confirm/desc.en-US.md b/docs/demos/confirm/desc.en-US.md deleted file mode 100644 index 518dabb1e..000000000 --- a/docs/demos/confirm/desc.en-US.md +++ /dev/null @@ -1 +0,0 @@ -It is usually used for the secondary confirmation of some important operations to reduce the probability of user misoperation. diff --git a/docs/demos/confirm/desc.zh-CN.md b/docs/demos/confirm/desc.zh-CN.md deleted file mode 100644 index eca584bfa..000000000 --- a/docs/demos/confirm/desc.zh-CN.md +++ /dev/null @@ -1 +0,0 @@ -通常用于一些重要操作的二次确认，以降低用户误操作的概率。 diff --git a/docs/demos/confirm/icon/desc.en-US.md b/docs/demos/confirm/icon/desc.en-US.md deleted file mode 100644 index a800a89c9..000000000 --- a/docs/demos/confirm/icon/desc.en-US.md +++ /dev/null @@ -1,7 +0,0 @@ -### Custom Icon - -Set the `icon` prop to set the icon of the confirm. - -Set the `iconColor` prop to set the color of the confirm icon. - -When you need more fine-grained control of the icon, you can set `icon` as a function, it will as a custom rendering method. diff --git a/docs/demos/confirm/icon/desc.zh-CN.md b/docs/demos/confirm/icon/desc.zh-CN.md deleted file mode 100644 index 477930e1e..000000000 --- a/docs/demos/confirm/icon/desc.zh-CN.md +++ /dev/null @@ -1,7 +0,0 @@ -### 自定义图标 - -设置 `icon` 属性可以设置确认框的图标。 - -设置 `iconColor` 属性可以设置确认框图标的颜色。 - -当需要更细粒度地控制图标时，可以设置 `icon` 为函数，传函数时为自定义渲染方法。 diff --git a/docs/demos/confirm/text/desc.en-US.md b/docs/demos/confirm/text/desc.en-US.md deleted file mode 100644 index dc829d5df..000000000 --- a/docs/demos/confirm/text/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Button Text - -Set the `confirmType` and `cancelText` options to customize the content of the confirm and cancel buttons. diff --git a/docs/demos/confirm/text/desc.zh-CN.md b/docs/demos/confirm/text/desc.zh-CN.md deleted file mode 100644 index a3082765b..000000000 --- a/docs/demos/confirm/text/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 按钮文字 - -设置 `confirmType` 和 `cancelText` 选项自定义确认按钮和取消按钮的内容。 diff --git a/docs/demos/confirm/title/desc.en-US.md b/docs/demos/confirm/title/desc.en-US.md deleted file mode 100644 index 7e12ac851..000000000 --- a/docs/demos/confirm/title/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Add Title - -Setting the `title` option can add a title, so we can change the layout style. diff --git a/docs/demos/confirm/title/desc.zh-CN.md b/docs/demos/confirm/title/desc.zh-CN.md deleted file mode 100644 index 39c49a0c7..000000000 --- a/docs/demos/confirm/title/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 添加标题 - -设置 `title` 选项可以添加标题，于是我们可以换种布局风格。 diff --git a/docs/demos/confirm/type/desc.en-US.md b/docs/demos/confirm/type/desc.en-US.md deleted file mode 100644 index 66038aebe..000000000 --- a/docs/demos/confirm/type/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Confirm Type - -Set the `confirmType` option to change the type of the confirm button. diff --git a/docs/demos/confirm/type/desc.zh-CN.md b/docs/demos/confirm/type/desc.zh-CN.md deleted file mode 100644 index b8545ce80..000000000 --- a/docs/demos/confirm/type/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 确认类型 - -设置 `confirmType` 选项可以改变确认按钮的类型。 diff --git a/docs/demos/contextmenu/api.en-US.md b/docs/demos/contextmenu/api.en-US.md deleted file mode 100644 index 029204f1f..000000000 --- a/docs/demos/contextmenu/api.en-US.md +++ /dev/null @@ -1,22 +0,0 @@ -### Contextmenu Options - -| Name | Type | Description | Default | Since | -| ------- | -------------- | -------------------------------------------------------------------------------------------------------------------------------------- | ------- | ----- | -| clientX | `number` | Set the horizontal x position where the menu appears | `0` | - | -| clientY | `number` | Set the vertical y position where the menu appears | `0` | - | -| appear | `boolean` | Same as the appear property of vue native transition, set whether the menu has a transition effect when the menu is initially rendered | `false` | - | -| configs | `MenuConfig[]` | Set menu options, see Contextmenu configuration items below for specific properties | `[]` | - | - -### Contextmenu Config - -| Name | Type | Description | Default | Since | -| --------- | ------------------------------------ | --------------------------------------------------------------------------------- | ------- | ----- | -| key | `string \| number` | Unique identifier of the setting menu | `''` | - | -| label | `string` | Set the label of the menu, if not set, display the key value of the menu | `''` | - | -| icon | `Record \| (() => any)` | The icon of the menu, rendered as the render function when passed in the function | `null` | - | -| color | `string` | The menu color | `''` | - | -| iconColor | `string` | The color of the menu icon | `''` | - | -| shortcut | `string` | Set the content of the shortcut key hint | `''` | - | -| divided | `boolean` | Set whether to have a dividing line | `false` | - | -| disabled | `boolean` | Set whether to disable the option | `false` | - | -| children | `MenuConfig[]` | Set submenu options | `[]` | - | diff --git a/docs/demos/contextmenu/api.zh-CN.md b/docs/demos/contextmenu/api.zh-CN.md deleted file mode 100644 index 85a9aa468..000000000 --- a/docs/demos/contextmenu/api.zh-CN.md +++ /dev/null @@ -1,22 +0,0 @@ -### Contextmenu 选项 - -| 名称 | 类型 | 说明 | 默认值 | 始于 | -| ------- | -------------- | ------------------------------------------------------------------------- | ------- | ---- | -| clientX | `number` | 设置菜单出现的横向 x 位置 | `0` | - | -| clientY | `number` | 设置菜单出现的纵向 y 位置 | `0` | - | -| appear | `boolean` | 同 vue 原生 transition 的 appear 属性，设置菜单初始渲染时是否具有过渡效果 | `false` | - | -| configs | `MenuConfig[]` | 设置菜单选项，具体属性参考下方 Contextmenu 配置项 | `[]` | - | - -### Contextmenu 配置项 - -| 名称 | 类型 | 说明 | 默认值 | 始于 | -| --------- | ------------------------------------ | ------------------------------------------- | ------- | ---- | -| key | `string \| number` | 设置菜单的唯一标识 | `''` | - | -| label | `string` | 设置菜单的标签，未设置时则显示菜单的 key 值 | `''` | - | -| icon | `Record \| (() => any)` | 菜单的图标，传入函数时作为 render 函数渲染 | `null` | - | -| color | `string` | 菜单的颜色 | `''` | - | -| iconColor | `string` | 菜单的图标的颜色 | `''` | - | -| shortcut | `string` | 设置快捷键提示内容 | `''` | - | -| divided | `boolean` | 设置是否具有分割线 | `false` | - | -| disabled | `boolean` | 设置是否禁用选项 | `false` | - | -| children | `MenuConfig[]` | 设置子菜单的选项 | `[]` | - | diff --git a/docs/demos/contextmenu/basis/desc.en-US.md b/docs/demos/contextmenu/basis/desc.en-US.md deleted file mode 100644 index 8842b9d8b..000000000 --- a/docs/demos/contextmenu/basis/desc.en-US.md +++ /dev/null @@ -1,5 +0,0 @@ -### Basis Usage - -The simplest usage is to call the menu through the `contextmenu` event callback on the element that needs to add a context menu. - -Note that the `contextmenu` event needs to disable the default behavior to prevent the system menu from popping up. diff --git a/docs/demos/contextmenu/basis/desc.zh-CN.md b/docs/demos/contextmenu/basis/desc.zh-CN.md deleted file mode 100644 index 420ea67fb..000000000 --- a/docs/demos/contextmenu/basis/desc.zh-CN.md +++ /dev/null @@ -1,5 +0,0 @@ -### 基础用法 - -最简单的用法，在需要添加右键菜单的元素上通过 `contextmenu` 事件回调调用菜单。 - -需要注意的是，`contextmenu` 事件需要禁用默认行为以阻止弹出系统菜单。 diff --git a/docs/demos/contextmenu/demos-meta.json b/docs/demos/contextmenu/demos-meta.json deleted file mode 100644 index fcfe06a33..000000000 --- a/docs/demos/contextmenu/demos-meta.json +++ /dev/null @@ -1 +0,0 @@ -["basis", "nesting", "example"] diff --git a/docs/demos/contextmenu/desc.en-US.md b/docs/demos/contextmenu/desc.en-US.md deleted file mode 100644 index ab1cd6b9b..000000000 --- a/docs/demos/contextmenu/desc.en-US.md +++ /dev/null @@ -1 +0,0 @@ -For some pages with more interactive logic, some operations can be placed in the right-click menu to facilitate quick selection by users. diff --git a/docs/demos/contextmenu/desc.zh-CN.md b/docs/demos/contextmenu/desc.zh-CN.md deleted file mode 100644 index 6821b0ebd..000000000 --- a/docs/demos/contextmenu/desc.zh-CN.md +++ /dev/null @@ -1 +0,0 @@ -对于一些交互逻辑较多的页面，可以将一些操作置于右键菜单中，以方便用户快速选择。 diff --git a/docs/demos/contextmenu/example/desc.en-US.md b/docs/demos/contextmenu/example/desc.en-US.md deleted file mode 100644 index b75a37f94..000000000 --- a/docs/demos/contextmenu/example/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Comprehensive Example - -This use case shows how to set custom colors, how to set custom icons, how to disable options, how to set menu shortcuts, and how to add dividers for grouping. diff --git a/docs/demos/contextmenu/example/desc.zh-CN.md b/docs/demos/contextmenu/example/desc.zh-CN.md deleted file mode 100644 index ecb6c3da8..000000000 --- a/docs/demos/contextmenu/example/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 综合用例 - -这个用例展示了如何设置自定义颜色、如何设置自定义图标、如何禁用选项、如何设置菜单快捷键提示、如何添加分割线进行分组。 diff --git a/docs/demos/contextmenu/nesting/desc.en-US.md b/docs/demos/contextmenu/nesting/desc.en-US.md deleted file mode 100644 index e5805ec4a..000000000 --- a/docs/demos/contextmenu/nesting/desc.en-US.md +++ /dev/null @@ -1,5 +0,0 @@ -### Nesting Usage - -Nested menus can be configured via the `children` option. - -The Contextmenu component is encapsulated by the Dropdown component, so the key value structure returned after selecting the menu is consistent with the Dropdown component. diff --git a/docs/demos/contextmenu/nesting/desc.zh-CN.md b/docs/demos/contextmenu/nesting/desc.zh-CN.md deleted file mode 100644 index 56a8da175..000000000 --- a/docs/demos/contextmenu/nesting/desc.zh-CN.md +++ /dev/null @@ -1,5 +0,0 @@ -### 嵌套菜单 - -通过 `children` 选项可以配置嵌套的菜单。 - -Contextmenu 组件是通过 Dropdown 组件封装的，因此选择菜单后返回的 key 值结构与 Dropdown 组件是一致。 diff --git a/docs/demos/date-picker/api.en-US.md b/docs/demos/date-picker/api.en-US.md deleted file mode 100644 index 9fd7cffd7..000000000 --- a/docs/demos/date-picker/api.en-US.md +++ /dev/null @@ -1,81 +0,0 @@ -### Preset Types - -```ts -type DateType = 'year' | 'month' | 'date' -type TimeType = 'hour' | 'minute' | 'second' -type DateTimeType = DateType | TimeType -type Dateable = number | string | Date -``` - -### DatePicker Props - -| Name | Type | Description | Default | Since | -| --------------- | --------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------- | -------- | -| type | `'date' \| 'datetime' \| 'year' \| 'month'` | The type of date picker | `'date'` | - | -| value | `Dateable \| Dateable[]` | The value of the date selector, can use `v-model` two-way binding | `new Date()` | - | -| size | `'small' \| 'default' \| 'large'` | The size of input | `'default'` | - | -| state | `'default' \| 'success' \| 'error' \| 'warning'` | The state of the input | `'default'` | - | -| visible | `boolean` | Set the initial open state of the date selection panel, you can use `v-model` two-way binding | `false` | - | -| placement | `Placement` | The position where the date selection panel appears, the optional value is the same as Popper.js | `'bottom'` | - | -| transfer | `boolean \| string` | Set the rendering position of the date selection panel. When enabled but no valid selector is specified, the default rendering is to `` | `false` | - | -| format | `string` | In `datetime` type, it will control the display and hide of the time selection column according to whether it has `Hms` | `'yyyy-MM-dd HH:mm:ss'` | - | -| filler | `string` | Filler when the date is not selected, the length is fixed to 1 | `'-'` | - | -| ~~no-filler~~ | `boolean` | Whether to disable initial filling, if disabled, the current `value` | `false` | - | -| clearable | `boolean` | Whether to allow clearing of values | `false` | - | -| no-action | `boolean` | Whether to disable the bottom actions of the date selection panel and change the selection mode | `false` | - | -| labels | `Partial>` | set at each date or time unit tag following | `{}` | - | -| date-separator | `string` | The separator for date part | `'/'` | - | -| time-separator | `string` | The separator for time part | `':'` | - | -| shortcuts | `{ name: string, value: Dateable \| (() => Dateable) }[]` | Set the candidate list of date shortcuts | `[]` | - | -| disabled-date | `(date: Date) => boolean` | Determine whether the date is disabled, accept a date parameter, return `true` to disable | `() => false` | - | -| steps | `number[]` | Set the scroll span of each wheel of the date picker separately | `[1, 1, 1]` | - | -| ctrl-steps | `number[]` | Set the scroll span of each wheel of the date picker when Ctrl is held down | `[5, 5, 5]` | - | -| prefix | `Record` | The prefix icon, invalid when using prefix slot | `null` | - | -| prefix-color | `string` | The color of the prefix content, affects the prefix slot | `''` | - | -| suffix | `Record` | The suffix icon, invalid when using suffix slot | `null` | - | -| suffix-color | `string` | The color of the suffix content, which affects the suffix slot | `''` | - | -| no-suffix | `boolean` | Set whether to disable suffix icon | `false` | - | -| disabled | `boolean` | Set whether to disable the date picker | `false` | - | -| transition-name | `string` | Set the transition between show and hide of the date selection panel | `'vxp-drop'` | - | -| confirm-text | `string` | The text content of the date selection panel confirm button | `locale.confirm` | - | -| cancel-text | `string` | The text content of the cancel button of the date selection panel | `locale.cancel` | - | -| today | `Dateable` | Set as today's date, which mainly affects some of the performance of the calendar in the date selection panel | `new Date()` | - | -| ~~is-range~~ | `boolean` | Set whether to enable range selection mode | `false` | - | -| loading | `boolean` | Set whether is loading | `false` | `2.0.0` | -| loading-icon | `Record` | Set the loading icon | `Spinner` | `2.0.0` | -| loading-lock | `boolean` | Set whether to be read-only when loading | `false` | `2.0.0` | -| loading-effect | `string` | Set the effect animation for the loading icon | `false` | `2.1.0` | -| min | `Dateable` | Set the minimum date that can be selected | `null` | `2.0.14` | -| max | `Dateable` | Set the maximum date that can be selected | `null` | `2.0.14` | -| outside-close | `boolean` | Set whether the component can be closed by clicking outside | `true` | `2.0.20` | -| outside-cancel | `boolean` | Set whether clicking outside the component to close is a cancel operation | `false` | `2.0.20` | -| locale | `LocaleConfig['calendar'] & LocaleConfig['dataPicker']` | Set the locale config | `null` | `2.1.0` | -| range | `boolean` | Set whether to enable range selection mode | `false` | `2.1.1` | -| placeholder | `string \| string[]` | Set placeholder for date picker | `null` | `2.1.1` | -| unit-readonly | `boolean` | Set whether the input control is read-only | `false` | `2.1.2` | -| week-start | `number` | Set the first day of the week in date selection panel, the optional value is 0 ~ 7, where 0 is Sunday | `null` | `2.1.9` | - -### DatePicker Events - -| Name | Description | Parameters | Since | -| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------- | ----- | -| toggle | Emitted when the date panel display state changes, returns the current state | `(visible: boolean)` | - | -| foucs | Emitted when the control is focused, no return value | - | - | -| blur | Emitted when the control loses focus, no return value | - | - | -| change | Emitted when the selected time changes, depending on whether the date picker type is `'year'` and whether the range mode is enabled, it will return a year, year range, standard date or standard date range | `(value: string \| number \| number[] \| string[] \| null)` | - | -| change-col | Emitted when the selected date type changes, returns the name of the current type | `(type: DateTimeType \| null)` | - | -| input | Emitted when the value of any type of date entered by pressing the key changes, returns the name of the current type and the input value | `(type: DateTimeType, value: number)` | - | -| enter | Emitted when the enter key is used to confirm or the confirm button of the date selection panel is clicked, no return value | - | - | -| cancel | Emitted when the Esc key is closed or the cancel button of the date selection panel is clicked, no return value | - | - | -| shortcut | Emitted when a date is selected using the shortcut function, returns the name and value of the shortcut selection | `(name: string, value: number \| string \| Date)` | - | -| plus | Emitted when the date value is incremented using the up arrow key, returns the name of the type name and the corresponding value | `(type: DateTimeType, value: number)` | - | -| minus | Emitted when a date value is decremented using the down arrow key, returns the name of the type name and the value of the column | `(type: DateTimeType, value: number)` | - | -| clear | Emitted when the value is cleared by the clear button, no return value | - | - | - -### DatePicker Slots - -| Name | Description | Parameters | Since | -| -------- | ----------------------------------------------------------------- | ---------- | -------- | -| prefix | Slot for prefix content, usually a single icon | - | - | -| suffix | Slot for suffix content, usually a single icon | - | - | -| exchange | The slot for the middle separator when range selection is enabled | - | `2.0.14` | diff --git a/docs/demos/date-picker/api.zh-CN.md b/docs/demos/date-picker/api.zh-CN.md deleted file mode 100644 index a5d035331..000000000 --- a/docs/demos/date-picker/api.zh-CN.md +++ /dev/null @@ -1,81 +0,0 @@ -### 预设类型 - -```ts -type DateType = 'year' | 'month' | 'date' -type TimeType = 'hour' | 'minute' | 'second' -type DateTimeType = DateType | TimeType -type Dateable = number | string | Date -``` - -### DatePicker 属性 - -| 名称 | 类型 | 说明 | 默认值 | 始于 | -| --------------- | --------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------- | -------- | -| type | `'date' \| 'datetime' \| 'year' \| 'month'` | 日期选择器的类型 | `'date'` | - | -| value | `Dateable \| Dateable[]` | 日期选择器的值，可以使用 `v-model` 双向绑定 | `new Date()` | - | -| size | `'small' \| 'default' \| 'large'` | 输入框的大小 | `'default'` | - | -| state | `'default' \| 'success' \| 'error' \| 'warning'` | 输入框的状态 | `'default'` | - | -| visible | `boolean` | 设置日期选择面板的初始打开状态，可以使用 `v-model` 双向绑定 | `false` | - | -| placement | `Placement` | 日期选择面板的出现位置，可选值同 Popper.js | `'bottom'` | - | -| transfer | `boolean \| string` | 设置日期选择面板的渲染位置，开启但未指定有效选择器时默认渲染至 `` | `false` | - | -| format | `string` | 在 `datetime` 类型时会根据是否具有 `Hms` 来控制时间选择列的显示隐藏 | `'yyyy-MM-dd HH:mm:ss'` | - | -| filler | `string` | 日期未选择时的填充符，长度固定为 1 | `'-'` | - | -| ~~no-filler~~ | `boolean` | 是否禁用初始填充，如果禁用，初始化后控件内会显示当前 `value` | `false` | - | -| clearable | `boolean` | 是否允许清空值 | `false` | - | -| no-action | `boolean` | 是否禁用日期选择面板的底部操作栏并改变选择模式 | `false` | - | -| labels | `Partial>` | 设置在每个日期或时间单元后面的标签 | `{}` | - | -| date-separator | `string` | 日期部分的连接符 | `'/'` | - | -| time-separator | `string` | 时间部分的连接符 | `':'` | - | -| shortcuts | `{ name: string, value: Dateable \| (() => Dateable) }[]` | 设置日期快捷选择的候选列表 | `[]` | - | -| disabled-date | `(date: Date) => boolean` | 判断日期是否禁用，接受一个日期参数，返回 `true` 则禁用 | `() => false` | - | -| steps | `number[]` | 分别设置时间选择器每个滚轮的滚动跨度 | `[1, 1, 1]` | - | -| ctrl-steps | `number[]` | 分别设置时间选择器每个滚轮按住 Ctrl 时的滚动跨度 | `[5, 5, 5]` | - | -| prefix | `Record` | 前缀图标，使用前缀插槽时无效 | `null` | - | -| prefix-color | `string` | 前缀内容的颜色，会影响前缀插槽 | `''` | - | -| suffix | `Record` | 后缀图标，使用后缀插槽时无效 | `null` | - | -| suffix-color | `string` | 后缀内容的颜色，会影响后缀插槽 | `''` | - | -| no-suffix | `boolean` | 设置是否禁用后缀图标 | `false` | - | -| disabled | `boolean` | 设置是否禁用日期选择器 | `false` | - | -| transition-name | `string` | 设置日期选择面板的显示隐藏过渡效果 | `'vxp-drop'` | - | -| confirm-text | `string` | 日期选择面板确认按钮的文本内容 | `locale.confirm` | - | -| cancel-text | `string` | 日期选择面板取消按钮的文本内容 | `locale.cancel` | - | -| today | `Dateable` | 设置作为今天的日期，这主要会影响日期选择面板中日历的一些表现 | `new Date()` | - | -| ~~is-range~~ | `boolean` | 设置是否开启范围选择模式 | `false` | - | -| loading | `boolean` | 设置是否为加载中 | `false` | `2.0.0` | -| loading-icon | `Record` | 设置加载中的图标 | `Spinner` | `2.0.0` | -| loading-lock | `boolean` | 设置在加载中时是否为只读 | `false` | `2.0.0` | -| loading-lock | `boolean` | 设置在加载中时是否为只读 | `false` | `2.1.0` | -| min | `Dateable` | 设置可选的最小日期 | `null` | `2.0.14` | -| max | `Dateable` | 设置可选的最大日期 | `null` | `2.0.14` | -| outside-close | `boolean` | 设置是否可以通过点击组件外部进行关闭 | `true` | `2.0.20` | -| outside-cancel | `boolean` | 设置点击组件外部进行关闭是否为取消操作 | `false` | `2.0.20` | -| locale | `LocaleConfig['calendar'] & LocaleConfig['dataPicker']` | 设置多语言配置 | `null` | `2.1.0` | -| range | `boolean` | 设置是否开启范围选择模式 | `false` | `2.1.1` | -| placeholder | `string \| string[]` | 设置日期选择器的占位符 | `null` | `2.1.1` | -| unit-readonly | `boolean` | 设置输入框控件是否只读 | `false` | `2.1.2` | -| week-start | `number` | 设置日期选择面板中每星期的第一天，可选值为 0 ~ 7，其中 0 为星期天 | `null` | `2.1.9` | - -### DatePicker 事件 - -| 名称 | 说明 | 参数 | 始于 | -| ---------- | -------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------- | ---- | -| toggle | 当日期面板显示状态改变时触发，返回当前状态 | `(visible: boolean)` | - | -| foucs | 控件聚焦时触发，无返回值 | - | - | -| blur | 控件失去焦点时触发，无返回值 | - | - | -| change | 当选择的时间发生改变时触发，根据日期选择器类型是否为 `'year'` 以及是否开启了范围模式，会返回一个年份、年份范围、标准日期或标准日期范围 | `(value: string \| number \| number[] \| string[] \| null)` | - | -| change-col | 当选择的日期类型发生改变时触发，返回当前类型的名称 | `(type: DateTimeType \| null)` | - | -| input | 当通过按键输入任意类型日期的值发生改变时触发，返回当前类型的名称与输入的值 | `(type: DateTimeType, value: number)` | - | -| enter | 当使用回车键确定或点击了日期选择面板的确认按钮时触发，无返回值 | - | - | -| cancel | 当使用 Esc 按键关闭或点击了日期选择面板的取消按钮时触发，无返回值 | - | - | -| shortcut | 当使用快捷功能选择日期时触发，返回快捷选择的名称和值 | `(name: string, value: number \| string \| Date)` | - | -| plus | 当使用上箭头按键增加日期值时触发，返回类型名称的名称和对应的值 | `(type: DateTimeType, value: number)` | - | -| minus | 当使用下箭头按键减少日期值时触发，返回类型名称的名称和列应的值 | `(type: DateTimeType, value: number)` | - | -| clear | 当通过清除按钮清空值时触发，无返回值 | - | - | - -### DatePicker 插槽 - -| 名称 | 说明 | 参数 | 始于 | -| -------- | -------------------------------- | ---- | -------- | -| prefix | 前缀内容的插槽，一般为单个图标 | - | - | -| suffix | 后缀内容的插槽，一般为单个图标 | - | - | -| exchange | 开启范围选择时，中间分隔符的插槽 | - | `2.0.14` | diff --git a/docs/demos/date-picker/basis/desc.en-US.md b/docs/demos/date-picker/basis/desc.en-US.md deleted file mode 100644 index bf0677b5c..000000000 --- a/docs/demos/date-picker/basis/desc.en-US.md +++ /dev/null @@ -1,5 +0,0 @@ -### Basis Usage - -For basic usage, you can use `v-model:value` for two-way binding. - -By default, the date picker will appear unselected despite the initial value. diff --git a/docs/demos/date-picker/basis/desc.zh-CN.md b/docs/demos/date-picker/basis/desc.zh-CN.md deleted file mode 100644 index 12ec302c4..000000000 --- a/docs/demos/date-picker/basis/desc.zh-CN.md +++ /dev/null @@ -1,5 +0,0 @@ -### 基础用法 - -基础用法，可以使用 `v-model:value` 进行双向绑定。 - -默认情况下，尽管有初始值，日期选择框仍会呈现未未选择的状态。 diff --git a/docs/demos/date-picker/bound/desc.en-US.md b/docs/demos/date-picker/bound/desc.en-US.md deleted file mode 100644 index c5452deb0..000000000 --- a/docs/demos/date-picker/bound/desc.en-US.md +++ /dev/null @@ -1,7 +0,0 @@ -### Limit Range - -With the `min` and `max` props, you can quickly set the selectable range of dates. - -Normally, these two props will limit to form a single-sided or double-sided, if you want an intermediate limit, you can make the value of `min` larger than `max`. - -If they do not meet your needs, you should use the `disabled-date` prop. diff --git a/docs/demos/date-picker/bound/desc.zh-CN.md b/docs/demos/date-picker/bound/desc.zh-CN.md deleted file mode 100644 index 7c4559a57..000000000 --- a/docs/demos/date-picker/bound/desc.zh-CN.md +++ /dev/null @@ -1,7 +0,0 @@ -### 限制范围 - -通过 `min` 和 `max` 属性，可以快速的设置日期的可选范围。 - -常规情况下，这两个属性会限制形成单边或双边限制，如果你想要一个中间限制，你可以使 `min` 的值大于 `max`。 - -上述情况仍不满足需求的话，你应该使用 `disabled-date` 属性。 diff --git a/docs/demos/date-picker/demos-meta.json b/docs/demos/date-picker/demos-meta.json deleted file mode 100644 index 91b307d7a..000000000 --- a/docs/demos/date-picker/demos-meta.json +++ /dev/null @@ -1,12 +0,0 @@ -[ - "basis", - "type", - "labels", - "filler", - "unit-readonly", - "range", - "bound", - "shortcuts", - "no-action", - "loading" -] diff --git a/docs/demos/date-picker/desc.en-US.md b/docs/demos/date-picker/desc.en-US.md deleted file mode 100644 index ed856f103..000000000 --- a/docs/demos/date-picker/desc.en-US.md +++ /dev/null @@ -1 +0,0 @@ -Used to select or input a date. diff --git a/docs/demos/date-picker/desc.zh-CN.md b/docs/demos/date-picker/desc.zh-CN.md deleted file mode 100644 index ac9135490..000000000 --- a/docs/demos/date-picker/desc.zh-CN.md +++ /dev/null @@ -1 +0,0 @@ -用于选择或输入一个日期。 diff --git a/docs/demos/date-picker/filler/desc.en-US.md b/docs/demos/date-picker/filler/desc.en-US.md deleted file mode 100644 index f0b960ef9..000000000 --- a/docs/demos/date-picker/filler/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Custom Filler - -Setting the value of the `filler` prop, you can specify the filler in the input control when selecting. diff --git a/docs/demos/date-picker/filler/desc.zh-CN.md b/docs/demos/date-picker/filler/desc.zh-CN.md deleted file mode 100644 index 79312e5b3..000000000 --- a/docs/demos/date-picker/filler/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 自定义填充 - -设置 `filler` 属性的值可以修改选择输入框中的填充符。 diff --git a/docs/demos/date-picker/labels/desc.en-US.md b/docs/demos/date-picker/labels/desc.en-US.md deleted file mode 100644 index a5b4d2995..000000000 --- a/docs/demos/date-picker/labels/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Date Labels - -Set the value of the `labels` prop to add labels to each date unit, often used to add units. diff --git a/docs/demos/date-picker/labels/desc.zh-CN.md b/docs/demos/date-picker/labels/desc.zh-CN.md deleted file mode 100644 index 5e80c89e8..000000000 --- a/docs/demos/date-picker/labels/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 日期标签 - -设置 `labels` 属性的值可以为每个日期单元添加标签，常用于添加单位。 diff --git a/docs/demos/date-picker/loading/desc.en-US.md b/docs/demos/date-picker/loading/desc.en-US.md deleted file mode 100644 index 28d331dcb..000000000 --- a/docs/demos/date-picker/loading/desc.en-US.md +++ /dev/null @@ -1,5 +0,0 @@ -### Loading - -The loading state of the date picker can be controlled through the `loading` prop. - -If you want to be read-only when loading, you need to add the `loading-lock` prop. diff --git a/docs/demos/date-picker/loading/desc.zh-CN.md b/docs/demos/date-picker/loading/desc.zh-CN.md deleted file mode 100644 index 272c100c3..000000000 --- a/docs/demos/date-picker/loading/desc.zh-CN.md +++ /dev/null @@ -1,5 +0,0 @@ -### 加载状态 - -通过 `loading` 属性可以日期选择器器的加载状态。 - -如果你希望在加载中时为只读，你需要添加 `loading-lock` 属性。 diff --git a/docs/demos/date-picker/no-action/desc.en-US.md b/docs/demos/date-picker/no-action/desc.en-US.md deleted file mode 100644 index a439aad4d..000000000 --- a/docs/demos/date-picker/no-action/desc.en-US.md +++ /dev/null @@ -1,7 +0,0 @@ -### Directly Select - -If you want to be able to complete the select after a date is clicked, you can add the `no-action` prop to change the selection mode. - -Note that the `outside-cancel` prop will always take effect after adding this prop. - -When the `type` prop is `'datetime'`, it only disables the bottom action bar of the panel, and does not change the selection mode. diff --git a/docs/demos/date-picker/no-action/desc.zh-CN.md b/docs/demos/date-picker/no-action/desc.zh-CN.md deleted file mode 100644 index 3cb11d5b5..000000000 --- a/docs/demos/date-picker/no-action/desc.zh-CN.md +++ /dev/null @@ -1,7 +0,0 @@ -### 直接选择 - -有时候你希望可以选择了日期后即完成选择，那么可以添加 `no-action` 属性改变选择方式。 - -注意，添加了该属性后 `outside-cancel` 属性将始终生效。 - -在 `type` 属性为 `'datetime'` 时，仅会禁用面板的底部操作栏，并不会改变选择方式。 diff --git a/docs/demos/date-picker/range/desc.en-US.md b/docs/demos/date-picker/range/desc.en-US.md deleted file mode 100644 index 76676f2f2..000000000 --- a/docs/demos/date-picker/range/desc.en-US.md +++ /dev/null @@ -1,7 +0,0 @@ -### Range Select - -Add the `range` prop to enable range selection mode. - -In range selection mode, the return value of the date picker will become an array containing the start and end dates. - -When the selection type is `'datetime'`, it is recommended that the minimum width of the control be kept above 380px. diff --git a/docs/demos/date-picker/range/desc.zh-CN.md b/docs/demos/date-picker/range/desc.zh-CN.md deleted file mode 100644 index f1f9b8fc4..000000000 --- a/docs/demos/date-picker/range/desc.zh-CN.md +++ /dev/null @@ -1,7 +0,0 @@ -### 范围选择 - -添加 `range` 属性可以开启范围选择模式。 - -范围选择模式下，日期选择框的返回值将变为一个包含开始和结束日期的数组。 - -在选择类型为 `datetime` 时，建议控件的最小宽度保持在 380px 以上。 diff --git a/docs/demos/date-picker/shortcuts/desc.en-US.md b/docs/demos/date-picker/shortcuts/desc.en-US.md deleted file mode 100644 index 6e86dc740..000000000 --- a/docs/demos/date-picker/shortcuts/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Shortcuts - -Date shortcuts can be added via the `shortcuts` prop. diff --git a/docs/demos/date-picker/shortcuts/desc.zh-CN.md b/docs/demos/date-picker/shortcuts/desc.zh-CN.md deleted file mode 100644 index 7dfd50cc8..000000000 --- a/docs/demos/date-picker/shortcuts/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 快捷日期 - -通过 `shortcuts` 属性可以添加快捷日期。 diff --git a/docs/demos/date-picker/type/desc.en-US.md b/docs/demos/date-picker/type/desc.en-US.md deleted file mode 100644 index 4ac206ffb..000000000 --- a/docs/demos/date-picker/type/desc.en-US.md +++ /dev/null @@ -1,5 +0,0 @@ -### Control Type - -Setting the value of the `type` prop toggles the selection type of the date picker. - -When the selection type is `'year'`, the return value of the date picker will become the year of type number. diff --git a/docs/demos/date-picker/type/desc.zh-CN.md b/docs/demos/date-picker/type/desc.zh-CN.md deleted file mode 100644 index c42f899cd..000000000 --- a/docs/demos/date-picker/type/desc.zh-CN.md +++ /dev/null @@ -1,5 +0,0 @@ -### 控件类型 - -设置 `type` 属性的值可以切换日期选择框的选择类型。 - -当选择类型为 `year` 时，日期选择框的返回值将变为数字类型的年份。 diff --git a/docs/demos/date-picker/unit-readonly/desc.en-US.md b/docs/demos/date-picker/unit-readonly/desc.en-US.md deleted file mode 100644 index 0a76f319f..000000000 --- a/docs/demos/date-picker/unit-readonly/desc.en-US.md +++ /dev/null @@ -1,5 +0,0 @@ -### Input Readonly - -Add `unit-readonly` prop to make the input control read-only, and the user can only select date via the panel. - -Note that this will make impossible to type date, and the component lose some accessibility. diff --git a/docs/demos/date-picker/unit-readonly/desc.zh-CN.md b/docs/demos/date-picker/unit-readonly/desc.zh-CN.md deleted file mode 100644 index ca9b2acf7..000000000 --- a/docs/demos/date-picker/unit-readonly/desc.zh-CN.md +++ /dev/null @@ -1,5 +0,0 @@ -### 输入框只读 - -添加 `unit-readonly` 属性可以使输入框内的控件只读，用户只能通过面板选择日期。 - -注意，这将无法键入日期，使组件失去部分可访问性。 diff --git a/docs/demos/divider/api.en-US.md b/docs/demos/divider/api.en-US.md deleted file mode 100644 index 145332e19..000000000 --- a/docs/demos/divider/api.en-US.md +++ /dev/null @@ -1,8 +0,0 @@ -### Divider Props - -| Name | Type | Description | Default | Since | -| ------------- | ------------------------------- | ------------------------------------- | ---------- | ----- | -| vertical | `boolean` | Set whether the Divider is vertical | `false` | - | -| dashed | `boolean` | Set whether the Divider is dashed | `false` | - | -| text-position | `'left' \| 'center' \| 'right'` | Set the position of the embedded text | `'center'` | - | -| primary | `boolean` | Set embedded text to be more visible | `false` | - | diff --git a/docs/demos/divider/api.zh-CN.md b/docs/demos/divider/api.zh-CN.md deleted file mode 100644 index 39013f813..000000000 --- a/docs/demos/divider/api.zh-CN.md +++ /dev/null @@ -1,8 +0,0 @@ -### Divider 属性 - -| 名称 | 类型 | 说明 | 默认值 | 始于 | -| ------------- | ------------------------------- | -------------------------- | ---------- | ---- | -| vertical | `boolean` | 设置分割线是否为纵向 | `false` | - | -| dashed | `boolean` | 设置分割线是否为虚线 | `false` | - | -| text-position | `'left' \| 'center' \| 'right'` | 设置嵌入文字的位置 | `'center'` | - | -| primary | `boolean` | 设置嵌入文字为更显眼的状态 | `false` | - | diff --git a/docs/demos/divider/basis/desc.en-US.md b/docs/demos/divider/basis/desc.en-US.md deleted file mode 100644 index cf05a7d47..000000000 --- a/docs/demos/divider/basis/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Horizontal Divider - -The default is a horizontal dividing line, and text can be added in the middle. diff --git a/docs/demos/divider/basis/desc.zh-CN.md b/docs/demos/divider/basis/desc.zh-CN.md deleted file mode 100644 index 92881407c..000000000 --- a/docs/demos/divider/basis/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 水平分割线 - -默认为水平分割线，可在中间加入文字。 diff --git a/docs/demos/divider/demos-meta.json b/docs/demos/divider/demos-meta.json deleted file mode 100644 index 90523b643..000000000 --- a/docs/demos/divider/demos-meta.json +++ /dev/null @@ -1 +0,0 @@ -["basis", "text", "vertical"] diff --git a/docs/demos/divider/desc.en-US.md b/docs/demos/divider/desc.en-US.md deleted file mode 100644 index 4643a656a..000000000 --- a/docs/demos/divider/desc.en-US.md +++ /dev/null @@ -1 +0,0 @@ -The dividing line that separates the content is used to divide the text paragraphs of different chapters or divide the inline elements. diff --git a/docs/demos/divider/desc.zh-CN.md b/docs/demos/divider/desc.zh-CN.md deleted file mode 100644 index d1e8e166d..000000000 --- a/docs/demos/divider/desc.zh-CN.md +++ /dev/null @@ -1 +0,0 @@ -区隔内容的分割线，用于对不同章节的文本段落进行分割或者对行内元素进行分割。 diff --git a/docs/demos/divider/text/desc.en-US.md b/docs/demos/divider/text/desc.en-US.md deleted file mode 100644 index 16f7a5788..000000000 --- a/docs/demos/divider/text/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Text Position - -With `text-position` you can change the position of the text. diff --git a/docs/demos/divider/text/desc.zh-CN.md b/docs/demos/divider/text/desc.zh-CN.md deleted file mode 100644 index 8fa344361..000000000 --- a/docs/demos/divider/text/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 文字位置 - -通过 `text-position` 可以改变文字所在的位置。 diff --git a/docs/demos/divider/vertical/desc.en-US.md b/docs/demos/divider/vertical/desc.en-US.md deleted file mode 100644 index 871e6b673..000000000 --- a/docs/demos/divider/vertical/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Veritcal Divider - -Add `vertical` prop to make it vertical. diff --git a/docs/demos/divider/vertical/desc.zh-CN.md b/docs/demos/divider/vertical/desc.zh-CN.md deleted file mode 100644 index 0cacea066..000000000 --- a/docs/demos/divider/vertical/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 垂直分割线 - -添加 `vertical` 可以变成纵向分割线。 diff --git a/docs/demos/drawer/api.en-US.md b/docs/demos/drawer/api.en-US.md deleted file mode 100644 index 1a810e29b..000000000 --- a/docs/demos/drawer/api.en-US.md +++ /dev/null @@ -1,47 +0,0 @@ -### Drawer Props - -| Name | Type | Description | Default | Since | -| --------------- | ------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------- | -------- | -| active | `boolean` | Set whether the drawer is active | `false` | - | -| placement | `'top' \| 'right' \| 'bottom' \| 'left'` | Set the orientation of the drawer | `'right'` | - | -| width | `` number \| `${number}` \| `${number}%` `` | When placement is `right` or `left`, it is used to set the width of the drawer, can pass a percentage value | `280` | - | -| height | `` number \| `${number}` \| `${number}%` `` | When placement is `top` or `bottom`, it is used to set the width of the drawer, can pass a percentage value | `280` | - | -| title | `string` | Set the title of the drawer, it is invalid after using the title slot | `''` | - | -| closable | `boolean` | Set whether the drawer has a close function, a close button will be added when it is opened | `false` | - | -| inner | `boolean` | Set whether it is an inline drawer, after opening, the positioning will change from fixed to absolute | `false` | - | -| mask-close | `boolean` | Set whether to close the drawer by clicking on the mask layer | `true` | - | -| drawer-class | `ClassType` | Class name that defines the drawer container | `null` | - | -| hide-mask | `boolean` | Set whether to hide the mask layer | `false` | - | -| transfer | `boolean \| string` | Set the rendering position of the drawer, when set to `true`, it will render to `` by default | `false` | - | -| on-before-close | `(isConfirm?: boolean) => any` | Set the drawer's callback before closing, supports asynchronous functions and promises, the return value of `false` will prevent closing | `null` | - | -| resizable | `boolean` | Set whether the drawer can be resized, the width can be changed when it is a left and right drawer, and the height can be changed when it is a top and bottom drawer | `false` | - | -| footer | `boolean` | whether to add footer with action buttons | `false` | `2.0.0` | -| loading | `boolean` | Set whether the confirm button of the drawer is in the loading state | `false` | `2.0.0` | -| confirm-text | `string` | Confirm button content | `locale.confirm` | `2.0.0` | -| cancel-text | `string` | Cancel button content | `locale.cancel` | `2.0.0` | -| locale | `LocaleConfig['drawer']` | Set the locale config | `null` | `2.1.0` | -| auto-remove | `boolean` | Set whether to automatically remove when not active | `false` | `2.0.13` | - -### Drawer Events - -| Name | Description | Parameters | Since | -| ------------ | ----------------------------------------------------------------------------------------------------------------------- | ------------------------------------------- | ------- | -| toggle | Emitted when the active state of the drawer changes, returns the current active state | `(active: boolean)` | - | -| close | Emitted when the close function is used to trigger the close (including the closing of the mask layer), no return value | `(isConfirm: boolean)` | - | -| show | When the drawer is opened, emitted after the transition effect ends, no return value | - | - | -| hide | When the drawer is closed, emitted after the transition effect ends, no return value | - | - | -| resize-start | Emitted when the drawer is about to start resize, no return value | - | - | -| resize-move | Emitted when the drawer is being resized, returns an object containing the width and height of the drawer | `(rect: { width: number, height: number })` | - | -| resize-end | Emitted when the drawer has finished resize, no return value | `(rect: { width: number, height: number })` | - | -| confirm | Emitted when the bottom confirm button is clicked, no return value | - | `2.0.0` | -| cancel | Emitted when the cancel button at the bottom is clicked, no return value | - | `2.0.0` | - -### Drawer Slots - -| Name | Description | Parameters | Since | -| ------- | ---------------------------------- | ----------------------- | ------- | -| default | The content slot for drawer | - | - | -| title | The title slot for drawer | - | - | -| close | The close action slot for drawer | - | - | -| handler | The resize handler slot for drawer | `{ resizing: boolean }` | - | -| footer | The footer slot for drawer | - | `2.0.0` | diff --git a/docs/demos/drawer/api.zh-CN.md b/docs/demos/drawer/api.zh-CN.md deleted file mode 100644 index 8f38038b9..000000000 --- a/docs/demos/drawer/api.zh-CN.md +++ /dev/null @@ -1,47 +0,0 @@ -### Drawer 属性 - -| 名称 | 类型 | 说明 | 默认值 | 始于 | -| --------------- | ------------------------------------------- | ------------------------------------------------------------------------------ | ---------------- | -------- | -| active | `boolean` | 设置抽屉是否激活 | `false` | - | -| placement | `'top' \| 'right' \| 'bottom' \| 'left'` | 设置抽屉出现的方位 | `'right'` | - | -| width | `` number \| `${number}` \| `${number}%` `` | 当 placement 为 `right` 或 `left` 时用于设置抽屉的宽度，可以传入百分比值 | `280` | - | -| height | `` number \| `${number}` \| `${number}%` `` | 当 placement 为 `top` 或 `bottom` 时用于设置抽屉的宽度，可以传入百分比值 | `280` | - | -| title | `string` | 设置抽屉的标题，使用了 title 插槽后改属性无效 | `''` | - | -| closable | `boolean` | 设置抽屉是否具有关闭功能，开启时会添加关闭按钮 | `false` | - | -| inner | `boolean` | 设置是否为一个内联的抽屉，开启后定位从 fixed 变位 absolute | `false` | - | -| mask-close | `boolean` | 设置是否可以通关点击遮罩层关闭抽屉 | `true` | - | -| drawer-class | `ClassType` | 定义抽屉容器的类名 | `null` | - | -| hide-mask | `boolean` | 设置是否隐藏遮罩层 | `false` | - | -| transfer | `boolean \| string` | 设置抽屉的渲染位置，设置为 `true` 时默认渲染至 `` | `false` | - | -| on-before-close | `(isConfirm?: boolean) => any` | 设置抽屉的关闭前回调，支持异步函数和 Promise，返回值为 `false` 会阻止关闭 | `null` | - | -| resizable | `boolean` | 设置抽屉是否可以改变大小，当为左右抽屉时可以改变宽度，为上下抽屉时可以改变高度 | `false` | - | -| footer | `boolean` | 是否添加底部的操作按钮 | `false` | `2.0.0` | -| loading | `boolean` | 设置抽屉的确认按钮是否为加载状态 | `false` | `2.0.0` | -| confirm-text | `string` | 确认按钮的内容 | `locale.confirm` | `2.0.0` | -| cancel-text | `string` | 取消按钮的内容 | `locale.cancel` | `2.0.0` | -| locale | `LocaleConfig['drawer']` | 设置多语言配置 | `null` | `2.1.0` | -| auto-remove | `boolean` | 设置不显示时是否自动移除 | `false` | `2.0.13` | - -### Drawer 事件 - -| 名称 | 说明 | 参数 | 始于 | -| ------------ | ---------------------------------------------------- | ------------------------------------------- | ------- | -| toggle | 当抽屉的激活状态改变时触发，返回当前的激活状态 | `(active: boolean)` | - | -| close | 当用关闭功能触发关闭时 (包括遮罩层关闭) 触发 | `(isConfirm: boolean)` | - | -| show | 当抽屉打开后，过渡效果结束后触发，无返回值 | - | - | -| hide | 当抽屉关闭后，过渡效果结束后触发，无返回值 | - | - | -| resize-start | 当抽屉将要开始调整大小时触发，无返回值 | - | - | -| resize-move | 当抽屉正在调整大小时触发，返回一个包含抽屉宽高的对象 | `(rect: { width: number, height: number })` | - | -| resize-end | 当抽屉结束调整大小时触发，无返回值 | `(rect: { width: number, height: number })` | - | -| confirm | 当点击了底部的确定按钮时触发，无返回值 | - | `2.0.0` | -| cancel | 当点击了底部的取消按钮时触发，无返回值 | - | `2.0.0` | - -### Drawer 插槽 - -| 名称 | 说明 | 参数 | 始于 | -| ------- | ---------------------- | ----------------------- | ------- | -| default | 抽屉的内容插槽 | - | - | -| title | 抽屉的标题插槽 | - | - | -| close | 抽屉的关闭按钮插槽 | - | - | -| handler | 抽屉调整大小手柄的插槽 | `{ resizing: boolean }` | - | -| footer | 抽屉的底部插槽 | - | `2.0.0` | diff --git a/docs/demos/drawer/basis/desc.en-US.md b/docs/demos/drawer/basis/desc.en-US.md deleted file mode 100644 index 9536788f6..000000000 --- a/docs/demos/drawer/basis/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Basis Usage - -Simple usage, control the `active` prop through two-way binding to control the display of the drawer, and click the mask area to close the drawer. diff --git a/docs/demos/drawer/basis/desc.zh-CN.md b/docs/demos/drawer/basis/desc.zh-CN.md deleted file mode 100644 index 02d56cf47..000000000 --- a/docs/demos/drawer/basis/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 基础用法 - -简单的用法，通过双向绑定控制 `active` 属性进而控制抽屉显示，点击遮罩区域关闭抽屉。 diff --git a/docs/demos/drawer/demos-meta.json b/docs/demos/drawer/demos-meta.json deleted file mode 100644 index 631b80d68..000000000 --- a/docs/demos/drawer/demos-meta.json +++ /dev/null @@ -1,10 +0,0 @@ -[ - "basis", - "inner", - "nesting", - "position", - "long-content", - "hide-mask", - "footer", - "resize" -] diff --git a/docs/demos/drawer/desc.en-US.md b/docs/demos/drawer/desc.en-US.md deleted file mode 100644 index 37c45775f..000000000 --- a/docs/demos/drawer/desc.en-US.md +++ /dev/null @@ -1 +0,0 @@ -Drawer is a great option when you want to make something fly in from the sides of the screen. diff --git a/docs/demos/drawer/desc.zh-CN.md b/docs/demos/drawer/desc.zh-CN.md deleted file mode 100644 index c241b313b..000000000 --- a/docs/demos/drawer/desc.zh-CN.md +++ /dev/null @@ -1 +0,0 @@ -当你想要从屏幕的四边飞一些东西进来，抽屉是个不错的选择。 diff --git a/docs/demos/drawer/footer/desc.en-US.md b/docs/demos/drawer/footer/desc.en-US.md deleted file mode 100644 index a0e0f178a..000000000 --- a/docs/demos/drawer/footer/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Add Footer - -Add the `footer` prop to quickly add feet, or you can directly use the slot of the same name. diff --git a/docs/demos/drawer/footer/desc.zh-CN.md b/docs/demos/drawer/footer/desc.zh-CN.md deleted file mode 100644 index 3a3b8f67e..000000000 --- a/docs/demos/drawer/footer/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 添加脚部 - -添加 `footer` 属性可以快速添加脚部，或者你也可以直接使用同名插槽。 diff --git a/docs/demos/drawer/hide-mask/desc.en-US.md b/docs/demos/drawer/hide-mask/desc.en-US.md deleted file mode 100644 index 100b5eac9..000000000 --- a/docs/demos/drawer/hide-mask/desc.en-US.md +++ /dev/null @@ -1,5 +0,0 @@ -### Hide Mask - -Add `hide-mask` prop to turn off the drawer's masking effect. - -After turning off the mask effect, don't forget to provide other ways to turn it off. diff --git a/docs/demos/drawer/hide-mask/desc.zh-CN.md b/docs/demos/drawer/hide-mask/desc.zh-CN.md deleted file mode 100644 index a0e6ac8fc..000000000 --- a/docs/demos/drawer/hide-mask/desc.zh-CN.md +++ /dev/null @@ -1,5 +0,0 @@ -### 隐藏遮罩 - -添加 `hide-mask` 属性可以关闭抽屉的遮罩效果。 - -关闭了遮罩效果后，别忘了提供其他关闭途径。 diff --git a/docs/demos/drawer/inner/desc.en-US.md b/docs/demos/drawer/inner/desc.en-US.md deleted file mode 100644 index d28bbae14..000000000 --- a/docs/demos/drawer/inner/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Inner Drawer - -Adding the `inner` prop enables the drawer to be positioned according to the nearest element with the positioned attribute, thus implementing a built-in drawer. diff --git a/docs/demos/drawer/inner/desc.zh-CN.md b/docs/demos/drawer/inner/desc.zh-CN.md deleted file mode 100644 index fc9d1319e..000000000 --- a/docs/demos/drawer/inner/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 内置抽屉 - -添加 `inner` 属性可以使抽屉根据最近的具有定位属性的元素进行定位，从而实现内置抽屉。 diff --git a/docs/demos/drawer/long-content/desc.en-US.md b/docs/demos/drawer/long-content/desc.en-US.md deleted file mode 100644 index 2999b498d..000000000 --- a/docs/demos/drawer/long-content/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Long Content - -Can be used in combination with scroll component when the content is too long. diff --git a/docs/demos/drawer/long-content/desc.zh-CN.md b/docs/demos/drawer/long-content/desc.zh-CN.md deleted file mode 100644 index 7580ad560..000000000 --- a/docs/demos/drawer/long-content/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 长内容 - -当内容过长时，可以结合滚动组件一同使用。 diff --git a/docs/demos/drawer/nesting/desc.en-US.md b/docs/demos/drawer/nesting/desc.en-US.md deleted file mode 100644 index b8c668edc..000000000 --- a/docs/demos/drawer/nesting/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Nesting Usage - -In the content slot of the drawer, a new drawer can be opened, which can solve the situation that the content needs to be multi-layered and multi-branched. diff --git a/docs/demos/drawer/nesting/desc.zh-CN.md b/docs/demos/drawer/nesting/desc.zh-CN.md deleted file mode 100644 index c38f09a7a..000000000 --- a/docs/demos/drawer/nesting/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 嵌套用法 - -在抽屉的内容插槽内可以在打开新的抽屉，可以解决内容需要多层多分支的情况。 diff --git a/docs/demos/drawer/position/desc.en-US.md b/docs/demos/drawer/position/desc.en-US.md deleted file mode 100644 index 91f80c75f..000000000 --- a/docs/demos/drawer/position/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Custom Placement - -Set the `placement` prop to `top`, `right`, `bottom`, `left` to customize the position of the drawer. diff --git a/docs/demos/drawer/position/desc.zh-CN.md b/docs/demos/drawer/position/desc.zh-CN.md deleted file mode 100644 index c2500ae2f..000000000 --- a/docs/demos/drawer/position/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 自定义位置 - -设置 `placement` 属性的值为 `top`、`right`、`bottom`、`left` 可以自定义抽屉出现的位置。 diff --git a/docs/demos/drawer/resize/desc.en-US.md b/docs/demos/drawer/resize/desc.en-US.md deleted file mode 100644 index 68fd8f853..000000000 --- a/docs/demos/drawer/resize/desc.en-US.md +++ /dev/null @@ -1,5 +0,0 @@ -### Resizable - -Add the `resizable` prop to enable resizing of the drawer. - -Move the mouse to the edge of the drawer and a handle will appear. The width of the drawer in the left and right directions can be adjusted, and the height of the drawer in the up and down direction can be adjusted. diff --git a/docs/demos/drawer/resize/desc.zh-CN.md b/docs/demos/drawer/resize/desc.zh-CN.md deleted file mode 100644 index 50e29e4a0..000000000 --- a/docs/demos/drawer/resize/desc.zh-CN.md +++ /dev/null @@ -1,5 +0,0 @@ -### 调整大小 - -添加 `resizable` 属性可以开启抽屉的调整大小功能。 - -鼠标移至抽屉边缘会出现手柄，左右方向的抽屉可以调整宽度，上下方向的抽屉可以调整高度。 diff --git a/docs/demos/dropdown/api.en-US.md b/docs/demos/dropdown/api.en-US.md deleted file mode 100644 index 3555b97f3..000000000 --- a/docs/demos/dropdown/api.en-US.md +++ /dev/null @@ -1,45 +0,0 @@ -### Dropdown Props - -| Name | Type | Description | Default | Since | -| ------------- | -------------------------------- | ------------------------------------------------------------------------------------------------------------------ | ---------- | -------- | -| visible | `boolean` | The expanded state of the dropdown menu, you can use `v-model` two-way binding | `false` | - | -| label | `string \| number` | Index of item when nested | `null` | - | -| outside-close | `boolean` | Set whether to close by clicking outside | `true` | - | -| trigger | `'hover' \| 'click' \| 'csutom'` | The trigger method of the dropdown menu, when it is `custom`, all scenarios need to be manually controlled visible | `'hover'` | - | -| placement | `Placement` | The position of the menu list, the optional value is the same as Popper.js | `'bottom'` | - | -| transfer | `boolean \| string` | Set the rendering position of the menu list. When set to `true`, it will render to `` by default | `false` | - | -| meta | `Record` | The meta data for dropdown, used when nesting | `null` | `2.0.0` | -| alive | `boolean` | When enabled, the dropdown menu will only be hidden when is closed | `false` | `2.1.13` | -| custom | `boolean` | Whether custom dropdown content, it will disable nested process after it is enabled | `false` | `2.1.22` | - -### Dropdown Events - -| Name | Description | Parameters | Since | -| ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------- | ----- | -| toggle | Emitted when the expanded state of the dropdown menu changes, returns the current state | `(visible: boolean)` | - | -| select | Emitted when the lower-level item of the drop-down menu is selected, returns the label of the selected item, if it is nested, the multi-level values will be returned together by '-' concatenation | `(labels: (string \| number)[], metas: Record[])` | - | -| outside-click | Emitted when the outside of the element is clicked, no return value | - | - | -| outside-close | Emitted when the drop-down menu is closed by clicking outside the element, no return value | - | - | - -### Dropdown Slots - -| Name | Description | Parameters | Since | -| ------- | -------------------------------------------------------------------------------------------- | ---------- | ----- | -| default | The part of the dropdown that triggers the state change | - | - | -| drop | The candidate list of the drop-down menu, generally undertaken by the DropdownList component | - | - | - -### DropdownItem Props - -| Name | Type | Description | Default | Since | -| -------- | --------------------- | ------------------------------------------------------------------------------------------------------------- | ------- | ------- | -| label | `string \| number` | The unique index of the option, if not set, the option's textContent value will be used during initialization | `null` | - | -| disabled | `boolean` | Set whether to disable the option | `false` | - | -| selected | `boolean` | Set whether to be selected | `false` | - | -| divided | `boolean` | Set whether to add a dividing line, after setting it will add a dividing line below the options | `false` | - | -| meta | `Record` | The meta data for dropdown item | `null` | `2.0.0` | - -### DropdownItem Events - -| Name | Description | Parameters | Since | -| ------ | -------------------------------------------------------------------- | --------------------------- | ----- | -| select | Emitted when the option is selected, returns the label of the option | `(label: string \| number)` | - | diff --git a/docs/demos/dropdown/api.zh-CN.md b/docs/demos/dropdown/api.zh-CN.md deleted file mode 100644 index 316d10237..000000000 --- a/docs/demos/dropdown/api.zh-CN.md +++ /dev/null @@ -1,45 +0,0 @@ -### Dropdown 属性 - -| 名称 | 类型 | 说明 | 默认值 | 始于 | -| ------------- | -------------------------------- | -------------------------------------------------------------------- | ---------- | -------- | -| visible | `boolean` | 下拉菜单的展开状态，可以使用 `v-model` 双向绑定 | `false` | - | -| label | `string \| number` | 在嵌套使用的时候，作为 item 的索引 | `null` | - | -| outside-close | `boolean` | 设置是否可以通过点击外部关闭 | `true` | - | -| trigger | `'hover' \| 'click' \| 'csutom'` | 下拉菜单的触发方式，当为 `custom` 时，所有情景都需要手动控制 visible | `'hover'` | - | -| placement | `Placement` | 菜单列表的出现位置，可选值同 Popper.js | `'bottom'` | - | -| transfer | `boolean \| string` | 设置菜单列表的渲染位置，设置为 `true` 时默认渲染至 `` | `false` | - | -| meta | `Record` | 设置下拉菜单的元数据，用于嵌套的时候 | `null` | `2.0.0` | -| alive | `boolean` | 开启后，下拉菜单关闭后后仅隐藏，不会销毁 | `false` | `2.1.13` | -| custom | `boolean` | 标记是否为自定义下拉内容，开启后将不会进行嵌套处理 | `false` | `2.1.22` | - -### Dropdown 事件 - -| 名称 | 说明 | 参数 | 始于 | -| ------------- | --------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------- | ---- | -| toggle | 当下拉菜单的展开状态改变时触发，返回当前的状态 | `(visible: boolean)` | - | -| select | 当下拉菜单的下级 item 被选取时触发，返回被选取的 item 的 label，如果是嵌套使用时，多级的值会被 '-' 连接一同返回 | `(labels: (string \| number)[], metas: Record[])` | - | -| outside-click | 当点击了元素外部时触发，无返回值 | - | - | -| outside-close | 当点击了元素外部进行了下拉菜单的关闭时触发，无返回值 | - | - | - -### Dropdown 插槽 - -| 名称 | 说明 | 参数 | 始于 | -| ------- | ------------------------------------------------ | ---- | ---- | -| default | 下拉菜单的触发状态变化的部分 | - | - | -| drop | 下拉菜单的候选列表，一般由 DropdownList 组件承担 | - | - | - -### DropdownItem 属性 - -| 名称 | 类型 | 说明 | 默认值 | 始于 | -| -------- | --------------------- | ----------------------------------------------------------------- | ------- | ------- | -| label | `string \| number` | 选项的唯一索引，若不设置时，在初始化时会使用选项的 textContent 值 | `null` | - | -| disabled | `boolean` | 设置是否禁用选项 | `false` | - | -| selected | `boolean` | 设置是否为选中状态 | `false` | - | -| divided | `boolean` | 设置是否添加分割线，设置后将在选项下方添加分割线 | `false` | - | -| meta | `Record` | 设置菜单的元数据 | `null` | `2.0.0` | - -### DropdownItem 事件 - -| 名称 | 说明 | 参数 | 始于 | -| ------ | -------------------------------------- | --------------------------- | ---- | -| select | 当该选项被选择时触发，返回选项的 label | `(label: string \| number)` | - | diff --git a/docs/demos/dropdown/basis/desc.en-US.md b/docs/demos/dropdown/basis/desc.en-US.md deleted file mode 100644 index b8306ccd4..000000000 --- a/docs/demos/dropdown/basis/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Basis Usage - -Simplest dropdown menu. diff --git a/docs/demos/dropdown/basis/desc.zh-CN.md b/docs/demos/dropdown/basis/desc.zh-CN.md deleted file mode 100644 index c33c28dda..000000000 --- a/docs/demos/dropdown/basis/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 基本使用 - -最简单的下拉菜单。 diff --git a/docs/demos/dropdown/custom/desc.en-US.md b/docs/demos/dropdown/custom/desc.en-US.md deleted file mode 100644 index e47843a4e..000000000 --- a/docs/demos/dropdown/custom/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Custom Content - -In addition to using the built-in components, you can customize the content of the slot. diff --git a/docs/demos/dropdown/custom/desc.zh-CN.md b/docs/demos/dropdown/custom/desc.zh-CN.md deleted file mode 100644 index d9d22b2b8..000000000 --- a/docs/demos/dropdown/custom/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 自定义内容 - -除了使用内置的组件外，还可以自定义插槽中的内容。 diff --git a/docs/demos/dropdown/demos-meta.json b/docs/demos/dropdown/demos-meta.json deleted file mode 100644 index 1d1361a22..000000000 --- a/docs/demos/dropdown/demos-meta.json +++ /dev/null @@ -1 +0,0 @@ -["basis", "nesting", "custom"] diff --git a/docs/demos/dropdown/desc.en-US.md b/docs/demos/dropdown/desc.en-US.md deleted file mode 100644 index 92a92d93e..000000000 --- a/docs/demos/dropdown/desc.en-US.md +++ /dev/null @@ -1 +0,0 @@ -展示一组折叠的下拉菜单。 diff --git a/docs/demos/dropdown/desc.zh-CN.md b/docs/demos/dropdown/desc.zh-CN.md deleted file mode 100644 index 92a92d93e..000000000 --- a/docs/demos/dropdown/desc.zh-CN.md +++ /dev/null @@ -1 +0,0 @@ -展示一组折叠的下拉菜单。 diff --git a/docs/demos/dropdown/nesting/desc.en-US.md b/docs/demos/dropdown/nesting/desc.en-US.md deleted file mode 100644 index f37c90f15..000000000 --- a/docs/demos/dropdown/nesting/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Nesting Usage - -Dropdown can be nested to achieve cascading effects. diff --git a/docs/demos/dropdown/nesting/desc.zh-CN.md b/docs/demos/dropdown/nesting/desc.zh-CN.md deleted file mode 100644 index c6b0fc582..000000000 --- a/docs/demos/dropdown/nesting/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 嵌套使用 - -下拉菜单可以进行嵌套实现级联的效果。 diff --git a/docs/demos/ellipsis/api.en-US.md b/docs/demos/ellipsis/api.en-US.md deleted file mode 100644 index a18994172..000000000 --- a/docs/demos/ellipsis/api.en-US.md +++ /dev/null @@ -1,13 +0,0 @@ -### Ellipsis Props - -| Name | Type | Description | Default | Since | -| --------------- | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------ | -------- | -| placement | `Placement` | Set the position of the prompt bubble, the optional value is the same as Popper.js | `'top'` | - | -| transfer | `boolean \| string` | Set the rendering position of the prompt bubble. When set to `true`, it will render to `` by default | `'body'` | - | -| no-hover | `boolean` | Set whether to make the prompt bubble unhoverable | `false` | - | -| transition-name | `string` | Set the transition effect of showing and hiding the prompt gas | `'vxp-fade'` | - | -| tooltip-theme | `string` | Set the theme of the tooltip, optional values are `light`, `dark` | `'dark'` | - | -| tip-class | `ClassType` | Custom class name for tooltip content | `null` | - | -| max-lines | `number` | Set the max displayed lines, The multi-line mode will be enabled when passing an integer greater then `0`. It is powered by `-webkit-line-clamp` | `null` | - | -| tip-max-width | `number \| string` | Set the maximum width of the tooltip | `500` | `2.0.13` | -| tip-disabled | `boolean` | Whether to disable tooltip | `false` | `2.1.18` | diff --git a/docs/demos/ellipsis/api.zh-CN.md b/docs/demos/ellipsis/api.zh-CN.md deleted file mode 100644 index ae1b87eb9..000000000 --- a/docs/demos/ellipsis/api.zh-CN.md +++ /dev/null @@ -1,13 +0,0 @@ -### Ellipsis 属性 - -| 名称 | 类型 | 说明 | 默认值 | 始于 | -| --------------- | ------------------- | -------------------------------------------------------------------------------------- | ------------ | -------- | -| placement | `Placement` | 设置提示气泡出现的位置，可选值同 Popper.js | `'top'` | - | -| transfer | `boolean \| string` | 设置提示气泡渲染位置，设置为 `true` 时默认渲染至 `` | `'body'` | - | -| no-hover | `boolean` | 设置是否让提示气泡变得无法捕捉 | `false` | - | -| transition-name | `string` | 设置提示气的显示隐藏过渡效果 | `'vxp-fade'` | - | -| tooltip-theme | `string` | 设置提示气泡的主题，可选值为 `light`、`dark` | `'dark'` | - | -| tip-class | `ClassType` | 提示内容的自定义类名 | `null` | - | -| max-lines | `number` | 设置最大行数，传入一个大于 `0` 的整数后将开启多行模式，其实现基于 `-webkit-line-clamp` | `null` | - | -| tip-max-width | `number \| string` | 设置提示气泡的最大宽度 | `500` | `2.0.13` | -| tip-disabled | `boolean` | 是否禁用气泡提示 | `false` | `2.1.18` | diff --git a/docs/demos/ellipsis/basis/desc.en-US.md b/docs/demos/ellipsis/basis/desc.en-US.md deleted file mode 100644 index db92ba133..000000000 --- a/docs/demos/ellipsis/basis/desc.en-US.md +++ /dev/null @@ -1,5 +0,0 @@ -### Basis Usage - -The simplest usage, it will be displayed as omitted content when the length of the content exceeds the width of the wrapping element. - -And the full content will be displayed through Tooltip when the mouse is moved in. diff --git a/docs/demos/ellipsis/basis/desc.zh-CN.md b/docs/demos/ellipsis/basis/desc.zh-CN.md deleted file mode 100644 index c8a3b3443..000000000 --- a/docs/demos/ellipsis/basis/desc.zh-CN.md +++ /dev/null @@ -1,5 +0,0 @@ -### 基础用法 - -最简单的用法，当内容的长度超过包裹元素的宽度时，将会显示为省略内容。 - -并在鼠标移入时通过 Tooltip 展示完整内容。 diff --git a/docs/demos/ellipsis/demos-meta.json b/docs/demos/ellipsis/demos-meta.json deleted file mode 100644 index 941afeacc..000000000 --- a/docs/demos/ellipsis/demos-meta.json +++ /dev/null @@ -1 +0,0 @@ -["basis", "max-lines"] diff --git a/docs/demos/ellipsis/desc.en-US.md b/docs/demos/ellipsis/desc.en-US.md deleted file mode 100644 index 4c6e2989e..000000000 --- a/docs/demos/ellipsis/desc.en-US.md +++ /dev/null @@ -1 +0,0 @@ -This can be used when there is a piece of text that is too long to fit. diff --git a/docs/demos/ellipsis/desc.zh-CN.md b/docs/demos/ellipsis/desc.zh-CN.md deleted file mode 100644 index 5b975fd67..000000000 --- a/docs/demos/ellipsis/desc.zh-CN.md +++ /dev/null @@ -1 +0,0 @@ -当有一段长到放不下的文本时，可以派上用场。 diff --git a/docs/demos/ellipsis/max-lines/desc.en-US.md b/docs/demos/ellipsis/max-lines/desc.en-US.md deleted file mode 100644 index b2916318e..000000000 --- a/docs/demos/ellipsis/max-lines/desc.en-US.md +++ /dev/null @@ -1,3 +0,0 @@ -### Max Lines - -The max lines to be displayed can be set via the `max-lines` prop. The multi-line mode will be enabled when the prop is set to a valid number. diff --git a/docs/demos/ellipsis/max-lines/desc.zh-CN.md b/docs/demos/ellipsis/max-lines/desc.zh-CN.md deleted file mode 100644 index b150ea796..000000000 --- a/docs/demos/ellipsis/max-lines/desc.zh-CN.md +++ /dev/null @@ -1,3 +0,0 @@ -### 最大行数 - -通过 `max-lines` 属性可以设置显示的最大行数，当该属性设置了有效值后会开启多行省略模式。 diff --git a/docs/demos/form/api.en-US.md b/docs/demos/form/api.en-US.md deleted file mode 100644 index ea7f81327..000000000 --- a/docs/demos/form/api.en-US.md +++ /dev/null @@ -1,134 +0,0 @@ -### Preset Types - -```ts -type Types = - | 'string' - | 'number' - | 'boolean' - | 'int' - | 'float' - | 'array' - | 'object' - | 'date' - | 'url' - | 'color' - | 'email' -type Range = [number, number] -type ValidatorReslut = boolean | string | Error | Promise - -interface Rule { - required?: boolean, - type?: Types, - length?: number, - range?: Range, - strict?: boolean, - enums?: T[], - message?: string, - validator?(value: T, model: Record): ValidatorReslut -} -``` - -### Form Props - -| Name | Type | Description | Default | Since | -| ------------- | -------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | ----------- | ------- | -| method | `'get' \| 'post' \| 'put' \| 'delete'` | Set the method value of the native form object, which takes effect after setting the action | `'post'` | - | -| action | `string` | Set the action value of the native form tag | `null` | - | -| model | `Record` | The form data source | `{}` | - | -| rules | `Record` | The form validation rules | `{}` | - | -| label-width | `number \| 'auto'` | The width of the form label | `'auto'` | - | -| labell-align | `'right' \| 'top' \| 'left'` | The alignment of form labels | `'right'` | - | -| all-required | `boolean` | Set whether all form content is required | `false` | - | -| label-suffix | `string` | The suffix of the form label, such as `:` | `''` | - | -| hide-asterisk | `boolean` | Set whether to hide required asterisks | `false` | - | -| validate-all | `boolean` | Set whether to perform all rule validation during form validation (by default each field encounters an error and stops subsequent validation) | `false` | - | -| hide-label | `boolean` | Set whether to hide the form label, commonly used in login forms | `false` | - | -| disabled | `boolean` | Set whether to disable all controls under the form | `false` | `2.0.0` | -| loading | `boolean` | Set whether all controls under the form are loading | `false` | `2.0.0` | -| size | `'small' \| 'default' \| 'large'` | Set the size of all controls under the form | `'default'` | `2.0.0` | -| inline | `boolean` | Set whether the form is inline layout | `false` | `2.0.0` | -| gap | `number \| number[]` | Grid gap, refer to the prop of the same name of the Row component | `[8, 0]` | `2.0.0` | -| justify | `RowGridJustify` | Horizontal arrangement, refer to the prop of the same name of the Row component | `'start'` | `2.0.0` | -| align | `RowGridAlign` | Vertical alignment, refer to the prop of the same name of the Row component | `'top'` | `2.0.0` | - -### Form Methods - -| Name | Description | Signature | Since | -| ---------------- | ------------------------------------------------------------------------------------------ | -------------------------------------------------- | ----- | -| validate | Validate all fields of the form | `() => Promise` | - | -| validateFields | Validate the fields specified by the form according to the properties | `(props: string \| string[]) => Promise` | - | -| reset | resets all fields of the form | `() => void` | - | -| resetFields | Reset the fields specified by the form according to the properties | `(props: string \| string[]) => void` | - | -| clearError | Clear all error messages of the form | `() => void` | - | -| clearFieldsError | Clears the error information of the fields specified by the form according to the property | `(props: string \| string[]) => void` | - | - -### Form Slots - -| Name | Description | Parameters | Since | -| ------- | --------------------- | ---------- | ----- | -| default | Slot for form content | - | - | - -### FormItem Props - -| Name | Type | Description | Default | Since | -| ---------------- | ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ------- | -| label | `string` | label of the form field | `''` | - | -| prop | `string` | property of the form field | `''` | - | -| rules | `Rule \| Rule[]` | Validation specification for form fields | `[]` | - | -| label-width | `number` | width of the form field label | `null` | - | -| required | `boolean` | Set whether the field is required | `false` | - | -| html-for | `string` | `for` attribute of native `