0.0.3 • Published 2 years ago
uih-fixed-ui-test v0.0.3
uih-fixed-ui 使用文档第三版
一、使用方法
uih-fixed-ui 发布于npm 网站。可以使用常规安装包方式进行安装。我们推荐使用 npm 或 yarn 的方式进行开发,不仅可在开发环境轻松调试,也可放心地在生产环境打包部署使用,享受整个生态圈和工具链带来的诸多好处。
npm install uih-fixed-ui
or
yarn add uih-fixed-ui
二、引入样式文件
uih-fixed-ui 中内置明暗两套主题样式,其中包含antd-design样式,不需要额外引入。
import 'uih-fixed-ui/style/index.less';
or
import 'uih-fixed-ui/style/index.css';
三、组件类名定义与使用
遵循ued-fe前端代码规范,为提高团队协作效率,规范文件管理,方便项目后期维护,提高代码质量,特制订此文档,前端开发规范-目录与命名规范(antd 控件库分险分析/目录与命名规范.md) uih-fixed-ui在遵循 ued-fe 前端代码规范下,制定如下类名:
- 在组件添加 uih-组件名即可获得定义样式。
组件名称 | 添加类名 |
---|---|
Default Button | uih-button |
uih-input |
- 如特殊组件select ,dropdown 之类,含有下拉菜单,并有overlayClassName , dropdownClassName ,之类的api , 应设置api的值为 uih-组件名-wrapper。
举个:chestnut:
<a-select class="uih-select" overlayClassName="uih-select-wrapper">
<a-select-option value="lucy">lucy</a-select-option>
</a-select>
特殊情况会在文档中补充说明。
四、换肤支持
uih-fixed-ui 中内置明暗两套主题,在body 上切换类名更换主题。切换时应注意将当前主题状态保存至本地缓存。
.uih-light-theme 代表明亮主题
.uih-dark-theme 代表黑暗主题