diff --git a/client/luigi-client.d.ts b/client/luigi-client.d.ts index f22406ab65..01be9936fc 100644 --- a/client/luigi-client.d.ts +++ b/client/luigi-client.d.ts @@ -140,7 +140,7 @@ export declare interface UxManager { * @param {Object} settings.links provides links data * @param {Object} settings.links.LINK_KEY object containing the data for a particular link. To properly render the link in the alert message refer to the description of the **settings.text** parameter * @param {string} settings.links.LINK_KEY.text text which replaces the link identifier in the alert content - * @param {string} settings.links.LINK_KEY.url url to navigate when you click the link. Currently, only internal links are supported in the form of relative or absolute paths + * @param {string} settings.links.LINK_KEY.url URL to navigate when you click the link. Currently, only internal links are supported in the form of relative or absolute paths * @param {string} settings.links.LINK_KEY.dismissKey dismissKey which represents the key of the link. * @param {number} settings.closeAfter (optional) time in milliseconds that tells Luigi when to close the Alert automatically. If not provided, the Alert will stay on until closed manually. It has to be greater than `100` * @returns {promise} which is resolved when the alert is dismissed diff --git a/client/src/lifecycleManager.js b/client/src/lifecycleManager.js index 606f80ddf1..2b0afd48b6 100644 --- a/client/src/lifecycleManager.js +++ b/client/src/lifecycleManager.js @@ -50,7 +50,7 @@ class LifecycleManager extends LuigiClientBase { } /** - * Starts the handshake with Luigi Core and thereafter resulting in initialization of Luigi Client. It is always ran by default when importing luigi-client package in your micro frontend. Note that when using 'defer-luigi-init' to defer default initialization you will need to initialize the handshake using this function manually wherever needed. + * Starts the handshake with Luigi Core and thereafter results in initialization of Luigi Client. It is always ran by default when importing the Luigi Client package in your micro frontend. Note that when using `defer-luigi-init` to defer default initialization, you will need to initialize the handshake using this function manually wherever needed. * @since 1.12.0 * @memberof Lifecycle * @example diff --git a/client/src/storageManager.js b/client/src/storageManager.js index f8651e60d4..2a7a8a1385 100644 --- a/client/src/storageManager.js +++ b/client/src/storageManager.js @@ -5,7 +5,7 @@ const pendingOperation = new Map(); /** * 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. + * 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. * @name storageManager */ diff --git a/client/src/uxManager.js b/client/src/uxManager.js index 31481965bc..155c499ff3 100644 --- a/client/src/uxManager.js +++ b/client/src/uxManager.js @@ -134,7 +134,7 @@ class UxManager extends LuigiClientBase { * @param {Object} settings.links provides links data * @param {Object} settings.links.LINK_KEY object containing the data for a particular link. To properly render the link in the alert message refer to the description of the **settings.text** parameter * @param {string} settings.links.LINK_KEY.text text which replaces the link identifier in the alert content - * @param {string} settings.links.LINK_KEY.url url to navigate when you click the link. Currently, only internal links are supported in the form of relative or absolute paths + * @param {string} settings.links.LINK_KEY.url URL to navigate when you click the link. Currently, only internal links are supported in the form of relative or absolute paths * @param {string} settings.links.LINK_KEY.dismissKey dismissKey which represents the key of the link. * @param {number} settings.closeAfter (optional) time in milliseconds that tells Luigi when to close the Alert automatically. If not provided, the Alert will stay on until closed manually. It has to be greater than `100` * @returns {promise} which is resolved when the alert is dismissed diff --git a/core/README.md b/core/README.md index c9ef1f8757..af37b21b01 100644 --- a/core/README.md +++ b/core/README.md @@ -39,9 +39,9 @@ You can see the Luigi Core in action by running the [Angular example application ### Build and watch with a simple development environment -Use the following steps, if you want to have a simpler development environment with less output and not the full-blown e2e application. This becomes handy if you want to debug a certain scenario where you already have a luigi configuration snippet. +Use the following steps, if you want to have a simpler development environment with less output and not the full-blown e2e application. This becomes handy if you want to debug a certain scenario where you already have a Luigi configuration snippet. -1. Install dependencies. +1. Install dependencies. ```bash npm install ``` @@ -50,10 +50,10 @@ Use the following steps, if you want to have a simpler development environment w npm run simpledev ``` -This will create (or use, if already existing) a simple luigi app under /dev-tools/simple-app where you can make changes according to your needs. +This will create (or use, if already existing) a simple Luigi app under `/dev-tools/simple-app` where you can make changes according to your needs.