Skip to content

Commit c37c2b2

Browse files
committed
docs(config-provider): fix cls-prefix description
1 parent 77fb24c commit c37c2b2

File tree

4 files changed

+4
-59
lines changed

4 files changed

+4
-59
lines changed

src/config-provider/demos/enUS/cls-prefix.demo.vue

Lines changed: 0 additions & 26 deletions
This file was deleted.

src/config-provider/demos/enUS/index.demo-entry.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@ For more info about theming, see [Customizing Theme](../docs/customize-theme).
1010
theme.vue
1111
namespace.vue
1212
inherit-theme.vue
13-
cls-prefix.vue
1413
os-theme.vue
1514
language.vue
1615
transparent.vue
@@ -25,14 +24,14 @@ inline-theme-disabled.vue
2524
| --- | --- | --- | --- | --- |
2625
| abstract | `boolean` | `false` | If `n-config-provider` has no wrapper DOM | |
2726
| breakpoints | `{ [k: string]: number }` | `{ xs: 0, s: 640, m: 1024, l: 1280, xl: 1536, xxl: 1920 }` | Responsive breakpoints, it will be used in `n-grid`. The prop is not responsive, you need to set it on its first mount. | |
28-
| cls-prefix | `string` | `undefined` | The class prefix of all inner components. It's applied in the first time. | |
27+
| cls-prefix | `string` | `undefined` | The class prefix of all inner components. (Since `NEXT_VERSION`) If you don't set the `cls-prefix` prop of `n-config-provider`, it will inherit the class prefix from its parent by default. Note that this prop is not reactive. | |
2928
| date-locale | `DateLocale \| null` | `undefined` | The date locale object to be consumed by its child. If set to `null` it will use the default `dateEnUS` locale. If set to `undefined` it will inherit its parent `n-config-provider`. | |
3029
| inline-theme-disabled | `boolean` | `false` | Whether to disabled inline theme CSS variables. If you won't change theme overrides frequently in client side, and need SSR or make devtools looks clear. You can enable the prop. Note that the prop is not responsive. | 2.26.0 |
3130
| katex | `object` | `undefined` | Katex object for `n-equation`. | 2.34.0 |
3231
| locale | `Locale \| null` | `undefined` | The locale object to be consumed by its child. If set to `null` it will use the default `enUS` locale. If set to `undefined` it will inherit its parent `n-config-provider`. | |
3332
| namespace | `string` | `undefined` | Class name of detached parts of components inside `n-config-provider` | |
3433
| preflight-style-disabled | `boolean` | `false` | Whether to disabled preflight style of naive-ui. If you disable it, you can take control of all global css. Also you can use `n-global-style` to apply global style (which is recommend since global style will be reactive). | 2.29.0 |
35-
| style-mount-target | `ParentNode` | `undefined` | Mounting target of style elements of components. | NEXT_VERSION |
34+
| style-mount-target | `ParentNode` | `undefined` | Mounting target of style elements of components. Note that this prop is not reactive. | NEXT_VERSION |
3635
| tag | `string` | `'div'` | What tag `n-config-provider` will be rendered as | |
3736
| theme | `Theme \| null` | `undefined` | The theme object to be consumed by its child. If set to `null` it will use the default light theme. If set to `undefined` it will inherit its parent `n-config-provider`. For more details please see [Customizing Theme](../docs/customize-theme). | |
3837
| theme-overrides | `ThemeOverrides \| null` | `undefined` | The theme vars overrides to be consumed by its child. If set to `null` it will clear all theme vars. If set to `undefined` it will inherit its parent `n-config-provider`. For more details please see [Customizing Theme](../docs/customize-theme). | |

src/config-provider/demos/zhCN/cls-prefix.demo.vue

Lines changed: 0 additions & 27 deletions
This file was deleted.

src/config-provider/demos/zhCN/index.demo-entry.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@
1010
theme.vue
1111
namespace.vue
1212
inherit-theme.vue
13-
cls-prefix.vue
1413
os-theme.vue
1514
language.vue
1615
transparent.vue
@@ -25,14 +24,14 @@ inline-theme-disabled.vue
2524
| --- | --- | --- | --- | --- |
2625
| abstract | `boolean` | `false` | 是否不存在 DOM 包裹 | |
2726
| breakpoints | `{ [k: string]: number }` | `{ xs: 0, s: 640, m: 1024, l: 1280, xl: 1536, xxl: 1920 }` | 屏幕响应式断点,对 `n-grid` 生效。这个属性不是响应式的,你需要在组件第一次挂载时就设定好 | |
28-
| cls-prefix | `string` | `undefined` | 内部所有组件的类的前缀,仅首次设定会生效 | |
27+
| cls-prefix | `string` | `undefined` | 内部所有组件的类的前缀。(从 `NEXT_VERSION` 开始)如果不设置 `n-config-provider` 的类前缀 `cls-prefix`,则默认继承父级的类前缀。注意,该属性不是响应式的。 | |
2928
| date-locale | `DateLocale \| null` | `undefined` | 对后代组件生效的日期语言对象,为 `null` 时会使用默认 `dateEnUS`,为 `undefined` 时会继承上级 `n-config-provider` | |
3029
| inline-theme-disabled | `boolean` | `false` | 是否禁用 inline css 主题变量,如果你不会频繁调整主题变量,并且需要 SSR 或者想让 devtools 看起来更干净,可以打开这个选项。注意,这个属性不是响应式的 | 2.26.0 |
3130
| katex | `object` | `undefined` | 公式组件需要的 katex 对象 | 2.34.0 |
3231
| locale | `Locale \| null` | `undefined` | 对后代组件生效的语言对象,为 `null` 时会使用默认 `enUS`,为 `undefined` 时会继承上级 `n-config-provider` | |
3332
| namespace | `string` | `undefined` | `n-config-provider` 内部组件被卸载于其他位置的 DOM 的类名 | |
3433
| preflight-style-disabled | `boolean` | `false` | 是否禁用默认样式,如果你禁用了它,便可以完全控制全局样式。你也可以使用 `n-global-style` 去挂载全局样式(推荐,样式是响应式的) | 2.29.0 |
35-
| style-mount-target | `ParentNode` | `undefined` | 组件样式的挂载位置 | NEXT_VERSION |
34+
| style-mount-target | `ParentNode` | `undefined` | 组件样式的挂载位置。注意,该属性不是响应式的。 | NEXT_VERSION |
3635
| tag | `string` | `'div'` | `n-config-provider` 被渲染成的元素 | |
3736
| theme | `Theme \| null` | `undefined` | 对后代组件生效的主题对象,为 `null` 时会使用默认亮色,为 `undefined` 时会继承上级 `n-config-provider`。更多信息参见[调整主题](../docs/customize-theme) | |
3837
| theme-overrides | `ThemeOverrides \| null` | `undefined` | 对后代组件生效的主题变量覆盖,为 `null` 时会清除全部覆盖变量,为 `undefined` 时会继承上级 `n-config-provider`。更多信息参见[调整主题](../docs/customize-theme) | |

0 commit comments

Comments
 (0)