Skip to content

Commit ea7ecfa

Browse files
Add setting up page for ra realtime in ra-core docs
1 parent 878c89d commit ea7ecfa

File tree

4 files changed

+647
-2
lines changed

4 files changed

+647
-2
lines changed

docs_headless/astro.config.mjs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -232,6 +232,7 @@ export default defineConfig({
232232
{
233233
label: 'Realtime',
234234
items: [
235+
enterpriseEntry('RealtimeFeatures', 'Setting Up'),
235236
enterpriseEntry('<ListLiveUpdate>'),
236237
enterpriseEntry('<LockOnMount>'),
237238
enterpriseEntry('<LockStatusBase>'),

docs_headless/src/content/docs/LockOnMount.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: '<LockOnMount>'
33
---
44

5-
`<LockOnMount />` calls `dataProvider.lock()` on mount and `dataProvider.unlock()` on unmount to lock and unlock the record. It relies on `authProvider.getIdentity()` to get the identity of the current user. It guesses the current `resource` and `recordId` from the context (or the route) if not provided.
5+
`<LockOnMount />` calls [`dataProvider.lock()`](./RealtimeFeatures.md#data-provider-requirements) on mount and [`dataProvider.unlock()`](./RealtimeFeatures.md#data-provider-requirements) on unmount to lock and unlock the record. It relies on [`authProvider.getIdentity()`](./AuthProviderWriting.md#getidentity) to get the identity of the current user. It guesses the current `resource` and `recordId` from the context (or the route) if not provided.
66

77
This feature requires a valid [Enterprise Edition](https://marmelab.com/ra-enterprise/) subscription.
88

0 commit comments

Comments
 (0)