gotin-ui v0.2.32-beta

Gotin UI

目录

├─ README.md
├─ build                // 构建相关
├─ dist                 // 构建输出目录
│    ├─ gotin-ui        // 主包
│    └─ types
├─ docs                 // 文档
├─ example              // 本地示例
├─ packages
│    ├─ assets          // 静态资源
│    ├─ components      // 组件
│    ├─ gotin-ui        // 构建基础目录
│    ├─ hooks
│    ├─ theme
│    ├─ locale          // 多语言
│    ├─ tokens
│    └─ utils
├─ scripts              // 脚本
├─ typings
├─ package.json
├─ pnpm-lock.yaml
├─ pnpm-workspace.yaml  // workspace配置文件
└─ tsconfig.json

基础指令

安装依赖

使用pnpm，在根目录安装依赖。

pnpm install

本地调试

pnpm dev

构建

构建node版本要求16+。

pnpm build

使用指南

// 引用样式文件
import 'gotin-ui/theme/index.css'

// 引入组件
import {GtButton, GtBack} from 'gotin-ui'

注：此示例为构建发布后示例

开发须知

本地调试

example为本地测试目录，packages为编写模块目录。

在example引入packages模块方式如下：

// 引用样式文件
import '@gotin-ui/theme/src/index.css'

// 使用组件
import {GtButton, GtBack} from '@gotin-ui/components'

组件相关

• Vue组件编写建议使用defineComponent
• packages/components下添加组件，需要在同级 index 下导出；
• packages/gotin-ui/component.ts中引入

样式文件

• 在packages/theme/目录下，新建组件对应的样式文件

静态资源

• packages/assets存放静态资源

模块引用

如，在packages/components组件中中引入packages/hooks内容

import { useLocale } from '@gotin-ui/hooks'