drip-table/README.zh-CN.md

<a href='http://drip-table.jd.com/'>
  <h1 style="display: flex; align-items: center; justify-content: center">
    <img src='https://storage.360buyimg.com/imgtools/7e0e546a96-d962c880-f9a2-11eb-bf08-d585041b7c80.svg'/>
    <span style="margin-left: 10px">Drip Table</span>
  </h1>
</a>

[English](./README.md) | 简体中文 | [官方文档](http://drip-table.jd.com/) | [讨论组](https://github.com/JDFED/drip-table/discussions)

<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->

[contributors]: https://img.shields.io/badge/all_contributors-2-orange.svg?style=flat-square "Number of contributors on All-Contributors"

<!-- ALL-CONTRIBUTORS-BADGE:END -->

[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE)
[![npm version](https://img.shields.io/npm/v/drip-table.svg?style=flat)](https://www.npmjs.com/package/drip-table)
![node](https://img.shields.io/badge/node-%3E%3D13.14.0-blue.svg)
![yarn](https://img.shields.io/badge/yarn-%3E%3D1.0.0-blue.svg)
![document](https://img.shields.io/badge/documentation-yes-brightgreen.svg)
![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)
[![All Contributors][contributors]](./CONTRIBUTORS.md)

## 📖 介绍

`DripTable` 是京东零售推出的一款用于企业级中后台的动态列表解决方案，项目基于 `React` 和 `JSON Schema`，旨在通过`简单配置`快速生成页面动态列表来降低 `CMS` 页面列表开发难度、提高工作效率。

`DripTable` 目前包含以下子项目：`drip-table`、`drip-table-generator`、`drip-table-driver-antd`。

各个子项目具体介绍如下：

- `drip-table`：动态列表解决方案的核心库，其主要能力是支持符合 `JSON Schema` 标准的数据自动渲染列表内容。

- `drip-table-generator`：一个可视化的用于 `DripTable` 配置 `JSON Schema` 标准的配置数据的生成工具。

- `drip-table-driver-antd`： 一个 `Ant Design` UI 组件库主题包。

## ⬆️ 开始使用

`DripTable` 分为两种应用场景：配置端和应用端。配置端主要负责通过可视化方式和 `low-code` 方式进行 `JSON Schema` 标准数据的生成。应用端的职能则是将 `JSON Schema` 标准配置数据渲染成动态列表。

### 配置端

1. 安装依赖

   配置端依赖应用端，安装前先确保已安装 `drip-table` 和 `drip-table-driver-{drivername}`。

   > yarn

   ```sh
   yarn add drip-table-generator
   ```

   > npm

   ```sh
   npm install --save drip-table-generator
   ```

2. 在文件开头引入依赖

   ```js
   import DripTableGenerator from "drip-table-generator";
   import "drip-table-generator/dist/index.css";
   ```

3. 在页面中引用

   ```js
   return <DripTableGenerator />;
   ```

   配置端正常渲染效果如下：

   ![drip-table-generator](https://img10.360buyimg.com/imagetools/jfs/t1/209919/9/12490/4540144/61b71921Ee35a9a3c/e2f7167fef822f17.gif)

### 应用端

1. 安装依赖

   同时安装 `drip-table` 和 `drip-table` 主题包：

   > yarn

   ```sh
   yarn add drip-table drip-table-driver-{drivername}
   ```

   > npm

   ```sh
   npm install --save drip-table drip-table-driver-{drivername}
   ```

   目前可选列表如下：

   - drip-table-driver-antd

2. 在文件开头引入依赖

   ```js
   // 引入 drip-table
   import DripTable from "drip-table";
   // 引入主题包，以 antd 为例
   import DripTableDriverAntDesign from "drip-table-driver-antd";
   // 引入 ant-design 样式
   import "antd/dist/antd.css";
   // 引入 drip-table 样式
   import "drip-table/dist/index.css";
   ```

3. 引用

   ```js
   const schema = {
     $schema: "http://json-schema.org/draft/2019-09/schema#",
     configs: {
       size: "middle",
     },
     columns: [
       {
         $id: "id",
         title: "名称",
         "ui:type": "text",
         "ui:props": { mode: "single" },
         type: "string",
         dataIndex: "dataIndexName",
       },
     ],
   };
   return (
     <DripTable
       driver={DripTableDriverAntDesign}
       schema={schema}
       dataSource={[]}
     />
   );
   ```

   应用端正常渲染效果如下：

   ![drip-table-demo](https://img13.360buyimg.com/imagetools/jfs/t1/217000/18/7528/191045/61b6d9ebE1c96d83b/a63b8edce7757bd8.png)

## 🤝 开发手册

如果您对这个项目感兴趣，欢迎提 ✨[issue](https://github.com/JDFED/drip-table/issues) ，也欢迎 ❤️[star](https://github.com/JDFED/drip-table) 支持一下。

### 本地运行

1. 克隆项目

   ```sh
   git clone https://github.com/JDFED/drip-table.git
   ```

2. 安装依赖

   ```sh
   lerna bootstrap
   ```

3. 运行项目

   ```sh
   yarn start
   ```

- 访问 http://localhost:8000
- `drip-table` 示例路由：/drip-table/guide/basic-demo
- `drip-table-generator` 示例路由：/drip-table-generator/preview

更多命令请查看 [DEVELOP](./DEVELOP.zh-CN.md) 。
官网地址请访问 [drip-table](http://drip-table.jd.com/) 。

## License

[MIT License](./LICENSE)