Skip to content

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
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions site/development/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ children:
- themes.md
- internationalization.md
- third-party-symbols.md
- local-storage.md
---

# Development
Expand Down
27 changes: 27 additions & 0 deletions site/development/local-storage.md
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`.