Skip to content

Commit

Permalink
docs: add GitBook documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
ghiscoding committed Dec 14, 2023
1 parent d5de49e commit 85d4509
Show file tree
Hide file tree
Showing 65 changed files with 11,642 additions and 6 deletions.
5 changes: 5 additions & 0 deletions .gitbook.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
root: ./docs/

structure:
readme: README.md
summary: TOC.md
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
[![codecov](https://codecov.io/gh/ghiscoding/aurelia-slickgrid/branch/master/graph/badge.svg)](https://codecov.io/gh/ghiscoding/aurelia-slickgrid)

### Description
One of the best JavasSript datagrid [SlickGrid](https://github.com/mleibman/SlickGrid), which was originally developed by @mleibman, is now available to Aurelia. SlickGrid beats most other datagrids in terms of features, customizability and performance (it can easily deal with even a million row). Angular-Slickgrid is a wrapper on top of SlickGrid and we are using the [6pac/SlickGrid](https://github.com/6pac/SlickGrid/) fork which is the most active one since the original one was put on pause by its original author for personal reasons. Also worth to know, that I also contributed a lot to the 6pac/SlickGrid fork over the years for the benefit of all the SlickGrid libraries that I maintain including this one here... SlickGrid was recently refactored to be browser native, which means that jQuery is no longer required in Aurelia-Slickgrid [v6.0](https://github.com/ghiscoding/aurelia-slickgrid/releases/tag/v6.0.0) and higher.
One of the best JavasSript datagrid [SlickGrid](https://github.com/mleibman/SlickGrid), which was originally developed by @mleibman, is now available to Aurelia. SlickGrid beats most other datagrids in terms of features, customizability and performance (it can easily deal with even a million row). Aurelia-Slickgrid is a wrapper on top of SlickGrid and we are using the [6pac/SlickGrid](https://github.com/6pac/SlickGrid/) fork which is the most active one since the original one was put on pause by its original author for personal reasons. Also worth to know, that I also contributed a lot to the 6pac/SlickGrid fork over the years for the benefit of all the SlickGrid libraries that I maintain including this one here... SlickGrid was recently refactored to be browser native, which means that jQuery is no longer required in Aurelia-Slickgrid [v6.0](https://github.com/ghiscoding/aurelia-slickgrid/releases/tag/v6.0.0) and higher.

## Installation
Refer to the **[Wiki - HOWTO Step by Step](https://github.com/ghiscoding/aurelia-slickgrid/wiki/HOWTO--Step-by-Step)** and/or clone the [Aurelia-Slickgrid Demos](https://github.com/ghiscoding/aurelia-slickgrid-demos) repository. Please review all Wikis before opening any new issue, also consider asking installation and/or general questions on [Stack Overflow](https://stackoverflow.com/search?tab=newest&q=slickgrid) unless you think there's a bug with the library.
Expand All @@ -35,9 +35,8 @@ For a full compatibility table of Aurelia-Slickgrid with Slickgrid-Universal, yo
There are also 2 new Themes, Material & Salesforce that are available as well and if you wish to use SVG then take a look at the [Wiki - SVG Icons](https://github.com/ghiscoding/aurelia-slickgrid/wiki/SVG--Icons).

#### Working Demos
For a complete set of working demos (over 30 examples), we strongly suggest you to clone the [Aurelia-Slickgrid Demos](https://github.com/ghiscoding/aurelia-slickgrid-demos) repository (instructions are provided in the demo repo). The repo provides multiple demos and they are updated every time a new version is out, so it is updated frequently and is also used as the GitHub live demo page for both the [Bootstrap 5 demo](https://ghiscoding.github.io/Angular-Slickgrid) and [Bootstrap 4 demo](https://ghiscoding.github.io/angular-slickgrid-demos).
For a complete set of working demos (over 30 examples), we strongly suggest you to clone the [Aurelia-Slickgrid Demos](https://github.com/ghiscoding/aurelia-slickgrid-demos) repository (instructions are provided in the demo repo). The repo provides multiple demos and they are updated every time a new version is out, so it is updated frequently and is also used as the GitHub live demo page for both the [Bootstrap 5 demo](https://ghiscoding.github.io/aurelia-slickgrid) and [Bootstrap 4 demo](https://ghiscoding.github.io/aurelia-slickgrid-demos).


For a complete working set of demos, you can clone the [Aurelia-Slickgrid Demos](https://github.com/ghiscoding/aurelia-slickgrid-demos) repository (instructions are provided in the demo repo). This repo provides multiple samples (RequireJS, WebPack, CLI, ...) and it is also worth to know that the 2 WebPacks demos are updated frequently since they are the actual live GitHub [Bootstrap 4 demo](https://ghiscoding.github.io/aurelia-slickgrid-demos/#/slickgrid) / [Bootstrap 5 demo](https://ghiscoding.github.io/aurelia-slickgrid).

## License
Expand Down
5 changes: 5 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Documentation

The [`docs`](https://github.com/ghiscoding/aurelia-slickgrid/tree/master/docs) folder of Aurelia-Slickgrid is the one-stop-shop for all project related documentation.

Feel free to contribution documentation fixes by editing any of the markdown files in the [`docs`](https://github.com/ghiscoding/aurelia-slickgrid/tree/master/docs) folder.
88 changes: 88 additions & 0 deletions docs/TOC.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
# Table of contents

* [Introduction](README.md)

## Getting Started

* [Quick start](getting-started/quick-start.md)

## Styling

* [Styling CSS/SASS/Themes](styling/styling.md)
* [SVG Icons](styling/svg-icons.md)

## Column Functionalities

* [Cell Menu (Action Menu)](column-functionalities/cell-menu.md)
* [Editors](column-functionalities/editors.md)
* [new Autocomplete (Kraaden-lib)](column-functionalities/editors/autocomplete-editor-kraaden.md)
* [Date Picker (flatpickr)](column-functionalities/editors/date-editor-flatpickr.md)
* [LongText (textarea)](column-functionalities/editors/longtext-editor-textarea.md)
* [Select Dropdown Editor (single/multiple)](column-functionalities/editors/select-dropdown-editor.md)
### Filters
* [Input Filter (default)](column-functionalities/filters/input-filter.md)
* [Select Filter (dropdown)](column-functionalities/filters/select-filter.md)
* [Compound Filters](column-functionalities/filters/compound-filters.md)
* [Range Filters](column-functionalities/filters/range-filters.md)
* [Custom Filter](column-functionalities/filters/custom-filter.md)
* [Styling Filled Filters](column-functionalities/filters/styling-filled-filters.md)
* [Single Search Filter](column-functionalities/filters/single-search-filter.md)
* [Formatters](column-functionalities/formatters.md)
* [Sorting](column-functionalities/sorting.md)

## Events

* [Available events](events/available-events.md)
* [On Events](events/grid-dataview-events.md)

## Localization

* [with I18N](localization/localization.md)
* [with Custom Locales](localization/localization-with-custom-locales.md)

## Testing

* [Testing Patterns](testing/testing-patterns.md)

## Grid Functionalities

* [Auto-Resize / Resizer Service](grid-functionalities/grid-auto-resize.md)
* [Resize by Cell Content](grid-functionalities/resize-by-cell-content.md)
* [Column Picker](grid-functionalities/column-picker.md)
* [Composite Editor Modal](grid-functionalities/composite-editor-modal.md)
* [Custom Tooltip](grid-functionalities/custom-tooltip.md)
* [Add, Update or Highlight a Datagrid Item](grid-functionalities/add-update-highlight.md)
* [Dynamically Add CSS Classes to Item Rows](grid-functionalities/dynamic-item-metadata.md)
* [Context Menu](grid-functionalities/context-menu.md)
* [Custom Footer](grid-functionalities/custom-footer.md)
* [Excel Copy Buffer Plugin](grid-functionalities/excel-copy-buffer.md)
* [Export to Excel](grid-functionalities/export-to-excel.md)
* [Export to File (csv/txt)](grid-functionalities/export-to-text-file.md)
* [Grid Menu](grid-functionalities/grid-menu.md)
* [Grid State & Presets](grid-functionalities/grid-state-preset.md)
* [Grouping & Aggregators](grid-functionalities/grouping-aggregators.md)
* [Header Menu & Header Buttons](grid-functionalities/header-menu-header-buttons.md)
* [Pinning (frozen) of Columns/Rows](grid-functionalities/frozen-columns-rows.md)
* [Providing data to the grid](grid-functionalities/providing-grid-data.md)
* [Row Detail](grid-functionalities/row-detail.md)
* [Row Selection](grid-functionalities/row-selection.md)
* [Tree Data Grid](grid-functionalities/tree-data-grid.md)

## Backend Services

* [Custom Backend Service](backend-services/custom-backend-service.md)
* [OData](backend-services/OData.md)
* [GraphQL](backend-services/GraphQL.md)
* [JSON Result Structure](backend-services/graphql/GraphQL-JSON-Result.md)
* [Filtering Schema](backend-services/graphql/GraphQL-Filtering.md)
* [Pagination Schema](backend-services/graphql/GraphQL-Pagination.md)
* [Sorting Schema](backend-services/graphql/GraphQL-Sorting.md)

## Migrations

* [Migration Guide to 2.x](migrations/migration-to-2.x.md)
* [Migration Guide to 3.x](migrations/migration-to-3.x.md)
* [Migration Guide to 4.x](migrations/migration-to-4.x.md)
* [Migration Guide to 5.x](migrations/migration-to-5.x.md)
* [Migration Guide to 6.x](migrations/migration-to-6.x.md)
* [Migration Guide to 7.x](migrations/migration-to-7.x.md)
Loading

0 comments on commit 85d4509

Please sign in to comment.