https://github.com/vittxr/tw-table

table designed with tailwind and tanstack-table
https://github.com/vittxr/tw-table

npm-package react tailwindcss tanstack-table yarn-package

Last synced: about 1 month ago
JSON representation

table designed with tailwind and tanstack-table

• Host: GitHub
• URL: https://github.com/vittxr/tw-table
• Owner: vittxr
• License: mit
• Created: 2023-04-06T20:01:40.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-09-29T22:33:44.000Z (about 2 months ago)
• Last Synced: 2024-09-30T16:48:57.060Z (about 2 months ago)
• Topics: npm-package, react, tailwindcss, tanstack-table, yarn-package
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/tw-table
• Size: 599 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Summary

...

# Installation

- NPM

  `npm install tw-table`

- YARN

  `yarn add tw-table`

# Usage

To use the library, start by importing `tw-table`:

```js

import { Table } from 'tw-table';

```

If you need type definitions from `react-table`, you can import them as follows:

```js

import { RowSelectionState } from '@tanstack/react-table';

```

You'll also need to configure Tailwind CSS to generate the necessary styles for this library. To do this, include `'node_modules/tw-table/**/*.{js,ts,jsx,tsx}'` in the `content` array of your `tailwind.config.js` file.

Your final configuration should look like this:

```js

/** @type {import('tailwindcss').Config} */

export default {

  content: [

    './index.html',

    './src/**/*.{js,ts,jsx,tsx}',

    './node_modules/tw-table/**/*.{js,ts,jsx,tsx}',

  ],

  ...

};

```

# Contribution

...