docu for modal microfrontends #454

JohannesDoberer · 2019-04-02T06:58:57Z

No description provided.

bszwarc

I added a couple of comments.

bszwarc · 2019-04-02T09:51:53Z

docs/luigi-client-api.md

@@ -88,13 +88,17 @@ Navigates to the given path in the application hosted by Luigi. It contains eith
 -   `path` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** path to be navigated to
 -   `sessionId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** current Luigi **sessionId**
 -   `preserveView` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Preserve a view by setting it to `true`. It keeps the current view opened in the background and opens the new route in a new frame. Use the [goBack()](#goBack) function to navigate back. You can use this feature across different levels. Preserved views are discarded as soon as the standard [navigate()](#navigate) function is used instead of [goBack()](#goBack).
+-   `modalSettings` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Opens a view in a modal. Settings to configure the title and size.


Suggested change

- `modalSettings` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Opens a view in a modal. Settings to configure the title and size.

- `modalSettings` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Opens a view in a modal. Use these settings to configure the modal's title and size.

bszwarc · 2019-04-02T09:54:32Z

docs/luigi-client-api.md

@@ -88,13 +88,17 @@ Navigates to the given path in the application hosted by Luigi. It contains eith
 -   `path` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** path to be navigated to
 -   `sessionId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** current Luigi **sessionId**
 -   `preserveView` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Preserve a view by setting it to `true`. It keeps the current view opened in the background and opens the new route in a new frame. Use the [goBack()](#goBack) function to navigate back. You can use this feature across different levels. Preserved views are discarded as soon as the standard [navigate()](#navigate) function is used instead of [goBack()](#goBack).
+-   `modalSettings` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Opens a view in a modal. Settings to configure the title and size.
+-   `modalSettings.title` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** modal title (default is node label or empty if no label is defined)


Suggested change

- `modalSettings.title` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** modal title (default is node label or empty if no label is defined)

- `modalSettings.title` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** modal title. By default, it is the node label. If there is no label, it is left empty.

bszwarc · 2019-04-02T11:24:57Z

docs/luigi-client-api.md

@@ -187,6 +191,25 @@ LuigiClient.linkManager().goBack({ foo: 'bar' });
 LuigiClient.linkManager().goBack(true);
 ```

+### openAsModal
+
+Opens a view in a modal. It is possible to specify a title and size. If nothing is specified, the title will be the node label or empty if no node label is set. Default size of the modal is set to large (l), which means 80%. It is also possible to specify m (60%) and s (40%) as modal size. Use it optionally in combination with any of the navigation functions.


Suggested change

Opens a view in a modal. It is possible to specify a title and size. If nothing is specified, the title will be the node label or empty if no node label is set. Default size of the modal is set to large (l), which means 80%. It is also possible to specify m (60%) and s (40%) as modal size. Use it optionally in combination with any of the navigation functions.

Opens a view in a modal. You can specify the modal's title and size. If you don't specify the title, it is the node label. If there is no node label, the title remains empty. The default size of the modal is large (`l`), which means 80%. You can also use `m` (60%) and `s` (40%) to set the modal size. Optionally, use it in combination with any of the navigation functions.

bszwarc · 2019-04-02T12:39:55Z

docs/luigi-client-api.md

+Opens a view in a modal. It is possible to specify a title and size. If nothing is specified, the title will be the node label or empty if no node label is set. Default size of the modal is set to large (l), which means 80%. It is also possible to specify m (60%) and s (40%) as modal size. Use it optionally in combination with any of the navigation functions.
+
+#### Parameters
+-   `path` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** path to be navigated to


Suggested change

- `path` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** path to be navigated to

- `path` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** navigation path

is the navigation path different from the path to be navigated to?

bszwarc · 2019-04-02T12:40:24Z

docs/luigi-client-api.md

+
+#### Parameters
+-   `path` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** path to be navigated to
+-   `modalSettings` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** opens a view in a modal. Settings to configure the title and size.


Suggested change

- `modalSettings` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** opens a view in a modal. Settings to configure the title and size.

- `modalSettings` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** opens a view in a modal. Use these settings to configure the modal's title and size.

bszwarc · 2019-04-02T12:41:17Z

docs/luigi-client-api.md

+#### Parameters
+-   `path` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** path to be navigated to
+-   `modalSettings` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** opens a view in a modal. Settings to configure the title and size.
+-   `modalSettings.title` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** modal title (default is node label or empty if no label is defined)


Suggested change

- `modalSettings.title` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** modal title (default is node label or empty if no label is defined)

- `modalSettings.title` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** modal title. By default, it is the node label. If there is no label, it is left empty.

jesusreal

A couple of points from my side:

please merge from master and run again lerna run docu from Luigi´s root folder. I am getting a different output as the current output of this pr.
In Luigi Client file I would replace both occurrences of
@param {string} modalSettings.size size of the modal (l=large 80% default, m=medium 60%, s=small 40%)
with
@param {('l'|'m'|'s')} [modalSettings.size=l] size of the modal (l=large 80%, m=medium 60%, s=small 40%)
and generate the docu again. I will create an extra ticket to properly document optional parameters (with or without default value)
I would say we don't need to specify in the docu that l, m and s mean large, medium and small respectively.

client/luigi-client.d.ts

jesusreal

Just a minor text change suggestion. Apart from that, looks good and it´s approved

jesusreal · 2019-04-03T10:16:54Z

client/src/luigi-client.js

-       * @param {Object} modalSettings settings to customize the modal title and size
-       * @param {string} modalSettings.title modal title
-       * @param {string} modalSettings.size size of the modal (l=large 80% default, m=medium 60%, s=small 40%)
+       * Opens a view in a modal. You can specify the modal's title and size. If you don't specify the title, it is the node label. If there is no node label, the title remains empty.  The default size of the modal is large (`l`), which means 80%. You can also use `m` (60%) and `s` (40%) to set the modal size. Optionally, use it in combination with any of the navigation functions.


Suggested change

* Opens a view in a modal. You can specify the modal's title and size. If you don't specify the title, it is the node label. If there is no node label, the title remains empty. The default size of the modal is large (`l`), which means 80%. You can also use `m` (60%) and `s` (40%) to set the modal size. Optionally, use it in combination with any of the navigation functions.

* Opens a view in a modal. You can specify the modal's title and size. If you don't specify the title, it is the node label. If there is no node label, the title remains empty. The default size of the modal is `l`, which means 80%. You can also use `m` (60%) and `s` (40%) to set the modal size. Optionally, use it in combination with any of the navigation functions.

docu for modal

2b63fa0

JohannesDoberer requested review from bszwarc, kazydek, klaudiagrz, mmitoraj and tomekpapiernik as code owners April 2, 2019 06:58

docu

607bbff

bszwarc self-assigned this Apr 2, 2019

bszwarc added the area/documentation label Apr 2, 2019

bszwarc reviewed Apr 2, 2019

View reviewed changes

JohannesDoberer added 2 commits April 2, 2019 15:17

Merge branch 'master' into docu-for-openAsModal

ddeff2c

docu improvements

522a1e5

jesusreal self-assigned this Apr 2, 2019

jesusreal added the area/luigi label Apr 2, 2019

jesusreal suggested changes Apr 2, 2019

View reviewed changes

JohannesDoberer added 2 commits April 2, 2019 16:14

Merge branch 'master' into docu-for-openAsModal

331f3e2

improvements

1d02bee

JohannesDoberer requested review from antiheld, dariadomagala-sap, hardl, kwiatekus, marynaKhromova, maxmarkus, parostatkiem-zz, pekura and y-kkamil as code owners April 2, 2019 14:33

JohannesDoberer requested a review from jesusreal April 2, 2019 14:34

JohannesDoberer added 2 commits April 2, 2019 20:01

generated docu

728cf77

update docu

38c63eb

kwiatekus changed the title ~~docu for modal~~ docu for modal microfrontends Apr 3, 2019

bszwarc reviewed Apr 3, 2019

View reviewed changes

client/luigi-client.d.ts Show resolved Hide resolved

bszwarc approved these changes Apr 3, 2019

View reviewed changes

jesusreal approved these changes Apr 3, 2019

View reviewed changes

docu update

a032f37

JohannesDoberer merged commit 57ecfca into SAP:master Apr 3, 2019

JohannesDoberer deleted the docu-for-openAsModal branch April 3, 2019 10:22

misappi unassigned bszwarc May 14, 2019

stanleychh pushed a commit to stanleychh/luigi that referenced this pull request Dec 30, 2021

docu for modal microfrontends (SAP#454)

9a963b4

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docu for modal microfrontends #454

docu for modal microfrontends #454

JohannesDoberer commented Apr 2, 2019

bszwarc left a comment

bszwarc Apr 2, 2019

bszwarc Apr 2, 2019

bszwarc Apr 2, 2019

bszwarc Apr 2, 2019

bszwarc Apr 2, 2019

bszwarc Apr 2, 2019

jesusreal left a comment

jesusreal left a comment

jesusreal Apr 3, 2019

	- `modalSettings` [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object) Opens a view in a modal. Settings to configure the title and size.
	- `modalSettings` [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object) Opens a view in a modal. Use these settings to configure the modal's title and size.

	- `modalSettings.title` [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) modal title (default is node label or empty if no label is defined)
	- `modalSettings.title` [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) modal title. By default, it is the node label. If there is no label, it is left empty.

	Opens a view in a modal. It is possible to specify a title and size. If nothing is specified, the title will be the node label or empty if no node label is set. Default size of the modal is set to large (l), which means 80%. It is also possible to specify m (60%) and s (40%) as modal size. Use it optionally in combination with any of the navigation functions.
	Opens a view in a modal. You can specify the modal's title and size. If you don't specify the title, it is the node label. If there is no node label, the title remains empty. The default size of the modal is large (`l`), which means 80%. You can also use `m` (60%) and `s` (40%) to set the modal size. Optionally, use it in combination with any of the navigation functions.

	- `path` [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) path to be navigated to
	- `path` [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) navigation path

	* Opens a view in a modal. You can specify the modal's title and size. If you don't specify the title, it is the node label. If there is no node label, the title remains empty. The default size of the modal is large (`l`), which means 80%. You can also use `m` (60%) and `s` (40%) to set the modal size. Optionally, use it in combination with any of the navigation functions.
	* Opens a view in a modal. You can specify the modal's title and size. If you don't specify the title, it is the node label. If there is no node label, the title remains empty. The default size of the modal is `l`, which means 80%. You can also use `m` (60%) and `s` (40%) to set the modal size. Optionally, use it in combination with any of the navigation functions.

docu for modal microfrontends #454

docu for modal microfrontends #454

Conversation

JohannesDoberer commented Apr 2, 2019

bszwarc left a comment

Choose a reason for hiding this comment

bszwarc Apr 2, 2019

Choose a reason for hiding this comment

bszwarc Apr 2, 2019

Choose a reason for hiding this comment

bszwarc Apr 2, 2019

Choose a reason for hiding this comment

bszwarc Apr 2, 2019

Choose a reason for hiding this comment

bszwarc Apr 2, 2019

Choose a reason for hiding this comment

bszwarc Apr 2, 2019

Choose a reason for hiding this comment

jesusreal left a comment

Choose a reason for hiding this comment

jesusreal left a comment

Choose a reason for hiding this comment

jesusreal Apr 3, 2019

Choose a reason for hiding this comment