-
-
Notifications
You must be signed in to change notification settings - Fork 734
Add support for disabling local storage usage #2872
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
Gerrit0
merged 7 commits into
TypeStrong:beta
from
jsmith2-coveo:optionally-disable-local-storage
Mar 1, 2025
Merged
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
cacec58
Add support for TypeScript 5.8
Gerrit0 986f645
Bump version to 0.27.9
Gerrit0 2953b01
Update changelog for release
typedoc-bot 3663e41
Add support for disabling local storage usage
jsmith2-coveo ccfa99d
Add documentation for disabling local storage functionality
jsmith2-coveo 12b87c0
Refactoring approach to disabling local storage
jsmith2-coveo 6f4094d
Remove console logs, unused methods and re-implement try/catch
jsmith2-coveo 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
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
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,27 @@ | ||
--- | ||
title: Disabling Local Storage | ||
--- | ||
|
||
# Disabling Local Storage | ||
|
||
TypeDoc uses local storage by default to retain operational state information across page loads for components | ||
such as side menus, site menus and generated pages. To comply with certain functional cookie requirements, local | ||
storage usage can be disabled either programmatically by modifying a data attribute on the `document`, or through | ||
a checkbox in the settings menu. | ||
|
||
**Note:** Enabling this feature will clear the local storage of the contents. | ||
|
||
## Programmatically | ||
|
||
Local storage can be disabled by setting the `disableLocalStorage` attribute in the `dataset` property | ||
of the `document.documentElement`. | ||
|
||
Specifically, use: `document.documentElement.dataset.disableLocalStorage`. | ||
|
||
**Note:** This attribute expects a boolean value, defaulting to `false`. | ||
|
||
## Checkbox | ||
|
||
A checkbox exists under the settings menu to allow for toggling of this functionality without directly modifying | ||
the data attribute. By default, this checkbox is hidden. To reveal it, change the display value of the CSS class | ||
on the wrapper `div`: `td-disable-local-storage-toggle`. |
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.