{"id":16298987,"url":"https://github.com/ghiscoding/aurelia-slickgrid","last_synced_at":"2025-04-06T09:07:07.801Z","repository":{"id":39121269,"uuid":"78310416","full_name":"ghiscoding/aurelia-slickgrid","owner":"ghiscoding","description":"Aurelia-Slickgrid is a wrapper of the lightning fast \u0026 customizable SlickGrid datagrid, it also includes multiple Styling Themes","archived":false,"fork":false,"pushed_at":"2024-04-29T22:25:50.000Z","size":107419,"stargazers_count":127,"open_issues_count":1,"forks_count":17,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-05-01T12:19:21.057Z","etag":null,"topics":["aurelia","bootstrap","bootstrap4","bootstrap5","data","datagrid","datatable","graphql","grid","odata","slickgrid","treeview","typescript"],"latest_commit_sha":null,"homepage":"https://ghiscoding.github.io/aurelia-slickgrid","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ghiscoding.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":".github/CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"ghiscoding","patreon":null,"open_collective":null,"ko_fi":"ghiscoding","tidelift":null,"custom":null}},"created_at":"2017-01-07T23:41:42.000Z","updated_at":"2024-08-17T17:00:10.286Z","dependencies_parsed_at":"2024-05-03T02:48:19.491Z","dependency_job_id":"8e09cc1b-e56e-4164-8abf-4350252343e0","html_url":"https://github.com/ghiscoding/aurelia-slickgrid","commit_stats":{"total_commits":1836,"total_committers":10,"mean_commits":183.6,"dds":0.1797385620915033,"last_synced_commit":"2f7f0cefb1f5dea8b39108974eb833a17c89631a"},"previous_names":[],"tags_count":219,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ghiscoding%2Faurelia-slickgrid","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ghiscoding%2Faurelia-slickgrid/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ghiscoding%2Faurelia-slickgrid/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ghiscoding%2Faurelia-slickgrid/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ghiscoding","download_url":"https://codeload.github.com/ghiscoding/aurelia-slickgrid/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247457799,"owners_count":20941906,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["aurelia","bootstrap","bootstrap4","bootstrap5","data","datagrid","datatable","graphql","grid","odata","slickgrid","treeview","typescript"],"created_at":"2024-10-10T20:46:12.320Z","updated_at":"2025-04-06T09:07:07.785Z","avatar_url":"https://github.com/ghiscoding.png","language":"TypeScript","funding_links":["https://github.com/sponsors/ghiscoding","https://ko-fi.com/ghiscoding","https://ko-fi.com/ghiscoding'"],"categories":["Table of Contents"],"sub_categories":["Aurelia"],"readme":"# Aurelia-Slickgrid\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n[![TypeScript](https://img.shields.io/badge/%3C%2F%3E-TypeScript-%230074c1.svg)](http://www.typescriptlang.org/)\n[![NPM downloads](https://img.shields.io/npm/dy/aurelia-slickgrid)](https://npmjs.org/package/aurelia-slickgrid)\n[![npm version](https://img.shields.io/npm/v/aurelia-slickgrid.svg?logo=npm\u0026logoColor=fff\u0026label=npm)](https://www.npmjs.com/package/aurelia-slickgrid)\n[![npm bundle size](https://img.shields.io/bundlephobia/minzip/aurelia-slickgrid?color=success\u0026label=gzip)](https://bundlephobia.com/result?p=aurelia-slickgrid)\n\n[![Actions Status](https://github.com/ghiscoding/aurelia-slickgrid/workflows/CI%20Build/badge.svg)](https://github.com/ghiscoding/aurelia-slickgrid/actions)\n[![Cypress.io](https://img.shields.io/badge/tested%20with-Cypress-04C38E.svg?logo=cypress)](https://www.cypress.io/)\n[![jest](https://jestjs.io/img/jest-badge.svg)](https://github.com/facebook/jest)\n\u003c!-- [![codecov](https://codecov.io/gh/ghiscoding/aurelia-slickgrid/branch/master/graph/badge.svg)](https://codecov.io/gh/ghiscoding/aurelia-slickgrid) --\u003e\n\n### Brief introduction\nOne of the best JavasSript data grid [SlickGrid](https://github.com/mleibman/SlickGrid), which was originally developed by @mleibman, is now available to the Aurelia world. SlickGrid beats most other data grids in terms of features, customizability \u0026 performance (running smoothly with even a million rows). Aurelia-Slickgrid is a wrapper on top of [Slickgrid-Universal](https://github.com/ghiscoding/slickgrid-universal/) (which is a dependency), in the early beginning we used the `6pac/SlickGrid` fork but that was dropped in \u003e=[v7.0](https://github.com/ghiscoding/aurelia-slickgrid/releases/tag/v7.0.3) since Slickgrid-Universal is now a standalone project. SlickGrid was also recently rewritten with browser native code (no more ~jQuery~ 🎉).\n\n## Documentation\n📕 [Documentation](https://ghiscoding.gitbook.io/aurelia-slickgrid/getting-started/quick-start) website powered by GitBook for version 7+ (_or use the [Wikis](https://github.com/ghiscoding/aurelia-slickgrid/wiki) for older versions_).\n\n## Installation\nAvailable in Stackblitz (Codeflow) below, this can also be used to provide an issue repro.\n\n[![Open in Codeflow](https://developer.stackblitz.com/img/open_in_codeflow.svg)](https:///pr.new/ghiscoding/aurelia-slickgrid)\n\nRefer to the **[Docs - Quick Start](https://ghiscoding.gitbook.io/aurelia-slickgrid/getting-started/quick-start)** and/or clone the [Aurelia-Slickgrid Demos](https://github.com/ghiscoding/aurelia-slickgrid-demos) repository. Please review the [Documentation](https://ghiscoding.gitbook.io/aurelia-slickgrid/) website before opening any new issue, also consider asking installation and/or general questions on [Stack Overflow](https://stackoverflow.com/search?tab=newest\u0026q=slickgrid) unless you think there's a bug with the library.\n\n```sh\nnpm install aurelia-slickgrid\n```\nInstall any optional Slickgrid-Universal dependencies, for example Excel Export\n```sh\nnpm install @slickgrid-universal/excel-export\n```\n\n### Versions Compatibility\n\n\u003e **Note** please be aware that only the latest major version of Aurelia-Slickgrid will be supported and receive bug fixes (it's already a lot of work to maintain for a single developer like me).\n\n| Aurelia-Slickgrid | Aurelia version | Migration Guide | Notes |\n|-------------------|-----------------|-----------------|------|\n| 8.x               | Aurelia 2       | [Migration 8.x](https://ghiscoding.gitbook.io/aurelia-slickgrid/migrations/migration-to-8.x)     | modern UI / Dark Mode, requires Slickgrid-Universal [5.x](https://github.com/ghiscoding/slickgrid-universal/releases/tag/v5.0.0) |\n| 7.x               | Aurelia 2       | [Migration 7.x](https://ghiscoding.gitbook.io/aurelia-slickgrid/migrations/migration-to-7.x)     | merge SlickGrid into Slickgrid-Universal, requires Slickgrid-Universal [4.x](https://github.com/ghiscoding/slickgrid-universal/releases/tag/v4.0.2) |\n| 6.x               | 1.x             | [Migration 6.x](https://github.com/ghiscoding/aurelia-slickgrid/wiki/Migration-to-6.x)     | removal of jQuery (now uses browser native code), requires Slickgrid-Universal [3.x](https://github.com/ghiscoding/slickgrid-universal/releases/tag/v3.0.0) |\n| 5.x               | 1.x             | [Migration 5.x](https://github.com/ghiscoding/aurelia-slickgrid/wiki/Migration-to-5.x)     | removal of jQueryUI, requires Slickgrid-Universal [2.x](https://github.com/ghiscoding/slickgrid-universal/releases/tag/v2.0.0) version |\n\nFor a full compatibility table of all Aurelia-Slickgrid versions with Slickgrid-Universal, please refer to the [Versions Compatibility Table - Wiki](https://github.com/ghiscoding/aurelia-slickgrid/wiki/Versions-Compatibility-Table)\n\n### Styling Themes\n\nMultiple styling themes are available\n- Default (UI agnostic)\n- Bootstrap (see all Aurelia-Slickgrid [live demos](https://ghiscoding.github.io/aurelia-slickgrid/))\n- Material (see [Slickgrid-Universal](https://ghiscoding.github.io/slickgrid-universal/#/example07))\n- Salesforce (see [Slickgrid-Universal](https://ghiscoding.github.io/slickgrid-universal/#/example16))\n\nAlso note that all of these themes also have a **Dark Theme** equivalent and even though Bootstrap is often used for live demos, it does work as well with any other UI framework like Bulma, Material, ...\n\n### Demo page\n\n`Aurelia-Slickgrid` works with all `Bootstrap` versions, you can see a demo of each one below. It also works well with any other frameworks like Material or Bulma and there are also couple of extra styling themes based on Material \u0026 Salesforce which are also available. You can also use different SVG icons, you may want to look at the [Docs - SVG Icons](https://ghiscoding.gitbook.io/aurelia-slickgrid/styling/svg-icons)\n- [Bootstrap 5 demo](https://ghiscoding.github.io/aurelia-slickgrid) / [examples repo](https://github.com/ghiscoding/aurelia-slickgrid-demos/tree/master/webpack-bs5-demo)\n- [Bootstrap 5 demo with Single Locale](https://ghiscoding.github.io/aurelia-slickgrid-demos) / [examples repo](https://github.com/ghiscoding/aurelia-slickgrid-demos/tree/master/webpack-bs5-demo-with-locales)\n\nThere are also 2 new Themes, Material \u0026 Salesforce that are available as well and if you wish to use SVG then take a look at the [Docs - SVG Icons](https://ghiscoding.gitbook.io/aurelia-slickgrid/styling/svg-icons).\n\n#### Working Demos\nFor a complete set of working demos (40+ examples), we strongly suggest you to clone the [Aurelia-Slickgrid Demos](https://github.com/ghiscoding/aurelia-slickgrid-demos) repository (instructions are provided inside it). The repo provides multiple examples which are updated for every new release, so it is updated frequently and is also the GitHub live demo page for both the [Bootstrap 5 demo](https://ghiscoding.github.io/aurelia-slickgrid) and [Bootstrap 5 demo (single Locale)](https://ghiscoding.github.io/aurelia-slickgrid-demos).\n\n## License\n[MIT License](LICENSE)\n\n### Like it? ⭐ it\nYou like and use **Aurelia-Slickgrid**? Be sure to upvote ⭐ and feel free to contribute.\n\n#### Like my work?\nYou could ⭐ the lib and maybe support me with caffeine [☕](https://ko-fi.com/ghiscoding) or GitHub sponsoring. Thanks.\n\n\u003ca href='https://ko-fi.com/ghiscoding' target='_blank'\u003e\u003cimg height='36' style='border:0px;height:36px;' src='https://storage.ko-fi.com/cdn/kofi3.png?v=6' border='0' alt='Buy Me a Coffee at ko-fi.com' /\u003e\u003c/a\u003e\n\n### Latest News \u0026 Releases\nCheck out the [Releases](https://github.com/ghiscoding/aurelia-slickgrid/releases) section for all latest News \u0026 Releases.\n\n### Tested with [Jest](https://jestjs.io/) (Unit Tests) - [Cypress](https://www.cypress.io/) (E2E Tests)\nSlickgrid-Universal has **100%** Unit Test Coverage and all Aurelia-Slickgrid Examples are tested with [Cypress](https://www.cypress.io/) as E2E tests.\n\n\n#### Basic Grid\n\n```ts\nimport { type Column, type GridOption } from 'aurelia-slickgrid';\n\nexport class Example {\n  columnDefinitions: Column[] = [];\n  gridOptions: GridOption;\n  dataset: any[] = [];\n\n  constructor() {\n    this.columnDefinitions = [\n      { id: 'firstName', name: 'First Name', field: 'firstName', sortable: true },\n      { id: 'lastName', name: 'Last Name', field: 'lastName', sortable: true },\n      { id: 'age', name: 'Age', field: 'age', type: 'number', sortable: true }\n    ];\n  }\n\n  attached() {\n    this.dataset = [\n      { id: 1, firstName: 'John', lastName: 'Doe', age: 20 },\n      { id: 2, firstName: 'Jane', lastName: 'Smith', age: 21 }\n    ];\n    this.gridOptions = { /*...*/ }; // optional grid options\n  }\n}\n```\n\n```html\n\u003caurelia-slickgrid\n  grid-id=\"grid2\"\n  column-definitions.bind=\"columnDefinitions\"\n  grid-options.bind=\"gridOptions\"\n  dataset.bind=\"dataset\"\u003e\n\u003c/aurelia-slickgrid\u003e\n```\n\n## Sponsors\n\nThanks to all my sponsors! \n\n\u003cdiv\u003e\n  \u003cspan\u003e\n    \u003ca href=\"https://github.com/wundergraph\" class=\"Link\" title=\"Wundergraph\" target=\"_blank\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/64281914\" width=\"50\" height=\"50\" valign=\"middle\" /\u003e\u003c/a\u003e\n  \u003c/span\u003e\n  \u0026nbsp;\n  \u003cspan\u003e\n    \u003ca href=\"https://github.com/johnsoncodehk\" class=\"Link\" title=\"johnsoncodehk (Volar)\" target=\"_blank\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/16279759\" width=\"50\" height=\"50\" valign=\"middle\" /\u003e\u003c/a\u003e\n  \u003c/span\u003e\n   \u0026nbsp;\n  \u003cspan\u003e\n    \u003ca href=\"https://github.com/kevinburkett\" class=\"Link\" title=\"kevinburkett\" target=\"_blank\"\u003e\u003cimg class=\"circle avatar-user\" src=\"https://avatars.githubusercontent.com/u/48218815?s=52\u0026amp;v=4\" width=\"45\" height=\"45\" valign=\"middle\" /\u003e\u003c/a\u003e\n  \u003c/span\u003e\n  \u0026nbsp;\n  \u003cspan\u003e\n    \u003ca href=\"https://github.com/anton-gustafsson\" class=\"Link\" title=\"anton-gustafsson\" target=\"_blank\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/22906905?s=52\u0026v=4\" width=\"50\" height=\"50\" valign=\"middle\" /\u003e\u003c/a\u003e\n  \u003c/span\u003e\n  \u0026nbsp;\n  \u003cspan\u003e\n    \u003ca href=\"https://github.com/gibson552\" class=\"Link\" title=\"gibson552\" target=\"_blank\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/84058359?s=52\u0026v=4\" width=\"50\" height=\"50\" valign=\"middle\" /\u003e\u003c/a\u003e\n  \u003c/span\u003e\n\u003c/div\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fghiscoding%2Faurelia-slickgrid","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fghiscoding%2Faurelia-slickgrid","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fghiscoding%2Faurelia-slickgrid/lists"}