About

Table Scroll Shadow enables easy responsive tables by checking if the table overflows it's container across all viewports. When overflow is present, it allows horizontal scrolling whilst adding an extra visual indicator in the shape of shadows to make it more obvious where the overflow is.

Here are a few key features of the plugin:

• Small file size, coming in at only 3 kB
• No jQuery dependency
• Built in options
• Just install and enjoy!

Getting Started

Step 1

Pull in the latest version of the plugin with one of the following commands:

NPM

npm install table-scroll-shadow

Yarn

yarn add table-scroll-shadow

Step 2

Once you have installed the plugin, you will need to add a little bit of necessary markup around the tables that you want to scroll (the class names can be changed via the options).

<div class="table-wrapper">
  <div class="table-scroll">
    <table>
      <!-- Tabular data here -->
    </table>
  </div>
</div>

Step 3

The plugin can be referenced via the global variable, TableScrollShadow.

const table = new TableScrollShadow()
table.init()

Options

All options for this plugin are optional, and have sensible defaults. The defaults are shown below:

TableScrollShadow({
  wrapperClass: '.table-wrapper',
  scrollAreaClass: '.table-scroll',
  shadowColor: 'rgba(0, 0, 0, 0.25)',
  shadowSize: '2em',
  throttleDelay: 75
})

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE.md for more information.

Contact

Gauthier Blanpain - [email protected]

Project Link: https://github.com/gauthierblanpain/table-scroll-shadow