ShadowUI3

# 指南

ShadowUI3 是一个功能丰富、易于使用的 UI 组件库，本指南将帮助您快速上手并充分利用其功能。

# 快速开始

# 目录结构

# 文档目录结构

ShadowUI3 文档采用清晰的目录结构，方便您查找所需信息：

  • 安装说明：如何在您的项目中安装和配置 ShadowUI3
  • 开发指南：组件开发的最佳实践和规范
  • 主题定制：如何自定义组件样式以匹配您的设计需求

# 项目目录结构

ShadowUI3 组件库的项目目录结构如下：

shadow-ui/
│  changelog.md          # 变更日志
│  index.js             # 入口文件
│  package.json         # 包配置
│  readme.md            # 项目说明
│  validator.md         # 验证规则
│
├─components/           # 组件目录
│  ├─ui-alert/          # 提示框组件
│  ├─ui-avatar/         # 头像组件
│  ├─ui-avatar-group/   # 头像组组件
│  ├─ui-backtop/        # 返回顶部组件
│  ├─ui-bar-height/     # 状态栏高度组件
│  ├─ui-body-height/    # 页面高度组件
│  ├─ui-button/         # 按钮组件
│  ├─ui-card/           # 卡片组件
│  ├─ui-cell/           # 单元格组件
│  ├─ui-collapse/       # 折叠面板组件
│  ├─ui-color-picker/   # 颜色选择器组件
│  ├─ui-digital/        # 数字滚动组件
│  ├─ui-divider/        # 分隔线组件
│  ├─ui-drawer/         # 抽屉组件
│  ├─ui-drawer-h/       # 水平抽屉组件
│  ├─ui-empty/          # 空状态组件
│  ├─ui-form/           # 表单组件
│  ├─ui-form-checkbox/  # 复选框组件
│  ├─ui-form-checkbox-group/ # 复选框组组件
│  ├─ui-form-checkbox-tag/ # 标签复选框组件
│  ├─ui-form-input/     # 输入框组件
│  ├─ui-form-item/      # 表单项组件
│  ├─ui-form-numberBox/ # 数字输入框组件
│  ├─ui-form-radio/     # 单选框组件
│  ├─ui-form-radio-group/ # 单选框组组件
│  ├─ui-form-radio-tag/ # 标签单选框组件
│  ├─ui-form-switch/    # 开关组件
│  ├─ui-form-textarea/  # 文本域组件
│  ├─ui-headbox/        # 头部盒子组件
│  ├─ui-image/          # 图片组件
│  ├─ui-load/           # 加载更多组件
│  ├─ui-loading/        # 加载中组件
│  ├─ui-loadmask/       # 加载遮罩组件
│  ├─ui-modal/          # 模态框组件
│  ├─ui-msg/            # 消息提示组件
│  ├─ui-navbar/         # 导航栏组件
│  ├─ui-picker/         # 选择器组件
│  ├─ui-preview/        # 图片预览组件
│  ├─ui-progress/       # 进度条组件
│  ├─ui-slide/          # 轮播图组件
│  ├─ui-slider/         # 滑块组件
│  ├─ui-sticky/         # 粘性定位组件
│  ├─ui-tabs/           # 标签页组件
│  ├─ui-tag/            # 标签组件
│  ├─ui-text/           # 文本组件
│  ├─ui-time/           # 时间组件
│  ├─ui-time-line/      # 时间线组件
│  ├─ui-time-rule/      # 时间规则组件
│  ├─ui-title/          # 标题组件
│  ├─ui-tooltip/        # 提示气泡组件
│  └─ui-upload/         # 上传组件
│
├─libs/                 # 工具库
│  │  mixin.js          # 混入函数
│  │
│  └─func/              # 功能函数
│          debounce.js  # 防抖函数
│          index.js     # 函数入口
│          route.js     # 路由相关
│          test.js      # 测试函数
│          throttle.js  # 节流函数
│
├─pages/                # 页面目录
│  └─shadow-ui/         # 示例页面
│          shadow-ui.vue
│
├─static/               # 静态资源
│      iconfont.scss    # 图标样式
│      iconfont.ttf     # 图标字体
│      tool.scss        # 工具样式
│
├─uniCloud-aliyun/      # 阿里云云函数
│  └─cloudfunctions/    # 云函数目录
│      └─shadow/        # 示例云函数
│              index.js
│              package.json
│
└─utils/                # 工具函数
        city.js         # 城市数据
        emitter.js      # 事件发射器
        express.js      # 表达式解析
        formValidation.js # 表单验证
        time.js         # 时间处理

# 开始使用

请从 安装说明 开始，了解如何在您的项目中集成 ShadowUI3。

# 贡献

如果您有任何建议或想要贡献代码，请参考我们的 贡献指南（即将推出）。

# 问题反馈

如有任何问题或bug，请在 GitHub Issues (opens new window) 中提交。

安装说明 →