yudao
/
admin-vben
mirror of https://gitee.com/yudaocode/yudao-ui-admin-vben.git
3
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

style: apply vsh lint formatting (#7923)

master^2
leo 2026-05-19 13:40:13 +08:00 committed by GitHub
parent 84e77f64ea
commit d71c81e8ff
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
20 changed files with 193 additions and 193 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.changeset/element-plus-theme-switch.md
View File

@ -1,5 +1,5 @@
---
"@vben/layouts": patch
'@vben/layouts': patch
---
fix: update primary color when toggling dark/light mode with custom theme

2
.changeset/page-auto-content-height.md
View File

@ -1,5 +1,5 @@
---
"@vben/common-ui": patch
'@vben/common-ui': patch
---
fix: skip fixed footer height in auto-content-height calculation

2
.changeset/small-moons-hunt.md
View File

@ -1,5 +1,5 @@
---
"@vben/icons": patch
'@vben/icons': patch
---
fix: guard svg icon loading during docs SSR

2
.changeset/tree-default-value.md
View File

@ -1,5 +1,5 @@
---
"@vben-core/shadcn-ui": patch
'@vben-core/shadcn-ui': patch
---
fix: preserve tree default value when treeData starts empty

7
docs/src/demos/vben-tiptap/basic/index.vue
View File

@ -11,10 +11,9 @@ const content = ref('<p>开始编辑你的内容...</p>');
<VbenTiptap v-model="content" />
<div class="mt-4">
<p class="text-sm text-gray-500">当前内容:</p>
<pre
class="mt-2 p-2 bg-gray-100 rounded text-xs overflow-auto max-h-40"
>{{ content }}</pre
>
<pre class="mt-2 p-2 bg-gray-100 rounded text-xs overflow-auto max-h-40">
{{ content }}
</pre>
</div>
</div>
</template>

92
packages/@core/base/shared/src/cache/README.md vendored
View File

@ -1,7 +1,6 @@
# Cache 模块
基于**策略模式**的异步存储管理方案，支持多种存储后端（localStorage、IndexedDB、Memory），提供统一的 API
接口。
基于**策略模式**的异步存储管理方案，支持多种存储后端（localStorage、IndexedDB、Memory），提供统一的 API 接口。
## 架构设计
@ -22,11 +21,11 @@
**分层职责：**
| 层级 | 职责 |
|------------------|----------------------------|
| 层级 | 职责 |
| ---------------- | -------------------------------------------- |
| `StorageManager` | 命名空间前缀隔离、TTL 过期检查、统一对外 API |
| `IStorageDriver` | 纯粹的 KV 存取抽象接口 |
| 各 Driver 实现 | 对接具体存储引擎，不感知前缀和 TTL |
| `IStorageDriver` | 纯粹的 KV 存取抽象接口 |
| 各 Driver 实现 | 对接具体存储引擎，不感知前缀和 TTL |
---
@ -35,9 +34,9 @@
### 基本使用（默认 localStorage）
```typescript
import {StorageManager} from '@vben-core/shared/cache';
import { StorageManager } from '@vben-core/shared/cache';
const cache = new StorageManager({prefix: 'myapp'});
const cache = new StorageManager({ prefix: 'myapp' });
// 使用 IndexedDB
//new StorageManager({ driver: new IndexedDBDriver(), prefix: 'app' });
@ -48,14 +47,14 @@ const cache = new StorageManager({prefix: 'myapp'});
//new StorageManager({ driver: new MemoryStorageDriver(), prefix: 'test' });
// 存储数据
await cache.setItem('user', {name: '张三', age: 28});
await cache.setItem('user', { name: '张三', age: 28 });
// 读取数据
const user = await cache.getItem('user');
// => { name: '张三', age: 28 }
// 带默认值读取
const settings = await cache.getItem('settings', {theme: 'light'});
const settings = await cache.getItem('settings', { theme: 'light' });
// 如果不存在，返回 { theme: 'light' }
// 删除数据
@ -68,7 +67,7 @@ await cache.clear();
### 带 TTL 过期
```typescript
const cache = new StorageManager({prefix: 'session'});
const cache = new StorageManager({ prefix: 'session' });
// 设置 5 分钟后过期（TTL 单位为毫秒）
await cache.setItem('token', 'abc123', 5 * 60 * 1000);
@ -191,20 +190,20 @@ const cache = new StorageManager({
new StorageManager(options?: StorageManagerOptions)
```
| 参数 | 类型 | 默认值 | 说明 |
|----------|------------------|----------------------------|--------------|
| `driver` | `IStorageDriver` | `new LocalStorageDriver()` | 存储驱动实例 |
| `prefix` | `string` | `''` | 键前缀，用于命名空间隔离 |
| 参数 | 类型 | 默认值 | 说明 |
| --- | --- | --- | --- |
| `driver` | `IStorageDriver` | `new LocalStorageDriver()` | 存储驱动实例 |
| `prefix` | `string` | `''` | 键前缀，用于命名空间隔离 |
#### 方法
| 方法 | 签名 | 说明 |
|---------------------|-------------------------------------------------------------------------|-------------------|
| `getItem` | `getItem<T>(key: string, defaultValue?: T \| null): Promise<T \| null>` | 获取存储项，过期或不存在返回默认值 |
| `setItem` | `setItem<T>(key: string, value: T, ttl?: number): Promise<void>` | 设置存储项，可选 TTL（毫秒） |
| `removeItem` | `removeItem(key: string): Promise<void>` | 删除指定存储项 |
| `clear` | `clear(): Promise<void>` | 清除当前前缀下所有存储项 |
| `clearExpiredItems` | `clearExpiredItems(): Promise<void>` | 主动清理所有过期项 |
| 方法 | 签名 | 说明 |
| --- | --- | --- |
| `getItem` | `getItem<T>(key: string, defaultValue?: T \| null): Promise<T \| null>` | 获取存储项，过期或不存在返回默认值 |
| `setItem` | `setItem<T>(key: string, value: T, ttl?: number): Promise<void>` | 设置存储项，可选 TTL（毫秒） |
| `removeItem` | `removeItem(key: string): Promise<void>` | 删除指定存储项 |
| `clear` | `clear(): Promise<void>` | 清除当前前缀下所有存储项 |
| `clearExpiredItems` | `clearExpiredItems(): Promise<void>` | 主动清理所有过期项 |
---
@ -233,7 +232,7 @@ interface IStorageDriver {
### 自定义 Driver
```typescript
import type {IStorageDriver} from '@vben-core/shared/cache';
import type { IStorageDriver } from '@vben-core/shared/cache';
class CookieStorageDriver implements IStorageDriver {
async getItem<T>(key: string): Promise<null | T> {
@ -301,11 +300,11 @@ function createStorageManager(prefix: string) {
```typescript
// 不同模块使用不同前缀，互不干扰
const userCache = new StorageManager({prefix: 'user'});
const configCache = new StorageManager({prefix: 'config'});
const userCache = new StorageManager({ prefix: 'user' });
const configCache = new StorageManager({ prefix: 'config' });
await userCache.setItem('profile', {name: '张三'});
await configCache.setItem('profile', {theme: 'dark'});
await userCache.setItem('profile', { name: '张三' });
await configCache.setItem('profile', { theme: 'dark' });
// 各自独立
await userCache.getItem('profile'); // => { name: '张三' }
@ -356,24 +355,24 @@ interface StorageItem<T> {
采用**惰性删除 + 主动清理**双重策略：
| 策略 | 触发时机 | 说明 |
|------|--------------------------|---------------------|
| 惰性删除 | 调用 `getItem` 时 | 读取时检查过期，过期则删除并返回默认值 |
| 策略 | 触发时机 | 说明 |
| --- | --- | --- |
| 惰性删除 | 调用 `getItem` 时 | 读取时检查过期，过期则删除并返回默认值 |
| 主动清理 | 调用 `clearExpiredItems` 时 | 遍历所有带前缀的 key，删除已过期项 |
---
## 各 Driver 对比
| 特性 | LocalStorageDriver | IndexedDBDriver | MemoryStorageDriver |
|-------|--------------------|-----------------|---------------------|
| 持久化 | ✅ | ✅ | ❌ |
| 容量 | 5-10 MB | 数百 MB+ | 受内存限制 |
| 速度 | 快（同步） | 中等（异步 I/O） | 最快 |
| 数据类型 | 仅 JSON 可序列化 | 结构化克隆 | 任意 JS 对象 |
| 浏览器支持 | 所有现代浏览器 | 所有现代浏览器 | 任意环境 |
| 阻塞主线程 | 是 | 否 | 否 |
| 适用场景 | 配置、Token、小数据 | 离线缓存、大数据 | 测试、SSR |
| 特性 | LocalStorageDriver | IndexedDBDriver | MemoryStorageDriver |
| ---------- | ------------------- | ---------------- | ------------------- |
| 持久化 | ✅ | ✅ | ❌ |
| 容量 | 5-10 MB | 数百 MB+ | 受内存限制 |
| 速度 | 快（同步） | 中等（异步 I/O） | 最快 |
| 数据类型 | 仅 JSON 可序列化 | 结构化克隆 | 任意 JS 对象 |
| 浏览器支持 | 所有现代浏览器 | 所有现代浏览器 | 任意环境 |
| 阻塞主线程 | 是 | 否 | 否 |
| 适用场景 | 配置、Token、小数据 | 离线缓存、大数据 | 测试、SSR |
---
@ -388,12 +387,12 @@ class PreferenceManager {
constructor() {
this.cache = new StorageManager();
this.state = reactive<Preferences>({...defaultPreferences});
this.state = reactive<Preferences>({ ...defaultPreferences });
}
initPreferences = async ({namespace}) => {
initPreferences = async ({ namespace }) => {
// 用应用命名空间重新初始化
this.cache = new StorageManager({prefix: namespace});
this.cache = new StorageManager({ prefix: namespace });
// 从缓存加载偏好设置
const cached = await this.cache.getItem<Preferences>('preferences');
@ -406,8 +405,7 @@ class PreferenceManager {
## 注意事项
1. **所有方法都是异步的** — 即使底层是同步的 localStorage，API 也返回 Promise，确保切换 Driver
时无需改动调用方。
1. **所有方法都是异步的** — 即使底层是同步的 localStorage，API 也返回 Promise，确保切换 Driver 时无需改动调用方。
2. **TTL 单位是毫秒** — `setItem('key', value, 60000)` 表示 60 秒后过期。
@ -415,8 +413,6 @@ class PreferenceManager {
4. **前缀隔离是逻辑隔离** — `clear()` 只清除当前前缀下的数据，不影响其他前缀或无前缀的数据。
5. **错误处理** — LocalStorageDriver 在 JSON 解析失败时自动清除损坏数据；
`PreferenceManager.saveToCache` 内部 try-catch 防止未捕获异常。
5. **错误处理** — LocalStorageDriver 在 JSON 解析失败时自动清除损坏数据； `PreferenceManager.saveToCache` 内部 try-catch 防止未捕获异常。
6. **IndexedDB 版本升级** — 如果需要修改 objectStore 结构，需要递增 `dbVersion`。当前实现在
`upgradeneeded` 事件中自动创建 objectStore。
6. **IndexedDB 版本升级** — 如果需要修改 objectStore 结构，需要递增 `dbVersion`。当前实现在 `upgradeneeded` 事件中自动创建 objectStore。

34
packages/@core/base/shared/src/cache/__tests__/storage-manager.test.ts vendored
View File

@ -1,6 +1,6 @@
import { beforeEach, describe, expect, it, vi } from 'vitest';
import {MemoryStorageDriver} from '../memory-storage-driver';
import { MemoryStorageDriver } from '../memory-storage-driver';
import { StorageManager } from '../storage-manager';
describe('storageManager', () => {
@ -15,7 +15,7 @@ describe('storageManager', () => {
});
it('should set and get an item', async () => {
await storageManager.setItem('user', {age: 30, name: 'John Doe'});
await storageManager.setItem('user', { age: 30, name: 'John Doe' });
const user = await storageManager.getItem('user');
expect(user).toEqual({ age: 30, name: 'John Doe' });
});
@ -29,22 +29,22 @@ describe('storageManager', () => {
});
it('should remove an item', async () => {
await storageManager.setItem('user', {age: 30, name: 'John Doe'});
await storageManager.setItem('user', { age: 30, name: 'John Doe' });
await storageManager.removeItem('user');
const user = await storageManager.getItem('user');
expect(user).toBeNull();
});
it('should clear all items with the prefix', async () => {
await storageManager.setItem('user1', {age: 30, name: 'John Doe'});
await storageManager.setItem('user2', {age: 25, name: 'Jane Doe'});
await storageManager.setItem('user1', { age: 30, name: 'John Doe' });
await storageManager.setItem('user2', { age: 25, name: 'Jane Doe' });
await storageManager.clear();
expect(await storageManager.getItem('user1')).toBeNull();
expect(await storageManager.getItem('user2')).toBeNull();
});
it('should clear expired items', async () => {
await storageManager.setItem('user', {age: 30, name: 'John Doe'}, 1000); // 1秒过期
await storageManager.setItem('user', { age: 30, name: 'John Doe' }, 1000); // 1秒过期
vi.advanceTimersByTime(1001); // 快进时间
await storageManager.clearExpiredItems();
const user = await storageManager.getItem('user');
@ -52,7 +52,7 @@ describe('storageManager', () => {
});
it('should not clear non-expired items', async () => {
await storageManager.setItem('user', {age: 30, name: 'John Doe'}, 10_000); // 10秒过期
await storageManager.setItem('user', { age: 30, name: 'John Doe' }, 10_000); // 10秒过期
vi.advanceTimersByTime(5000); // 快进时间
await storageManager.clearExpiredItems();
const user = await storageManager.getItem('user');
@ -65,36 +65,36 @@ describe('storageManager', () => {
});
it('should overwrite existing items', async () => {
await storageManager.setItem('user', {age: 30, name: 'John Doe'});
await storageManager.setItem('user', {age: 25, name: 'Jane Doe'});
await storageManager.setItem('user', { age: 30, name: 'John Doe' });
await storageManager.setItem('user', { age: 25, name: 'Jane Doe' });
const user = await storageManager.getItem('user');
expect(user).toEqual({ age: 25, name: 'Jane Doe' });
});
it('should handle items without expiry correctly', async () => {
await storageManager.setItem('user', {age: 30, name: 'John Doe'});
await storageManager.setItem('user', { age: 30, name: 'John Doe' });
vi.advanceTimersByTime(5000);
const user = await storageManager.getItem('user');
expect(user).toEqual({ age: 30, name: 'John Doe' });
});
it('should remove expired items when accessed', async () => {
await storageManager.setItem('user', {age: 30, name: 'John Doe'}, 1000); // 1秒过期
await storageManager.setItem('user', { age: 30, name: 'John Doe' }, 1000); // 1秒过期
vi.advanceTimersByTime(1001); // 快进时间
const user = await storageManager.getItem('user');
expect(user).toBeNull();
});
it('should not remove non-expired items when accessed', async () => {
await storageManager.setItem('user', {age: 30, name: 'John Doe'}, 10_000); // 10秒过期
await storageManager.setItem('user', { age: 30, name: 'John Doe' }, 10_000); // 10秒过期
vi.advanceTimersByTime(5000); // 快进时间
const user = await storageManager.getItem('user');
expect(user).toEqual({ age: 30, name: 'John Doe' });
});
it('should handle multiple items with different expiry times', async () => {
await storageManager.setItem('user1', {age: 30, name: 'John Doe'}, 1000); // 1秒过期
await storageManager.setItem('user2', {age: 25, name: 'Jane Doe'}, 2000); // 2秒过期
await storageManager.setItem('user1', { age: 30, name: 'John Doe' }, 1000); // 1秒过期
await storageManager.setItem('user2', { age: 25, name: 'Jane Doe' }, 2000); // 2秒过期
vi.advanceTimersByTime(1500); // 快进时间
await storageManager.clearExpiredItems();
const user1 = await storageManager.getItem('user1');
@ -104,7 +104,7 @@ describe('storageManager', () => {
});
it('should handle items with no expiry', async () => {
await storageManager.setItem('user', {age: 30, name: 'John Doe'});
await storageManager.setItem('user', { age: 30, name: 'John Doe' });
vi.advanceTimersByTime(10_000); // 快进时间
await storageManager.clearExpiredItems();
const user = await storageManager.getItem('user');
@ -112,8 +112,8 @@ describe('storageManager', () => {
});
it('should clear all items correctly', async () => {
await storageManager.setItem('user1', {age: 30, name: 'John Doe'});
await storageManager.setItem('user2', {age: 25, name: 'Jane Doe'});
await storageManager.setItem('user1', { age: 30, name: 'John Doe' });
await storageManager.setItem('user2', { age: 25, name: 'Jane Doe' });
await storageManager.clear();
const user1 = await storageManager.getItem('user1');
const user2 = await storageManager.getItem('user2');

14
packages/@core/base/shared/src/cache/indexeddb-driver.ts vendored
View File

@ -1,4 +1,4 @@
import type {IStorageDriver} from './types';
import type { IStorageDriver } from './types';
interface IndexedDBDriverOptions {
/** 数据库名称 */
@ -20,10 +20,10 @@ class IndexedDBDriver implements IStorageDriver {
private storeName: string;
constructor({
dbName = 'vben-storage',
dbVersion = 1,
storeName = 'kv-store',
}: IndexedDBDriverOptions = {}) {
dbName = 'vben-storage',
dbVersion = 1,
storeName = 'kv-store',
}: IndexedDBDriverOptions = {}) {
this.dbName = dbName;
this.dbVersion = dbVersion;
this.storeName = storeName;
@ -133,5 +133,5 @@ class IndexedDBDriver implements IStorageDriver {
}
}
export {IndexedDBDriver};
export type {IndexedDBDriverOptions};
export { IndexedDBDriver };
export type { IndexedDBDriverOptions };

10
packages/@core/base/shared/src/cache/local-storage-driver.ts vendored
View File

@ -1,4 +1,4 @@
import type {IStorageDriver} from './types';
import type { IStorageDriver } from './types';
type StorageType = 'localStorage' | 'sessionStorage';
@ -15,8 +15,8 @@ class LocalStorageDriver implements IStorageDriver {
private storage: Storage;
constructor({
storageType = 'localStorage',
}: LocalStorageDriverOptions = {}) {
storageType = 'localStorage',
}: LocalStorageDriverOptions = {}) {
if (typeof window === 'undefined') {
// eslint-disable-next-line unicorn/prefer-type-error -- not a type check, it's an environment check
throw new Error(
@ -67,5 +67,5 @@ class LocalStorageDriver implements IStorageDriver {
}
}
export {LocalStorageDriver};
export type {LocalStorageDriverOptions};
export { LocalStorageDriver };
export type { LocalStorageDriverOptions };

4
packages/@core/base/shared/src/cache/memory-storage-driver.ts vendored
View File

@ -1,4 +1,4 @@
import type {IStorageDriver} from './types';
import type { IStorageDriver } from './types';
/**
* 内存存储驱动
@ -29,4 +29,4 @@ class MemoryStorageDriver implements IStorageDriver {
}
}
export {MemoryStorageDriver};
export { MemoryStorageDriver };

6
packages/@core/base/shared/src/cache/storage-manager.ts vendored
View File

@ -4,8 +4,8 @@ import type {
StorageManagerOptions,
} from './types';
import {LocalStorageDriver} from './local-storage-driver';
import {MemoryStorageDriver} from './memory-storage-driver';
import { LocalStorageDriver } from './local-storage-driver';
import { MemoryStorageDriver } from './memory-storage-driver';
/**
* 存储管理器（策略模式）
@ -17,7 +17,7 @@ class StorageManager {
private driver: IStorageDriver;
private prefix: string;
constructor({driver, prefix = ''}: StorageManagerOptions = {}) {
constructor({ driver, prefix = '' }: StorageManagerOptions = {}) {
this.driver = driver || this.createDefaultDriver();
this.prefix = prefix;
if (!this.prefix && this.driver instanceof LocalStorageDriver) {

2
packages/@core/base/shared/src/cache/types.ts vendored
View File

@ -36,4 +36,4 @@ interface StorageManagerOptions {
prefix?: string;
}
export type {IStorageDriver, StorageItem, StorageManagerOptions};
export type { IStorageDriver, StorageItem, StorageManagerOptions };

2
packages/@core/preferences/src/preferences.ts
View File

@ -43,7 +43,7 @@ class PreferenceManager {
this.cache = new StorageManager();
// 构造函数不再同步读取缓存，使用默认值初始化
// 真正的缓存加载在 initPreferences 中完成（已经是 async）
this.state = reactive<Preferences>({...defaultPreferences});
this.state = reactive<Preferences>({ ...defaultPreferences });
this.debouncedSave = useDebounceFn(() => this.saveToCache(), 150);
}

9
packages/effects/common-ui/src/components/page/page.vue
View File

@ -12,8 +12,11 @@ defineOptions({
name: 'Page',
});
const { autoContentHeight = false, heightOffset = 0, footerFixed = false } =
defineProps<PageProps>();
const {
autoContentHeight = false,
heightOffset = 0,
footerFixed = false,
} = defineProps<PageProps>();
const headerHeight = ref(0);
const footerHeight = ref(0);
@ -40,7 +43,7 @@ async function calcContentHeight() {
await nextTick();
headerHeight.value = headerRef.value?.offsetHeight || 0;
footerHeight.value = footerFixed ? 0 : (footerRef.value?.offsetHeight || 0);
footerHeight.value = footerFixed ? 0 : footerRef.value?.offsetHeight || 0;
setTimeout(() => {
shouldAutoHeight.value = true;

66
packages/effects/plugins/src/tiptap/extensions.ts
View File

@ -272,30 +272,30 @@ function createCustomImage(
...this.parent?.(),
uploadImage:
() =>
({ editor: cmdEditor }: { editor: CoreEditor }) => {
const input = document.createElement('input');
input.type = 'file';
input.accept = imageUpload.accept ?? DEFAULT_ACCEPT;
input.style.display = 'none';
({ editor: cmdEditor }: { editor: CoreEditor }) => {
const input = document.createElement('input');
input.type = 'file';
input.accept = imageUpload.accept ?? DEFAULT_ACCEPT;
input.style.display = 'none';
input.addEventListener('change', () => {
const file = input.files?.[0];
if (!file) return;
input.addEventListener('change', () => {
const file = input.files?.[0];
if (!file) return;
const error = validateFile(file, imageUpload);
if (error) {
handleUploadError(new Error(error), imageUpload);
return;
}
const error = validateFile(file, imageUpload);
if (error) {
handleUploadError(new Error(error), imageUpload);
return;
}
createUploadProcess(cmdEditor, file, imageUpload, blobUrlTracker);
input.remove();
});
createUploadProcess(cmdEditor, file, imageUpload, blobUrlTracker);
input.remove();
});
document.body.append(input);
input.click();
return true;
},
document.body.append(input);
input.click();
return true;
},
};
},
@ -428,20 +428,20 @@ export function createDefaultTiptapExtensions(
}),
options.imageUpload
? createCustomImage(
options.imageUpload,
options._blobUrlTracker,
).configure({
allowBase64: true,
HTMLAttributes: {
class: 'vben-tiptap__image',
},
})
options.imageUpload,
options._blobUrlTracker,
).configure({
allowBase64: true,
HTMLAttributes: {
class: 'vben-tiptap__image',
},
})
: Image.configure({
allowBase64: true,
HTMLAttributes: {
class: 'vben-tiptap__image',
},
}),
allowBase64: true,
HTMLAttributes: {
class: 'vben-tiptap__image',
},
}),
Placeholder.configure({
placeholder: options.placeholder ?? $t('ui.tiptap.placeholder'),
}),

2
packages/effects/plugins/src/vxe-table/api.ts
View File

@ -6,7 +6,7 @@ import type {
} from '@vben-core/form-ui';
import type { VxeGridProps } from './types';
import type {ViewedRowHelper} from './use-viewed-row';
import type { ViewedRowHelper } from './use-viewed-row';
import { toRaw } from 'vue';

40
packages/effects/plugins/src/vxe-table/types.ts
View File

@ -75,29 +75,29 @@ interface ViewedRowPersistBase {
*/
export type ViewedRowPersistOptions =
| ({
/** IndexedDB 数据库名称，默认 'viewed-table-db' */
dbName?: string;
/** IndexedDB 数据库版本，默认 1 */
dbVersion?: number;
/** 存储 key / prefix（必传） */
key: string;
/** IndexedDB 对象存储名称，默认 'viewed-table-row' */
storeName?: string;
type: 'indexedDB';
} & ViewedRowPersistBase)
/** IndexedDB 数据库名称，默认 'viewed-table-db' */
dbName?: string;
/** IndexedDB 数据库版本，默认 1 */
dbVersion?: number;
/** 存储 key / prefix（必传） */
key: string;
/** IndexedDB 对象存储名称，默认 'viewed-table-row' */
storeName?: string;
type: 'indexedDB';
} & ViewedRowPersistBase)
| ({
/** 存储 key（必传） */
key: string;
type: 'localStorage' | 'sessionStorage';
} & ViewedRowPersistBase)
/** 存储 key（必传） */
key: string;
type: 'localStorage' | 'sessionStorage';
} & ViewedRowPersistBase)
| ({
/** 自定义存储适配器（必传） */
storage: ViewedRowStorageAdapter;
type: 'custom';
} & ViewedRowPersistBase)
/** 自定义存储适配器（必传） */
storage: ViewedRowStorageAdapter;
type: 'custom';
} & ViewedRowPersistBase)
| (ViewedRowPersistBase & {
type: 'memory';
});
type: 'memory';
});
/**
* 已查看row设置

46
packages/effects/plugins/src/vxe-table/use-viewed-row.ts
View File

@ -1,4 +1,4 @@
import type {VxeGridProps as VxeTableGridProps} from 'vxe-table';
import type { VxeGridProps as VxeTableGridProps } from 'vxe-table';
import type {
ViewedRowOptions,
@ -6,9 +6,9 @@ import type {
ViewedRowStorageAdapter,
} from './types';
import {isRef, shallowRef, toRaw, triggerRef, watch} from 'vue';
import { isRef, shallowRef, toRaw, triggerRef, watch } from 'vue';
import {isBoolean, isFunction} from '@vben/utils';
import { isBoolean, isFunction } from '@vben/utils';
import {
IndexedDBDriver,
@ -16,7 +16,7 @@ import {
StorageManager,
} from '@vben-core/shared/cache';
import {useDebounceFn} from '@vueuse/core';
import { useDebounceFn } from '@vueuse/core';
const DEFAULT_VIEWED_CLASS = 'vxe-row--viewed';
@ -32,7 +32,7 @@ function createWebStorageAdapter(
ttl?: number,
): ViewedRowStorageAdapter {
const manager = new StorageManager({
driver: new LocalStorageDriver({storageType}),
driver: new LocalStorageDriver({ storageType }),
});
return {
@ -182,11 +182,13 @@ export function useViewedRow<T = any>(
options: ViewedRowOptions<T> & { keyField: string },
) {
// ========== 解析持久化配置 ==========
const persistOpts: null | ViewedRowPersistOptions = options.persist
? (typeof options.persist === 'string'
? {key: options.persist, type: 'localStorage'}
: options.persist)
: null;
let persistOpts: null | ViewedRowPersistOptions = null;
if (options.persist) {
persistOpts =
typeof options.persist === 'string'
? { key: options.persist, type: 'localStorage' }
: options.persist;
}
const adapter = createStorageAdapter(options.persist);
const maxSize = persistOpts?.maxSize ?? 100;
@ -341,7 +343,7 @@ export function useViewedRow<T = any>(
function getRowClassName(params: any): string {
if (!isViewed(params.row)) return '';
const {rowClassName} = options;
const { rowClassName } = options;
if (rowClassName === undefined || rowClassName === null) {
return DEFAULT_VIEWED_CLASS;
}
@ -358,7 +360,7 @@ export function useViewedRow<T = any>(
function getRowStyle(params: any): any {
if (!isViewed(params.row)) return undefined;
const {rowStyle} = options;
const { rowStyle } = options;
if (rowStyle === undefined || rowStyle === null) {
return undefined;
}
@ -415,11 +417,11 @@ function wrapColumnsForViewedRow(
return columns.map((column) => {
if (!column || typeof column !== 'object') return column;
const nextColumn = {...column};
const nextColumn = { ...column };
if (nextColumn.cellRender?.name === 'CellOperation') {
const cellRender = {...nextColumn.cellRender};
const attrs = {...cellRender.attrs};
const cellRender = { ...nextColumn.cellRender };
const attrs = { ...cellRender.attrs };
const originalOnClick = attrs.onClick;
attrs.onClick = (params: { code: string; row: any }) => {
@ -515,16 +517,16 @@ export function applyViewedRowOptions(
if (!viewedStyle && !originalStyle) return undefined;
if (!originalStyle) return viewedStyle;
if (!viewedStyle) return originalStyle;
return {...originalStyle, ...viewedStyle};
return { ...originalStyle, ...viewedStyle };
};
// 拦截 CellOperation columns
const actionCodes =
!isBoolean(viewedRowConfig) && viewedRowConfig.actionCodes
? (Array.isArray(viewedRowConfig.actionCodes)
? viewedRowConfig.actionCodes
: [viewedRowConfig.actionCodes])
: [];
let actionCodes: string[] = [];
if (!isBoolean(viewedRowConfig) && viewedRowConfig.actionCodes) {
actionCodes = Array.isArray(viewedRowConfig.actionCodes)
? viewedRowConfig.actionCodes
: [viewedRowConfig.actionCodes];
}
if (actionCodes.length > 0 && Array.isArray(mergedOptions.columns)) {
mergedOptions.columns = wrapColumnsForViewedRow(

6
packages/effects/plugins/src/vxe-table/use-vxe-grid.vue
View File

@ -44,7 +44,7 @@ import { VxeGrid, VxeUI } from 'vxe-table';
import { extendProxyOptions } from './extends';
import { useTableForm } from './init';
import {applyViewedRowOptions, useViewedRow} from './use-viewed-row';
import { applyViewedRowOptions, useViewedRow } from './use-viewed-row';
import 'vxe-table/styles/cssvar.scss';
import 'vxe-pc-ui/styles/cssvar.scss';
@ -93,10 +93,10 @@ watch(
if (!cfg) return;
const keyField = (gridOptions.value?.rowConfig as any)?.keyField || 'id';
const resolved = isBoolean(cfg) ? {keyField} : {keyField, ...cfg};
const resolved = isBoolean(cfg) ? { keyField } : { keyField, ...cfg };
gridApi.viewedRowHelper = useViewedRow(resolved);
},
{immediate: true},
{ immediate: true },
);
const { isMobile } = usePreferences();

38
playground/src/views/examples/vxe-table/viewed.vue
View File

@ -1,15 +1,15 @@
<script lang="ts" setup>
import type {OnActionClickParams, VxeGridProps} from '#/adapter/vxe-table';
import type { OnActionClickParams, VxeGridProps } from '#/adapter/vxe-table';
import {ref} from 'vue';
import { ref } from 'vue';
import {Page, useVbenModal} from '@vben/common-ui';
import {$t} from '@vben/locales';
import { Page, useVbenModal } from '@vben/common-ui';
import { $t } from '@vben/locales';
import {Button, message} from 'ant-design-vue';
import { Button, message } from 'ant-design-vue';
import {useVbenVxeGrid} from '#/adapter/vxe-table';
import {getExampleTableApi} from '#/api';
import { useVbenVxeGrid } from '#/adapter/vxe-table';
import { getExampleTableApi } from '#/api';
interface RowType {
category: string;
@ -26,12 +26,12 @@ const gridOptions: VxeGridProps<RowType> = {
labelField: 'category',
},
columns: [
{title: '序号', type: 'seq', width: 50},
{field: 'category', sortable: true, title: 'Category'},
{field: 'color', sortable: true, title: 'Color'},
{field: 'productName', sortable: true, title: 'Product Name'},
{field: 'price', sortable: true, title: 'Price'},
{field: 'releaseDate', formatter: 'formatDateTime', title: 'DateTime'},
{ title: '序号', type: 'seq', width: 50 },
{ field: 'category', sortable: true, title: 'Category' },
{ field: 'color', sortable: true, title: 'Color' },
{ field: 'productName', sortable: true, title: 'Product Name' },
{ field: 'price', sortable: true, title: 'Price' },
{ field: 'releaseDate', formatter: 'formatDateTime', title: 'DateTime' },
{
align: 'center',
cellRender: {
@ -61,7 +61,7 @@ const gridOptions: VxeGridProps<RowType> = {
keepSource: true,
proxyConfig: {
ajax: {
query: async ({page, sort}) => {
query: async ({ page, sort }) => {
return await getExampleTableApi({
page: page.currentPage,
pageSize: page.pageSize,
@ -73,7 +73,7 @@ const gridOptions: VxeGridProps<RowType> = {
sort: true,
},
sortConfig: {
defaultSort: {field: 'category', order: 'desc'},
defaultSort: { field: 'category', order: 'desc' },
remote: true,
},
toolbarConfig: {
@ -103,7 +103,7 @@ const [Grid, gridApi] = useVbenVxeGrid({
},
});
function onActionClick({code, row}: OnActionClickParams<RowType>) {
function onActionClick({ code, row }: OnActionClickParams<RowType>) {
switch (code) {
case 'edit': {
onEdit(row);
@ -123,9 +123,9 @@ const editRow = ref<RowType>();
const [Modal, modalApi] = useVbenModal({
draggable: true,
onConfirm: () => {
modalApi.setState({loading: true});
modalApi.setState({ loading: true });
editRow.value && gridApi.markRowAsViewed(editRow.value);
modalApi.setState({loading: false});
modalApi.setState({ loading: false });
modalApi.close();
},
});
@ -149,7 +149,7 @@ function onStyleSet() {
gridApi.setState({
viewedRowOptions: {
rowStyle: () => {
return isStyle.value ? {backgroundColor: 'gray'} : '';
return isStyle.value ? { backgroundColor: 'gray' } : '';
},
},
});