@omakase-ui/react-table/README.md

Omakase React Table Component.

# Welcome to @omakase-ui/react-table 👋

Omakase React Table Component.

[![Version](https://img.shields.io/npm/v/@omakase-ui/react-table.svg)](https://www.npmjs.com/package/@omakase-ui/react-table)
[![Documentation](https://img.shields.io/badge/documentation-yes-brightgreen.svg)](https://github.com/ThaddeusJiang/omakase-ui#readme)
[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://github.com/ThaddeusJiang/omakase-ui/graphs/commit-activity)
[![License: MIT](https://img.shields.io/github/license/ThaddeusJiang/omakase-ui)](https://github.com/ThaddeusJiang/omakase-ui/blob/dev/LICENSE)
[![Twitter: ThaddeusJiang](https://img.shields.io/twitter/follow/ThaddeusJiang.svg?style=social)](https://twitter.com/ThaddeusJiang)

## features

- [x] out of box react table component with beautiful style.
- [x] resize column size of table.
- [x] automatic animations

### 🏠 [Homepage](https://github.com/ThaddeusJiang/omakase-ui/tree/dev/packages/react-table#readme)

### ✨ [Demo](https://omakase-ui.vercel.app/react-table)

## Install

```sh
yarn add @omakase-ui/react-table @tanstack/react-table
```

## Usage

if you don't use [Tailwind CSS](https://tailwindcss.com/)

```ts
import { DataTable } from '@omakase-ui/react-table';
import '@omakase-ui/react-table/dist/index.css';

<DataTable columns={columns} data={data} sort={['name', 'asc']} />;
```

if you use [Tailwind CSS](https://tailwindcss.com/)

```ts
import { DataTable } from '@omakase-ui/react-table';

<DataTable columns={columns} data={data} sort={['name', 'asc']} />;
```

modify tailwind.config.js

```diff
// tailwind.config.js
+ const path = require("path");

module.exports = {
  content: [
    "./src/**/*{js,ts,jsx,tsx}",
+    path.join(
+      require.resolve("@omakase-ui/react-table"),
+      "../**/*.{js,ts,jsx,tsx}"
+    ),
  ],
  theme: {},
  plugins: [],
};
```

## Author

👤 **Thaddeus Jiang**

- Website: https://thaddeusjiang.com/
- Twitter: [@ThaddeusJiang](https://twitter.com/ThaddeusJiang)
- Github: [@ThaddeusJiang](https://github.com/ThaddeusJiang)

## 🤝 Contributing

Contributions, issues and feature requests are welcome!

Feel free to check [issues page](https://github.com/ThaddeusJiang/omakase-ui/issues). You can also take a look at the [contributing guide](https://github.com/ThaddeusJiang/omakase-ui/blob/dev/CONTRIBUTING.md).

## Show your support

Give a ⭐️ if this project helped you!

## 📝 License

Copyright © 2022 [Thaddeus Jiang](https://github.com/ThaddeusJiang).

This project is [MIT](https://github.com/ThaddeusJiang/omakase-ui/blob/dev/LICENSE) licensed.

---

_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_