diff --git a/docs/markdown/theme.en-US.md b/docs/markdown/theme.en-US.md index 1082eb564..59da82e69 100644 --- a/docs/markdown/theme.en-US.md +++ b/docs/markdown/theme.en-US.md @@ -2,21 +2,81 @@ ### Intro -Vant provides a set of default themes, if you want to custom the theme color or other styles, you can use the following methods: +Vant use [Less](http://lesscss.org/) as css preprocessor,you can override the default less variables to custom theme. ### Less variables -Vant use [Less](http://lesscss.org/) as css preprocessor,you can modify less variables to custom theme. - There are some basic variables below, all available variables could be found in [var.less](https://github.com/youzan/vant/blob/dev/src/style/var.less)。 ```less +// Color Palette +@black: #000; +@white: #fff; +@gray-1: #f7f8fa; +@gray-2: #f2f3f5; +@gray-3: #ebedf0; +@gray-4: #dcdee0; +@gray-5: #c8c9cc; +@gray-6: #969799; +@gray-7: #646566; +@gray-8: #323233; +@red: #ee0a24; +@blue: #1989fa; +@orange: #ff976a; +@orange-dark: #ed6a0c; +@orange-light: #fffbe8; +@green: #07c160; + +// Gradient Colors +@gradient-red: linear-gradient(to right, #ff6034, #ee0a24); +@gradient-orange: linear-gradient(to right, #ffd01e, #ff8917); + // Component Colors -@text-color: #323233; -@border-color: #ebedf0; -@active-color: #f2f3f5; -@background-color: #f7f8fa; +@text-color: @gray-8; +@active-color: @gray-2; +@active-opacity: 0.7; +@disabled-opacity: 0.5; +@background-color: @gray-1; @background-color-light: #fafafa; +@text-link-color: #576b95; + +// Padding +@padding-base: 4px; +@padding-xs: @padding-base * 2; +@padding-sm: @padding-base * 3; +@padding-md: @padding-base * 4; +@padding-lg: @padding-base * 6; +@padding-xl: @padding-base * 8; + +// Font +@font-size-xs: 10px; +@font-size-sm: 12px; +@font-size-md: 14px; +@font-size-lg: 16px; +@font-weight-bold: 500; +@line-height-xs: 14px; +@line-height-sm: 18px; +@line-height-md: 20px; +@line-height-lg: 22px; +@base-font-family: -apple-system, BlinkMacSystemFont, 'Helvetica Neue', + Helvetica, Segoe UI, Arial, Roboto, 'PingFang SC', 'miui', 'Hiragino Sans GB', + 'Microsoft Yahei', sans-serif; +@price-integer-font-family: Avenir-Heavy, PingFang SC, Helvetica Neue, Arial, + sans-serif; + +// Animation +@animation-duration-base: 0.3s; +@animation-duration-fast: 0.2s; +@animation-timing-function-enter: ease-out; +@animation-timing-function-leave: ease-in; + +// Border +@border-color: @gray-3; +@border-width-base: 1px; +@border-radius-sm: 2px; +@border-radius-md: 4px; +@border-radius-lg: 8px; +@border-radius-max: 999px; ``` ## How to custom theme diff --git a/docs/markdown/theme.zh-CN.md b/docs/markdown/theme.zh-CN.md index bc62ba87f..493423fc3 100644 --- a/docs/markdown/theme.zh-CN.md +++ b/docs/markdown/theme.zh-CN.md @@ -2,7 +2,7 @@ ### 介绍 -Vant 提供了一套默认主题,CSS 命名采用 BEM 的风格,方便使用者覆盖样式。如果你想完全替换主题色或者其他样式,可以使用下面提供的方法。 +Vant 提供了一套默认主题,CSS 命名采用 BEM 的风格,方便使用者覆盖样式。如果你想完全替换主题色或者其他样式,可以按照本文档进行主题定制。 ### 示例工程 @@ -12,15 +12,77 @@ Vant 提供了一套默认主题,CSS 命名采用 BEM 的风格,方便使用 Vant 使用了 [Less](http://lesscss.org/) 对样式进行预处理,并内置了一些样式变量,通过替换样式变量即可定制你自己需要的主题。 -下面是一些基本的样式变量,所有可用的颜色变量请参考 [配置文件](https://github.com/youzan/vant/blob/dev/src/style/var.less)。 +下面是所有的基础样式变量,组件的颜色变量请参考各个组件的文档或[配置文件](https://github.com/youzan/vant/blob/dev/src/style/var.less)。 ```less +// Color Palette +@black: #000; +@white: #fff; +@gray-1: #f7f8fa; +@gray-2: #f2f3f5; +@gray-3: #ebedf0; +@gray-4: #dcdee0; +@gray-5: #c8c9cc; +@gray-6: #969799; +@gray-7: #646566; +@gray-8: #323233; +@red: #ee0a24; +@blue: #1989fa; +@orange: #ff976a; +@orange-dark: #ed6a0c; +@orange-light: #fffbe8; +@green: #07c160; + +// Gradient Colors +@gradient-red: linear-gradient(to right, #ff6034, #ee0a24); +@gradient-orange: linear-gradient(to right, #ffd01e, #ff8917); + // Component Colors -@text-color: #323233; -@border-color: #ebedf0; -@active-color: #f2f3f5; -@background-color: #f7f8fa; +@text-color: @gray-8; +@active-color: @gray-2; +@active-opacity: 0.7; +@disabled-opacity: 0.5; +@background-color: @gray-1; @background-color-light: #fafafa; +@text-link-color: #576b95; + +// Padding +@padding-base: 4px; +@padding-xs: @padding-base * 2; +@padding-sm: @padding-base * 3; +@padding-md: @padding-base * 4; +@padding-lg: @padding-base * 6; +@padding-xl: @padding-base * 8; + +// Font +@font-size-xs: 10px; +@font-size-sm: 12px; +@font-size-md: 14px; +@font-size-lg: 16px; +@font-weight-bold: 500; +@line-height-xs: 14px; +@line-height-sm: 18px; +@line-height-md: 20px; +@line-height-lg: 22px; +@base-font-family: -apple-system, BlinkMacSystemFont, 'Helvetica Neue', + Helvetica, Segoe UI, Arial, Roboto, 'PingFang SC', 'miui', 'Hiragino Sans GB', + 'Microsoft Yahei', sans-serif; +@price-integer-font-family: Avenir-Heavy, PingFang SC, Helvetica Neue, Arial, + sans-serif; + +// Animation +@animation-duration-base: 0.3s; +@animation-duration-fast: 0.2s; +@animation-timing-function-enter: ease-out; +@animation-timing-function-leave: ease-in; + +// Border +@border-color: @gray-3; +@border-width-base: 1px; +@border-radius-sm: 2px; +@border-radius-md: 4px; +@border-radius-lg: 8px; +@border-radius-max: 999px; ``` ## 定制方法 diff --git a/src/action-bar/README.md b/src/action-bar/README.md index da8d84b75..06531f5e7 100644 --- a/src/action-bar/README.md +++ b/src/action-bar/README.md @@ -126,3 +126,22 @@ Use `badge` prop to show badge in icon. | Name | Description | | ------- | -------------- | | default | Button content | + +### Less Variables + +How to use: [Custom Theme](#/en-US/theme). + +| Name | Default Value | Description | +| ---------------------------------- | ------------------ | ----------- | +| @goods-action-background-color | `@white` | - | +| @goods-action-height | `50px` | - | +| @goods-action-icon-width | `48px` | - | +| @goods-action-icon-height | `100%` | - | +| @goods-action-icon-color | `@text-color` | - | +| @goods-action-icon-size | `18px` | - | +| @goods-action-icon-font-size | `@font-size-xs` | - | +| @goods-action-icon-active-color | `@active-color` | - | +| @goods-action-icon-text-color | `@gray-7` | - | +| @goods-action-button-height | `40px` | - | +| @goods-action-button-warning-color | `@gradient-orange` | - | +| @goods-action-button-danger-color | `@gradient-red` | - | diff --git a/src/action-bar/README.zh-CN.md b/src/action-bar/README.zh-CN.md index e7d04c2a3..0beee6698 100644 --- a/src/action-bar/README.zh-CN.md +++ b/src/action-bar/README.zh-CN.md @@ -106,7 +106,7 @@ export default { ### ActionBarButton Props | 参数 | 说明 | 类型 | 默认值 | -| --- | --- | --- | --- | +| --- | --- | --- | --- | --- | | text | 按钮文字 | _string_ | - | | type | 按钮类型,可选值为 `primary` `info` `warning` `danger` | _string_ | `default` | | color | 按钮颜色,支持传入`linear-gradient`渐变色 | _string_ | - | @@ -129,3 +129,22 @@ export default { | 名称 | 说明 | | ------- | ------------ | | default | 按钮显示内容 | + +### 样式变量 + +组件提供了下列 Less 变量,可用于自定义样式,使用方法请参考[主题定制](#/zh-CN/theme)。 + +| 名称 | 默认值 | 描述 | +| ---------------------------------- | ------------------ | ---- | +| @goods-action-background-color | `@white` | - | +| @goods-action-height | `50px` | - | +| @goods-action-icon-width | `48px` | - | +| @goods-action-icon-height | `100%` | - | +| @goods-action-icon-color | `@text-color` | - | +| @goods-action-icon-size | `18px` | - | +| @goods-action-icon-font-size | `@font-size-xs` | - | +| @goods-action-icon-active-color | `@active-color` | - | +| @goods-action-icon-text-color | `@gray-7` | - | +| @goods-action-button-height | `40px` | - | +| @goods-action-button-warning-color | `@gradient-orange` | - | +| @goods-action-button-danger-color | `@gradient-red` | - | diff --git a/src/action-sheet/README.md b/src/action-sheet/README.md index 1aea3105c..e96e4d4bd 100644 --- a/src/action-sheet/README.md +++ b/src/action-sheet/README.md @@ -198,3 +198,32 @@ export default { | --------------------- | ------------------ | | default | Custom content | | description `v2.10.4` | Custom description | + +### Less Variables + +How to use: [Custom Theme](#/en-US/theme). + +| Name | Default Value | Description | +| -------------------------------------- | ------------------- | ----------- | +| @action-sheet-max-height | `80%` | - | +| @action-sheet-header-height | `48px` | - | +| @action-sheet-header-font-size | `@font-size-lg` | - | +| @action-sheet-description-color | `@gray-6` | - | +| @action-sheet-description-font-size | `@font-size-md` | - | +| @action-sheet-description-line-height | `@line-height-md` | - | +| @action-sheet-item-background | `@white` | - | +| @action-sheet-item-font-size | `@font-size-lg` | - | +| @action-sheet-item-line-height | `@line-height-lg` | - | +| @action-sheet-item-text-color | `@text-color` | - | +| @action-sheet-item-disabled-text-color | `@gray-5` | - | +| @action-sheet-subname-color | `@gray-6` | - | +| @action-sheet-subname-font-size | `@font-size-sm` | - | +| @action-sheet-subname-line-height | `@line-height-sm` | - | +| @action-sheet-close-icon-size | `22px` | - | +| @action-sheet-close-icon-color | `@gray-5` | - | +| @action-sheet-close-icon-active-color | `@gray-6` | - | +| @action-sheet-close-icon-padding | `0 @padding-md` | - | +| @action-sheet-cancel-text-color | `@gray-7` | - | +| @action-sheet-cancel-padding-top | `@padding-xs` | - | +| @action-sheet-cancel-padding-color | `@background-color` | - | +| @action-sheet-loading-icon-size | `22px` | - | diff --git a/src/action-sheet/README.zh-CN.md b/src/action-sheet/README.zh-CN.md index 2fc01ebfa..278d5e5b1 100644 --- a/src/action-sheet/README.zh-CN.md +++ b/src/action-sheet/README.zh-CN.md @@ -207,6 +207,35 @@ export default { | default | 自定义面板的展示内容 | | description `v2.10.4` | 自定义描述文案 | +### 样式变量 + +组件提供了下列 Less 变量,可用于自定义样式,使用方法请参考[主题定制](#/zh-CN/theme)。 + +| 名称 | 默认值 | 描述 | +| -------------------------------------- | ------------------- | ---- | +| @action-sheet-max-height | `80%` | - | +| @action-sheet-header-height | `48px` | - | +| @action-sheet-header-font-size | `@font-size-lg` | - | +| @action-sheet-description-color | `@gray-6` | - | +| @action-sheet-description-font-size | `@font-size-md` | - | +| @action-sheet-description-line-height | `@line-height-md` | - | +| @action-sheet-item-background | `@white` | - | +| @action-sheet-item-font-size | `@font-size-lg` | - | +| @action-sheet-item-line-height | `@line-height-lg` | - | +| @action-sheet-item-text-color | `@text-color` | - | +| @action-sheet-item-disabled-text-color | `@gray-5` | - | +| @action-sheet-subname-color | `@gray-6` | - | +| @action-sheet-subname-font-size | `@font-size-sm` | - | +| @action-sheet-subname-line-height | `@line-height-sm` | - | +| @action-sheet-close-icon-size | `22px` | - | +| @action-sheet-close-icon-color | `@gray-5` | - | +| @action-sheet-close-icon-active-color | `@gray-6` | - | +| @action-sheet-close-icon-padding | `0 @padding-md` | - | +| @action-sheet-cancel-text-color | `@gray-7` | - | +| @action-sheet-cancel-padding-top | `@padding-xs` | - | +| @action-sheet-cancel-padding-color | `@background-color` | - | +| @action-sheet-loading-icon-size | `22px` | - | + ## 常见问题 ### 引入时提示 dependencies not found? diff --git a/src/address-edit/README.md b/src/address-edit/README.md index 604e097cd..ecbca56f9 100644 --- a/src/address-edit/README.md +++ b/src/address-edit/README.md @@ -144,3 +144,15 @@ Use [ref](https://v3.vuejs.org/guide/component-template-refs.html) to get Addres ### Area Data Structure Please refer to [Area](#/en-US/area) component。 + +### Less Variables + +How to use: [Custom Theme](#/en-US/theme). + +| Name | Default Value | Description | +| --- | --- | --- | +| @address-edit-padding | `@padding-sm` | - | +| @address-edit-buttons-padding | `@padding-xl @padding-base` | - | +| @address-edit-button-margin-bottom | `@padding-sm` | - | +| @address-edit-detail-finish-color | `@blue` | - | +| @address-edit-detail-finish-font-size | `@font-size-sm` | - | diff --git a/src/address-edit/README.zh-CN.md b/src/address-edit/README.zh-CN.md index 808c85417..d1accc9ec 100644 --- a/src/address-edit/README.zh-CN.md +++ b/src/address-edit/README.zh-CN.md @@ -150,3 +150,15 @@ export default { ### 省市县列表数据格式 请参考 [Area](#/zh-CN/area) 组件。 + +### 样式变量 + +组件提供了下列 Less 变量,可用于自定义样式,使用方法请参考[主题定制](#/zh-CN/theme)。 + +| 名称 | 默认值 | 描述 | +| ------------------------------------- | --------------------------- | ---- | +| @address-edit-padding | `@padding-sm` | - | +| @address-edit-buttons-padding | `@padding-xl @padding-base` | - | +| @address-edit-button-margin-bottom | `@padding-sm` | - | +| @address-edit-detail-finish-color | `@blue` | - | +| @address-edit-detail-finish-font-size | `@font-size-sm` | - | diff --git a/src/address-list/README.md b/src/address-list/README.md index a7e36a2bb..c4b41a5cb 100644 --- a/src/address-list/README.md +++ b/src/address-list/README.md @@ -111,3 +111,23 @@ export default { | default | Custom content after list | - | | top | Custom content before list | - | | item-bottom `v2.5.0` | Custom content after list item | item | + +### Less Variables + +How to use: [Custom Theme](#/en-US/theme). + +| Name | Default Value | Description | +| --- | --- | --- | +| @address-list-padding | `@padding-sm @padding-sm 80px` | - | +| @address-list-disabled-text-color | `@gray-6` | - | +| @address-list-disabled-text-padding | `@padding-base * 5 0 @padding-md` | - | +| @address-list-disabled-text-font-size | `@font-size-md` | - | +| @address-list-disabled-text-line-height | `@line-height-md` | - | +| @address-list-add-button-z-index | `999` | - | +| @address-list-item-padding | `@padding-sm` | - | +| @address-list-item-text-color | `@text-color` | - | +| @address-list-item-disabled-text-color | `@gray-5` | - | +| @address-list-item-font-size | `13px` | - | +| @address-list-item-line-height | `@line-height-sm` | - | +| @address-list-item-radio-icon-color | `@red` | - | +| @address-list-edit-icon-size | `20px` | - | diff --git a/src/address-list/README.zh-CN.md b/src/address-list/README.zh-CN.md index a6fff4fae..6497de187 100644 --- a/src/address-list/README.zh-CN.md +++ b/src/address-list/README.zh-CN.md @@ -115,3 +115,23 @@ export default { | default | 在列表下方插入内容 | - | | top | 在顶部插入内容 | - | | item-bottom `v2.5.0` | 在列表项底部插入内容 | 列表项的值 | + +### 样式变量 + +组件提供了下列 Less 变量,可用于自定义样式,使用方法请参考[主题定制](#/zh-CN/theme)。 + +| 名称 | 默认值 | 描述 | +| --- | --- | --- | +| @address-list-padding | `@padding-sm @padding-sm 80px` | - | +| @address-list-disabled-text-color | `@gray-6` | - | +| @address-list-disabled-text-padding | `@padding-base * 5 0 @padding-md` | - | +| @address-list-disabled-text-font-size | `@font-size-md` | - | +| @address-list-disabled-text-line-height | `@line-height-md` | - | +| @address-list-add-button-z-index | `999` | - | +| @address-list-item-padding | `@padding-sm` | - | +| @address-list-item-text-color | `@text-color` | - | +| @address-list-item-disabled-text-color | `@gray-5` | - | +| @address-list-item-font-size | `13px` | - | +| @address-list-item-line-height | `@line-height-sm` | - | +| @address-list-item-radio-icon-color | `@red` | - | +| @address-list-edit-icon-size | `20px` | - | diff --git a/src/badge/README.md b/src/badge/README.md index 6cc4b3e63..afe329436 100644 --- a/src/badge/README.md +++ b/src/badge/README.md @@ -76,3 +76,20 @@ app.use(Badge); | Name | Description | | ------- | ------------ | | default | Default slot | + +### Less Variables + +How to use: [Custom Theme](#/en-US/theme). + +| Name | Default Value | Description | +| --- | --- | --- | +| @badge-size | `16px` | - | +| @badge-color | `@white` | - | +| @badge-padding | `0 3px` | - | +| @badge-font-size | `@font-size-sm` | - | +| @badge-font-weight | `@font-weight-bold` | - | +| @badge-border-width | `@border-width-base` | - | +| @badge-background-color | `@red` | - | +| @badge-dot-color | `@red` | - | +| @badge-dot-size | `8px` | - | +| @badge-font-family | `-apple-system-font, Helvetica Neue, Arial, sans-serif` | - | diff --git a/src/badge/README.zh-CN.md b/src/badge/README.zh-CN.md index 0bea13e48..fee1ce4e3 100644 --- a/src/badge/README.zh-CN.md +++ b/src/badge/README.zh-CN.md @@ -89,3 +89,20 @@ app.use(Badge); | ------- | ---------------- | | default | 徽标包裹的子元素 | | content | 自定义徽标内容 | + +### 样式变量 + +组件提供了下列 Less 变量,可用于自定义样式,使用方法请参考[主题定制](#/zh-CN/theme)。 + +| 名称 | 默认值 | 描述 | +| --- | --- | --- | +| @badge-size | `16px` | - | +| @badge-color | `@white` | - | +| @badge-padding | `0 3px` | - | +| @badge-font-size | `@font-size-sm` | - | +| @badge-font-weight | `@font-weight-bold` | - | +| @badge-border-width | `@border-width-base` | - | +| @badge-background-color | `@red` | - | +| @badge-dot-color | `@red` | - | +| @badge-dot-size | `8px` | - | +| @badge-font-family | `-apple-system-font, Helvetica Neue, Arial, sans-serif` | - | diff --git a/src/badge/index.js b/src/badge/index.js new file mode 100644 index 000000000..652e5184b --- /dev/null +++ b/src/badge/index.js @@ -0,0 +1,69 @@ +import { isDef, createNamespace } from '../utils'; +import { isNumeric } from '../utils/validate/number'; + +const [createComponent, bem] = createNamespace('badge'); + +export default createComponent({ + props: { + dot: Boolean, + max: [Number, String], + color: String, + content: [Number, String], + tag: { + type: String, + default: 'div', + }, + }, + + methods: { + hasContent() { + return !!( + this.$scopedSlots.content || + (isDef(this.content) && this.content !== '') + ); + }, + + renderContent() { + const { dot, max, content } = this; + + if (!dot && this.hasContent()) { + if (this.$scopedSlots.content) { + return this.$scopedSlots.content(); + } + + if (isDef(max) && isNumeric(content) && +content > max) { + return `${max}+`; + } + + return content; + } + }, + + renderBadge() { + if (this.hasContent() || this.dot) { + return ( +
+ {this.renderContent()} +
+ ); + } + }, + }, + + render() { + if (this.$scopedSlots.default) { + const { tag } = this; + return ( + + {this.$scopedSlots.default()} + {this.renderBadge()} + + ); + } + + return this.renderBadge(); + }, +}); diff --git a/src/button/README.md b/src/button/README.md index 757cf942c..7a2ad1edd 100644 --- a/src/button/README.md +++ b/src/button/README.md @@ -141,3 +141,39 @@ app.use(Button); | ----------------- | ------------------- | | default | Default slot | | loading `v2.10.1` | Custom loading icon | + +### Less Variables + +How to use: [Custom Theme](#/en-US/theme). + +| Name | Default Value | Description | +| -------------------------------- | -------------------- | ----------- | +| @button-mini-height | `24px` | - | +| @button-mini-font-size | `@font-size-xs` | - | +| @button-small-height | `32px` | - | +| @button-small-font-size | `@font-size-sm` | - | +| @button-normal-font-size | `@font-size-md` | - | +| @button-large-height | `50px` | - | +| @button-default-height | `44px` | - | +| @button-default-line-height | `1.2` | - | +| @button-default-font-size | `@font-size-lg` | - | +| @button-default-color | `@text-color` | - | +| @button-default-background-color | `@white` | - | +| @button-default-border-color | `@border-color` | - | +| @button-primary-color | `@white` | - | +| @button-primary-background-color | `@green` | - | +| @button-primary-border-color | `@green` | - | +| @button-info-color | `@white` | - | +| @button-info-background-color | `@blue` | - | +| @button-info-border-color | `@blue` | - | +| @button-danger-color | `@white` | - | +| @button-danger-background-color | `@red` | - | +| @button-danger-border-color | `@red` | - | +| @button-warning-color | `@white` | - | +| @button-warning-background-color | `@orange` | - | +| @button-warning-border-color | `@orange` | - | +| @button-border-width | `@border-width-base` | - | +| @button-border-radius | `@border-radius-sm` | - | +| @button-round-border-radius | `@border-radius-max` | - | +| @button-plain-background-color | `@white` | - | +| @button-disabled-opacity | `@disabled-opacity` | - | diff --git a/src/button/README.zh-CN.md b/src/button/README.zh-CN.md index c65973976..a1485ac3a 100644 --- a/src/button/README.zh-CN.md +++ b/src/button/README.zh-CN.md @@ -168,3 +168,39 @@ app.use(Button); | ----------------- | -------------- | | default | 按钮内容 | | loading `v2.10.1` | 自定义加载图标 | + +### 样式变量 + +组件提供了下列 Less 变量,可用于自定义样式,使用方法请参考[主题定制](#/zh-CN/theme)。 + +| 名称 | 默认值 | 描述 | +| -------------------------------- | -------------------- | ---- | +| @button-mini-height | `24px` | - | +| @button-mini-font-size | `@font-size-xs` | - | +| @button-small-height | `32px` | - | +| @button-small-font-size | `@font-size-sm` | - | +| @button-normal-font-size | `@font-size-md` | - | +| @button-large-height | `50px` | - | +| @button-default-height | `44px` | - | +| @button-default-line-height | `1.2` | - | +| @button-default-font-size | `@font-size-lg` | - | +| @button-default-color | `@text-color` | - | +| @button-default-background-color | `@white` | - | +| @button-default-border-color | `@border-color` | - | +| @button-primary-color | `@white` | - | +| @button-primary-background-color | `@green` | - | +| @button-primary-border-color | `@green` | - | +| @button-info-color | `@white` | - | +| @button-info-background-color | `@blue` | - | +| @button-info-border-color | `@blue` | - | +| @button-danger-color | `@white` | - | +| @button-danger-background-color | `@red` | - | +| @button-danger-border-color | `@red` | - | +| @button-warning-color | `@white` | - | +| @button-warning-background-color | `@orange` | - | +| @button-warning-border-color | `@orange` | - | +| @button-border-width | `@border-width-base` | - | +| @button-border-radius | `@border-radius-sm` | - | +| @button-round-border-radius | `@border-radius-max` | - | +| @button-plain-background-color | `@white` | - | +| @button-disabled-opacity | `@disabled-opacity` | - | diff --git a/src/calendar/README.md b/src/calendar/README.md index e9507db14..9a8ad000c 100644 --- a/src/calendar/README.md +++ b/src/calendar/README.md @@ -318,3 +318,35 @@ Use [ref](https://v3.vuejs.org/guide/component-template-refs.html) to get Calend | Name | Description | Attribute | Return value | | ----- | ----------------------------------- | --------- | ------------ | | reset | Reset selected date to default date | - | - | + +### Less Variables + +How to use: [Custom Theme](#/en-US/theme). + +| Name | Default Value | Description | +| --- | --- | --- | +| @calendar-background-color | `@white` | - | +| @calendar-popup-height | `80%` | - | +| @calendar-header-box-shadow | `0 2px 10px rgba(125, 126, 128, 0.16)` | - | +| @calendar-header-title-height | `44px` | - | +| @calendar-header-title-font-size | `@font-size-lg` | - | +| @calendar-header-subtitle-font-size | `@font-size-md` | - | +| @calendar-weekdays-height | `30px` | - | +| @calendar-weekdays-font-size | `@font-size-sm` | - | +| @calendar-month-title-font-size | `@font-size-md` | - | +| @calendar-month-mark-color | `fade(@gray-2, 80%)` | - | +| @calendar-month-mark-font-size | `160px` | - | +| @calendar-day-height | `64px` | - | +| @calendar-day-font-size | `@font-size-lg` | - | +| @calendar-range-edge-color | `@white` | - | +| @calendar-range-edge-background-color | `@red` | - | +| @calendar-range-middle-color | `@red` | - | +| @calendar-range-middle-background-opacity | `0.1` | - | +| @calendar-selected-day-size | `54px` | - | +| @calendar-selected-day-color | `@white` | - | +| @calendar-info-font-size | `@font-size-xs` | - | +| @calendar-info-line-height | `@line-height-xs` | - | +| @calendar-selected-day-background-color | `@red` | - | +| @calendar-day-disabled-color | `@gray-5` | - | +| @calendar-confirm-button-height | `36px` | - | +| @calendar-confirm-button-margin | `7px 0` | - | diff --git a/src/calendar/README.zh-CN.md b/src/calendar/README.zh-CN.md index 9fa9f6aff..1de8333b6 100644 --- a/src/calendar/README.zh-CN.md +++ b/src/calendar/README.zh-CN.md @@ -323,6 +323,38 @@ export default { | ------ | ---------------------- | ---- | ------ | | reset | 重置选中的日期到默认值 | - | - | +### 样式变量 + +组件提供了下列 Less 变量,可用于自定义样式,使用方法请参考[主题定制](#/zh-CN/theme)。 + +| 名称 | 默认值 | 描述 | +| --- | --- | --- | +| @calendar-background-color | `@white` | - | +| @calendar-popup-height | `80%` | - | +| @calendar-header-box-shadow | `0 2px 10px rgba(125, 126, 128, 0.16)` | - | +| @calendar-header-title-height | `44px` | - | +| @calendar-header-title-font-size | `@font-size-lg` | - | +| @calendar-header-subtitle-font-size | `@font-size-md` | - | +| @calendar-weekdays-height | `30px` | - | +| @calendar-weekdays-font-size | `@font-size-sm` | - | +| @calendar-month-title-font-size | `@font-size-md` | - | +| @calendar-month-mark-color | `fade(@gray-2, 80%)` | - | +| @calendar-month-mark-font-size | `160px` | - | +| @calendar-day-height | `64px` | - | +| @calendar-day-font-size | `@font-size-lg` | - | +| @calendar-range-edge-color | `@white` | - | +| @calendar-range-edge-background-color | `@red` | - | +| @calendar-range-middle-color | `@red` | - | +| @calendar-range-middle-background-opacity | `0.1` | - | +| @calendar-selected-day-size | `54px` | - | +| @calendar-selected-day-color | `@white` | - | +| @calendar-info-font-size | `@font-size-xs` | - | +| @calendar-info-line-height | `@line-height-xs` | - | +| @calendar-selected-day-background-color | `@red` | - | +| @calendar-day-disabled-color | `@gray-5` | - | +| @calendar-confirm-button-height | `36px` | - | +| @calendar-confirm-button-margin | `7px 0` | - | + ## 常见问题 ### 在 iOS 系统上初始化组件失败? diff --git a/src/card/README.md b/src/card/README.md index d88984a32..df2985f85 100644 --- a/src/card/README.md +++ b/src/card/README.md @@ -101,3 +101,26 @@ Use slot to custom content. | tag | Custom thumb tag | | tags | Custom tags | | footer | Custom footer | + +### Less Variables + +How to use: [Custom Theme](#/en-US/theme). + +| Name | Default Value | Description | +| ----------------------------- | ---------------------------- | ----------- | +| @card-padding | `@padding-xs @padding-md` | - | +| @card-font-size | `@font-size-sm` | - | +| @card-text-color | `@text-color` | - | +| @card-background-color | `@background-color-light` | - | +| @card-thumb-size | `88px` | - | +| @card-thumb-border-radius | `@border-radius-lg` | - | +| @card-title-line-height | `16px` | - | +| @card-desc-color | `@gray-7` | - | +| @card-desc-line-height | `@line-height-md` | - | +| @card-price-color | `@gray-8` | - | +| @card-origin-price-color | `@gray-6` | - | +| @card-num-color | `@gray-6` | - | +| @card-origin-price-font-size | `@font-size-xs` | - | +| @card-price-font-size | `@font-size-sm` | - | +| @card-price-integer-font-size | `@font-size-lg` | - | +| @card-price-font-family | `@price-integer-font-family` | - | diff --git a/src/card/README.zh-CN.md b/src/card/README.zh-CN.md index ad2bf8a9b..7d1ffcba7 100644 --- a/src/card/README.zh-CN.md +++ b/src/card/README.zh-CN.md @@ -107,3 +107,26 @@ app.use(Card); | tag | 自定义图片角标 | | tags | 自定义描述下方标签区域 | | footer | 自定义右下角内容 | + +### 样式变量 + +组件提供了下列 Less 变量,可用于自定义样式,使用方法请参考[主题定制](#/zh-CN/theme)。 + +| 名称 | 默认值 | 描述 | +| ----------------------------- | ---------------------------- | ---- | +| @card-padding | `@padding-xs @padding-md` | - | +| @card-font-size | `@font-size-sm` | - | +| @card-text-color | `@text-color` | - | +| @card-background-color | `@background-color-light` | - | +| @card-thumb-size | `88px` | - | +| @card-thumb-border-radius | `@border-radius-lg` | - | +| @card-title-line-height | `16px` | - | +| @card-desc-color | `@gray-7` | - | +| @card-desc-line-height | `@line-height-md` | - | +| @card-price-color | `@gray-8` | - | +| @card-origin-price-color | `@gray-6` | - | +| @card-num-color | `@gray-6` | - | +| @card-origin-price-font-size | `@font-size-xs` | - | +| @card-price-font-size | `@font-size-sm` | - | +| @card-price-integer-font-size | `@font-size-lg` | - | +| @card-price-font-family | `@price-integer-font-family` | - | diff --git a/src/cell/README.md b/src/cell/README.md index 2450709e1..aefcedff0 100644 --- a/src/cell/README.md +++ b/src/cell/README.md @@ -175,3 +175,34 @@ app.use(CellGroup); | label | Custom label | | right-icon | Custom right icon | | extra | Custom extra content on the right | + +### Less Variables + +How to use: [Custom Theme](#/en-US/theme). + +| Name | Default Value | Description | +| --- | --- | --- | +| @cell-font-size | `@font-size-md` | - | +| @cell-line-height | `24px` | - | +| @cell-vertical-padding | `10px` | - | +| @cell-horizontal-padding | `@padding-md` | - | +| @cell-text-color | `@text-color` | - | +| @cell-background-color | `@white` | - | +| @cell-border-color | `@border-color` | - | +| @cell-active-color | `@active-color` | - | +| @cell-required-color | `@red` | - | +| @cell-label-color | `@gray-6` | - | +| @cell-label-font-size | `@font-size-sm` | - | +| @cell-label-line-height | `@line-height-sm` | - | +| @cell-label-margin-top | `@padding-base` | - | +| @cell-value-color | `@gray-6` | - | +| @cell-icon-size | `16px` | - | +| @cell-right-icon-color | `@gray-6` | - | +| @cell-large-vertical-padding | `@padding-sm` | - | +| @cell-large-title-font-size | `@font-size-lg` | - | +| @cell-large-label-font-size | `@font-size-md` | - | +| @cell-group-background-color | `@white` | - | +| @cell-group-title-color | `@gray-6` | - | +| @cell-group-title-padding | `@padding-md @padding-md @padding-xs` | - | +| @cell-group-title-font-size | `@font-size-md` | - | +| @cell-group-title-line-height | `16px` | - | diff --git a/src/cell/README.zh-CN.md b/src/cell/README.zh-CN.md index 220f2427d..a313b0775 100644 --- a/src/cell/README.zh-CN.md +++ b/src/cell/README.zh-CN.md @@ -182,3 +182,34 @@ app.use(CellGroup); | icon | 自定义左侧图标 | | right-icon | 自定义右侧按钮,默认为`arrow` | | extra | 自定义单元格最右侧的额外内容 | + +### 样式变量 + +组件提供了下列 Less 变量,可用于自定义样式,使用方法请参考[主题定制](#/zh-CN/theme)。 + +| 名称 | 默认值 | 描述 | +| ----------------------------- | ------------------------------------- | ---- | +| @cell-font-size | `@font-size-md` | - | +| @cell-line-height | `24px` | - | +| @cell-vertical-padding | `10px` | - | +| @cell-horizontal-padding | `@padding-md` | - | +| @cell-text-color | `@text-color` | - | +| @cell-background-color | `@white` | - | +| @cell-border-color | `@border-color` | - | +| @cell-active-color | `@active-color` | - | +| @cell-required-color | `@red` | - | +| @cell-label-color | `@gray-6` | - | +| @cell-label-font-size | `@font-size-sm` | - | +| @cell-label-line-height | `@line-height-sm` | - | +| @cell-label-margin-top | `@padding-base` | - | +| @cell-value-color | `@gray-6` | - | +| @cell-icon-size | `16px` | - | +| @cell-right-icon-color | `@gray-6` | - | +| @cell-large-vertical-padding | `@padding-sm` | - | +| @cell-large-title-font-size | `@font-size-lg` | - | +| @cell-large-label-font-size | `@font-size-md` | - | +| @cell-group-background-color | `@white` | - | +| @cell-group-title-color | `@gray-6` | - | +| @cell-group-title-padding | `@padding-md @padding-md @padding-xs` | - | +| @cell-group-title-font-size | `@font-size-md` | - | +| @cell-group-title-line-height | `16px` | - | diff --git a/src/checkbox/README.md b/src/checkbox/README.md index 0f49b9ee3..20ff6e151 100644 --- a/src/checkbox/README.md +++ b/src/checkbox/README.md @@ -225,7 +225,7 @@ export default { ### Checkbox Props | Attribute | Description | Type | Default | -| --- | --- | --- | --- | +| --- | --- | --- | --- | --- | | v-model (value) | Check status | _boolean_ | `false` | | name | Checkbox name | _any_ | - | | shape | Can be set to `square` | _string_ | `round` | @@ -239,7 +239,7 @@ export default { ### CheckboxGroup Props | Attribute | Description | Type | Default | -| --- | --- | --- | --- | +| --- | --- | --- | --- | --- | | v-model (value) | Names of all checked checkboxes | _any[]_ | - | | disabled | Whether to disable all checkboxes | _boolean_ | `false` | | max | Maximum amount of checked options | _number \| string_ | `0`(Unlimited) | @@ -282,3 +282,19 @@ Use [ref](https://v3.vuejs.org/guide/component-template-refs.html) to get Checkb | Name | Description | Attribute | Return value | | ------ | ------------------- | ------------------- | ------------ | | toggle | Toggle check status | _checked?: boolean_ | - | + +### Less Variables + +How to use: [Custom Theme](#/en-US/theme). + +| Name | Default Value | Description | +| --- | --- | --- | +| @checkbox-size | `20px` | - | +| @checkbox-border-color | `@gray-5` | - | +| @checkbox-transition-duration | `@animation-duration-fast` | - | +| @checkbox-label-margin | `@padding-xs` | - | +| @checkbox-label-color | `@text-color` | - | +| @checkbox-checked-icon-color | `@blue` | - | +| @checkbox-disabled-icon-color | `@gray-5` | - | +| @checkbox-disabled-label-color | `@gray-5` | - | +| @checkbox-disabled-background-color | `@border-color` | - | diff --git a/src/checkbox/README.zh-CN.md b/src/checkbox/README.zh-CN.md index 4da2c1b82..bdcb5a397 100644 --- a/src/checkbox/README.zh-CN.md +++ b/src/checkbox/README.zh-CN.md @@ -306,3 +306,19 @@ export default { | 方法名 | 说明 | 参数 | 返回值 | | --- | --- | --- | --- | | toggle | 切换选中状态,传`true`为选中,`false`为取消选中,不传参为取反 | _checked?: boolean_ | - | + +### 样式变量 + +组件提供了下列 Less 变量,可用于自定义样式,使用方法请参考[主题定制](#/zh-CN/theme)。 + +| 名称 | 默认值 | 描述 | +| ----------------------------------- | -------------------------- | ---- | +| @checkbox-size | `20px` | - | +| @checkbox-border-color | `@gray-5` | - | +| @checkbox-transition-duration | `@animation-duration-fast` | - | +| @checkbox-label-margin | `@padding-xs` | - | +| @checkbox-label-color | `@text-color` | - | +| @checkbox-checked-icon-color | `@blue` | - | +| @checkbox-disabled-icon-color | `@gray-5` | - | +| @checkbox-disabled-label-color | `@gray-5` | - | +| @checkbox-disabled-background-color | `@border-color` | - | diff --git a/src/circle/README.md b/src/circle/README.md index 5fad3cac4..6dd482abe 100644 --- a/src/circle/README.md +++ b/src/circle/README.md @@ -130,3 +130,14 @@ export default { | Name | Description | | ------- | ------------------- | | default | custom text content | + +### Less Variables + +How to use: [Custom Theme](#/en-US/theme). + +| Name | Default Value | Description | +| ------------------------ | ------------------- | ----------- | +| @circle-text-color | `@text-color` | - | +| @circle-text-font-weight | `@font-weight-bold` | - | +| @circle-text-font-size | `@font-size-md` | - | +| @circle-text-line-height | `@line-height-md` | - | diff --git a/src/circle/README.zh-CN.md b/src/circle/README.zh-CN.md index 1e876675d..bda928294 100644 --- a/src/circle/README.zh-CN.md +++ b/src/circle/README.zh-CN.md @@ -146,3 +146,14 @@ export default { | 名称 | 说明 | | ------- | -------------- | | default | 自定义文字内容 | + +### 样式变量 + +组件提供了下列 Less 变量,可用于自定义样式,使用方法请参考[主题定制](#/zh-CN/theme)。 + +| 名称 | 默认值 | 描述 | +| ------------------------ | ------------------- | ---- | +| @circle-text-color | `@text-color` | - | +| @circle-text-font-weight | `@font-weight-bold` | - | +| @circle-text-font-size | `@font-size-md` | - | +| @circle-text-line-height | `@line-height-md` | - | diff --git a/src/collapse/README.md b/src/collapse/README.md index 27fed469c..67a5dc338 100644 --- a/src/collapse/README.md +++ b/src/collapse/README.md @@ -149,3 +149,17 @@ Use [ref](https://v3.vuejs.org/guide/component-template-refs.html) to get Collap | Name | Description | Attribute | Return value | | --- | --- | --- | --- | | toggle `v2.10.9` | Toggle expanded status | _expanded: boolean_ | - | + +### Less Variables + +How to use: [Custom Theme](#/en-US/theme). + +| Name | Default Value | Description | +| --- | --- | --- | +| @collapse-item-transition-duration | `@animation-duration-base` | - | +| @collapse-item-content-padding | `@padding-sm @padding-md` | - | +| @collapse-item-content-font-size | `@font-size-md` | - | +| @collapse-item-content-line-height | `1.5` | - | +| @collapse-item-content-text-color | `@gray-6` | - | +| @collapse-item-content-background-color | `@white` | - | +| @collapse-item-title-disabled-color | `@gray-5` | - | diff --git a/src/collapse/README.zh-CN.md b/src/collapse/README.zh-CN.md index 4f169c163..b44572f7e 100644 --- a/src/collapse/README.zh-CN.md +++ b/src/collapse/README.zh-CN.md @@ -151,3 +151,17 @@ export default { | 方法名 | 说明 | 参数 | 返回值 | | --- | --- | --- | --- | | toggle `v2.10.9` | 切换面试展开状态,传 `true` 为展开,`false` 为收起,不传参为切换 | _expand?: boolean_ | - | + +### 样式变量 + +组件提供了下列 Less 变量,可用于自定义样式,使用方法请参考[主题定制](#/zh-CN/theme)。 + +| 名称 | 默认值 | 描述 | +| --------------------------------------- | -------------------------- | ---- | +| @collapse-item-transition-duration | `@animation-duration-base` | - | +| @collapse-item-content-padding | `@padding-sm @padding-md` | - | +| @collapse-item-content-font-size | `@font-size-md` | - | +| @collapse-item-content-line-height | `1.5` | - | +| @collapse-item-content-text-color | `@gray-6` | - | +| @collapse-item-content-background-color | `@white` | - | +| @collapse-item-title-disabled-color | `@gray-5` | - | diff --git a/src/contact-card/README.md b/src/contact-card/README.md index f5baf4897..8d6090e2b 100644 --- a/src/contact-card/README.md +++ b/src/contact-card/README.md @@ -88,3 +88,14 @@ export default { | Event | Description | Arguments | | ----- | --------------------------------- | -------------- | | click | Emitted when component is clicked | _event: Event_ | + +### Less Variables + +How to use: [Custom Theme](#/en-US/theme). + +| Name | Default Value | Description | +| ------------------------------- | ----------------- | ----------- | +| @contact-card-padding | `@padding-md` | - | +| @contact-card-add-icon-size | `40px` | - | +| @contact-card-add-icon-color | `@blue` | - | +| @contact-card-value-line-height | `@line-height-md` | - | diff --git a/src/contact-card/README.zh-CN.md b/src/contact-card/README.zh-CN.md index 99e789458..33fbfdc41 100644 --- a/src/contact-card/README.zh-CN.md +++ b/src/contact-card/README.zh-CN.md @@ -87,3 +87,14 @@ export default { | 事件名 | 说明 | 回调参数 | | ------ | ---------- | -------------- | | click | 点击时触发 | _event: Event_ | + +### 样式变量 + +组件提供了下列 Less 变量,可用于自定义样式,使用方法请参考[主题定制](#/zh-CN/theme)。 + +| 名称 | 默认值 | 描述 | +| ------------------------------- | ----------------- | ---- | +| @contact-card-padding | `@padding-md` | - | +| @contact-card-add-icon-size | `40px` | - | +| @contact-card-add-icon-color | `@blue` | - | +| @contact-card-value-line-height | `@line-height-md` | - | diff --git a/src/contact-edit/README.md b/src/contact-edit/README.md index 9b7c8f41a..5d4f48032 100644 --- a/src/contact-edit/README.md +++ b/src/contact-edit/README.md @@ -72,3 +72,16 @@ export default { | ---- | ----------- | -------- | | name | Name | _string_ | | tel | Phone | _string_ | + +### Less Variables + +How to use: [Custom Theme](#/en-US/theme). + +| Name | Default Value | Description | +| ---------------------------------- | ------------------- | ----------- | +| @contact-edit-padding | `@padding-md` | - | +| @contact-edit-fields-radius | `@border-radius-md` | - | +| @contact-edit-buttons-padding | `@padding-xl 0` | - | +| @contact-edit-button-margin-bottom | `@padding-sm` | - | +| @contact-edit-button-font-size | `16px` | - | +| @contact-edit-field-label-width | `4.1em` | - | diff --git a/src/contact-edit/README.zh-CN.md b/src/contact-edit/README.zh-CN.md index 49aa9c1a7..c72e90a18 100644 --- a/src/contact-edit/README.zh-CN.md +++ b/src/contact-edit/README.zh-CN.md @@ -76,3 +76,16 @@ export default { | ---- | ------------ | ------------------ | | name | 联系人姓名 | _string_ | | tel | 联系人手机号 | _number \| string_ | + +### 样式变量 + +组件提供了下列 Less 变量,可用于自定义样式,使用方法请参考[主题定制](#/zh-CN/theme)。 + +| 名称 | 默认值 | 描述 | +| ---------------------------------- | ------------------- | ---- | +| @contact-edit-padding | `@padding-md` | - | +| @contact-edit-fields-radius | `@border-radius-md` | - | +| @contact-edit-buttons-padding | `@padding-xl 0` | - | +| @contact-edit-button-margin-bottom | `@padding-sm` | - | +| @contact-edit-button-font-size | `16px` | - | +| @contact-edit-field-label-width | `4.1em` | - | diff --git a/src/contact-list/README.md b/src/contact-list/README.md index 20ecd430b..bb4ecea18 100644 --- a/src/contact-list/README.md +++ b/src/contact-list/README.md @@ -88,3 +88,13 @@ export default { | name | Name | _string_ | | tel | Phone | _string_ | | isDefault | Is default contact | _boolean_ | + +### Less Variables + +How to use: [Custom Theme](#/en-US/theme). + +| Name | Default Value | Description | +| -------------------------------- | ------------- | ----------- | +| @contact-list-edit-icon-size | `16px` | - | +| @contact-list-add-button-z-index | `999` | - | +| @contact-list-item-padding | `@padding-md` | - | diff --git a/src/contact-list/README.zh-CN.md b/src/contact-list/README.zh-CN.md index 56bba0ae6..528767fb1 100644 --- a/src/contact-list/README.zh-CN.md +++ b/src/contact-list/README.zh-CN.md @@ -92,3 +92,13 @@ export default { | name | 联系人姓名 | _string_ | | tel | 联系人手机号 | _number \| string_ | | isDefault | 是否为默认联系人 | _boolean_ | + +### 样式变量 + +组件提供了下列 Less 变量,可用于自定义样式,使用方法请参考[主题定制](#/zh-CN/theme)。 + +| 名称 | 默认值 | 描述 | +| -------------------------------- | ------------- | ---- | +| @contact-list-edit-icon-size | `16px` | - | +| @contact-list-add-button-z-index | `999` | - | +| @contact-list-item-padding | `@padding-md` | - | diff --git a/src/count-down/README.md b/src/count-down/README.md index 7be91ecb2..4d5a00c18 100644 --- a/src/count-down/README.md +++ b/src/count-down/README.md @@ -165,3 +165,13 @@ Use [ref](https://v3.vuejs.org/guide/component-template-refs.html) to get CountD | start | Start count down | - | - | | pause | Pause count down | - | - | | reset | Reset count down | - | - | + +### Less Variables + +How to use: [Custom Theme](#/en-US/theme). + +| Name | Default Value | Description | +| ----------------------- | ----------------- | ----------- | +| @count-down-text-color | `@text-color` | - | +| @count-down-font-size | `@font-size-md` | - | +| @count-down-line-height | `@line-height-md` | - | diff --git a/src/count-down/README.zh-CN.md b/src/count-down/README.zh-CN.md index f66290ee1..e4746af34 100644 --- a/src/count-down/README.zh-CN.md +++ b/src/count-down/README.zh-CN.md @@ -178,7 +178,17 @@ export default { | --- | --- | --- | --- | | start | 开始倒计时 | - | - | | pause | 暂停倒计时 | - | - | -| reset | 重设倒计时,若`auto-start`为`true`,重设后会自动开始倒计时 | - | - | +| reset | 重设倒计时,若 `auto-start` 为 `true`,重设后会自动开始倒计时 | - | - | + +### 样式变量 + +组件提供了下列 Less 变量,可用于自定义样式,使用方法请参考[主题定制](#/zh-CN/theme)。 + +| 名称 | 默认值 | 描述 | +| ----------------------- | ----------------- | ---- | +| @count-down-text-color | `@text-color` | - | +| @count-down-font-size | `@font-size-md` | - | +| @count-down-line-height | `@line-height-md` | - | ## 常见问题 diff --git a/src/coupon-list/README.md b/src/coupon-list/README.md index d6234003e..29df73cad 100644 --- a/src/coupon-list/README.md +++ b/src/coupon-list/README.md @@ -88,7 +88,7 @@ export default { ### CouponList Props | Attribute | Description | Type | Default | -| --- | --- | --- | --- | +| --- | --- | --- | --- | --- | | v-model | Current exchange code | _string_ | - | | chosen-coupon | Index of chosen coupon | _number_ | `-1` | | coupons | Coupon list | _Coupon[]_ | `[]` | @@ -127,3 +127,34 @@ export default { | value | Value | _number_ | | valueDesc | Value Text | _string_ | | unitDesc | Unit Text | _string_ | + +### Less Variables + +How to use: [Custom Theme](#/en-US/theme). + +| Name | Default Value | Description | +| --- | --- | --- | +| @coupon-margin | `0 @padding-sm @padding-sm` | - | +| @coupon-content-height | `84px` | - | +| @coupon-content-padding | `14px 0` | - | +| @coupon-background-color | `@white` | - | +| @coupon-active-background-color | `@active-color` | - | +| @coupon-border-radius | `@border-radius-lg` | - | +| @coupon-box-shadow | `0 0 4px rgba(0, 0, 0, 0.1)` | - | +| @coupon-head-width | `96px` | - | +| @coupon-amount-color | `@red` | - | +| @coupon-amount-font-size | `30px` | - | +| @coupon-currency-font-size | `40%` | - | +| @coupon-name-font-size | `@font-size-md` | - | +| @coupon-disabled-text-color | `@gray-6` | - | +| @coupon-description-padding | `@padding-xs @padding-md` | - | +| @coupon-description-border-color | `@border-color` | - | +| @coupon-list-background-color | `@background-color` | - | +| @coupon-list-field-padding | `5px 0 5px @padding-md` | - | +| @coupon-list-exchange-button-height | `32px` | - | +| @coupon-list-close-button-height | `40px` | - | +| @coupon-list-empty-image-size | `200px` | - | +| @coupon-list-empty-tip-color | `@gray-6` | - | +| @coupon-list-empty-tip-font-size | `@font-size-md` | - | +| @coupon-list-empty-tip-line-height | `@line-height-md` | - | +| @coupon-cell-selected-text-color | `@text-color` | - | diff --git a/src/coupon-list/README.zh-CN.md b/src/coupon-list/README.zh-CN.md index 81d8588ce..2e2fff23f 100644 --- a/src/coupon-list/README.zh-CN.md +++ b/src/coupon-list/README.zh-CN.md @@ -77,13 +77,13 @@ export default { ### CouponCell Props | 参数 | 说明 | 类型 | 默认值 | -| ------------- | -------------------- | ------------------ | -------- | +| ------------- | -------------------- | ------------------ | -------- | --- | | title | 单元格标题 | _string_ | `优惠券` | | chosen-coupon | 当前选中优惠券的索引 | _number \| string_ | `-1` | | coupons | 可用优惠券列表 | _Coupon[]_ | `[]` | | editable | 能否切换优惠券 | _boolean_ | `true` | | border | 是否显示内边框 | _boolean_ | `true` | -| currency | 货币符号 | _string_ | `¥` | - | +| currency | 货币符号 | _string_ | `¥` | - | ### CouponList Props @@ -129,3 +129,34 @@ export default { | value | 折扣券优惠金额,单位分 | _number_ | | valueDesc | 折扣券优惠金额文案 | _string_ | | unitDesc | 单位文案 | _string_ | + +### 样式变量 + +组件提供了下列 Less 变量,可用于自定义样式,使用方法请参考[主题定制](#/zh-CN/theme)。 + +| 名称 | 默认值 | 描述 | +| ----------------------------------- | ---------------------------- | ---- | +| @coupon-margin | `0 @padding-sm @padding-sm` | - | +| @coupon-content-height | `84px` | - | +| @coupon-content-padding | `14px 0` | - | +| @coupon-background-color | `@white` | - | +| @coupon-active-background-color | `@active-color` | - | +| @coupon-border-radius | `@border-radius-lg` | - | +| @coupon-box-shadow | `0 0 4px rgba(0, 0, 0, 0.1)` | - | +| @coupon-head-width | `96px` | - | +| @coupon-amount-color | `@red` | - | +| @coupon-amount-font-size | `30px` | - | +| @coupon-currency-font-size | `40%` | - | +| @coupon-name-font-size | `@font-size-md` | - | +| @coupon-disabled-text-color | `@gray-6` | - | +| @coupon-description-padding | `@padding-xs @padding-md` | - | +| @coupon-description-border-color | `@border-color` | - | +| @coupon-list-background-color | `@background-color` | - | +| @coupon-list-field-padding | `5px 0 5px @padding-md` | - | +| @coupon-list-exchange-button-height | `32px` | - | +| @coupon-list-close-button-height | `40px` | - | +| @coupon-list-empty-image-size | `200px` | - | +| @coupon-list-empty-tip-color | `@gray-6` | - | +| @coupon-list-empty-tip-font-size | `@font-size-md` | - | +| @coupon-list-empty-tip-line-height | `@line-height-md` | - | +| @coupon-cell-selected-text-color | `@text-color` | - | diff --git a/src/dialog/README.md b/src/dialog/README.md index a019ce75b..5e3748aea 100644 --- a/src/dialog/README.md +++ b/src/dialog/README.md @@ -205,3 +205,29 @@ export default { | ------- | -------------- | | default | Custom message | | title | Custom title | + +### Less Variables + +How to use: [Custom Theme](#/en-US/theme). + +| Name | Default Value | Description | +| --- | --- | --- | +| @dialog-width | `320px` | - | +| @dialog-small-screen-width | `90%` | - | +| @dialog-font-size | `@font-size-lg` | - | +| @dialog-transition | `@animation-duration-base` | - | +| @dialog-border-radius | `16px` | - | +| @dialog-background-color | `@white` | - | +| @dialog-header-font-weight | `@font-weight-bold` | - | +| @dialog-header-line-height | `24px` | - | +| @dialog-header-padding-top | `26px` | - | +| @dialog-header-isolated-padding | `@padding-lg 0` | - | +| @dialog-message-padding | `@padding-lg` | - | +| @dialog-message-font-size | `@font-size-md` | - | +| @dialog-message-line-height | `@line-height-md` | - | +| @dialog-message-max-height | `60vh` | - | +| @dialog-has-title-message-text-color | `@gray-7` | - | +| @dialog-has-title-message-padding-top | `@padding-xs` | - | +| @dialog-button-height | `48px` | - | +| @dialog-round-button-height | `36px` | - | +| @dialog-confirm-button-text-color | `@red` | - | diff --git a/src/dialog/README.zh-CN.md b/src/dialog/README.zh-CN.md index 285e3cf7e..850d0b494 100644 --- a/src/dialog/README.zh-CN.md +++ b/src/dialog/README.zh-CN.md @@ -246,3 +246,29 @@ export default { | ------- | ---------- | | default | 自定义内容 | | title | 自定义标题 | + +### 样式变量 + +组件提供了下列 Less 变量,可用于自定义样式,使用方法请参考[主题定制](#/zh-CN/theme)。 + +| 名称 | 默认值 | 描述 | +| ------------------------------------- | -------------------------- | ---- | +| @dialog-width | `320px` | - | +| @dialog-small-screen-width | `90%` | - | +| @dialog-font-size | `@font-size-lg` | - | +| @dialog-transition | `@animation-duration-base` | - | +| @dialog-border-radius | `16px` | - | +| @dialog-background-color | `@white` | - | +| @dialog-header-font-weight | `@font-weight-bold` | - | +| @dialog-header-line-height | `24px` | - | +| @dialog-header-padding-top | `26px` | - | +| @dialog-header-isolated-padding | `@padding-lg 0` | - | +| @dialog-message-padding | `@padding-lg` | - | +| @dialog-message-font-size | `@font-size-md` | - | +| @dialog-message-line-height | `@line-height-md` | - | +| @dialog-message-max-height | `60vh` | - | +| @dialog-has-title-message-text-color | `@gray-7` | - | +| @dialog-has-title-message-padding-top | `@padding-xs` | - | +| @dialog-button-height | `48px` | - | +| @dialog-round-button-height | `36px` | - | +| @dialog-confirm-button-text-color | `@red` | - | diff --git a/src/divider/README.md b/src/divider/README.md index 7e66aefe2..a7d044c1f 100644 --- a/src/divider/README.md +++ b/src/divider/README.md @@ -62,3 +62,18 @@ app.use(Divider); | Name | Description | | ------- | ----------- | | default | content | + +### Less Variables + +How to use: [Custom Theme](#/en-US/theme). + +| Name | Default Value | Description | +| ---------------------------- | --------------- | ----------- | +| @divider-margin | `@padding-md 0` | - | +| @divider-text-color | `@gray-6` | - | +| @divider-font-size | `@font-size-md` | - | +| @divider-line-height | `24px` | - | +| @divider-border-color | `@border-color` | - | +| @divider-content-padding | `@padding-md` | - | +| @divider-content-left-width | `10%` | - | +| @divider-content-right-width | `10%` | - | diff --git a/src/divider/README.zh-CN.md b/src/divider/README.zh-CN.md index f3499dc3f..f8097a660 100644 --- a/src/divider/README.zh-CN.md +++ b/src/divider/README.zh-CN.md @@ -76,3 +76,18 @@ app.use(Divider); | 名称 | 说明 | | ------- | ---- | | default | 内容 | + +### 样式变量 + +组件提供了下列 Less 变量,可用于自定义样式,使用方法请参考[主题定制](#/zh-CN/theme)。 + +| 名称 | 默认值 | 描述 | +| ---------------------------- | --------------- | ---- | +| @divider-margin | `@padding-md 0` | - | +| @divider-text-color | `@gray-6` | - | +| @divider-font-size | `@font-size-md` | - | +| @divider-line-height | `24px` | - | +| @divider-border-color | `@border-color` | - | +| @divider-content-padding | `@padding-md` | - | +| @divider-content-left-width | `10%` | - | +| @divider-content-right-width | `10%` | - | diff --git a/src/dropdown-menu/README.md b/src/dropdown-menu/README.md index 58c29cf27..70537d495 100644 --- a/src/dropdown-menu/README.md +++ b/src/dropdown-menu/README.md @@ -177,3 +177,22 @@ Use [ref](https://v3.vuejs.org/guide/component-template-refs.html) to get Dropdo | text | Text | _string_ | | value | Value | _number \| string_ | | icon | Left icon | _string_ | + +### Less Variables + +How to use: [Custom Theme](#/en-US/theme). + +| Name | Default Value | Description | +| --- | --- | --- | +| @dropdown-menu-height | `48px` | - | +| @dropdown-menu-background-color | `@white` | - | +| @dropdown-menu-box-shadow | `0 2px 12px fade(@gray-7, 12)` | - | +| @dropdown-menu-title-font-size | `15px` | - | +| @dropdown-menu-title-text-color | `@text-color` | - | +| @dropdown-menu-title-active-text-color | `@red` | - | +| @dropdown-menu-title-disabled-text-color | `@gray-6` | - | +| @dropdown-menu-title-padding | `0 @padding-xs` | - | +| @dropdown-menu-title-line-height | `@line-height-lg` | - | +| @dropdown-menu-option-active-color | `@red` | - | +| @dropdown-menu-content-max-height | `80%` | - | +| @dropdown-item-z-index | `10` | - | diff --git a/src/dropdown-menu/README.zh-CN.md b/src/dropdown-menu/README.zh-CN.md index c1dcbc259..baac42864 100644 --- a/src/dropdown-menu/README.zh-CN.md +++ b/src/dropdown-menu/README.zh-CN.md @@ -185,3 +185,22 @@ export default { | text | 文字 | _string_ | | value | 标识符 | _number \| string_ | | icon | 左侧[图标名称](#/zh-CN/icon)或图片链接 | _string_ | + +### 样式变量 + +组件提供了下列 Less 变量,可用于自定义样式,使用方法请参考[主题定制](#/zh-CN/theme)。 + +| 名称 | 默认值 | 描述 | +| --- | --- | --- | +| @dropdown-menu-height | `48px` | - | +| @dropdown-menu-background-color | `@white` | - | +| @dropdown-menu-box-shadow | `0 2px 12px fade(@gray-7, 12)` | - | +| @dropdown-menu-title-font-size | `15px` | - | +| @dropdown-menu-title-text-color | `@text-color` | - | +| @dropdown-menu-title-active-text-color | `@red` | - | +| @dropdown-menu-title-disabled-text-color | `@gray-6` | - | +| @dropdown-menu-title-padding | `0 @padding-xs` | - | +| @dropdown-menu-title-line-height | `@line-height-lg` | - | +| @dropdown-menu-option-active-color | `@red` | - | +| @dropdown-menu-content-max-height | `80%` | - | +| @dropdown-item-z-index | `10` | - | diff --git a/src/empty/README.md b/src/empty/README.md index 1ff99f5ad..5b47a6023 100644 --- a/src/empty/README.md +++ b/src/empty/README.md @@ -51,9 +51,7 @@ Use the image prop to display different placeholder images. ```html - - Button - + Button