docs: add docs for carousel and config-provider #8
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Change-Id: I7c9dd8f4cea8c1fef036a53f35ab6163e05587c0
|
This pull request is being automatically deployed with Vercel (learn more). 🔍 Inspect: https://vercel.com/ecomfe/veui-docs/4KqvH4FTkWg2Fs6TjYV41b2kEroM |
Justineo
requested changes
Sep 14, 2021
one/docs/components/carousel.md
Outdated
|
|
||
| 使用 `indicator` 属性来指定进度指示器类型。 | ||
|
|
||
| 使用 `controls-position` 属性来切换按钮相对于布局方向的位置。 |
There was a problem hiding this comment.
controls-position 放到 vertical 的 demo 里面去吧？
one/docs/components/carousel.md
Outdated
| | `indicator-position` | `'outside' | 'inside'` | `inside` | 用于支持指示器显示在轮播容器的内部/外部。 | | ||
| | `controls-position` | `'outside' | 'inside'` | `inside` | 用于支持切换按钮相对于布局方向的位置。 | | ||
| | `slide-aspect-ratio` | `number= | '${number}/${number}'` | - | 指定不同轮播项类型的默认配置。 | | ||
| | `options` | `object=` | `{ video: { muted: true, autoplay: true, controls: true, loop: true } }` | 用于指定每个轮播项的纵横比。 | |
There was a problem hiding this comment.
Suggested change
| | `options` | `object=` | `{ video: { muted: true, autoplay: true, controls: true, loop: true } }` | 用于指定每个轮播项的纵横比。 | | |
| | `options` | `Object=` | `{ video: { muted: true, autoplay: true, controls: true, loop: true } }` | 用于指定每个轮播项的纵横比。 | |
one/docs/components/carousel.md
Outdated
| | `slide-aspect-ratio` | `number= | '${number}/${number}'` | - | 指定不同轮播项类型的默认配置。 | | ||
| | `options` | `object=` | `{ video: { muted: true, autoplay: true, controls: true, loop: true } }` | 用于指定每个轮播项的纵横比。 | | ||
| | `slides-per-view` | `number=` | `1` | 指定同时显示多少个轮播项。 | | ||
| | `slides-per-group` | `number=` | `1` | 指定每次前后切换的一组包含多少个轮播项。 | | ||
|
|
||
| ^^^datasource | ||
| 轮播图数据源，项目类型为：`{src, alt, label}`。 |
There was a problem hiding this comment.
Suggested change
| 轮播图数据源，项目类型为：`{src, alt, label}`。 | |
| 轮播图数据源，项目类型为：`{src, alt, label, type}`。 |
|
|
||
| ## 示例 | ||
|
|
||
| ### 配置 `Select` 的 placeholder |
There was a problem hiding this comment.
Suggested change
| ### 配置 `Select` 的 placeholder | |
| ### 配置 `Select` 的 `placeholder` |
|
|
||
| ### 配置 `Select` 的 placeholder | ||
|
|
||
| 可选的尺寸 `ui` 属性值：`s`/`m`。 |
There was a problem hiding this comment.
Suggested change
| 可选的尺寸 `ui` 属性值：`s`/`m`。 |
|
|
||
| | 名称 | 描述 | | ||
| | -- | -- | | ||
| | `default` | 直接渲染出来，其中 `VEUI` 的组件会响应对应的配置值。 | |
There was a problem hiding this comment.
Suggested change
| | `default` | 直接渲染出来，其中 `VEUI` 的组件会响应对应的配置值。 | | |
| | `default` | 需要接收配置的内容，其中 VEUI 的组件会响应对应的配置值。 | |
one/docs/demo/carousel/indicator.vue
Outdated
| </section> | ||
| <section> | ||
| <veui-carousel | ||
| :datasource="items" | ||
| :indicator="indicator" | ||
| :indicator-position="indicatorPosition" | ||
| :indicator-alignment="alignment" |
There was a problem hiding this comment.
感觉 Carousel 的 indicator-alignment 可以缩短成 indicator-align，太长了，类似 CSS 的 vertical-align 就行。
Change-Id: I1b868d7a3fffed2a5cf13a1b650e42bb06357d3f
Justineo
approved these changes
Sep 15, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.