From d2e5f19915773aab7d50e1bc0467155d75b966ca Mon Sep 17 00:00:00 2001 From: unix Date: Wed, 24 Jun 2020 21:01:23 +0800 Subject: [PATCH] docs(snippet): add enum type of APIs --- pages/en-us/components/snippet.mdx | 12 +++++++++++- pages/zh-cn/components/snippet.mdx | 13 +++++++++++++ 2 files changed, 24 insertions(+), 1 deletion(-) diff --git a/pages/en-us/components/snippet.mdx b/pages/en-us/components/snippet.mdx index 137b860..e9a8212 100644 --- a/pages/en-us/components/snippet.mdx +++ b/pages/en-us/components/snippet.mdx @@ -101,7 +101,7 @@ Display a snippet of copyable code for the command line. | **copy** | function of copy button | `CopyTypes` | `'default', 'slient', 'prevent'` | `default` | | **symbol** | symbol snippet | `string` | - | `$` | | **toastText** | toast text | `string` | - | `Copied to clipboard!` | -| **toastType** | toast type | `NormalTypes` | `'default', 'secondary', 'success', 'warning', 'error'` | `success` | +| **toastType** | toast type | `NormalTypes` | [NormalTypes](#normaltypes) | `success` | | ... | native props | `HTMLAttributes` | `'id', 'name', 'className', ...` | - | SnippetTypes @@ -116,6 +116,16 @@ type SnippetTypes = 'default' | 'lite' ``` +NormalTypes + +```ts +type NormalTypes = 'default' + | 'secondary' + | 'success' + | 'warning' + | 'error' +``` + export default ({ children }) => {children} diff --git a/pages/zh-cn/components/snippet.mdx b/pages/zh-cn/components/snippet.mdx index f712766..e8e54d9 100644 --- a/pages/zh-cn/components/snippet.mdx +++ b/pages/zh-cn/components/snippet.mdx @@ -85,6 +85,9 @@ export const meta = { | **filled** | 填充风格的样式 | `boolean` | - | `false` | | **width** | 设置 CSS 宽度 | `string` | - | `initial` | | **copy** | 拷贝按钮的工作方式 | `CopyTypes` | `'default', 'slient', 'prevent'` | `default` | +| **symbol** | 组件左侧显示的字符 | `string` | - | `$` | +| **toastText** | 拷贝提示的字符 | `string` | - | `Copied to clipboard!` | +| **toastType** | 拷贝提示的类型 | `NormalTypes` | [NormalTypes](#normaltypes) | `success` | | ... | 原生属性 | `HTMLAttributes` | `'id', 'name', 'className', ...` | - | SnippetTypes @@ -99,6 +102,16 @@ type SnippetTypes = 'default' | 'lite' ``` +NormalTypes + +```ts +type NormalTypes = 'default' + | 'secondary' + | 'success' + | 'warning' + | 'error' +``` + export default ({ children }) => {children}