docs: deprecate styleScheme & themeEnv

This commit is contained in:
07akioni 2020-11-13 21:40:38 +08:00
parent cf2603e9f4
commit acd96b3d2e
10 changed files with 13 additions and 14 deletions

View File

@ -16,4 +16,4 @@ color
## Slots ## Slots
|Name|Parameters|Description| |Name|Parameters|Description|
|-|-|-| |-|-|-|
|default|`(options: { theme: string, namespace: string, language: string, themeEnvironment: any, styleScheme: Object })`|| |default|`(options: { theme: string, namespace: string, language: string })`||

View File

@ -1,4 +1,4 @@
# Theme Environments # Theme Environments (Deprecated)
Get current theme environment. Get current theme environment.
```html ```html
<n-space vertical> <n-space vertical>

View File

@ -16,4 +16,4 @@ color
## Slots ## Slots
|名称|参数|说明| |名称|参数|说明|
|-|-|-| |-|-|-|
|default|`(options: { theme: string, namespace: string, language: string, themeEnvironment: any, styleScheme: Object })`|| |default|`(options: { theme: string, namespace: string, language: string })`||

View File

@ -1,4 +1,4 @@
# 主题环境 # 主题环境(弃用)
获得当前主题环境值。 获得当前主题环境值。
```html ```html
<n-space vertical> <n-space vertical>

View File

@ -5,10 +5,10 @@ Config Provider is used to set global theme, set global language and set namespa
theme theme
namespace namespace
inherit-theme inherit-theme
theme-environment
os-theme os-theme
language language
transparent transparent
theme-environment
``` ```
## Props ## Props
|Name|Type|Default|Description| |Name|Type|Default|Description|
@ -18,4 +18,3 @@ transparent
|language|`string`|`'en-US'`|Language of components inside `n-config-provider`| |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`| |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|`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`|

View File

@ -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`. Sometimes you may need some component to access some values at specific theme. You can use `theme-environments`.
```html ```html
<div> <div>

View File

@ -5,10 +5,10 @@
theme theme
namespace namespace
inherit-theme inherit-theme
theme-environment
os-theme os-theme
language language
transparent transparent
theme-environment
``` ```
## Props ## Props
|名称|类型|默认值|说明| |名称|类型|默认值|说明|
@ -16,7 +16,7 @@ transparent
|abstract|`boolean`|`false`|是否不存在 DOM 包裹| |abstract|`boolean`|`false`|是否不存在 DOM 包裹|
|tag|`string`|`'div'`|`n-config-provider` 被渲染成的元素| |tag|`string`|`'div'`|`n-config-provider` 被渲染成的元素|
|language|`string`|`'en-US'`|`n-config-provider` 内部的组件语言| |language|`string`|`'en-US'`|`n-config-provider` 内部的组件语言|
|namespace|`string`'`undefined`|`n-config-provider` 内部组件被卸载于其他位置的 DOM 的类名| |namespace|`string`|`undefined`|`n-config-provider` 内部组件被卸载于其他位置的 DOM 的类名|
|theme|`string`'`undefined`|`n-config-provider` 内部组件的主题| |theme|`string`|`undefined`|`n-config-provider` 内部组件的主题|
|theme-environments|`{ [themeName: string]: any }`'`undefined`|一个可以被 `n-config-consumer``n-element` 获取到的主题环境变量,|

View File

@ -1,4 +1,4 @@
# 主题环境 # 主题环境(弃用)
你有的时候可能需要让一些组件在特定主题下获取一些值,这个时候你可以设定环境主题。 你有的时候可能需要让一些组件在特定主题下获取一些值,这个时候你可以设定环境主题。
```html ```html
<div> <div>

View File

@ -15,4 +15,4 @@ color
## Slots ## Slots
|Name|Parameters|Description| |Name|Parameters|Description|
|-|-|-| |-|-|-|
|default|`(theme: string, namespace: string, themeEnvironment: any, styleScheme: Object)`|| |default|`(theme: string, namespace: string)`||

View File

@ -16,4 +16,4 @@ color
## Slots ## Slots
|名称|参数|说明| |名称|参数|说明|
|-|-|-| |-|-|-|
|default|`(theme: string, namespace: string, themeEnvironment: any, styleScheme: Object)`|| |default|`(theme: string, namespace: string)`||