From 0c5d904fb36433b0c984ca9a6a62f77a44667f1f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E9=99=88=E5=98=89=E6=B6=B5?= Date: Sat, 11 May 2019 10:19:54 +0800 Subject: [PATCH] [Doc] NoticeBar: update demo --- docs/src/doc.config.js | 2 +- packages/notice-bar/demo/index.vue | 47 ++++++++----- packages/notice-bar/en-US.md | 42 +++++++----- .../test/__snapshots__/demo.spec.js.snap | 24 ++++--- packages/notice-bar/zh-CN.md | 66 +++++++++++-------- 5 files changed, 114 insertions(+), 67 deletions(-) diff --git a/docs/src/doc.config.js b/docs/src/doc.config.js index 2afcae2e3..d611951a8 100644 --- a/docs/src/doc.config.js +++ b/docs/src/doc.config.js @@ -227,7 +227,7 @@ module.exports = { }, { path: '/notice-bar', - title: 'NoticeBar 通告栏' + title: 'NoticeBar 通知栏' }, { path: '/panel', diff --git a/packages/notice-bar/demo/index.vue b/packages/notice-bar/demo/index.vue index 2a33e692c..149fef479 100644 --- a/packages/notice-bar/demo/index.vue +++ b/packages/notice-bar/demo/index.vue @@ -7,17 +7,6 @@ /> - - - - - + + + + + + + + + @@ -40,15 +49,17 @@ export default { i18n: { 'zh-CN': { unscrollable: '禁用滚动', - mode: '通告栏模式', - wrapable: '文本换行', - text: '足协杯战线连续第2年上演广州德比战,上赛季半决赛上恒大以两回合5-3的总比分淘汰富力。' + mode: '通知栏模式', + wrapable: '多行展示', + text: '足协杯战线连续第2年上演广州德比战,上赛季半决赛上恒大以两回合5-3的总比分淘汰富力。', + customStyle: '自定义样式' }, 'en-US': { mode: 'Mode', wrapable: 'Wrapable', unscrollable: 'Disable scroll', - text: 'Only those who have the patience to do simple things perfectly ever acquire the skill to do difficult things easily.' + text: 'Only those who have the patience to do simple things perfectly ever acquire the skill to do difficult things easily.', + customStyle: 'Custom Style' } } }; @@ -57,7 +68,11 @@ export default { diff --git a/packages/notice-bar/en-US.md b/packages/notice-bar/en-US.md index 568e17007..8c0369a97 100644 --- a/packages/notice-bar/en-US.md +++ b/packages/notice-bar/en-US.md @@ -13,28 +13,16 @@ Vue.use(NoticeBar); ```html ``` -#### Mode - -```html - - Only those who have the patience to do simple things perfectly ever acquire the skill to do difficult things easily. - - - - Only those who have the patience to do simple things perfectly ever acquire the skill to do difficult things easily. - -``` - #### Disable scroll ```html - Only those who have the patience to do simple things perfectly ever acquire the skill to do difficult things easily. + Notice Content ``` @@ -42,7 +30,31 @@ Vue.use(NoticeBar); ```html - Only those who have the patience to do simple things perfectly ever acquire the skill to do difficult things easily. + Notice Content + +``` + +#### Mode + +```html + + Notice Content + + + + Notice Content + +``` + +### Custom Style + +```html + + Notice Content ``` diff --git a/packages/notice-bar/test/__snapshots__/demo.spec.js.snap b/packages/notice-bar/test/__snapshots__/demo.spec.js.snap index 590e50e43..a77c9e112 100644 --- a/packages/notice-bar/test/__snapshots__/demo.spec.js.snap +++ b/packages/notice-bar/test/__snapshots__/demo.spec.js.snap @@ -10,6 +10,20 @@ exports[`renders demo correctly 1`] = ` +
+
+
+
足协杯战线连续第2年上演广州德比战,上赛季半决赛上恒大以两回合5-3的总比分淘汰富力。
+
+
+
+
+
+
+
足协杯战线连续第2年上演广州德比战,上赛季半决赛上恒大以两回合5-3的总比分淘汰富力。
+
+
+
@@ -25,14 +39,8 @@ exports[`renders demo correctly 1`] = `
-
-
-
足协杯战线连续第2年上演广州德比战,上赛季半决赛上恒大以两回合5-3的总比分淘汰富力。
-
-
-
-
-
+
+
足协杯战线连续第2年上演广州德比战,上赛季半决赛上恒大以两回合5-3的总比分淘汰富力。
diff --git a/packages/notice-bar/zh-CN.md b/packages/notice-bar/zh-CN.md index 449b5266e..20874ea62 100644 --- a/packages/notice-bar/zh-CN.md +++ b/packages/notice-bar/zh-CN.md @@ -1,4 +1,4 @@ -## NoticeBar 通告栏 +## NoticeBar 通知栏 ### 使用指南 ``` javascript @@ -13,44 +13,56 @@ Vue.use(NoticeBar); ```html ``` -#### 通告栏模式 - -默认模式为空,支持`closeable`和`link`。 - -```html - - - 足协杯战线连续第2年上演广州德比战,上赛季半决赛上恒大以两回合5-3的总比分淘汰富力。 - - - - - 足协杯战线连续第2年上演广州德比战,上赛季半决赛上恒大以两回合5-3的总比分淘汰富力。 - -``` - #### 禁用滚动 文字内容多于一行时,可通过`scrollable`参数控制是否开启滚动 ```html - 足协杯战线连续第2年上演广州德比战,上赛季半决赛上恒大以两回合5-3的总比分淘汰富力。 + 通知内容 ``` -#### 文本换行 +#### 多行展示 -禁用滚动时,可以设置`wrapable`来开启文本换行 +禁用滚动时,可以设置`wrapable`来开启多行展示 ```html - 足协杯战线连续第2年上演广州德比战,上赛季半决赛上恒大以两回合5-3的总比分淘汰富力。 + 通知内容 + +``` + +#### 通知栏模式 + +默认模式为空,支持`closeable`和`link`两种模式 + +```html + + + 通知内容 + + + + + 通知内容 + +``` + +### 自定义样式 + +```html + + 通知内容 ``` @@ -58,8 +70,8 @@ Vue.use(NoticeBar); | 参数 | 说明 | 类型 | 默认值 | 版本 | |------|------|------|------|------| -| mode | 通告栏模式,可选值为 `closeable` `link` | `String` | `''` | - | -| text | 通告文本内容 | `String` | `''` | - | +| mode | 通知栏模式,可选值为 `closeable` `link` | `String` | `''` | - | +| text | 通知文本内容 | `String` | `''` | - | | delay | 动画延迟时间 (s) | `Number` | `1` | - | | speed | 滚动速率 (px/s) | `Number` | `50` | - | | scrollable | 是否在长度溢出时滚动播放 | `Boolean` | `true` | - | @@ -72,13 +84,13 @@ Vue.use(NoticeBar); | 事件名 | 说明 | 回调参数 | |------|------|------| -| click | 点击时触发 | - | -| close | 关闭时触发 | - | +| click | 点击通知栏时触发 | - | +| close | 关闭通知栏时触发 | - | ### Slots | 名称 | 内容 | |------|------| -| - | 通告文本内容 | +| default | 通知文本内容 | | left-icon | 自定义左侧图标 | | right-icon | 自定义右侧图标 |