0.1.116 • Published 2 years ago

qcraft-comp v0.1.116

Weekly downloads
-
License
MIT
Repository
-
Last release
2 years ago

Arco 物料库

物料平台文档中心

快速开始

# 添加组件
npm run add:component -- YourComponentName

# 开发模式
npm run dev

# 构建
npm run build

# 发布至物料平台(需先发布 NPM 包)
arco sync

样式

components/style 下,你可以编写全局样式。

components/*/style/index.tsx 用于组件样式的按需加载,你需要在此文件中声明该组件依赖的其他组件样式。 例如:组件 A 内使用到了组件 B,则按需加载 A 的样式时同样需要加载 B 的样式,故需要在 components/A/style/index.tsx 中声明 import '../../B/style'

提供 Demo

Demo 目录位于 components/*/demo。在 demo/index.js 中,通过 JSDoc 的语法提供物料及各个 Demo 的相关信息。

// src/demo/index.js

/**
 * @file
 * @title 名称
 * @memberOf 数据录入
 * @description 一段对于物料的描述。
 * @author 物料作者
 */

/**
 * @title 基础用法
 * @description 一个物料最基本的使用方式。
 */
export { default as Basic } from './basic';

API 文档

为了帮助他人更好地使用你的组件,请提供详细的 API 文档。

书写注释

我们提供了自动化的文档生成工具,它从 TS 接口定义中提取注释自动生成属性文档。按照以下指引使用,为接口书写 tsDoc 类型的注释:

/**
 * @title Button (必填,带有 `title` 描述的接口或者类型才会被收集)
 */
interface ButtonProps {
  /**
   * @zh 按钮尺寸 (属性的中文描述)
   * @en Size of Button (属性的英文描述)
   * @version 1.2.0 (可选,新增的属性在哪个版本开始支持)
   * @defaultValue 'default' (可选,属性的默认值)
   */
  size?: 'mini' | 'small' | 'default' | 'large';
  /**
   * @zh 按钮状态
   * @en Status of Button
   */
  status?: 'danger' | 'error' | 'success';
}

扩展 TEMPLATE.md

TEMPLATE.md 是用于自动文档生成的模板,你可以修改此文件添加更多组件的使用帮助信息,但请不要删除其原有的内容,否则可能导致内容替换失败。

// TEMPLATE.md
---
file: index,interface (可以指定多个文档提取的入口文件,使用逗号隔开)
---

# TooltipButton

## 属性/Props

%%Props%%

### OtherProps

在这里你可以书写更多组件帮助文档。

## Demos

%%Demos%%

测试

测试目录位于 components/*/__test__。你可以在 index.test.tsx 中编写你的测试用例,在 demo.test.tsx 中可以进行基于 Demo 的快照测试。

npm run test 命令允许你传入任何 jest 的命令行参数,例如 npm run test -- --u npm run test -- --no-cache

0.1.116

2 years ago

0.1.114

2 years ago

0.1.113

2 years ago

0.1.115

2 years ago

0.1.112

2 years ago

0.1.111

2 years ago

0.1.96

2 years ago

0.1.97

2 years ago

0.1.98

2 years ago

0.1.99

2 years ago

0.1.95

2 years ago

0.1.107

2 years ago

0.1.106

2 years ago

0.1.109

2 years ago

0.1.108

2 years ago

0.1.103

2 years ago

0.1.102

2 years ago

0.1.105

2 years ago

0.1.104

2 years ago

0.1.101

2 years ago

0.1.100

2 years ago

0.1.90

3 years ago

0.1.91

3 years ago

0.1.92

3 years ago

0.1.93

3 years ago

0.1.94

3 years ago

0.1.85

3 years ago

0.1.86

3 years ago

0.1.87

3 years ago

0.1.88

3 years ago

0.1.89

3 years ago

0.1.80

3 years ago

0.1.81

3 years ago

0.1.82

3 years ago

0.1.83

3 years ago

0.1.84

3 years ago

0.1.77

3 years ago

0.1.78

3 years ago

0.1.79

3 years ago

0.1.74

3 years ago

0.1.75

3 years ago

0.1.76

3 years ago

0.1.70

3 years ago

0.1.71

3 years ago

0.1.72

3 years ago

0.1.73

3 years ago

0.1.68

3 years ago

0.1.69

3 years ago

0.1.52

3 years ago

0.1.53

3 years ago

0.1.54

3 years ago

0.1.10

3 years ago

0.1.55

3 years ago

0.1.11

3 years ago

0.1.12

3 years ago

0.1.57

3 years ago

0.1.13

3 years ago

0.1.58

3 years ago

0.1.14

3 years ago

0.1.59

3 years ago

0.1.15

3 years ago

0.1.50

3 years ago

0.1.51

3 years ago

0.1.49

3 years ago

0.1.41

3 years ago

0.1.42

3 years ago

0.1.43

3 years ago

0.1.44

3 years ago

0.1.45

3 years ago

0.1.46

3 years ago

0.1.47

3 years ago

0.1.48

3 years ago

0.1.40

3 years ago

0.1.38

3 years ago

0.1.39

3 years ago

0.1.9

3 years ago

0.1.30

3 years ago

0.1.31

3 years ago

0.1.32

3 years ago

0.1.33

3 years ago

0.1.34

3 years ago

0.1.35

3 years ago

0.1.36

3 years ago

0.1.37

3 years ago

0.1.27

3 years ago

0.1.28

3 years ago

0.1.29

3 years ago

0.1.63

3 years ago

0.1.64

3 years ago

0.1.20

3 years ago

0.1.65

3 years ago

0.1.21

3 years ago

0.1.66

3 years ago

0.1.22

3 years ago

0.1.67

3 years ago

0.1.23

3 years ago

0.1.24

3 years ago

0.1.25

3 years ago

0.1.26

3 years ago

0.1.60

3 years ago

0.1.61

3 years ago

0.1.62

3 years ago

0.1.16

3 years ago

0.1.17

3 years ago

0.1.18

3 years ago

0.1.19

3 years ago

0.1.8

3 years ago

0.1.7

3 years ago

0.1.4

3 years ago

0.1.6

3 years ago

0.1.5

3 years ago

0.1.3

3 years ago

0.1.2

3 years ago

0.1.1

3 years ago

0.1.0

3 years ago