Swimlane/ngx-datatable: A Feature-rich Yet Lightweight Data ... - GitHub

ngx-datatable

ngx-datatable is an Angular component for presenting large and complex data. It has all the features you would expect from any other table but in a light package with no external dependencies. The table was designed to be extremely flexible and light; it doesn't make any assumptions about your data or how you: filter, sort or page it.

Check out the documentation & demos for more information!

See the changelog for recent changes.

Features

• Handle large data sets ( Virtual DOM )
• Expressive Header and Cell Templates
• Horizontal & Vertical Scrolling
• Column Reordering & Resizing
• Client/Server side Pagination & Sorting
• Intelligent Column Width Algorithms ( Force-fill & Flex-grow )
• Integrated Pager
• Cell & Row Selection ( Single, Multi, Keyboard, Checkbox )
• Fixed AND Fluid height
• Left and Right Column Pinning
• Row Detail View
• Decoupled theme'ing with included Google Material theme
• Light codebase / No external dependencies
• AoT Compilation Support
• Universal Support

Installation

To use ngx-datatable in your project install it via npm:

npm i @swimlane/ngx-datatable --save

Building

Run yarn build to build the project. The build artifacts will be stored in the dist/ directory.

Running tests

• Run yarn test to execute the linter, prettier check, unit and end-to-end tests.

Release

• Checkout master (git checkout master)
• Pull master (git pull)
• Refresh node modules (yarn install --frozen-lockfile)
• Run tests (yarn test)
• Examine log to determine next version (X.Y.Z)
• Run git checkout -b release/X.Y.Z
• Update version in projects/swimlane/ngx-datatable/package.json.
• Update changelog in docs/CHANGELOG.md
• Run yarn package to build the package
• Run git commit -am "(release): X.Y.Z"
• Run git tag X.Y.Z
• Run git push origin HEAD --tags
• Run yarn publish
• Submit PR

Credits

ngx-datatable is a Swimlane open-source project; we believe in giving back to the open-source community by sharing some of the projects we build for our application. Swimlane is an automated cyber security operations and incident response platform that enables cyber security teams to leverage threat intelligence, speed up incident response and automate security operations.