From 966d98ad0ce04fa9884067889f20b87da6f10f1e Mon Sep 17 00:00:00 2001 From: cipchk Date: Sun, 17 Sep 2023 00:05:19 +0800 Subject: [PATCH] docs: update docs --- packages/abc/onboarding/index.en-US.md | 2 +- packages/abc/onboarding/index.zh-CN.md | 2 +- packages/abc/onboarding/onboarding.types.ts | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/packages/abc/onboarding/index.en-US.md b/packages/abc/onboarding/index.en-US.md index d3b70a03a1..deeedfe21e 100644 --- a/packages/abc/onboarding/index.en-US.md +++ b/packages/abc/onboarding/index.en-US.md @@ -25,7 +25,7 @@ The components only support the use of `OnboardingService` service to build. | Property | Description | Type | Default | |----------|-------------|------|---------| -| `[key]` | Storage identification Key | `string` | - | +| `[key]` | Storage identification Key, The default is `localStorage` local storage, allowing the use of `ONBOARDING_STORE_TOKEN` to change the storage method | `string` | - | | `[keyVersion]` | Current version | `unknown` | - | | `[items]` | Onboarding items | `OnboardingItem[]` | `[]` | | `[mask]` | Whether to show mask or not | `boolean` | `true` | diff --git a/packages/abc/onboarding/index.zh-CN.md b/packages/abc/onboarding/index.zh-CN.md index 376e18d2d2..98977770a4 100644 --- a/packages/abc/onboarding/index.zh-CN.md +++ b/packages/abc/onboarding/index.zh-CN.md @@ -25,7 +25,7 @@ module: import { OnboardingModule } from '@delon/abc/onboarding'; | 成员 | 说明 | 类型 | 默认值 | |----|----|----|-----| -| `[key]` | 存储标识Key | `string` | - | +| `[key]` | 存储标识Key;默认 `localStorage` 本地存储,允许使用 `ONBOARDING_STORE_TOKEN` 变更存储方式 | `string` | - | | `[keyVersion]` | 当前版本 | `unknown` | - | | `[items]` | 引导项列表 | `OnboardingItem[]` | `[]` | | `[mask]` | 是否展示遮罩 | `boolean` | `true` | diff --git a/packages/abc/onboarding/onboarding.types.ts b/packages/abc/onboarding/onboarding.types.ts index 2203dd6921..4d9e0db218 100644 --- a/packages/abc/onboarding/onboarding.types.ts +++ b/packages/abc/onboarding/onboarding.types.ts @@ -8,7 +8,7 @@ export type OnboardingOpType = 'next' | 'prev' | 'skip' | 'done'; export interface OnboardingConfig { /** - * Storage identification Key + * Storage identification Key, The default is `localStorage` local storage, allowing the use of `ONBOARDING_STORE_TOKEN` to change the storage method */ key?: string; /**