From acd96b3d2ed39642258047c0adbf38a1f4a4f4be Mon Sep 17 00:00:00 2001 From: 07akioni <07akioni2@gmail.com> Date: Fri, 13 Nov 2020 21:40:38 +0800 Subject: [PATCH] docs: deprecate styleScheme & themeEnv --- .../components/config-consumer/enUS/index.demo-entry.md | 2 +- .../config-consumer/enUS/theme-environment.demo.md | 2 +- .../components/config-consumer/zhCN/index.demo-entry.md | 2 +- .../config-consumer/zhCN/theme-environment.demo.md | 2 +- .../components/config-provider/enUS/index.demo-entry.md | 3 +-- .../config-provider/enUS/theme-environment.demo.md | 2 +- .../components/config-provider/zhCN/index.demo-entry.md | 8 ++++---- .../config-provider/zhCN/theme-environment.demo.md | 2 +- .../components/element/enUS/index.demo-entry.md | 2 +- .../components/element/zhCN/index.demo-entry.md | 2 +- 10 files changed, 13 insertions(+), 14 deletions(-) diff --git a/demo/documentation/components/config-consumer/enUS/index.demo-entry.md b/demo/documentation/components/config-consumer/enUS/index.demo-entry.md index 76f80ee7e..59fe66355 100644 --- a/demo/documentation/components/config-consumer/enUS/index.demo-entry.md +++ b/demo/documentation/components/config-consumer/enUS/index.demo-entry.md @@ -16,4 +16,4 @@ color ## Slots |Name|Parameters|Description| |-|-|-| -|default|`(options: { theme: string, namespace: string, language: string, themeEnvironment: any, styleScheme: Object })`|| \ No newline at end of file +|default|`(options: { theme: string, namespace: string, language: string })`|| \ No newline at end of file diff --git a/demo/documentation/components/config-consumer/enUS/theme-environment.demo.md b/demo/documentation/components/config-consumer/enUS/theme-environment.demo.md index 6adf00950..e0d26d9ef 100644 --- a/demo/documentation/components/config-consumer/enUS/theme-environment.demo.md +++ b/demo/documentation/components/config-consumer/enUS/theme-environment.demo.md @@ -1,4 +1,4 @@ -# Theme Environments +# Theme Environments (Deprecated) Get current theme environment. ```html diff --git a/demo/documentation/components/config-consumer/zhCN/index.demo-entry.md b/demo/documentation/components/config-consumer/zhCN/index.demo-entry.md index f89da9368..43b512cfe 100644 --- a/demo/documentation/components/config-consumer/zhCN/index.demo-entry.md +++ b/demo/documentation/components/config-consumer/zhCN/index.demo-entry.md @@ -16,4 +16,4 @@ color ## Slots |名称|参数|说明| |-|-|-| -|default|`(options: { theme: string, namespace: string, language: string, themeEnvironment: any, styleScheme: Object })`|| \ No newline at end of file +|default|`(options: { theme: string, namespace: string, language: string })`|| \ No newline at end of file diff --git a/demo/documentation/components/config-consumer/zhCN/theme-environment.demo.md b/demo/documentation/components/config-consumer/zhCN/theme-environment.demo.md index 19b3f56ab..c8f946568 100644 --- a/demo/documentation/components/config-consumer/zhCN/theme-environment.demo.md +++ b/demo/documentation/components/config-consumer/zhCN/theme-environment.demo.md @@ -1,4 +1,4 @@ -# 主题环境 +# 主题环境(弃用) 获得当前主题环境值。 ```html diff --git a/demo/documentation/components/config-provider/enUS/index.demo-entry.md b/demo/documentation/components/config-provider/enUS/index.demo-entry.md index 6f210b7c3..67935dcfd 100644 --- a/demo/documentation/components/config-provider/enUS/index.demo-entry.md +++ b/demo/documentation/components/config-provider/enUS/index.demo-entry.md @@ -5,10 +5,10 @@ Config Provider is used to set global theme, set global language and set namespa theme namespace inherit-theme -theme-environment os-theme language transparent +theme-environment ``` ## Props |Name|Type|Default|Description| @@ -18,4 +18,3 @@ transparent |language|`string`|`'en-US'`|Language of components inside `n-config-provider`| |namespace|`string`|`undefined`|Class name of detached parts of components inside `n-config-provider`| |theme|`string`|`undefined`|Theme name of components inside `n-config-provider`| -|theme-environments|`{ [themeName: string]: any }`|`undefined`|An object with some value which can be accessed by `n-config-consumer` or `n-element` inside `n-config-provider`| diff --git a/demo/documentation/components/config-provider/enUS/theme-environment.demo.md b/demo/documentation/components/config-provider/enUS/theme-environment.demo.md index acc603685..a4fd281f9 100644 --- a/demo/documentation/components/config-provider/enUS/theme-environment.demo.md +++ b/demo/documentation/components/config-provider/enUS/theme-environment.demo.md @@ -1,4 +1,4 @@ -# Theme Environments +# Theme Environments (Deprecated) Sometimes you may need some component to access some values at specific theme. You can use `theme-environments`. ```html
diff --git a/demo/documentation/components/config-provider/zhCN/index.demo-entry.md b/demo/documentation/components/config-provider/zhCN/index.demo-entry.md index 9ed6b10db..efbba53b1 100644 --- a/demo/documentation/components/config-provider/zhCN/index.demo-entry.md +++ b/demo/documentation/components/config-provider/zhCN/index.demo-entry.md @@ -5,10 +5,10 @@ theme namespace inherit-theme -theme-environment os-theme language transparent +theme-environment ``` ## Props |名称|类型|默认值|说明| @@ -16,7 +16,7 @@ transparent |abstract|`boolean`|`false`|是否不存在 DOM 包裹| |tag|`string`|`'div'`|`n-config-provider` 被渲染成的元素| |language|`string`|`'en-US'`|`n-config-provider` 内部的组件语言| -|namespace|`string`'`undefined`|`n-config-provider` 内部组件被卸载于其他位置的 DOM 的类名| -|theme|`string`'`undefined`|`n-config-provider` 内部组件的主题| -|theme-environments|`{ [themeName: string]: any }`'`undefined`|一个可以被 `n-config-consumer` 或 `n-element` 获取到的主题环境变量,| +|namespace|`string`|`undefined`|`n-config-provider` 内部组件被卸载于其他位置的 DOM 的类名| +|theme|`string`|`undefined`|`n-config-provider` 内部组件的主题| + diff --git a/demo/documentation/components/config-provider/zhCN/theme-environment.demo.md b/demo/documentation/components/config-provider/zhCN/theme-environment.demo.md index e6a9e73a3..a87d23c21 100644 --- a/demo/documentation/components/config-provider/zhCN/theme-environment.demo.md +++ b/demo/documentation/components/config-provider/zhCN/theme-environment.demo.md @@ -1,4 +1,4 @@ -# 主题环境 +# 主题环境(弃用) 你有的时候可能需要让一些组件在特定主题下获取一些值,这个时候你可以设定环境主题。 ```html
diff --git a/demo/documentation/components/element/enUS/index.demo-entry.md b/demo/documentation/components/element/enUS/index.demo-entry.md index 51ec4c89b..25a023609 100644 --- a/demo/documentation/components/element/enUS/index.demo-entry.md +++ b/demo/documentation/components/element/enUS/index.demo-entry.md @@ -15,4 +15,4 @@ color ## Slots |Name|Parameters|Description| |-|-|-| -|default|`(theme: string, namespace: string, themeEnvironment: any, styleScheme: Object)`|| +|default|`(theme: string, namespace: string)`|| diff --git a/demo/documentation/components/element/zhCN/index.demo-entry.md b/demo/documentation/components/element/zhCN/index.demo-entry.md index f8e85f9e5..59fb1e4fa 100644 --- a/demo/documentation/components/element/zhCN/index.demo-entry.md +++ b/demo/documentation/components/element/zhCN/index.demo-entry.md @@ -16,4 +16,4 @@ color ## Slots |名称|参数|说明| |-|-|-| -|default|`(theme: string, namespace: string, themeEnvironment: any, styleScheme: Object)`|| \ No newline at end of file +|default|`(theme: string, namespace: string)`|| \ No newline at end of file