@luigi-project/client 2.3.1-dev.202308180826 → 2.3.1-dev.202308190026

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/luigi-element.d.ts +23 -0
  2. package/package.json +1 -1
@@ -420,4 +420,27 @@ export interface LuigiClient {
420
420
  linkManager: () => LinkManager;
421
421
  uxManager: () => UxManager;
422
422
  publishEvent: (event: Event) => void;
423
+ /**
424
+ * Sets node parameters in Luigi Core. The parameters will be added to the URL.
425
+ * @param {Object} params
426
+ * @param {boolean} keepBrowserHistory
427
+ * @memberof LuigiClient
428
+ */
429
+ addNodeParams: (params: Object, keepBrowserHistory: boolean) => void;
430
+ /**
431
+ * Returns the node parameters of the active URL.
432
+ * Node parameters are defined like URL query parameters but with a specific prefix allowing Luigi to pass them to the micro frontend view. The default prefix is **~** and you can use it in the following way: `https://my.luigi.app/home/products?~sort=asc&~page=3`.
433
+ * <!-- add-attribute:class:warning -->
434
+ * > **NOTE:** some special characters (`<`, `>`, `"`, `'`, `/`) in node parameters are HTML-encoded.
435
+ * @param {boolean} shouldDesanitise defines whether the specially encoded characters should be desanitised
436
+ * @returns {Object} node parameters, where the object property name is the node parameter name without the prefix, and its value is the value of the node parameter. For example `{sort: 'asc', page: 3}`
437
+ * @memberof LuigiClient
438
+ */
439
+ getNodeParams: (shouldDesanitise: boolean) => Object;
440
+ /**
441
+ * Sends anchor to Luigi Core. The anchor will be added to the URL.
442
+ * @param {string} anchor
443
+ * @memberof LuigiClient
444
+ */
445
+ setAnchor: (anchor: string) => void;
423
446
  }
package/package.json CHANGED
@@ -17,5 +17,5 @@
17
17
  "micro-frontends",
18
18
  "microfrontends"
19
19
  ],
20
- "version": "2.3.1-dev.202308180826"
20
+ "version": "2.3.1-dev.202308190026"
21
21
  }