@kordar-lib/common
v2.0.0
Published
通用样式与基础类型集合: - 样式:内置大量颜色类名(.color-xxx),打包输出 dist/index.min.css,便于在任意项目中即用即取 - 类型:提供通用 UI 类型定义(当前包含面包屑 Breadcrumb 相关类型)
Readme
@kordar-lib/common
通用样式与基础类型集合:
- 样式:内置大量颜色类名(.color-xxx),打包输出 dist/index.min.css,便于在任意项目中即用即取
- 类型:提供通用 UI 类型定义(当前包含面包屑 Breadcrumb 相关类型)
特性
- 颜色工具类
- 基于 SCSS 预置上百种颜色类:.color-black、.color-blue、.color-red 等
- 通过打包生成 dist/index.min.css,可直接在应用中按需引入
- 基础类型
- 面包屑类型:BreadcrumbItem、BreadcrumbProps、BreadcrumbState
- 仅类型定义,不绑定具体框架实现,适合复用
安装
npm install @kordar-lib/common样式引入
全量引入打包后的样式:
import '@kordar-lib/common/dist/index.min.css'HTML 使用示例:
<span class="color-red">Red</span>
<span class="color-deep-sky-blue">DeepSkyBlue</span>类型使用
按需引入并在 TS 中使用类型:
import type { BreadcrumbItem, BreadcrumbProps, BreadcrumbState } from '@kordar-lib/common'
const items: BreadcrumbItem[] = [
{ label: '首页', path: '/' },
{ label: '列表', path: '/list' },
{ label: '详情' }
]
const props: BreadcrumbProps = {
hasBack: true,
backIcon: 'arrow-left',
items
}导出一览
- assets
- dist/index.min.css:颜色工具类集合
- component
- BreadcrumbItem
- BreadcrumbProps
- BreadcrumbState
构建与类型(Monorepo:npm)
在仓库根目录执行:
npm install
npm run -w @kordar-lib/common build类型检查:
npm exec -w @kordar-lib/common -- tsc -p tsconfig.json --noEmit许可证
MIT
