Skip to content
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

[Doc] add a section demonstrating the <Datagrid> headers pinning feature #9564

Merged
merged 3 commits into from
Jan 10, 2024
Merged

[Doc] add a section demonstrating the <Datagrid> headers pinning feature #9564

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6a5fdeb
doc: added a screencast and a section to demonstrate headers pinning …
adguernier Jan 5, 2024
ca6eb70
Apply suggestions from code review
adguernier Jan 8, 2024
565bb6c
add a line break
adguernier Jan 10, 2024
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
11 changes: 11 additions & 0 deletions docs/Datagrid.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -832,6 +832,17 @@ const PostList = () => (

**Tip**: The `Datagrid` component `classes` can also be customized for all instances of the component with its global css name `"RaDatagrid"` as [describe here](https://marmelab.com/blog/2019/12/18/react-admin-3-1.html#theme-overrides)

## Header Pinning

`<Datagrid>` has sticky headers, which means that the header row will remain visible even when scrolling down the page.

<video controls autoplay playsinline muted loop>
<source src="./img/datagrid-headers-pinning.mp4" type="video/mp4"/>
Your browser does not support the video tag.
</video>

You don't need to do anything for this to work, as it's enabled by default.

## Configurable

You can let end users customize the fields displayed in the `<Datagrid>` by using the `<DatagridConfigurable>` component instead.
Expand Down
Binary file added docs/img/datagrid-headers-pinning.mp4
View file
Open in desktop
Binary file not shown.