-
Notifications
You must be signed in to change notification settings - Fork 73
DOC Unsaved changes indcator #848
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.
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
GuySartorelli
merged 1 commit into
silverstripe:6
from
creative-commoners:pulls/6/unsaved-indicator
Nov 25, 2025
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
44 changes: 44 additions & 0 deletions
44
...loper_Guides/15_Customising_the_Admin_Interface/08_Unsaved_Changes_Indicator.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| --- | ||
| title: Unsaved changes indicator | ||
| summary: Configure and customise the CMS unsaved changes indicator shown on edit forms | ||
| icon: icon-clock | ||
| --- | ||
|
|
||
| # Unsaved changes indicator | ||
|
|
||
| The CMS shows a small inline indicator on edit forms after a user has started editing the form (contains unsaved changes) after a configurable period of time. The indicator starts as a subtle "notice" and escalates to a more prominent "warning" after a second period. This helps editors remember to save their work and reduces accidental data loss. | ||
|
|
||
|  | ||
|
|
||
| The indicator activates only when the form has started editing the form. When the form then changes to a state where there are no unsaved changes, either by saving or reverting the unsaved changes, then its timer resets. By default, a notice appears after 5 minutes, escalating to a warning after 10 minutes. Notice and warning are independent levels; you can disable either or both through configuration. | ||
|
|
||
| ## Configuration | ||
|
|
||
| You can configure the indicator using YAML. The configuration controls the intervals in minutes for the two levels. | ||
| Set either level to `0` to disable that level. Set both to `0` to disable the indicator entirely. | ||
|
|
||
| Example: change the notice to 10 minutes and the warning to 20 minutes | ||
|
|
||
| ```yml | ||
| SilverStripe\Admin\Forms\UnsavedChangesIndicator: | ||
| minutes: | ||
| notice: 10 | ||
| warning: 20 | ||
| ``` | ||
|
|
||
| To disable the warning level only: | ||
|
|
||
| ```yml | ||
| SilverStripe\Admin\Forms\UnsavedChangesIndicator: | ||
| minutes: | ||
| warning: 0 | ||
| ``` | ||
|
|
||
| To disable the indicator entirely: | ||
|
|
||
| ```yml | ||
| SilverStripe\Admin\Forms\UnsavedChangesIndicator: | ||
| minutes: | ||
| notice: 0 | ||
| warning: 0 | ||
| ``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.