@origen-ui/admin-cli 2.0.1 → 3.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +50 -11
- package/bin/contract-sync.mjs +112 -0
- package/bin/lib/errors.mjs +8 -0
- package/bin/lib/fs-json.mjs +18 -0
- package/bin/lib/hash.mjs +9 -0
- package/bin/og-admin.mjs +165 -35
- package/bin/sync-project.mjs +717 -0
- package/package.json +28 -17
- package/templates/current/clean/.agents/skills/admin-component-usage/SKILL.md +28 -0
- package/templates/current/clean/.agents/skills/admin-component-usage/references/component-directory.md +270 -0
- package/templates/current/clean/.agents/skills/build-admin-feature/SKILL.md +20 -0
- package/templates/current/clean/.agents/skills/build-admin-feature/references/component-selection.md +38 -0
- package/templates/current/{examples/.codex → clean/.agents}/skills/use-og-form/SKILL.md +1 -1
- package/templates/current/{examples/.codex → clean/.agents}/skills/use-og-form-table/SKILL.md +4 -3
- package/templates/current/clean/{.codex → .agents}/skills/use-og-search/SKILL.md +3 -3
- package/templates/current/clean/.agents/skills/use-og-table/SKILL.md +22 -0
- package/templates/current/{examples/.codex → clean/.agents}/skills/use-og-upload/SKILL.md +6 -5
- package/templates/current/clean/.api-client-e2e.config.ts +13 -0
- package/templates/current/clean/.claude/rules/01-feature-architecture.md +10 -0
- package/templates/current/clean/.claude/rules/02-vue-typescript.md +10 -0
- package/templates/current/clean/.claude/rules/03-component-policy.md +31 -0
- package/templates/current/clean/.claude/rules/04-api-auth-router.md +10 -0
- package/templates/current/clean/.claude/rules/05-style.md +10 -0
- package/templates/current/clean/.claude/rules/06-quality.md +10 -0
- package/templates/current/clean/.claude/skills/admin-component-usage/SKILL.md +28 -0
- package/templates/current/clean/.claude/skills/admin-component-usage/references/component-directory.md +270 -0
- package/templates/current/clean/.claude/skills/build-admin-feature/SKILL.md +20 -0
- package/templates/current/clean/.claude/skills/build-admin-feature/references/component-selection.md +38 -0
- package/templates/current/clean/{.codex → .claude}/skills/use-og-form/SKILL.md +1 -1
- package/templates/current/clean/{.codex → .claude}/skills/use-og-form-table/SKILL.md +4 -3
- package/templates/current/{examples/.codex → clean/.claude}/skills/use-og-search/SKILL.md +3 -3
- package/templates/current/clean/.claude/skills/use-og-table/SKILL.md +22 -0
- package/templates/current/clean/{.codex → .claude}/skills/use-og-upload/SKILL.md +6 -5
- package/templates/current/clean/.codebuddy/rules/01-feature-architecture.md +2 -2
- package/templates/current/clean/.codebuddy/rules/03-component-policy.md +4 -1
- package/templates/current/clean/.codebuddy/skills/admin-component-usage/SKILL.md +31 -0
- package/templates/current/clean/.codebuddy/skills/admin-component-usage/references/component-directory.md +270 -0
- package/templates/current/clean/.codebuddy/skills/build-admin-feature/SKILL.md +11 -5
- package/templates/current/clean/.codebuddy/skills/build-admin-feature/references/component-selection.md +38 -0
- package/templates/current/clean/.codebuddy/skills/use-og-form/SKILL.md +1 -1
- package/templates/current/clean/.codebuddy/skills/use-og-form-table/SKILL.md +4 -3
- package/templates/current/clean/.codebuddy/skills/use-og-search/SKILL.md +3 -3
- package/templates/current/clean/.codebuddy/skills/use-og-table/SKILL.md +16 -10
- package/templates/current/clean/.codebuddy/skills/use-og-upload/SKILL.md +6 -5
- package/templates/current/clean/.codex/AGENTS.md +55 -8
- package/templates/current/clean/.codex/rules/01-feature-architecture.md +2 -2
- package/templates/current/clean/.codex/rules/03-component-policy.md +4 -1
- package/templates/current/clean/.cursor/rules/.generated +5 -0
- package/templates/current/clean/.cursor/rules/01-feature-architecture.mdc +2 -2
- package/templates/current/clean/.cursor/rules/03-component-policy.mdc +4 -1
- package/templates/current/clean/.cursor/skills/admin-component-usage/SKILL.md +28 -0
- package/templates/current/clean/.cursor/skills/admin-component-usage/references/component-directory.md +270 -0
- package/templates/current/clean/.cursor/skills/build-admin-feature/SKILL.md +11 -5
- package/templates/current/clean/.cursor/skills/build-admin-feature/references/component-selection.md +38 -0
- package/templates/current/clean/.cursor/skills/use-og-form/SKILL.md +1 -1
- package/templates/current/clean/.cursor/skills/use-og-form-table/SKILL.md +4 -3
- package/templates/current/clean/.cursor/skills/use-og-search/SKILL.md +3 -3
- package/templates/current/clean/.cursor/skills/use-og-table/SKILL.md +16 -10
- package/templates/current/clean/.cursor/skills/use-og-upload/SKILL.md +6 -5
- package/templates/current/clean/{.env.example → .env.dev} +3 -2
- package/templates/current/clean/.env.mock +4 -0
- package/templates/current/clean/.env.production +5 -0
- package/templates/current/clean/.env.test +4 -0
- package/templates/current/clean/.node-version +1 -0
- package/templates/current/clean/.prettierignore +17 -0
- package/templates/current/clean/.prettierrc +8 -0
- package/templates/current/clean/.qoder/rules/01-feature-architecture.md +3 -4
- package/templates/current/clean/.qoder/rules/02-vue-typescript.md +1 -2
- package/templates/current/clean/.qoder/rules/03-component-policy.md +5 -3
- package/templates/current/clean/.qoder/rules/04-api-auth-router.md +1 -2
- package/templates/current/clean/.qoder/rules/05-style.md +1 -2
- package/templates/current/clean/.qoder/rules/06-quality.md +1 -2
- package/templates/current/clean/.qoder/skills/admin-component-usage/SKILL.md +28 -0
- package/templates/current/clean/.qoder/skills/admin-component-usage/references/component-directory.md +270 -0
- package/templates/current/clean/.qoder/skills/build-admin-feature/SKILL.md +11 -5
- package/templates/current/clean/.qoder/skills/build-admin-feature/references/component-selection.md +38 -0
- package/templates/current/clean/.qoder/skills/use-og-form/SKILL.md +1 -1
- package/templates/current/clean/.qoder/skills/use-og-form-table/SKILL.md +4 -3
- package/templates/current/clean/.qoder/skills/use-og-search/SKILL.md +3 -3
- package/templates/current/clean/.qoder/skills/use-og-table/SKILL.md +16 -10
- package/templates/current/clean/.qoder/skills/use-og-upload/SKILL.md +6 -5
- package/templates/current/clean/.zcode/skills/admin-component-usage/SKILL.md +28 -0
- package/templates/current/clean/.zcode/skills/admin-component-usage/references/component-directory.md +270 -0
- package/templates/current/clean/.zcode/skills/build-admin-feature/SKILL.md +20 -0
- package/templates/current/clean/.zcode/skills/build-admin-feature/references/component-selection.md +38 -0
- package/templates/current/clean/.zcode/skills/style-og-origen-ui/SKILL.md +11 -0
- package/templates/current/clean/.zcode/skills/use-og-dialog/SKILL.md +12 -0
- package/templates/current/clean/.zcode/skills/use-og-editor/SKILL.md +25 -0
- package/templates/current/clean/.zcode/skills/use-og-form/SKILL.md +12 -0
- package/templates/current/clean/.zcode/skills/use-og-form-table/SKILL.md +26 -0
- package/templates/current/clean/.zcode/skills/use-og-http/SKILL.md +13 -0
- package/templates/current/clean/.zcode/skills/use-og-router-tabs/SKILL.md +11 -0
- package/templates/current/clean/.zcode/skills/use-og-search/SKILL.md +14 -0
- package/templates/current/clean/.zcode/skills/use-og-table/SKILL.md +22 -0
- package/templates/current/clean/.zcode/skills/use-og-upload/SKILL.md +26 -0
- package/templates/current/clean/AGENTS.md +55 -9
- package/templates/current/clean/CHANGELOG.md +129 -0
- package/templates/current/clean/CLAUDE.md +3 -0
- package/templates/current/clean/README.md +58 -87
- package/templates/current/clean/component-catalog.json +766 -348
- package/templates/current/clean/component-catalog.v2.json +2040 -0
- package/templates/current/clean/docs/components/dialog.md +405 -0
- package/templates/current/clean/docs/components/editor-viewer.md +87 -0
- package/templates/current/clean/docs/components/editor.md +275 -0
- package/templates/current/clean/docs/components/form-table.md +222 -0
- package/templates/current/clean/docs/components/form.md +750 -0
- package/templates/current/clean/docs/components/index.md +44 -0
- package/templates/current/clean/docs/components/router.md +452 -0
- package/templates/current/clean/docs/components/search.md +1205 -0
- package/templates/current/clean/docs/components/svg-icon.md +124 -0
- package/templates/current/clean/docs/components/table-local.md +176 -0
- package/templates/current/clean/docs/components/table-with-search.md +207 -0
- package/templates/current/clean/docs/components/table.md +813 -0
- package/templates/current/clean/docs/components/tabs.md +440 -0
- package/templates/current/clean/docs/components/upload.md +349 -0
- package/templates/current/clean/eslint.config.js +89 -0
- package/templates/current/clean/index.html +1 -1
- package/templates/current/clean/openapi.json +10048 -999
- package/templates/current/clean/package.json +51 -39
- package/templates/current/clean/playwright.config.ts +20 -6
- package/templates/current/clean/playwright.mock.config.ts +42 -0
- package/templates/current/clean/pnpm-workspace.yaml +34 -0
- package/templates/current/clean/recipes/remote-crud-dialog-form.vue +15 -13
- package/templates/current/clean/scaffold.lock.json +164 -4
- package/templates/current/clean/scripts/api-codegen.config.ts +35 -0
- package/templates/current/clean/scripts/api-codegen.ts +2015 -0
- package/templates/current/clean/scripts/api-templates/http-client.ejs +359 -0
- package/templates/current/clean/scripts/check-admin-scaffold.mjs +316 -18
- package/templates/current/clean/scripts/generate-api.ts +290 -85
- package/templates/current/clean/scripts/lib/admin-component-catalog.mjs +515 -0
- package/templates/current/clean/scripts/lib/repository-root.mjs +9 -0
- package/templates/current/clean/scripts/mock-api.ts +1356 -0
- package/templates/current/clean/scripts/remove-examples.mjs +10 -35
- package/templates/current/clean/src/App.vue +9 -18
- package/templates/current/clean/src/api/generated/data-contracts.ts +23 -265
- package/templates/current/clean/src/api/generated/http-client.ts +351 -180
- package/templates/current/clean/src/api/generated/index.ts +22 -0
- package/templates/current/clean/src/api/generated/services/auth.ts +123 -0
- package/templates/current/clean/src/api/generated/services/common/files.ts +111 -0
- package/templates/current/clean/src/api/generated/services/monitor/cache.ts +164 -0
- package/templates/current/clean/src/api/generated/services/monitor/job.ts +195 -0
- package/templates/current/clean/src/api/generated/services/monitor/jobLog.ts +126 -0
- package/templates/current/clean/src/api/generated/services/monitor/logininfor.ts +126 -0
- package/templates/current/clean/src/api/generated/services/monitor/online.ts +66 -0
- package/templates/current/clean/src/api/generated/services/monitor/operlog.ts +106 -0
- package/templates/current/clean/src/api/generated/services/monitor/server.ts +41 -0
- package/templates/current/clean/src/api/generated/services/system/configs.ts +190 -0
- package/templates/current/clean/src/api/generated/services/system/departments.ts +173 -0
- package/templates/current/clean/src/api/generated/services/system/dictionaries/data.ts +169 -0
- package/templates/current/clean/src/api/generated/services/system/dictionaries/types.ts +187 -0
- package/templates/current/clean/src/api/generated/services/system/index.ts +158 -0
- package/templates/current/clean/src/api/generated/services/system/menus.ts +193 -0
- package/templates/current/clean/src/api/generated/services/system/notices.ts +221 -0
- package/templates/current/clean/src/api/generated/services/system/posts.ts +168 -0
- package/templates/current/clean/src/api/generated/services/system/roles.ts +354 -0
- package/templates/current/clean/src/api/generated/services/system/users.ts +425 -0
- package/templates/current/clean/src/api/generated/services/tool/code-generator.ts +304 -0
- package/templates/current/clean/src/api/generated/types/auth.types.ts +132 -0
- package/templates/current/clean/src/api/generated/types/common/files.types.ts +57 -0
- package/templates/current/clean/src/api/generated/types/common.ts +174 -0
- package/templates/current/clean/src/api/generated/types/enum-dict.ts +94 -0
- package/templates/current/clean/src/api/generated/types/enums.ts +155 -0
- package/templates/current/clean/src/api/generated/types/monitor/cache.types.ts +149 -0
- package/templates/current/clean/src/api/generated/types/monitor/job.types.ts +207 -0
- package/templates/current/clean/src/api/generated/types/monitor/jobLog.types.ts +134 -0
- package/templates/current/clean/src/api/generated/types/monitor/logininfor.types.ts +135 -0
- package/templates/current/clean/src/api/generated/types/monitor/online.types.ts +80 -0
- package/templates/current/clean/src/api/generated/types/monitor/operlog.types.ts +126 -0
- package/templates/current/clean/src/api/generated/types/monitor/server.types.ts +205 -0
- package/templates/current/clean/src/api/generated/types/system/configs.types.ts +200 -0
- package/templates/current/clean/src/api/generated/types/system/departments.types.ts +145 -0
- package/templates/current/clean/src/api/generated/types/system/dictionaries/data.types.ts +210 -0
- package/templates/current/clean/src/api/generated/types/system/dictionaries/types.types.ts +221 -0
- package/templates/current/clean/src/api/generated/types/system/index.types.ts +19 -0
- package/templates/current/clean/src/api/generated/types/system/menus.types.ts +234 -0
- package/templates/current/clean/src/api/generated/types/system/notices.types.ts +270 -0
- package/templates/current/clean/src/api/generated/types/system/posts.types.ts +198 -0
- package/templates/current/clean/src/api/generated/types/system/roles.types.ts +410 -0
- package/templates/current/clean/src/api/generated/types/system/users.types.ts +413 -0
- package/templates/current/clean/src/api/generated/types/tool/code-generator.types.ts +388 -0
- package/templates/current/clean/src/api/index.ts +44 -39
- package/templates/current/clean/src/app/__tests__/api-generated.types.ts +24 -0
- package/templates/current/clean/src/app/api.ts +6 -0
- package/templates/current/clean/src/app/authorization/permission.ts +9 -0
- package/templates/current/{examples/src/app → clean/src/app/config}/runtimeConfig.ts +44 -12
- package/templates/current/clean/src/app/errors/errorMessage.ts +80 -0
- package/templates/current/clean/src/app/http/client.ts +141 -0
- package/templates/current/clean/src/app/http/http-adapter.ts +71 -0
- package/templates/current/{examples/src/app → clean/src/app/i18n}/adminLocale.ts +25 -19
- package/templates/current/clean/src/app/{localeFormat.ts → i18n/localeFormat.ts} +29 -6
- package/templates/current/clean/src/app/i18n/origenUiLocale.ts +15 -0
- package/templates/current/clean/src/app/menu/menu.ts +175 -0
- package/templates/current/clean/src/app/menu/menuTypes.ts +20 -0
- package/templates/current/clean/src/{features → app}/security/devtoolsProtection.ts +8 -7
- package/templates/current/clean/src/app/ui/createAdminUi.ts +31 -0
- package/templates/current/clean/src/app/ui/iconCatalog.ts +71 -0
- package/templates/current/clean/src/assets/icons/appearance.svg +1 -0
- package/templates/current/clean/src/assets/icons/arrow-right.svg +1 -0
- package/templates/current/clean/src/assets/icons/check.svg +1 -0
- package/templates/current/clean/src/assets/icons/circle-check.svg +1 -0
- package/templates/current/clean/src/assets/icons/default.svg +4 -0
- package/templates/current/clean/src/assets/icons/directory/setting.svg +1 -0
- package/templates/current/clean/src/assets/icons/expand.svg +1 -0
- package/templates/current/clean/src/assets/icons/fold.svg +1 -0
- package/templates/current/clean/src/assets/icons/key.svg +1 -0
- package/templates/current/clean/src/assets/icons/lock.svg +1 -0
- package/templates/current/clean/src/assets/icons/monitor.svg +1 -0
- package/templates/current/clean/src/assets/icons/moon.svg +11 -0
- package/templates/current/clean/src/assets/icons/page/department.svg +1 -0
- package/templates/current/clean/src/assets/icons/page/dictionary.svg +1 -0
- package/templates/current/clean/src/assets/icons/page/menus.svg +1 -0
- package/templates/current/clean/src/assets/icons/page/user.svg +1 -0
- package/templates/current/clean/src/assets/icons/page/users.svg +1 -0
- package/templates/current/clean/src/assets/icons/plus.svg +1 -0
- package/templates/current/clean/src/assets/icons/profile.svg +1 -0
- package/templates/current/clean/src/assets/icons/refresh.svg +1 -0
- package/templates/current/clean/src/assets/icons/roles.svg +1 -0
- package/templates/current/clean/src/assets/icons/search.svg +1 -0
- package/templates/current/clean/src/assets/icons/sunny.svg +1 -0
- package/templates/current/clean/src/assets/icons/system.svg +1 -0
- package/templates/current/clean/src/assets/icons/theme-auto.svg +14 -0
- package/templates/current/clean/src/assets/icons/tune.svg +13 -0
- package/templates/current/clean/src/{features/shell/components → components}/RouteProgress.vue +2 -2
- package/templates/current/{examples/src/features/system/access → clean/src}/composables/useAuthorizationRefresh.ts +6 -1
- package/templates/current/clean/src/composables/useSystemTableSearchVisibility.ts +33 -0
- package/templates/current/clean/src/{features/appearance/composables → composables}/useTheme.ts +1 -1
- package/templates/current/clean/src/env.d.ts +6 -19
- package/templates/current/clean/src/layouts/AdminLayout.vue +7 -9
- package/templates/current/clean/src/{features/shell/components → layouts}/AdminWatermark.vue +2 -2
- package/templates/current/clean/src/layouts/BreadcrumbBar.vue +9 -1
- package/templates/current/clean/src/layouts/SideMenu.vue +7 -15
- package/templates/current/clean/src/{features/appearance/components → layouts}/ThemePanel.vue +39 -11
- package/templates/current/clean/src/layouts/TopBar.vue +60 -28
- package/templates/current/clean/src/layouts/WorkspaceTabs.vue +10 -1
- package/templates/current/clean/src/layouts/topBarMenuSearch.ts +25 -4
- package/templates/current/clean/src/locales/en-US.json +227 -219
- package/templates/current/clean/src/locales/index.ts +72 -32
- package/templates/current/clean/src/locales/messages-types.ts +15 -10
- package/templates/current/clean/src/locales/vue-i18n.d.ts +1 -1
- package/templates/current/clean/src/locales/zh-CN.json +226 -218
- package/templates/current/clean/src/locales/zh-TW.json +222 -214
- package/templates/current/clean/src/main.ts +59 -30
- package/templates/current/clean/src/router/bootstrap.ts +69 -24
- package/templates/current/clean/src/router/dynamic/componentLoader.ts +150 -0
- package/templates/current/clean/src/router/{dynamicMenuRefresh.ts → dynamic/dynamicMenuRefresh.ts} +6 -2
- package/templates/current/clean/src/router/dynamic/dynamicRoutes.ts +247 -0
- package/templates/current/clean/src/router/navigation/guards.ts +12 -0
- package/templates/current/clean/src/router/navigation/paths.ts +28 -0
- package/templates/current/clean/src/router/navigation/staticRoutes.ts +109 -0
- package/templates/current/clean/src/router/{queryEncryption.ts → query/queryEncryption.ts} +29 -12
- package/templates/current/clean/src/router/query/routeQuery.ts +29 -0
- package/templates/current/clean/src/router/{useRouteQueryDefaults.ts → query/useRouteQueryDefaults.ts} +9 -8
- package/templates/current/clean/src/router/query/useRouteQueryDefaults.types.ts +28 -0
- package/templates/current/clean/src/router/{runtimeErrorRecovery.ts → recovery/runtimeErrorRecovery.ts} +21 -3
- package/templates/current/clean/src/{features/auth/store → store}/auth.ts +96 -61
- package/templates/current/clean/src/store/dictionaries.ts +86 -0
- package/templates/current/clean/src/{features/shell/store → store}/sidebar.ts +9 -2
- package/templates/current/{examples/src/features/appearance → clean/src}/store/theme.ts +8 -4
- package/templates/current/clean/src/styles/layout.css +51 -0
- package/templates/current/clean/src/templates/og-form.ts +7 -2
- package/templates/current/clean/src/templates/og-table.ts +88 -20
- package/templates/current/clean/src/templates/router.ts +11 -2
- package/templates/current/clean/src/utils/color-mix.ts +6 -2
- package/templates/current/clean/src/utils/download.ts +11 -0
- package/templates/current/clean/src/utils/permissions.ts +1 -1
- package/templates/current/clean/src/utils/retryableDialog.ts +46 -0
- package/templates/current/clean/src/{features → views}/errors/pages/Forbidden.vue +6 -2
- package/templates/current/clean/src/views/errors/pages/MethodNotAllowed.vue +34 -0
- package/templates/current/clean/src/{features → views}/errors/pages/NotFound.vue +6 -2
- package/templates/current/clean/src/{features → views}/errors/pages/ServerError.vue +6 -2
- package/templates/current/clean/src/{features/auth/pages/Login.vue → views/login/pages/index.vue} +101 -11
- package/templates/current/clean/src/views/system/access/services/admin-repository.ts +489 -0
- package/templates/current/clean/src/views/system/access/services/rbac.ts +317 -0
- package/templates/current/clean/src/views/system/dept/components/DepartmentEditorForm.vue +87 -0
- package/templates/current/clean/src/views/system/dept/composables/useDepartmentManagement.ts +314 -0
- package/templates/current/clean/src/views/system/dept/pages/index.vue +44 -0
- package/templates/current/clean/src/views/system/dept/services/departments.ts +168 -0
- package/templates/current/clean/src/views/system/dict/components/DictionaryDataEditorForm.vue +98 -0
- package/templates/current/clean/src/views/system/dict/components/DictionaryDataPreview.vue +233 -0
- package/templates/current/clean/src/views/system/dict/components/DictionaryTypeEditorForm.vue +66 -0
- package/templates/current/clean/src/views/system/dict/composables/useDictionaryDataManagement.ts +406 -0
- package/templates/current/clean/src/views/system/dict/composables/useDictionaryTypeManagement.ts +329 -0
- package/templates/current/clean/src/views/system/dict/data/pages/index.vue +134 -0
- package/templates/current/clean/src/views/system/dict/pages/index.vue +113 -0
- package/templates/current/clean/src/views/system/dict/services/dictionaries.ts +239 -0
- package/templates/current/clean/src/views/system/menu/components/MenuEditorForm.vue +252 -0
- package/templates/current/clean/src/views/system/menu/composables/useMenuManagement.ts +357 -0
- package/templates/current/clean/src/views/system/menu/menuDraft.ts +45 -0
- package/templates/current/clean/src/views/system/menu/pages/ExternalLink.vue +37 -0
- package/templates/current/clean/src/views/system/menu/pages/index.vue +75 -0
- package/templates/current/clean/src/views/system/post/components/PostEditorForm.vue +69 -0
- package/templates/current/clean/src/views/system/post/composables/usePostManagement.ts +245 -0
- package/templates/current/clean/src/views/system/post/pages/index.vue +92 -0
- package/templates/current/clean/src/views/system/post/services/posts.ts +100 -0
- package/templates/current/clean/src/views/system/role/auth-users/pages/index.vue +100 -0
- package/templates/current/clean/src/views/system/role/components/RoleDataScopeForm.vue +167 -0
- package/templates/current/clean/src/views/system/role/components/RoleEditorForm.vue +165 -0
- package/templates/current/clean/src/views/system/role/components/RoleUserSelectForm.vue +129 -0
- package/templates/current/clean/src/views/system/role/composables/useRoleManagement.ts +422 -0
- package/templates/current/clean/src/views/system/role/composables/useRoleUserManagement.ts +233 -0
- package/templates/current/clean/src/views/system/role/pages/index.vue +110 -0
- package/templates/current/clean/src/views/system/role/services/roleAccess.ts +162 -0
- package/templates/current/clean/src/views/system/user/auth-roles/pages/index.vue +209 -0
- package/templates/current/clean/src/views/system/user/components/UserDetailsForm.vue +108 -0
- package/templates/current/clean/src/views/system/user/components/UserEditorForm.vue +207 -0
- package/templates/current/clean/src/views/system/user/components/UserImportDialog.vue +80 -0
- package/templates/current/clean/src/views/system/user/components/UserResetPasswordForm.vue +56 -0
- package/templates/current/clean/src/views/system/user/composables/useUserManagement.ts +502 -0
- package/templates/current/clean/src/views/system/user/pages/index.vue +459 -0
- package/templates/current/clean/tests/e2e/admin-access-business.spec.ts +33 -0
- package/templates/current/clean/tests/e2e/admin-shell.spec.ts +50 -0
- package/templates/current/clean/tests/e2e/fixtures/adminMockBackend.ts +95 -0
- package/templates/current/clean/tests/e2e/fixtures/labelGeometry.ts +52 -0
- package/templates/current/clean/tests/e2e/mock-api-generation.spec.ts +27 -0
- package/templates/current/clean/tests/e2e/mock-business.spec.ts +555 -0
- package/templates/current/clean/tests/e2e/mock-menu-retry-form-label.spec.ts +100 -0
- package/templates/current/clean/tests/e2e/mock-shell.spec.ts +25 -0
- package/templates/current/clean/tests/e2e/mock-tree-selection-layout.spec.ts +113 -0
- package/templates/current/clean/tests/unit/api/api-codegen.spec.ts +893 -0
- package/templates/current/clean/tests/unit/api/client.spec.ts +145 -0
- package/templates/current/clean/tests/unit/api/generated-http-client.spec.ts +290 -0
- package/templates/current/{examples/src → clean/tests/unit}/api/http-adapter.spec.ts +3 -3
- package/templates/current/clean/tests/unit/api/system-apis.spec.ts +118 -0
- package/templates/current/clean/tests/unit/app/createAdminUi.spec.ts +79 -0
- package/templates/current/clean/{src → tests/unit}/app/errorMessage.spec.ts +1 -1
- package/templates/current/clean/tests/unit/app/iconCatalog.spec.ts +12 -0
- package/templates/current/clean/tests/unit/app/menu.spec.ts +215 -0
- package/templates/current/{examples/src → clean/tests/unit}/app/origenUiLocale.spec.ts +1 -1
- package/templates/current/{examples/src → clean/tests/unit}/app/permission.spec.ts +4 -5
- package/templates/current/clean/tests/unit/app/runtimeConfig.spec.ts +36 -0
- package/templates/current/{examples/src/features → clean/tests/unit/app}/security/devtoolsProtection.spec.ts +17 -7
- package/templates/current/{examples/src/features/shell → clean/tests/unit}/composables/useRouteProgress.spec.ts +1 -1
- package/templates/current/{examples/src/features/shell/components → clean/tests/unit/layouts}/AdminWatermark.spec.ts +5 -7
- package/templates/current/{examples/src → clean/tests/unit}/layouts/topBarMenuSearch.spec.ts +25 -8
- package/templates/current/clean/{src → tests/unit}/locales/messages.spec.ts +43 -17
- package/templates/current/clean/tests/unit/router/dynamicMenuRefresh.spec.ts +151 -0
- package/templates/current/clean/tests/unit/router/dynamicRoutes.spec.ts +374 -0
- package/templates/current/clean/tests/unit/router/paths.spec.ts +103 -0
- package/templates/current/clean/{src → tests/unit}/router/queryEncryption.spec.ts +56 -10
- package/templates/current/clean/tests/unit/router/routeQuery.spec.ts +19 -0
- package/templates/current/clean/{src → tests/unit}/router/runtimeErrorRecovery.spec.ts +11 -6
- package/templates/current/{examples/src → clean/tests/unit}/router/useRouteQueryDefaults.spec.ts +46 -12
- package/templates/current/clean/tests/unit/scripts/mock-api.spec.ts +440 -0
- package/templates/current/clean/{scripts → tests/unit/scripts}/vite-build-policy.spec.ts +35 -6
- package/templates/current/clean/{src/features/auth → tests/unit}/store/auth.spec.ts +68 -15
- package/templates/current/clean/tests/unit/store/dictionaries.spec.ts +106 -0
- package/templates/current/{examples/src → clean/tests/unit}/templates/templates.spec.ts +60 -16
- package/templates/current/clean/{src/utils/__tests__ → tests/unit/utils}/color-mix.spec.ts +1 -1
- package/templates/current/clean/tests/unit/utils/retryableDialog.spec.ts +61 -0
- package/templates/current/{examples/src/features/errors/pages → clean/tests/unit/views/errors}/error-pages.spec.ts +11 -7
- package/templates/current/clean/tests/unit/views/feature-composables.spec.ts +233 -0
- package/templates/current/clean/tests/unit/views/system/access/admin-repository.spec.ts +353 -0
- package/templates/current/clean/tests/unit/views/system/access/rbac.spec.ts +329 -0
- package/templates/current/clean/tests/unit/views/system/dept/departments.spec.ts +104 -0
- package/templates/current/clean/tests/unit/views/system/dict/dictionaries.spec.ts +234 -0
- package/templates/current/clean/tests/unit/views/system/menu/menuDraft.spec.ts +77 -0
- package/templates/current/clean/tests/unit/views/system/menu/useMenuManagement.spec.ts +339 -0
- package/templates/current/clean/tests/unit/views/system/user/searchControl.spec.ts +128 -0
- package/templates/current/clean/tsconfig.json +4 -19
- package/templates/current/clean/vite.build-policy.ts +97 -22
- package/templates/current/clean/vite.config.ts +50 -7
- package/templates/current/examples/.agents/skills/admin-component-usage/SKILL.md +28 -0
- package/templates/current/examples/.agents/skills/admin-component-usage/references/component-directory.md +270 -0
- package/templates/current/examples/.agents/skills/build-admin-feature/SKILL.md +20 -0
- package/templates/current/examples/.agents/skills/build-admin-feature/references/component-selection.md +38 -0
- package/templates/current/examples/.agents/skills/style-og-origen-ui/SKILL.md +11 -0
- package/templates/current/examples/.agents/skills/use-og-dialog/SKILL.md +12 -0
- package/templates/current/examples/.agents/skills/use-og-editor/SKILL.md +25 -0
- package/templates/current/examples/.agents/skills/use-og-form/SKILL.md +12 -0
- package/templates/current/examples/.agents/skills/use-og-form-table/SKILL.md +26 -0
- package/templates/current/examples/.agents/skills/use-og-http/SKILL.md +13 -0
- package/templates/current/examples/.agents/skills/use-og-router-tabs/SKILL.md +11 -0
- package/templates/current/examples/.agents/skills/use-og-search/SKILL.md +14 -0
- package/templates/current/examples/.agents/skills/use-og-table/SKILL.md +22 -0
- package/templates/current/examples/.agents/skills/use-og-upload/SKILL.md +26 -0
- package/templates/current/examples/.api-client-e2e.config.ts +13 -0
- package/templates/current/examples/.claude/rules/01-feature-architecture.md +10 -0
- package/templates/current/examples/.claude/rules/02-vue-typescript.md +10 -0
- package/templates/current/examples/.claude/rules/03-component-policy.md +31 -0
- package/templates/current/examples/.claude/rules/04-api-auth-router.md +10 -0
- package/templates/current/examples/.claude/rules/05-style.md +10 -0
- package/templates/current/examples/.claude/rules/06-quality.md +10 -0
- package/templates/current/examples/.claude/skills/admin-component-usage/SKILL.md +28 -0
- package/templates/current/examples/.claude/skills/admin-component-usage/references/component-directory.md +270 -0
- package/templates/current/examples/.claude/skills/build-admin-feature/SKILL.md +20 -0
- package/templates/current/examples/.claude/skills/build-admin-feature/references/component-selection.md +38 -0
- package/templates/current/examples/.claude/skills/style-og-origen-ui/SKILL.md +11 -0
- package/templates/current/examples/.claude/skills/use-og-dialog/SKILL.md +12 -0
- package/templates/current/examples/.claude/skills/use-og-editor/SKILL.md +25 -0
- package/templates/current/examples/.claude/skills/use-og-form/SKILL.md +12 -0
- package/templates/current/examples/.claude/skills/use-og-form-table/SKILL.md +26 -0
- package/templates/current/examples/.claude/skills/use-og-http/SKILL.md +13 -0
- package/templates/current/examples/.claude/skills/use-og-router-tabs/SKILL.md +11 -0
- package/templates/current/examples/.claude/skills/use-og-search/SKILL.md +14 -0
- package/templates/current/examples/.claude/skills/use-og-table/SKILL.md +22 -0
- package/templates/current/examples/.claude/skills/use-og-upload/SKILL.md +26 -0
- package/templates/current/examples/.codebuddy/rules/01-feature-architecture.md +2 -2
- package/templates/current/examples/.codebuddy/rules/03-component-policy.md +4 -1
- package/templates/current/examples/.codebuddy/skills/admin-component-usage/SKILL.md +31 -0
- package/templates/current/examples/.codebuddy/skills/admin-component-usage/references/component-directory.md +270 -0
- package/templates/current/examples/.codebuddy/skills/build-admin-feature/SKILL.md +11 -5
- package/templates/current/examples/.codebuddy/skills/build-admin-feature/references/component-selection.md +38 -0
- package/templates/current/examples/.codebuddy/skills/use-og-form/SKILL.md +1 -1
- package/templates/current/examples/.codebuddy/skills/use-og-form-table/SKILL.md +4 -3
- package/templates/current/examples/.codebuddy/skills/use-og-search/SKILL.md +3 -3
- package/templates/current/examples/.codebuddy/skills/use-og-table/SKILL.md +16 -10
- package/templates/current/examples/.codebuddy/skills/use-og-upload/SKILL.md +6 -5
- package/templates/current/examples/.codex/AGENTS.md +55 -8
- package/templates/current/examples/.codex/rules/01-feature-architecture.md +2 -2
- package/templates/current/examples/.codex/rules/03-component-policy.md +4 -1
- package/templates/current/examples/.cursor/rules/.generated +5 -0
- package/templates/current/examples/.cursor/rules/01-feature-architecture.mdc +2 -2
- package/templates/current/examples/.cursor/rules/03-component-policy.mdc +4 -1
- package/templates/current/examples/.cursor/skills/admin-component-usage/SKILL.md +28 -0
- package/templates/current/examples/.cursor/skills/admin-component-usage/references/component-directory.md +270 -0
- package/templates/current/examples/.cursor/skills/build-admin-feature/SKILL.md +11 -5
- package/templates/current/examples/.cursor/skills/build-admin-feature/references/component-selection.md +38 -0
- package/templates/current/examples/.cursor/skills/use-og-form/SKILL.md +1 -1
- package/templates/current/examples/.cursor/skills/use-og-form-table/SKILL.md +4 -3
- package/templates/current/examples/.cursor/skills/use-og-search/SKILL.md +3 -3
- package/templates/current/examples/.cursor/skills/use-og-table/SKILL.md +16 -10
- package/templates/current/examples/.cursor/skills/use-og-upload/SKILL.md +6 -5
- package/templates/current/examples/{.env.example → .env.dev} +3 -2
- package/templates/current/examples/.env.mock +4 -0
- package/templates/current/examples/.env.production +5 -0
- package/templates/current/examples/.env.test +4 -0
- package/templates/current/examples/.node-version +1 -0
- package/templates/current/examples/.prettierignore +17 -0
- package/templates/current/examples/.prettierrc +8 -0
- package/templates/current/examples/.qoder/rules/01-feature-architecture.md +3 -4
- package/templates/current/examples/.qoder/rules/02-vue-typescript.md +1 -2
- package/templates/current/examples/.qoder/rules/03-component-policy.md +5 -3
- package/templates/current/examples/.qoder/rules/04-api-auth-router.md +1 -2
- package/templates/current/examples/.qoder/rules/05-style.md +1 -2
- package/templates/current/examples/.qoder/rules/06-quality.md +1 -2
- package/templates/current/examples/.qoder/skills/admin-component-usage/SKILL.md +28 -0
- package/templates/current/examples/.qoder/skills/admin-component-usage/references/component-directory.md +270 -0
- package/templates/current/examples/.qoder/skills/build-admin-feature/SKILL.md +11 -5
- package/templates/current/examples/.qoder/skills/build-admin-feature/references/component-selection.md +38 -0
- package/templates/current/examples/.qoder/skills/use-og-form/SKILL.md +1 -1
- package/templates/current/examples/.qoder/skills/use-og-form-table/SKILL.md +4 -3
- package/templates/current/examples/.qoder/skills/use-og-search/SKILL.md +3 -3
- package/templates/current/examples/.qoder/skills/use-og-table/SKILL.md +16 -10
- package/templates/current/examples/.qoder/skills/use-og-upload/SKILL.md +6 -5
- package/templates/current/examples/.zcode/skills/admin-component-usage/SKILL.md +28 -0
- package/templates/current/examples/.zcode/skills/admin-component-usage/references/component-directory.md +270 -0
- package/templates/current/examples/.zcode/skills/build-admin-feature/SKILL.md +20 -0
- package/templates/current/examples/.zcode/skills/build-admin-feature/references/component-selection.md +38 -0
- package/templates/current/examples/.zcode/skills/style-og-origen-ui/SKILL.md +11 -0
- package/templates/current/examples/.zcode/skills/use-og-dialog/SKILL.md +12 -0
- package/templates/current/examples/.zcode/skills/use-og-editor/SKILL.md +25 -0
- package/templates/current/examples/.zcode/skills/use-og-form/SKILL.md +12 -0
- package/templates/current/examples/.zcode/skills/use-og-form-table/SKILL.md +26 -0
- package/templates/current/examples/.zcode/skills/use-og-http/SKILL.md +13 -0
- package/templates/current/examples/.zcode/skills/use-og-router-tabs/SKILL.md +11 -0
- package/templates/current/examples/.zcode/skills/use-og-search/SKILL.md +14 -0
- package/templates/current/examples/.zcode/skills/use-og-table/SKILL.md +22 -0
- package/templates/current/examples/.zcode/skills/use-og-upload/SKILL.md +26 -0
- package/templates/current/examples/AGENTS.md +55 -9
- package/templates/current/examples/CHANGELOG.md +129 -0
- package/templates/current/examples/CLAUDE.md +3 -0
- package/templates/current/examples/README.md +58 -87
- package/templates/current/examples/component-catalog.json +766 -348
- package/templates/current/examples/component-catalog.v2.json +2040 -0
- package/templates/current/examples/docs/components/dialog.md +405 -0
- package/templates/current/examples/docs/components/editor-viewer.md +87 -0
- package/templates/current/examples/docs/components/editor.md +275 -0
- package/templates/current/examples/docs/components/form-table.md +222 -0
- package/templates/current/examples/docs/components/form.md +750 -0
- package/templates/current/examples/docs/components/index.md +44 -0
- package/templates/current/examples/docs/components/router.md +452 -0
- package/templates/current/examples/docs/components/search.md +1205 -0
- package/templates/current/examples/docs/components/svg-icon.md +124 -0
- package/templates/current/examples/docs/components/table-local.md +176 -0
- package/templates/current/examples/docs/components/table-with-search.md +207 -0
- package/templates/current/examples/docs/components/table.md +813 -0
- package/templates/current/examples/docs/components/tabs.md +440 -0
- package/templates/current/examples/docs/components/upload.md +349 -0
- package/templates/current/examples/eslint.config.js +89 -0
- package/templates/current/examples/index.html +1 -1
- package/templates/current/examples/openapi.json +10048 -999
- package/templates/current/examples/package.json +51 -39
- package/templates/current/examples/playwright.config.ts +20 -6
- package/templates/current/examples/playwright.mock.config.ts +42 -0
- package/templates/current/examples/pnpm-workspace.yaml +34 -0
- package/templates/current/examples/recipes/remote-crud-dialog-form.vue +15 -13
- package/templates/current/examples/scaffold.lock.json +164 -4
- package/templates/current/examples/scripts/api-codegen.config.ts +35 -0
- package/templates/current/examples/scripts/api-codegen.ts +2015 -0
- package/templates/current/examples/scripts/api-templates/http-client.ejs +359 -0
- package/templates/current/examples/scripts/check-admin-scaffold.mjs +316 -18
- package/templates/current/examples/scripts/generate-api.ts +290 -85
- package/templates/current/examples/scripts/lib/admin-component-catalog.mjs +515 -0
- package/templates/current/examples/scripts/lib/repository-root.mjs +9 -0
- package/templates/current/examples/scripts/mock-api.ts +1356 -0
- package/templates/current/examples/scripts/remove-examples.mjs +10 -35
- package/templates/current/examples/src/App.vue +9 -18
- package/templates/current/examples/src/api/generated/data-contracts.ts +23 -265
- package/templates/current/examples/src/api/generated/http-client.ts +351 -180
- package/templates/current/examples/src/api/generated/index.ts +22 -0
- package/templates/current/examples/src/api/generated/services/auth.ts +123 -0
- package/templates/current/examples/src/api/generated/services/common/files.ts +111 -0
- package/templates/current/examples/src/api/generated/services/monitor/cache.ts +164 -0
- package/templates/current/examples/src/api/generated/services/monitor/job.ts +195 -0
- package/templates/current/examples/src/api/generated/services/monitor/jobLog.ts +126 -0
- package/templates/current/examples/src/api/generated/services/monitor/logininfor.ts +126 -0
- package/templates/current/examples/src/api/generated/services/monitor/online.ts +66 -0
- package/templates/current/examples/src/api/generated/services/monitor/operlog.ts +106 -0
- package/templates/current/examples/src/api/generated/services/monitor/server.ts +41 -0
- package/templates/current/examples/src/api/generated/services/system/configs.ts +190 -0
- package/templates/current/examples/src/api/generated/services/system/departments.ts +173 -0
- package/templates/current/examples/src/api/generated/services/system/dictionaries/data.ts +169 -0
- package/templates/current/examples/src/api/generated/services/system/dictionaries/types.ts +187 -0
- package/templates/current/examples/src/api/generated/services/system/index.ts +158 -0
- package/templates/current/examples/src/api/generated/services/system/menus.ts +193 -0
- package/templates/current/examples/src/api/generated/services/system/notices.ts +221 -0
- package/templates/current/examples/src/api/generated/services/system/posts.ts +168 -0
- package/templates/current/examples/src/api/generated/services/system/roles.ts +354 -0
- package/templates/current/examples/src/api/generated/services/system/users.ts +425 -0
- package/templates/current/examples/src/api/generated/services/tool/code-generator.ts +304 -0
- package/templates/current/examples/src/api/generated/types/auth.types.ts +132 -0
- package/templates/current/examples/src/api/generated/types/common/files.types.ts +57 -0
- package/templates/current/examples/src/api/generated/types/common.ts +174 -0
- package/templates/current/examples/src/api/generated/types/enum-dict.ts +94 -0
- package/templates/current/examples/src/api/generated/types/enums.ts +155 -0
- package/templates/current/examples/src/api/generated/types/monitor/cache.types.ts +149 -0
- package/templates/current/examples/src/api/generated/types/monitor/job.types.ts +207 -0
- package/templates/current/examples/src/api/generated/types/monitor/jobLog.types.ts +134 -0
- package/templates/current/examples/src/api/generated/types/monitor/logininfor.types.ts +135 -0
- package/templates/current/examples/src/api/generated/types/monitor/online.types.ts +80 -0
- package/templates/current/examples/src/api/generated/types/monitor/operlog.types.ts +126 -0
- package/templates/current/examples/src/api/generated/types/monitor/server.types.ts +205 -0
- package/templates/current/examples/src/api/generated/types/system/configs.types.ts +200 -0
- package/templates/current/examples/src/api/generated/types/system/departments.types.ts +145 -0
- package/templates/current/examples/src/api/generated/types/system/dictionaries/data.types.ts +210 -0
- package/templates/current/examples/src/api/generated/types/system/dictionaries/types.types.ts +221 -0
- package/templates/current/examples/src/api/generated/types/system/index.types.ts +19 -0
- package/templates/current/examples/src/api/generated/types/system/menus.types.ts +234 -0
- package/templates/current/examples/src/api/generated/types/system/notices.types.ts +270 -0
- package/templates/current/examples/src/api/generated/types/system/posts.types.ts +198 -0
- package/templates/current/examples/src/api/generated/types/system/roles.types.ts +410 -0
- package/templates/current/examples/src/api/generated/types/system/users.types.ts +413 -0
- package/templates/current/examples/src/api/generated/types/tool/code-generator.types.ts +388 -0
- package/templates/current/examples/src/api/index.ts +44 -39
- package/templates/current/examples/src/app/__tests__/api-generated.types.ts +24 -0
- package/templates/current/examples/src/app/api.ts +6 -0
- package/templates/current/examples/src/app/authorization/permission.ts +9 -0
- package/templates/current/{clean/src/app → examples/src/app/config}/runtimeConfig.ts +44 -12
- package/templates/current/examples/src/app/errors/errorMessage.ts +80 -0
- package/templates/current/examples/src/app/http/client.ts +141 -0
- package/templates/current/examples/src/app/http/http-adapter.ts +71 -0
- package/templates/current/{clean/src/app → examples/src/app/i18n}/adminLocale.ts +25 -19
- package/templates/current/examples/src/app/{localeFormat.ts → i18n/localeFormat.ts} +29 -6
- package/templates/current/examples/src/app/i18n/origenUiLocale.ts +15 -0
- package/templates/current/examples/src/app/menu/menu.ts +175 -0
- package/templates/current/examples/src/app/menu/menuTypes.ts +20 -0
- package/templates/current/examples/src/{features → app}/security/devtoolsProtection.ts +8 -7
- package/templates/current/examples/src/app/ui/createAdminUi.ts +31 -0
- package/templates/current/examples/src/app/ui/iconCatalog.ts +71 -0
- package/templates/current/examples/src/assets/icons/appearance.svg +1 -0
- package/templates/current/examples/src/assets/icons/arrow-right.svg +1 -0
- package/templates/current/examples/src/assets/icons/check.svg +1 -0
- package/templates/current/examples/src/assets/icons/circle-check.svg +1 -0
- package/templates/current/examples/src/assets/icons/default.svg +4 -0
- package/templates/current/examples/src/assets/icons/directory/setting.svg +1 -0
- package/templates/current/examples/src/assets/icons/expand.svg +1 -0
- package/templates/current/examples/src/assets/icons/fold.svg +1 -0
- package/templates/current/examples/src/assets/icons/key.svg +1 -0
- package/templates/current/examples/src/assets/icons/lock.svg +1 -0
- package/templates/current/examples/src/assets/icons/monitor.svg +1 -0
- package/templates/current/examples/src/assets/icons/moon.svg +11 -0
- package/templates/current/examples/src/assets/icons/page/department.svg +1 -0
- package/templates/current/examples/src/assets/icons/page/dictionary.svg +1 -0
- package/templates/current/examples/src/assets/icons/page/menus.svg +1 -0
- package/templates/current/examples/src/assets/icons/page/user.svg +1 -0
- package/templates/current/examples/src/assets/icons/page/users.svg +1 -0
- package/templates/current/examples/src/assets/icons/plus.svg +1 -0
- package/templates/current/examples/src/assets/icons/profile.svg +1 -0
- package/templates/current/examples/src/assets/icons/refresh.svg +1 -0
- package/templates/current/examples/src/assets/icons/roles.svg +1 -0
- package/templates/current/examples/src/assets/icons/search.svg +1 -0
- package/templates/current/examples/src/assets/icons/sunny.svg +1 -0
- package/templates/current/examples/src/assets/icons/system.svg +1 -0
- package/templates/current/examples/src/assets/icons/theme-auto.svg +14 -0
- package/templates/current/examples/src/assets/icons/tune.svg +13 -0
- package/templates/current/examples/src/{features/shell/components → components}/RouteProgress.vue +2 -2
- package/templates/current/{clean/src/features/system/access → examples/src}/composables/useAuthorizationRefresh.ts +6 -1
- package/templates/current/examples/src/composables/useSystemTableSearchVisibility.ts +33 -0
- package/templates/current/examples/src/{features/appearance/composables → composables}/useTheme.ts +1 -1
- package/templates/current/examples/src/env.d.ts +6 -19
- package/templates/current/examples/src/layouts/AdminLayout.vue +7 -9
- package/templates/current/examples/src/{features/shell/components → layouts}/AdminWatermark.vue +2 -2
- package/templates/current/examples/src/layouts/BreadcrumbBar.vue +9 -1
- package/templates/current/examples/src/layouts/SideMenu.vue +7 -15
- package/templates/current/examples/src/{features/appearance/components → layouts}/ThemePanel.vue +39 -11
- package/templates/current/examples/src/layouts/TopBar.vue +60 -28
- package/templates/current/examples/src/layouts/WorkspaceTabs.vue +10 -1
- package/templates/current/examples/src/layouts/topBarMenuSearch.ts +25 -4
- package/templates/current/examples/src/locales/en-US.json +227 -219
- package/templates/current/examples/src/locales/index.ts +72 -32
- package/templates/current/examples/src/locales/messages-types.ts +15 -10
- package/templates/current/examples/src/locales/vue-i18n.d.ts +1 -1
- package/templates/current/examples/src/locales/zh-CN.json +226 -218
- package/templates/current/examples/src/locales/zh-TW.json +222 -214
- package/templates/current/examples/src/main.ts +50 -40
- package/templates/current/examples/src/router/bootstrap.ts +69 -24
- package/templates/current/examples/src/router/dynamic/componentLoader.ts +150 -0
- package/templates/current/examples/src/router/{dynamicMenuRefresh.ts → dynamic/dynamicMenuRefresh.ts} +6 -2
- package/templates/current/examples/src/router/dynamic/dynamicRoutes.ts +247 -0
- package/templates/current/examples/src/router/navigation/guards.ts +12 -0
- package/templates/current/examples/src/router/navigation/paths.ts +28 -0
- package/templates/current/examples/src/router/navigation/staticRoutes.ts +109 -0
- package/templates/current/examples/src/router/{queryEncryption.ts → query/queryEncryption.ts} +29 -12
- package/templates/current/examples/src/router/query/routeQuery.ts +29 -0
- package/templates/current/examples/src/router/{useRouteQueryDefaults.ts → query/useRouteQueryDefaults.ts} +9 -8
- package/templates/current/examples/src/router/query/useRouteQueryDefaults.types.ts +28 -0
- package/templates/current/examples/src/router/{runtimeErrorRecovery.ts → recovery/runtimeErrorRecovery.ts} +21 -3
- package/templates/current/examples/src/{features/auth/store → store}/auth.ts +96 -61
- package/templates/current/examples/src/store/dictionaries.ts +86 -0
- package/templates/current/examples/src/{features/shell/store → store}/sidebar.ts +9 -2
- package/templates/current/{clean/src/features/appearance → examples/src}/store/theme.ts +8 -4
- package/templates/current/examples/src/styles/layout.css +51 -0
- package/templates/current/examples/src/templates/og-form.ts +7 -2
- package/templates/current/examples/src/templates/og-table.ts +88 -20
- package/templates/current/examples/src/templates/router.ts +11 -2
- package/templates/current/examples/src/utils/color-mix.ts +6 -2
- package/templates/current/examples/src/utils/download.ts +11 -0
- package/templates/current/examples/src/utils/permissions.ts +1 -1
- package/templates/current/examples/src/utils/retryableDialog.ts +46 -0
- package/templates/current/{clean/scripts/clean-overlay/src/features → examples/src/views}/errors/pages/Forbidden.vue +6 -2
- package/templates/current/examples/src/views/errors/pages/MethodNotAllowed.vue +34 -0
- package/templates/current/examples/{scripts/clean-overlay/src/features → src/views}/errors/pages/NotFound.vue +6 -2
- package/templates/current/examples/{scripts/clean-overlay/src/features → src/views}/errors/pages/ServerError.vue +6 -2
- package/templates/current/examples/src/{features/auth/pages/Login.vue → views/login/pages/index.vue} +101 -11
- package/templates/current/examples/src/views/system/access/services/admin-repository.ts +489 -0
- package/templates/current/examples/src/views/system/access/services/rbac.ts +317 -0
- package/templates/current/examples/src/views/system/dept/components/DepartmentEditorForm.vue +87 -0
- package/templates/current/examples/src/views/system/dept/composables/useDepartmentManagement.ts +314 -0
- package/templates/current/examples/src/views/system/dept/pages/index.vue +44 -0
- package/templates/current/examples/src/views/system/dept/services/departments.ts +168 -0
- package/templates/current/examples/src/views/system/dict/components/DictionaryDataEditorForm.vue +98 -0
- package/templates/current/examples/src/views/system/dict/components/DictionaryDataPreview.vue +233 -0
- package/templates/current/examples/src/views/system/dict/components/DictionaryTypeEditorForm.vue +66 -0
- package/templates/current/examples/src/views/system/dict/composables/useDictionaryDataManagement.ts +406 -0
- package/templates/current/examples/src/views/system/dict/composables/useDictionaryTypeManagement.ts +329 -0
- package/templates/current/examples/src/views/system/dict/data/pages/index.vue +134 -0
- package/templates/current/examples/src/views/system/dict/pages/index.vue +113 -0
- package/templates/current/examples/src/views/system/dict/services/dictionaries.ts +239 -0
- package/templates/current/examples/src/views/system/menu/components/MenuEditorForm.vue +252 -0
- package/templates/current/examples/src/views/system/menu/composables/useMenuManagement.ts +357 -0
- package/templates/current/examples/src/views/system/menu/menuDraft.ts +45 -0
- package/templates/current/examples/src/views/system/menu/pages/ExternalLink.vue +37 -0
- package/templates/current/examples/src/views/system/menu/pages/index.vue +75 -0
- package/templates/current/examples/src/views/system/post/components/PostEditorForm.vue +69 -0
- package/templates/current/examples/src/views/system/post/composables/usePostManagement.ts +245 -0
- package/templates/current/examples/src/views/system/post/pages/index.vue +92 -0
- package/templates/current/examples/src/views/system/post/services/posts.ts +100 -0
- package/templates/current/examples/src/views/system/role/auth-users/pages/index.vue +100 -0
- package/templates/current/examples/src/views/system/role/components/RoleDataScopeForm.vue +167 -0
- package/templates/current/examples/src/views/system/role/components/RoleEditorForm.vue +165 -0
- package/templates/current/examples/src/views/system/role/components/RoleUserSelectForm.vue +129 -0
- package/templates/current/examples/src/views/system/role/composables/useRoleManagement.ts +422 -0
- package/templates/current/examples/src/views/system/role/composables/useRoleUserManagement.ts +233 -0
- package/templates/current/examples/src/views/system/role/pages/index.vue +110 -0
- package/templates/current/examples/src/views/system/role/services/roleAccess.ts +162 -0
- package/templates/current/examples/src/views/system/user/auth-roles/pages/index.vue +209 -0
- package/templates/current/examples/src/views/system/user/components/UserDetailsForm.vue +108 -0
- package/templates/current/examples/src/views/system/user/components/UserEditorForm.vue +207 -0
- package/templates/current/examples/src/views/system/user/components/UserImportDialog.vue +80 -0
- package/templates/current/examples/src/views/system/user/components/UserResetPasswordForm.vue +56 -0
- package/templates/current/examples/src/views/system/user/composables/useUserManagement.ts +502 -0
- package/templates/current/examples/src/views/system/user/pages/index.vue +459 -0
- package/templates/current/examples/tests/e2e/admin-access-business.spec.ts +33 -0
- package/templates/current/examples/tests/e2e/admin-shell.spec.ts +50 -0
- package/templates/current/examples/tests/e2e/fixtures/adminMockBackend.ts +95 -0
- package/templates/current/examples/tests/e2e/fixtures/labelGeometry.ts +52 -0
- package/templates/current/examples/tests/e2e/mock-api-generation.spec.ts +27 -0
- package/templates/current/examples/tests/e2e/mock-business.spec.ts +555 -0
- package/templates/current/examples/tests/e2e/mock-menu-retry-form-label.spec.ts +100 -0
- package/templates/current/examples/tests/e2e/mock-shell.spec.ts +25 -0
- package/templates/current/examples/tests/e2e/mock-tree-selection-layout.spec.ts +113 -0
- package/templates/current/examples/tests/unit/api/api-codegen.spec.ts +893 -0
- package/templates/current/examples/tests/unit/api/client.spec.ts +145 -0
- package/templates/current/examples/tests/unit/api/generated-http-client.spec.ts +290 -0
- package/templates/current/{clean/src → examples/tests/unit}/api/http-adapter.spec.ts +3 -3
- package/templates/current/examples/tests/unit/api/system-apis.spec.ts +118 -0
- package/templates/current/examples/tests/unit/app/createAdminUi.spec.ts +79 -0
- package/templates/current/examples/{src → tests/unit}/app/errorMessage.spec.ts +1 -1
- package/templates/current/examples/tests/unit/app/iconCatalog.spec.ts +12 -0
- package/templates/current/examples/tests/unit/app/menu.spec.ts +215 -0
- package/templates/current/{clean/src → examples/tests/unit}/app/origenUiLocale.spec.ts +1 -1
- package/templates/current/{clean/src → examples/tests/unit}/app/permission.spec.ts +4 -5
- package/templates/current/examples/tests/unit/app/runtimeConfig.spec.ts +36 -0
- package/templates/current/{clean/src/features → examples/tests/unit/app}/security/devtoolsProtection.spec.ts +17 -7
- package/templates/current/{clean/src/features/shell → examples/tests/unit}/composables/useRouteProgress.spec.ts +1 -1
- package/templates/current/{clean/src/features/shell/components → examples/tests/unit/layouts}/AdminWatermark.spec.ts +5 -7
- package/templates/current/{clean/src → examples/tests/unit}/layouts/topBarMenuSearch.spec.ts +25 -8
- package/templates/current/examples/{src → tests/unit}/locales/messages.spec.ts +43 -17
- package/templates/current/examples/tests/unit/router/dynamicMenuRefresh.spec.ts +151 -0
- package/templates/current/examples/tests/unit/router/dynamicRoutes.spec.ts +374 -0
- package/templates/current/examples/tests/unit/router/paths.spec.ts +103 -0
- package/templates/current/examples/{src → tests/unit}/router/queryEncryption.spec.ts +56 -10
- package/templates/current/examples/tests/unit/router/routeQuery.spec.ts +19 -0
- package/templates/current/examples/{src → tests/unit}/router/runtimeErrorRecovery.spec.ts +11 -6
- package/templates/current/{clean/src → examples/tests/unit}/router/useRouteQueryDefaults.spec.ts +46 -12
- package/templates/current/examples/tests/unit/scripts/mock-api.spec.ts +440 -0
- package/templates/current/examples/{scripts → tests/unit/scripts}/vite-build-policy.spec.ts +35 -6
- package/templates/current/examples/{src/features/auth → tests/unit}/store/auth.spec.ts +68 -15
- package/templates/current/examples/tests/unit/store/dictionaries.spec.ts +106 -0
- package/templates/current/{clean/src → examples/tests/unit}/templates/templates.spec.ts +60 -16
- package/templates/current/examples/{src/utils/__tests__ → tests/unit/utils}/color-mix.spec.ts +1 -1
- package/templates/current/examples/tests/unit/utils/retryableDialog.spec.ts +61 -0
- package/templates/current/examples/{scripts/clean-overlay/src/features/errors/pages → tests/unit/views/errors}/error-pages.spec.ts +12 -9
- package/templates/current/examples/tests/unit/views/feature-composables.spec.ts +233 -0
- package/templates/current/examples/tests/unit/views/system/access/admin-repository.spec.ts +353 -0
- package/templates/current/examples/tests/unit/views/system/access/rbac.spec.ts +329 -0
- package/templates/current/examples/tests/unit/views/system/dept/departments.spec.ts +104 -0
- package/templates/current/examples/tests/unit/views/system/dict/dictionaries.spec.ts +234 -0
- package/templates/current/examples/tests/unit/views/system/menu/menuDraft.spec.ts +77 -0
- package/templates/current/examples/tests/unit/views/system/menu/useMenuManagement.spec.ts +339 -0
- package/templates/current/examples/tests/unit/views/system/user/searchControl.spec.ts +128 -0
- package/templates/current/examples/tsconfig.json +4 -19
- package/templates/current/examples/vite.build-policy.ts +97 -22
- package/templates/current/examples/vite.config.ts +50 -7
- package/templates/current/clean/.codebuddy/AGENTS.md +0 -18
- package/templates/current/clean/.codex/skills/build-admin-feature/SKILL.md +0 -14
- package/templates/current/clean/.codex/skills/build-admin-feature/references/component-selection.md +0 -25
- package/templates/current/clean/.codex/skills/use-og-table/SKILL.md +0 -16
- package/templates/current/clean/.cursor/AGENTS.md +0 -18
- package/templates/current/clean/.env.production.example +0 -31
- package/templates/current/clean/.qoder/AGENTS.md +0 -15
- package/templates/current/clean/e2e/admin-shell.spec.ts +0 -156
- package/templates/current/clean/e2e/demo-shell.spec.ts +0 -372
- package/templates/current/clean/playwright.demo.config.ts +0 -25
- package/templates/current/clean/scripts/clean-overlay/src/features/errors/pages/NotFound.vue +0 -31
- package/templates/current/clean/scripts/clean-overlay/src/features/errors/pages/ServerError.vue +0 -31
- package/templates/current/clean/scripts/clean-overlay/src/features/errors/pages/error-pages.spec.ts +0 -41
- package/templates/current/clean/scripts/clean-overlay/src/main.ts +0 -100
- package/templates/current/clean/scripts/clean-overlay/src/router/componentCache.ts +0 -12
- package/templates/current/clean/scripts/clean-overlay/src/router/componentRegistry.ts +0 -14
- package/templates/current/clean/scripts/clean-overlay/src/router/dynamicRoutes.spec.ts +0 -77
- package/templates/current/clean/scripts/clean-overlay/src/router/paths.ts +0 -21
- package/templates/current/clean/scripts/clean-overlay/src/router/staticRoutes.ts +0 -63
- package/templates/current/clean/scripts/demo-api.ts +0 -873
- package/templates/current/clean/src/api/client.spec.ts +0 -66
- package/templates/current/clean/src/api/client.ts +0 -152
- package/templates/current/clean/src/api/generated//347/263/273/347/273/237/347/256/241/347/220/206/345/206/205/345/256/271/346/226/207/347/253/240.ts +0 -144
- package/templates/current/clean/src/api/generated//347/263/273/347/273/237/347/256/241/347/220/206/345/256/241/350/256/241.ts +0 -50
- package/templates/current/clean/src/api/generated//347/263/273/347/273/237/347/256/241/347/220/206/346/226/207/344/273/266/344/270/212/344/274/240.ts +0 -63
- package/templates/current/clean/src/api/generated//347/263/273/347/273/237/347/256/241/347/220/206/347/224/250/346/210/267.ts +0 -169
- package/templates/current/clean/src/api/generated//347/263/273/347/273/237/347/256/241/347/220/206/350/217/234/345/215/225.ts +0 -180
- package/templates/current/clean/src/api/generated//347/263/273/347/273/237/347/256/241/347/220/206/350/247/222/350/211/262.ts +0 -167
- package/templates/current/clean/src/api/generated//347/263/273/347/273/237/347/256/241/347/220/206/350/256/242/345/215/225/350/215/211/347/250/277.ts +0 -168
- package/templates/current/clean/src/api/generated//350/256/244/350/257/201.ts +0 -95
- package/templates/current/clean/src/api/http-adapter.ts +0 -83
- package/templates/current/clean/src/app/createAdminUi.spec.ts +0 -166
- package/templates/current/clean/src/app/createAdminUi.ts +0 -63
- package/templates/current/clean/src/app/embedded-token.spec.ts +0 -40
- package/templates/current/clean/src/app/embedded.spec.ts +0 -135
- package/templates/current/clean/src/app/embedded.ts +0 -255
- package/templates/current/clean/src/app/errorMessage.ts +0 -53
- package/templates/current/clean/src/app/menu-host.spec.ts +0 -77
- package/templates/current/clean/src/app/menu.spec.ts +0 -320
- package/templates/current/clean/src/app/menu.ts +0 -308
- package/templates/current/clean/src/app/menuTypes.ts +0 -18
- package/templates/current/clean/src/app/origenUiLocale.ts +0 -10
- package/templates/current/clean/src/app/permission.ts +0 -9
- package/templates/current/clean/src/demo-api.spec.ts +0 -478
- package/templates/current/clean/src/features/errors/pages/error-pages.spec.ts +0 -41
- package/templates/current/clean/src/features/system/access/api/admin-repository.spec.ts +0 -14
- package/templates/current/clean/src/features/system/access/api/admin-repository.ts +0 -298
- package/templates/current/clean/src/features/system/access/api/rbac.spec.ts +0 -72
- package/templates/current/clean/src/features/system/access/api/rbac.ts +0 -292
- package/templates/current/clean/src/features/system/access/composables/useAuthorizationPolling.spec.ts +0 -134
- package/templates/current/clean/src/features/system/access/composables/useAuthorizationPolling.ts +0 -96
- package/templates/current/clean/src/features/workspace/pages/Profile.vue +0 -185
- package/templates/current/clean/src/router/componentCache.ts +0 -12
- package/templates/current/clean/src/router/componentRegistry.ts +0 -14
- package/templates/current/clean/src/router/dynamicMenuRefresh.spec.ts +0 -101
- package/templates/current/clean/src/router/dynamicRoutes.spec.ts +0 -77
- package/templates/current/clean/src/router/dynamicRoutes.ts +0 -177
- package/templates/current/clean/src/router/guards.ts +0 -5
- package/templates/current/clean/src/router/paths.spec.ts +0 -50
- package/templates/current/clean/src/router/paths.ts +0 -21
- package/templates/current/clean/src/router/routeQuery.spec.ts +0 -11
- package/templates/current/clean/src/router/routeQuery.ts +0 -3
- package/templates/current/clean/src/router/staticRoutes.ts +0 -63
- package/templates/current/clean/src/router/useRouteQueryDefaults.types.ts +0 -20
- package/templates/current/examples/.codebuddy/AGENTS.md +0 -18
- package/templates/current/examples/.codex/skills/build-admin-feature/SKILL.md +0 -14
- package/templates/current/examples/.codex/skills/build-admin-feature/references/component-selection.md +0 -25
- package/templates/current/examples/.codex/skills/use-og-table/SKILL.md +0 -16
- package/templates/current/examples/.cursor/AGENTS.md +0 -18
- package/templates/current/examples/.env.production.example +0 -31
- package/templates/current/examples/.qoder/AGENTS.md +0 -15
- package/templates/current/examples/e2e/admin-shell.spec.ts +0 -156
- package/templates/current/examples/e2e/demo-shell.spec.ts +0 -372
- package/templates/current/examples/playwright.demo.config.ts +0 -25
- package/templates/current/examples/scripts/clean-overlay/src/features/errors/pages/Forbidden.vue +0 -31
- package/templates/current/examples/scripts/clean-overlay/src/main.ts +0 -100
- package/templates/current/examples/scripts/clean-overlay/src/router/componentCache.ts +0 -12
- package/templates/current/examples/scripts/clean-overlay/src/router/componentRegistry.ts +0 -14
- package/templates/current/examples/scripts/clean-overlay/src/router/dynamicRoutes.spec.ts +0 -77
- package/templates/current/examples/scripts/clean-overlay/src/router/paths.ts +0 -21
- package/templates/current/examples/scripts/clean-overlay/src/router/staticRoutes.ts +0 -63
- package/templates/current/examples/scripts/demo-api.ts +0 -873
- package/templates/current/examples/src/api/client.spec.ts +0 -66
- package/templates/current/examples/src/api/client.ts +0 -152
- package/templates/current/examples/src/api/generated//347/263/273/347/273/237/347/256/241/347/220/206/345/206/205/345/256/271/346/226/207/347/253/240.ts +0 -144
- package/templates/current/examples/src/api/generated//347/263/273/347/273/237/347/256/241/347/220/206/345/256/241/350/256/241.ts +0 -50
- package/templates/current/examples/src/api/generated//347/263/273/347/273/237/347/256/241/347/220/206/346/226/207/344/273/266/344/270/212/344/274/240.ts +0 -63
- package/templates/current/examples/src/api/generated//347/263/273/347/273/237/347/256/241/347/220/206/347/224/250/346/210/267.ts +0 -169
- package/templates/current/examples/src/api/generated//347/263/273/347/273/237/347/256/241/347/220/206/350/217/234/345/215/225.ts +0 -180
- package/templates/current/examples/src/api/generated//347/263/273/347/273/237/347/256/241/347/220/206/350/247/222/350/211/262.ts +0 -167
- package/templates/current/examples/src/api/generated//347/263/273/347/273/237/347/256/241/347/220/206/350/256/242/345/215/225/350/215/211/347/250/277.ts +0 -168
- package/templates/current/examples/src/api/generated//350/256/244/350/257/201.ts +0 -95
- package/templates/current/examples/src/api/http-adapter.ts +0 -83
- package/templates/current/examples/src/app/createAdminUi.spec.ts +0 -166
- package/templates/current/examples/src/app/createAdminUi.ts +0 -63
- package/templates/current/examples/src/app/embedded-token.spec.ts +0 -40
- package/templates/current/examples/src/app/embedded.spec.ts +0 -135
- package/templates/current/examples/src/app/embedded.ts +0 -255
- package/templates/current/examples/src/app/errorMessage.ts +0 -53
- package/templates/current/examples/src/app/menu-host.spec.ts +0 -77
- package/templates/current/examples/src/app/menu.spec.ts +0 -320
- package/templates/current/examples/src/app/menu.ts +0 -308
- package/templates/current/examples/src/app/menuTypes.ts +0 -18
- package/templates/current/examples/src/app/origenUiLocale.ts +0 -10
- package/templates/current/examples/src/app/permission.ts +0 -9
- package/templates/current/examples/src/demo-api.spec.ts +0 -478
- package/templates/current/examples/src/features/errors/pages/Forbidden.vue +0 -31
- package/templates/current/examples/src/features/errors/pages/NotFound.vue +0 -31
- package/templates/current/examples/src/features/errors/pages/ServerError.vue +0 -31
- package/templates/current/examples/src/features/feature-composables.spec.ts +0 -245
- package/templates/current/examples/src/features/system/access/api/admin-repository.spec.ts +0 -14
- package/templates/current/examples/src/features/system/access/api/admin-repository.ts +0 -298
- package/templates/current/examples/src/features/system/access/api/rbac.spec.ts +0 -72
- package/templates/current/examples/src/features/system/access/api/rbac.ts +0 -292
- package/templates/current/examples/src/features/system/access/composables/useAuthorizationPolling.spec.ts +0 -134
- package/templates/current/examples/src/features/system/access/composables/useAuthorizationPolling.ts +0 -96
- package/templates/current/examples/src/features/system/audit/composables/useAuditManagement.ts +0 -122
- package/templates/current/examples/src/features/system/audit/pages/AuditList.vue +0 -20
- package/templates/current/examples/src/features/system/menus/components/MenuEditorForm.vue +0 -279
- package/templates/current/examples/src/features/system/menus/composables/useMenuManagement.ts +0 -435
- package/templates/current/examples/src/features/system/menus/menuDraft.spec.ts +0 -204
- package/templates/current/examples/src/features/system/menus/menuDraft.ts +0 -116
- package/templates/current/examples/src/features/system/menus/menuTreePrecheck.spec.ts +0 -268
- package/templates/current/examples/src/features/system/menus/menuTreePrecheck.ts +0 -317
- package/templates/current/examples/src/features/system/menus/pages/MenuList.vue +0 -51
- package/templates/current/examples/src/features/system/roles/components/RoleEditorForm.vue +0 -116
- package/templates/current/examples/src/features/system/roles/composables/useRoleManagement.ts +0 -194
- package/templates/current/examples/src/features/system/roles/pages/RoleList.vue +0 -47
- package/templates/current/examples/src/features/system/users/components/UserEditorForm.vue +0 -104
- package/templates/current/examples/src/features/system/users/composables/useUserManagement.ts +0 -228
- package/templates/current/examples/src/features/system/users/pages/UserList.vue +0 -51
- package/templates/current/examples/src/features/workspace/pages/Dashboard.spec.ts +0 -41
- package/templates/current/examples/src/features/workspace/pages/Dashboard.vue +0 -325
- package/templates/current/examples/src/features/workspace/pages/Profile.vue +0 -185
- package/templates/current/examples/src/router/componentCache.ts +0 -18
- package/templates/current/examples/src/router/componentRegistry.ts +0 -66
- package/templates/current/examples/src/router/dynamicMenuRefresh.spec.ts +0 -101
- package/templates/current/examples/src/router/dynamicRoutes.spec.ts +0 -144
- package/templates/current/examples/src/router/dynamicRoutes.ts +0 -177
- package/templates/current/examples/src/router/guards.ts +0 -5
- package/templates/current/examples/src/router/paths.spec.ts +0 -50
- package/templates/current/examples/src/router/paths.ts +0 -21
- package/templates/current/examples/src/router/routeQuery.spec.ts +0 -11
- package/templates/current/examples/src/router/routeQuery.ts +0 -3
- package/templates/current/examples/src/router/staticRoutes.ts +0 -63
- package/templates/current/examples/src/router/useRouteQueryDefaults.types.ts +0 -20
- /package/templates/current/clean/{.codex → .agents}/skills/style-og-origen-ui/SKILL.md +0 -0
- /package/templates/current/clean/{.codex → .agents}/skills/style-og-origen-ui/agents/openai.yaml +0 -0
- /package/templates/current/clean/{.codex → .agents}/skills/use-og-dialog/SKILL.md +0 -0
- /package/templates/current/clean/{.codex → .agents}/skills/use-og-dialog/agents/openai.yaml +0 -0
- /package/templates/current/clean/{.codex → .agents}/skills/use-og-editor/SKILL.md +0 -0
- /package/templates/current/clean/{.codex → .agents}/skills/use-og-http/SKILL.md +0 -0
- /package/templates/current/clean/{.codex → .agents}/skills/use-og-http/agents/openai.yaml +0 -0
- /package/templates/current/clean/{.codex → .agents}/skills/use-og-router-tabs/SKILL.md +0 -0
- /package/templates/current/{examples/.codex → clean/.claude}/skills/style-og-origen-ui/SKILL.md +0 -0
- /package/templates/current/{examples/.codex → clean/.claude}/skills/use-og-dialog/SKILL.md +0 -0
- /package/templates/current/{examples/.codex → clean/.claude}/skills/use-og-editor/SKILL.md +0 -0
- /package/templates/current/{examples/.codex → clean/.claude}/skills/use-og-http/SKILL.md +0 -0
- /package/templates/current/{examples/.codex → clean/.claude}/skills/use-og-router-tabs/SKILL.md +0 -0
- /package/templates/current/clean/src/{features/security/components → components}/DevtoolsProtectionOverlay.vue +0 -0
- /package/templates/current/clean/src/{features/shell/composables → composables}/useRouteProgress.ts +0 -0
- /package/templates/current/clean/src/{features/workspace → views/fallback}/pages/Empty.vue +0 -0
- /package/templates/current/examples/{.codex → .agents}/skills/style-og-origen-ui/agents/openai.yaml +0 -0
- /package/templates/current/examples/{.codex → .agents}/skills/use-og-dialog/agents/openai.yaml +0 -0
- /package/templates/current/examples/{.codex → .agents}/skills/use-og-http/agents/openai.yaml +0 -0
- /package/templates/current/examples/src/{features/security/components → components}/DevtoolsProtectionOverlay.vue +0 -0
- /package/templates/current/examples/src/{features/shell/composables → composables}/useRouteProgress.ts +0 -0
- /package/templates/current/examples/src/{features/workspace → views/fallback}/pages/Empty.vue +0 -0
|
@@ -0,0 +1,750 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: OgForm
|
|
3
|
+
description: 覆盖联动、校验、异步选项与动态字段的 Schema 表单。
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# OgForm
|
|
7
|
+
|
|
8
|
+
根入口组件为 `OgForm`,其完整 Props 类型为 `OgFormProps`。
|
|
9
|
+
|
|
10
|
+
基于 Element Plus 的 Schema 表单。字段定义、联动、校验、布局、只读展示与动态操作都收敛到同一份字段状态中。
|
|
11
|
+
|
|
12
|
+
## 何时使用
|
|
13
|
+
|
|
14
|
+
- 编辑页需要由字段 Schema 驱动,且要统一布局、控件与校验。
|
|
15
|
+
- 字段之间存在显示、禁用、计算值或异步选项依赖。
|
|
16
|
+
- 需要通过实例 API 管理提交、重置、动态字段或选项刷新。
|
|
17
|
+
|
|
18
|
+
## 基础用法
|
|
19
|
+
|
|
20
|
+
`v-model` 同步整份表单模型;字段的 `prop` 与模型字段一一对应。先从最小表单验证双向绑定与校验,再叠加复杂 Schema。
|
|
21
|
+
|
|
22
|
+
```vue
|
|
23
|
+
<script setup lang="ts">
|
|
24
|
+
import type { FormField } from '@origen-ui/form'
|
|
25
|
+
import { OgForm } from '@origen-ui/form'
|
|
26
|
+
import { ref } from 'vue'
|
|
27
|
+
|
|
28
|
+
interface UserForm {
|
|
29
|
+
name: string
|
|
30
|
+
age: number | undefined
|
|
31
|
+
role: string
|
|
32
|
+
}
|
|
33
|
+
|
|
34
|
+
const model = ref<UserForm>({ name: '', age: undefined, role: '' })
|
|
35
|
+
const fields: FormField<UserForm>[] = [
|
|
36
|
+
{ prop: 'name', label: '姓名', required: true, ogControl: { ogType: 'input' } },
|
|
37
|
+
{ prop: 'age', label: '年龄', ogControl: { ogType: 'number', min: 0 } },
|
|
38
|
+
{
|
|
39
|
+
prop: 'role',
|
|
40
|
+
label: '角色',
|
|
41
|
+
options: [{ label: '管理员', value: 'admin' }],
|
|
42
|
+
ogControl: { ogType: 'select' },
|
|
43
|
+
},
|
|
44
|
+
]
|
|
45
|
+
</script>
|
|
46
|
+
|
|
47
|
+
<template>
|
|
48
|
+
<OgForm v-model="model" :og-schema="{ sections: [{ fields }] }" :og-columns="2" />
|
|
49
|
+
</template>
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
<div id="form-basic"></div>
|
|
53
|
+
### 基础表单
|
|
54
|
+
|
|
55
|
+
从空模型启动,填写、校验并重置;切换只读、禁用、隐藏和动态字段,比较编辑模型与实际提交投影。
|
|
56
|
+
|
|
57
|
+
## 典型用法
|
|
58
|
+
|
|
59
|
+
<div id="form-reset-commands"></div>
|
|
60
|
+
<div id="form-reset-modes"></div>
|
|
61
|
+
<div id="form-command-api"></div>
|
|
62
|
+
### 重置与命令 API
|
|
63
|
+
|
|
64
|
+
合并 keepDefault、clear 重置模式和 validate、setFields、refreshOptions 命令。
|
|
65
|
+
|
|
66
|
+
<div id="form-field-layout"></div>
|
|
67
|
+
<div id="form-all-fields"></div>
|
|
68
|
+
<div id="form-groups-grid"></div>
|
|
69
|
+
<div id="form-responsive-layout"></div>
|
|
70
|
+
### 字段类型、分组与响应式布局
|
|
71
|
+
|
|
72
|
+
合并内置字段、sections、span、columns 与响应式提交导航。
|
|
73
|
+
|
|
74
|
+
## 高级能力
|
|
75
|
+
|
|
76
|
+
<div id="form-linkage-options"></div>
|
|
77
|
+
<div id="form-linkage"></div>
|
|
78
|
+
<div id="form-async-options"></div>
|
|
79
|
+
<div id="form-options-retry"></div>
|
|
80
|
+
### 联动、异步选项与错误重试
|
|
81
|
+
|
|
82
|
+
合并联动计算、异步选项取消和选项失败重试,观察依赖变化后的状态恢复。
|
|
83
|
+
|
|
84
|
+
<div id="form-permissions"></div>
|
|
85
|
+
### 字段权限
|
|
86
|
+
|
|
87
|
+
切换角色,观察字段隐藏、只读、可编辑和提交投影的权限边界。
|
|
88
|
+
|
|
89
|
+
<div id="form-custom-readonly"></div>
|
|
90
|
+
<div id="form-slots-render"></div>
|
|
91
|
+
<div id="form-readonly"></div>
|
|
92
|
+
<div id="form-renderer"></div>
|
|
93
|
+
### 插槽、render、只读与 Renderer
|
|
94
|
+
|
|
95
|
+
合并字段插槽、render、只读展示和实例级 renderer 注册。
|
|
96
|
+
|
|
97
|
+
<div id="form-rich-upload"></div>
|
|
98
|
+
<div id="form-rich-text"></div>
|
|
99
|
+
<div id="form-editor-upload"></div>
|
|
100
|
+
### 富文本与上传组合
|
|
101
|
+
|
|
102
|
+
合并富文本字段和编辑器上传组合,观察统一提交模型与只读投影。
|
|
103
|
+
|
|
104
|
+
<div id="form-local-file"></div>
|
|
105
|
+
### 本地文件状态
|
|
106
|
+
|
|
107
|
+
选择文件并观察 fileList 模型,不发送网络请求。
|
|
108
|
+
|
|
109
|
+
<div id="form-validation"></div>
|
|
110
|
+
### 校验规则
|
|
111
|
+
|
|
112
|
+
覆盖必填、同步与异步规则、条件必填和跨字段依赖。
|
|
113
|
+
|
|
114
|
+
<div id="form-dynamic-schema"></div>
|
|
115
|
+
### 动态 Schema
|
|
116
|
+
|
|
117
|
+
动态新增和移除字段,并读取当前字段定义。
|
|
118
|
+
|
|
119
|
+
## API
|
|
120
|
+
|
|
121
|
+
## 模型与提交契约
|
|
122
|
+
|
|
123
|
+
业务模型直接声明为 `interface` 或无索引签名的 `type`,不要 `extends Record<string, unknown>`。这样 `FormField<T>`、`setFieldValue` 和动态字段 API 才能保留字段名和值的类型校验。
|
|
124
|
+
|
|
125
|
+
`OgForm<TModel, TSubmit>` 支持将编辑模型与提交模型分离。`getModel()` 返回可见字段的 `Partial<TModel>`;`getSubmitModel()` 先移除不可见字段、拆分日期/时间范围字段,再将标准化后的 `Record<string, unknown>` 交给 `modelTransform`,其返回值即 `TSubmit`。
|
|
126
|
+
|
|
127
|
+
```ts
|
|
128
|
+
import type { OgFormExpose, OgFormProps } from '@origen-ui/form'
|
|
129
|
+
import { useTemplateRef } from 'vue'
|
|
130
|
+
|
|
131
|
+
interface UserSubmit {
|
|
132
|
+
name: string
|
|
133
|
+
startedAt: string
|
|
134
|
+
endedAt: string
|
|
135
|
+
}
|
|
136
|
+
|
|
137
|
+
const formRef = useTemplateRef<OgFormExpose<UserForm, UserSubmit>>('formRef')
|
|
138
|
+
|
|
139
|
+
const instanceProps: OgFormProps<UserForm, UserSubmit> = {
|
|
140
|
+
ogModelTransform: (model) => ({
|
|
141
|
+
name: String(model.name ?? ''),
|
|
142
|
+
startedAt: String(model.startedAt ?? ''),
|
|
143
|
+
endedAt: String(model.endedAt ?? ''),
|
|
144
|
+
}),
|
|
145
|
+
}
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
### `ogControl` 控件配置
|
|
149
|
+
|
|
150
|
+
字段以 `ogControl: { ogType }` 选择内置控件,并把该控件的官方属性直接放在同一对象中,例如 `ogControl: { ogType: 'number', min: 0 }`。字段语义配置(校验、选项、联动、权限和布局)仍在字段层;模型值、更新事件、只读/禁用、选项和上传状态由 OgForm 管理,不能通过控件属性覆盖。Element Plus `format` 等原生属性沿用官方名称;模型值投影等 Og 业务选项使用 `og` 前缀,例如 `ogValueFormat`。
|
|
151
|
+
|
|
152
|
+
没有设置控件 `placeholder` 时,支持占位提示的内置控件会按当前 `ogLocale.placeholder` 自动显示类型默认文案;上传按钮使用 `ogLocale.upload`,也可通过 `ogControl.ogText` 覆盖。显式空字符串会保留为空。日期/时间的 `ogValueFormat` 支持函数形式,但函数只用于提交值与只读文本格式化,不会透传给 Element Plus 编辑控件。
|
|
153
|
+
|
|
154
|
+
`ogControl` 中的 Element Plus 属性按 `ogType` 对应的实际控件进行静态类型校验;`ogEvents` 是该控件的类型化事件回调入口,并与受控更新逻辑合并。Checkbox 会根据是否配置选项渲染单选框或分组,因此其官方属性和事件类型覆盖两个分支;TreeSelect 的官方边界覆盖 Select 与 Tree 属性以及 `cacheData`。上传字段遵循 OgUpload 的 adapter 边界:可用的官方属性仍使用官方名称,选择阶段回调放在 `ogUploadEvents`;传输、移除、预览和超限流程由 OgUpload 管理。模型、禁用/只读、尺寸、占位文案和加载状态等受控属性仍由 OgForm 最终写入。编辑器字段内部控件设置使用 `ogToolbar`、`ogLinkDialog`、`ogMediaDialog` 等目标配置,复用 `@origen-ui/editor` 的类型;`custom` renderer 由其注册实现定义自身属性。官方属性与事件详情参考 Element Plus 官方文档。
|
|
155
|
+
|
|
156
|
+
`ogControl.ogSlots` 将 Element Plus 插槽转发给对应内置字段,插槽名与作用域参数按控件类型静态校验。Select、Radio 和带选项的 Checkbox 未提供 `default` 插槽时继续从字段 `options` 渲染选项;显式提供后由该插槽接管内容。Element Plus Tree Select 的 `default` 插槽用于自定义树节点内容,作用域参数遵循 Element Plus Tree;Tree Select 仍负责树数据与缓存选项。`upload`、`editor` 和 `custom` 不是直接的 Element Plus 字段控件,不接受 `ogSlots`。官方插槽详情参考 Element Plus 官方文档。
|
|
157
|
+
|
|
158
|
+
### 组件 locale
|
|
159
|
+
|
|
160
|
+
组件文案默认使用简体中文,无需接入业务 `vue-i18n`。使用 `locale` 可局部覆盖文案,也可直接使用 `OG_FORM_LOCALE_EN_US`:
|
|
161
|
+
|
|
162
|
+
```vue
|
|
163
|
+
<OgForm
|
|
164
|
+
v-model="model"
|
|
165
|
+
:og-schema="{ sections: [{ fields }] }"
|
|
166
|
+
:og-locale="{ retry: 'Retry', emptyValue: 'No value' }"
|
|
167
|
+
/>
|
|
168
|
+
```
|
|
169
|
+
|
|
170
|
+
```ts
|
|
171
|
+
import { OG_FORM_LOCALE_EN_US } from '@origen-ui/form'
|
|
172
|
+
```
|
|
173
|
+
|
|
174
|
+
通用只读 password 默认显示 `******`,可以通过 `locale.passwordMask` 覆盖。需要在只读态主动显示明文时,请提供 `readonlySlot` 或 `readonlyRender`。
|
|
175
|
+
|
|
176
|
+
## Label 说明
|
|
177
|
+
|
|
178
|
+
`FormField.labelTip` 与 `OgFormItem.labelTip` 支持两种静态说明。字符串默认显示为 label 后的问号 Tooltip;对象设置 `mode: 'inline'` 时,说明常驻在控件下方、校验错误上方。inline 说明的稳定 ID 会与错误 ID 一起写入控件的 `aria-describedby`。
|
|
179
|
+
|
|
180
|
+
```ts
|
|
181
|
+
const fields: FormField<UserForm>[] = [
|
|
182
|
+
{ prop: 'name', label: '姓名', labelTip: '请与证件姓名保持一致' },
|
|
183
|
+
{
|
|
184
|
+
prop: 'department',
|
|
185
|
+
label: '部门',
|
|
186
|
+
labelTip: { content: '部门决定审批流程与数据权限', mode: 'inline' },
|
|
187
|
+
},
|
|
188
|
+
]
|
|
189
|
+
```
|
|
190
|
+
|
|
191
|
+
`placement`、`maxWidth` 仅影响 Tooltip 模式。上传字段原有的 `tip` 仍用于上传控件说明,与 `labelTip` 相互独立;只读、renderer 与自定义 slot 路径使用同一套 label 说明配置。
|
|
192
|
+
|
|
193
|
+
## 空值、默认值与重置
|
|
194
|
+
|
|
195
|
+
`defaultValue` 决定初始化优先级。`reset()` 恢复当前编辑基线;`clearFields('default')` 恢复声明默认值,`clearFields('empty')` 回到控件对应的空值。异步加载数据时,通过变更 `ogBaselineKey` 接受这份数据为新的编辑基线。
|
|
196
|
+
|
|
197
|
+
| 字段场景 | `clear` 空值 |
|
|
198
|
+
| ------------------------------- | ------------ |
|
|
199
|
+
| 多选、区间、级联、标签 | `[]` |
|
|
200
|
+
| `upload` 的 `urls` / `fileList` | `[]` |
|
|
201
|
+
| `upload` 的 `url` | `''` |
|
|
202
|
+
| switch、单 checkbox | `false` |
|
|
203
|
+
| number | `undefined` |
|
|
204
|
+
| 其他基础输入 | `''` |
|
|
205
|
+
|
|
206
|
+
## 联动、计算与异步选项
|
|
207
|
+
|
|
208
|
+
`dependencies` 是唯一的依赖声明,用于计算排序和异步选项刷新。组件会中止字段替换、移除或依赖变化后的过期请求;被中止请求不会把旧选项写回字段。`optionsApi` 应接收并传递 `AbortSignal`,不要在 Demo 或业务层用旧响应手动覆盖 `field.options`。
|
|
209
|
+
|
|
210
|
+
## 字段权限
|
|
211
|
+
|
|
212
|
+
通过 `permissions.has` 把业务侧权限判断传入表单。字段 `permission` 可只声明查看权限,或分别声明 `view` 与 `edit`:无查看权限的字段不会渲染、校验、提交或请求异步选项;无编辑权限的字段进入只读展示并保留提交值。
|
|
213
|
+
|
|
214
|
+
```ts
|
|
215
|
+
const fields: FormField<Employee>[] = [
|
|
216
|
+
{
|
|
217
|
+
prop: 'salary',
|
|
218
|
+
label: '薪资',
|
|
219
|
+
permission: { view: 'employee:salary:view', edit: 'employee:salary:edit' },
|
|
220
|
+
},
|
|
221
|
+
]
|
|
222
|
+
|
|
223
|
+
const permissions = {
|
|
224
|
+
has: (permission: Permission) => permissionService.has(permission),
|
|
225
|
+
}
|
|
226
|
+
```
|
|
227
|
+
|
|
228
|
+
权限数组的组合语义由业务侧 `has()` 决定。权限仅约束前端展示与提交模型,服务端仍必须执行最终鉴权。
|
|
229
|
+
|
|
230
|
+
## 分组、插槽与只读展示
|
|
231
|
+
|
|
232
|
+
分组布局可单独覆盖栅格。字段可用 `slot` / `readonlySlot`、`render` / `readonlyRender` 定制展示,写值时应使用作用域参数 `setValue` 保留完整联动流程。
|
|
233
|
+
|
|
234
|
+
详情需要标签或强调文本时,可在 `readonlyRender` 返回 Element Plus 组件,并直接设置组件属性。普通格式化、空值文案和复制按钮仍使用 `readonlyDisplay`;自定义 renderer/slot 接管完整展示内容,不会自动附带该复制按钮。
|
|
235
|
+
|
|
236
|
+
```ts
|
|
237
|
+
import type { FormField } from '@origen-ui/form'
|
|
238
|
+
import { ElTag, ElText } from 'element-plus'
|
|
239
|
+
import { h } from 'vue'
|
|
240
|
+
|
|
241
|
+
interface AccountDetail {
|
|
242
|
+
status: 'active' | 'inactive'
|
|
243
|
+
score: number
|
|
244
|
+
}
|
|
245
|
+
|
|
246
|
+
const fields: FormField<AccountDetail>[] = [
|
|
247
|
+
{
|
|
248
|
+
prop: 'status',
|
|
249
|
+
label: '状态',
|
|
250
|
+
ogControl: { ogType: 'select' },
|
|
251
|
+
options: [
|
|
252
|
+
{ label: '启用', value: 'active' },
|
|
253
|
+
{ label: '停用', value: 'inactive' },
|
|
254
|
+
],
|
|
255
|
+
readonlyRender: (_model, { value }) =>
|
|
256
|
+
h(ElTag, { type: value === 'active' ? 'success' : 'info' }, () =>
|
|
257
|
+
value === 'active' ? '启用' : '停用',
|
|
258
|
+
),
|
|
259
|
+
},
|
|
260
|
+
{
|
|
261
|
+
prop: 'score',
|
|
262
|
+
label: '信用分',
|
|
263
|
+
ogControl: { ogType: 'number' },
|
|
264
|
+
readonlyRender: (_model, { value }) => h(ElText, { type: 'primary' }, () => `信用分:${value}`),
|
|
265
|
+
},
|
|
266
|
+
]
|
|
267
|
+
```
|
|
268
|
+
|
|
269
|
+
全局 `readonly`、字段 `readonly`、联动只读和无编辑权限会让字段退出校验:必填标记与已有错误会立即清除,恢复编辑后原有规则自动生效。字段 `disabled` 只禁止交互,仍参与 `validate()`、`validateField()`、`getModel()`、`getSubmitModel()` 和程序化写值。
|
|
270
|
+
|
|
271
|
+
关于“不进入提交投影”的两种情形要区分清楚:
|
|
272
|
+
|
|
273
|
+
- 表单内部子组件通过 `useFormContext()` 调用 `setFieldVisible(prop, false)` 时,与无查看权限一样属于**隐藏**:字段仍在字段状态中,只是 `hidden` 为 `true`,因此既不进入校验、也不进入 `getModel()` / `getSubmitModel()`,但业务模型仍保留其值。
|
|
274
|
+
- 表单内部子组件通过 `useFormContext()` 调用 `removeFields()` 属于**结构性删除**:字段从字段状态中移除,`pushModel()` 重建 v-model 快照时不再包含它,所以业务模型中的对应值也会被一并移除——这与隐藏不同,无法再还原。外部调用方应通过 `schema.sections` 声明式替换字段。
|
|
275
|
+
|
|
276
|
+
换言之,`getModel()` / `getSubmitModel()` 返回的是当前仍存在于字段状态中的、且非 `hidden` 的字段;`readonly` / `disabled` 字段始终保留在提交投影中。
|
|
277
|
+
|
|
278
|
+
## 富文本字段
|
|
279
|
+
|
|
280
|
+
`ogControl: { ogType: 'editor' }` 渲染 `@origen-ui/editor` 的 `OgEditor`。该 renderer 只存在于根入口 `@origen-ui/form`:`@origen-ui/form/core` 的 registry 不含 editor 与 upload,使用这两类字段时必须从根入口导入,或自行注册 renderer。编辑器由根入口静态注册,确保编辑与只读 renderer 的运行时类型稳定;因此使用根入口会把 Editor 依赖纳入初始构建。
|
|
281
|
+
|
|
282
|
+
字段值始终是 HTML 字符串;`required` 会把 `<p></p>`、`<p> </p>` 这类空段落视为空值。表单或字段只读时,字段渲染为 `OgEditorViewer`,只展示内容而不再提供编辑能力。图片、视频与附件的上传全部由 `ogControl.ogUpload` 的业务回调提供,Form 不感知传输细节。
|
|
283
|
+
|
|
284
|
+
```ts
|
|
285
|
+
const fields: FormField<ArticleForm>[] = [
|
|
286
|
+
{
|
|
287
|
+
prop: 'content',
|
|
288
|
+
label: '正文',
|
|
289
|
+
required: true,
|
|
290
|
+
span: 24,
|
|
291
|
+
ogControl: {
|
|
292
|
+
ogType: 'editor',
|
|
293
|
+
ogSetup: { type: 'preset', preset: 'basic' },
|
|
294
|
+
ogPlaceholder: '请输入正文',
|
|
295
|
+
ogMinHeight: 180,
|
|
296
|
+
ogMaxHeight: 320,
|
|
297
|
+
ogUpload: {
|
|
298
|
+
image: {
|
|
299
|
+
accept: 'image/png,image/jpeg,image/webp',
|
|
300
|
+
request: async ({ file, reportProgress }) => ({
|
|
301
|
+
url: await uploadImage(file, reportProgress),
|
|
302
|
+
}),
|
|
303
|
+
},
|
|
304
|
+
},
|
|
305
|
+
},
|
|
306
|
+
},
|
|
307
|
+
]
|
|
308
|
+
```
|
|
309
|
+
|
|
310
|
+
## 上传值模式
|
|
311
|
+
|
|
312
|
+
上传字段在 `ogControl: { ogType: 'upload', ogValueType }` 中选择模型投影。应用可以只存 URL,也可以保留完整文件对象。
|
|
313
|
+
|
|
314
|
+
| `ogControl.ogValueType` | 模型值 |
|
|
315
|
+
| ----------------------- | ---------------------------------------- |
|
|
316
|
+
| `url` | 单个 URL 字符串 |
|
|
317
|
+
| `urls` | URL 字符串数组 |
|
|
318
|
+
| `fileList` | `{ name, url, status, uid, response }[]` |
|
|
319
|
+
|
|
320
|
+
## 编辑器与上传组合
|
|
321
|
+
|
|
322
|
+
编辑器与上传字段可以共存于同一份 schema。上传字段用 `ogControl.ogValueType` 选择模型投影,富文本字段保留 HTML,二者都由 `getSubmitModel()` 统一产出提交模型;切换整表只读时,编辑器走内容查看器、上传控件进入只读展示。
|
|
323
|
+
|
|
324
|
+
```ts
|
|
325
|
+
const fields: FormField<ReleaseForm>[] = [
|
|
326
|
+
{
|
|
327
|
+
prop: 'cover',
|
|
328
|
+
label: '封面',
|
|
329
|
+
ogControl: {
|
|
330
|
+
ogType: 'upload',
|
|
331
|
+
ogValueType: 'url',
|
|
332
|
+
accept: 'image/*',
|
|
333
|
+
limit: 1,
|
|
334
|
+
ogAdapter: adapter,
|
|
335
|
+
},
|
|
336
|
+
},
|
|
337
|
+
{
|
|
338
|
+
prop: 'content',
|
|
339
|
+
label: '正文',
|
|
340
|
+
required: true,
|
|
341
|
+
span: 24,
|
|
342
|
+
ogControl: {
|
|
343
|
+
ogType: 'editor',
|
|
344
|
+
ogSetup: { type: 'preset', preset: 'basic' },
|
|
345
|
+
ogUpload: editorUpload,
|
|
346
|
+
},
|
|
347
|
+
},
|
|
348
|
+
{
|
|
349
|
+
prop: 'attachments',
|
|
350
|
+
label: '附件',
|
|
351
|
+
span: 24,
|
|
352
|
+
ogControl: {
|
|
353
|
+
ogType: 'upload',
|
|
354
|
+
ogValueType: 'fileList',
|
|
355
|
+
showFileList: true,
|
|
356
|
+
ogAdapter: adapter,
|
|
357
|
+
},
|
|
358
|
+
},
|
|
359
|
+
]
|
|
360
|
+
```
|
|
361
|
+
|
|
362
|
+
## 校验、命令 API 与动态 Schema
|
|
363
|
+
|
|
364
|
+
校验支持 `required`、同步/异步 `validator`、`requiredWhen` 与跨字段依赖。实例 API 适合处理批量写值、动态字段和远程选项刷新。`isDirty()` 会比较标准化后的 `getSubmitModel()`;异步回填完成可更新 `ogBaselineKey`,保存成功后可调用 `markClean()`。可用 `ogDirtyModelTransform` 投影出稳定比较模型;无法比较的值会触发 `dirtyError` 并保守地视为有修改。
|
|
365
|
+
|
|
366
|
+
## 实例级 Renderer
|
|
367
|
+
|
|
368
|
+
使用实例级 registry 扩展字段类型,避免一个表单或 SSR 请求的自定义 renderer 影响其他实例。
|
|
369
|
+
|
|
370
|
+
```ts
|
|
371
|
+
import { createRendererRegistry } from '@origen-ui/form'
|
|
372
|
+
|
|
373
|
+
const rendererRegistry = createRendererRegistry()
|
|
374
|
+
rendererRegistry.register('currency', (field, deps) => {
|
|
375
|
+
// 返回自定义 Vue 控件 VNode,并绑定 deps.resolveDisabled(field)。
|
|
376
|
+
})
|
|
377
|
+
```
|
|
378
|
+
|
|
379
|
+
## 全局配置与 Renderer 导出
|
|
380
|
+
|
|
381
|
+
属性与运行时类型:`OgFormBusinessProps`、`OgFormFieldControl`、`OgFormItemBusinessProps`、`OgFormItemProps`、`OgFormRuntimeProps`。
|
|
382
|
+
|
|
383
|
+
### 官方表单项属性类型:`OgFormItemElProps`
|
|
384
|
+
|
|
385
|
+
以下能力来自 `@origen-ui/form` 根入口,用于应用级默认值和实例级控件注册:
|
|
386
|
+
|
|
387
|
+
### 完整名称索引
|
|
388
|
+
|
|
389
|
+
### 校验与快照工具:`DeepReadonly`、`DeepReadonlyDate`、`DeepReadonlyRegExp`、`DeepReadonlyURL`、`DeepReadonlyURLSearchParams`、`OgFormValidationOutcome`、`ValidationTrigger`、`createDependencySignatureContext`、`dependencySignature`、`dependencyWatchSource`、`DependencySignatureContext`、`DependencyWatchSource`、`createReadonlyModelView`
|
|
390
|
+
|
|
391
|
+
校验、快照与只读工具还包括 `DeepReadonly`、`DeepReadonlyDate`、`DeepReadonlyRegExp`、`DeepReadonlyURL`、`DeepReadonlyURLSearchParams`、`OgFormValidationOutcome`、`ValidationTrigger`、`createDependencySignatureContext`、`dependencySignature`、`dependencyWatchSource`、`DependencySignatureContext`、`DependencyWatchSource` 和 `createReadonlyModelView`。
|
|
392
|
+
|
|
393
|
+
以下根入口类型和工具由本页的 Props、Renderer、联动、校验与事件章节定义:
|
|
394
|
+
|
|
395
|
+
| 分类 | 导出 |
|
|
396
|
+
| -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
397
|
+
| 应用配置 | `createOgForm`、`resolveOgFormGlobalConfig`、`useOgFormGlobalConfig`、`OgFormGlobalConfig`、`ResolvedOgFormGlobalConfig` |
|
|
398
|
+
| Renderer 与 registry | `buildControl`、`createCoreRendererRegistry`、`createRendererRegistry`、`FieldRenderer`、`OgFormItem`、`provideRendererRegistry`、`RENDERER_REGISTRY_KEY`、`useRendererRegistry`、`ControlRenderer`、`RenderDeps` |
|
|
399
|
+
| 联动、计算与校验 | `applyComputePlan`、`createComputePlan`、`ComputePlan`、`ComputePlanError`、`createLinkageCache`、`evalWhenConditions`、`resolveLinkage`、`LinkageCache`、`createFormContext`、`FORM_CONTEXT_KEY`、`useFormContext`、`buildFieldRules`、`applyValueChangePatches` |
|
|
400
|
+
| 组件与 locale | `OG_FORM_LOCALE_EN_US`、`OG_FORM_LOCALE_ZH_CN`、`OG_FORM_LOCALE_ZH_TW`、`OgForm` |
|
|
401
|
+
| 字段与表单类型 | `RendererRegistry`、`rangeProjection`、`BuiltInFieldType`、`CascaderProps`、`EditorFieldProps`、`FieldA11y`、`FieldAccess`、`FieldKey`、`FieldOptionValue`、`FieldPermission`、`FieldPropsForType`、`FieldRenderContext`、`FieldRenderFn`、`FieldSlotsForType`、`FieldType`、`FieldValidationResult`、`FieldValue`、`FieldValueEntry`、`FormField`、`FormFieldFor`、`FormFieldForType`、`FormFieldIdentity`、`FormFieldLinkage`、`FormFieldOptions`、`FormFieldPresentation`、`FormFieldSlotProps`、`FormFieldValidation`、`FormLinkageResult`、`FormSection`、`FormSectionVariant`、`InputFieldProps`、`RendererField` |
|
|
402
|
+
| 实例、选项与值类型 | `LinkageFn`、`NormalizeFormModel`、`NumberFieldProps`、`OgFormExpose`、`OgFormFieldController`、`OgFormFieldMeta`、`OgFormLocale`、`OgFormElFormProps`、`OgFormOperationContext`、`OgFormOperationError`、`OgFormPermissions`、`OgFormProps`、`OgFormSchema`、`OgFormValidationIssue`、`OgFormValidationResult`、`OptionsApiPolicy`、`OptionsErrorSlotProps`、`OptionsRefreshResult`、`OptionsRefreshStatus`、`ReadonlyDisplayFormat`、`ReadonlyDisplayOptions`、`SelectFieldProps`、`TypedSelectOption`、`UploadFieldProps`、`UploadFieldValueCodec`、`UploadUserFile`、`UploadValue`、`WhenCondition`、`WhenOp`、`resolveEmptyFieldValue`、`resolveInitialFieldValue` |
|
|
403
|
+
| 默认值与日期工具 | `formatDateValue` |
|
|
404
|
+
| 属性与运行时契约 | `OgFormBusinessProps`、`OgFormFieldControl`、`OgFormItemBusinessProps`、`OgFormItemProps`、`OgFormRuntimeProps` |
|
|
405
|
+
|
|
406
|
+
| 导出 | 类型/签名 | 用途 |
|
|
407
|
+
| ---------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------ |
|
|
408
|
+
| `createOgForm` | `(config?: OgFormGlobalConfig) => Plugin` | 提供应用级默认值;不创建模块级单例。 |
|
|
409
|
+
| `resolveOgFormGlobalConfig` | `(config: OgFormGlobalConfig \| undefined) => ResolvedOgFormGlobalConfig` | 参数位置必填;传入 `undefined` 时返回冻结空配置,并快照 `locale`、`formProps`、`optionsPolicy`。 |
|
|
410
|
+
| `useOgFormGlobalConfig` | `() => ResolvedOgFormGlobalConfig \| undefined` | 在 setup 中读取当前应用已安装的配置;未安装时返回 `undefined`。 |
|
|
411
|
+
| `buildControl` | `(field, deps, registry) => VNode \| Component \| string \| number` | 在已有 OgForm 上下文中构造单个控件;不能替代 `<OgForm>`。 |
|
|
412
|
+
| `createCoreRendererRegistry` | `(initial?) => RendererRegistry` | 从传入或内置 core renderer 快照创建隔离 registry。 |
|
|
413
|
+
| `createRendererRegistry` | `(initial?) => RendererRegistry` | 从完整内置(core、editor、upload)renderer 快照创建隔离 registry。 |
|
|
414
|
+
|
|
415
|
+
全局配置可提供 `locale`、`localeSource`、`permissions`、`rendererRegistry`、布局默认值、`formProps` 与 `optionsPolicy`;组件实例的显式 `og*` Props 优先。registry 选择顺序为实例 `ogRendererRegistry` → 全局 `rendererRegistry` → 新建 core registry。字段 `renderer` 只是在选定 registry 中指定 key;声明未知 key,或进入编辑 renderer 路径时 `ogControl.ogType: 'custom'` 同时未指定 `renderer` 与 `render`,都会明确报错。只读字段可以仅提供 `readonlyRender`,字段也可以通过命名 slot 自定义渲染。
|
|
416
|
+
|
|
417
|
+
`resolveOgFormGlobalConfig` 的参数位置不能省略;当没有应用级配置时,显式传入
|
|
418
|
+
`undefined`:
|
|
419
|
+
|
|
420
|
+
```ts
|
|
421
|
+
import { resolveOgFormGlobalConfig } from '@origen-ui/form'
|
|
422
|
+
|
|
423
|
+
const resolvedConfig = resolveOgFormGlobalConfig(undefined)
|
|
424
|
+
```
|
|
425
|
+
|
|
426
|
+
```ts
|
|
427
|
+
import { createOgForm, createRendererRegistry } from '@origen-ui/form'
|
|
428
|
+
|
|
429
|
+
const rendererRegistry = createRendererRegistry()
|
|
430
|
+
rendererRegistry.register('currency', currencyRenderer)
|
|
431
|
+
|
|
432
|
+
app.use(
|
|
433
|
+
createOgForm({
|
|
434
|
+
columns: 2,
|
|
435
|
+
labelWidth: '96px',
|
|
436
|
+
localeSource,
|
|
437
|
+
rendererRegistry,
|
|
438
|
+
}),
|
|
439
|
+
)
|
|
440
|
+
```
|
|
441
|
+
|
|
442
|
+
### Core 与 Runtime 子路径
|
|
443
|
+
|
|
444
|
+
`@origen-ui/form/core` 复用根入口的组件、类型和工具;该入口的 `createRendererRegistry` 是
|
|
445
|
+
`createCoreRendererRegistry` 的别名,只包含 core renderer。需要 editor、upload 内置 renderer 时,
|
|
446
|
+
使用根入口的同名工厂。
|
|
447
|
+
|
|
448
|
+
`@origen-ui/form/runtime` 提供上表的应用配置函数、配置类型及三份 locale 常量,适用于应用启动配置。
|
|
449
|
+
三份 locale 常量也可单独从 `@origen-ui/form/locale` 导入。
|
|
450
|
+
|
|
451
|
+
## 常用操作导航
|
|
452
|
+
|
|
453
|
+
本节仅汇总命令用途;完整 Props、事件、插槽与低层组件参数以后文的[Props](#props)、[完整事件与插槽](#完整事件与插槽)为准。
|
|
454
|
+
|
|
455
|
+
| 类别 | 可用能力 |
|
|
456
|
+
| ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
457
|
+
| 校验与提交 | `validate`(返回布尔值)、`validateResult`(返回聚合结果)、`validateField`(返回 `valid` / `invalid` / `stale` / `disposed` 结构化结果)、`clearValidate`(清除校验提示,可指定 prop)、`getModel`、`getSubmitModel`、`isDirty`、`markClean` |
|
|
458
|
+
| 重置与清空 | `reset`(恢复编辑基线)、`resetField`(恢复单个字段)、`clearFields`(清空全部字段)、`clearField`(清空单个字段) |
|
|
459
|
+
| 字段控制 | `setFieldValue`、`setFields`(批量写值)、`getFieldValue`(读取单个字段值) |
|
|
460
|
+
| Schema | 通过 `schema.sections` 声明式替换字段与布局 |
|
|
461
|
+
| 异步选项 | `refreshOptions`、`refreshOptionsResult` |
|
|
462
|
+
| 内部引用 | `formRef`(Element Plus Form 实例 ref) |
|
|
463
|
+
|
|
464
|
+
::: tip 类型建议
|
|
465
|
+
|
|
466
|
+
使用 `FormField<T>` 与 `OgFormExpose<TModel, TSubmit>` 让字段 prop、默认值、计算值、命令 API 和提交模型都与业务模型保持一致。固定内置控件类型时,可使用 `FormFieldForType<T, K, Type>`,其 `ogControl` 会同步收窄 `ogType` 与同级控件属性。
|
|
467
|
+
|
|
468
|
+
:::
|
|
469
|
+
|
|
470
|
+
## 事件
|
|
471
|
+
|
|
472
|
+
OgForm 通过 `defineEmits` 向外抛出以下事件:
|
|
473
|
+
|
|
474
|
+
| 事件名 | 参数 | 触发时机 |
|
|
475
|
+
| ------------------- | ----------------------------------------- | ------------------------------------------------------------------------- |
|
|
476
|
+
| `update:modelValue` | `model: Model` | 提交一次模型变更(双向绑定)。 |
|
|
477
|
+
| `fieldChange` | `prop: string, value: unknown` | 单字段直接写值(如 `setFieldValue`);批量或派生 patch 不额外发出该事件。 |
|
|
478
|
+
| `optionsError` | `prop: string, error: Error` | `optionsApi` 加载失败,包括同步抛错。 |
|
|
479
|
+
| `dirtyError` | `error: Error` | 建立基线、脏状态投影或比较失败;比较失败时保守地视为有修改。 |
|
|
480
|
+
| `operationError` | `OgFormOperationError<Model>` | compute、异步选项或脏状态操作失败,包含操作与业务上下文。 |
|
|
481
|
+
| `validate` | Element Plus `FormEmits['validate']` 参数 | 转发表单字段原生校验事件。 |
|
|
482
|
+
| `submit` | `model: TSubmit` | 提交或 Enter 校验成功。 |
|
|
483
|
+
| `submitInvalid` | `OgFormValidationResult<Model>` | 提交或 Enter 校验失败。 |
|
|
484
|
+
|
|
485
|
+
```vue
|
|
486
|
+
<template>
|
|
487
|
+
<OgForm
|
|
488
|
+
v-model="model"
|
|
489
|
+
:og-schema="{ sections: [{ fields }] }"
|
|
490
|
+
@field-change="(prop, value) => console.log(prop, value)"
|
|
491
|
+
@options-error="(prop, err) => toast.error(`${prop} 选项加载失败`)"
|
|
492
|
+
/>
|
|
493
|
+
</template>
|
|
494
|
+
```
|
|
495
|
+
|
|
496
|
+
## 字段校验配置
|
|
497
|
+
|
|
498
|
+
### Major 版本迁移提示
|
|
499
|
+
|
|
500
|
+
schema 继续使用 `FormField<T>`;`NormalizedFormField` 和 runtime ports 已移为内部类型。自定义 renderer 使用 `RendererField<T>`,`resolveLinkage()` 返回 `FormLinkageResult<T>`。字段解析结果为只读快照,更新值或字段配置请通过 `setValue()`、`setFieldValue()`、`updateFields()` 等命令,不要直接修改快照。slot 和 renderer 的 model 参数也只读。
|
|
501
|
+
|
|
502
|
+
`validateField()` 现在返回结构化结果,应检查 `outcome.status === 'valid'`。`disabled` 字段仍校验和提交,hidden、无查看权限与 readonly 字段跳过校验。清空 daterange/timerange 后,提交模型仍包含两个端点键,空值为 `''`。upload 只使用 change/submit 校验触发,配置 blur 会转换为 change。隐藏或移除字段时,其 options 请求、缓存、watcher 和 timer 会随字段生命周期释放。
|
|
503
|
+
|
|
504
|
+
### validateOn
|
|
505
|
+
|
|
506
|
+
控制字段的校验触发时机。缺省采用 **smart** 策略:`input`、`password`、`textarea` 与 `input-tag` 使用 `'blur'`,其余内置控件使用 `'change'`。`validateOn` 始终优先于默认策略,必填与否不会改变默认触发方式。上传字段不提供可靠的 blur 事件,因此 `validateOn: 'blur'` 会归一为 `'change'`。
|
|
507
|
+
|
|
508
|
+
| 值 | 说明 |
|
|
509
|
+
| ---------- | ------------------------ |
|
|
510
|
+
| `'blur'` | 控件失去焦点时触发校验 |
|
|
511
|
+
| `'change'` | 控件值变化时立即触发校验 |
|
|
512
|
+
|
|
513
|
+
```ts
|
|
514
|
+
{ prop: 'email', label: '邮箱', required: true, validateOn: 'change' }
|
|
515
|
+
```
|
|
516
|
+
|
|
517
|
+
### validationDeps
|
|
518
|
+
|
|
519
|
+
校验依赖:声明的字段值变化后自动重校验本字段。`requiredWhen` 引用的字段会自动纳入,无需重复声明。
|
|
520
|
+
|
|
521
|
+
```ts
|
|
522
|
+
{
|
|
523
|
+
prop: 'confirmPassword',
|
|
524
|
+
label: '确认密码',
|
|
525
|
+
validator: (rule, value, callback, model) => {
|
|
526
|
+
if (value !== model.password) callback('两次密码不一致')
|
|
527
|
+
},
|
|
528
|
+
validationDeps: ['password'],
|
|
529
|
+
}
|
|
530
|
+
```
|
|
531
|
+
|
|
532
|
+
## optionsErrorSlot 字段级选项失败插槽
|
|
533
|
+
|
|
534
|
+
当字段的 `optionsApi` 加载失败时,可通过 `optionsErrorSlot` 指定一个具名插槽来展示错误信息和重试按钮。插槽作用域提供 `error`(错误对象)和 `retry`(重试函数)。
|
|
535
|
+
|
|
536
|
+
```vue
|
|
537
|
+
<template>
|
|
538
|
+
<OgForm v-model="model" :og-schema="{ sections: [{ fields }] }">
|
|
539
|
+
<template #city-options-error="{ error, retry }">
|
|
540
|
+
<div class="options-error">
|
|
541
|
+
<span>选项加载失败</span>
|
|
542
|
+
<el-button size="small" @click="retry">重试</el-button>
|
|
543
|
+
</div>
|
|
544
|
+
</template>
|
|
545
|
+
</OgForm>
|
|
546
|
+
</template>
|
|
547
|
+
```
|
|
548
|
+
|
|
549
|
+
```ts
|
|
550
|
+
const fields: FormField[] = [
|
|
551
|
+
{
|
|
552
|
+
prop: 'city',
|
|
553
|
+
label: '城市',
|
|
554
|
+
ogControl: { ogType: 'select' },
|
|
555
|
+
optionsApi: fetchCities,
|
|
556
|
+
optionsErrorSlot: 'city-options-error',
|
|
557
|
+
},
|
|
558
|
+
]
|
|
559
|
+
```
|
|
560
|
+
|
|
561
|
+
## 明细表格字段
|
|
562
|
+
|
|
563
|
+
安装 `@origen-ui/form-table` 后,可用 `createOgFormTableField` 将对象数组字段作为可编辑表格接入 OgForm。单元格使用同一套 OgForm 控件 renderer,行新增、删除和编辑会立即写回表单模型。
|
|
564
|
+
|
|
565
|
+
```ts
|
|
566
|
+
import { createOgFormTableField } from '@origen-ui/form-table'
|
|
567
|
+
|
|
568
|
+
const fields = [
|
|
569
|
+
createOgFormTableField<OrderForm, 'lines', LineItem>({
|
|
570
|
+
prop: 'lines',
|
|
571
|
+
label: '明细',
|
|
572
|
+
rowKey: 'id',
|
|
573
|
+
ogColumns: [
|
|
574
|
+
{ prop: 'sku', label: 'SKU', editor: { ogControl: { ogType: 'input' }, required: true } },
|
|
575
|
+
{ prop: 'quantity', label: '数量', editor: { ogControl: { ogType: 'number' } } },
|
|
576
|
+
],
|
|
577
|
+
ogLocal: { createRow: () => ({ id: crypto.randomUUID(), sku: '', quantity: 1 }) },
|
|
578
|
+
}),
|
|
579
|
+
]
|
|
580
|
+
```
|
|
581
|
+
|
|
582
|
+
## newline 字段属性
|
|
583
|
+
|
|
584
|
+
`newline: true` 强制将字段放到下一行,打破 `columns` 均分布局。适合在固定列数布局中实现灵活的字段排列。
|
|
585
|
+
|
|
586
|
+
```ts
|
|
587
|
+
const fields: FormField[] = [
|
|
588
|
+
{ prop: 'a', label: '字段 A', span: 8 },
|
|
589
|
+
{ prop: 'b', label: '字段 B', span: 8 },
|
|
590
|
+
{ prop: 'c', label: '字段 C', span: 8 },
|
|
591
|
+
{ prop: 'd', label: '字段 D', span: 24, newline: true }, // 强制换行到下一行
|
|
592
|
+
]
|
|
593
|
+
```
|
|
594
|
+
|
|
595
|
+
## 复合字段校验
|
|
596
|
+
|
|
597
|
+
自定义 renderer 与插槽会收到 `a11y`、`registerController` 和按表单/字段优先级解析后的 `disabled`;注册的 renderer 可调用 `deps.resolveDisabled(field)`。使用自定义控件时,将该值绑定到可交互控件;全局或字段 `readonly` 会强制禁用,否则字段显式设置 `disabled: false` 时会覆盖表单级禁用。`formProps.disabled` 仅控制交互状态,不会改变 OgForm 的校验、字段提交投影或程序化写值语义。当字段拥有 Element Plus 无法感知的校验或焦点行为(如可编辑表格)时,请注册一个 controller。`validateResult({ focusFirstError: true })` 返回原生与复合校验合并后的结果,而 `validate()` 仍是一个布尔便捷方法。
|
|
598
|
+
|
|
599
|
+
当宿主应用需要在 `operation-error` 事件上获得 trace、路由与表面元数据时,请设置 `ogOperationContext`。
|
|
600
|
+
|
|
601
|
+
## 企业级字段状态与提交工作流
|
|
602
|
+
|
|
603
|
+
`getFieldMeta(prop)` 暴露 `touched`、`dirty`、`validating`、校验错误与 `optionsStatus`;`getDirtyFields()` 返回相对当前干净基线的已变更字段 prop。这为工作流守卫与审核状态提供了支持,且无需将应用代码耦合到 Element Plus 内部实现。
|
|
604
|
+
|
|
605
|
+
对于依赖型远程选项,可在全局或字段级配置 `optionsPolicy`。它完全按需启用:省略时保留原有的立即请求行为。
|
|
606
|
+
|
|
607
|
+
```ts
|
|
608
|
+
const optionsPolicy = {
|
|
609
|
+
debounceMs: 150,
|
|
610
|
+
cacheTimeMs: 30_000,
|
|
611
|
+
cacheKey: (model) => model.organizationId,
|
|
612
|
+
}
|
|
613
|
+
```
|
|
614
|
+
|
|
615
|
+
`submitOnEnter` 会在 Enter 提交有效模型时触发 `submit`,否则触发带结构化校验结果的
|
|
616
|
+
`submitInvalid`。文本域、富文本编辑器和 IME 组合输入不参与该快捷键。
|
|
617
|
+
|
|
618
|
+
## Props
|
|
619
|
+
|
|
620
|
+
| 属性 | 类型 | 默认值 | 说明 |
|
|
621
|
+
| ----------------------- | --------------------------------------- | --------------- | --------------------------------------------------------------------------------- |
|
|
622
|
+
| `modelValue` | `Partial<TModel>` | `{}` | 受控表单模型,支持 `v-model`。 |
|
|
623
|
+
| `ogSchema` | `OgFormSchema<TModel>` | - | 唯一声明式布局入口;普通表单使用一个无标题 section。 |
|
|
624
|
+
| `ogSectionVariant` | `'accent' \| 'line' \| 'band'` | `'accent'` | 分组默认视觉样式。 |
|
|
625
|
+
| `ogAnchor` | `boolean` | 自动 | 是否显示分组导航;未传入时在两个及以上具标题分组中自动启用。 |
|
|
626
|
+
| `ogScrollToFirstError` | `boolean` | `true` | 整体校验失败时是否滚动并聚焦首个错误字段。 |
|
|
627
|
+
| `ogReadonly` | `boolean` | `false` | 将字段渲染为只读展示。 |
|
|
628
|
+
| `labelWidth` | `string` | `'100px'` | 默认标签宽度。 |
|
|
629
|
+
| `ogColumns` | `number` | `3` | 响应式布局的最大列数。 |
|
|
630
|
+
| `ogResponsiveColumns` | `false \| Array<{ minWidth, columns }>` | 内置断点 | 自定义容器宽度断点,`false` 禁用响应式列数。 |
|
|
631
|
+
| `size` | `'small' \| 'default' \| 'large'` | `'default'` | 内置控件尺寸。 |
|
|
632
|
+
| `ogBaselineKey` | `string \| number` | - | 仅在该值变化时将外部模型认定为新的干净基线。 |
|
|
633
|
+
| `ogModelTransform` | `(model) => TSubmit` | - | 提交前转换模型。 |
|
|
634
|
+
| `ogDirtyModelTransform` | `(submitModel) => unknown` | - | 用于脏状态比较的稳定投影。 |
|
|
635
|
+
| `ogLocale` | `Partial<OgFormLocale>` | 中文预设 | 覆盖组件文案。 |
|
|
636
|
+
| `ogOperationContext` | `OgFormOperationContext` | - | 附加到 `operation-error` 的业务上下文。 |
|
|
637
|
+
| `ogOptionsPolicy` | `OptionsApiPolicy<TModel>` | - | 异步选项的默认缓存、去抖和取消策略。 |
|
|
638
|
+
| `ogSubmitOnEnter` | `boolean` | `true` | 是否在普通输入框中按 Enter 提交。 |
|
|
639
|
+
| `ogPermissions` | `OgFormPermissions` | 全部允许 | 字段权限检查器。 |
|
|
640
|
+
| `ogRendererRegistry` | `RendererRegistry` | 内置 registry | 覆盖字段控件 renderer。 |
|
|
641
|
+
| Element Plus props | `FormProps`(除 `model`、`rules`) | 依 Element Plus | 官方普通属性直接放在 OgForm 顶层,例如 `disabled`、`labelSuffix`、`showMessage`。 |
|
|
642
|
+
|
|
643
|
+
## 完整事件与插槽
|
|
644
|
+
|
|
645
|
+
| 事件 | 载荷 | 说明 |
|
|
646
|
+
| ------------------- | -------------------------------- | --------------------------------------------- |
|
|
647
|
+
| `update:modelValue` | `Model` | 表单模型变更。 |
|
|
648
|
+
| `fieldChange` | `(prop: string, value: unknown)` | 单个字段写值后触发。 |
|
|
649
|
+
| `submit` | `TSubmit` | 校验通过并提交,载荷已经过 `modelTransform`。 |
|
|
650
|
+
| `submitInvalid` | `OgFormValidationResult<Model>` | 提交或 Enter 校验失败。 |
|
|
651
|
+
| `optionsError` | `(prop: string, error: Error)` | 字段 `optionsApi` 请求失败。 |
|
|
652
|
+
| `operation-error` | `OgFormOperationError<Model>` | compute、异步选项或脏状态操作失败。 |
|
|
653
|
+
| `dirtyError` | `Error` | 脏状态投影或比较失败。 |
|
|
654
|
+
|
|
655
|
+
字段插槽使用 `field-{prop}` 命名,作用域参数为 `FormFieldSlotProps<T>`;选项失败插槽可由字段的 `optionsErrorSlot` 指定。低层 `FieldRenderer` 公开接收 `field` 和 `readonly`,只能在 OgForm 上下文中使用;`OgFormItem` 使用 `ogName`、`ogField`、`ogReadonly`、`ogLabelTip` 声明业务字段,并将 Element Plus `ElFormItem` 普通属性直接放在根层。
|
|
656
|
+
|
|
657
|
+
### 低层字段组件 Props
|
|
658
|
+
|
|
659
|
+
`FieldRenderer` 与 `OgFormItem` 依赖 OgForm 注入的表单上下文,不能脱离 OgForm 单独挂载;上方基础表单示例走的正是同一套字段渲染和校验链路。
|
|
660
|
+
|
|
661
|
+
| 组件 | 属性 | 类型 | 默认值 | 说明 |
|
|
662
|
+
| --------------- | ------------------------------------------------------------ | --------------- | ------- | ------------------------------------------------------ |
|
|
663
|
+
| `FieldRenderer` | `ogField` | `FormField<T>` | - | 必填。按 schema 渲染单个字段控件。 |
|
|
664
|
+
| `FieldRenderer` | `ogReadonly` | `boolean` | `false` | 将字段切换为只读展示。 |
|
|
665
|
+
| `FieldRenderer` | `ogA11y` | `FieldA11y` | - | 覆盖表单上下文解析出的字段无障碍属性。 |
|
|
666
|
+
| `OgFormItem` | `ogName` | `FieldKey<T>` | - | 必填。表单上下文中的字段名。 |
|
|
667
|
+
| `OgFormItem` | `ogLabelTip` | `Tip` | - | 覆盖 schema 字段说明,支持 Tooltip 与 inline。 |
|
|
668
|
+
| `OgFormItem` | `ogField` | `FormField<T>` | - | 指定时复用 `FieldRenderer` 的 schema 渲染路径。 |
|
|
669
|
+
| `OgFormItem` | `ogReadonly` | `boolean` | `false` | 只读态并传递到字段渲染器。 |
|
|
670
|
+
| `OgFormItem` | Element Plus `FormItemProps` 除 `prop`、`error` 外的普通属性 | `FormItemProps` | - | 直接使用官方名称;字段路径和错误状态仍由 OgForm 控制。 |
|
|
671
|
+
|
|
672
|
+
## 原生 Element Plus 表单属性
|
|
673
|
+
|
|
674
|
+
Element Plus `<ElForm>` 的普通属性直接放在 OgForm 顶层,例如 `inline`、`labelSuffix`、`showMessage`、`scrollIntoViewOptions`、`disabled`、`labelWidth` 和 `size`;`model` 与 `rules` 由 OgForm 的 v-model 与 schema 校验流程接管,不接受作为透传属性。实例级 `disabled` 会同步应用于内置控件、上传/编辑器字段及自定义 renderer/slot 上下文;字段显式的 `disabled: true | false` 按 Element Plus 控件级优先级覆盖表单值。自定义 renderer/slot 必须使用作用域中的 `disabled` 绑定自身控件。表单级禁用只改变交互状态,不改变 OgForm 校验、提交投影或程序化写值语义。应用级 `createOgForm` 全局默认值仍可通过全局配置的 `formProps` 设置;该配置对象不是组件实例属性。`OgFormItem` 的 Element Plus `FormItemProps` 直接使用官方名称;`prop` 与 `error` 由 OgForm 控制。字段 schema 中的 `ogFormItem` 仍是面向 `<ElFormItem>` 的独立属性组。官方属性详情参考 Element Plus 官方文档。暴露出的 `formRef` 是原生 Element Plus 的 `FormInstance`,供显式需要原生 API 的场景使用。
|
|
675
|
+
|
|
676
|
+
## 分组展示与导航
|
|
677
|
+
|
|
678
|
+
`ogSchema.sections` 支持 `description` 与 `variant`。通过 `ogSectionVariant` 选择表单默认样式:`accent`(默认)、`line` 或 `band`;单个分组可用 `variant` 覆盖。
|
|
679
|
+
|
|
680
|
+
当存在两个及以上具标题分组时,OgForm 会自动渲染吸顶的分组导航。设置 `og-anchor="false"` 可禁用,`og-anchor="true"` 可显式启用。分组 id 限定在表单实例内,因此同一页面可共存多个表单。
|
|
681
|
+
|
|
682
|
+
整表 `validate()` 与 `validateResult()` 默认会显示并聚焦第一个可见的无效项。当宿主接管该流程时,可设置 `og-scroll-to-first-error="false"`,或调用 `validateResult({ focusFirstError: false })`。
|
|
683
|
+
|
|
684
|
+
## Schema 引用与更新
|
|
685
|
+
|
|
686
|
+
表单会按引用缓存 `ogSchema.sections`、分组、字段以及 `ogControl` 的规范化结果。修改布局或字段配置时,应创建新的 `ogSchema.sections` 数组,并替换受影响的分组、字段或 `ogControl` 引用:
|
|
687
|
+
|
|
688
|
+
```ts
|
|
689
|
+
const nextSchema = {
|
|
690
|
+
...ogSchema,
|
|
691
|
+
sections: ogSchema.sections.map((section) => ({
|
|
692
|
+
...section,
|
|
693
|
+
fields: section.fields.map((field) =>
|
|
694
|
+
field.prop === 'name' ? { ...field, ogControl: { ogType: 'input', clearable: true } } : field,
|
|
695
|
+
),
|
|
696
|
+
})),
|
|
697
|
+
}
|
|
698
|
+
```
|
|
699
|
+
|
|
700
|
+
不支持 schema 嵌套对象的原地修改;声明式更新请使用不可变替换,表单上下文消费者可用 `updateFields()` 进行运行时字段调整。
|
|
701
|
+
|
|
702
|
+
原始事件名与 TypeScript 监听使用 camelCase:`fieldChange`、`dirtyError`、`optionsError`、`operationError`、`submitInvalid`。Vue 模板继续使用 `@field-change`、`@dirty-error`、`@options-error`、`@operation-error`、`@submit-invalid`;这是 Vue 的名称映射。原始 emit 键仅发出 camelCase 一次,无旧名别名;载荷与 `update:modelValue` 不变。
|
|
703
|
+
|
|
704
|
+
## 相关组合示例
|
|
705
|
+
|
|
706
|
+
明细表格字段见 [OgFormTable](./form-table.md);编辑器和上传的页面级组合见[表单与输入场景](../../.agents/skills/admin-component-usage/references/component-directory.md)。
|
|
707
|
+
|
|
708
|
+
<!-- component-contract:start -->
|
|
709
|
+
|
|
710
|
+
## 公共契约
|
|
711
|
+
|
|
712
|
+
> 由组件目录生成;每条记录对应可公开导入的组件及其消费者 API 摘要。
|
|
713
|
+
|
|
714
|
+
### Imports
|
|
715
|
+
|
|
716
|
+
- `form`: `import { OgForm } from '@origen-ui/form'`
|
|
717
|
+
- `form-item`: `import { OgFormItem } from '@origen-ui/form'`
|
|
718
|
+
- `field-renderer`: `import { FieldRenderer } from '@origen-ui/form'`
|
|
719
|
+
|
|
720
|
+
### Props
|
|
721
|
+
|
|
722
|
+
- `form`: `modelValue`, `ogSchema`, `ogSectionVariant`, `ogAnchor`, `ogScrollToFirstError`, `ogReadonly`, `ogColumns`, `ogResponsiveColumns`, `ogBaselineKey`, `ogModelTransform`, `ogDirtyModelTransform`, `ogLocale`, `ogOperationContext`, `ogOptionsPolicy`, `ogSubmitOnEnter`, `ogPermissions`, `ogRendererRegistry`
|
|
723
|
+
- `form-item`: `ogName`, `ogField`, `ogReadonly`, `ogLabelTip`
|
|
724
|
+
- `field-renderer`: `ogField`, `ogReadonly`, `ogA11y`
|
|
725
|
+
|
|
726
|
+
### Events
|
|
727
|
+
|
|
728
|
+
- `form`: `fieldChange`, `dirtyError`, `optionsError`, `operationError`, `validate`, `update:modelValue`, `submit`, `submitInvalid`
|
|
729
|
+
- `form-item`: 无
|
|
730
|
+
- `field-renderer`: 无
|
|
731
|
+
|
|
732
|
+
### Slots
|
|
733
|
+
|
|
734
|
+
- `form`: `actions`, `*`
|
|
735
|
+
- `form-item`: `default`, `*`
|
|
736
|
+
- `field-renderer`: `options-error`
|
|
737
|
+
|
|
738
|
+
### Exposes
|
|
739
|
+
|
|
740
|
+
- `form`: `validate`, `validateResult`, `validateField`, `clearValidate`, `focusField`, `getFieldMeta`, `getDirtyFields`, `getModel`, `getSubmitModel`, `isDirty`, `markClean`, `reset`, `resetField`, `clearFields`, `clearField`, `setFields`, `setFieldValue`, `getFieldValue`, `refreshOptions`, `refreshOptionsResult`, `formRef`
|
|
741
|
+
- `form-item`: 无
|
|
742
|
+
- `field-renderer`: 无
|
|
743
|
+
|
|
744
|
+
### Types
|
|
745
|
+
|
|
746
|
+
- `form`:属性类型:`OgFormProps`;公开方法类型:无
|
|
747
|
+
- `form-item`:属性类型:由公开 Vue 组件推断,未单独导出属性类型;公开方法类型:无
|
|
748
|
+
- `field-renderer`:属性类型:由公开 Vue 组件推断,未单独导出属性类型;公开方法类型:无
|
|
749
|
+
|
|
750
|
+
<!-- component-contract:end -->
|