From 8d059678fc4f01767f3ce9b8595ac9390b892035 Mon Sep 17 00:00:00 2001 From: yutent Date: Fri, 21 Apr 2023 19:34:34 +0800 Subject: [PATCH] =?UTF-8?q?=E6=9B=B4=E6=96=B0=E6=96=87=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- public/docset/ui/icons.md | 136 ++++++++++++++++++++++ public/docset/ui/install.md | 30 +++++ public/docset/ui/wc-button.md | 123 +++++++++++++++++++ src/pages/@wcui/docs/app.vue | 11 +- src/pages/@wcui/docs/components/aside.vue | 12 +- src/pages/@wcui/docs/main.js | 5 +- 6 files changed, 307 insertions(+), 10 deletions(-) create mode 100644 public/docset/ui/icons.md create mode 100644 public/docset/ui/install.md create mode 100644 public/docset/ui/wc-button.md diff --git a/public/docset/ui/icons.md b/public/docset/ui/icons.md new file mode 100644 index 0000000..0fff07e --- /dev/null +++ b/public/docset/ui/icons.md @@ -0,0 +1,136 @@ +## WC-ICON 图标 +精心绘制了`84`个常用小图标。 + + + + +### 使用 + +```html + +``` + +
+ +
+ +### 尺寸 +`size="xxxl"`, `size="xxl"`, `size="xl"`, `size="l"`, `size="m"`, `size="s"`, 连同默认尺寸在内, 5种预设规格。 +如果需要其他的尺寸的图片, 可自行通过css设置`--size: #{你想要的大小}`即可, 也可以直接设置`width, height`。 + + + +import '//jscdn.ink/@bd/ui/latest/space/index.js' +import '//jscdn.ink/@bd/ui/latest/icon/index.js' + + + + + + + + + + + + + + + + +### 全部图标列表 + +
+

android

+

app

+

apple

+

at

+

attach

+

backward

+

bell

+

calendar

+

camera

+

chart

+

checkbox-on

+

checkbox-off

+

client

+

close

+

color

+

dbl-left

+

dbl-right

+

deny

+

doc

+

download

+

edit

+

eye

+

eye-off

+

face

+

finger-print

+

fire

+

first

+

floppy

+

fly

+

folder-open

+

folder-close

+

get

+

happy

+

headset

+

home

+

image

+

info

+

key

+

layout

+

left

+

linux

+

live

+

load

+

loading

+

location

+

lock

+

mail

+

menu

+

menu-dot

+

mute

+

option

+

phone

+

pie

+

pin

+

plus

+

post

+

qr

+

quote

+

radio-on

+

radio-off

+

right

+

sad

+

search

+

second

+

setting

+

share

+

star

+

star-half

+

star-full

+

switch

+

tag

+

talk

+

third

+

time

+

track

+

trash

+

trigon-down

+

trigon-up

+

unmute

+

upload

+

user

+

vip

+

warn

+

wallet

+

windows

+
\ No newline at end of file diff --git a/public/docset/ui/install.md b/public/docset/ui/install.md new file mode 100644 index 0000000..a9538d7 --- /dev/null +++ b/public/docset/ui/install.md @@ -0,0 +1,30 @@ +## 安装 + +本项目无需安装, 全程cdn引入即可。 + + +### 示例 +cdn地址, 可以使用我们提供的地址,这个地址的版本将永远保持为最新版 + +如果想固定使用某个版本, 可以使用npm的cdn地址。 + +1. `//jscdn.ink/@bd/ui/latest/` 直接使用最新版 +2. `//jscdn.ink/@bd/ui/1.0.0/` 指定版本 + + +```html + + + + + +``` \ No newline at end of file diff --git a/public/docset/ui/wc-button.md b/public/docset/ui/wc-button.md new file mode 100644 index 0000000..8847084 --- /dev/null +++ b/public/docset/ui/wc-button.md @@ -0,0 +1,123 @@ + + +## WC-BUTTON +> 常用的按钮组件。 + + +### 基础用法 + +
+ Primary Button + Info Button + Success Button + Warning Button +
+
+ Normal Button + Help Button + Secondary Button + Danger Button +
+ + +### 尺寸大小 + +5种尺寸规则的按钮, 如果不满足自己的需求, 可以自行设置`width`和`height`。 + +```html +xxxl Size +xxl Size +xl Size +Deault Size +Medium Size +small Size +``` + +
+ xxxl Size + xxl Size + xl Size + Deault Size + Medium Size + small Size +
+ +### 状态 +按钮有2种状态, `loading` 和 `disabled`, 这2种状态下, 都不能点击, 也无法获取焦点。 + +```html +Loading Status +Disabled Status +Loading Status +Disabled Status +``` + + +
+ Loading Status + Disabled Status + Loading Status + Disabled Status +
+ + +### 图标 +按钮可通过`icon`属性, 增加前置图标, 图标的名字, 参考前面的章节。 + +```html +编辑 +删除 +静态菊花图标 +动态加载图标 +提交 +``` + +
+ 编辑 + 删除 + 静态菊花图标 + 动态加载图标 + 提交 +
+ +### 特殊属性 +有2个特殊属性`round`和`circle`, 可以控制按钮的圆角半径, 如果有其他半径需求, 可以直接通过css设置`border-radius`。 + +`注:` circle属性会让移除掉按钮内文字, 只能用图标 + +```html +圆角矩形 +圆角矩形 +圆角矩形 + + + +``` + +
+ 圆角矩形 + 圆角矩形 + 圆角矩形 + + + +
+ + +### 完整APIs + +| 属性 | 值类型 | 默认值 | 描述 | +| :-: | :-: | :-: | - | +| type | String | 无 | 按钮类型, 仅能决定按钮的颜色, 无额外作用, 可选值有: primary、info、success、warning、default、inverse、danger | +| size | String | default | 按钮尺寸, 可选值有: large、medium、small、mini | +| loading | Boolean | false | 按钮的加载状态, 为true时, 按钮会呈现loading动画, 且按钮点击事件无效 | +| disbaled | Boolean | false | 按钮的禁用状态, 为true时, 按钮点击事件无效 | +| icon | String | 无 | 为按钮设置前置图标 | +| round | 无 | 无 | 为按钮设置大圆角半径。 不需要赋值 | +| circle | 无 | 无 | 设置为正圆按钮, 且会让文字失效。 不需要赋值 | +| autofocus | 无 | 无 | 让按钮自动获得焦点。 不需要赋值 | +| lazy | Number | 0 | 为按钮设置节流防抖, 单位毫秒, 设置一个大于0的值之后, 在指定毫秒之内, 无法多次触发点击事件 | \ No newline at end of file diff --git a/src/pages/@wcui/docs/app.vue b/src/pages/@wcui/docs/app.vue index f42d12e..8f6fb62 100644 --- a/src/pages/@wcui/docs/app.vue +++ b/src/pages/@wcui/docs/app.vue @@ -1,7 +1,7 @@