From ff824acb97ce66f8dfddb99e42399b636a8b0e75 Mon Sep 17 00:00:00 2001 From: Oh My Felix Date: Sat, 4 Jul 2026 12:11:48 +0000 Subject: [PATCH 1/3] Docs: move documentation to README. Co-authored-by: Felix --- .docs/README.md | 34 ----------------------- README.md | 73 +++++++++++++++++++++++++++++++++++++------------ 2 files changed, 56 insertions(+), 51 deletions(-) delete mode 100644 .docs/README.md diff --git a/.docs/README.md b/.docs/README.md deleted file mode 100644 index 517a4c7e5..000000000 --- a/.docs/README.md +++ /dev/null @@ -1,34 +0,0 @@ -# Contributte Datagrid - -- [Introduction](introduction.md) - -**Data sources** -- [Data sources](data-source.md) - -**UI** -- [Columns](columns.md) -- [Filters](filters.md) -- [Localization](localization.md) -- [Pagination](pagination.md) -- [Assets](assets.md) - -**Actions** -- [Actions](actions.md) -- [Group action](group-action.md) - -**Templates** -- [Row](row.md) -- [Templates](template.md) - -**Export** -- [Exports](export.md) - -**State storage** -- [State storage](state-storage.md) - -**Inline** (advanced) -- [Inline edit](inline-edit.md) -- [Inline add](inline-add.md) - -**Tree view** (advanced) -- [Tree view](tree-view.md) diff --git a/README.md b/README.md index 9df3635ca..573df38e2 100755 --- a/README.md +++ b/README.md @@ -22,35 +22,74 @@ Website 🚀 contributte.org | Contact

-## About +First class datagrid for Nette Framework with filtering, sorting, pagination, tree view, table view, localization, exports and inline editing. -You are looking at first class datagrid for Nette Framework. Supported features: filtering, sorting, pagination, tree view, table view, translator and many others. -Give us a star, it makes us so happy. Thanks ⭐.️ +## Versions + +| State | Version | Branch | Nette | PHP | +|--------|-----------|----------|--------|---------| +| dev | `^7.2.x` | `master` | `3.2+` | `>=8.2` | +| stable | `^7.1.0` | `master` | `3.2+` | `>=8.2` | +| stable | `^7.0.0` | `master` | `3.2+` | `>=8.1` | +| stable | `^6.10.0` | `master` | `3.0+` | `>=7.2` | + +## Installation + +To install latest version of `ublaboo/datagrid` use [Composer](https://getcomposer.org). + +``` +composer require ublaboo/datagrid +``` + +## Resources | Resource | Link | |----------|------| -| **Documentation** | [documentation](.docs) | | **Skeleton Demo** | [https://examples.contributte.org/datagrid-skeleton/](https://examples.contributte.org/datagrid-skeleton/) | | **Skeleton Repository** | [github.com/contributte/datagrid-skeleton](https://github.com/contributte/datagrid-skeleton) | -## Usage +## Topics -To install latest version of `datagrid` use [Composer](https://getcomposer.org). +- [Introduction](.docs/introduction.md) -``` -composer require ublaboo/datagrid -``` +**Data sources** -For details on how to use this package, check out our [documentation](.docs). +- [Data sources](.docs/data-source.md) -## Versions +**UI** -| State | Version | Branch | Nette | PHP | -|--------|-----------|----------|--------|---------| -| dev | `^7.2.x` | `master` | `3.2+` | `>=8.2` | -| stable | `^7.1.0` | `master` | `3.2+` | `>=8.2` | -| stable | `^7.0.0` | `master` | `3.2+` | `>=8.1` | -| stable | `^6.10.0` | `master` | `3.0+` | `>=7.2` | +- [Columns](.docs/columns.md) +- [Filters](.docs/filters.md) +- [Localization](.docs/localization.md) +- [Pagination](.docs/pagination.md) +- [Assets](.docs/assets.md) + +**Actions** + +- [Actions](.docs/actions.md) +- [Group action](.docs/group-action.md) + +**Templates** + +- [Row](.docs/row.md) +- [Templates](.docs/template.md) + +**Export** + +- [Exports](.docs/export.md) + +**State storage** + +- [State storage](.docs/state-storage.md) + +**Inline** (advanced) + +- [Inline edit](.docs/inline-edit.md) +- [Inline add](.docs/inline-add.md) + +**Tree view** (advanced) + +- [Tree view](.docs/tree-view.md) ## Development From ee2dba293533b1340036edd1e288249ac3c01cf6 Mon Sep 17 00:00:00 2001 From: Oh My Felix Date: Sun, 16 Aug 2026 08:18:22 +0000 Subject: [PATCH 2/3] Docs: fix README rendering Co-authored-by: Milan Sulc --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 573df38e2..871b0aa0d 100755 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ Website 🚀 contributte.org | Contact

