Skip to content

[Doc] Improve ra-realtime doc to unlock record #10648

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

Merged
merged 2 commits into from
Apr 8, 2025
Merged

[Doc] Improve ra-realtime doc to unlock record #10648

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6eea0bc
[Doc] Improve `ra-realtime` doc to unlock record
erwanMarmelab Apr 8, 2025
3137aed
Update documentation [no ci]
djhi Apr 8, 2025
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
2 changes: 2 additions & 0 deletions docs/useLockOnMount.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,8 @@ const PostEdit = () => (
```
{% endraw %}

**Note**: If users close their tab/browser when on a page with a locked record, `useLockOnMount` will call your `dataProvider.unlock` method. However, as browsers don't wait for asynchronous calls to finish, make sure your dataProvider executes as fast as possible.

## Parameters

`useLockOnMount` accepts a single options parameter, with the following properties (all optional):
Expand Down
Loading