Compare commits

...
2 Commits
Author SHA1 Message Date
wc24 4b6f260227 docs: 内置字段类型照 fields/ 目录重列——删掉不存在的 json,补上 array/object,点明未注册类型是静默回落 2026-08-11 16:57:43 +08:00
wc24 00c2211271 0.8.2 顶栏改走 resolveVue,撤掉 headerWidgets
headerWidgets 是往 userbar 里插组件的口子:VueAdmin 收一个组件数组、userbar 用
v-for 渲染。它绕开了本包唯一的覆盖机制(sources 路径后缀),等于给同一件事开了
第二条路——而且是条窄路,只能往那一处塞,插进去的东西也没法参与 userbar 自身的
布局与样式。

撤掉它,同时把真问题补上:userbar 之前根本不可覆盖(layout.vue 静态 import),
消费侧就算按约定放了 shrimp/components/userbar.vue 也会被静默忽略——这才是当初
需要 headerWidgets 的原因。现在 userbar 走 resolveVue,整条顶栏都能换。

代价:想改顶栏得整份重写内置那 92 行,不能只插一个部件。这是有意的,覆盖颗粒度
本来就停在入口级(README 那张表),不为单个部件开代理。

README 同步:补上 userbar 这一行,并写明表外路径会被静默忽略、不报错。
2026-08-11 12:18:48 +08:00
6 changed files with 19 additions and 19 deletions
+10 -5
View File
@@ -20,7 +20,7 @@ shrimp-admin 是**源码 ship**(.ts + .vue 直接发),不带构建产物,由消
"type": "module",
"scripts": { "dev": "vite", "build": "vite build" },
"dependencies": {
"shrimp-admin": "git+http://git.zeromvc.com/wc24/shrimp-admin.git#v0.7.10",
"shrimp-admin": "git+http://git.zeromvc.com/wc24/shrimp-admin.git#v0.8.2",
// ⚠️ 不能删 —— 下面 6 个是 shrimp-admin 的 peerDependencies,
// 必须由消费侧显式装进自己的 dependencies,不能指望 npm 提升碰巧能 import 到
@@ -168,17 +168,18 @@ Vite dev 默认用 **esbuild** 把 node_modules 里的裸导入预打包成 `nod
└── orders.vue 子模块,parent=user
```
### 覆盖颗粒度只在 3 个入口
### 覆盖颗粒度只在这几个入口
框架内 .vue 之间的 peer 引用是**硬编码静态 import**,override 颗粒度就停在下面这 3 类入口,不会一路传递下去:
框架内 .vue 之间的 peer 引用是**硬编码静态 import**,override 颗粒度就停在下面这几类入口,不会一路传递下去:
| 入口 | 后缀 | 说明 |
| --- | --- | --- |
| **router targets** | `components/login.vue`、`components/layout.vue`、`components/404.vue` | vue-router 三个根级路由组件 |
| **module routes** | `module/<key>.vue`、`module/<parent>/<sub>.vue` | 走 `registerRoute` 的业务模块/子模块 |
| **field registry** | `components/fields/Field<X>.vue` | 字段类型注册表(文件名首字母小写 = type 键) |
| **顶栏** | `components/userbar.vue` | 右上角那一条(语言、全屏、用户菜单),整体替换 |
想换更细的部件(比如 layout 里的 topbar)就在消费侧的 `layout.vue` 自己组装 — 框架不再代理任何 peer 切换。
**表里没有的路径不会被覆盖,而且不报错**——写了个 `components/topbar.vue` 放进 sources,框架照样用内置那份,页面正常打开、你的文件被静默忽略。想换更细的部件就在消费侧的 `layout.vue` 里自己组装,框架不代理 peer 切换。
### 字段类型注册
@@ -190,7 +191,11 @@ Vite dev 默认用 **esbuild** 把 node_modules 里的裸导入预打包成 `nod
| `FieldRelativeTime.vue` | `relativeTime` |
| 你自己的 `FieldMyType.vue` | `myType` |
后端 moduleInfo 里 `field.type === 'myType'` 时就用你这个组件。内置类型: `string` / `boolean` / `date` / `json` / `number` / `password` / `relation` / `select` / `tab` / `textarea` / `relativeTime`。
后端 moduleInfo 里 `field.type === 'myType'` 时就用你这个组件。
内置类型以 `src/components/fields/` 目录为准,当前是: `array` / `boolean` / `date` / `number` / `object` / `password` / `relation` / `relativeTime` / `select` / `string` / `tab` / `textarea`。其中 `relativeTime` 是本实现独有的,shrimp-server 的 `ShrimpFieldTypes` 里没有。
**没有 `json`。** 后端发一个没注册的 type 过来不会报错,`getFieldComponent` 静默回落成 `string` 渲染,只在控制台留一条 warning——列照样出、内容不对。字符串数组要用 `array` + `item`,嵌套对象用 `object` + `fields`。
### 业务模块
+2 -2
View File
@@ -1,12 +1,12 @@
{
"name": "shrimp-admin",
"version": "0.1.0",
"version": "0.8.3",
"lockfileVersion": 3,
"requires": true,
"packages": {
"": {
"name": "shrimp-admin",
"version": "0.1.0",
"version": "0.8.3",
"dependencies": {
"shrimp-server": "git+http://git.zeromvc.com/wc24/shrimp-server.git#v0.5.0"
},
+1 -1
View File
@@ -1,6 +1,6 @@
{
"name": "shrimp-admin",
"version": "0.8.1",
"version": "0.8.3",
"private": true,
"description": "Shrimp 框架前端 — 消费 ShrimpServer + ShrimpTable 契约的经典 Vue3 + Element Plus 实现",
"main": "src/index.ts",
-6
View File
@@ -53,8 +53,6 @@ export interface ShrimpAdminOptions {
locales?: Record<string, any>
/** 语言列表,默认 [{ lang: 'zh-cn', name: '简体中文' }] */
langList?: { lang: string; name: string }[]
/** 顶栏(userbar)自定义组件,按序渲染在语言切换左侧。业务侧注入全局头部小部件(如终端商户选择器) */
headerWidgets?: Component[]
}
// ============== 源注册表 ==============
@@ -167,9 +165,6 @@ export class VueAdmin extends ShrimpClient {
state = reactive({ isMobile: false })
/** 顶栏自定义组件(由 createShrimpAdmin 的 headerWidgets 注入),userbar 按序渲染 */
headerWidgets: Component[] = []
private _token: string | null = null
get token() { return this._token }
set token(value: string | null) {
@@ -202,7 +197,6 @@ export class VueAdmin extends ShrimpClient {
super()
this.config = opts.config
this.langList = opts.langList || [{ lang: 'zh-cn', name: '简体中文' }]
this.headerWidgets = opts.headerWidgets || []
if (opts.sources) {
Object.assign(externalSources, opts.sources)
+6 -3
View File
@@ -43,15 +43,18 @@
</template>
<script lang="ts" setup>
import { ref, watch } from "vue";
import { vueAdmin } from "../VueAdmin";
import { ref, watch, defineAsyncComponent } from "vue";
import { vueAdmin, resolveVue } from "../VueAdmin";
import { type IMenuItem } from "../IShrimpType";
import SideM from "./sideM.vue";
import navMenu from "./navMenu.vue";
import Topbar from "./topbar.vue";
import Userbar from "./userbar.vue";
import Logo from "./logo.vue";
// 顶栏走 resolveVue,消费侧放 shrimp/components/userbar.vue 即可整体替换。
// 其余内置组件仍是静态 import——等真有人要覆盖再逐个放开,不预先把整棵树异步化。
const Userbar = defineAsyncComponent(resolveVue("components/userbar.vue"));
// 初始化选中菜单
let currentPath = vueAdmin.router.currentRoute.value.path;
let pick = vueAdmin.getMenuIndex(currentPath);
-2
View File
@@ -1,7 +1,5 @@
<template>
<div class="user-bar">
<!-- 业务侧注入的顶栏部件(headerWidgets),按序渲染在语言切换左侧 -->
<component :is="w" v-for="(w, i) in vueAdmin.headerWidgets" :key="i" />
<LangSwitch class="panel-item" />
<div class="panel-item" @click="screen">
<el-icon><el-icon-full-screen /></el-icon>