Skip to content

Docs: move documentation to README #1292

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ohmyfelix wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Docs: move documentation to README #1292

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ff824ac
Docs: move documentation to README.
ohmyfelix Jul 4, 2026
ee2dba2
Docs: fix README rendering
ohmyfelix Aug 16, 2026
9651903
Docs: complete library quick start
ohmyfelix Aug 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 36 additions & 19 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,38 +19,55 @@ Website 🚀 <a href="https://contributte.org">contributte.org</a> | Contact
</p>

<p align=center>
<img src="https://github.com/contributte/datagrid/blob/master/.docs/assets/datagrid.gif">
<img src=".docs/assets/datagrid.gif">
</p>

## 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

| 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) |
| 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` |

## Usage
## Installation

To install latest version of `datagrid` use [Composer](https://getcomposer.org).
To install latest version of `ublaboo/datagrid` use [Composer](https://getcomposer.org).

```
composer require ublaboo/datagrid
```

For details on how to use this package, check out our [documentation](.docs).
## Quick start

## Versions
Create a component, give it an array data source, and add one column:

| 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` |
```php
use Contributte\Datagrid\Datagrid;

protected function createComponentUsersGrid(): Datagrid
{
$grid = new Datagrid($this, 'usersGrid');
$grid->setDataSource([
['id' => 1, 'name' => 'John'],
]);
$grid->addColumnText('name', 'Name');

return $grid;
}
```

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.

## 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) |

## Development

Expand Down
Loading