- +

First class datagrid for Nette Framework with filtering, sorting, pagination, tree view, table view, localization, exports and inline editing. From 9651903a8e1368d810a33e3abc42e3ad30a7b328 Mon Sep 17 00:00:00 2001 From: Oh My Felix Date: Sun, 16 Aug 2026 08:26:16 +0000 Subject: [PATCH 3/3] Docs: complete library quick start Co-authored-by: Milan Sulc --- .docs/README.md | 34 +++++++++++++++++++++++++++ README.md | 62 ++++++++++++++++--------------------------------- 2 files changed, 54 insertions(+), 42 deletions(-) create mode 100644 .docs/README.md diff --git a/.docs/README.md b/.docs/README.md new file mode 100644 index 000000000..517a4c7e5 --- /dev/null +++ b/.docs/README.md @@ -0,0 +1,34 @@ +# Contributte Datagrid + +- [Introduction](introduction.md) + +**Data sources** +- [Data sources](data-source.md) + +**UI** +- [Columns](columns.md) +- [Filters](filters.md) +- [Localization](localization.md) +- [Pagination](pagination.md) +- [Assets](assets.md) + +**Actions** +- [Actions](actions.md) +- [Group action](group-action.md) + +**Templates** +- [Row](row.md) +- [Templates](template.md) + +**Export** +- [Exports](export.md) + +**State storage** +- [State storage](state-storage.md) + +**Inline** (advanced) +- [Inline edit](inline-edit.md) +- [Inline add](inline-add.md) + +**Tree view** (advanced) +- [Tree view](tree-view.md) diff --git a/README.md b/README.md index 871b0aa0d..a8fd1ce3b 100755 --- a/README.md +++ b/README.md @@ -41,55 +41,33 @@ To install latest version of `ublaboo/datagrid` use [Composer](https://getcompos composer require ublaboo/datagrid ``` -## Resources - -| Resource | Link | -|----------|------| -| **Skeleton Demo** | [https://examples.contributte.org/datagrid-skeleton/](https://examples.contributte.org/datagrid-skeleton/) | -| **Skeleton Repository** | [github.com/contributte/datagrid-skeleton](https://github.com/contributte/datagrid-skeleton) | - -## Topics - -- [Introduction](.docs/introduction.md) - -**Data sources** - -- [Data sources](.docs/data-source.md) - -**UI** - -- [Columns](.docs/columns.md) -- [Filters](.docs/filters.md) -- [Localization](.docs/localization.md) -- [Pagination](.docs/pagination.md) -- [Assets](.docs/assets.md) +## Quick start -**Actions** +Create a component, give it an array data source, and add one column: -- [Actions](.docs/actions.md) -- [Group action](.docs/group-action.md) +```php +use Contributte\Datagrid\Datagrid; -**Templates** +protected function createComponentUsersGrid(): Datagrid +{ + $grid = new Datagrid($this, 'usersGrid'); + $grid->setDataSource([ + ['id' => 1, 'name' => 'John'], + ]); + $grid->addColumnText('name', 'Name'); -- [Row](.docs/row.md) -- [Templates](.docs/template.md) - -**Export** - -- [Exports](.docs/export.md) - -**State storage** - -- [State storage](.docs/state-storage.md) - -**Inline** (advanced) + return $grid; +} +``` -- [Inline edit](.docs/inline-edit.md) -- [Inline add](.docs/inline-add.md) +Render `{control usersGrid}` in the component template. It renders a grid with a **Name** column and the `John` row. See [the detailed documentation index](.docs/README.md) for data-source variants and all grid modes. -**Tree view** (advanced) +## Resources -- [Tree view](.docs/tree-view.md) +| Resource | Link | +|----------|------| +| **Skeleton Demo** | [https://examples.contributte.org/datagrid-skeleton/](https://examples.contributte.org/datagrid-skeleton/) | +| **Skeleton Repository** | [github.com/contributte/datagrid-skeleton](https://github.com/contributte/datagrid-skeleton) | ## Development