1.0.0 • Published 1 year ago

lm-gallery v1.0.0

Weekly downloads
-
License
MIT
Repository
-
Last release
1 year ago

Development

# install dependencies
$ cnpm install

# develop library by docs demo
$ cnpm start

# build library source code
$ cnpm run build

# build library source code in watch mode
$ cnpm run build:watch

# build docs
$ cnpm run docs:build

# check your project for potential problems
$ cnpm run doctor

LICENSE

MIT

className 命名

注意组件 className 命名 不要使用 css module 的形式(不便于引入后修改名称)

目前迁移组件都使用 css module 形式进行命名、后续进行优化

样式问题

目前项目中的组件外都套了一层 外面套层 ConfigProviderAC,里面的 theme 统一了 border-radius、border-color 等 css 属性、组件封装记得检查相关属性样式与之前一致

vscode 插件

Fileheader Pro 用于文件头部注释信息

组件封装-基于 antd

组件基于 antd 的二次封装,组件命名带有AC标志,意为"add content"。

为了统一样式更改,二次封装需要修改前缀为 antd-lm 可参考 ButtonAC 组件

统一在组件内部文件夹修改样式

非二次封装 只修改样式 需要在.dumi 中 overrides.less 文件中修改

文档书写

文档中引用的示例不直接写在 md 文件中

通过 code 双标签来引用 demo 示例文件夹下的示例代码

API 目前手动书写、官方自动生成方案存在问题、后续考虑进行自动生成

组件分类

基础组件

业务组件

通知组件

数据展示

示例书写

统一写在组件内部文件夹 demo 文件夹下

命名可根据要展示的示例分组类型来 基础命名为 base.tsx

多个示例写在不同文件下