https://github.com/aminya/solid-simple-table

Blazing fast Table component with solid-js
https://github.com/aminya/solid-simple-table

component fast react solid solid-js svelte table vue

Last synced: about 1 month ago
JSON representation

Blazing fast Table component with solid-js

• Host: GitHub
• URL: https://github.com/aminya/solid-simple-table
• Owner: aminya
• License: mit
• Created: 2020-12-24T06:57:44.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2023-11-26T03:25:51.000Z (about 1 year ago)
• Last Synced: 2024-10-10T12:31:10.298Z (2 months ago)
• Topics: component, fast, react, solid, solid-js, svelte, table, vue
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/solid-simple-table
• Size: 1.1 MB
• Stars: 53
• Watchers: 4
• Forks: 7
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-blazingly-fast - solid-simple-table - Blazing fast Table component with solid-js (TypeScript)
• awesome-solid-js - Solid Simple Table - simple-table)) (📦 Components & Libraries / UI Components)

README

        
# Solid SimpleTable

![CI](https://github.com/aminya/solid-simple-table/workflows/CI/badge.svg)

Solid SimpleTable is a blazing fast reactive table component that gives you freedom.

### Features

- Very fast as it is compiled down to VanilaJS using Solid

- Very small (~2.7KB)

- Automatic sorting

- Support for custom header and row renderers (so the cells can be components themselves)

- Support for custom sort functions

- Support for onClick on all rows

- Support for DOM accessors

- The library is fully tested with 90% of code coverage.

![Simple table demo](other/simple-table-demo.gif)

This library is production ready. It is currently used as the linter panel of Atom editor!

![Atom Linter Panel](other/atom-linter-panel.png)

## Installation

      npm install --save solid-simple-table

## Usage

[**Run demo here!**](https://aminya.github.io/solid-simple-table/)

```js

import { render } from "solid-js/web"

import { SimpleTable } from "solid-simple-table"

import type { SortDirection } from "solid-simple-table"

const rows = [

  { file: "C:/a", message: "Folder a", severity: "error" },

  { file: "C:/b", message: "Folder b", severity: "warning" },

  { file: "C:/c", message: "Folder c", severity: "info" },

  { file: "C:/d", message: "Folder d", severity: "error" },

]

function MyTable() {

  return 

}

render(() => , document.getElementById("app"))

```

The css is available under `dist/SimpleTable.css` which you can import into HTML:

```html

```

or in JavaScript:

```js

import "solid-simple-table/dist/SimpleTable.css";

```

For other examples, see [the demo folder](https://github.com/aminya/solid-simple-table/tree/master/demo).

## API

```ts

  // Optional props:

  // columns

  // manually provided columns

  columns?: Array>

  /**

    if columns is not provided and Row is an object, construct columns based on this row

    Takes this Row's keys as Column IDs

    @default 0 (first row)

  */

  representativeRowNumber?: number

  // renderers

  headerRenderer?(column: Column): string | Renderable

  bodyRenderer?(row: Row, columnID: K): string | Renderable

  // dynamic CSS classes for table cells

  headerCellClass?(column: Column): string

  bodyCellClass?(row: Row, columnID: K): string

  // the class name to be used instead of the provided default. The default value is `solid-simple-table light typography`

  className?: string

  // extra styles

  style?: JSX.CSSProperties | string

  // sort options

  defaultSortDirection?: NonNullSortDirection

  rowSorter?(rows: Array, sortDirection: NonNullSortDirection): Array

  // accessors

  /**

    set to true if you want column, row, and cell accessors

    @default false

  */

  accessors?: boolean

  /** a function that takes row and returns string unique key for that row

    @default {defaultGetRowID}

  */

  getRowID?(row: Row): string

/>;

```

In which:

```ts

// util types

export type Renderable = any

export type IndexType = string | number

// row and column types

export type Row = number | string | Record

export type Column = {

  id: K

  label?: string

  sortable?: boolean

  onClick?(e: MouseEvent, row: Row): void

}

/**

 * Sort direction. It is a tuple:

 *

 * @type is The direction of the sort

 * @columnID is the key used for sorting

 */

export type NonNullSortDirection = [columnID: K, type: "asc" | "desc"]

export type SortDirection = NonNullSortDirection | [columnID: null, type: null]

```

## Projects using Solid-Table

- [Atom's Linter](https://github.com/steelbrain/linter-ui-default)

## License

This package is licensed under the terms of MIT License. Originally, it was inspired by [sb-react-table](https://github.com/steelbrain/react-table/tree/2f8472960a77ca6cf2444c392697772716195bf4).