Skip to content

Commit 2259582

Browse files
committed
doc(bill, notice-bar): update
1 parent cdf501e commit 2259582

3 files changed

Lines changed: 24 additions & 21 deletions

File tree

components/bill/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Vue.component(Bill.name, Bill)
2828
#### Bill Slots
2929

3030
##### default
31-
默认内容插错
31+
默认内容插槽
3232

3333
##### header
3434
头部内容插槽

components/notice-bar/README.en-US.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -23,25 +23,26 @@ Vue.component(NoticeBar.name, NoticeBar)
2323
|Props | Description | Type | Default | Note|
2424
|----|-----|------|------|------|
2525
|mode|notice bar mode|String|-|`closable/link`, priority is less than slot|
26-
|type|theme|String|`default`|`default/warning`|
26+
|type|theme|String|`default`|`default/activity/warning`|
2727
|time|display time|Number|`0`|unit is `ms`, which does not disappear automatically and can be set to `0`|
28-
|isCircle|notice bar is oval display or not|Boolean|`false`|-|
29-
|multiRows|Content exceeds line break display|Boolean|`false`|Priority is heigher than scrollable|
30-
|scrollable|Show scrolling animation when content is exceeded|Boolean|`false``|Priority is less than multiRows|
31-
|icon|notice bar icon|String|-|**recommended use slot**,will be deleted in the future|
28+
|is-circle|fillet radius|Boolean|`false`|-|
29+
|multi-rows|content exceeds line break display|Boolean|`false`|Priority is heigher than scrollable|
30+
|scrollable|show scrolling animation when content is exceeded|Boolean|`false``|Priority is less than multiRows|
31+
|icon|notice bar icon|String|-|-|
3232
|icon-svg|use svg icon|Boolean|`false`|-|
33-
|closable|whether the notice bar is closable or not|Boolean|`false`|**recommended use mode or slot**,will be deleted in the future|
3433

3534
#### InputItem Slots
3635

36+
#### default
37+
Default slot of content
38+
3739
#### left
38-
Left slot, generally is used to place icons, etc.
40+
Left slot, generally is used to place icons, etc
3941

4042
#### right
41-
Right slot, generally is used to place icons, etc.
43+
Right slot, generally is used to place icons, etc
4244

4345
#### NoticeBar Events
4446

45-
##### @click()
46-
When you click the icon on the right will trigger event.
47-
When the `mode` is `closable` or the `closable` is true, the event will be close at the same time
47+
##### @close()
48+
Notice bar close event (set `mode` to 'closable' or `closable` to true)

components/notice-bar/README.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -23,16 +23,18 @@ Vue.component(NoticeBar.name, NoticeBar)
2323
|属性 | 说明 | 类型 | 默认值 | 备注|
2424
|----|-----|------|------|------|
2525
|mode|右边提示类型|String|-|`closable/link`,优先级小于slot|
26-
|type|主题样式|String|`default`|`default/warning`|
26+
|type|主题样式|String|`default`|`default/activity/warning`|
2727
|time|显示时长|Number|`0`|单位为`ms`,不需要自动消失可将其置为`0`|
28-
|is-circle|是否椭圆形展示|Boolean|`false`|-|
29-
|multi-rows|内容超出是否多行展示|Boolean|`false`|优先级高于scrollable|
30-
|scrollable|内容超出是否滚动展示|Boolean|`false`|优先级小于multiRows|
31-
|icon|在开始位置的图标样式|String|-|**推荐使用slot**, 仅为兼容1.x版本|
28+
|is-circle|圆角展示|Boolean|`false`|-|
29+
|multi-rows|内容超出多行展示|Boolean|`false`|优先级高于scrollable|
30+
|scrollable|内容超出滚动展示|Boolean|`false`|优先级小于multiRows|
31+
|icon|在开始位置的图标样式|String|-|-|
3232
|icon-svg|使用svg图标|Boolean|`false`|-|
33-
|closable|是否可关闭|Boolean|`false`|**推荐使用mode或slot**, 仅为兼容1.x版本|
3433

35-
#### InputItem Slots
34+
#### NoticeBar Slots
35+
36+
#### default
37+
默认内容插错
3638

3739
#### left
3840
左侧插槽,一般用于放置图标等
@@ -42,6 +44,6 @@ Vue.component(NoticeBar.name, NoticeBar)
4244

4345
#### NoticeBar Events
4446

45-
##### @click()
46-
点击通告栏右侧Icon后触发的事件,设置`mode`'closable'或`closable`为true会同时触发关闭通告栏
47+
##### @close()
48+
通告栏关闭事件(设置`mode``closable`
4749

0 commit comments

Comments
 (0)