# experium-react-sticky-table

> Dynamically sized fixed header and columns for tables

Latest version **1.3.0** (published 2018-12-27) · MIT license · 0 weekly downloads

## Install

```sh
npm install experium-react-sticky-table
pnpm add experium-react-sticky-table
yarn add experium-react-sticky-table
bun add experium-react-sticky-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.3.0 |
| Published | 2018-12-27 |
| First published | 2017-06-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 339.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Weflow |
| Maintainers | experium |
| Keywords | react-component, table, sticky, table, fixed, table, header, column |

## Links

- npm: https://www.npmjs.com/package/experium-react-sticky-table
- Repository: https://github.com/experium/react-sticky-table
- Issues: https://github.com/experium/react-sticky-table/issues
- npm.io page: https://npm.io/package/experium-react-sticky-table

## Dependencies (1)

- [element-resize-event](https://npm.io/package/element-resize-event.md) ^3.0.3

## 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.3.0 (latest) — 2018-12-27
- 1.2.0 — 2017-11-27
- 1.1.0 — 2017-11-27
- 1.0.3 — 2017-06-28
- 1.0.2 — 2017-06-28
- 1.0.1 — 2017-06-27

## README

# Experium Sticky Table

[![Build Status](https://travis-ci.org/experium/react-sticky-table.svg?branch=master)](https://travis-ci.org/experium/react-sticky-table)

Responsive and dynamically-sized fixed headers and columns for tables forked from [henrybuilt](https://henrybuilt.github.io/react-sticky-table/).

## Features

- Optional fixed columns & header
- Responsive table dimensions (wrap it in any size container and it will fill that container)
- Dynamic row height & column width (no need to specify width and height in pixels)
- Rows and columns resize as content resizes
- Scrollbars that are smooth and visible at all times

## Getting Started

Install `experium-react-sticky-table` using `npm`.

```
npm install experium-react-sticky-table --save
```

Make sure you import the mandatory stylesheet: [react-sticky-table/dist/react-sticky-table.css](https://github.com/henrybuilt/react-sticky-table/blob/master/dist/react-sticky-table.css). Feel free to overwrite it, though. It should be unobtrusive.

## Example
```javascript
import React, { Component } from 'react';

import { StickyTable, Row, Cell } from 'react-sticky-table';
import 'react-sticky-table/dist/react-sticky-table.css';

export default class BasicExample extends Component {
  render() {
    return (
        <div style={{width: '100%', height: '400px'}}>
          <StickyTable>
            <Row>
              <Cell>Header 1</Cell>
              <Cell>Header 2</Cell>
            </Row>
            <Row>
              <Cell>Cell 1</Cell>
              <Cell>Cell 2</Cell>
            </Row>
          </StickyTable>
        </div>
    );
  }
}
```

## Options

Default settings:

```javascript
{
  stickyHeaderCount: 1,
  stickyColumnsCount: 1
}
```

Disable sticky header:

```javascript
<StickyTable stickyHeaderCount={0}>
```

Disable sticky column:

```javascript
<StickyTable stickyColumnsCount={0}>
```

## Events

Scroll event:

```javascript
<StickyTable onScroll={function(object) {}}>
```

Scroll event object:

```javascript
{
  scrollTop: 0,
  scrollHeight: 2304,
  clientHeight: 259,
  scrollLeft: 0,
  scrollWidth: 27953,
  clientWidth: 887
}
```

## License

(The MIT License)

Copyright (c) 2017 Henrybuilt.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

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