[Doc] Add documentation for <LockOnMount> and <WithLocks> headless components

Author: jonathanarnault

docs_headless/astro.config.mjs

@@ -233,7 +233,9 @@ export default defineConfig({
                     label: 'Realtime',
                     items: [
                         enterpriseEntry('<ListLiveUpdate>'),
+                        enterpriseEntry('<LockOnMount>'),
                         enterpriseEntry('<LockStatusBase>'),
+                        enterpriseEntry('<WithLocks>'),
                         enterpriseEntry('usePublish'),
                         enterpriseEntry('useSubscribe'),
                         enterpriseEntry('useSubscribeCallback'),

docs_headless/src/content/docs/LockOnMount.md

@@ -0,0 +1,39 @@
+---
+title: '<LockOnMount>'
+---
+
+`<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.
+
+This feature requires a valid [Enterprise Edition](https://marmelab.com/ra-enterprise/) subscription.
+
+## Installation
+
+```bash
+npm install --save @react-admin/ra-core-ee
+# or
+yarn add @react-admin/ra-core-ee
+```
+
+## Usage
+
+```tsx
+import { EditBase, Form } from 'ra-core';
+import { LockOnMount, useLockCallbacks } from '@react-admin/ra-core-ee';
+
+const PostEdit = () => (
+    <EditBase>
+        <PostEditForm />
+        <LockOnMount />
+    </EditBase>
+);
+
+const PostEditForm = () => {
+    const { isPending, isLocked } = useLockCallbacks();
+
+    if (isPending) {
+        return <p>Loading...</p>;
+    }
+
+    return <Form disabled={isLocked}>{/* ... */}</Form>;
+};
+```

docs_headless/src/content/docs/WithLocks.md

@@ -0,0 +1,54 @@
+---
+title: '<WithLocks>'
+---
+
+`<WithLocks>` fetches the locks for a resource on mount, and puts them in a LocksContext. The locks are updated in real time.
+
+This component calls `dataProvider.getLocks()`, then subscribes to the locks topic for the current resource, and refetches the locks when a new event is received.
+
+This feature requires a valid [Enterprise Edition](https://marmelab.com/ra-enterprise/) subscription.
+
+## Installation
+
+```bash
+npm install --save @react-admin/ra-core-ee
+# or
+yarn add @react-admin/ra-core-ee
+```
+
+## Usage
+
+```tsx
+import { ListBase, useRecordContext } from 'ra-core';
+import { WithLocks, useLocksContext } from '@react-admin/ra-core-ee';
+import { DataTable } from 'your-ra-ui-library';
+
+const LockField = () => {
+    const locks = useLocksContext();
+    const record = useRecordContext();
+
+    if (!record) return null;
+
+    const lock = locks.find(lock => lock.recordId === record?.id);
+    if (!lock) return null;
+
+    return <span>Locked by {lock.identity}</span>;
+};
+
+const PostList = () => (
+    <WithLocks>
+        <ListBase>
+            <DataTable>
+                {/* ... */}
+                <DataTable.Col source="lockStatus" field={LockField} />
+            </DataTable>
+        </ListBase>
+    </WithLocks>
+);
+```
+
+## Props
+
+| Prop       | Required | Type        | Default | Description                                       |
+| ---------- | -------- | ----------- | ------- | ------------------------------------------------- |
+| `children` | Required | `ReactNode` |         | The component to render inside the `LocksContext` |