JSPM

@revolist/revogrid

4.0.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 10198
  • Score
    100M100P100Q148873F
  • License MIT

Virtual reactive data grid spreadsheet component - RevoGrid.

Package Exports

  • @revolist/revogrid
  • @revolist/revogrid/loader
  • @revolist/revogrid/standalone

Readme

RevoGrid

Latest Version on NPM Software License Tree shaking Tree shaking

Powerful data grid component built with StencilJS.

Support Millions of cells and thousands of columns easy and efficiently for fast data rendering. Easy to use.

Demo and APIKey FeaturesHow To UseInstallationDocsLicense

Material grid preview RevoGrid material theme.

Key Features

  • High Performance: Handles millions of cells in the viewport with a powerful core built by default.

  • Keyboard Support:

    • Excel-like focus for efficient navigation and editing.
    • Seamless copy/paste from Excel, Google Sheets, or any other sheet format.
  • Lightweight: Minimal initial bundle size Min size. Can be imported with polyfills or as a module for modern browsers.

  • Intelligent Virtual DOM: Smart row recombination to minimize redraws.

  • Sorting: Multiple options, customizable per column, with advanced event handling.

  • Filtering:

    • Predefined system filters.
    • Preserve existing collections.
    • Custom filters to extend system filters with your own set.
  • Export: Export data to file.

  • Custom Sizes: Define custom sizes for columns and rows. Automatic sizing based on content.

  • Column Resizing: Adjust column widths.

  • Pinned/Sticky/Freezed Elements:

    • Columns (define left or right).
    • Rows (define top or bottom).
  • Grouping:

    • Column grouping (nested headers).
    • Row grouping (nested rows).
  • Cell Editing: In-place editing of cell data.

  • Customizations:

    • Column header templates.
    • Row header templates.
    • Cell template (create your own cell views).
    • Cell editor (use predefined or apply your own custom editors and cell types).
    • Cell properties (define custom properties for rendered cells).
  • Column Types: More details

    • Text/String (default).
    • Number.
    • Select.
    • Date.
    • Custom (create extended styles using any template).
  • Drag and Drop: Easily reorder rows.

  • Range Operations:

    • Selection.
    • Editing.
  • Theme Packages:

    • Excel-like (default).
    • Material (compact, dark, or light).
  • Extensibility: Modern VNode features and tsx support for easy extension.

  • Trimmed Rows: Hide rows on demand.

  • Plugin System: Create custom plugins or extend existing ones easily.

  • Additional Customizations and Improvements: Explore hundreds of other small customizations and improvements in RevoGrid.


Framework Friendly

Framework friendly

I am RevoGrid, your solution for efficiently representing large datasets
in an "Excel-like" data table or as a list. Render native components inside each cell!




Installation

The library published as a scoped NPM package in the NPMJS Revolist account. Check for more info on our demo side.

With NPM:

npm i @revolist/revogrid --save;

With Yarn:

yarn add @revolist/revogrid;

Browser Support

Chrome Firefox Safari Opera Edge
Latest ✔ Latest ✔ Latest ✔ Latest ✔ Latest ✔

Framework

Basic Usage

RevoGrid functions as a web component. Simply place the component on your page and access its properties as you would with any other HTML element. It also offers multiple ways to integrate our grid into your project:

Vanilla JS Grid Usage

// Select the RevoGrid element from the DOM
const grid = document.querySelector('revo-grid');

// Define the columns for the grid
const columns = [
  { prop: 'name', name: 'First Column' }, // Simple column definition
  {
    prop: 'details',
    name: 'Second Column',
    // Custom cell template for the 'details' column
    cellTemplate: (createElement, props) => {
      return createElement(
        'div',
        {
          style: { backgroundColor: 'red' }, // Styling the cell background
          class: { 'inner-cell': true }, // Adding a CSS class
        },
        props.model[props.prop] || '' // Display the cell content or an empty string if undefined
      );
    },
  },
];

// Define the data source for the grid
const items = [{ name: 'New Item', details: 'Item Description' }];

// Assign the columns and data source to the grid
grid.columns = columns;
grid.source = items;

Versions

  • 2.0+: Introduced the plugin system, grouping, sorting, and filtering.
  • 3.0+: Breaking changes introduced. See the migration guide. This version features new component loading, ESM modules, Bootstrap support, and much more.
  • 4.0+: Breaking changes introduced. See the migration guide. In this version, we rethought our framework approach, updated typings, fixed major issues, updated core and significantly improved overall performance. The grid is now much faster, with better plugin support and full framework support for Angular, React, and Vue, along with partial support for Ember and Svelte. Redesigned the documentation, and added more examples.

Contributing

We invite you to join our community and contribute to the growth and success of open-source projects. By getting involved, you'll have the opportunity to enhance your skills, gain valuable experience, and make a significant impact for the open-source community.

Why Contribute?

  • Expand Your Knowledge: Working on RevoGrid allows you to dive deep into modern web technologies (like webcomponents), improve your coding skills, and learn best practices in performance optimization, data handling, and component-based architecture.
  • Valuable Experience: Contributing to an open-source project like RevoGrid provides you with practical experience that can be a great addition to your portfolio. It demonstrates your ability to work collaboratively, solve complex problems.
  • Professional Growth: Contributing leads to mentorship opportunities, collaborations, and professional connections that can benefit your career.
  • Make a Difference: Your contributions can help improve RevoGrid, making it more user-friendly for developers around the world. Your input can shape the the project and drive innovation.

Join Us

Your contribution, no matter how big or small, is valuable. By working on RevoGrid, you'll be part of an exciting project that's making a difference in the world of data grids.

License

MIT