diff --git a/docs/.vitepress/components/demo-preview.vue b/docs/.vitepress/components/demo-preview.vue deleted file mode 100644 index 4c8829f8..00000000 --- a/docs/.vitepress/components/demo-preview.vue +++ /dev/null @@ -1,45 +0,0 @@ - - - diff --git a/docs/.vitepress/components/index.ts b/docs/.vitepress/components/index.ts deleted file mode 100644 index 9430871e..00000000 --- a/docs/.vitepress/components/index.ts +++ /dev/null @@ -1 +0,0 @@ -export { default as DemoPreview } from './demo-preview.vue'; diff --git a/docs/.vitepress/components/preview-group.vue b/docs/.vitepress/components/preview-group.vue deleted file mode 100644 index 2fb02d3f..00000000 --- a/docs/.vitepress/components/preview-group.vue +++ /dev/null @@ -1,110 +0,0 @@ - - - diff --git a/docs/.vitepress/config/en.mts b/docs/.vitepress/config/en.mts deleted file mode 100644 index a74a7e5f..00000000 --- a/docs/.vitepress/config/en.mts +++ /dev/null @@ -1,231 +0,0 @@ -import type { DefaultTheme } from 'vitepress'; - -import { defineConfig } from 'vitepress'; - -import { version } from '../../../package.json'; - -export const en = defineConfig({ - description: 'Vben Admin & Enterprise level management system framework', - lang: 'en-US', - themeConfig: { - darkModeSwitchLabel: 'Theme', - darkModeSwitchTitle: 'Switch to Dark Mode', - docFooter: { - next: 'Next Page', - prev: 'Previous Page', - }, - editLink: { - pattern: - 'https://github.com/vbenjs/vue-vben-admin/edit/main/docs/src/:path', - text: 'Edit this page on GitHub', - }, - footer: { - copyright: `Copyright © 2020-${new Date().getFullYear()} Vben`, - message: 'Released under the MIT License.', - }, - langMenuLabel: 'Language', - lastUpdated: { - formatOptions: { - dateStyle: 'short', - timeStyle: 'medium', - }, - text: 'Last updated on', - }, - lightModeSwitchTitle: 'Switch to Light Mode', - nav: nav(), - outline: { - label: 'Navigate', - }, - returnToTopLabel: 'Back to top', - sidebar: { - '/en/commercial/': { - base: '/en/commercial/', - items: sidebarCommercial(), - }, - '/en/guide/': { base: '/en/guide/', items: sidebarGuide() }, - }, - }, -}); - -function sidebarGuide(): DefaultTheme.SidebarItem[] { - return [ - { - collapsed: false, - text: 'Introduction', - items: [ - { - link: 'introduction/vben', - text: 'About Vben Admin', - }, - { - link: 'introduction/why', - text: 'Why Choose Us?', - }, - { link: 'introduction/quick-start', text: 'Quick Start' }, - { link: 'introduction/thin', text: 'Lite Version' }, - ], - }, - { - text: 'Basics', - items: [ - { link: 'essentials/concept', text: 'Basic Concepts' }, - { link: 'essentials/development', text: 'Local Development' }, - { link: 'essentials/route', text: 'Routing and Menu' }, - { link: 'essentials/settings', text: 'Configuration' }, - { link: 'essentials/icons', text: 'Icons' }, - { link: 'essentials/styles', text: 'Styles' }, - { link: 'essentials/external-module', text: 'External Modules' }, - { link: 'essentials/build', text: 'Build and Deployment' }, - { link: 'essentials/server', text: 'Server Interaction and Data Mock' }, - ], - }, - { - text: 'Advanced', - items: [ - { link: 'in-depth/login', text: 'Login' }, - { link: 'in-depth/theme', text: 'Theme' }, - { link: 'in-depth/access', text: 'Access Control' }, - { link: 'in-depth/locale', text: 'Internationalization' }, - { link: 'in-depth/features', text: 'Common Features' }, - { link: 'in-depth/check-updates', text: 'Check Updates' }, - { link: 'in-depth/loading', text: 'Global Loading' }, - { link: 'in-depth/ui-framework', text: 'UI Framework Switching' }, - ], - }, - { - text: 'Engineering', - items: [ - { link: 'project/standard', text: 'Standards' }, - { link: 'project/cli', text: 'CLI' }, - { link: 'project/dir', text: 'Directory Explanation' }, - { link: 'project/test', text: 'Unit Testing' }, - { link: 'project/tailwindcss', text: 'Tailwind CSS' }, - { link: 'project/changeset', text: 'Changeset' }, - { link: 'project/vite', text: 'Vite Config' }, - ], - }, - { - text: 'Others', - items: [ - { link: 'other/project-update', text: 'Project Update' }, - { link: 'other/remove-code', text: 'Remove Code' }, - { link: 'other/faq', text: 'FAQ' }, - ], - }, - ]; -} - -function sidebarCommercial(): DefaultTheme.SidebarItem[] { - return [ - { - link: 'community', - text: 'Community', - }, - { - link: 'technical-support', - text: 'Technical-support', - }, - { - link: 'customized', - text: 'Customized', - }, - ]; -} - -function nav(): DefaultTheme.NavItem[] { - return [ - { - activeMatch: '^/en/(guide|components)/', - text: 'Doc', - items: [ - { - activeMatch: '^/en/guide/', - link: '/en/guide/introduction/vben', - text: 'Guide', - }, - // { - // activeMatch: '^/en/components/', - // link: '/en/components/introduction', - // text: 'Components', - // }, - { - text: 'Historical Versions', - items: [ - { - link: 'https://doc.vvbin.cn', - text: '2.x Version Documentation', - }, - ], - }, - ], - }, - { - text: 'Demo', - items: [ - { - text: 'Vben Admin', - items: [ - { - link: 'https://www.vben.pro', - text: 'Demo Version', - }, - { - link: 'https://ant.vben.pro', - text: 'Ant Design Vue Version', - }, - { - link: 'https://naive.vben.pro', - text: 'Naive Version', - }, - { - link: 'https://ele.vben.pro', - text: 'Element Plus Version', - }, - ], - }, - { - text: 'Others', - items: [ - { - link: 'https://vben.vvbin.cn', - text: 'Vben Admin 2.x', - }, - ], - }, - ], - }, - { - text: version, - items: [ - { - link: 'https://github.com/vbenjs/vue-vben-admin/releases', - text: 'Changelog', - }, - { - link: 'https://github.com/orgs/vbenjs/projects/5', - text: 'Roadmap', - }, - { - link: 'https://github.com/vbenjs/vue-vben-admin/blob/main/.github/contributing.md', - text: 'Contribution', - }, - ], - }, - { - link: '/commercial/technical-support', - text: '🦄 Tech Support', - }, - { - link: '/sponsor/personal', - text: '✨ Sponsor', - }, - { - link: '/commercial/community', - text: '👨‍👦‍👦 Community', - }, - // { - // link: '/friend-links/', - // text: '🤝 Friend Links', - // }, - ]; -} diff --git a/docs/.vitepress/config/index.mts b/docs/.vitepress/config/index.mts deleted file mode 100644 index 6b8cb81d..00000000 --- a/docs/.vitepress/config/index.mts +++ /dev/null @@ -1,25 +0,0 @@ -import { withPwa } from '@vite-pwa/vitepress'; -import { defineConfigWithTheme } from 'vitepress'; - -import { en } from './en.mts'; -import { shared } from './shared.mts'; -import { zh } from './zh.mts'; - -export default withPwa( - defineConfigWithTheme({ - ...shared, - locales: { - en: { - label: 'English', - lang: 'en', - link: '/en/', - ...en, - }, - root: { - label: '简体中文', - lang: 'zh-CN', - ...zh, - }, - }, - }), -); diff --git a/docs/.vitepress/config/plugins/demo-preview.ts b/docs/.vitepress/config/plugins/demo-preview.ts deleted file mode 100644 index 03b1698c..00000000 --- a/docs/.vitepress/config/plugins/demo-preview.ts +++ /dev/null @@ -1,143 +0,0 @@ -import type { MarkdownEnv, MarkdownRenderer } from 'vitepress'; - -import crypto from 'node:crypto'; -import { readdirSync } from 'node:fs'; -import { join } from 'node:path'; - -export const rawPathRegexp = - // eslint-disable-next-line regexp/no-super-linear-backtracking, regexp/strict - /^(.+?(?:\.([\da-z]+))?)(#[\w-]+)?(?: ?{(\d+(?:[,-]\d+)*)? ?(\S+)?})? ?(?:\[(.+)])?$/; - -function rawPathToToken(rawPath: string) { - const [ - filepath = '', - extension = '', - region = '', - lines = '', - lang = '', - rawTitle = '', - ] = (rawPathRegexp.exec(rawPath) || []).slice(1); - - const title = rawTitle || filepath.split('/').pop() || ''; - - return { extension, filepath, lang, lines, region, title }; -} - -export const demoPreviewPlugin = (md: MarkdownRenderer) => { - md.core.ruler.after('inline', 'demo-preview', (state) => { - const insertComponentImport = (importString: string) => { - const index = state.tokens.findIndex( - (i) => i.type === 'html_block' && i.content.match(/\n`; - state.tokens.splice(0, 0, importComponent); - } else { - if (state.tokens[index]) { - const content = state.tokens[index].content; - state.tokens[index].content = content.replace( - '', - `${importString}\n`, - ); - } - } - }; - // Define the regular expression to match the desired pattern - const regex = /]*\sdir="([^"]*)"/g; - // Iterate through the Markdown content and replace the pattern - state.src = state.src.replaceAll(regex, (_match, dir) => { - const componentDir = join(process.cwd(), 'src', dir).replaceAll( - '\\', - '/', - ); - - let childFiles: string[] = []; - let dirExists = true; - - try { - childFiles = - readdirSync(componentDir, { - encoding: 'utf8', - recursive: false, - withFileTypes: false, - }) || []; - } catch { - dirExists = false; - } - - if (!dirExists) { - return ''; - } - - const uniqueWord = generateContentHash(componentDir); - - const ComponentName = `DemoComponent_${uniqueWord}`; - insertComponentImport( - `import ${ComponentName} from '${componentDir}/index.vue'`, - ); - const { path: _path } = state.env as MarkdownEnv; - - const index = state.tokens.findIndex((i) => i.content.match(regex)); - - if (!state.tokens[index]) { - return ''; - } - const firstString = 'index.vue'; - childFiles = childFiles.sort((a, b) => { - if (a === firstString) return -1; - if (b === firstString) return 1; - return a.localeCompare(b, 'en', { sensitivity: 'base' }); - }); - state.tokens[index].content = - `<${ComponentName}/> - `; - - const _dummyToken = new state.Token('', '', 0); - const tokenArray: Array = []; - childFiles.forEach((filename) => { - // const slotName = filename.replace(extname(filename), ''); - - const templateStart = new state.Token('html_inline', '', 0); - templateStart.content = `'; - tokenArray.push(templateEnd); - }); - const endTag = new state.Token('html_inline', '', 0); - endTag.content = ''; - tokenArray.push(endTag); - - state.tokens.splice(index + 1, 0, ...tokenArray); - - // console.log( - // state.md.renderer.render(state.tokens, state?.options ?? [], state.env), - // ); - return ''; - }); - }); -}; - -function generateContentHash(input: string, length: number = 10): string { - // 使用 SHA-256 生成哈希值 - const hash = crypto.createHash('sha256').update(input).digest('hex'); - - // 将哈希值转换为 Base36 编码，并取指定长度的字符作为结果 - return Number.parseInt(hash, 16).toString(36).slice(0, length); -} diff --git a/docs/.vitepress/config/shared.mts b/docs/.vitepress/config/shared.mts deleted file mode 100644 index c48cc609..00000000 --- a/docs/.vitepress/config/shared.mts +++ /dev/null @@ -1,172 +0,0 @@ -import type { PwaOptions } from '@vite-pwa/vitepress'; -import type { HeadConfig } from 'vitepress'; - -import { resolve } from 'node:path'; - -import { - viteArchiverPlugin, - viteVxeTableImportsPlugin, -} from '@vben/vite-config'; - -import { - GitChangelog, - GitChangelogMarkdownSection, -} from '@nolebase/vitepress-plugin-git-changelog/vite'; -import tailwind from 'tailwindcss'; -import { defineConfig, postcssIsolateStyles } from 'vitepress'; -import { - groupIconMdPlugin, - groupIconVitePlugin, -} from 'vitepress-plugin-group-icons'; - -import { demoPreviewPlugin } from './plugins/demo-preview'; -import { search as zhSearch } from './zh.mts'; - -export const shared = defineConfig({ - appearance: 'dark', - head: head(), - markdown: { - preConfig(md) { - md.use(demoPreviewPlugin); - md.use(groupIconMdPlugin); - }, - }, - pwa: pwa(), - srcDir: 'src', - themeConfig: { - i18nRouting: true, - logo: 'https://unpkg.com/@vbenjs/static-source@0.1.7/source/logo-v1.webp', - search: { - options: { - locales: { - ...zhSearch, - }, - }, - provider: 'local', - }, - siteTitle: 'Vben Admin', - socialLinks: [ - { icon: 'github', link: 'https://github.com/vbenjs/vue-vben-admin' }, - ], - }, - title: 'Vben Admin', - vite: { - build: { - chunkSizeWarningLimit: Infinity, - minify: 'terser', - }, - css: { - postcss: { - plugins: [ - tailwind(), - postcssIsolateStyles({ includeFiles: [/vp-doc\.css/] }), - ], - }, - preprocessorOptions: { - scss: { - api: 'modern', - }, - }, - }, - json: { - stringify: true, - }, - plugins: [ - GitChangelog({ - mapAuthors: [ - { - mapByNameAliases: ['Vben'], - name: 'vben', - username: 'anncwb', - }, - { - name: 'vince', - username: 'vince292007', - }, - { - name: 'Li Kui', - username: 'likui628', - }, - ], - repoURL: () => 'https://github.com/vbenjs/vue-vben-admin', - }), - GitChangelogMarkdownSection(), - viteArchiverPlugin({ outputDir: '.vitepress' }), - groupIconVitePlugin(), - await viteVxeTableImportsPlugin(), - ], - server: { - fs: { - allow: ['../..'], - }, - host: true, - port: 6173, - }, - - ssr: { - external: ['@vue/repl'], - }, - }, -}); - -function head(): HeadConfig[] { - return [ - ['meta', { content: 'Vbenjs Team', name: 'author' }], - [ - 'meta', - { - content: 'vben, vitejs, vite, shacdn-ui, vue', - name: 'keywords', - }, - ], - ['link', { href: '/favicon.ico', rel: 'icon', type: 'image/svg+xml' }], - [ - 'meta', - { - content: - 'width=device-width,initial-scale=1,minimum-scale=1.0,maximum-scale=1.0,user-scalable=no', - name: 'viewport', - }, - ], - ['meta', { content: 'vben admin docs', name: 'keywords' }], - ['link', { href: '/favicon.ico', rel: 'icon' }], - // [ - // 'script', - // { - // src: 'https://cdn.tailwindcss.com', - // }, - // ], - ]; -} - -function pwa(): PwaOptions { - return { - includeManifestIcons: false, - manifest: { - description: - 'Vben Admin is a modern admin dashboard template based on Vue 3. ', - icons: [ - { - sizes: '192x192', - src: 'https://unpkg.com/@vbenjs/static-source@0.1.7/source/pwa-icon-192.png', - type: 'image/png', - }, - { - sizes: '512x512', - src: 'https://unpkg.com/@vbenjs/static-source@0.1.7/source/pwa-icon-512.png', - type: 'image/png', - }, - ], - id: '/', - name: 'Vben Admin Doc', - short_name: 'vben_admin_doc', - theme_color: '#ffffff', - }, - outDir: resolve(process.cwd(), '.vitepress/dist'), - registerType: 'autoUpdate', - workbox: { - globPatterns: ['**/*.{css,js,html,svg,png,ico,txt,woff2}'], - maximumFileSizeToCacheInBytes: 5 * 1024 * 1024, - }, - }; -} diff --git a/docs/.vitepress/config/zh.mts b/docs/.vitepress/config/zh.mts deleted file mode 100644 index 2c3753de..00000000 --- a/docs/.vitepress/config/zh.mts +++ /dev/null @@ -1,358 +0,0 @@ -import type { DefaultTheme } from 'vitepress'; - -import { defineConfig } from 'vitepress'; - -import { version } from '../../../package.json'; - -export const zh = defineConfig({ - description: 'Vben Admin & 企业级管理系统框架', - lang: 'zh-Hans', - themeConfig: { - darkModeSwitchLabel: '主题', - darkModeSwitchTitle: '切换到深色模式', - docFooter: { - next: '下一页', - prev: '上一页', - }, - editLink: { - pattern: - 'https://github.com/vbenjs/vue-vben-admin/edit/main/docs/src/:path', - text: '在 GitHub 上编辑此页面', - }, - footer: { - copyright: `Copyright © 2020-${new Date().getFullYear()} Vben`, - message: '基于 MIT 许可发布.', - }, - langMenuLabel: '多语言', - lastUpdated: { - formatOptions: { - dateStyle: 'short', - timeStyle: 'medium', - }, - text: '最后更新于', - }, - lightModeSwitchTitle: '切换到浅色模式', - nav: nav(), - - outline: { - label: '页面导航', - }, - returnToTopLabel: '回到顶部', - - sidebar: { - '/commercial/': { base: '/commercial/', items: sidebarCommercial() }, - '/components/': { base: '/components/', items: sidebarComponents() }, - '/guide/': { base: '/guide/', items: sidebarGuide() }, - }, - sidebarMenuLabel: '菜单', - }, -}); - -function sidebarGuide(): DefaultTheme.SidebarItem[] { - return [ - { - collapsed: false, - text: '简介', - items: [ - { - link: 'introduction/vben', - text: '关于 Vben Admin', - }, - { - link: 'introduction/why', - text: '为什么选择我们?', - }, - { link: 'introduction/quick-start', text: '快速开始' }, - { link: 'introduction/thin', text: '精简版本' }, - { - base: '/', - link: 'components/introduction', - text: '组件文档', - }, - ], - }, - { - text: '基础', - items: [ - { link: 'essentials/concept', text: '基础概念' }, - { link: 'essentials/development', text: '本地开发' }, - { link: 'essentials/route', text: '路由和菜单' }, - { link: 'essentials/settings', text: '配置' }, - { link: 'essentials/icons', text: '图标' }, - { link: 'essentials/styles', text: '样式' }, - { link: 'essentials/external-module', text: '外部模块' }, - { link: 'essentials/build', text: '构建与部署' }, - { link: 'essentials/server', text: '服务端交互与数据Mock' }, - ], - }, - { - text: '深入', - items: [ - { link: 'in-depth/login', text: '登录' }, - // { link: 'in-depth/layout', text: '布局' }, - { link: 'in-depth/theme', text: '主题' }, - { link: 'in-depth/access', text: '权限' }, - { link: 'in-depth/locale', text: '国际化' }, - { link: 'in-depth/features', text: '常用功能' }, - { link: 'in-depth/check-updates', text: '检查更新' }, - { link: 'in-depth/loading', text: '全局loading' }, - { link: 'in-depth/ui-framework', text: '组件库切换' }, - ], - }, - { - text: '工程', - items: [ - { link: 'project/standard', text: '规范' }, - { link: 'project/cli', text: 'CLI' }, - { link: 'project/dir', text: '目录说明' }, - { link: 'project/test', text: '单元测试' }, - { link: 'project/tailwindcss', text: 'Tailwind CSS' }, - { link: 'project/changeset', text: 'Changeset' }, - { link: 'project/vite', text: 'Vite Config' }, - ], - }, - { - text: '其他', - items: [ - { link: 'other/project-update', text: '项目更新' }, - { link: 'other/remove-code', text: '移除代码' }, - { link: 'other/faq', text: '常见问题' }, - ], - }, - ]; -} - -function sidebarCommercial(): DefaultTheme.SidebarItem[] { - return [ - { - link: 'community', - text: '交流群', - }, - { - link: 'technical-support', - text: '技术支持', - }, - { - link: 'customized', - text: '定制开发', - }, - ]; -} - -function sidebarComponents(): DefaultTheme.SidebarItem[] { - return [ - { - text: '组件', - items: [ - { - link: 'introduction', - text: '介绍', - }, - ], - }, - { - collapsed: false, - text: '布局组件', - items: [ - { - link: 'layout-ui/page', - text: 'Page 页面', - }, - ], - }, - { - collapsed: false, - text: '通用组件', - items: [ - { - link: 'common-ui/vben-api-component', - text: 'ApiComponent Api组件包装器', - }, - { - link: 'common-ui/vben-alert', - text: 'Alert 轻量提示框', - }, - { - link: 'common-ui/vben-modal', - text: 'Modal 模态框', - }, - { - link: 'common-ui/vben-drawer', - text: 'Drawer 抽屉', - }, - { - link: 'common-ui/vben-form', - text: 'Form 表单', - }, - { - link: 'common-ui/vben-vxe-table', - text: 'Vxe Table 表格', - }, - { - link: 'common-ui/vben-count-to-animator', - text: 'CountToAnimator 数字动画', - }, - { - link: 'common-ui/vben-ellipsis-text', - text: 'EllipsisText 省略文本', - }, - ], - }, - ]; -} - -function nav(): DefaultTheme.NavItem[] { - return [ - { - activeMatch: '^/(guide|components)/', - text: '文档', - items: [ - { - activeMatch: '^/guide/', - link: '/guide/introduction/vben', - text: '指南', - }, - { - activeMatch: '^/components/', - link: '/components/introduction', - text: '组件', - }, - { - text: '历史版本', - items: [ - { - link: 'https://doc.vvbin.cn', - text: '2.x版本文档', - }, - ], - }, - ], - }, - { - text: '演示', - items: [ - { - text: 'Vben Admin', - items: [ - { - link: 'https://www.vben.pro', - text: '演示版本', - }, - { - link: 'https://ant.vben.pro', - text: 'Ant Design Vue 版本', - }, - { - link: 'https://naive.vben.pro', - text: 'Naive 版本', - }, - { - link: 'https://ele.vben.pro', - text: 'Element Plus版本', - }, - ], - }, - { - text: '其他', - items: [ - { - link: 'https://vben.vvbin.cn', - text: 'Vben Admin 2.x', - }, - ], - }, - ], - }, - { - text: version, - items: [ - { - link: 'https://github.com/vbenjs/vue-vben-admin/releases', - text: '更新日志', - }, - { - link: 'https://github.com/orgs/vbenjs/projects/5', - text: '路线图', - }, - { - link: 'https://github.com/vbenjs/vue-vben-admin/blob/main/.github/contributing.md', - text: '贡献', - }, - ], - }, - { - link: '/commercial/technical-support', - text: '🦄 技术支持', - }, - { - link: '/sponsor/personal', - text: '✨ 赞助', - }, - { - link: '/commercial/community', - text: '👨‍👦‍👦 交流群', - // items: [ - // { - // link: 'https://qun.qq.com/qqweb/qunpro/share?_wv=3&_wwv=128&appChannel=share&inviteCode=22ySzj7pKiw&businessType=9&from=246610&biz=ka&mainSourceId=share&subSourceId=others&jumpsource=shorturl#/pc', - // text: 'QQ频道', - // }, - // { - // link: 'https://qm.qq.com/cgi-bin/qm/qr?_wv=1027&k=mjZmlhgVzzUxvdxllB6C1vHpX8O8QRL0&authKey=DBdFbBwERmfaKY95JvRWqLCJIRGJAmKyZbrpzZ41EKDMZ5SR6MfbjOBaaNRN73fr&noverify=0&group_code=4286109', - // text: 'QQ群', - // }, - // { - // link: 'https://discord.gg/VU62jTecad', - // text: 'Discord', - // }, - // ], - }, - // { - // link: '/friend-links/', - // text: '🤝 友情链接', - // }, - ]; -} - -export const search: DefaultTheme.AlgoliaSearchOptions['locales'] = { - root: { - placeholder: '搜索文档', - translations: { - button: { - buttonAriaLabel: '搜索文档', - buttonText: '搜索文档', - }, - modal: { - errorScreen: { - helpText: '你可能需要检查你的网络连接', - titleText: '无法获取结果', - }, - footer: { - closeText: '关闭', - navigateText: '切换', - searchByText: '搜索提供者', - selectText: '选择', - }, - noResultsScreen: { - noResultsText: '无法找到相关结果', - reportMissingResultsLinkText: '点击反馈', - reportMissingResultsText: '你认为该查询应该有结果？', - suggestedQueryText: '你可以尝试查询', - }, - searchBox: { - cancelButtonAriaLabel: '取消', - cancelButtonText: '取消', - resetButtonAriaLabel: '清除查询条件', - resetButtonTitle: '清除查询条件', - }, - startScreen: { - favoriteSearchesTitle: '收藏', - noRecentSearchesText: '没有搜索历史', - recentSearchesTitle: '搜索历史', - removeFavoriteSearchButtonTitle: '从收藏中移除', - removeRecentSearchButtonTitle: '从搜索历史中移除', - saveRecentSearchButtonTitle: '保存至搜索历史', - }, - }, - }, - }, -}; diff --git a/docs/.vitepress/theme/components/site-layout.vue b/docs/.vitepress/theme/components/site-layout.vue deleted file mode 100644 index 96427d05..00000000 --- a/docs/.vitepress/theme/components/site-layout.vue +++ /dev/null @@ -1,96 +0,0 @@ - - - - - diff --git a/docs/.vitepress/theme/components/vben-contributors.vue b/docs/.vitepress/theme/components/vben-contributors.vue deleted file mode 100644 index 9b887d92..00000000 --- a/docs/.vitepress/theme/components/vben-contributors.vue +++ /dev/null @@ -1,29 +0,0 @@ - - - - - diff --git a/docs/.vitepress/theme/index.ts b/docs/.vitepress/theme/index.ts deleted file mode 100644 index 7d4d3dc2..00000000 --- a/docs/.vitepress/theme/index.ts +++ /dev/null @@ -1,29 +0,0 @@ -// https://vitepress.dev/guide/custom-theme -import type { EnhanceAppContext, Theme } from 'vitepress'; - -import { NolebaseGitChangelogPlugin } from '@nolebase/vitepress-plugin-git-changelog/client'; -import DefaultTheme from 'vitepress/theme'; - -import { DemoPreview } from '../components'; -import SiteLayout from './components/site-layout.vue'; -import VbenContributors from './components/vben-contributors.vue'; -import { initHmPlugin } from './plugins/hm'; - -import './styles'; - -import 'virtual:group-icons.css'; -import '@nolebase/vitepress-plugin-git-changelog/client/style.css'; - -export default { - async enhanceApp(ctx: EnhanceAppContext) { - const { app } = ctx; - app.component('VbenContributors', VbenContributors); - app.component('DemoPreview', DemoPreview); - app.use(NolebaseGitChangelogPlugin); - - // 百度统计 - initHmPlugin(); - }, - extends: DefaultTheme, - Layout: SiteLayout, -} satisfies Theme; diff --git a/docs/.vitepress/theme/plugins/hm.ts b/docs/.vitepress/theme/plugins/hm.ts deleted file mode 100644 index 5e0a9318..00000000 --- a/docs/.vitepress/theme/plugins/hm.ts +++ /dev/null @@ -1,28 +0,0 @@ -import { inBrowser } from 'vitepress'; - -const SITE_ID = '2e443a834727c065877c01d89921545e'; - -declare global { - interface Window { - _hmt: any; - } -} - -function registerAnalytics() { - window._hmt = window._hmt || []; - const script = document.createElement('script'); - script.innerHTML = `var _hmt = _hmt || []; - (function() { - var hm = document.createElement("script"); - hm.src = "https://hm.baidu.com/hm.js?${SITE_ID}"; - var s = document.getElementsByTagName("script")[0]; - s.parentNode.insertBefore(hm, s); - })()`; - document.querySelector('head')?.append(script); -} - -export function initHmPlugin() { - if (inBrowser && import.meta.env.PROD) { - registerAnalytics(); - } -} diff --git a/docs/.vitepress/theme/styles/base.css b/docs/.vitepress/theme/styles/base.css deleted file mode 100644 index 8eb423af..00000000 --- a/docs/.vitepress/theme/styles/base.css +++ /dev/null @@ -1,22 +0,0 @@ -html.dark { - color-scheme: dark; -} - -.dark .VPContent { - /* background-color: #14161a; */ -} - -.form-valid-error p { - margin: 0; -} - -/* 顶部导航栏选中项样式 */ -.VPNavBarMenuLink, -.VPNavBarMenuGroup { - border-bottom: 1px solid transparent; -} - -.VPNavBarMenuLink.active, -.VPNavBarMenuGroup.active { - border-bottom-color: var(--vp-c-brand-1); -} diff --git a/docs/.vitepress/theme/styles/index.ts b/docs/.vitepress/theme/styles/index.ts deleted file mode 100644 index 566e63f8..00000000 --- a/docs/.vitepress/theme/styles/index.ts +++ /dev/null @@ -1,4 +0,0 @@ -import '@vben/styles'; - -import './variables.css'; -import './base.css'; diff --git a/docs/.vitepress/theme/styles/variables.css b/docs/.vitepress/theme/styles/variables.css deleted file mode 100644 index 124bb0c4..00000000 --- a/docs/.vitepress/theme/styles/variables.css +++ /dev/null @@ -1,132 +0,0 @@ -/** - * Customize default theme styling by overriding CSS variables: - * https://github.com/vuejs/vitepress/blob/main/src/client/theme-default/styles/vars.css - */ - -/** - * Colors - * - * Each colors have exact same color scale system with 3 levels of solid - * colors with different brightness, and 1 soft color. - * - * - `XXX-1`: The most solid color used mainly for colored text. It must - * satisfy the contrast ratio against when used on top of `XXX-soft`. - * - * - `XXX-2`: The color used mainly for hover state of the button. - * - * - `XXX-3`: The color for solid background, such as bg color of the button. - * It must satisfy the contrast ratio with pure white (#ffffff) text on - * top of it. - * - * - `XXX-soft`: The color used for subtle background such as custom container - * or badges. It must satisfy the contrast ratio when putting `XXX-1` colors - * on top of it. - * - * The soft color must be semi transparent alpha channel. This is crucial - * because it allows adding multiple "soft" colors on top of each other - * to create a accent, such as when having inline code block inside - * custom containers. - * - * - `default`: The color used purely for subtle indication without any - * special meanings attched to it such as bg color for menu hover state. - * - * - `brand`: Used for primary brand colors, such as link text, button with - * brand theme, etc. - * - * - `tip`: Used to indicate useful information. The default theme uses the - * brand color for this by default. - * - * - `warning`: Used to indicate warning to the users. Used in custom - * container, badges, etc. - * - * - `danger`: Used to show error, or dangerous message to the users. Used - * in custom container, badges, etc. - * -------------------------------------------------------------------------- */ - -:root { - /* --vp-c-indigo-1: #4f69fd; */ - --vp-c-default-1: var(--vp-c-gray-1); - --vp-c-default-2: var(--vp-c-gray-2); - --vp-c-default-3: var(--vp-c-gray-3); - --vp-c-default-soft: var(--vp-c-gray-soft); - --vp-c-brand-1: var(--vp-c-indigo-1); - --vp-c-brand-2: var(--vp-c-indigo-2); - --vp-c-brand-3: var(--vp-c-indigo-3); - --vp-c-brand-soft: var(--vp-c-indigo-soft); - --vp-c-tip-1: var(--vp-c-brand-1); - --vp-c-tip-2: var(--vp-c-brand-2); - --vp-c-tip-3: var(--vp-c-brand-3); - --vp-c-tip-soft: var(--vp-c-brand-soft); - --vp-c-warning-1: var(--vp-c-yellow-1); - --vp-c-warning-2: var(--vp-c-yellow-2); - --vp-c-warning-3: var(--vp-c-yellow-3); - --vp-c-warning-soft: var(--vp-c-yellow-soft); - --vp-c-danger-1: var(--vp-c-red-1); - --vp-c-danger-2: var(--vp-c-red-2); - --vp-c-danger-3: var(--vp-c-red-3); - --vp-c-danger-soft: var(--vp-c-red-soft); - - /** - * Component: Button - * -------------------------------------------------------------------------- */ - - --vp-button-brand-border: transparent; - --vp-button-brand-text: var(--vp-c-white); - --vp-button-brand-bg: var(--vp-c-brand-3); - --vp-button-brand-hover-border: transparent; - --vp-button-brand-hover-text: var(--vp-c-white); - --vp-button-brand-hover-bg: var(--vp-c-brand-2); - --vp-button-brand-active-border: transparent; - --vp-button-brand-active-text: var(--vp-c-white); - --vp-button-brand-active-bg: var(--vp-c-brand-1); - - /** - * Component: Home - * -------------------------------------------------------------------------- */ - - --vp-home-hero-name-color: transparent; - --vp-home-hero-name-background: linear-gradient( - 120deg, - var(--vp-c-indigo-1) 30%, - #18cefe - ); - --vp-home-hero-image-background-image: linear-gradient( - -45deg, - #18cefe 50%, - #c279ed 50% - ); - --vp-home-hero-image-filter: blur(44px); - - /** - * Component: Custom Block - * -------------------------------------------------------------------------- */ - --vp-custom-block-tip-border: transparent; - --vp-custom-block-tip-text: var(--vp-c-text-1); - --vp-custom-block-tip-bg: var(--vp-c-brand-soft); - --vp-custom-block-tip-code-bg: var(--vp-c-brand-soft); - - /** - * modal zIndex - */ - --popup-z-index: 1000; -} - -@media (min-width: 640px) { - :root { - --vp-home-hero-image-filter: blur(56px); - } -} - -@media (min-width: 960px) { - :root { - --vp-home-hero-image-filter: blur(68px); - } -} - -/** - * Component: Algolia - * -------------------------------------------------------------------------- */ - -.DocSearch { - --docsearch-primary-color: var(--vp-c-brand-1) !important; -} diff --git a/docs/package.json b/docs/package.json deleted file mode 100644 index f17468c7..00000000 --- a/docs/package.json +++ /dev/null @@ -1,35 +0,0 @@ -{ - "name": "@vben/docs", - "version": "5.5.9", - "private": true, - "scripts": { - "build": "vitepress build", - "dev": "vitepress dev", - "docs:preview": "vitepress preview" - }, - "imports": { - "#/*": { - "node": "./src/_env/node/*", - "default": "./src/_env/*" - } - }, - "dependencies": { - "@vben-core/shadcn-ui": "workspace:*", - "@vben/common-ui": "workspace:*", - "@vben/locales": "workspace:*", - "@vben/plugins": "workspace:*", - "@vben/styles": "workspace:*", - "ant-design-vue": "catalog:", - "lucide-vue-next": "catalog:", - "medium-zoom": "catalog:", - "reka-ui": "catalog:", - "vitepress-plugin-group-icons": "catalog:" - }, - "devDependencies": { - "@nolebase/vitepress-plugin-git-changelog": "catalog:", - "@vben/vite-config": "workspace:*", - "@vite-pwa/vitepress": "catalog:", - "vitepress": "catalog:", - "vue": "catalog:" - } -} diff --git a/docs/src/_env/adapter/component.ts b/docs/src/_env/adapter/component.ts deleted file mode 100644 index ec3d0196..00000000 --- a/docs/src/_env/adapter/component.ts +++ /dev/null @@ -1,128 +0,0 @@ -/** - * 通用组件共同的使用的基础组件，原先放在 adapter/form 内部，限制了使用范围，这里提取出来，方便其他地方使用 - * 可用于 vben-form、vben-modal、vben-drawer 等组件使用, - */ - -import type { Component, SetupContext } from 'vue'; - -import type { BaseFormComponentType } from '@vben/common-ui'; - -import { h } from 'vue'; - -import { globalShareState } from '@vben/common-ui'; -import { $t } from '@vben/locales'; - -import { - AutoComplete, - Button, - Checkbox, - CheckboxGroup, - DatePicker, - Divider, - Input, - InputNumber, - InputPassword, - Mentions, - notification, - Radio, - RadioGroup, - RangePicker, - Rate, - Select, - Space, - Switch, - Textarea, - TimePicker, - TreeSelect, - Upload, -} from 'ant-design-vue'; - -const withDefaultPlaceholder = ( - component: T, - type: 'input' | 'select', -) => { - return (props: any, { attrs, slots }: Omit) => { - const placeholder = props?.placeholder || $t(`ui.placeholder.${type}`); - return h(component, { ...props, ...attrs, placeholder }, slots); - }; -}; - -// 这里需要自行根据业务组件库进行适配，需要用到的组件都需要在这里类型说明 -export type ComponentType = - | 'AutoComplete' - | 'Checkbox' - | 'CheckboxGroup' - | 'DatePicker' - | 'DefaultButton' - | 'Divider' - | 'Input' - | 'InputNumber' - | 'InputPassword' - | 'Mentions' - | 'PrimaryButton' - | 'Radio' - | 'RadioGroup' - | 'RangePicker' - | 'Rate' - | 'Select' - | 'Space' - | 'Switch' - | 'Textarea' - | 'TimePicker' - | 'TreeSelect' - | 'Upload' - | BaseFormComponentType; - -async function initComponentAdapter() { - const components: Partial> = { - // 如果你的组件体积比较大，可以使用异步加载 - // Button: () => - // import('xxx').then((res) => res.Button), - - AutoComplete, - Checkbox, - CheckboxGroup, - DatePicker, - // 自定义默认按钮 - DefaultButton: (props, { attrs, slots }) => { - return h(Button, { ...props, attrs, type: 'default' }, slots); - }, - Divider, - Input: withDefaultPlaceholder(Input, 'input'), - InputNumber: withDefaultPlaceholder(InputNumber, 'input'), - InputPassword: withDefaultPlaceholder(InputPassword, 'input'), - Mentions: withDefaultPlaceholder(Mentions, 'input'), - // 自定义主要按钮 - PrimaryButton: (props, { attrs, slots }) => { - return h(Button, { ...props, attrs, type: 'primary' }, slots); - }, - Radio, - RadioGroup, - RangePicker, - Rate, - Select: withDefaultPlaceholder(Select, 'select'), - Space, - Switch, - Textarea: withDefaultPlaceholder(Textarea, 'input'), - TimePicker, - TreeSelect: withDefaultPlaceholder(TreeSelect, 'select'), - Upload, - }; - - // 将组件注册到全局共享状态中 - globalShareState.setComponents(components); - - // 定义全局共享状态中的消息提示 - globalShareState.defineMessage({ - // 复制成功消息提示 - copyPreferencesSuccess: (title, content) => { - notification.success({ - description: content, - message: title, - placement: 'bottomRight', - }); - }, - }); -} - -export { initComponentAdapter }; diff --git a/docs/src/_env/adapter/form.ts b/docs/src/_env/adapter/form.ts deleted file mode 100644 index d8b51c25..00000000 --- a/docs/src/_env/adapter/form.ts +++ /dev/null @@ -1,47 +0,0 @@ -import type { - VbenFormSchema as FormSchema, - VbenFormProps, -} from '@vben/common-ui'; - -import type { ComponentType } from './component'; - -import { setupVbenForm, useVbenForm as useForm, z } from '@vben/common-ui'; -import { $t } from '@vben/locales'; - -import { initComponentAdapter } from './component'; - -initComponentAdapter(); -setupVbenForm({ - config: { - baseModelPropName: 'value', - // naive-ui组件的空值为null,不能是undefined，否则重置表单时不生效 - emptyStateValue: null, - modelPropNameMap: { - Checkbox: 'checked', - Radio: 'checked', - Switch: 'checked', - Upload: 'fileList', - }, - }, - defineRules: { - required: (value, _params, ctx) => { - if (value === undefined || value === null || value.length === 0) { - return $t('ui.formRules.required', [ctx.label]); - } - return true; - }, - selectRequired: (value, _params, ctx) => { - if (value === undefined || value === null) { - return $t('ui.formRules.selectRequired', [ctx.label]); - } - return true; - }, - }, -}); - -const useVbenForm = useForm; - -export { useVbenForm, z }; - -export type VbenFormSchema = FormSchema; -export type { VbenFormProps }; diff --git a/docs/src/_env/adapter/vxe-table.ts b/docs/src/_env/adapter/vxe-table.ts deleted file mode 100644 index bab7f3d3..00000000 --- a/docs/src/_env/adapter/vxe-table.ts +++ /dev/null @@ -1,70 +0,0 @@ -import { h } from 'vue'; - -import { setupVbenVxeTable, useVbenVxeGrid } from '@vben/plugins/vxe-table'; - -import { Button, Image } from 'ant-design-vue'; - -import { useVbenForm } from './form'; - -if (!import.meta.env.SSR) { - setupVbenVxeTable({ - configVxeTable: (vxeUI) => { - vxeUI.setConfig({ - grid: { - align: 'center', - border: false, - columnConfig: { - resizable: true, - }, - - formConfig: { - // 全局禁用vxe-table的表单配置，使用formOptions - enabled: false, - }, - minHeight: 180, - proxyConfig: { - autoLoad: true, - response: { - result: 'items', - total: 'total', - list: 'items', - }, - showActiveMsg: true, - showResponseMsg: false, - }, - round: true, - showOverflow: true, - size: 'small', - }, - }); - - // 表格配置项可以用 cellRender: { name: 'CellImage' }, - vxeUI.renderer.add('CellImage', { - renderTableDefault(_renderOpts, params) { - const { column, row } = params; - return h(Image, { src: row[column.field] }); - }, - }); - - // 表格配置项可以用 cellRender: { name: 'CellLink' }, - vxeUI.renderer.add('CellLink', { - renderTableDefault(renderOpts) { - const { props } = renderOpts; - return h( - Button, - { size: 'small', type: 'link' }, - { default: () => props?.text }, - ); - }, - }); - - // 这里可以自行扩展 vxe-table 的全局配置，比如自定义格式化 - // vxeUI.formats.add - }, - useVbenForm, - }); -} - -export { useVbenVxeGrid }; - -export type * from '@vben/plugins/vxe-table'; diff --git a/docs/src/_env/node/adapter/form.ts b/docs/src/_env/node/adapter/form.ts deleted file mode 100644 index a206c0d8..00000000 --- a/docs/src/_env/node/adapter/form.ts +++ /dev/null @@ -1,4 +0,0 @@ -export const useVbenForm = () => {}; -export const z = {}; -export type VbenFormSchema = any; -export type VbenFormProps = any; diff --git a/docs/src/_env/node/adapter/vxe-table.ts b/docs/src/_env/node/adapter/vxe-table.ts deleted file mode 100644 index 5ec409fb..00000000 --- a/docs/src/_env/node/adapter/vxe-table.ts +++ /dev/null @@ -1,3 +0,0 @@ -export type * from '@vben/plugins/vxe-table'; - -export const useVbenVxeGrid = () => {}; diff --git a/docs/src/commercial/community.md b/docs/src/commercial/community.md deleted file mode 100644 index 60d9f254..00000000 --- a/docs/src/commercial/community.md +++ /dev/null @@ -1,30 +0,0 @@ -# 社区交流 - -社区交流群主要是为了方便大家交流，提问，解答问题，分享经验等。偏自助方式，如果你有问题，可以通过以下方式加入社区交流群： - -- [QQ频道](https://pd.qq.com/s/16p8lvvob)：推荐！！！主要提供问题解答，分享经验等。 -- QQ群：[大群](https://qm.qq.com/q/MEmHoCLbG0)，[1群](https://qm.qq.com/q/YacMHPYAMu)、[2群](https://qm.qq.com/q/ajVKZvFICk)、[3群](https://qm.qq.com/q/36zdwThP2E)，[4群](https://qm.qq.com/q/sCzSlm3504)，[5群](https://qm.qq.com/q/ya9XrtbS6s)，主要的使用者交流群。 -- [Discord](https://discord.com/invite/VU62jTecad): 主要提供问题解答，分享经验等。 - -::: tip - -免费QQ群人数上限200，将会不定期清理。推荐加入QQ频道进行交流 - -::: - -## 微信群 - -作者主要通过微信群提供帮助，如果你有问题，可以通过以下方式加入微信群。 - -通过微信联系作者，注明加群来意： - -::: tip - -因为微信群人数有限制，加微信群要求： - -- 通过[赞助](../sponsor/personal.md)任意金额。 -- 发送赞助`截图`，备注`加入微信群`即可。 - -::: - - diff --git a/docs/src/commercial/customized.md b/docs/src/commercial/customized.md deleted file mode 100644 index 1f0bceca..00000000 --- a/docs/src/commercial/customized.md +++ /dev/null @@ -1,12 +0,0 @@ -# 定制开发 - -我们提供基于 Vben Admin 的技术支持服务及定制开发，基本需求我们都可以满足。 - -详细需求可添加作者了解，并注明来意： - -- 通过邮箱联系开发者： [ann.vben@gmail.com](mailto:ann.vben@gmail.com) -- 通过微信联系开发者： - - - -我们会在第一时间回复您，定制费用根据需求而定。 diff --git a/docs/src/commercial/technical-support.md b/docs/src/commercial/technical-support.md deleted file mode 100644 index ded9bf2d..00000000 --- a/docs/src/commercial/technical-support.md +++ /dev/null @@ -1,8 +0,0 @@ -# 技术支持 - -## 问题反馈 - -在使用项目的过程中，如果遇到问题，你可以先详细阅读本文档，未找到解决方案时，可以通过以下方式获取技术支持： - -- 通过 [GitHub Issues](https://github.com/vbenjs/vue-vben-admin/issues) -- 通过 [GitHub Discussions](https://github.com/vbenjs/vue-vben-admin/discussions) diff --git a/docs/src/components/common-ui/vben-alert.md b/docs/src/components/common-ui/vben-alert.md deleted file mode 100644 index 6541b665..00000000 --- a/docs/src/components/common-ui/vben-alert.md +++ /dev/null @@ -1,166 +0,0 @@ ---- -outline: deep ---- - -# Vben Alert 轻量提示框 - -框架提供的一些用于轻量提示的弹窗，仅使用js代码即可快速动态创建提示而不需要在template写任何代码。 - -::: info 应用场景 - -Alert提供的功能与Modal类似，但只适用于简单应用场景。例如临时性、动态地弹出模态确认框、输入框等。如果对弹窗有更复杂的需求，请使用VbenModal - -::: - -::: tip 注意 - -Alert提供的快捷方法alert、confirm、prompt动态创建的弹窗在已打开的情况下，不支持HMR（热更新），代码变更后需要关闭这些弹窗后重新打开。 - -::: - -::: tip README - -下方示例代码中的，存在一些主题色未适配、样式缺失的问题，这些问题只在文档内会出现，实际使用并不会有这些问题，可忽略，不必纠结。 - -::: - -## 基础用法 - -使用 `alert` 创建只有一个确认按钮的提示框。 - - - -使用 `confirm` 创建有确认和取消按钮的提示框。 - - - -使用 `prompt` 创建有确认和取消按钮、接受用户输入的提示框。 - - - -## useAlertContext - -当弹窗的content、footer、icon使用自定义组件时，在这些组件中可以使用 `useAlertContext` 获取当前弹窗的上下文对象，用来主动控制弹窗。 - -::: tip 注意 - -`useAlertContext`只能用在setup或者函数式组件中。 - -::: - -### Methods - -| 方法 | 描述 | 类型 | 版本要求 | -| --------- | ------------------ | -------- | -------- | -| doConfirm | 调用弹窗的确认操作 | ()=>void | >5.5.4 | -| doCancel | 调用弹窗的取消操作 | ()=>void | >5.5.4 | - -## 类型说明 - -```ts -/** 预置的图标类型 */ -export type IconType = 'error' | 'info' | 'question' | 'success' | 'warning'; - -export type BeforeCloseScope = { - /** 是否为点击确认按钮触发的关闭 */ - isConfirm: boolean; -}; - -/** - * alert 属性 - */ -export type AlertProps = { - /** 关闭前的回调，如果返回false，则终止关闭 */ - beforeClose?: ( - scope: BeforeCloseScope, - ) => boolean | Promise | undefined; - /** 边框 */ - bordered?: boolean; - /** 按钮对齐方式 */ - buttonAlign?: 'center' | 'end' | 'start'; - /** 取消按钮的标题 */ - cancelText?: string; - /** 是否居中显示 */ - centered?: boolean; - /** 确认按钮的标题 */ - confirmText?: string; - /** 弹窗容器的额外样式 */ - containerClass?: string; - /** 弹窗提示内容 */ - content: Component | string; - /** 弹窗内容的额外样式 */ - contentClass?: string; - /** 执行beforeClose回调期间，在内容区域显示一个loading遮罩*/ - contentMasking?: boolean; - /** 弹窗底部内容（与按钮在同一个容器中） */ - footer?: Component | string; - /** 弹窗的图标（在标题的前面） */ - icon?: Component | IconType; - /** - * 弹窗遮罩模糊效果 - */ - overlayBlur?: number; - /** 是否显示取消按钮 */ - showCancel?: boolean; - /** 弹窗标题 */ - title?: string; -}; - -/** prompt 属性 */ -export type PromptProps = { - /** 关闭前的回调，如果返回false，则终止关闭 */ - beforeClose?: (scope: { - isConfirm: boolean; - value: T | undefined; - }) => boolean | Promise | undefined; - /** 用于接受用户输入的组件 */ - component?: Component; - /** 输入组件的属性 */ - componentProps?: Recordable; - /** 输入组件的插槽 */ - componentSlots?: Recordable; - /** 默认值 */ - defaultValue?: T; - /** 输入组件的值属性名 */ - modelPropName?: string; -} & Omit; - -/** - * 函数签名 - * alert和confirm的函数签名相同。 - * confirm默认会显示取消按钮，而alert默认只有一个按钮 - * */ -export function alert(options: AlertProps): Promise; -export function alert( - message: string, - options?: Partial, -): Promise; -export function alert( - message: string, - title?: string, - options?: Partial, -): Promise; - -/** - * 弹出输入框的函数签名。 - * beforeClose的参数会传入用户当前输入的值 - * component指定接受用户输入的组件，默认为Input - * componentProps 为输入组件设置的属性数据 - * defaultValue 默认的值 - * modelPropName 输入组件的值属性名称。默认为modelValue - */ -export async function prompt( - options: Omit & { - beforeClose?: ( - scope: BeforeCloseScope & { - /** 输入组件的当前值 */ - value: T; - }, - ) => boolean | Promise | undefined; - component?: Component; - componentProps?: Recordable; - defaultValue?: T; - modelPropName?: string; - }, -): Promise; -``` diff --git a/docs/src/components/common-ui/vben-api-component.md b/docs/src/components/common-ui/vben-api-component.md deleted file mode 100644 index 2c84e56b..00000000 --- a/docs/src/components/common-ui/vben-api-component.md +++ /dev/null @@ -1,173 +0,0 @@ ---- -outline: deep ---- - -# Vben ApiComponent Api组件包装器 - -框架提供的API“包装器”，它一般不独立使用，主要用于包装其它组件，为目标组件提供自动获取远程数据的能力，但仍然保持了目标组件的原始用法。 - -::: info 写在前面 - -我们在各个应用的组件适配器中，使用ApiComponent包装了Select、TreeSelect组件，使得这些组件可以自动获取远程数据并生成选项。其它类似的组件（比如Cascader）如有需要也可以参考示例代码自行进行包装。 - -::: - -## 基础用法 - -通过 `component` 传入其它组件的定义，并配置相关的其它属性（主要是一些名称映射）。包装组件将通过`api`获取数据（`beforerFetch`、`afterFetch`将分别在`api`运行前、运行后被调用），使用`resultField`从中提取数组，使用`valueField`、`labelField`等来从数据中提取value和label（如果提供了`childrenField`，会将其作为树形结构递归处理每一级数据），之后将处理好的数据通过`optionsPropName`指定的属性传递给目标组件。 - -::: details 包装级联选择器,点击下拉时开始加载远程数据 - -```vue - - -``` - -::: - -## 并发和缓存 - -有些场景下可能需要使用多个ApiComponent，它们使用了相同的远程数据源（例如用在可编辑的表格中）。如果直接将请求后端接口的函数传递给api属性，则每一个实例都会访问一次接口，这会造成资源浪费，是完全没有必要的。Tanstack Query提供了并发控制、缓存、重试等诸多特性，我们可以将接口请求函数用useQuery包装一下再传递给ApiComponent，这样的话无论页面有多少个使用相同数据源的ApiComponent实例，都只会发起一次远程请求。演示效果请参考 [Playground vue-query](https://www.vben.pro/#/demos/features/vue-query)，具体代码请查看项目文件[concurrency-caching](https://github.com/vbenjs/vue-vben-admin/blob/main/playground/src/views/demos/features/vue-query/concurrency-caching.vue) - -## API - -### Props - -| 属性名 | 描述 | 类型 | 默认值 | 版本要求 | -| --- | --- | --- | --- | --- | -| modelValue(v-model) | 当前值 | `any` | - | - | -| component | 欲包装的组件（以下称为目标组件） | `Component` | - | - | -| numberToString | 是否将value从数字转为string | `boolean` | `false` | - | -| api | 获取数据的函数 | `(arg?: any) => Promise>` | - | - | -| params | 传递给api的参数 | `Record` | - | - | -| resultField | 从api返回的结果中提取options数组的字段名 | `string` | - | - | -| labelField | label字段名 | `string` | `label` | - | -| childrenField | 子级数据字段名，需要层级数据的组件可用 | `string` | `` | - | -| valueField | value字段名 | `string` | `value` | - | -| optionsPropName | 目标组件接收options数据的属性名称 | `string` | `options` | - | -| modelPropName | 目标组件的双向绑定属性名，默认为modelValue。部分组件可能为value | `string` | `modelValue` | - | -| immediate | 是否立即调用api | `boolean` | `true` | - | -| alwaysLoad | 每次`visibleEvent`事件发生时都重新请求数据 | `boolean` | `false` | - | -| beforeFetch | 在api请求之前的回调函数 | `AnyPromiseFunction` | - | - | -| afterFetch | 在api请求之后的回调函数 | `AnyPromiseFunction` | - | - | -| options | 直接传入选项数据，也作为api返回空数据时的后备数据 | `OptionsItem[]` | - | - | -| visibleEvent | 触发重新请求数据的事件名 | `string` | - | - | -| loadingSlot | 目标组件的插槽名称，用来显示一个"加载中"的图标 | `string` | - | - | -| autoSelect | 自动设置选项 | `'first' \| 'last' \| 'one'\| ((item: OptionsItem[]) => OptionsItem) \| false` | `false` | >5.5.4 | - -#### autoSelect 自动设置选项 - -如果当前值为undefined，在选项数据成功加载之后，自动从备选项中选择一个作为当前值。默认值为`false`，即不自动选择选项。注意：该属性不应用于多选组件。可选值有： - -- `"first"`：自动选择第一个选项 -- `"last"`：自动选择最后一个选项 -- `"one"`：有且仅有一个选项时，自动选择它 -- `自定义函数`：自定义选择逻辑，函数的参数为options，返回值为选择的选项 -- `false`：不自动选择选项 - -### Methods - -| 方法 | 描述 | 类型 | 版本要求 | -| --- | --- | --- | --- | -| getComponentRef | 获取被包装的组件的实例 | ()=>T | >5.5.4 | -| updateParam | 设置接口请求参数（将与params属性合并） | (newParams: Record)=>void | >5.5.4 | -| getOptions | 获取已加载的选项数据 | ()=>OptionsItem[] | >5.5.4 | -| getValue | 获取当前值 | ()=>any | >5.5.4 | diff --git a/docs/src/components/common-ui/vben-count-to-animator.md b/docs/src/components/common-ui/vben-count-to-animator.md deleted file mode 100644 index 5f3ec188..00000000 --- a/docs/src/components/common-ui/vben-count-to-animator.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -outline: deep ---- - -# Vben CountToAnimator 数字动画 - -框架提供的数字动画组件，支持数字动画效果。 - -> 如果文档内没有参数说明，可以尝试在在线示例内寻找 - -::: info 写在前面 - -如果你觉得现有组件的封装不够理想，或者不完全符合你的需求，大可以直接使用原生组件，亦或亲手封装一个适合的组件。框架提供的组件并非束缚，使用与否，完全取决于你的需求与自由。 - -::: - -## 基础用法 - -通过 `start-val` 和 `end-val`设置数字动画的开始值和结束值， 持续时间`3000`ms。 - - - -## 自定义前缀及分隔符 - -通过 `prefix` 和 `separator` 设置数字动画的前缀和分隔符。 - - - -### Props - -| 属性名 | 描述 | 类型 | 默认值 | -| ---------- | -------------- | --------- | -------- | -| startVal | 起始值 | `number` | `0` | -| endVal | 结束值 | `number` | `2021` | -| duration | 动画持续时间 | `number` | `1500` | -| autoplay | 自动执行 | `boolean` | `true` | -| prefix | 前缀 | `string` | - | -| suffix | 后缀 | `string` | - | -| separator | 分隔符 | `string` | `,` | -| color | 字体颜色 | `string` | - | -| useEasing | 是否开启动画 | `boolean` | `true` | -| transition | 动画效果 | `string` | `linear` | -| decimals | 保留小数点位数 | `number` | `0` | - -### Events - -| 事件名 | 描述 | 类型 | -| -------------- | -------------- | -------------- | -| started | 动画已开始 | `()=>void` | -| finished | 动画已结束 | `()=>void` | -| ~~onStarted~~ | ~~动画已开始~~ | ~~`()=>void`~~ | -| ~~onFinished~~ | ~~动画已结束~~ | ~~`()=>void`~~ | - -### Methods - -| 方法名 | 描述 | 类型 | -| ------ | ------------ | ---------- | -| start | 开始执行动画 | `()=>void` | -| reset | 重置 | `()=>void` | diff --git a/docs/src/components/common-ui/vben-drawer.md b/docs/src/components/common-ui/vben-drawer.md deleted file mode 100644 index 3a28cce7..00000000 --- a/docs/src/components/common-ui/vben-drawer.md +++ /dev/null @@ -1,156 +0,0 @@ ---- -outline: deep ---- - -# Vben Drawer 抽屉 - -框架提供的抽屉组件，支持`自动高度`、`loading`等功能。 - -> 如果文档内没有参数说明，可以尝试在在线示例内寻找 - -::: info 写在前面 - -如果你觉得现有组件的封装不够理想，或者不完全符合你的需求，大可以直接使用原生组件，亦或亲手封装一个适合的组件。框架提供的组件并非束缚，使用与否，完全取决于你的需求与自由。 - -::: - -::: tip README - -下方示例代码中的，存在一些国际化、主题色未适配问题，这些问题只在文档内会出现，实际使用并不会有这些问题，可忽略，不必纠结。 - -::: - -## 基础用法 - -使用 `useVbenDrawer` 创建最基础的抽屉。 - - - -## 组件抽离 - -Drawer 内的内容一般业务中，会比较复杂，所以我们可以将 drawer 内的内容抽离出来，也方便复用。通过 `connectedComponent` 参数，可以将内外组件进行连接，而不用其他任何操作。 - - - -## 自动计算高度 - -弹窗会自动计算内容高度，超过一定高度会出现滚动条，同时结合 `loading` 效果以及使用 `prepend-footer` 插槽。 - - - -## 使用 Api - -通过 `drawerApi` 可以调用 drawer 的方法以及使用 `setState` 更新 drawer 的状态。 - - - -## 数据共享 - -如果你使用了 `connectedComponent` 参数，那么内外组件会共享数据，比如一些表单回填等操作。可以用 `drawerApi` 来获取数据和设置数据，配合 `onOpenChange`，可以满足大部分的需求。 - - - -::: info 注意 - -- `VbenDrawer` 组件对于参数的处理优先级是 `slot` > `props` > `state`(通过api更新的状态以及useVbenDrawer参数)。如果你已经传入了 `slot` 或者 `props`，那么 `setState` 将不会生效，这种情况下你可以通过 `slot` 或者 `props` 来更新状态。 -- 如果你使用到了 `connectedComponent` 参数，那么会存在 2 个`useVbenDrawer`, 此时，如果同时设置了相同的参数，那么以内部为准（也就是没有设置 connectedComponent 的代码）。比如 同时设置了 `onConfirm`，那么以内部的 `onConfirm` 为准。`onOpenChange`事件除外，内外都会触发。 -- 使用了`connectedComponent`参数时，可以配置`destroyOnClose`属性来决定当关闭弹窗时，是否要销毁`connectedComponent`组件（重新创建`connectedComponent`组件，这将会把其内部所有的变量、状态、数据等恢复到初始状态。）。 -- 如果抽屉的默认行为不符合你的预期，可以在`src\bootstrap.ts`中修改`setDefaultDrawerProps`的参数来设置默认的属性，如默认隐藏全屏按钮，修改默认ZIndex等。 - -::: - -## API - -```ts -// Drawer 为弹窗组件 -// drawerApi 为弹窗的方法 -const [Drawer, drawerApi] = useVbenDrawer({ - // 属性 - // 事件 -}); -``` - -### Props - -所有属性都可以传入 `useVbenDrawer` 的第一个参数中。 - -| 属性名 | 描述 | 类型 | 默认值 | -| --- | --- | --- | --- | -| appendToMain | 是否挂载到内容区域（默认挂载到body） | `boolean` | `false` | -| connectedComponent | 连接另一个Drawer组件 | `Component` | - | -| destroyOnClose | 关闭时销毁 | `boolean` | `false` | -| title | 标题 | `string\|slot` | - | -| titleTooltip | 标题提示信息 | `string\|slot` | - | -| description | 描述信息 | `string\|slot` | - | -| isOpen | 弹窗打开状态 | `boolean` | `false` | -| loading | 弹窗加载状态 | `boolean` | `false` | -| closable | 显示关闭按钮 | `boolean` | `true` | -| closeIconPlacement | 关闭按钮位置 | `'left'\|'right'` | `right` | -| modal | 显示遮罩 | `boolean` | `true` | -| header | 显示header | `boolean` | `true` | -| footer | 显示footer | `boolean\|slot` | `true` | -| confirmLoading | 确认按钮loading状态 | `boolean` | `false` | -| closeOnClickModal | 点击遮罩关闭弹窗 | `boolean` | `true` | -| closeOnPressEscape | esc 关闭弹窗 | `boolean` | `true` | -| confirmText | 确认按钮文本 | `string\|slot` | `确认` | -| cancelText | 取消按钮文本 | `string\|slot` | `取消` | -| placement | 抽屉弹出位置 | `'left'\|'right'\|'top'\|'bottom'` | `right` | -| showCancelButton | 显示取消按钮 | `boolean` | `true` | -| showConfirmButton | 显示确认按钮 | `boolean` | `true` | -| class | modal的class，宽度通过这个配置 | `string` | - | -| contentClass | modal内容区域的class | `string` | - | -| footerClass | modal底部区域的class | `string` | - | -| headerClass | modal顶部区域的class | `string` | - | -| zIndex | 抽屉的ZIndex层级 | `number` | `1000` | -| overlayBlur | 遮罩模糊度 | `number` | - | - -::: info appendToMain - -`appendToMain`可以指定将抽屉挂载到内容区域，打开抽屉时，内容区域以外的部分（标签栏、导航菜单等等）不会被遮挡。默认情况下，抽屉会挂载到body上。但是：挂载到内容区域时，作为页面根容器的`Page`组件，需要设置`auto-content-height`属性，以便抽屉能够正确计算高度。 - -::: - -### Event - -以下事件，只有在 `useVbenDrawer({onCancel:()=>{}})` 中传入才会生效。 - -| 事件名 | 描述 | 类型 | 版本限制 | -| --- | --- | --- | --- | -| onBeforeClose | 关闭前触发，返回 `false`则禁止关闭 | `()=>boolean` | --- | -| onCancel | 点击取消按钮触发 | `()=>void` | --- | -| onClosed | 关闭动画播放完毕时触发 | `()=>void` | >5.5.2 | -| onConfirm | 点击确认按钮触发 | `()=>void` | --- | -| onOpenChange | 关闭或者打开弹窗时触发 | `(isOpen:boolean)=>void` | --- | -| onOpened | 打开动画播放完毕时触发 | `()=>void` | >5.5.2 | - -### Slots - -除了上面的属性类型包含`slot`，还可以通过插槽来自定义弹窗的内容。 - -| 插槽名 | 描述 | -| -------------- | -------------------------------------------------- | -| default | 默认插槽 - 弹窗内容 | -| prepend-footer | 取消按钮左侧 | -| center-footer | 取消按钮和确认按钮中间（不使用 footer 插槽时有效） | -| append-footer | 确认按钮右侧 | -| close-icon | 关闭按钮图标 | -| extra | 额外内容(标题右侧) | - -### drawerApi - -| 方法 | 描述 | 类型 | 版本限制 | -| --- | --- | --- | --- | -| setState | 动态设置弹窗状态属性 | `(((prev: ModalState) => Partial)\| Partial)=>drawerApi` | -| open | 打开弹窗 | `()=>void` | --- | -| close | 关闭弹窗 | `()=>void` | --- | -| setData | 设置共享数据 | `(data:T)=>drawerApi` | --- | -| getData | 获取共享数据 | `()=>T` | --- | -| useStore | 获取可响应式状态 | - | --- | -| lock | 将抽屉标记为提交中，锁定当前状态 | `(isLock:boolean)=>drawerApi` | >5.5.3 | -| unlock | lock方法的反操作，解除抽屉的锁定状态，也是lock(false)的别名 | `()=>drawerApi` | >5.5.3 | - -::: info lock - -`lock`方法用于锁定抽屉的状态，一般用于提交数据的过程中防止用户重复提交或者抽屉被意外关闭、表单数据被改变等等。当处于锁定状态时，抽屉的确认按钮会变为loading状态，同时禁用取消按钮和关闭按钮、禁止ESC或者点击遮罩等方式关闭抽屉、开启抽屉的spinner动画以遮挡弹窗内容。调用`close`方法关闭处于锁定状态的抽屉时，会自动解锁。要主动解除这种状态，可以调用`unlock`方法或者再次调用lock方法并传入false参数。 - -::: diff --git a/docs/src/components/common-ui/vben-ellipsis-text.md b/docs/src/components/common-ui/vben-ellipsis-text.md deleted file mode 100644 index ce6c0334..00000000 --- a/docs/src/components/common-ui/vben-ellipsis-text.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -outline: deep ---- - -# Vben EllipsisText 省略文本 - -框架提供的文本展示组件，可配置超长省略、tooltip提示、展开收起等功能。 - -> 如果文档内没有参数说明，可以尝试在在线示例内寻找 - -## 基础用法 - -通过默认插槽设置文本内容，`maxWidth`属性设置最大宽度。 - - - -## 可折叠的文本块 - -通过`line`设置折叠后的行数，`expand`属性设置是否支持展开收起。 - - - -## 自定义提示浮层 - -通过名为`tooltip`的插槽定制提示信息。 - - - -## 自动显示 tooltip - -通过`tooltip-when-ellipsis`设置，仅在文本长度超出导致省略号出现时才触发 tooltip。 - - - -## API - -### Props - -| 属性名 | 描述 | 类型 | 默认值 | -| --- | --- | --- | --- | -| expand | 支持点击展开或收起 | `boolean` | `false` | -| line | 文本最大行数 | `number` | `1` | -| maxWidth | 文本区域最大宽度 | `number \| string` | `'100%'` | -| placement | 提示浮层的位置 | `'bottom'\|'left'\|'right'\|'top'` | `'top'` | -| tooltip | 启用文本提示 | `boolean` | `true` | -| tooltipWhenEllipsis | 内容超出，自动启用文本提示 | `boolean` | `false` | -| ellipsisThreshold | 设置 tooltipWhenEllipsis 后才生效，文本截断检测的像素差异阈值，越大则判断越严格，如果碰见异常情况可以自己设置阈值 | `number` | `3` | -| tooltipBackgroundColor | 提示文本的背景颜色 | `string` | - | -| tooltipColor | 提示文本的颜色 | `string` | - | -| tooltipFontSize | 提示文本的大小 | `string` | - | -| tooltipMaxWidth | 提示浮层的最大宽度。如不设置则保持与文本宽度一致 | `number` | - | -| tooltipOverlayStyle | 提示框内容区域样式 | `CSSProperties` | `{ textAlign: 'justify' }` | - -### Events - -| 事件名 | 描述 | 类型 | -| ------------ | ------------ | -------------------------- | -| expandChange | 展开状态改变 | `(isExpand:boolean)=>void` | - -### Slots - -| 插槽名 | 描述 | -| ------- | -------------------------------- | -| tooltip | 启用文本提示时，用来定制提示内容 | diff --git a/docs/src/components/common-ui/vben-form.md b/docs/src/components/common-ui/vben-form.md deleted file mode 100644 index 48772bfa..00000000 --- a/docs/src/components/common-ui/vben-form.md +++ /dev/null @@ -1,587 +0,0 @@ ---- -outline: deep ---- - -# Vben Form 表单 - -框架提供的表单组件，可适配 `Element Plus`、`Ant Design Vue`、`Naive UI` 等框架。 - -> 如果文档内没有参数说明，可以尝试在在线示例内寻找 - -::: info 写在前面 - -如果你觉得现有组件的封装不够理想，或者不完全符合你的需求，大可以直接使用原生组件，亦或亲手封装一个适合的组件。框架提供的组件并非束缚，使用与否，完全取决于你的需求与自由。 - -::: - -## 适配器 - -表单底层使用 [vee-validate](https://vee-validate.logaretm.com/v4/) 进行表单验证，所以你可以使用 `vee-validate` 的所有功能。对于不同的 UI 框架，我们提供了适配器，以便更好的适配不同的 UI 框架。 - -### 适配器说明 - -每个应用都有不同的 UI 框架，所以在应用的 `src/adapter/form` 和 `src/adapter/component` 内部，你可以根据自己的需求，进行组件适配。下面是 `Ant Design Vue` 的适配器示例代码，可根据注释查看说明： - -::: details ant design vue 表单适配器 - -```ts -import type { - VbenFormSchema as FormSchema, - VbenFormProps, -} from '@vben/common-ui'; - -import type { ComponentType } from './component'; - -import { setupVbenForm, useVbenForm as useForm, z } from '@vben/common-ui'; -import { $t } from '@vben/locales'; - -setupVbenForm({ - config: { - // ant design vue组件库默认都是 v-model:value - baseModelPropName: 'value', - // 一些组件是 v-model:checked 或者 v-model:fileList - modelPropNameMap: { - Checkbox: 'checked', - Radio: 'checked', - Switch: 'checked', - Upload: 'fileList', - }, - }, - defineRules: { - // 输入项目必填国际化适配 - required: (value, _params, ctx) => { - if (value === undefined || value === null || value.length === 0) { - return $t('ui.formRules.required', [ctx.label]); - } - return true; - }, - // 选择项目必填国际化适配 - selectRequired: (value, _params, ctx) => { - if (value === undefined || value === null) { - return $t('ui.formRules.selectRequired', [ctx.label]); - } - return true; - }, - }, -}); - -const useVbenForm = useForm; - -export { useVbenForm, z }; -export type VbenFormSchema = FormSchema; -export type { VbenFormProps }; -``` - -::: - -::: details ant design vue 组件适配器 - -```ts -/** - * 通用组件共同的使用的基础组件，原先放在 adapter/form 内部，限制了使用范围，这里提取出来，方便其他地方使用 - * 可用于 vben-form、vben-modal、vben-drawer 等组件使用, - */ - -import type { BaseFormComponentType } from '@vben/common-ui'; - -import type { Component, SetupContext } from 'vue'; -import { h } from 'vue'; - -import { globalShareState, IconPicker } from '@vben/common-ui'; -import { $t } from '@vben/locales'; - -const AutoComplete = defineAsyncComponent( - () => import('ant-design-vue/es/auto-complete'), -); -const Button = defineAsyncComponent(() => import('ant-design-vue/es/button')); -const Checkbox = defineAsyncComponent( - () => import('ant-design-vue/es/checkbox'), -); -const CheckboxGroup = defineAsyncComponent(() => - import('ant-design-vue/es/checkbox').then((res) => res.CheckboxGroup), -); -const DatePicker = defineAsyncComponent( - () => import('ant-design-vue/es/date-picker'), -); -const Divider = defineAsyncComponent(() => import('ant-design-vue/es/divider')); -const Input = defineAsyncComponent(() => import('ant-design-vue/es/input')); -const InputNumber = defineAsyncComponent( - () => import('ant-design-vue/es/input-number'), -); -const InputPassword = defineAsyncComponent(() => - import('ant-design-vue/es/input').then((res) => res.InputPassword), -); -const Mentions = defineAsyncComponent( - () => import('ant-design-vue/es/mentions'), -); -const Radio = defineAsyncComponent(() => import('ant-design-vue/es/radio')); -const RadioGroup = defineAsyncComponent(() => - import('ant-design-vue/es/radio').then((res) => res.RadioGroup), -); -const RangePicker = defineAsyncComponent(() => - import('ant-design-vue/es/date-picker').then((res) => res.RangePicker), -); -const Rate = defineAsyncComponent(() => import('ant-design-vue/es/rate')); -const Select = defineAsyncComponent(() => import('ant-design-vue/es/select')); -const Space = defineAsyncComponent(() => import('ant-design-vue/es/space')); -const Switch = defineAsyncComponent(() => import('ant-design-vue/es/switch')); -const Textarea = defineAsyncComponent(() => - import('ant-design-vue/es/input').then((res) => res.Textarea), -); -const TimePicker = defineAsyncComponent( - () => import('ant-design-vue/es/time-picker'), -); -const TreeSelect = defineAsyncComponent( - () => import('ant-design-vue/es/tree-select'), -); -const Upload = defineAsyncComponent(() => import('ant-design-vue/es/upload')); - - -const withDefaultPlaceholder = ( - component: T, - type: 'input' | 'select', -) => { - return (props: any, { attrs, slots }: Omit) => { - const placeholder = props?.placeholder || $t(`ui.placeholder.${type}`); - return h(component, { ...props, ...attrs, placeholder }, slots); - }; -}; - -// 这里需要自行根据业务组件库进行适配，需要用到的组件都需要在这里类型说明 -export type ComponentType = - | 'AutoComplete' - | 'Checkbox' - | 'CheckboxGroup' - | 'DatePicker' - | 'DefaultButton' - | 'Divider' - | 'Input' - | 'InputNumber' - | 'InputPassword' - | 'Mentions' - | 'PrimaryButton' - | 'Radio' - | 'RadioGroup' - | 'RangePicker' - | 'Rate' - | 'Select' - | 'Space' - | 'Switch' - | 'Textarea' - | 'TimePicker' - | 'TreeSelect' - | 'Upload' - | 'IconPicker'; - | BaseFormComponentType; - -async function initComponentAdapter() { - const components: Partial> = { - // 如果你的组件体积比较大，可以使用异步加载 - // Button: () => - // import('xxx').then((res) => res.Button), - - AutoComplete, - Checkbox, - CheckboxGroup, - DatePicker, - // 自定义默认按钮 - DefaultButton: (props, { attrs, slots }) => { - return h(Button, { ...props, attrs, type: 'default' }, slots); - }, - Divider, - IconPicker, - Input: withDefaultPlaceholder(Input, 'input'), - InputNumber: withDefaultPlaceholder(InputNumber, 'input'), - InputPassword: withDefaultPlaceholder(InputPassword, 'input'), - Mentions: withDefaultPlaceholder(Mentions, 'input'), - // 自定义主要按钮 - PrimaryButton: (props, { attrs, slots }) => { - return h(Button, { ...props, attrs, type: 'primary' }, slots); - }, - Radio, - RadioGroup, - RangePicker, - Rate, - Select: withDefaultPlaceholder(Select, 'select'), - Space, - Switch, - Textarea: withDefaultPlaceholder(Textarea, 'input'), - TimePicker, - TreeSelect: withDefaultPlaceholder(TreeSelect, 'select'), - Upload, - }; - - // 将组件注册到全局共享状态中 - globalShareState.setComponents(components); - - // 定义全局共享状态中的消息提示 - globalShareState.defineMessage({ - // 复制成功消息提示 - copyPreferencesSuccess: (title, content) => { - notification.success({ - description: content, - message: title, - placement: 'bottomRight', - }); - }, - }); -} - -export { initComponentAdapter }; -``` - -::: - -## 基础用法 - -::: tip README - -下方示例代码中的，存在一些国际化、主题色未适配问题，这些问题只在文档内会出现，实际使用并不会有这些问题，可忽略，不必纠结。 - -::: - -使用 `useVbenForm` 创建最基础的表单。 - - - -## 查询表单 - -查询表单是一种特殊的表单，用于查询数据。查询表单不会触发表单验证，只会触发查询事件。 - - - -## 表单校验 - -表单校验是一个非常重要的功能，可以通过 `rules` 属性进行校验。 - - - -## 表单联动 - -表单联动是一个非常常见的功能，可以通过 `dependencies` 属性进行联动。 - -_注意_ 需要指定 `dependencies` 的 `triggerFields` 属性，设置由谁的改动来触发，以便表单组件能够正确的联动。 - - - -## 自定义组件 - -如果你的业务组件库没有提供某个组件，你可以自行封装一个组件，然后加到表单内部。 - - - -## 操作 - -一些常见的表单操作。 - - - -## API - -`useVbenForm` 返回一个数组，第一个元素是表单组件，第二个元素是表单的方法。 - -```vue - - - -``` - -### FormApi - -useVbenForm 返回的第二个参数，是一个对象，包含了一些表单的方法。 - -| 方法名 | 描述 | 类型 | 版本号 | -| --- | --- | --- | --- | -| submitForm | 提交表单 | `(e:Event)=>Promise>` | - | -| validateAndSubmitForm | 提交并校验表单 | `(e:Event)=>Promise>` | - | -| resetForm | 重置表单 | `()=>Promise` | - | -| setValues | 设置表单值, 默认会过滤不在schema中定义的field, 可通过filterFields形参关闭过滤 | `(fields: Record, filterFields?: boolean, shouldValidate?: boolean) => Promise` | - | -| getValues | 获取表单值 | `(fields:Record,shouldValidate: boolean = false)=>Promise` | - | -| validate | 表单校验 | `()=>Promise` | - | -| validateField | 校验指定字段 | `(fieldName: string)=>Promise>` | - | -| isFieldValid | 检查某个字段是否已通过校验 | `(fieldName: string)=>Promise` | - | -| resetValidate | 重置表单校验 | `()=>Promise` | - | -| updateSchema | 更新formSchema | `(schema:FormSchema[])=>void` | - | -| setFieldValue | 设置字段值 | `(field: string, value: any, shouldValidate?: boolean)=>Promise` | - | -| setState | 设置组件状态（props） | `(stateOrFn:\| ((prev: VbenFormProps) => Partial)\| Partial)=>Promise` | - | -| getState | 获取组件状态（props） | `()=>Promise` | - | -| form | 表单对象实例，可以操作表单，见 [useForm](https://vee-validate.logaretm.com/v4/api/use-form/) | - | - | -| getFieldComponentRef | 获取指定字段的组件实例 | `(fieldName: string)=>T` | >5.5.3 | -| getFocusedField | 获取当前已获得焦点的字段 | `()=>string\|undefined` | >5.5.3 | - -## Props - -所有属性都可以传入 `useVbenForm` 的第一个参数中。 - -| 属性名 | 描述 | 类型 | 默认值 | -| --- | --- | --- | --- | -| layout | 表单项布局 | `'horizontal' \| 'vertical'\| 'inline'` | `horizontal` | -| showCollapseButton | 是否显示折叠按钮 | `boolean` | `false` | -| wrapperClass | 表单的布局，基于tailwindcss | `any` | - | -| actionWrapperClass | 表单操作区域class | `any` | - | -| actionLayout | 表单操作按钮位置 | `'newLine' \| 'rowEnd' \| 'inline'` | `rowEnd` | -| actionPosition | 表单操作按钮对齐方式 | `'left' \| 'center' \| 'right'` | `right` | -| handleReset | 表单重置回调 | `(values: Record,) => Promise \| void` | - | -| handleSubmit | 表单提交回调 | `(values: Record,) => Promise \| void` | - | -| handleValuesChange | 表单值变化回调 | `(values: Record, fieldsChanged: string[]) => void` | - | -| actionButtonsReverse | 调换操作按钮位置 | `boolean` | `false` | -| resetButtonOptions | 重置按钮组件参数 | `ActionButtonOptions` | - | -| submitButtonOptions | 提交按钮组件参数 | `ActionButtonOptions` | - | -| showDefaultActions | 是否显示默认操作按钮 | `boolean` | `true` | -| collapsed | 是否折叠，在`showCollapseButton`为`true`时生效 | `boolean` | `false` | -| collapseTriggerResize | 折叠时，触发`resize`事件 | `boolean` | `false` | -| collapsedRows | 折叠时保持的行数 | `number` | `1` | -| fieldMappingTime | 用于将表单内的数组值映射成 2 个字段 | `[string, [string, string],Nullable\|[string,string]\|((any,string)=>any)?][]` | - | -| commonConfig | 表单项的通用配置，每个配置都会传递到每个表单项，表单项可覆盖 | `FormCommonConfig` | - | -| schema | 表单项的每一项配置 | `FormSchema[]` | - | -| submitOnEnter | 按下回车健时提交表单 | `boolean` | false | -| submitOnChange | 字段值改变时提交表单(内部防抖，这个属性一般用于表格的搜索表单) | `boolean` | false | -| compact | 是否紧凑模式(忽略为校验信息所预留的空间) | `boolean` | false | -| scrollToFirstError | 表单验证失败时是否自动滚动到第一个错误字段 | `boolean` | false | - -::: tip handleValuesChange - -`handleValuesChange` 回调函数的第一个参数`values`装载了表单改变后的当前值对象，第二个参数`fieldsChanged`是一个数组，包含了所有被改变的字段名。注意：第二个参数仅在v5.5.4(不含)以上版本可用，并且传递的是已在schema中定义的字段名。如果你使用了字段映射并且需要检查是哪些字段发生了变化的话，请注意该参数并不会包含映射后的字段名。 - -::: - -::: tip fieldMappingTime - -此属性用于将表单内的数组值映射成 2 个字段，它应当传入一个数组，数组的每一项是一个映射规则，规则的第一个成员是一个字符串，表示需要映射的字段名，第二个成员是一个数组，表示映射后的字段名，第三个成员是一个可选的格式掩码，用于格式化日期时间字段；也可以提供一个格式化函数（参数分别为当前值和当前字段名，返回格式化后的值）。如果明确地将格式掩码设为null，则原值映射而不进行格式化（适用于非日期时间字段）。例如：`[['timeRange', ['startTime', 'endTime'], 'YYYY-MM-DD']]`，`timeRange`应当是一个至少具有2个成员的数组类型的值。Form会将`timeRange`的值前两个值分别按照格式掩码`YYYY-MM-DD`格式化后映射到`startTime`和`endTime`字段上。每一项的第三个参数是一个可选的格式掩码， - -::: - -### TS 类型说明 - -::: details ActionButtonOptions - -```ts -export interface ActionButtonOptions { - /** 样式 */ - class?: ClassType; - /** 是否禁用 */ - disabled?: boolean; - /** 是否加载中 */ - loading?: boolean; - /** 按钮大小 */ - size?: ButtonVariantSize; - /** 按钮类型 */ - variant?: ButtonVariants; - /** 是否显示 */ - show?: boolean; - /** 按钮文本 */ - content?: string; - /** 任意属性 */ - [key: string]: any; -} -``` - -::: - -::: details FormCommonConfig - -```ts -export interface FormCommonConfig { - /** - * 所有表单项的props - */ - componentProps?: ComponentProps; - /** - * 所有表单项的控件样式 - */ - controlClass?: string; - /** - * 在表单项的Label后显示一个冒号 - */ - colon?: boolean; - /** - * 所有表单项的禁用状态 - * @default false - */ - disabled?: boolean; - /** - * 所有表单项的控件样式 - * @default {} - */ - formFieldProps?: Partial; - /** - * 所有表单项的栅格布局 - * @default "" - */ - formItemClass?: (() => string) | string; - /** - * 隐藏所有表单项label - * @default false - */ - hideLabel?: boolean; - /** - * 是否隐藏必填标记 - * @default false - */ - hideRequiredMark?: boolean; - /** - * 所有表单项的label样式 - * @default "" - */ - labelClass?: string; - /** - * 所有表单项的label宽度 - */ - labelWidth?: number; - /** - * 所有表单项的model属性名。使用自定义组件时可通过此配置指定组件的model属性名。已经在modelPropNameMap中注册的组件不受此配置影响 - * @default "modelValue" - */ - modelPropName?: string; - /** - * 所有表单项的wrapper样式 - */ - wrapperClass?: string; -} -``` - -::: - -::: details FormSchema - -```ts -export interface FormSchema< - T extends BaseFormComponentType = BaseFormComponentType, -> extends FormCommonConfig { - /** 组件 */ - component: Component | T; - /** 组件参数 */ - componentProps?: ComponentProps; - /** 默认值 */ - defaultValue?: any; - /** 依赖 */ - dependencies?: FormItemDependencies; - /** 描述 */ - description?: string; - /** 字段名，也作为自定义插槽的名称 */ - fieldName: string; - /** 帮助信息 */ - help?: CustomRenderType; - /** 是否隐藏表单项 */ - hide?: boolean; - /** 表单的标签（如果是一个string，会用于默认必选规则的消息提示） */ - label?: CustomRenderType; - /** 自定义组件内部渲染 */ - renderComponentContent?: RenderComponentContentType; - /** 字段规则 */ - rules?: FormSchemaRuleType; - /** 后缀 */ - suffix?: CustomRenderType; -} -``` - -::: - -### 表单联动 - -表单联动需要通过 schema 内的 `dependencies` 属性进行联动，允许您添加字段之间的依赖项，以根据其他字段的值控制字段。 - -```ts -dependencies: { - // 触发字段。只有这些字段值变动时，联动才会触发 - triggerFields: ['name'], - // 动态判断当前字段是否需要显示，不显示则直接销毁 - if(values,formApi){}, - // 动态判断当前字段是否需要显示，不显示用css隐藏 - show(values,formApi){}, - // 动态判断当前字段是否需要禁用 - disabled(values,formApi){}, - // 字段变更时，都会触发该函数 - trigger(values,formApi){}, - // 动态rules - rules(values,formApi){}, - // 动态必填 - required(values,formApi){}, - // 动态组件参数 - componentProps(values,formApi){}, -} -``` - -### 表单校验 - -表单校验需要通过 schema 内的 `rules` 属性进行配置。 - -rules的值可以是字符串（预定义的校验规则名称），也可以是一个zod的schema。 - -#### 预定义的校验规则 - -```ts -// 表示字段必填，默认会根据适配器的required进行国际化 -{ - rules: 'required'; -} - -// 表示字段必填，默认会根据适配器的required进行国际化，用于下拉选择之类 -{ - rules: 'selectRequired'; -} -``` - -#### zod - -rules也支持 zod 的 schema，可以进行更复杂的校验，zod 的使用请查看 [zod文档](https://zod.dev/)。 - -```ts -import { z } from '#/adapter/form'; - -// 基础类型 -{ - rules: z.string().min(1, { message: '请输入字符串' }); -} - -// 可选(可以是undefined)，并且携带默认值。注意zod的optional不包括空字符串'' -{ - rules: z.string().default('默认值').optional(); -} - -// 可以是空字符串、undefined或者一个邮箱地址(两种不同的用法) -{ - rules: z.union([z.string().email().optional(), z.literal('')]); -} - -{ - rules: z.string().email().or(z.literal('')).optional(); -} - -// 复杂校验 -{ - z.string() - .min(1, { message: '请输入' }) - .refine((value) => value === '123', { - message: '值必须为123', - }); -} -``` - -## Slots - -可以使用以下插槽在表单中插入自定义的内容 - -| 插槽名 | 描述 | -| ------------- | ------------------ | -| reset-before | 重置按钮之前的位置 | -| submit-before | 提交按钮之前的位置 | -| expand-before | 展开按钮之前的位置 | -| expand-after | 展开按钮之后的位置 | - -::: tip 字段插槽 - -除了以上内置插槽之外，`schema`属性中每个字段的`fieldName`都可以作为插槽名称，这些字段插槽的优先级高于`component`定义的组件。也就是说，当提供了与`fieldName`同名的插槽时，这些插槽的内容将会作为这些字段的组件，此时`component`的值将会被忽略。 - -::: diff --git a/docs/src/components/common-ui/vben-modal.md b/docs/src/components/common-ui/vben-modal.md deleted file mode 100644 index fc714e27..00000000 --- a/docs/src/components/common-ui/vben-modal.md +++ /dev/null @@ -1,174 +0,0 @@ ---- -outline: deep ---- - -# Vben Modal 模态框 - -框架提供的模态框组件，支持`拖拽`、`全屏`、`自动高度`、`loading`等功能。 - -> 如果文档内没有参数说明，可以尝试在在线示例内寻找 - -::: info 写在前面 - -如果你觉得现有组件的封装不够理想，或者不完全符合你的需求，大可以直接使用原生组件，亦或亲手封装一个适合的组件。框架提供的组件并非束缚，使用与否，完全取决于你的需求与自由。 - -::: - -::: tip README - -下方示例代码中的，存在一些国际化、主题色未适配问题，这些问题只在文档内会出现，实际使用并不会有这些问题，可忽略，不必纠结。 - -::: - -## 基础用法 - -使用 `useVbenModal` 创建最基础的模态框。 - - - -## 组件抽离 - -Modal 内的内容一般业务中，会比较复杂，所以我们可以将 modal 内的内容抽离出来，也方便复用。通过 `connectedComponent` 参数，可以将内外组件进行连接，而不用其他任何操作。 - - - -## 开启拖拽 - -通过 `draggable` 参数，可开启拖拽功能。 - - - -## 自动计算高度 - -弹窗会自动计算内容高度，超过一定高度会出现滚动条，同时结合 `loading` 效果以及使用 `prepend-footer` 插槽。 - - - -## 使用 Api - -通过 `modalApi` 可以调用 modal 的方法以及使用 `setState` 更新 modal 的状态。 - - - -## 数据共享 - -如果你使用了 `connectedComponent` 参数，那么内外组件会共享数据，比如一些表单回填等操作。可以用 `modalApi` 来获取数据和设置数据，配合 `onOpenChange`，可以满足大部分的需求。 - - - -## 动画类型 - -通过 `animationType` 属性可以控制弹窗的动画效果： - -- `slide`（默认）：从顶部向下滑动进入/退出 -- `scale`：缩放淡入/淡出效果 - - - -::: info 注意 - -- `VbenModal` 组件对与参数的处理优先级是 `slot` > `props` > `state`(通过api更新的状态以及useVbenModal参数)。如果你已经传入了 `slot` 或者 `props`，那么 `setState` 将不会生效，这种情况下你可以通过 `slot` 或者 `props` 来更新状态。 -- 如果你使用到了 `connectedComponent` 参数，那么会存在 2 个`useVbenModal`, 此时，如果同时设置了相同的参数，那么以内部为准（也就是没有设置 connectedComponent 的代码）。比如 同时设置了 `onConfirm`，那么以内部的 `onConfirm` 为准。`onOpenChange`事件除外，内外都会触发。另外，如果设置了`destroyOnClose`，内部Modal及其子组件会在被关闭后完全销毁。 -- 如果弹窗的默认行为不符合你的预期，可以在`src\bootstrap.ts`中修改`setDefaultModalProps`的参数来设置默认的属性，如默认隐藏全屏按钮，修改默认ZIndex等。 - -::: - -## API - -```ts -// Modal 为弹窗组件 -// modalApi 为弹窗的方法 -const [Modal, modalApi] = useVbenModal({ - // 属性 - // 事件 -}); -``` - -### Props - -所有属性都可以传入 `useVbenModal` 的第一个参数中。 - -| 属性名 | 描述 | 类型 | 默认值 | -| --- | --- | --- | --- | -| appendToMain | 是否挂载到内容区域（默认挂载到body） | `boolean` | `false` | -| connectedComponent | 连接另一个Modal组件 | `Component` | - | -| destroyOnClose | 关闭时销毁 | `boolean` | `false` | -| title | 标题 | `string\|slot` | - | -| titleTooltip | 标题提示信息 | `string\|slot` | - | -| description | 描述信息 | `string\|slot` | - | -| isOpen | 弹窗打开状态 | `boolean` | `false` | -| loading | 弹窗加载状态 | `boolean` | `false` | -| fullscreen | 全屏显示 | `boolean` | `false` | -| fullscreenButton | 显示全屏按钮 | `boolean` | `true` | -| draggable | 可拖拽 | `boolean` | `false` | -| closable | 显示关闭按钮 | `boolean` | `true` | -| centered | 居中显示 | `boolean` | `false` | -| modal | 显示遮罩 | `boolean` | `true` | -| header | 显示header | `boolean` | `true` | -| footer | 显示footer | `boolean\|slot` | `true` | -| confirmDisabled | 禁用确认按钮 | `boolean` | `false` | -| confirmLoading | 确认按钮loading状态 | `boolean` | `false` | -| closeOnClickModal | 点击遮罩关闭弹窗 | `boolean` | `true` | -| closeOnPressEscape | esc 关闭弹窗 | `boolean` | `true` | -| confirmText | 确认按钮文本 | `string\|slot` | `确认` | -| cancelText | 取消按钮文本 | `string\|slot` | `取消` | -| showCancelButton | 显示取消按钮 | `boolean` | `true` | -| showConfirmButton | 显示确认按钮 | `boolean` | `true` | -| class | modal的class，宽度通过这个配置 | `string` | - | -| contentClass | modal内容区域的class | `string` | - | -| footerClass | modal底部区域的class | `string` | - | -| headerClass | modal顶部区域的class | `string` | - | -| bordered | 是否显示border | `boolean` | `false` | -| zIndex | 弹窗的ZIndex层级 | `number` | `1000` | -| overlayBlur | 遮罩模糊度 | `number` | - | -| animationType | 动画类型 | `'slide' \| 'scale'` | `'slide'` | -| submitting | 标记为提交中，锁定弹窗当前状态 | `boolean` | `false` | - -::: info appendToMain - -`appendToMain`可以指定将弹窗挂载到内容区域，打开这种弹窗时，内容区域以外的部分（标签栏、导航菜单等等）不会被遮挡。默认情况下，弹窗会挂载到body上。但是：挂载到内容区域时，作为页面根容器的`Page`组件，需要设置`auto-content-height`属性，以便弹窗能够正确计算高度。 - -::: - -### Event - -以下事件，只有在 `useVbenModal({onCancel:()=>{}})` 中传入才会生效。 - -| 事件名 | 描述 | 类型 | 版本号 | -| --- | --- | --- | --- | -| onBeforeClose | 关闭前触发，返回 `false`或者被`reject`则禁止关闭 | `()=>Promise\|boolean` | >5.5.2支持Promise | -| onCancel | 点击取消按钮触发 | `()=>void` | | -| onClosed | 关闭动画播放完毕时触发 | `()=>void` | >5.4.3 | -| onConfirm | 点击确认按钮触发 | `()=>void` | | -| onOpenChange | 关闭或者打开弹窗时触发 | `(isOpen:boolean)=>void` | | -| onOpened | 打开动画播放完毕时触发 | `()=>void` | >5.4.3 | - -### Slots - -除了上面的属性类型包含`slot`，还可以通过插槽来自定义弹窗的内容。 - -| 插槽名 | 描述 | -| -------------- | -------------------------------------------------- | -| default | 默认插槽 - 弹窗内容 | -| prepend-footer | 取消按钮左侧 | -| center-footer | 取消按钮和确认按钮中间（不使用 footer 插槽时有效） | -| append-footer | 确认按钮右侧 | - -### modalApi - -| 方法 | 描述 | 类型 | 版本 | -| --- | --- | --- | --- | -| setState | 动态设置弹窗状态属性 | `(((prev: ModalState) => Partial)\| Partial)=>modalApi` | - | -| open | 打开弹窗 | `()=>void` | - | -| close | 关闭弹窗 | `()=>void` | - | -| setData | 设置共享数据 | `(data:T)=>modalApi` | - | -| getData | 获取共享数据 | `()=>T` | - | -| useStore | 获取可响应式状态 | - | - | -| lock | 将弹窗标记为提交中，锁定当前状态 | `(isLock:boolean)=>modalApi` | >5.5.2 | -| unlock | lock方法的反操作，解除弹窗的锁定状态，也是lock(false)的别名 | `()=>modalApi` | >5.5.3 | - -::: info lock - -`lock`方法用于锁定当前弹窗的状态，一般用于提交数据的过程中防止用户重复提交或者弹窗被意外关闭、表单数据被改变等等。当处于锁定状态时，弹窗的确认按钮会变为loading状态，同时禁用取消按钮和关闭按钮、禁止ESC或者点击遮罩等方式关闭弹窗、开启弹窗的spinner动画以遮挡弹窗内容。调用`close`方法关闭处于锁定状态的弹窗时，会自动解锁。要主动解除这种状态，可以调用`unlock`方法或者再次调用lock方法并传入false参数。 - -::: diff --git a/docs/src/components/common-ui/vben-vxe-table.md b/docs/src/components/common-ui/vben-vxe-table.md deleted file mode 100644 index 344ecae1..00000000 --- a/docs/src/components/common-ui/vben-vxe-table.md +++ /dev/null @@ -1,276 +0,0 @@ ---- -outline: deep ---- - -# Vben Vxe Table 表格 - -框架提供的Table 列表组件基于 [vxe-table](https://vxetable.cn/v4/#/grid/api?apiKey=grid)，结合`Vben Form 表单`进行了二次封装。 - -其中，表头的 **表单搜索** 部分采用了`Vben Form表单`，表格主体部分使用了`vxe-grid`组件，支持表格的分页、排序、筛选等功能。 - -> 如果文档内没有参数说明，可以尝试在在线示例或者在 [vxe-grid 官方API 文档](https://vxetable.cn/v4/#/grid/api?apiKey=grid) 内寻找 - -::: info 写在前面 - -如果你觉得现有组件的封装不够理想，或者不完全符合你的需求，大可以直接使用原生组件，亦或亲手封装一个适合的组件。框架提供的组件并非束缚，使用与否，完全取决于你的需求与自由。 - -::: - -## 适配器 - -表格底层使用 [vxe-table](https://vxetable.cn/#/start/install) 进行实现，所以你可以使用 `vxe-table` 的所有功能。对于不同的 UI 框架，我们提供了适配器，以便更好的适配不同的 UI 框架。 - -### 适配器说明 - -每个应用都可以自己配置`vxe-table`的适配器，你可以根据自己的需求。下面是一个简单的配置示例： - -::: details vxe-table 表格适配器 - -```ts -import { h } from 'vue'; - -import { setupVbenVxeTable, useVbenVxeGrid } from '@vben/plugins/vxe-table'; - -import { Button, Image } from 'ant-design-vue'; - -import { useVbenForm } from './form'; - -setupVbenVxeTable({ - configVxeTable: (vxeUI) => { - vxeUI.setConfig({ - grid: { - align: 'center', - border: false, - columnConfig: { - resizable: true, - }, - minHeight: 180, - formConfig: { - // 全局禁用vxe-table的表单配置，使用formOptions - enabled: false, - }, - proxyConfig: { - autoLoad: true, - response: { - result: 'items', - total: 'total', - list: 'items', - }, - showActiveMsg: true, - showResponseMsg: false, - }, - round: true, - showOverflow: true, - size: 'small', - }, - }); - - // 表格配置项可以用 cellRender: { name: 'CellImage' }, - vxeUI.renderer.add('CellImage', { - renderTableDefault(_renderOpts, params) { - const { column, row } = params; - return h(Image, { src: row[column.field] }); - }, - }); - - // 表格配置项可以用 cellRender: { name: 'CellLink' }, - vxeUI.renderer.add('CellLink', { - renderTableDefault(renderOpts) { - const { props } = renderOpts; - return h( - Button, - { size: 'small', type: 'link' }, - { default: () => props?.text }, - ); - }, - }); - - // 这里可以自行扩展 vxe-table 的全局配置，比如自定义格式化 - // vxeUI.formats.add - }, - useVbenForm, -}); - -export { useVbenVxeGrid }; - -export type * from '@vben/plugins/vxe-table'; -``` - -::: - -## 基础表格 - -使用 `useVbenVxeGrid` 创建最基础的表格。 - - - -## 远程加载 - -通过指定 `proxyConfig.ajax` 的 `query` 方法，可以实现远程加载数据。 - - - -## 树形表格 - -树形表格的数据源为扁平结构，可以指定`treeConfig`配置项，实现树形表格。 - -```typescript -treeConfig: { - transform: true, // 指定表格为树形表格 - parentField: 'parentId', // 父节点字段名 - rowField: 'id', // 行数据字段名 -}, -``` - - - -## 固定表头/列 - -列固定可选参数： `'left' | 'right' | '' | null` - - - -## 自定义单元格 - -自定义单元格有两种实现方式 - -- 通过 `slots` 插槽 -- 通过 `customCell` 自定义单元格，但是要先添加渲染器 - -```typescript -// 表格配置项可以用 cellRender: { name: 'CellImage' }, -vxeUI.renderer.add('CellImage', { - renderDefault(_renderOpts, params) { - const { column, row } = params; - return h(Image, { src: row[column.field] } as any); // 注意此处的Image 组件，来源于Antd，需要自行引入,否则会使用js的Image类 - }, -}); - -// 表格配置项可以用 cellRender: { name: 'CellLink' }, -vxeUI.renderer.add('CellLink', { - renderDefault(renderOpts) { - const { props } = renderOpts; - return h( - Button, - { size: 'small', type: 'link' }, - { default: () => props?.text }, - ); - }, -}); -``` - - - -## 搜索表单 - -**表单搜索** 部分采用了`Vben Form 表单`，参考 [Vben Form 表单文档](/components/common-ui/vben-form)。 - -当启用了表单搜索时，可以在toolbarConfig中配置`search`为`true`来让表格在工具栏区域显示一个搜索表单控制按钮。表格的所有以`form-`开头的命名插槽都会被传递给搜索表单。 - -### 定制分隔条 - -当你启用表单搜索时，在表单和表格之间会显示一个分隔条。这个分隔条使用了默认的组件背景色，并且横向贯穿整个Vben Vxe Table在视觉上融入了页面的默认背景中。如果你在Vben Vxe Table的外层包裹了一个不同背景色的容器（如将其放在一个Card内），默认的表单和表格之间的分隔条可能就显得格格不入了，下面的代码演示了如何定制这个分隔条。 - -```ts -const [Grid] = useVbenVxeGrid({ - formOptions: {}, - gridOptions: {}, - // 完全移除分隔条 - separator: false, - // 你也可以使用下面的代码来移除分隔条 - // separator: { show: false }, - // 或者使用下面的代码来改变分隔条的颜色 - // separator: { backgroundColor: 'rgba(100,100,0,0.5)' }, -}); -``` - - - -## 单元格编辑 - -通过指定`editConfig.mode`为`cell`，可以实现单元格编辑。 - - - -## 行编辑 - -通过指定`editConfig.mode`为`row`，可以实现行编辑。 - - - -## 虚拟滚动 - -通过 scroll-y.enabled 与 scroll-y.gt 组合开启，其中 enabled 为总开关，gt 是指当总行数大于指定行数时自动开启。 - -> 参考 [vxe-table 官方文档 - 虚拟滚动](https://vxetable.cn/v4/#/component/grid/scroll/vertical)。 - - - -## API - -`useVbenVxeGrid` 返回一个数组，第一个元素是表格组件，第二个元素是表格的方法。 - -```vue - - - -``` - -### GridApi - -useVbenVxeGrid 返回的第二个参数，是一个对象，包含了一些表单的方法。 - -| 方法名 | 描述 | 类型 | 说明 | -| --- | --- | --- | --- | -| setLoading | 设置loading状态 | `(loading)=>void` | - | -| setGridOptions | 设置vxe-table grid组件参数 | `(options: Partialvoid` | - | -| reload | 重载表格，会进行初始化 | `(params:any)=>void` | - | -| query | 重载表格，会保留当前分页 | `(params:any)=>void` | - | -| grid | vxe-table grid实例 | `VxeGridInstance` | - | -| formApi | vbenForm api实例 | `FormApi` | - | -| toggleSearchForm | 设置搜索表单显示状态 | `(show?: boolean)=>boolean` | 当省略参数时，则将表单在显示和隐藏两种状态之间切换 | - -## Props - -所有属性都可以传入 `useVbenVxeGrid` 的第一个参数中。 - -| 属性名 | 描述 | 类型 | 版本要求 | -| --- | --- | --- | --- | -| tableTitle | 表格标题 | `string` | - | -| tableTitleHelp | 表格标题帮助信息 | `string` | - | -| gridClass | grid组件的class | `string` | - | -| gridOptions | grid组件的参数 | `VxeTableGridProps` | - | -| gridEvents | grid组件的触发的事件 | `VxeGridListeners` | - | -| formOptions | 表单参数 | `VbenFormProps` | - | -| showSearchForm | 是否显示搜索表单 | `boolean` | - | -| separator | 搜索表单与表格主体之间的分隔条 | `boolean\|SeparatorOptions` | >5.5.4 | - -## Slots - -大部分插槽的说明请参考 [vxe-table 官方文档](https://vxetable.cn/v4/#/grid/api)，但工具栏部分由于做了一些定制封装，需使用以下插槽定制表格的工具栏： - -| 插槽名 | 描述 | -| --------------- | -------------------------------------------- | -| toolbar-actions | 工具栏左侧部分（表格标题附近） | -| toolbar-tools | 工具栏右侧部分（vxeTable原生工具按钮的左侧） | -| table-title | 表格标题插槽 | - -::: info 搜索表单的插槽 - -对于使用了搜索表单的表格来说，所有以`form-`开头的命名插槽都会传递给表单。 - -::: diff --git a/docs/src/components/introduction.md b/docs/src/components/introduction.md deleted file mode 100644 index 438470e9..00000000 --- a/docs/src/components/introduction.md +++ /dev/null @@ -1,15 +0,0 @@ -# 介绍 - -::: info README - -该文档介绍的是框架组件的使用方法、属性、事件等。如果你觉得现有组件的封装不够理想，或者不完全符合你的需求，大可以直接使用原生组件，亦或亲手封装一个适合的组件。框架提供的组件并非束缚，使用与否，完全取决于你的需求与自由。 - -::: - -## 布局组件 - -布局组件一般在页面内容区域用作顶层容器组件，提供一些统一的布局样式和基本功能。 - -## 通用组件 - -通用组件是一些常用的组件，比如弹窗、抽屉、表单等。大部分基于 `Tailwind CSS` 实现，可适用于不同 UI 组件库的应用。 diff --git a/docs/src/components/layout-ui/page.md b/docs/src/components/layout-ui/page.md deleted file mode 100644 index 29fbdd40..00000000 --- a/docs/src/components/layout-ui/page.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -outline: deep ---- - -# Page 常规页面组件 - -提供一个常规页面布局的组件，包括头部、内容区域、底部三个部分。 - -::: info 写在前面 - -本组件是一个基本布局组件。如果有更多的通用页面布局需求（比如双列布局等），可以根据实际需求自行封装。 - -::: - -## 基础用法 - -将`Page`作为你的业务页面的根组件即可。 - -### Props - -| 属性名 | 描述 | 类型 | 默认值 | 说明 | -| --- | --- | --- | --- | --- | -| title | 页面标题 | `string\|slot` | - | - | -| description | 页面描述（标题下的内容） | `string\|slot` | - | - | -| contentClass | 内容区域的class | `string` | - | - | -| headerClass | 头部区域的class | `string` | - | - | -| footerClass | 底部区域的class | `string` | - | - | -| autoContentHeight | 自动调整内容区域的高度 | `boolean` | `false` | - | - -::: tip 注意 - -如果`title`、`description`、`extra`三者均未提供有效内容（通过`props`或者`slots`均可），则页面头部区域不会渲染。 - -::: - -### Slots - -| 插槽名称 | 描述 | -| ----------- | ------------ | -| default | 页面内容 | -| title | 页面标题 | -| description | 页面描述 | -| extra | 页面头部右侧 | -| footer | 页面底部 | diff --git a/docs/src/demos/vben-alert/alert/index.vue b/docs/src/demos/vben-alert/alert/index.vue deleted file mode 100644 index 9ba18a4d..00000000 --- a/docs/src/demos/vben-alert/alert/index.vue +++ /dev/null @@ -1,36 +0,0 @@ - - diff --git a/docs/src/demos/vben-alert/confirm/index.vue b/docs/src/demos/vben-alert/confirm/index.vue deleted file mode 100644 index 723445d9..00000000 --- a/docs/src/demos/vben-alert/confirm/index.vue +++ /dev/null @@ -1,75 +0,0 @@ - - diff --git a/docs/src/demos/vben-alert/prompt/index.vue b/docs/src/demos/vben-alert/prompt/index.vue deleted file mode 100644 index a1922134..00000000 --- a/docs/src/demos/vben-alert/prompt/index.vue +++ /dev/null @@ -1,118 +0,0 @@ - - diff --git a/docs/src/demos/vben-api-component/cascader/index.vue b/docs/src/demos/vben-api-component/cascader/index.vue deleted file mode 100644 index 957964cd..00000000 --- a/docs/src/demos/vben-api-component/cascader/index.vue +++ /dev/null @@ -1,100 +0,0 @@ - - diff --git a/docs/src/demos/vben-count-to-animator/basic/index.vue b/docs/src/demos/vben-count-to-animator/basic/index.vue deleted file mode 100644 index acc76eda..00000000 --- a/docs/src/demos/vben-count-to-animator/basic/index.vue +++ /dev/null @@ -1,6 +0,0 @@ - - diff --git a/docs/src/demos/vben-count-to-animator/custom/index.vue b/docs/src/demos/vben-count-to-animator/custom/index.vue deleted file mode 100644 index 5a243405..00000000 --- a/docs/src/demos/vben-count-to-animator/custom/index.vue +++ /dev/null @@ -1,12 +0,0 @@ - - diff --git a/docs/src/demos/vben-drawer/auto-height/drawer.vue b/docs/src/demos/vben-drawer/auto-height/drawer.vue deleted file mode 100644 index 9ab433cc..00000000 --- a/docs/src/demos/vben-drawer/auto-height/drawer.vue +++ /dev/null @@ -1,45 +0,0 @@ - - diff --git a/docs/src/demos/vben-drawer/auto-height/index.vue b/docs/src/demos/vben-drawer/auto-height/index.vue deleted file mode 100644 index 59294e53..00000000 --- a/docs/src/demos/vben-drawer/auto-height/index.vue +++ /dev/null @@ -1,21 +0,0 @@ - - - diff --git a/docs/src/demos/vben-drawer/basic/index.vue b/docs/src/demos/vben-drawer/basic/index.vue deleted file mode 100644 index bd7d9275..00000000 --- a/docs/src/demos/vben-drawer/basic/index.vue +++ /dev/null @@ -1,11 +0,0 @@ - - diff --git a/docs/src/demos/vben-drawer/dynamic/drawer.vue b/docs/src/demos/vben-drawer/dynamic/drawer.vue deleted file mode 100644 index 50f62831..00000000 --- a/docs/src/demos/vben-drawer/dynamic/drawer.vue +++ /dev/null @@ -1,26 +0,0 @@ - - diff --git a/docs/src/demos/vben-drawer/dynamic/index.vue b/docs/src/demos/vben-drawer/dynamic/index.vue deleted file mode 100644 index 95464023..00000000 --- a/docs/src/demos/vben-drawer/dynamic/index.vue +++ /dev/null @@ -1,29 +0,0 @@ - - - diff --git a/docs/src/demos/vben-drawer/extra/drawer.vue b/docs/src/demos/vben-drawer/extra/drawer.vue deleted file mode 100644 index e84c1939..00000000 --- a/docs/src/demos/vben-drawer/extra/drawer.vue +++ /dev/null @@ -1,8 +0,0 @@ - - diff --git a/docs/src/demos/vben-drawer/extra/index.vue b/docs/src/demos/vben-drawer/extra/index.vue deleted file mode 100644 index 59294e53..00000000 --- a/docs/src/demos/vben-drawer/extra/index.vue +++ /dev/null @@ -1,21 +0,0 @@ - - - diff --git a/docs/src/demos/vben-drawer/shared-data/drawer.vue b/docs/src/demos/vben-drawer/shared-data/drawer.vue deleted file mode 100644 index 629199b6..00000000 --- a/docs/src/demos/vben-drawer/shared-data/drawer.vue +++ /dev/null @@ -1,26 +0,0 @@ - - diff --git a/docs/src/demos/vben-drawer/shared-data/index.vue b/docs/src/demos/vben-drawer/shared-data/index.vue deleted file mode 100644 index fef6cb05..00000000 --- a/docs/src/demos/vben-drawer/shared-data/index.vue +++ /dev/null @@ -1,27 +0,0 @@ - - - diff --git a/docs/src/demos/vben-ellipsis-text/auto-display/index.vue b/docs/src/demos/vben-ellipsis-text/auto-display/index.vue deleted file mode 100644 index fb5a32a5..00000000 --- a/docs/src/demos/vben-ellipsis-text/auto-display/index.vue +++ /dev/null @@ -1,16 +0,0 @@ - - diff --git a/docs/src/demos/vben-ellipsis-text/expand/index.vue b/docs/src/demos/vben-ellipsis-text/expand/index.vue deleted file mode 100644 index 842f6b32..00000000 --- a/docs/src/demos/vben-ellipsis-text/expand/index.vue +++ /dev/null @@ -1,10 +0,0 @@ - - diff --git a/docs/src/demos/vben-ellipsis-text/line/index.vue b/docs/src/demos/vben-ellipsis-text/line/index.vue deleted file mode 100644 index dfbf20ef..00000000 --- a/docs/src/demos/vben-ellipsis-text/line/index.vue +++ /dev/null @@ -1,10 +0,0 @@ - - diff --git a/docs/src/demos/vben-ellipsis-text/tooltip/index.vue b/docs/src/demos/vben-ellipsis-text/tooltip/index.vue deleted file mode 100644 index e6287a12..00000000 --- a/docs/src/demos/vben-ellipsis-text/tooltip/index.vue +++ /dev/null @@ -1,14 +0,0 @@ - - diff --git a/docs/src/demos/vben-form/api/index.vue b/docs/src/demos/vben-form/api/index.vue deleted file mode 100644 index 786dc89e..00000000 --- a/docs/src/demos/vben-form/api/index.vue +++ /dev/null @@ -1,236 +0,0 @@ - - - diff --git a/docs/src/demos/vben-form/basic/index.vue b/docs/src/demos/vben-form/basic/index.vue deleted file mode 100644 index 88d01425..00000000 --- a/docs/src/demos/vben-form/basic/index.vue +++ /dev/null @@ -1,231 +0,0 @@ - - - diff --git a/docs/src/demos/vben-form/custom/index.vue b/docs/src/demos/vben-form/custom/index.vue deleted file mode 100644 index e4da38dc..00000000 --- a/docs/src/demos/vben-form/custom/index.vue +++ /dev/null @@ -1,68 +0,0 @@ - - - diff --git a/docs/src/demos/vben-form/dynamic/index.vue b/docs/src/demos/vben-form/dynamic/index.vue deleted file mode 100644 index 83d1a711..00000000 --- a/docs/src/demos/vben-form/dynamic/index.vue +++ /dev/null @@ -1,168 +0,0 @@ - - - diff --git a/docs/src/demos/vben-form/query/index.vue b/docs/src/demos/vben-form/query/index.vue deleted file mode 100644 index a0b64f5d..00000000 --- a/docs/src/demos/vben-form/query/index.vue +++ /dev/null @@ -1,94 +0,0 @@ - - - diff --git a/docs/src/demos/vben-form/rules/index.vue b/docs/src/demos/vben-form/rules/index.vue deleted file mode 100644 index 78e59813..00000000 --- a/docs/src/demos/vben-form/rules/index.vue +++ /dev/null @@ -1,190 +0,0 @@ - - - diff --git a/docs/src/demos/vben-modal/animation-type/index.vue b/docs/src/demos/vben-modal/animation-type/index.vue deleted file mode 100644 index 79ba9d33..00000000 --- a/docs/src/demos/vben-modal/animation-type/index.vue +++ /dev/null @@ -1,36 +0,0 @@ - - - diff --git a/docs/src/demos/vben-modal/auto-height/index.vue b/docs/src/demos/vben-modal/auto-height/index.vue deleted file mode 100644 index 2addf2e9..00000000 --- a/docs/src/demos/vben-modal/auto-height/index.vue +++ /dev/null @@ -1,21 +0,0 @@ - - - diff --git a/docs/src/demos/vben-modal/auto-height/modal.vue b/docs/src/demos/vben-modal/auto-height/modal.vue deleted file mode 100644 index 8757d5ef..00000000 --- a/docs/src/demos/vben-modal/auto-height/modal.vue +++ /dev/null @@ -1,45 +0,0 @@ - - diff --git a/docs/src/demos/vben-modal/basic/index.vue b/docs/src/demos/vben-modal/basic/index.vue deleted file mode 100644 index 9f899708..00000000 --- a/docs/src/demos/vben-modal/basic/index.vue +++ /dev/null @@ -1,11 +0,0 @@ - - diff --git a/docs/src/demos/vben-modal/draggable/index.vue b/docs/src/demos/vben-modal/draggable/index.vue deleted file mode 100644 index 2addf2e9..00000000 --- a/docs/src/demos/vben-modal/draggable/index.vue +++ /dev/null @@ -1,21 +0,0 @@ - - - diff --git a/docs/src/demos/vben-modal/draggable/modal.vue b/docs/src/demos/vben-modal/draggable/modal.vue deleted file mode 100644 index ecca497b..00000000 --- a/docs/src/demos/vben-modal/draggable/modal.vue +++ /dev/null @@ -1,10 +0,0 @@ - - diff --git a/docs/src/demos/vben-modal/dynamic/index.vue b/docs/src/demos/vben-modal/dynamic/index.vue deleted file mode 100644 index 1b025545..00000000 --- a/docs/src/demos/vben-modal/dynamic/index.vue +++ /dev/null @@ -1,29 +0,0 @@ - - - diff --git a/docs/src/demos/vben-modal/dynamic/modal.vue b/docs/src/demos/vben-modal/dynamic/modal.vue deleted file mode 100644 index d4612896..00000000 --- a/docs/src/demos/vben-modal/dynamic/modal.vue +++ /dev/null @@ -1,38 +0,0 @@ - - diff --git a/docs/src/demos/vben-modal/extra/index.vue b/docs/src/demos/vben-modal/extra/index.vue deleted file mode 100644 index 2addf2e9..00000000 --- a/docs/src/demos/vben-modal/extra/index.vue +++ /dev/null @@ -1,21 +0,0 @@ - - - diff --git a/docs/src/demos/vben-modal/extra/modal.vue b/docs/src/demos/vben-modal/extra/modal.vue deleted file mode 100644 index 488fd4a0..00000000 --- a/docs/src/demos/vben-modal/extra/modal.vue +++ /dev/null @@ -1,8 +0,0 @@ - - diff --git a/docs/src/demos/vben-modal/shared-data/index.vue b/docs/src/demos/vben-modal/shared-data/index.vue deleted file mode 100644 index 91afeb70..00000000 --- a/docs/src/demos/vben-modal/shared-data/index.vue +++ /dev/null @@ -1,27 +0,0 @@ - - - diff --git a/docs/src/demos/vben-modal/shared-data/modal.vue b/docs/src/demos/vben-modal/shared-data/modal.vue deleted file mode 100644 index 806585d9..00000000 --- a/docs/src/demos/vben-modal/shared-data/modal.vue +++ /dev/null @@ -1,26 +0,0 @@ - - diff --git a/docs/src/demos/vben-vxe-table/basic/index.vue b/docs/src/demos/vben-vxe-table/basic/index.vue deleted file mode 100644 index 4b6b5a63..00000000 --- a/docs/src/demos/vben-vxe-table/basic/index.vue +++ /dev/null @@ -1,85 +0,0 @@ - - - diff --git a/docs/src/demos/vben-vxe-table/custom-cell/index.vue b/docs/src/demos/vben-vxe-table/custom-cell/index.vue deleted file mode 100644 index 6d6c84d8..00000000 --- a/docs/src/demos/vben-vxe-table/custom-cell/index.vue +++ /dev/null @@ -1,105 +0,0 @@ - - - diff --git a/docs/src/demos/vben-vxe-table/edit-cell/index.vue b/docs/src/demos/vben-vxe-table/edit-cell/index.vue deleted file mode 100644 index 711941de..00000000 --- a/docs/src/demos/vben-vxe-table/edit-cell/index.vue +++ /dev/null @@ -1,55 +0,0 @@ - - - diff --git a/docs/src/demos/vben-vxe-table/edit-row/index.vue b/docs/src/demos/vben-vxe-table/edit-row/index.vue deleted file mode 100644 index f317f69d..00000000 --- a/docs/src/demos/vben-vxe-table/edit-row/index.vue +++ /dev/null @@ -1,92 +0,0 @@ - - - diff --git a/docs/src/demos/vben-vxe-table/fixed/index.vue b/docs/src/demos/vben-vxe-table/fixed/index.vue deleted file mode 100644 index 6067a5eb..00000000 --- a/docs/src/demos/vben-vxe-table/fixed/index.vue +++ /dev/null @@ -1,67 +0,0 @@ - - - diff --git a/docs/src/demos/vben-vxe-table/form/index.vue b/docs/src/demos/vben-vxe-table/form/index.vue deleted file mode 100644 index bcf3f5a5..00000000 --- a/docs/src/demos/vben-vxe-table/form/index.vue +++ /dev/null @@ -1,127 +0,0 @@ - - - diff --git a/docs/src/demos/vben-vxe-table/mock-api.ts b/docs/src/demos/vben-vxe-table/mock-api.ts deleted file mode 100644 index e5c40b61..00000000 --- a/docs/src/demos/vben-vxe-table/mock-api.ts +++ /dev/null @@ -1,36 +0,0 @@ -import { MOCK_API_DATA } from './table-data'; - -export namespace DemoTableApi { - export interface PageFetchParams { - [key: string]: any; - page: number; - pageSize: number; - } -} - -export function sleep(time = 1000) { - return new Promise((resolve) => { - setTimeout(() => { - resolve(true); - }, time); - }); -} - -/** - * 获取示例表格数据 - */ -async function getExampleTableApi(params: DemoTableApi.PageFetchParams) { - return new Promise<{ items: any; total: number }>((resolve) => { - const { page, pageSize } = params; - const items = MOCK_API_DATA.slice((page - 1) * pageSize, page * pageSize); - - sleep(1000).then(() => { - resolve({ - total: items.length, - items, - }); - }); - }); -} - -export { getExampleTableApi }; diff --git a/docs/src/demos/vben-vxe-table/remote/index.vue b/docs/src/demos/vben-vxe-table/remote/index.vue deleted file mode 100644 index bc93d29a..00000000 --- a/docs/src/demos/vben-vxe-table/remote/index.vue +++ /dev/null @@ -1,112 +0,0 @@ - - - diff --git a/docs/src/demos/vben-vxe-table/table-data.ts b/docs/src/demos/vben-vxe-table/table-data.ts deleted file mode 100644 index c37b88ad..00000000 --- a/docs/src/demos/vben-vxe-table/table-data.ts +++ /dev/null @@ -1,384 +0,0 @@ -interface TableRowData { - address: string; - age: number; - id: number; - name: string; - nickname: string; - role: string; -} - -const roles = ['User', 'Admin', 'Manager', 'Guest']; - -export const MOCK_TABLE_DATA: TableRowData[] = (() => { - const data: TableRowData[] = []; - for (let i = 0; i < 10; i++) { - data.push({ - address: `New York${i}`, - age: i + 1, - id: i, - name: `Test${i}`, - nickname: `Test${i}`, - role: roles[Math.floor(Math.random() * roles.length)] as string, - }); - } - return data; -})(); - -export const MOCK_TREE_TABLE_DATA = [ - { - date: '2020-08-01', - id: 10_000, - name: 'Test1', - parentId: null, - size: 1024, - type: 'mp3', - }, - { - date: '2021-04-01', - id: 10_050, - name: 'Test2', - parentId: null, - size: 0, - type: 'mp4', - }, - { - date: '2020-03-01', - id: 24_300, - name: 'Test3', - parentId: 10_050, - size: 1024, - type: 'avi', - }, - { - date: '2021-04-01', - id: 20_045, - name: 'Test4', - parentId: 24_300, - size: 600, - type: 'html', - }, - { - date: '2021-04-01', - id: 10_053, - name: 'Test5', - parentId: 24_300, - size: 0, - type: 'avi', - }, - { - date: '2021-10-01', - id: 24_330, - name: 'Test6', - parentId: 10_053, - size: 25, - type: 'txt', - }, - { - date: '2020-01-01', - id: 21_011, - name: 'Test7', - parentId: 10_053, - size: 512, - type: 'pdf', - }, - { - date: '2021-06-01', - id: 22_200, - name: 'Test8', - parentId: 10_053, - size: 1024, - type: 'js', - }, - { - date: '2020-11-01', - id: 23_666, - name: 'Test9', - parentId: null, - size: 2048, - type: 'xlsx', - }, - { - date: '2021-06-01', - id: 23_677, - name: 'Test10', - parentId: 23_666, - size: 1024, - type: 'js', - }, - { - date: '2021-06-01', - id: 23_671, - name: 'Test11', - parentId: 23_677, - size: 1024, - type: 'js', - }, - { - date: '2021-06-01', - id: 23_672, - name: 'Test12', - parentId: 23_677, - size: 1024, - type: 'js', - }, - { - date: '2021-06-01', - id: 23_688, - name: 'Test13', - parentId: 23_666, - size: 1024, - type: 'js', - }, - { - date: '2021-06-01', - id: 23_681, - name: 'Test14', - parentId: 23_688, - size: 1024, - type: 'js', - }, - { - date: '2021-06-01', - id: 23_682, - name: 'Test15', - parentId: 23_688, - size: 1024, - type: 'js', - }, - { - date: '2020-10-01', - id: 24_555, - name: 'Test16', - parentId: null, - size: 224, - type: 'avi', - }, - { - date: '2021-06-01', - id: 24_566, - name: 'Test17', - parentId: 24_555, - size: 1024, - type: 'js', - }, - { - date: '2021-06-01', - id: 24_577, - name: 'Test18', - parentId: 24_555, - size: 1024, - type: 'js', - }, -]; - -export const MOCK_API_DATA = [ - { - available: true, - category: 'Computers', - color: 'purple', - currency: 'NAD', - description: - 'Ergonomic executive chair upholstered in bonded black leather and PVC padded seat and back for all-day comfort and support', - id: '45a613df-227a-4907-a89f-4a7f1252ca0c', - imageUrl: 'https://avatars.githubusercontent.com/u/62715097', - imageUrl2: 'https://avatars.githubusercontent.com/u/75395683', - inProduction: false, - open: true, - price: '48.89', - productName: 'Handcrafted Steel Salad', - quantity: 70, - rating: 3.780_582_329_574_367, - releaseDate: '2024-09-09T04:06:57.793Z', - status: 'error', - tags: ['Bespoke', 'Handmade', 'Luxurious'], - weight: 1.031_015_671_912_002_5, - }, - { - available: true, - category: 'Toys', - color: 'green', - currency: 'CZK', - description: - 'The Nagasaki Lander is the trademarked name of several series of Nagasaki sport bikes, that started with the 1984 ABC800J', - id: 'd02e5ee9-bc98-4de2-98fa-25a6567ecc19', - imageUrl: 'https://avatars.githubusercontent.com/u/51512330', - imageUrl2: 'https://avatars.githubusercontent.com/u/58698113', - inProduction: false, - open: false, - price: '68.15', - productName: 'Generic Cotton Gloves', - quantity: 3, - rating: 1.681_749_367_682_703_3, - releaseDate: '2024-06-16T09:00:36.806Z', - status: 'warning', - tags: ['Rustic', 'Handcrafted', 'Recycled'], - weight: 9.601_076_149_300_575, - }, - { - available: true, - category: 'Beauty', - color: 'teal', - currency: 'OMR', - description: - 'The Apollotech B340 is an affordable wireless mouse with reliable connectivity, 12 months battery life and modern design', - id: '2b72521c-225c-4e64-8030-611b76b10b37', - imageUrl: 'https://avatars.githubusercontent.com/u/50300075', - imageUrl2: 'https://avatars.githubusercontent.com/u/36541691', - inProduction: true, - open: true, - price: '696.94', - productName: 'Gorgeous Soft Ball', - quantity: 50, - rating: 2.361_581_777_372_057_5, - releaseDate: '2024-06-03T13:24:19.809Z', - status: 'warning', - tags: ['Gorgeous', 'Ergonomic', 'Licensed'], - weight: 8.882_340_049_286_19, - }, - { - available: true, - category: 'Games', - color: 'silver', - currency: 'SOS', - description: - 'Carbonite web goalkeeper gloves are ergonomically designed to give easy fit', - id: 'bafab694-3801-452c-b102-9eb519bd1143', - imageUrl: 'https://avatars.githubusercontent.com/u/89827115', - imageUrl2: 'https://avatars.githubusercontent.com/u/55952747', - inProduction: false, - open: false, - price: '553.84', - productName: 'Bespoke Soft Computer', - quantity: 29, - rating: 2.176_412_873_760_271_7, - releaseDate: '2024-09-17T12:16:27.034Z', - status: 'error', - tags: ['Elegant', 'Rustic', 'Recycled'], - weight: 9.653_285_869_978_038, - }, - { - available: true, - category: 'Toys', - color: 'indigo', - currency: 'BIF', - description: - 'Andy shoes are designed to keeping in mind durability as well as trends, the most stylish range of shoes & sandals', - id: 'bf6dea6b-2a55-441d-8773-937e03d99389', - imageUrl: 'https://avatars.githubusercontent.com/u/21431092', - imageUrl2: 'https://avatars.githubusercontent.com/u/3771350', - inProduction: true, - open: true, - price: '237.39', - productName: 'Handcrafted Cotton Mouse', - quantity: 54, - rating: 4.363_265_388_265_461, - releaseDate: '2023-10-23T13:42:34.947Z', - status: 'error', - tags: ['Unbranded', 'Handmade', 'Generic'], - weight: 9.513_203_612_535_571, - }, - { - available: false, - category: 'Tools', - color: 'violet', - currency: 'TZS', - description: - 'New ABC 13 9370, 13.3, 5th Gen CoreA5-8250U, 8GB RAM, 256GB SSD, power UHD Graphics, OS 10 Home, OS Office A & J 2016', - id: '135ba6ab-32ee-4989-8189-5cfa658ef970', - imageUrl: 'https://avatars.githubusercontent.com/u/29946092', - imageUrl2: 'https://avatars.githubusercontent.com/u/23842994', - inProduction: false, - open: false, - price: '825.25', - productName: 'Awesome Bronze Ball', - quantity: 94, - rating: 4.251_159_804_726_753, - releaseDate: '2023-12-30T07:31:43.464Z', - status: 'warning', - tags: ['Handmade', 'Elegant', 'Unbranded'], - weight: 2.247_473_385_732_636_8, - }, - { - available: true, - category: 'Automotive', - color: 'teal', - currency: 'BOB', - description: 'The Football Is Good For Training And Recreational Purposes', - id: '652ef256-7d4e-48b7-976c-7afaa781ea92', - imageUrl: 'https://avatars.githubusercontent.com/u/2531904', - imageUrl2: 'https://avatars.githubusercontent.com/u/15215990', - inProduction: false, - open: false, - price: '780.49', - productName: 'Oriental Rubber Pants', - quantity: 70, - rating: 2.636_323_417_377_916, - releaseDate: '2024-02-23T23:30:49.628Z', - status: 'success', - tags: ['Unbranded', 'Elegant', 'Unbranded'], - weight: 4.812_965_858_018_838, - }, - { - available: false, - category: 'Garden', - color: 'plum', - currency: 'LRD', - description: - 'The slim & simple Maple Gaming Keyboard from Dev Byte comes with a sleek body and 7- Color RGB LED Back-lighting for smart functionality', - id: '3ea24798-6589-40cc-85f0-ab78752244a0', - imageUrl: 'https://avatars.githubusercontent.com/u/23165285', - imageUrl2: 'https://avatars.githubusercontent.com/u/14595665', - inProduction: false, - open: true, - price: '583.85', - productName: 'Handcrafted Concrete Hat', - quantity: 15, - rating: 1.371_600_527_752_802_7, - releaseDate: '2024-03-02T19:40:50.255Z', - status: 'error', - tags: ['Rustic', 'Sleek', 'Ergonomic'], - weight: 4.926_949_366_405_728_4, - }, - { - available: false, - category: 'Industrial', - color: 'salmon', - currency: 'AUD', - description: - 'The Apollotech B340 is an affordable wireless mouse with reliable connectivity, 12 months battery life and modern design', - id: '997113dd-f6e4-4acc-9790-ef554c7498d1', - imageUrl: 'https://avatars.githubusercontent.com/u/49021914', - imageUrl2: 'https://avatars.githubusercontent.com/u/4690621', - inProduction: true, - open: false, - price: '67.99', - productName: 'Generic Rubber Bacon', - quantity: 68, - rating: 4.129_840_682_128_08, - releaseDate: '2023-12-17T01:40:25.415Z', - status: 'error', - tags: ['Oriental', 'Small', 'Handcrafted'], - weight: 1.080_114_331_801_906_4, - }, - { - available: false, - category: 'Tools', - color: 'sky blue', - currency: 'NOK', - description: - 'The Nagasaki Lander is the trademarked name of several series of Nagasaki sport bikes, that started with the 1984 ABC800J', - id: 'f697a250-6cb2-46c8-b0f7-871ab1f2fa8d', - imageUrl: 'https://avatars.githubusercontent.com/u/95928385', - imageUrl2: 'https://avatars.githubusercontent.com/u/47588244', - inProduction: false, - open: false, - price: '613.89', - productName: 'Gorgeous Frozen Ball', - quantity: 55, - rating: 1.646_947_205_998_534_6, - releaseDate: '2024-10-13T12:31:04.929Z', - status: 'warning', - tags: ['Handmade', 'Unbranded', 'Unbranded'], - weight: 9.430_690_557_758_114, - }, -]; diff --git a/docs/src/demos/vben-vxe-table/tree/index.vue b/docs/src/demos/vben-vxe-table/tree/index.vue deleted file mode 100644 index 0024765a..00000000 --- a/docs/src/demos/vben-vxe-table/tree/index.vue +++ /dev/null @@ -1,80 +0,0 @@ - - - diff --git a/docs/src/demos/vben-vxe-table/virtual/index.vue b/docs/src/demos/vben-vxe-table/virtual/index.vue deleted file mode 100644 index 81fa00af..00000000 --- a/docs/src/demos/vben-vxe-table/virtual/index.vue +++ /dev/null @@ -1,64 +0,0 @@ - - - diff --git a/docs/src/en/guide/essentials/build.md b/docs/src/en/guide/essentials/build.md deleted file mode 100644 index 7f5c9532..00000000 --- a/docs/src/en/guide/essentials/build.md +++ /dev/null @@ -1,243 +0,0 @@ -# Build and Deployment - -::: tip Preface - -Since this is a demonstration project, the package size after building is relatively large. If there are plugins in the project that are not used, you can delete the corresponding files or routes. If they are not referenced, they will not be packaged. - -::: - -## Building - -After the project development is completed, execute the following command to build: - -**Note:** Please execute the following command in the project root directory. - -```bash -pnpm build -``` - -After the build is successful, a `dist` folder for the corresponding application will be generated in the root directory, which contains the built and packaged files, for example: `apps/web-antd/dist/` - -## Preview - -Before publishing, you can preview it locally in several ways, here are two: - -- Using the project's custom command for preview (recommended) - -**Note：** Please execute the following command in the project root directory. - -```bash -pnpm preview -``` - -After waiting for the build to succeed, visit `http://localhost:4173` to view the effect. - -- Local server preview - -You can globally install a `serve` service on your computer, such as `live-server`, - -```bash -npm i -g live-server -``` - -Then execute the `live-server` command in the `dist` directory to view the effect locally. - -```bash -cd apps/web-antd/dist -# Local preview, default port 8080 -live-server -# Specify port -live-server --port 9000 -``` - -## Compression - -### Enable `gzip` Compression - -To enable during the build process, change the `.env.production` configuration: - -```bash -VITE_COMPRESS=gzip -``` - -### Enable `brotli` Compression - -To enable during the build process, change the `.env.production` configuration: - -```bash -VITE_COMPRESS=brotli -``` - -### Enable Both `gzip` and `brotli` Compression - -To enable during the build process, change the `.env.production` configuration: - -```bash -VITE_COMPRESS=gzip,brotli -``` - -::: tip Note - -Both `gzip` and `brotli` require specific modules to be installed for use. - -::: - -::: details gzip 与 brotli 在 nginx 内的配置 - -```bash -http { - # Enable gzip - gzip on; - # Enable gzip_static - # After enabling gzip_static, there might be errors, requiring the installation of specific modules. The installation method can be researched independently. - # Only with this enabled, the .gz files packaged by vue files will be effective; otherwise, there is no need to enable gzip for packaging. - gzip_static on; - gzip_proxied any; - gzip_min_length 1k; - gzip_buffers 4 16k; - # If nginx uses multiple layers of proxy, this must be set to enable gzip. - gzip_http_version 1.0; - gzip_comp_level 2; - gzip_types text/plain application/javascript application/x-javascript text/css application/xml text/javascript application/x-httpd-php image/jpeg image/gif image/png; - gzip_vary off; - gzip_disable "MSIE [1-6]\."; - - # Enable brotli compression - # Requires the installation of the corresponding nginx module, which can be researched independently. - # Can coexist with gzip without conflict. - brotli on; - brotli_comp_level 6; - brotli_buffers 16 8k; - brotli_min_length 20; - brotli_types text/plain text/css application/json application/x-javascript text/xml application/xml application/xml+rss text/javascript application/javascript image/svg+xml; -} -``` - -::: - -## Build Analysis - -If your build files are large, you can optimize your code by analyzing the code size with the built-in [rollup-plugin-analyzer](https://github.com/doesdev/rollup-plugin-analyzer) plugin. Just execute the following command in the `root directory`: - -```bash -pnpm run build:analyze -``` - -After running, you can see the specific distribution of sizes on the automatically opened page to analyze which dependencies are problematic. - -![Build analysis report](/guide/report.png) - -## Deployment - -A simple deployment only requires publishing the final static files, the static files in the dist folder, to your CDN or static server. It's important to note that the index.html is usually the entry page for your backend service. After determining the static js and css, you may need to change the page's import path. - -For example, to upload to an nginx server, you can upload the files under the dist folder to the server's `/srv/www/project/index.html` directory, and then access the configured domain name. - -```bash -# nginx configuration -location / { - # Do not cache html to prevent cache from continuing to be effective after program updates - if ($request_filename ~* .*\.(?:htm|html)$) { - add_header Cache-Control "private, no-store, no-cache, must-revalidate, proxy-revalidate"; - access_log on; - } - # This is the storage path for the files inside the vue packaged dist folder - root /srv/www/project/; - index index.html index.htm; -} -``` - -If you find the resource path is incorrect during deployment, you just need to modify the `.env.production` file. - -```bash -# Configure the change according to your own path -# Note that it needs to start and end with / -VITE_BASE=/ -VITE_BASE=/xxx/ -``` - -### Integration of Frontend Routing and Server - -The project uses vue-router for frontend routing, so you can choose between two modes: history and hash. - -- `hash` mode will append `#` to the URL by default. -- `history` mode will not, but `history` mode requires server-side support. - -You can modify the mode in `.env.production`: - -```bash -VITE_ROUTER_HISTORY=hash -``` - -### Server Configuration for History Mode Routing - -Enabling `history` mode requires server configuration. For more details on server configuration, see [history-mode](https://router.vuejs.org/guide/essentials/history-mode.html#html5-mode) - -Here is an example of `nginx` configuration: - -#### Deployment at the Root Directory - -```bash {5} -server { - listen 80; - location / { - # For use with History mode - try_files $uri $uri/ /index.html; - } -} -``` - -#### Deployment to a Non-root Directory - -- First, you need to change the `.env.production` configuration during packaging: - -```bash -VITE_BASE = /sub/ -``` - -- Then configure in the nginx configuration file - -```bash {8} -server { - listen 80; - server_name localhost; - location /sub/ { - # This is the path where the vue packaged dist files are stored - alias /srv/www/project/; - index index.html index.htm; - try_files $uri $uri/ /sub/index.html; - } -} -``` - -## Cross-Domain Handling - -Using nginx to handle cross-domain issues after project deployment - -1. Configure the frontend project API address in the `.env.production` file in the project directory: - -```bash -VITE_GLOB_API_URL=/api -``` - -2. Configure nginx to forward requests to the backend - -```bash {10-11} -server { - listen 8080; - server_name localhost; - # API proxy for solving cross-domain issues - location /api { - proxy_set_header Host $host; - proxy_set_header X-Real-IP $remote_addr; - proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; - # Backend API address - proxy_pass http://110.110.1.1:8080/api; - rewrite "^/api/(.*)$" /$1 break; - proxy_redirect default; - add_header Access-Control-Allow-Origin *; - add_header Access-Control-Allow-Headers X-Requested-With; - add_header Access-Control-Allow-Methods GET,POST,OPTIONS; - } -} -``` diff --git a/docs/src/en/guide/essentials/concept.md b/docs/src/en/guide/essentials/concept.md deleted file mode 100644 index 8c940a94..00000000 --- a/docs/src/en/guide/essentials/concept.md +++ /dev/null @@ -1,70 +0,0 @@ -# Basic Concepts - -In the new version, the entire project has been restructured. Now, we will introduce some basic concepts to help you better understand the entire document. Please make sure to read this section first. - -## Monorepo - -Monorepo refers to the repository of the entire project, which includes all code, packages, applications, standards, documentation, configurations, etc., that is, the entire content of a `Monorepo` directory. - -## Applications - -Applications refer to a complete project; a project can contain multiple applications, which can reuse the code, packages, standards, etc., within the monorepo. Applications are placed in the `apps` directory. Each application is independent and can be run, built, tested, and deployed separately; it can also include different component libraries, etc. - -::: tip - -Applications are not limited to front-end applications; they can also be back-end applications, mobile applications, etc. For example, `apps/backend-mock` is a back-end service. - -::: - -## Packages - -A package refers to an independent module, which can be a component, a tool, a library, etc. Packages can be referenced by multiple applications or other packages. Packages are placed in the `packages` directory. - -You can consider these packages as independent `npm` packages, and they are used in the same way as `npm` packages. - -### Package Import - -Importing a package in `package.json`: - -```json {3} -{ - "dependencies": { - "@vben/utils": "workspace:*" - } -} -``` - -### Package Usage - -Importing a package in the code: - -```ts -import { isString } from '@vben/utils'; -``` - -## Aliases - -In the project, you can see some paths starting with `#`, such as `#/api`, `#/views`. These paths are aliases, used for quickly locating a certain directory. They are not implemented through `vite`'s `alias`, but through the principle of [subpath imports](https://nodejs.org/api/packages.html#subpath-imports) in `Node.js` itself. You only need to configure the `imports` field in `package.json`. - -```json {3} -{ - "imports": { - "#/*": "./src/*" - } -} -``` - -To make these aliases recognizable by the IDE, we also need to configure them in `tsconfig.json`: - -```json {5} -{ - "compilerOptions": { - "baseUrl": ".", - "paths": { - "#/*": ["src/*"] - } - } -} -``` - -This way, you can use aliases in your code. diff --git a/docs/src/en/guide/essentials/development.md b/docs/src/en/guide/essentials/development.md deleted file mode 100644 index 437810f7..00000000 --- a/docs/src/en/guide/essentials/development.md +++ /dev/null @@ -1,257 +0,0 @@ -# Local Development {#development} - -::: tip Code Acquisition - -If you haven't acquired the code yet, you can start by reading the documentation from [Quick Start](../introduction/quick-start.md). - -::: - -## Prerequisites - -For a better development experience, we provide some tool configurations and project descriptions to facilitate your development. - -### Required Basic Knowledge - -This project requires some basic frontend knowledge. Please ensure you are familiar with the basics of Vue to handle common issues. It is recommended to learn the following topics before development. Understanding these will be very helpful for the project: - -- [Vue3](https://vuejs.org/) -- [Tailwind CSS](https://tailwindcss.com/) -- [TypeScript](https://www.typescriptlang.org/) -- [Vue Router](https://router.vuejs.org/) -- [Vitejs](https://vitejs.dev/) -- [Pnpm](https://pnpm.io/) -- [Turbo](https://turbo.build/) - -### Tool Configuration - -If you are using [vscode](https://code.visualstudio.com/) (recommended) as your IDE, you can install the following tools to improve development efficiency and code formatting: - -- [Vue - Official](https://marketplace.visualstudio.com/items?itemName=Vue.volar) - Official Vue plugin (essential). -- [Tailwind CSS](https://marketplace.visualstudio.com/items?itemName=bradlc.vscode-tailwindcss) - Tailwind CSS autocomplete plugin. -- [CSS Variable Autocomplete](https://marketplace.visualstudio.com/items?itemName=vunguyentuan.vscode-css-variables) - CSS variable autocomplete plugin. -- [Iconify IntelliSense](https://marketplace.visualstudio.com/items?itemName=antfu.iconify) - Iconify icon plugin. -- [i18n Ally](https://marketplace.visualstudio.com/items?itemName=Lokalise.i18n-ally) - i18n plugin. -- [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) - Script code linting. -- [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) - Code formatting. -- [Stylelint](https://marketplace.visualstudio.com/items?itemName=stylelint.vscode-stylelint) - CSS formatting. -- [Code Spell Checker](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker) - Spelling checker. -- [DotENV](https://marketplace.visualstudio.com/items?itemName=mikestead.dotenv) - .env file highlighting. - -## Npm Scripts - -Npm scripts are common configurations used in the project to perform common tasks such as starting the project, building the project, etc. The following scripts can be found in the `package.json` file at the root of the project. - -The execution command is: `pnpm run [script]` or `npm run [script]`. - -```json -{ - "scripts": { - // Build the project - "build": "cross-env NODE_OPTIONS=--max-old-space-size=8192 turbo build", - // Build the project with analysis - "build:analyze": "turbo build:analyze", - // Build a local Docker image - "build:docker": "./build-local-docker-image.sh", - // Build the web-antd application separately - "build:antd": "pnpm run build --filter=@vben/web-antd", - // Build the documentation separately - "build:docs": "pnpm run build --filter=@vben/docs", - // Build the web-ele application separately - "build:ele": "pnpm run build --filter=@vben/web-ele", - // Build the web-naive application separately - "build:naive": "pnpm run build --filter=@vben/naive", - // Build the web-tdesign application separately - "build:tdesign": "pnpm run build --filter=@vben/web-tdesign", - // Build the playground application separately - "build:play": "pnpm run build --filter=@vben/playground", - // Changeset version management - "changeset": "pnpm exec changeset", - // Check for various issues in the project - "check": "pnpm run check:circular && pnpm run check:dep && pnpm run check:type && pnpm check:cspell", - // Check for circular dependencies - "check:circular": "vsh check-circular", - // Check spelling - "check:cspell": "cspell lint **/*.ts **/README.md .changeset/*.md --no-progress" - // Check dependencies - "check:dep": "vsh check-dep", - // Check types - "check:type": "turbo run typecheck", - // Clean the project (delete node_modules, dist, .turbo, etc.) - "clean": "node ./scripts/clean.mjs", - // Commit code - "commit": "czg", - // Start the project (by default, the dev scripts of all packages in the entire repository will run) - "dev": "turbo-run dev", - // Start the web-antd application - "dev:antd": "pnpm -F @vben/web-antd run dev", - // Start the documentation - "dev:docs": "pnpm -F @vben/docs run dev", - // Start the web-ele application - "dev:ele": "pnpm -F @vben/web-ele run dev", - // Start the web-naive application - "dev:naive": "pnpm -F @vben/web-naive run dev", - // Start the playground application - "dev:play": "pnpm -F @vben/playground run dev", - // Format code - "format": "vsh lint --format", - // Lint code - "lint": "vsh lint", - // After installing dependencies, execute the stub script for all packages - "postinstall": "pnpm -r run stub --if-present", - // Only allow using pnpm - "preinstall": "npx only-allow pnpm", - // Install lefthook - "prepare": "is-ci || lefthook install", - // Preview the application - "preview": "turbo-run preview", - // Package specification check - "publint": "vsh publint", - // Delete all node_modules, yarn.lock, package.lock.json, and reinstall dependencies - "reinstall": "pnpm clean --del-lock && pnpm install", - // Run vitest unit tests - "test:unit": "vitest run --dom", - // Update project dependencies - "update:deps": " pnpm update --latest --recursive", - // Changeset generation and versioning - "version": "pnpm exec changeset version && pnpm install --no-frozen-lockfile" - } -} -``` - -## Running the Project Locally - -To run the documentation locally and make adjustments, you can execute the following command. This command allows you to select the application you want to develop: - -```bash -pnpm dev -``` - -If you want to run a specific application directly, you can execute the following commands: - -To run the `web-antd` application: - -```bash -pnpm dev:antd -``` - -To run the `web-naive` application: - -```bash -pnpm dev:naive -``` - -To run the `web-ele` application: - -```bash -pnpm dev:ele -``` - -To run the `docs` application: - -```bash -pnpm dev:docs -``` - -### Distinguishing Build Environments - -In actual business development, multiple environments are usually distinguished during the build process, such as the test environment `test` and the production environment `build`. - -At this point, you can modify three files and add corresponding script configurations to distinguish between production environments. - -Take the addition of the test environment `test` to `@vben/web-antd` as an example: - -- `apps\web-antd\package.json` - -```json -"scripts": { - "build:prod": "pnpm vite build --mode production", - "build:test": "pnpm vite build --mode test", - "build:analyze": "pnpm vite build --mode analyze", - "dev": "pnpm vite --mode development", - "preview": "vite preview", - "typecheck": "vue-tsc --noEmit --skipLibCheck" -} -``` - -Add the command `"build:test"` and change the original `"build"` to `"build:prod"` to avoid building packages for two environments simultaneously. - -- `package.json` - -```json -"scripts": { - "build": "cross-env NODE_OPTIONS=--max-old-space-size=8192 turbo build", - "build:analyze": "turbo build:analyze", - "build:antd": "pnpm run build --filter=@vben/web-antd", - "build-test:antd": "pnpm run build --filter=@vben/web-antd build:test", - - ······ -} -``` - -Add the command to build the test environment in the root directory `package.json`. - -- `turbo.json` - -```json -"tasks": { - "build": { - "dependsOn": ["^build"], - "outputs": [ - "dist/**", - "dist.zip", - ".vitepress/dist.zip", - ".vitepress/dist/**" - ] - }, - - "build-test:antd": { - "dependsOn": ["@vben/web-antd#build:test"], - "outputs": ["dist/**"] - }, - - "@vben/web-antd#build:test": { - "dependsOn": ["^build"], - "outputs": ["dist/**"] - }, - - ······ -``` - -Add the relevant dependent commands in `turbo.json`. - -## Public Static Resources - -If you need to use public static resources in the project, such as images, static HTML, etc., and you want to directly import them in the development process through `src="/xxx.png"`. - -You need to put the resource in the corresponding project's `public/static` directory. The import path for the resource should be `src="/static/xxx.png"`. - -## DevTools - -The project has a built-in [Vue DevTools](https://github.com/vuejs/devtools-next) plugin, which can be used during development. It is disabled by default, but can be enabled in the `.env.development` file. After enabling it, restart the project: - -```bash -VITE_DEVTOOLS=true -``` - -Once enabled, a Vue DevTools icon will appear at the bottom of the page during project runtime. Click it to open the DevTools. - -![Vue DevTools](/guide/devtools.png) - -## Running Documentation Locally - -To run the documentation locally and make adjustments, you can execute the following command: - -```bash -pnpm dev:docs -``` - -## Troubleshooting - -If you encounter dependency-related issues, you can try reinstalling the dependencies: - -```bash -# Execute this command at the root of the project. -# This command will delete all node_modules, yarn.lock, and package.lock.json files -# and then reinstall dependencies (this process will be noticeably slower). -pnpm reinstall -``` diff --git a/docs/src/en/guide/essentials/external-module.md b/docs/src/en/guide/essentials/external-module.md deleted file mode 100644 index f0a6d6e3..00000000 --- a/docs/src/en/guide/essentials/external-module.md +++ /dev/null @@ -1,58 +0,0 @@ -# External Modules - -In addition to the external modules that are included by default in the project, sometimes we need to import other external modules. Let's take [ant-design-vue](https://antdv.com/components/overview) as an example: - -## Installing Dependencies - -::: tip Install dependencies into a specific package - -- Since the project uses [pnpm](https://pnpm.io/) as the package management tool, we need to use the `pnpm` command to install dependencies. -- As the project is managed using a Monorepo module, we need to install dependencies under a specific package. Please make sure you have entered the specific package directory before installing dependencies. - -::: - -```bash -# cd /path/to/your/package -pnpm add ant-design-vue -``` - -## Usage - -### Global Import - -```ts -import { createApp } from 'vue'; -import Antd from 'ant-design-vue'; -import App from './App'; -import 'ant-design-vue/dist/reset.css'; - -const app = createApp(App); - -app.use(Antd).mount('#app'); -``` - -#### Usage - -```vue - -``` - -### Partial Import - -```vue - - - -``` - -::: warning Note - -- If the component depends on styles, you also need to import the style file. - -::: diff --git a/docs/src/en/guide/essentials/icons.md b/docs/src/en/guide/essentials/icons.md deleted file mode 100644 index 0c1631fe..00000000 --- a/docs/src/en/guide/essentials/icons.md +++ /dev/null @@ -1,78 +0,0 @@ -# Icons - -::: tip About Icon Management - -- The icons in the project are mainly provided by the `@vben/icons` package. It is recommended to manage them within this package for unified management and maintenance. -- If you are using `Vscode`, it is recommended to install the [Iconify IntelliSense](https://marketplace.visualstudio.com/items?itemName=antfu.iconify) plugin, which makes it easy to find and use icons. - -::: - -There are several ways to use icons in the project, you can choose according to the actual situation: - -## Iconify Icons - -Integrated with the [iconify](https://github.com/iconify/iconify) icon library - -### Adding New Icons - -You can add new icons in the `packages/icons/src/iconify` directory: - -```ts -// packages/icons/src/iconify/index.ts -import { createIconifyIcon } from '@vben-core/icons'; - -export const MdiKeyboardEsc = createIconifyIcon('mdi:keyboard-esc'); -``` - -### Usage - -```vue - - - -``` - -## SVG Icons - -Instead of using Svg Sprite, SVG icons are directly imported, - -### Adding New Icons - -You can add new icon files `test.svg` in the `packages/icons/src/svg/icons` directory, and then import it in `packages/icons/src/svg/index.ts`: - -```ts -// packages/icons/src/svg/index.ts -import { createIconifyIcon } from '@vben-core/icons'; - -const SvgTestIcon = createIconifyIcon('svg:test'); - -export { SvgTestIcon }; -``` - -### Usage - -```vue - - - -``` - -## Tailwind CSS Icons - -### Usage - -You can use the icons by directly adding the Tailwind CSS icon class names, which can be found on [iconify](https://github.com/iconify/iconify) ： - -```vue - -``` diff --git a/docs/src/en/guide/essentials/route.md b/docs/src/en/guide/essentials/route.md deleted file mode 100644 index 8fb0a6d1..00000000 --- a/docs/src/en/guide/essentials/route.md +++ /dev/null @@ -1,603 +0,0 @@ ---- -outline: deep ---- - -# Routes and Menus - -::: info - -This page is translated by machine translation and may not be very accurate. - -::: - -In the project, the framework provides a basic routing system and **automatically generates the corresponding menu structure based on the routing files**. - -## Types of Routes - -Routes are divided into core routes, static routes, and dynamic routes. Core routes are built-in routes of the framework, including root routes, login routes, 404 routes, etc.; static routes are routes that are determined when the project starts; dynamic routes are generally generated dynamically based on the user's permissions after the user logs in. - -Both static and dynamic routes go through permission control, which can be controlled by configuring the `authority` field in the `meta` property of the route. - -### Core Routes - -Core routes are built-in routes of the framework, including root routes, login routes, 404 routes, etc. The configuration of core routes is in the `src/router/routes/core` directory under the application. - -::: tip - -Core routes are mainly used for the basic functions of the framework, so it is not recommended to put business-related routes in core routes. It is recommended to put business-related routes in static or dynamic routes. - -::: - -### Static Routes - -The configuration of static routes is in the `src/router/routes/index` directory under the application. Open the commented file content: - -::: tip - -Permission control is controlled by the `authority` field in the `meta` property of the route. If your page project does not require permission control, you can omit the `authority` field. - -::: - -```ts -// Uncomment if needed and create the folder -// const externalRouteFiles = import.meta.glob('./external/**/*.ts', { eager: true }); // [!code --] -const staticRouteFiles = import.meta.glob('./static/**/*.ts', { eager: true }); // [!code ++] -/** Dynamic routes */ -const dynamicRoutes: RouteRecordRaw[] = mergeRouteModules(dynamicRouteFiles); - -/** External route list, these pages can be accessed without Layout, possibly used for embedding in other systems */ -// const externalRoutes: RouteRecordRaw[] = mergeRouteModules(externalRouteFiles) // [!code --] -const externalRoutes: RouteRecordRaw[] = []; // [!code --] -const externalRoutes: RouteRecordRaw[] = mergeRouteModules(externalRouteFiles); // [!code ++] -``` - -### Dynamic Routes - -The configuration of dynamic routes is in the `src/router/routes/modules` directory under the corresponding application. This directory contains all the route files. The content format of each file is consistent with the Vue Router route configuration format. Below is the configuration of secondary and multi-level routes. - -## Route Definition - -The configuration method of static routes and dynamic routes is the same. Below is the configuration of secondary and multi-level routes: - -### Secondary Routes - -::: details Secondary Route Example Code - -```ts -import type { RouteRecordRaw } from 'vue-router'; - -import { VBEN_LOGO_URL } from '@vben/constants'; - -import { BasicLayout } from '#/layouts'; -import { $t } from '#/locales'; - -const routes: RouteRecordRaw[] = [ - { - meta: { - badgeType: 'dot', - badgeVariants: 'destructive', - icon: VBEN_LOGO_URL, - order: 9999, - title: $t('page.vben.title'), - }, - name: 'VbenProject', - path: '/vben-admin', - redirect: '/vben-admin/about', - children: [ - { - name: 'VbenAbout', - path: '/vben-admin/about', - component: () => import('#/views/_core/about/index.vue'), - meta: { - badgeType: 'dot', - badgeVariants: 'destructive', - icon: 'lucide:copyright', - title: $t('page.vben.about'), - }, - }, - ], - }, -]; - -export default routes; -``` - -::: - -### Multi-level Routes - -::: tip - -- The parent route of multi-level routes does not need to set the `component` property, just set the `children` property. Unless you really need to display content nested under the parent route. -- In most cases, the `redirect` property of the parent route does not need to be specified, it will default to the first child route. - -::: - -::: details Multi-level Route Example Code - -```ts -import type { RouteRecordRaw } from 'vue-router'; - -import { BasicLayout } from '#/layouts'; -import { $t } from '#/locales'; - -const routes: RouteRecordRaw[] = [ - { - meta: { - icon: 'ic:baseline-view-in-ar', - keepAlive: true, - order: 1000, - title: $t('demos.title'), - }, - name: 'Demos', - path: '/demos', - redirect: '/demos/access', - children: [ - // Nested menu - { - meta: { - icon: 'ic:round-menu', - title: $t('demos.nested.title'), - }, - name: 'NestedDemos', - path: '/demos/nested', - redirect: '/demos/nested/menu1', - children: [ - { - name: 'Menu1Demo', - path: '/demos/nested/menu1', - component: () => import('#/views/demos/nested/menu-1.vue'), - meta: { - icon: 'ic:round-menu', - keepAlive: true, - title: $t('demos.nested.menu1'), - }, - }, - { - name: 'Menu2Demo', - path: '/demos/nested/menu2', - meta: { - icon: 'ic:round-menu', - keepAlive: true, - title: $t('demos.nested.menu2'), - }, - redirect: '/demos/nested/menu2/menu2-1', - children: [ - { - name: 'Menu21Demo', - path: '/demos/nested/menu2/menu2-1', - component: () => import('#/views/demos/nested/menu-2-1.vue'), - meta: { - icon: 'ic:round-menu', - keepAlive: true, - title: $t('demos.nested.menu2_1'), - }, - }, - ], - }, - { - name: 'Menu3Demo', - path: '/demos/nested/menu3', - meta: { - icon: 'ic:round-menu', - title: $t('demos.nested.menu3'), - }, - redirect: '/demos/nested/menu3/menu3-1', - children: [ - { - name: 'Menu31Demo', - path: 'menu3-1', - component: () => import('#/views/demos/nested/menu-3-1.vue'), - meta: { - icon: 'ic:round-menu', - keepAlive: true, - title: $t('demos.nested.menu3_1'), - }, - }, - { - name: 'Menu32Demo', - path: 'menu3-2', - meta: { - icon: 'ic:round-menu', - title: $t('demos.nested.menu3_2'), - }, - redirect: '/demos/nested/menu3/menu3-2/menu3-2-1', - children: [ - { - name: 'Menu321Demo', - path: '/demos/nested/menu3/menu3-2/menu3-2-1', - component: () => - import('#/views/demos/nested/menu-3-2-1.vue'), - meta: { - icon: 'ic:round-menu', - keepAlive: true, - title: $t('demos.nested.menu3_2_1'), - }, - }, - ], - }, - ], - }, - ], - }, - ], - }, -]; - -export default routes; -``` - -::: - -## Adding a New Page - -To add a new page, you only need to add a route and the corresponding page component. - -### Adding a Route - -Add a route object in the corresponding route file, as follows: - -```ts -import type { RouteRecordRaw } from 'vue-router'; - -import { VBEN_LOGO_URL } from '@vben/constants'; - -import { BasicLayout } from '#/layouts'; -import { $t } from '#/locales'; - -const routes: RouteRecordRaw[] = [ - { - meta: { - icon: 'mdi:home', - title: $t('page.home.title'), - }, - name: 'Home', - path: '/home', - redirect: '/home/index', - children: [ - { - name: 'HomeIndex', - path: '/home/index', - component: () => import('#/views/home/index.vue'), - meta: { - icon: 'mdi:home', - title: $t('page.home.index'), - }, - }, - ], - }, -]; - -export default routes; -``` - -### Adding a Page Component - -In `#/views/home/`, add a new `index.vue` file, as follows: - -```vue - -``` - -### Verification - -At this point, the page has been added. Visit `http://localhost:5555/home/index` to see the corresponding page. - -## Route Configuration - -The route configuration items are mainly in the `meta` property of the route object. The following are common configuration items: - -```ts {5-8} -const routes = [ - { - name: 'HomeIndex', - path: '/home/index', - meta: { - icon: 'mdi:home', - title: $t('page.home.index'), - }, - }, -]; -``` - -::: details Route Meta Configuration Type Definition - -```ts -interface RouteMeta { - /** - * Active icon (menu) - */ - activeIcon?: string; - /** - * The currently active menu, sometimes you don't want to activate the existing menu, use this to activate the parent menu - */ - activePath?: string; - /** - * Whether to fix the tab - * @default false - */ - affixTab?: boolean; - /** - * The order of fixed tabs - * @default 0 - */ - affixTabOrder?: number; - /** - * Specific roles required to access - * @default [] - */ - authority?: string[]; - /** - * Badge - */ - badge?: string; - /** - * Badge type - */ - badgeType?: 'dot' | 'normal'; - /** - * Badge color - */ - badgeVariants?: - | 'default' - | 'destructive' - | 'primary' - | 'success' - | 'warning' - | string; - /** - * The children of the current route are not displayed in the menu - * @default false - */ - hideChildrenInMenu?: boolean; - /** - * The current route is not displayed in the breadcrumb - * @default false - */ - hideInBreadcrumb?: boolean; - /** - * The current route is not displayed in the menu - * @default false - */ - hideInMenu?: boolean; - /** - * The current route is not displayed in the tab - * @default false - */ - hideInTab?: boolean; - /** - * Icon (menu/tab) - */ - icon?: string; - /** - * iframe address - */ - iframeSrc?: string; - /** - * Ignore permissions, can be accessed directly - * @default false - */ - ignoreAccess?: boolean; - /** - * Enable KeepAlive cache - */ - keepAlive?: boolean; - /** - * External link - jump path - */ - link?: string; - /** - * Whether the route has been loaded - */ - loaded?: boolean; - /** - * Maximum number of open tabs - * @default false - */ - maxNumOfOpenTab?: number; - /** - * The menu can be seen, but access will be redirected to 403 - */ - menuVisibleWithForbidden?: boolean; - /** - * Open in a new window - */ - openInNewWindow?: boolean; - /** - * Used for route -> menu sorting - */ - order?: number; - /** - * Parameters carried by the menu - */ - query?: Recordable; - /** - * Title name - */ - title: string; -} -``` - -::: - -### title - -- Type: `string` -- Default: `''` - -Used to configure the title of the page, which will be displayed in the menu and tab. Generally used with internationalization. - -### icon - -- Type: `string` -- Default: `''` - -Used to configure the icon of the page, which will be displayed in the menu and tab. Generally used with an icon library, if it is an `http` link, the image will be loaded automatically. - -### activeIcon - -- Type: `string` -- Default: `''` - -Used to configure the active icon of the page, which will be displayed in the menu. Generally used with an icon library, if it is an `http` link, the image will be loaded automatically. - -### keepAlive - -- Type: `boolean` -- Default: `false` - -Used to configure whether the page cache is enabled. When enabled, the page will be cached and will not reload, only effective when the tab is enabled. - -### hideInMenu - -- Type: `boolean` -- Default: `false` - -Used to configure whether the page is hidden in the menu. When hidden, the page will not be displayed in the menu. - -### hideInTab - -- Type: `boolean` -- Default: `false` - -Used to configure whether the page is hidden in the tab. When hidden, the page will not be displayed in the tab. - -### hideInBreadcrumb - -- Type: `boolean` -- Default: `false` - -Used to configure whether the page is hidden in the breadcrumb. When hidden, the page will not be displayed in the breadcrumb. - -### hideChildrenInMenu - -- Type: `boolean` -- Default: `false` - -Used to configure whether the subpages of the page are hidden in the menu. When hidden, the subpages will not be displayed in the menu. - -### authority - -- Type: `string[]` -- Default: `[]` - -Used to configure the permissions of the page. Only users with the corresponding permissions can access the page. If not configured, no permissions are required. - -### badge - -- Type: `string` -- Default: `''` - -Used to configure the badge of the page, which will be displayed in the menu. - -### badgeType - -- Type: `'dot' | 'normal'` -- Default: `'normal'` - -Used to configure the badge type of the page. `dot` is a small red dot, `normal` is text. - -### badgeVariants - -- Type: `'default' | 'destructive' | 'primary' | 'success' | 'warning' | string` -- Default: `'success'` - -Used to configure the badge color of the page. - -### activePath - -- Type: `string` -- Default: `''` - -Used to configure the currently active menu. Sometimes the page is not displayed in the menu, and this is used to activate the parent menu. - -### affixTab - -- Type: `boolean` -- Default: `false` - -Used to configure whether the page is fixed in the tab. When fixed, the page cannot be closed. - -### affixTabOrder - -- Type: `number` -- Default: `0` - -Used to configure the order of fixed tabs, sorted in ascending order. - -### iframeSrc - -- Type: `string` -- Default: `''` - -Used to configure the `iframe` address of the embedded page. When set, the corresponding page will be embedded in the current page. - -### ignoreAccess - -- Type: `boolean` -- Default: `false` - -Used to configure whether the page ignores permissions and can be accessed directly. - -### link - -- Type: `string` -- Default: `''` - -Used to configure the external link jump path, which will open in a new window. - -### maxNumOfOpenTab - -- Type: `number` -- Default: `-1` - -Used to configure the maximum number of open tabs. When set, the earliest opened tab will be automatically closed when opening a new tab (only effective when opening tabs with the same name). - -### menuVisibleWithForbidden - -- Type: `boolean` -- Default: `false` - -Used to configure whether the page can be seen in the menu, but access will be redirected to 403. - -### openInNewWindow - -- Type: `boolean` -- Default: `false` - -When set to `true`, the page will open in a new window. - -### order - -- Type: `number` -- Default: `0` - -Used to configure the sorting of the page, used for route to menu sorting. - -_Note:_ Sorting is only effective for first-level menus. The sorting of second-level menus needs to be set in the corresponding first-level menu in code order. - -### query - -- Type: `Recordable` -- Default: `{}` - -Used to configure the menu parameters of the page, which will be passed to the page in the menu. - -## Route Refresh - -The route refresh method is as follows: - -```vue - -``` diff --git a/docs/src/en/guide/essentials/server.md b/docs/src/en/guide/essentials/server.md deleted file mode 100644 index 67e0b1fd..00000000 --- a/docs/src/en/guide/essentials/server.md +++ /dev/null @@ -1,356 +0,0 @@ -# Server Interaction and Data Mocking - -::: tip Note - -This document explains how to use Mock data and interact with the server in a development environment, involving technologies such as: - -- [Nitro](https://nitro.unjs.io/) A lightweight backend server that can be deployed anywhere, used as a Mock server in the project. -- [axios](https://axios-http.com/docs/intro) Used to send HTTP requests to interact with the server. - -::: - -## Interaction in Development Environment - -If the frontend application and the backend API server are not running on the same host, you need to proxy the API requests to the API server in the development environment. If they are on the same host, you can directly request the specific API endpoint. - -### Local Development CORS Configuration - -::: tip Hint - -The CORS configuration for local development has already been set up. If you have other requirements, you can add or adjust the configuration as needed. - -::: - -#### Configuring Local Development API Endpoint - -Configure the API endpoint in the `.env.development` file at the project root directory, here it is set to `/api`: - -```bash -VITE_GLOB_API_URL=/api -``` - -#### Configuring Development Server Proxy - -In the development environment, if you need to handle CORS, configure the API endpoint in the `vite.config.mts` file under the corresponding application directory: - -```ts{8-16} -// apps/web-antd/vite.config.mts -import { defineConfig } from '@vben/vite-config'; - -export default defineConfig(async () => { - return { - vite: { - server: { - proxy: {// [!code focus:11] - '/api': { - changeOrigin: true, - rewrite: (path) => path.replace(/^\/api/, ''), - // mock proxy - target: 'http://localhost:5320/api', - ws: true, - }, - }, - }, - }, - }; -}); -``` - -#### API Requests - -Based on the above configuration, we can use `/api` as the prefix for API requests in our frontend project, for example: - -```ts -import axios from 'axios'; - -axios.get('/api/user').then((res) => { - console.log(res); -}); -``` - -At this point, the request will be proxied to `http://localhost:5320/api/user`. - -::: warning Note - -From the browser's console Network tab, the request appears as `http://localhost:5555/api/user`. This is because the proxy configuration does not change the local request's URL. - -::: - -### Configuration Without CORS - -If there is no CORS issue, you can directly ignore the [Configure Development Server Proxy](./server.md#configure-development-server-proxy) settings and set the API endpoint directly in `VITE_GLOB_API_URL`. - -Configure the API endpoint in the `.env.development` file at the project root directory: - -```bash -VITE_GLOB_API_URL=https://mock-napi.vben.pro/api -``` - -## Production Environment Interaction - -### API Endpoint Configuration - -Configure the API endpoint in the `.env.production` file at the project root directory: - -```bash -VITE_GLOB_API_URL=https://mock-napi.vben.pro/api -``` - -::: tip How to Dynamically Modify API Endpoint in Production - -Variables starting with `VITE_GLOB_*` in the `.env` file are injected into the `_app.config.js` file during packaging. After packaging, you can modify the corresponding API addresses in `dist/_app.config.js` and refresh the page to apply the changes. This eliminates the need to package multiple times for different environments, allowing a single package to be deployed across multiple API environments. - -::: - -### Cross-Origin Resource Sharing (CORS) Handling - -In the production environment, if CORS issues arise, you can use `nginx` to proxy the API address or enable `cors` on the backend to handle it (refer to the mock service for examples). - -## API Request Configuration - -The project comes with a default basic request configuration based on `axios`, provided by the `@vben/request` package. The project does not overly complicate things but simply wraps some common configurations. If there are other requirements, you can add or adjust the configurations as needed. Depending on the app, different component libraries and `store` might be used, so under the `src/api/request.ts` folder in the application directory, there are corresponding request configuration files. For example, in the `web-antd` project, there's a `src/api/request.ts` file where you can configure according to your needs. - -### Request Examples - -#### GET Request - -```ts -import { requestClient } from '#/api/request'; - -export async function getUserInfoApi() { - return requestClient.get('/user/info'); -} -``` - -#### POST/PUT Request - -```ts -import { requestClient } from '#/api/request'; - -export async function saveUserApi(user: UserInfo) { - return requestClient.post('/user', user); -} - -export async function saveUserApi(user: UserInfo) { - return requestClient.put('/user', user); -} - -export async function saveUserApi(user: UserInfo) { - const url = user.id ? `/user/${user.id}` : '/user/'; - return requestClient.request(url, { - data: user, - // OR PUT - method: user.id ? 'PUT' : 'POST', - }); -} -``` - -#### DELETE Request - -```ts -import { requestClient } from '#/api/request'; - -export async function deleteUserApi(userId: number) { - return requestClient.delete(`/user/${userId}`); -} -``` - -### Request Configuration - -The `src/api/request.ts` within the application can be configured according to the needs of your application: - -```ts -/** - * This file can be adjusted according to business logic - */ -import type { HttpResponse } from '@vben/request'; - -import { useAppConfig } from '@vben/hooks'; -import { preferences } from '@vben/preferences'; -import { - authenticateResponseInterceptor, - errorMessageResponseInterceptor, - RequestClient, -} from '@vben/request'; -import { useAccessStore } from '@vben/stores'; - -import { message } from 'ant-design-vue'; - -import { useAuthStore } from '#/store'; - -import { refreshTokenApi } from './core'; - -const { apiURL } = useAppConfig(import.meta.env, import.meta.env.PROD); - -function createRequestClient(baseURL: string) { - const client = new RequestClient({ - baseURL, - }); - - /** - * Re-authentication Logic - */ - async function doReAuthenticate() { - console.warn('Access token or refresh token is invalid or expired. '); - const accessStore = useAccessStore(); - const authStore = useAuthStore(); - accessStore.setAccessToken(null); - if (preferences.app.loginExpiredMode === 'modal') { - accessStore.setLoginExpired(true); - } else { - await authStore.logout(); - } - } - - /** - * Refresh token Logic - */ - async function doRefreshToken() { - const accessStore = useAccessStore(); - const resp = await refreshTokenApi(); - const newToken = resp.data; - accessStore.setAccessToken(newToken); - return newToken; - } - - function formatToken(token: null | string) { - return token ? `Bearer ${token}` : null; - } - - // Request Header Processing - client.addRequestInterceptor({ - fulfilled: async (config) => { - const accessStore = useAccessStore(); - - config.headers.Authorization = formatToken(accessStore.accessToken); - config.headers['Accept-Language'] = preferences.app.locale; - return config; - }, - }); - - // Deal Response Data - client.addResponseInterceptor({ - fulfilled: (response) => { - const { data: responseData, status } = response; - - const { code, data } = responseData; - - if (status >= 200 && status < 400 && code === 0) { - return data; - } - throw Object.assign({}, response, { response }); - }, - }); - - // Handling Token Expiration - client.addResponseInterceptor( - authenticateResponseInterceptor({ - client, - doReAuthenticate, - doRefreshToken, - enableRefreshToken: preferences.app.enableRefreshToken, - formatToken, - }), - ); - - // Generic error handling; if none of the above error handling logic is triggered, it will fall back to this. - client.addResponseInterceptor( - errorMessageResponseInterceptor((msg: string, error) => { - // 这里可以根据业务进行定制,你可以拿到 error 内的信息进行定制化处理，根据不同的 code 做不同的提示，而不是直接使用 message.error 提示 msg - // 当前mock接口返回的错误字段是 error 或者 message - const responseData = error?.response?.data ?? {}; - const errorMessage = responseData?.error ?? responseData?.message ?? ''; - // 如果没有错误信息，则会根据状态码进行提示 - message.error(errorMessage || msg); - }), - ); - - return client; -} - -export const requestClient = createRequestClient(apiURL); - -export const baseRequestClient = new RequestClient({ baseURL: apiURL }); -``` - -### Multiple API Endpoints - -To handle multiple API endpoints, simply create multiple `requestClient` instances, as follows: - -```ts -const { apiURL, otherApiURL } = useAppConfig( - import.meta.env, - import.meta.env.PROD, -); - -export const requestClient = createRequestClient(apiURL); - -export const otherRequestClient = createRequestClient(otherApiURL); -``` - -## Refresh Token - -The project provides a default logic for refreshing tokens. To enable it, follow the configuration below: - -- Ensure the refresh token feature is enabled - -Adjust the `preferences.ts` in the corresponding application directory to ensure `enableRefreshToken='true'`. - -```ts -import { defineOverridesPreferences } from '@vben/preferences'; - -export const overridesPreferences = defineOverridesPreferences({ - // overrides - app: { - enableRefreshToken: true, - }, -}); -``` - -Configure the `doRefreshToken` method in `src/api/request.ts` as follows: - -```ts -// Adjust this to your token format -function formatToken(token: null | string) { - return token ? `Bearer ${token}` : null; -} - -/** - * Refresh token logic - */ -async function doRefreshToken() { - const accessStore = useAccessStore(); - // Adjust this to your refresh token API - const resp = await refreshTokenApi(); - const newToken = resp.data; - accessStore.setAccessToken(newToken); - return newToken; -} -``` - -## Data Mocking - -::: tip Production Environment Mock - -The new version no longer supports mock in the production environment. Please use real interfaces. - -::: - -Mock data is an indispensable part of frontend development, serving as a key link in separating frontend and backend development. By agreeing on interfaces with the server side in advance and simulating request data and even logic, frontend development can proceed independently, without being blocked by the backend development process. - -The project uses [Nitro](https://nitro.unjs.io/) for local mock data processing. The principle is to start an additional backend service locally, which is a real backend service that can handle requests and return data. - -### Using Nitro - -The mock service code is located in the `apps/backend-mock` directory. It does not need to be started manually and is already integrated into the project. You only need to run `pnpm dev` in the project root directory. After running successfully, the console will print `http://localhost:5320/api`, and you can access this address to view the mock service. - -[Nitro](https://nitro.unjs.io/) syntax is simple, and you can configure and develop according to your needs. For specific configurations, you can refer to the [Nitro documentation](https://nitro.unjs.io/). - -## Disabling Mock Service - -Since mock is essentially a real backend service, if you do not need the mock service, you can configure `VITE_NITRO_MOCK=false` in the `.env.development` file in the project root directory to disable the mock service. - -```bash -# .env.development -VITE_NITRO_MOCK=false -``` diff --git a/docs/src/en/guide/essentials/settings.md b/docs/src/en/guide/essentials/settings.md deleted file mode 100644 index ba3f860d..00000000 --- a/docs/src/en/guide/essentials/settings.md +++ /dev/null @@ -1,629 +0,0 @@ -# Configuration - -## Environment Variable Configuration - -The project's environment variable configuration is located in the application directory under `.env`, `.env.development`, `.env.production`. - -The rules are consistent with [Vite Env Variables and Modes](https://vitejs.dev/guide/env-and-mode.html). The format is as follows: - -```bash -.env # Loaded in all environments -.env.local # Loaded in all environments, but ignored by git -.env.[mode] # Only loaded in the specified mode -.env.[mode].local # Only loaded in the specified mode, but ignored by git -``` - -::: tip - -- Only variables starting with `VITE_` will be embedded into the client-side package. You can access them in the project code like this: - - ```ts - console.log(import.meta.env.VITE_PROT); - ``` - -- Variables starting with `VITE_GLOB_*` will be added to the `_app.config.js` configuration file during packaging. - -::: - -## Environment Configuration Description - -::: code-group - -```bash [.env] -# Application title -VITE_APP_TITLE=Vben Admin - -# Application namespace, used as a prefix for caching, store, etc., to ensure isolation -VITE_APP_NAMESPACE=vben-web-antd -``` - -```bash [.env.development] -# Port Number -VITE_PORT=5555 - -# Public Path for Resources, must start and end with / -VITE_BASE=/ - -# API URL -VITE_GLOB_API_URL=/api - -# Whether to enable Nitro Mock service, true to enable, false to disable -VITE_NITRO_MOCK=true - -# Whether to open devtools, true to open, false to close -VITE_DEVTOOLS=true - -# Whether to inject global loading -VITE_INJECT_APP_LOADING=true - -# Whether to generate after packaging dist.zip -VITE_ARCHIVER=true -``` - -```bash [.env.production] -# Public Path for Resources, must start and end with / -VITE_BASE=/ - -# API URL -VITE_GLOB_API_URL=https://mock-napi.vben.pro/api - -# Whether to enable compression, can be set to none, brotli, gzip -VITE_COMPRESS=gzip - -# Whether to enable PWA -VITE_PWA=false - -# vue-router mode -VITE_ROUTER_HISTORY=hash - -# Whether to inject global loading -VITE_INJECT_APP_LOADING=true - -# Whether to generate dist.zip after packaging -VITE_ARCHIVER=true -``` - -::: - -## Dynamic Configuration in Production Environment - -When executing `pnpm build` in the root directory of the monorepo, a `dist/_app.config.js` file will be automatically generated in the corresponding application and inserted into `index.html`. - -`_app.config.js` is a dynamic configuration file that allows for modifications to the configuration dynamically based on different environments after the project has been built. The content is as follows: - -```ts -window._VBEN_ADMIN_PRO_APP_CONF_ = { - VITE_GLOB_API_URL: 'https://mock-napi.vben.pro/api', -}; -Object.freeze(window._VBEN_ADMIN_PRO_APP_CONF_); -Object.defineProperty(window, '_VBEN_ADMIN_PRO_APP_CONF_', { - configurable: false, - writable: false, -}); -``` - -### Purpose - -`_app.config.js` is used for projects that need to dynamically modify configurations after packaging, such as API endpoints. There's no need to repackage; you can simply modify the variables in `/dist/_app.config.js` after packaging, and refresh to update the variables in the code. A `js` file is used to ensure that the configuration file is loaded early in the order. - -### Usage - -To access the variables inside `_app.config.js`, you need to use the `useAppConfig` method provided by `@vben/hooks`. - -```ts -const { apiURL } = useAppConfig(import.meta.env, import.meta.env.PROD); -``` - -### Adding New - -To add a new dynamically modifiable configuration item, simply follow the steps below: - -- First, add the variable that needs to be dynamically configurable in the `.env` file or the corresponding development environment configuration file. The variable must start with `VITE_GLOB_*`, for example: - - ```bash - VITE_GLOB_OTHER_API_URL=https://mock-napi.vben.pro/other-api - ``` - -- In `packages/types/global.d.ts`, add the corresponding type definition, such as: - - ```ts - export interface VbenAdminProAppConfigRaw { - VITE_GLOB_API_URL: string; - VITE_GLOB_OTHER_API_URL: string; // [!code ++] - } - - export interface ApplicationConfig { - apiURL: string; - otherApiURL: string; // [!code ++] - } - ``` - -- In `packages/effects/hooks/src/use-app-config.ts`, add the corresponding configuration item, such as: - - ```ts - export function useAppConfig( - env: Record, - isProduction: boolean, - ): ApplicationConfig { - // In production environment, directly use the window._VBEN_ADMIN_PRO_APP_CONF_ global variable - const config = isProduction - ? window._VBEN_ADMIN_PRO_APP_CONF_ - : (env as VbenAdminProAppConfigRaw); - - const { VITE_GLOB_API_URL, VITE_GLOB_OTHER_API_URL } = config; // [!code ++] - - return { - apiURL: VITE_GLOB_API_URL, - otherApiURL: VITE_GLOB_OTHER_API_URL, // [!code ++] - }; - } - ``` - -At this point, you can use the `useAppConfig` method within the project to access the newly added configuration item. - -```ts -const { otherApiURL } = useAppConfig(import.meta.env, import.meta.env.PROD); -``` - -::: warning Warning - -The `useAppConfig` method should only be used within the application and not be coupled with the internals of a package. The reason for passing `import.meta.env` and `import.meta.env.PROD` is to avoid such coupling. A pure package should avoid using variables specific to a particular build tool. - -::: - -## Preferences - -The project offers a wide range of preference settings for dynamically configuring various features of the project: - -![](/guide/preferences.png) - -If you cannot find documentation for a setting, you can try configuring it yourself and then click `Copy Preferences` to override the project defaults. The configuration file is located in the application directory under `preferences.ts`, where you can override the framework's default configurations to achieve custom settings. - -```ts -import { useAppConfig } from '@vben/hooks'; -import { defineOverridesPreferences } from '@vben/preferences'; - -/** - * @description Project configuration file - * Only a part of the configuration in the project needs to be covered, and unnecessary configurations do not need to be covered. The default configuration will be automatically used - * !!! Please clear the cache after changing the configuration, otherwise it may not take effect - */ -export const overridesPreferences = defineOverridesPreferences({ - // overrides -}); -``` - -### Framework default configuration - -::: details View the default configuration of the framework - -```ts -const defaultPreferences: Preferences = { - app: { - accessMode: 'frontend', - authPageLayout: 'panel-right', - checkUpdatesInterval: 1, - colorGrayMode: false, - colorWeakMode: false, - compact: false, - contentCompact: 'wide', - contentCompactWidth: 1200, - contentPadding: 0, - contentPaddingBottom: 0, - contentPaddingLeft: 0, - contentPaddingRight: 0, - contentPaddingTop: 0, - defaultAvatar: - 'https://unpkg.com/@vbenjs/static-source@0.1.7/source/avatar-v1.webp', - defaultHomePath: '/analytics', - dynamicTitle: true, - enableCheckUpdates: true, - enablePreferences: true, - enableRefreshToken: false, - isMobile: false, - layout: 'sidebar-nav', - locale: 'zh-CN', - loginExpiredMode: 'page', - name: 'Vben Admin', - preferencesButtonPosition: 'auto', - watermark: false, - zIndex: 200, - }, - breadcrumb: { - enable: true, - hideOnlyOne: false, - showHome: false, - showIcon: true, - styleType: 'normal', - }, - copyright: { - companyName: 'Vben', - companySiteLink: 'https://www.vben.pro', - date: '2024', - enable: true, - icp: '', - icpLink: '', - settingShow: true, - }, - footer: { - enable: false, - fixed: false, - height: 32, - }, - header: { - enable: true, - height: 50, - hidden: false, - menuAlign: 'start', - mode: 'fixed', - }, - logo: { - enable: true, - fit: 'contain', - source: 'https://unpkg.com/@vbenjs/static-source@0.1.7/source/logo-v1.webp', - // sourceDark: 'https://unpkg.com/@vbenjs/static-source@0.1.7/source/logo-dark.webp', // Optional: Dark theme logo - }, - navigation: { - accordion: true, - split: true, - styleType: 'rounded', - }, - shortcutKeys: { - enable: true, - globalLockScreen: true, - globalLogout: true, - globalPreferences: true, - globalSearch: true, - }, - sidebar: { - autoActivateChild: false, - collapsed: false, - collapsedButton: true, - collapsedShowTitle: false, - collapseWidth: 60, - enable: true, - expandOnHover: true, - extraCollapse: false, - extraCollapsedWidth: 60, - fixedButton: true, - hidden: false, - mixedWidth: 80, - width: 224, - }, - tabbar: { - draggable: true, - enable: true, - height: 38, - keepAlive: true, - maxCount: 0, - middleClickToClose: false, - persist: true, - showIcon: true, - showMaximize: true, - showMore: true, - styleType: 'chrome', - wheelable: true, - }, - theme: { - builtinType: 'default', - colorDestructive: 'hsl(348 100% 61%)', - colorPrimary: 'hsl(212 100% 45%)', - colorSuccess: 'hsl(144 57% 58%)', - colorWarning: 'hsl(42 84% 61%)', - mode: 'dark', - radius: '0.5', - semiDarkHeader: false, - semiDarkSidebar: false, - }, - transition: { - enable: true, - loading: true, - name: 'fade-slide', - progress: true, - }, - widget: { - fullscreen: true, - globalSearch: true, - languageToggle: true, - lockScreen: true, - notification: true, - refresh: true, - sidebarToggle: true, - themeToggle: true, - }, -}; -``` - -::: - -::: details View the default configuration type of the framework - -```ts -interface AppPreferences { - /** Permission mode */ - accessMode: AccessModeType; - /** Layout of the login/registration page */ - authPageLayout: AuthPageLayoutType; - /** Interval for checking updates */ - checkUpdatesInterval: number; - /** Whether to enable gray mode */ - colorGrayMode: boolean; - /** Whether to enable color weakness mode */ - colorWeakMode: boolean; - /** Whether to enable compact mode */ - compact: boolean; - /** Whether to enable content compact mode */ - contentCompact: ContentCompactType; - /** Content compact width */ - contentCompactWidth: number; - /** Content padding */ - contentPadding: number; - /** Content bottom padding */ - contentPaddingBottom: number; - /** Content left padding */ - contentPaddingLeft: number; - /** Content right padding */ - contentPaddingRight: number; - /** Content top padding */ - contentPaddingTop: number; - // /** Default application avatar */ - defaultAvatar: string; - /** Default homepage path */ - defaultHomePath: string; - // /** Enable dynamic title */ - dynamicTitle: boolean; - /** Whether to enable update checks */ - enableCheckUpdates: boolean; - /** Whether to display preferences */ - enablePreferences: boolean; - /** - * @zh_CN Whether to enable refreshToken - */ - enableRefreshToken: boolean; - /** Whether it's mobile */ - isMobile: boolean; - /** Layout method */ - layout: LayoutType; - /** Supported languages */ - locale: SupportedLanguagesType; - /** Login expiration mode */ - loginExpiredMode: LoginExpiredModeType; - /** Application name */ - name: string; - /** Position of the preferences button */ - preferencesButtonPosition: PreferencesButtonPositionType; - /** - * @zh_CN Whether to enable watermark - */ - watermark: boolean; - /** z-index */ - zIndex: number; -} -interface BreadcrumbPreferences { - /** Whether breadcrumbs are enabled */ - enable: boolean; - /** Whether to hide breadcrumbs when there is only one */ - hideOnlyOne: boolean; - /** Whether the home icon in breadcrumbs is visible */ - showHome: boolean; - /** Whether the icon in breadcrumbs is visible */ - showIcon: boolean; - /** Breadcrumb style */ - styleType: BreadcrumbStyleType; -} - -interface CopyrightPreferences { - /** Copyright company name */ - companyName: string; - /** Link to the copyright company's site */ - companySiteLink: string; - /** Copyright date */ - date: string; - /** Whether copyright is visible */ - enable: boolean; - /** ICP number */ - icp: string; - /** Link to the ICP */ - icpLink: string; - /** Whether to show in settings panel */ - settingShow?: boolean; -} - -interface FooterPreferences { - /** Whether the footer is visible */ - enable: boolean; - /** Whether the footer is fixed */ - fixed: boolean; - /** Footer height */ - height: number; -} - -interface HeaderPreferences { - /** Whether the header is enabled */ - enable: boolean; - /** Header height */ - height: number; - /** Whether the header is hidden, css-hidden */ - hidden: boolean; - /** Header menu alignment */ - menuAlign: LayoutHeaderMenuAlignType; - /** Header display mode */ - mode: LayoutHeaderModeType; -} - -interface LogoPreferences { - /** Whether the logo is visible */ - enable: boolean; - /** Logo image fitting method */ - fit: 'contain' | 'cover' | 'fill' | 'none' | 'scale-down'; - /** Logo URL */ - source: string; - /** Dark theme logo URL (optional, if not set, use source) */ - sourceDark?: string; -} - -interface NavigationPreferences { - /** Navigation menu accordion mode */ - accordion: boolean; - /** Whether the navigation menu is split, only effective in layout=mixed-nav */ - split: boolean; - /** Navigation menu style */ - styleType: NavigationStyleType; -} -interface SidebarPreferences { - /** Automatically activate child menu when clicking on directory */ - autoActivateChild: boolean; - /** Whether the sidebar is collapsed */ - collapsed: boolean; - /** Whether the sidebar collapse button is visible */ - collapsedButton: boolean; - /** Whether to show title when sidebar is collapsed */ - collapsedShowTitle: boolean; - /** Sidebar collapse width */ - collapseWidth: number; - /** Whether the sidebar is visible */ - enable: boolean; - /** Menu auto-expand state */ - expandOnHover: boolean; - /** Whether the sidebar extension area is collapsed */ - extraCollapse: boolean; - /** Sidebar extension area collapse width */ - extraCollapsedWidth: number; - /** Whether the sidebar fixed button is visible */ - fixedButton: boolean; - /** Whether the sidebar is hidden - css */ - hidden: boolean; - /** Mixed sidebar width */ - mixedWidth: number; - /** Sidebar width */ - width: number; -} - -interface ShortcutKeyPreferences { - /** Whether shortcut keys are enabled globally */ - enable: boolean; - /** Whether the global lock screen shortcut is enabled */ - globalLockScreen: boolean; - /** Whether the global logout shortcut is enabled */ - globalLogout: boolean; - /** Whether the global preferences shortcut is enabled */ - globalPreferences: boolean; - /** Whether the global search shortcut is enabled */ - globalSearch: boolean; -} - -interface TabbarPreferences { - /** Whether dragging of multiple tabs is enabled */ - draggable: boolean; - /** Whether multiple tabs are enabled */ - enable: boolean; - /** Tab height */ - height: number; - /** Whether tab caching is enabled */ - keepAlive: boolean; - /** Maximum number of tabs */ - maxCount: number; - /** Whether to close tab when middle-clicked */ - middleClickToClose: boolean; - /** Whether tabs are persistent */ - persist: boolean; - /** Whether icons in multiple tabs are enabled */ - showIcon: boolean; - /** Whether to show the maximize button */ - showMaximize: boolean; - /** Whether to show the more button */ - showMore: boolean; - /** Tab style */ - styleType: TabsStyleType; - /** Whether mouse wheel response is enabled */ - wheelable: boolean; -} -interface ThemePreferences { - /** Built-in theme name */ - builtinType: BuiltinThemeType; - /** Destructive color */ - colorDestructive: string; - /** Primary color */ - colorPrimary: string; - /** Success color */ - colorSuccess: string; - /** Warning color */ - colorWarning: string; - /** Current theme */ - mode: ThemeModeType; - /** Radius */ - radius: string; - /** Whether to enable semi-dark header (only effective when theme='light') */ - semiDarkHeader: boolean; - /** Whether to enable semi-dark sidebar (only effective when theme='light') */ - semiDarkSidebar: boolean; -} - -interface TransitionPreferences { - /** Whether page transition animations are enabled */ - enable: boolean; - // /** Whether page loading loading is enabled */ - loading: boolean; - /** Page transition animation */ - name: PageTransitionType | string; - /** Whether page loading progress animation is enabled */ - progress: boolean; -} - -interface WidgetPreferences { - /** Whether fullscreen widgets are enabled */ - fullscreen: boolean; - /** Whether global search widget is enabled */ - globalSearch: boolean; - /** Whether language switch widget is enabled */ - languageToggle: boolean; - /** Whether lock screen functionality is enabled */ - lockScreen: boolean; - /** Whether notification widget is displayed */ - notification: boolean; - /** Whether to show the refresh button */ - refresh: boolean; - /** Whether sidebar show/hide widget is displayed */ - sidebarToggle: boolean; - /** Whether theme switch widget is displayed */ - themeToggle: boolean; -} -interface Preferences { - /** Global configuration */ - app: AppPreferences; - /** Header configuration */ - breadcrumb: BreadcrumbPreferences; - /** Copyright configuration */ - copyright: CopyrightPreferences; - /** Footer configuration */ - footer: FooterPreferences; - /** Breadcrumb configuration */ - header: HeaderPreferences; - /** Logo configuration */ - logo: LogoPreferences; - /** Navigation configuration */ - navigation: NavigationPreferences; - /** Shortcut key configuration */ - shortcutKeys: ShortcutKeyPreferences; - /** Sidebar configuration */ - sidebar: SidebarPreferences; - /** Tab bar configuration */ - tabbar: TabbarPreferences; - /** Theme configuration */ - theme: ThemePreferences; - /** Animation configuration */ - transition: TransitionPreferences; - /** Widget configuration */ - widget: WidgetPreferences; -} -``` - -::: - -::: warning Warning - -- The `overridesPreferences` method only needs to override a part of the configurations in the project. There's no need to override configurations that are not needed; they will automatically use the default settings. -- Any configuration item can be overridden. You just need to override it within the `overridesPreferences` method. Do not modify the default configuration file. -- Please clear the cache after changing the configuration, otherwise it may not take effect. - -::: diff --git a/docs/src/en/guide/essentials/styles.md b/docs/src/en/guide/essentials/styles.md deleted file mode 100644 index 16f6681d..00000000 --- a/docs/src/en/guide/essentials/styles.md +++ /dev/null @@ -1,106 +0,0 @@ -# Styles - -::: tip Preface - -For Vue projects, the [official documentation](https://vuejs.org/api/sfc-css-features.html#deep-selectors) already provides a detailed introduction to the syntax. Here, we mainly introduce the structure and usage of style files in the project. - -::: - -## Project Structure - -The style files in the project are stored in `@vben/styles`, which includes some global styles, such as reset styles, global variables, etc. It inherits the styles and capabilities of `@vben-core/design` and can be overridden according to project needs. - -## Scss - -The project uses `scss` as the style preprocessor, allowing the use of `scss` features such as variables, functions, mixins, etc., within the project. - -```vue - -``` - -## Postcss - -If you're not accustomed to using `scss`, you can also use `postcss`, which is a more powerful style processor that supports a wider range of plugins. The project includes the [postcss-nested](https://github.com/postcss/postcss-nested) plugin and is configured with `Css Variables`, making it a complete substitute for `scss`. - -```vue - -``` - -## Tailwind CSS - -The project integrates [Tailwind CSS](https://tailwindcss.com/), allowing the use of `tailwindcss` class names to quickly build pages. - -```vue - -``` - -## BEM Standard - -Another option to avoid style conflicts is to use the `BEM` standard. If you choose `scss`, it is recommended to use the `BEM` naming convention for better style management. The project provides a default `useNamespace` function to easily generate namespaces. - -```vue - - - -``` - -## CSS Modules - -Another solution to address style conflicts is to use the `CSS Modules` modular approach. The usage method is as follows. - -```vue - - - -``` - -For more usage, see the [CSS Modules official documentation](https://vuejs.org/api/sfc-css-features.html#css-modules). diff --git a/docs/src/en/guide/in-depth/access.md b/docs/src/en/guide/in-depth/access.md deleted file mode 100644 index 545dddab..00000000 --- a/docs/src/en/guide/in-depth/access.md +++ /dev/null @@ -1,356 +0,0 @@ ---- -outline: deep ---- - -# Access Control - -The framework has built-in three types of access control methods: - -- Determining whether a menu or button can be accessed based on user roles -- Determining whether a menu or button can be accessed through an API -- Mixed mode: Using both frontend and backend access control simultaneously - -## Frontend Access Control - -**Implementation Principle**: The permissions for routes are hardcoded on the frontend, specifying which permissions are required to view certain routes. Only general routes are initialized, and routes that require permissions are not added to the route table. After logging in or obtaining user roles through other means, the roles are used to traverse the route table to generate a route table that the role can access. This table is then added to the router instance using `router.addRoute`, achieving permission filtering. - -**Disadvantage**: The permissions are relatively inflexible; if the backend changes roles, the frontend needs to be adjusted accordingly. This is suitable for systems with relatively fixed roles. - -### Steps - -- Ensure the current mode is set to frontend access control - -Adjust `preferences.ts` in the corresponding application directory to ensure `accessMode='frontend'`. - -```ts -import { defineOverridesPreferences } from '@vben/preferences'; - -export const overridesPreferences = defineOverridesPreferences({ - // overrides - app: { - // Default value, optional - accessMode: 'frontend', - }, -}); -``` - -- Configure route permissions - -#### If not configured, it is visible by default - -```ts {3} - { - meta: { - authority: ['super'], - }, -}, -``` - -- Ensure the roles returned by the interface match the permissions in the route table - -You can look under `src/store/auth` in the application to find the following code: - -```ts -// Set the login user information, ensuring that userInfo.roles is an array and contains permissions from the route table -// For example: userInfo.roles=['super', 'admin'] -authStore.setUserInfo(userInfo); -``` - -At this point, the configuration is complete. You need to ensure that the roles returned by the interface after login match the permissions in the route table; otherwise, access will not be possible. - -### Menu Visible but Access Forbidden - -Sometimes, we need the menu to be visible but access to it forbidden. This can be achieved by setting `menuVisibleWithForbidden` to `true`. In this case, the menu will be visible, but access will be forbidden, redirecting to a 403 page. - -```ts -{ - meta: { - menuVisibleWithForbidden: true, - }, -}, -``` - -## Backend Access Control - -**Implementation Principle**: It is achieved by dynamically generating a routing table through an API, which returns data following a certain structure. The frontend processes this data into a recognizable structure, then adds it to the routing instance using `router.addRoute`, realizing the dynamic generation of permissions. - -**Disadvantage**: The backend needs to provide a data structure that meets the standards, and the frontend needs to process this structure. This is suitable for systems with more complex permissions. - -### Steps - -- Ensure the current mode is set to backend access control - -Adjust `preferences.ts` in the corresponding application directory to ensure `accessMode='backend'`. - -```ts -import { defineOverridesPreferences } from '@vben/preferences'; - -export const overridesPreferences = defineOverridesPreferences({ - // overrides - app: { - accessMode: 'backend', - }, -}); -``` - -- Ensure the structure of the menu data returned by the interface is correct - -You can look under `src/router/access.ts` in the application to find the following code: - -```ts -async function generateAccess(options: GenerateMenuAndRoutesOptions) { - return await generateAccessible(preferences.app.accessMode, { - fetchMenuListAsync: async () => { - // This interface is for the menu data returned by the backend - return await getAllMenus(); - }, - }); -} -``` - -- Interface returns menu data, see comments for explanation - -::: details Example of Interface Returning Menu Data - -```ts -const dashboardMenus = [ - { - // Here, 'BasicLayout' is hardcoded and cannot be changed - component: 'BasicLayout', - meta: { - order: -1, - title: 'page.dashboard.title', - }, - name: 'Dashboard', - path: '/', - redirect: '/analytics', - children: [ - { - name: 'Analytics', - path: '/analytics', - // Here is the path of the page, need to remove 'views/' and '.vue' - component: '/dashboard/analytics/index', - meta: { - affixTab: true, - title: 'page.dashboard.analytics', - }, - }, - { - name: 'Workspace', - path: '/workspace', - component: '/dashboard/workspace/index', - meta: { - title: 'page.dashboard.workspace', - }, - }, - ], - }, -]; -``` - -::: - -At this point, the configuration is complete. You need to ensure that after logging in, the format of the menu returned by the interface is correct; otherwise, access will not be possible. - -## Mixed Access Control - -**Implementation Principle**: Mixed mode combines both frontend access control and backend access control methods. The system processes frontend fixed route permissions and backend dynamic menu data in parallel, ultimately merging both parts of routes to provide a more flexible access control solution. - -**Advantages**: Combines the performance advantages of frontend control with the flexibility of backend control, suitable for complex business scenarios requiring permission management. - -### Steps - -- Ensure the current mode is set to mixed access control - -Adjust `preferences.ts` in the corresponding application directory to ensure `accessMode='mixed'`. - -```ts -import { defineOverridesPreferences } from '@vben/preferences'; - -export const overridesPreferences = defineOverridesPreferences({ - // overrides - app: { - accessMode: 'mixed', - }, -}); -``` - -- Configure frontend route permissions - -Same as the route permission configuration method in [Frontend Access Control](#frontend-access-control) mode. - -- Configure backend menu interface - -Same as the interface configuration method in [Backend Access Control](#backend-access-control) mode. - -- Ensure roles and permissions match - -Must satisfy both frontend route permission configuration and backend menu data return requirements, ensuring user roles match the permission configurations of both modes. - -At this point, the configuration is complete. Mixed mode will automatically merge frontend and backend routes, providing complete access control functionality. - -## Fine-grained Control of Buttons - -In some cases, we need to control the display of buttons with fine granularity. We can control the display of buttons through interfaces or roles. - -### Permission Code - -The permission code is the code returned by the interface. The logic to determine whether a button is displayed is located under `src/store/auth`: - -```ts -const [fetchUserInfoResult, accessCodes] = await Promise.all([ - fetchUserInfo(), - getAccessCodes(), -]); - -userInfo = fetchUserInfoResult; -authStore.setUserInfo(userInfo); -accessStore.setAccessCodes(accessCodes); -``` - -Locate the `getAccessCodes` corresponding interface, which can be adjusted according to business logic. - -The data structure returned by the permission code is an array of strings, for example: `['AC_100100', 'AC_100110', 'AC_100120', 'AC_100010']` - -With the permission codes, you can use the `AccessControl` component and API provided by `@vben/access` to show and hide buttons. - -#### Component Method - -```vue - - - -``` - -#### API Method - -```vue - - - -``` - -#### Directive Method - -> The directive supports binding single or multiple permission codes. For a single one, you can pass a string or an array containing one permission code, and for multiple permission codes, you can pass an array. - -```vue - -``` - -### Roles - -The method of determining roles does not require permission codes returned by the interface; it directly determines whether buttons are displayed based on roles. - -#### Component Method - -```vue - - - -``` - -#### API Method - -```vue - - - -``` - -#### Directive Method - -> The directive supports binding single or multiple permission codes. For a single one, you can pass a string or an array containing one permission code, and for multiple permission codes, you can pass an array. - -```vue - -``` diff --git a/docs/src/en/guide/in-depth/check-updates.md b/docs/src/en/guide/in-depth/check-updates.md deleted file mode 100644 index 1e5b679d..00000000 --- a/docs/src/en/guide/in-depth/check-updates.md +++ /dev/null @@ -1,48 +0,0 @@ -# Check Updates - -## Introduction - -When there are updates to the website, you might need to check for updates. The framework provides this functionality. By periodically checking for updates, you can configure the `checkUpdatesInterval` and `enableCheckUpdates` fields in your application's preferences.ts file to enable and set the interval for checking updates (in minutes). - -```ts -import { defineOverridesPreferences } from '@vben/preferences'; - -export const overridesPreferences = defineOverridesPreferences({ - // overrides - app: { - // Whether to enable check for updates - enableCheckUpdates: true, - // The interval for checking updates, in minutes - checkUpdatesInterval: 1, - }, -}); -``` - -## Effect - -When an update is detected, a prompt will pop up asking the user whether to refresh the page: - -![check-updates](/guide/update-notice.png) - -## Replacing with Other Update Checking Methods - -If you need to check for updates in other ways, such as through an API to more flexibly control the update logic (such as force refresh, display update content, etc.), you can do so by modifying the `src/widgets/check-updates/check-updates.vue` file under `@vben/layouts`. - -```ts -// Replace this with your update checking logic -async function getVersionTag() { - try { - const response = await fetch('/', { - cache: 'no-cache', - method: 'HEAD', - }); - - return ( - response.headers.get('etag') || response.headers.get('last-modified') - ); - } catch { - console.error('Failed to fetch version tag'); - return null; - } -} -``` diff --git a/docs/src/en/guide/in-depth/features.md b/docs/src/en/guide/in-depth/features.md deleted file mode 100644 index 24fecea9..00000000 --- a/docs/src/en/guide/in-depth/features.md +++ /dev/null @@ -1,84 +0,0 @@ -# Common Features - -A collection of some commonly used features. - -## Login Authentication Expiry - -When the interface returns a `401` status code, the framework will consider the login authentication to have expired. Upon login timeout, it will redirect to the login page or open a login popup. This can be configured in `preferences.ts` in the application directory: - -### Redirect to Login Page - -Upon login timeout, it will redirect to the login page. - -```ts -import { defineOverridesPreferences } from '@vben/preferences'; - -export const overridesPreferences = defineOverridesPreferences({ - // overrides - app: { - loginExpiredMode: 'page', - }, -}); -``` - -### Open Login Popup - -When login times out, a login popup will open. - -![login-expired](/guide/login-expired.png) - -Configuration: - -```ts -import { defineOverridesPreferences } from '@vben/preferences'; - -export const overridesPreferences = defineOverridesPreferences({ - // overrides - app: { - loginExpiredMode: 'modal', - }, -}); -``` - -## Dynamic Title - -- Default value: `true` - -When enabled, the webpage title changes according to the route's `title`. You can enable or disable this in the `preferences.ts` file in your application directory. - -```ts -export const overridesPreferences = defineOverridesPreferences({ - // overrides - app: { - dynamicTitle: true, - }, -}); -``` - -## Page Watermark - -- Default value: `false` - -When enabled, the webpage will display a watermark. You can enable or disable this in the `preferences.ts` file in your application directory. - -```ts -export const overridesPreferences = defineOverridesPreferences({ - // overrides - app: { - watermark: true, - }, -}); -``` - -If you want to update the content of the watermark, you can do so. The parameters can be referred to [watermark-js-plus](https://zhensherlock.github.io/watermark-js-plus/): - -```ts -import { useWatermark } from '@vben/hooks'; - -const { destroyWatermark, updateWatermark } = useWatermark(); - -await updateWatermark({ - // watermark content - content: 'hello my watermark', -}); -``` diff --git a/docs/src/en/guide/in-depth/layout.md b/docs/src/en/guide/in-depth/layout.md deleted file mode 100644 index 412c1cf0..00000000 --- a/docs/src/en/guide/in-depth/layout.md +++ /dev/null @@ -1 +0,0 @@ -# Layout diff --git a/docs/src/en/guide/in-depth/loading.md b/docs/src/en/guide/in-depth/loading.md deleted file mode 100644 index 0f1cff6e..00000000 --- a/docs/src/en/guide/in-depth/loading.md +++ /dev/null @@ -1,44 +0,0 @@ -# Global Loading - -Global loading refers to the loading effect that appears when the page is refreshed, usually a spinning icon: - -![Global loading spinner](/guide/loading.png) - -## Principle - -Implemented by the `vite-plugin-inject-app-loading` plugin, the plugin injects a global `loading html` into each application. - -## Disable - -If you do not need global loading, you can disable it in the `.env` file: - -```bash -VITE_INJECT_APP_LOADING=false -``` - -## Customization - -If you want to customize the global loading, you can create a `loading.html` file in the application directory, at the same level as `index.html`. The plugin will automatically read and inject this HTML. You can define the style and animation of this HTML as you wish. - -::: tip - -- You can use the same syntax as in `index.html`, such as the `VITE_APP_TITLE` variable, to get the application's title. -- You must ensure there is an element with `id="__app-loading__"`. -- Add a `hidden` class to the element with `id="__app-loading__"`. -- You must ensure there is a `style[data-app-loading="inject-css"]` element. - -```html{1,4} - -
- -
<%= VITE_APP_TITLE %>
-
-``` diff --git a/docs/src/en/guide/in-depth/locale.md b/docs/src/en/guide/in-depth/locale.md deleted file mode 100644 index 549bc83f..00000000 --- a/docs/src/en/guide/in-depth/locale.md +++ /dev/null @@ -1,227 +0,0 @@ -# Internationalization - -The project has integrated [Vue i18n](https://kazupon.github.io/vue-i18n/), and Chinese and English language packs have been configured. - -## IDE Plugin - -If you are using vscode as your development tool, it is recommended to install the [i18n Ally](https://marketplace.visualstudio.com/items?itemName=Lokalise.i18n-ally) plugin. It can help you manage internationalization copy more conveniently. After installing this plugin, you can see the corresponding language content in your code in real-time: - -![](/public/guide/locale.png) - -## Configure Default Language - -You just need to override the default preferences. In the corresponding application, find the `src/preferences.ts` file and modify the value of `locale`: - -```ts {3} -export const overridesPreferences = defineOverridesPreferences({ - app: { - locale: 'en-US', - }, -}); -``` - -## Dynamic Language Switching - -Switching languages consists of two parts: - -- Updating preferences -- Loading the corresponding language pack - -```ts -import type { SupportedLanguagesType } from '@vben/locales'; -import { loadLocaleMessages } from '@vben/locales'; -import { updatePreferences } from '@vben/preferences'; - -async function updateLocale(value: string) { - // 1. Update preferences - const locale = value as SupportedLanguagesType; - updatePreferences({ - app: { - locale, - }, - }); - // 2. Load the corresponding language pack - await loadLocaleMessages(locale); -} - -updateLocale('en-US'); -``` - -## Adding Translation Texts - -::: warning Attention - -- Do not place business translation texts inside `@vben/locales` to better manage business and general translation texts. -- When adding new translation texts and multiple language packs are available, ensure to add the corresponding texts in all language packs. - -::: - -To add new translation texts, simply find `src/locales/langs/` in the corresponding application and add the texts accordingly, for example: - -**src/locales/langs/zh-CN/\*.json** - -````ts -```json -{ - "about": { - "desc": "Vben Admin 是一个现代的管理模版。" - } -} -```` - -**src/locales/langs/en-US.ts** - -````ts -```json -{ - "about": { - "desc": "Vben Admin is a modern management template." - } -} -```` - -## Using Translation Texts - -With `@vben/locales`, you can easily use translation texts: - -### In Code - -```vue - - -``` - -## Adding a New Language Pack - -If you need to add a new language pack, follow these steps: - -- Add the corresponding language pack file in the `packages/locales/langs` directory, for example, `zh-TW.json`, and translate the respective texts. -- In the corresponding application, locate the `src/locales/langs` file and add the new language pack `zh-TW.json`. -- Add the corresponding language in `packages/constants/src/core.ts`: - - ```ts - export interface LanguageOption { - label: string; - value: 'en-US' | 'zh-CN'; // [!code --] - value: 'en-US' | 'zh-CN' | 'zh-TW'; // [!code ++] - } - export const SUPPORT_LANGUAGES: LanguageOption[] = [ - { - label: '简体中文', - value: 'zh-CN', - }, - { - label: 'English', - value: 'en-US', - }, - { - label: '繁体中文', // [!code ++] - value: 'zh-TW', // [!code ++] - }, - ]; - ``` - -- In `packages/locales/typing.ts`, add a new TypeScript type: - - ```ts - export type SupportedLanguagesType = 'en-US' | 'zh-CN'; // [!code --] - export type SupportedLanguagesType = 'en-US' | 'zh-CN' | 'zh-TW'; // [!code ++] - ``` - -At this point, you can use the newly added language pack in the project. - -## Interface Language Switching Function - -If you want to disable the language switching display button on the interface, in the corresponding application, find the `src/preferences.ts` file and modify the value of `locale` accordingly: - -```ts {3} -export const overridesPreferences = defineOverridesPreferences({ - widget: { - languageToggle: false, - }, -}); -``` - -## Remote Loading of Language Packs - -::: tip Tip - -When making interface requests through the project's built-in `request` tool, the default request header will include [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language), allowing the server to dynamically internationalize data based on the request header. - -::: - -Each application has an independent language pack that can override the general language configuration. You can remotely load the corresponding language pack by finding the `src/locales/index.ts` file in the corresponding application and modifying the `loadMessages` method accordingly: - -```ts {3-4} -async function loadMessages(lang: SupportedLanguagesType) { - const [appLocaleMessages] = await Promise.all([ - // Modify here to load data via a remote interface - localesMap[lang](), - loadThirdPartyMessage(lang), - ]); - return appLocaleMessages.default; -} -``` - -## Third-Party Language Packs - -Different applications may use third-party component libraries or plugins with varying internationalization methods, so they need to be handled differently. If you need to introduce a third-party language pack, you can find the `src/locales/index.ts` file in the corresponding application and modify the `loadThirdPartyMessage` method accordingly: - -```ts -/** - * Load the dayjs language pack - * @param lang - */ -async function loadDayjsLocale(lang: SupportedLanguagesType) { - let locale; - switch (lang) { - case 'zh-CN': { - locale = await import('dayjs/locale/zh-cn'); - break; - } - case 'en-US': { - locale = await import('dayjs/locale/en'); - break; - } - // Default to using English - default: { - locale = await import('dayjs/locale/en'); - } - } - if (locale) { - dayjs.locale(locale); - } else { - console.error(`Failed to load dayjs locale for ${lang}`); - } -} -``` - -## Removing Internationalization - -Firstly, it is not recommended to remove internationalization, as it is a good development practice. However, if you really need to remove it, you can directly use Chinese copy and then retain the project's built-in language pack, which will not affect the overall development experience. The steps to remove internationalization are as follows: - -- Hide the language switching button on the interface, see: [Interface Language Switching Function](#interface-language-switching-function) -- Modify the default language, see: [Configure Default Language](#configure-default-language) -- Disable `vue-i18n` warning prompts, in the `src/locales/index.ts` file, modify `missingWarn` to `false`: - - ```ts - async function setupI18n(app: App, options: LocaleSetupOptions = {}) { - await coreSetup(app, { - defaultLocale: preferences.app.locale, - loadMessages, - missingWarn: !import.meta.env.PROD, // [!code --] - missingWarn: false, // [!code ++] - ...options, - }); - } - ``` diff --git a/docs/src/en/guide/in-depth/login.md b/docs/src/en/guide/in-depth/login.md deleted file mode 100644 index 7fdac2c6..00000000 --- a/docs/src/en/guide/in-depth/login.md +++ /dev/null @@ -1,119 +0,0 @@ -# Login - -This document explains how to customize the login page of your application. - -## Login Page Adjustment - -If you want to adjust the title, description, icon, and toolbar of the login page, you can do so by configuring the `props` parameter of the `AuthPageLayout` component. - -![login](/guide/login.png) - -You just need to configure the `props` parameter of `AuthPageLayout` in `src/router/routes/core.ts` within your application: - -```ts {4-8} - { - component: AuthPageLayout, - props: { - sloganImage: "xxx/xxx.png", - pageTitle: "开箱即用的大型中后台管理系统", - pageDescription: "工程化、高性能、跨组件库的前端模版", - toolbar: true, - toolbarList: ['color', 'language', 'layout', 'theme'], - } - // ... - }, -``` - -::: tip - -If these configurations do not meet your needs, you can implement your own login page. Simply implement your own `AuthPageLayout`. - -::: - -## Login Form Adjustment - -If you want to adjust the content of the login form, you can configure the `AuthenticationLogin` component parameters in `src/views/_core/authentication/login.vue` within your application: - -```vue - -``` - -::: details AuthenticationLogin Component Props - -```ts -{ - /** - * @en Verification code login path - */ - codeLoginPath?: string; - /** - * @en Forget password path - */ - forgetPasswordPath?: string; - - /** - * @en Whether it is in loading state - */ - loading?: boolean; - - /** - * @en QR code login path - */ - qrCodeLoginPath?: string; - - /** - * @en Registration path - */ - registerPath?: string; - - /** - * @en Whether to show verification code login - */ - showCodeLogin?: boolean; - /** - * @en Whether to show forget password - */ - showForgetPassword?: boolean; - - /** - * @en Whether to show QR code login - */ - showQrcodeLogin?: boolean; - - /** - * @en Whether to show registration button - */ - showRegister?: boolean; - - /** - * @en Whether to show remember account - */ - showRememberMe?: boolean; - - /** - * @en Whether to show third-party login - */ - showThirdPartyLogin?: boolean; - - /** - * @en Login box subtitle - */ - subTitle?: string; - - /** - * @en Login box title - */ - title?: string; -} -``` - -::: - -::: tip - -If these configurations do not meet your needs, you can implement your own login form and related login logic. - -::: diff --git a/docs/src/en/guide/in-depth/theme.md b/docs/src/en/guide/in-depth/theme.md deleted file mode 100644 index 164ac179..00000000 --- a/docs/src/en/guide/in-depth/theme.md +++ /dev/null @@ -1,1295 +0,0 @@ -# Theme - -The framework is built on [shadcn-vue](https://www.shadcn-vue.com/themes.html) and [tailwindcss](https://tailwindcss.com/), offering a rich theme configuration. You can easily switch between various themes through simple configuration to meet personalized needs. You can choose to use CSS variables or Tailwind CSS utility classes for theme settings. - -## CSS Variables - -The project follows the theme configuration of [shadcn-vue](https://www.shadcn-vue.com/themes.html), for example: - -```html -
-``` - -We use a simple convention for colors. The `background` variable is used for the background color of components, and the `foreground` variable is used for text color. - -For the following components, `background` will be `hsl(var(--primary))`, and `foreground` will be `hsl(var(--primary-foreground))`. - -## Detailed List of CSS Variables - -::: warning Note - -The colors inside CSS variables must use the `hsl` format, such as `0 0% 100%`, without adding `hsl()` and `,`. - -::: - -You can check the list below to understand all the available variables. - -::: details Default theme CSS variables - -```css -:root { - --font-family: - -apple-system, blinkmacsystemfont, 'Segoe UI', roboto, 'Helvetica Neue', - arial, 'Noto Sans', sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', - 'Segoe UI Symbol', 'Noto Color Emoji'; - - /* Default background color of ...etc */ - --background: 0 0% 100%; - - /* Main area background color */ - --background-deep: 216 20.11% 95.47%; - --foreground: 210 6% 21%; - - /* Background color for */ - --card: 0 0% 100%; - --card-foreground: 222.2 84% 4.9%; - - /* Background color for popovers such as , , */ - --popover: 0 0% 100%; - --popover-foreground: 222.2 84% 4.9%; - - /* Muted backgrounds such as , and */ - --muted: 210 40% 96.1%; - --muted-foreground: 215.4 16.3% 46.9%; - - /* Theme Colors */ - - --primary: 212 100% 45%; - --primary-foreground: 0 0% 98%; - - /* Used for destructive actions such as