# svelte-dx-table

> dx friendly svelte table component

Latest version **1.0.0** (published 2022-01-04) · MIT license · 0 weekly downloads

## Install

```sh
npm install svelte-dx-table
pnpm add svelte-dx-table
yarn add svelte-dx-table
bun add svelte-dx-table
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2022-01-04 |
| First published | 2022-01-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 49.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | thecodejack |
| Maintainers | thecodejack |
| Keywords | svelte, svelte3, svelte-components, svelte-dx-table, sveltejs |

## Links

- npm: https://www.npmjs.com/package/svelte-dx-table
- Repository: https://github.com/thecodejack/svelte-dx-table
- Homepage: https://github.com/thecodejack/svelte-dx-table#readme
- Issues: https://github.com/thecodejack/svelte-dx-table/issues
- npm.io page: https://npm.io/package/svelte-dx-table

## Alternatives

- [@lexical/table](https://npm.io/package/@lexical/table.md) — 3.0M weekly downloads
- [mantine-datatable](https://npm.io/package/mantine-datatable.md) — 98.2K weekly downloads
- [react-native-collapsible-tab-view](https://npm.io/package/react-native-collapsible-tab-view.md) — 70.6K weekly downloads
- [@handsontable/vue3](https://npm.io/package/@handsontable/vue3.md) — 16.1K weekly downloads
- [vuewordcloud](https://npm.io/package/vuewordcloud.md) — 7.2K weekly downloads

## Recent versions

- 1.0.0 (latest) — 2022-01-04
- 1.0.0-dev.0 — 2022-01-04

## README

# svelte-dx-table

[![NPM](https://img.shields.io/npm/v/svelte-dx-table.svg)](https://www.npmjs.com/package/svelte-dx-table)
[![npm bundle size (minified + gzip)](https://img.shields.io/bundlephobia/minzip/svelte-dx-table.svg)](https://www.npmjs.com/package/svelte-dx-table)

Simple dev friendly Svelte component for building a HTML Table with basic features like sorting by default. Generated component is a raw HTML one which has classes to apply styling as well.

You can generate table by just passing array of objects as following.

```svelte
<SimpleTable data={data} />
```

> Note: `svelte-dx-table` is for simplicity as of now. It is more of making a table out of array of objects instead spending time on building config to render a simple table. If you are looking for advanced features, would recommend to check [svelte-table](https://github.com/dasDaniel/svelte-table)

You can also provide `ignoreKeys` incase you want to ignore from default.

```svelte
<Table {data} ignoreKeys={["dob"]} />
```

Columns config(via `columns` prop) is not a array of objects instead it will be map, which can make you add config for a necessary columns only. Check example

```svelte
<Table {data} columns={{
      dob: {
        key: "dob",
        formatter: (val) => {
          return new Intl.DateTimeFormat("en-US").format(new Date(val));
        }
      }
    }}/>
```

> Note that `key` inside column config is mandatory.

If incase, you want to specify order of columns, you can use `keys` prop in which you can provide `keys` of row object in the order you want.

```svelte
<Table {data} keys={["name", "gender","age", "email"]} />
```

## Demo

[Click here for Storybook link](https://svelte-dx-table.netlify.app/)

## Installation

```
npm install svelte-dx-table

or

yarn add svelte-dx-table
```

## API

### Props

| Prop Name  | mandatory | Description                                                                                       | Default Value |
| ---------- | --------- | ------------------------------------------------------------------------------------------------- | ------------- |
| data       | yes       | rows of data that needs to be passed                                                              | []            |
| columns    |           | column config for necessary columns as a map. Refer following for more info available properties. | {}            |
| keys       |           | keys of array of objects(data) that needs to be rendered                                          | []            |
| ignoreKeys |           | ignore keys of object that shouldn't be rendered                                                  | []            |
| tableClass |           | class that needs to be added as part of Table                                                     | ""            |
| sortKey    |           | column/object key on which sort needs to be applied                                               | ""            |
| sortType   |           | "normal" or "reverse"                                                                             | "normal"      |

### keys of column config

| key Name     | Description                | definition                                       |
| ------------ | -------------------------- | ------------------------------------------------ |
| key          | key of objects in the data | mandatory field if added in column config        |
| header       |                            | `(key) => string`                                |
| format       |                            | `(val) => string`                                |
| headerClass  | string                     | ""                                               |
| sortFunction | compare function           | `(firstValue, SecondValue, key) => 1 or -1 or 0` |

As informed previously columns prop is a map. Check columns prop of following a reference

```svelte
<Table {data} columns={{
  dob: {
    key: "dob",
    formatter: (val) => {
      return new Intl.DateTimeFormat("en-US").format(new Date(val));
    },
  },
  age: {
    key: "age",
    formatter: (val) => {
      return `${val} years`;
    },
  }
}}/>

```

### Development

```
npm install
npm run storybook
```

## License

MIT

---
_Source: https://npm.io/package/svelte-dx-table · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._