Skip to content

Commit 6eb9127

Browse files
committed
docs: 所有组件添加简短说明
1 parent f3d3dd5 commit 6eb9127

File tree

19 files changed

+33
-2
lines changed

19 files changed

+33
-2
lines changed

src/components/Preview.vue

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ $border-color: #d9d9d9;
4141
4242
.preview-container {
4343
border: 1px solid $border-color;
44-
margin: 16px 0px 32px;
44+
margin: 32px 0px 32px;
4545
min-width: 300px;
4646
> h2 {
4747
font-size: 20px;

src/views/doc/affix/index.vue

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
<template>
22
<div class="affix-doc-wrapper">
33
<h1>固钉 Affix</h1>
4+
<p>将页面元素固定在特定可视区域。</p>
45
<div class="preview-wrapper">
56
<Preview :component="AffixPreview1" />
67
<Preview :component="AffixPreview2" />

src/views/doc/avatar/index.vue

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
<template>
22
<div class="avatar-doc-wrapper">
33
<h1>Avatar 头像</h1>
4+
<p>Avatar 组件可以用来代表人物或对象</p>
45
<div class="preview-wrapper">
56
<Preview :component="AvatarPreview1" />
67
<Preview :component="AvatarPreview2" />

src/views/doc/backtop/index.vue

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
<template>
22
<div class="backtop-doc-wrapper">
33
<h1>回到顶部 Backtop</h1>
4+
<p>返回页面顶部的操作按钮</p>
45
<div class="preview-wrapper">
56
<Preview :component="BacktopPreview1" />
67
<Preview :component="BacktopPreview2" />

src/views/doc/breadcrumb/index.vue

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
<template>
22
<div class="breadcrumb-doc-wrapper">
33
<h1>面包屑 Breadcrumb</h1>
4+
<p>
5+
显示当前页面的路径,快速返回之前的任意页面。
6+
</p>
47
<div class="preview-wrapper">
58
<Preview :component="BreadcrumbPreview1" />
69
<Preview :component="BreadcrumbPreview2" />

src/views/doc/button/index.vue

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
<template>
22
<div class="button-doc-wrapper">
33
<h1>Button 按钮</h1>
4+
<p>常用的操作按钮。</p>
45
<div class="preview-wrapper">
56
<Preview :component="ButtonPreview1" />
67
<Preview :component="ButtonPreview2" />

src/views/doc/checkbox/index.vue

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
<template>
22
<div class="checkbox-doc-wrapper">
33
<h1>Checkbox 单选框</h1>
4+
<p>一组备选项中进行多选</p>
45
<div class="preview-wrapper">
56
<Preview :component="CheckboxPreview1" />
67
<Preview :component="CheckboxPreview2" />

src/views/doc/dialog/index.vue

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
<template>
22
<h1>Dialog 对话框</h1>
3+
<p>在保留当前页面状态的情况下,告知用户并承载相关操作。</p>
34
<div class="preview-wrapper">
45
<Preview :component="DialogPreview1" />
56
<Preview :component="DialogPreview2" />

src/views/doc/divider/index.vue

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
<template>
22
<div class="divider-doc-wrapper">
33
<h1>分割线 Divider</h1>
4+
<p>区隔内容的分割线。</p>
45
<div class="preview-wrapper">
56
<Preview :component="DividerPreview1" />
67
<Preview :component="DividerPreview2" />

src/views/doc/ellipsis/index.vue

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
<template>
22
<div class="ellipsis-doc-wrapper">
33
<h1>Ellipsis 文本省略</h1>
4+
<p>复杂度不会消失,只会转移。</p>
5+
<p>当你听到一些人对于精致的概念模型侃侃而谈,请保持清醒。</p>
46
<div class="preview-wrapper">
57
<Preview :component="EllipsisPreview1" />
68
<Preview :component="EllipsisPreview2" />

0 commit comments

Comments
 (0)