mirror of
https://github.com/VisActor/VTable
synced 2024-11-22 18:57:38 +00:00
94 lines
2.5 KiB
Markdown
94 lines
2.5 KiB
Markdown
<div align="center">
|
|
<a href="" target="_blank">
|
|
<img alt="VisActor Logo" width="200" src="https://github.com/VisActor/.github/blob/main/profile/500_200.svg"/>
|
|
</a>
|
|
</div>
|
|
|
|
<div align="center">
|
|
<h1>React-VTable</h1>
|
|
</div>
|
|
|
|
<div align="center">
|
|
|
|
VTable is not just a high-performance multidimensional data analysis table, but also a grid artist that creates art between rows and columns.React-VTable is a React wrapper of VTable.
|
|
|
|
[![npm Version](https://img.shields.io/npm/v/@visactor/vtable.svg)](https://www.npmjs.com/package/@visactor/react-vtable)
|
|
[![npm Download](https://img.shields.io/npm/dm/@visactor/vtable.svg)](https://www.npmjs.com/package/@visactor/react-vvtable)
|
|
[![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/visactor/vtable/blob/main/LICENSE)
|
|
|
|
</div>
|
|
|
|
# Usage
|
|
|
|
## Installation
|
|
|
|
[npm package](https://www.npmjs.com/package/@visactor/react-vtable)
|
|
|
|
```bash
|
|
// npm
|
|
npm install @visactor/react-vtable
|
|
|
|
// yarn
|
|
yarn add @visactor/react-vtable
|
|
```
|
|
|
|
## Quick Start
|
|
|
|
```jsx
|
|
import React from 'react';
|
|
import ReactDOM from 'react-dom/client';
|
|
import { ListTable } from "@visactor/react-vtable";
|
|
|
|
const option = {
|
|
header: [
|
|
{
|
|
field: "0",
|
|
title: "name",
|
|
},
|
|
{
|
|
field: "1",
|
|
title: "age",
|
|
},
|
|
{
|
|
field: "2",
|
|
title: "gender",
|
|
},
|
|
{
|
|
field: "3",
|
|
title: "hobby",
|
|
},
|
|
],
|
|
records: new Array(1000).fill(["John", 18, "male", "🏀"]),
|
|
};
|
|
|
|
ReactDOM.createRoot(document.getElementById('root') as HTMLElement).render(
|
|
<ListTable option={option} height={'500px'}/>
|
|
);
|
|
```
|
|
|
|
##
|
|
|
|
[More demos and detailed tutorials](https://visactor.io/vtable)
|
|
|
|
# Related Links
|
|
|
|
- [Official website](https://visactor.io/vtable)
|
|
|
|
# Ecosystem
|
|
|
|
| Project | Description |
|
|
| ----------------------------------------------------------- | -------------------------------------------------------------------------------------- |
|
|
| [AI-generated Components](https://visactor.io/ai-vtable) | AI-generated table component. |
|
|
|
|
# Contribution
|
|
|
|
If you would like to contribute, please read the [Code of Conduct ](./CODE_OF_CONDUCT.md) 和 [ Guide](./CONTRIBUTING.zh-CN.md) first。
|
|
|
|
Small streams converge to make great rivers and seas!
|
|
|
|
<a href="https://github.com/visactor/vtable/graphs/contributors"><img src="https://contrib.rocks/image?repo=visactor/vtable" /></a>
|
|
|
|
# License
|
|
|
|
[MIT License](./LICENSE)
|