Skip to content

Commit

Permalink
Add note to storage manager and edit ONLY to only
Browse files Browse the repository at this point in the history
  • Loading branch information
ndricimrr committed Sep 24, 2024
1 parent 239b172 commit c49686b
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 1 deletion.
1 change: 1 addition & 0 deletions client/src/storageManager.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import { helpers } from './helpers';
const pendingOperation = new Map();

/**
* <!-- label-success: Web App API only -->
* StorageManager allows you to use browser local storage of key/values. Every storage operation is sent to be managed by Luigi Core.
* The idea is that different micro frontends can share or persist items using local storage, as long as they come from the same domain and follow the [same-origin policy](https://developer.mozilla.org/en-US/docs/Web/Security/Same-origin_policy).
* Since all storage operations are asynchronous (sending an event to Luigi Core that will reply once operation is finished), all the methods return Promises.
Expand Down
2 changes: 2 additions & 0 deletions docs/luigi-client-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -1274,6 +1274,8 @@ LuigiClient.uxManager().applyCSS();

### storageManager

<!-- label-success: Web App API only -->

StorageManager allows you to use browser local storage of key/values. Every storage operation is sent to be managed by Luigi Core.
The idea is that different micro frontends can share or persist items using local storage, as long as they come from the same domain and follow the [same-origin policy](https://developer.mozilla.org/en-US/docs/Web/Security/Same-origin_policy).
Since all storage operations are asynchronous (sending an event to Luigi Core that will reply once operation is finished), all the methods return Promises.
Expand Down
2 changes: 1 addition & 1 deletion website/docs/src/app.html
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
'title',
'This API function is not available on Luigi Container and WC based microfrontends'
);
} else if (label.innerHTML === 'Web Component API ONLY') {
} else if (label.innerHTML === 'Web Component API only') {
label.setAttribute(
'title',
'This API function is ONLY available for Web Component based Microfrontend.'
Expand Down

0 comments on commit c49686b

Please sign in to comment.