From b42c3a4c6450889a8a0cfecc47f8cdce01229d29 Mon Sep 17 00:00:00 2001 From: Damon Cook Date: Wed, 29 May 2024 10:37:25 -0400 Subject: [PATCH] Documentation: LocalAutosaveMonitor editor component (#61951) * Add LocalAutosaveMonitor component editor JSDocs * Auto-generate editor package docs to add LocalAutosaveMonitor * Improve JSDocs for LocalAutosaveMonitor editor component * Auto-generate editor docs for LocalAutosaveMonitor enhancements --- packages/editor/README.md | 9 ++++++++- .../src/components/local-autosave-monitor/index.js | 12 ++++++++++++ 2 files changed, 20 insertions(+), 1 deletion(-) diff --git a/packages/editor/README.md b/packages/editor/README.md index 3e9c92044de590..34528eac04bf23 100644 --- a/packages/editor/README.md +++ b/packages/editor/README.md @@ -426,7 +426,14 @@ _Returns_ ### LocalAutosaveMonitor -Undocumented declaration. +Monitors local autosaves of a post in the editor. It uses several hooks and functions to manage autosave behavior: + +- `useAutosaveNotice` hook: Manages the creation of a notice prompting the user to restore a local autosave, if one exists. +- `useAutosavePurge` hook: Ejects a local autosave after a successful save occurs. +- `hasSessionStorageSupport` function: Checks if the current environment supports browser sessionStorage. +- `LocalAutosaveMonitor` component: Uses the `AutosaveMonitor` component to perform autosaves at a specified interval. + +The module also checks for sessionStorage support and conditionally exports the `LocalAutosaveMonitor` component based on that. ### MediaPlaceholder diff --git a/packages/editor/src/components/local-autosave-monitor/index.js b/packages/editor/src/components/local-autosave-monitor/index.js index 185497710f35f9..f999cf9ef85340 100644 --- a/packages/editor/src/components/local-autosave-monitor/index.js +++ b/packages/editor/src/components/local-autosave-monitor/index.js @@ -192,4 +192,16 @@ function LocalAutosaveMonitor() { ); } +/** + * Monitors local autosaves of a post in the editor. + * It uses several hooks and functions to manage autosave behavior: + * - `useAutosaveNotice` hook: Manages the creation of a notice prompting the user to restore a local autosave, if one exists. + * - `useAutosavePurge` hook: Ejects a local autosave after a successful save occurs. + * - `hasSessionStorageSupport` function: Checks if the current environment supports browser sessionStorage. + * - `LocalAutosaveMonitor` component: Uses the `AutosaveMonitor` component to perform autosaves at a specified interval. + * + * The module also checks for sessionStorage support and conditionally exports the `LocalAutosaveMonitor` component based on that. + * + * @module LocalAutosaveMonitor + */ export default ifCondition( hasSessionStorageSupport )( LocalAutosaveMonitor );