Improve navigation parameters reference #847
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
alexandra-simeonova
requested review from
maxmarkus,
hardl,
pekura,
JohannesDoberer,
zarkosimic and
marynaKhromova
alexandra-simeonova
requested review from
bszwarc,
kazydek,
mmitoraj and
tomekpapiernik
as code owners
|
There are some question marks if a property is required or not. Also type is sometimes not clear. One developer should replace these question marks with the correct values. |
alexandra-simeonova
force-pushed
the
improve-navparam-reference
branch
from
0eaf49d to
3d5ef6a
Compare
zarkosimic
reviewed
Oct 10, 2019
zarkosimic
reviewed
Oct 10, 2019
zarkosimic
reviewed
Oct 10, 2019
zarkosimic
reviewed
Oct 10, 2019
zarkosimic
reviewed
Oct 10, 2019
zarkosimic
reviewed
Oct 11, 2019
zarkosimic
suggested changes
Oct 11, 2019
|
|
||
| ### showMainAppEntry | ||
| - **type**: array | ||
| - **description**: includes the link to the root of the Luigi application in the drop-down using the **title** specified in the **settings/header** section of the configuration as a label. |
There was a problem hiding this comment.
I see this only as a boolean type. Might we would need to check it again.
There was a problem hiding this comment.
According to Pete: "if it is set to true then in the app switcher dropdown an entry is shown that points to the app root, and the title of the entry is the title of the app (that is why we only need a boolean here)"
zarkosimic
suggested changes
Oct 11, 2019
There was a problem hiding this comment.
We can also now add 'TabNav'
-> see https://github.com/SAP/luigi/blob/master/docs/navigation-parameters-reference.md
Co-Authored-By: Zarko Simic <[email protected]>
Co-Authored-By: Zarko Simic <[email protected]>
Co-Authored-By: Zarko Simic <[email protected]>
Co-Authored-By: Zarko Simic <[email protected]>
alexandra-simeonova
force-pushed
the
improve-navparam-reference
branch
from
bd918be to
a27f606
Compare
pekura
approved these changes
Oct 22, 2019
zarkosimic
approved these changes
Oct 22, 2019
alexandra-simeonova
changed the title
bszwarc
suggested changes
Oct 25, 2019
|
|
||
| This code sample demonstrates a sample structure with the parameters you can use when configuring navigation for Luigi. | ||
| You can use properties and functions in this reference to configure your Luigi navigation structure. |
There was a problem hiding this comment.
Suggested change
| You can use properties and functions in this reference to configure your Luigi navigation structure. | |
| Use properties and functions in this reference to configure your Luigi navigation structure. |
You can is also good, use is a bit more direct I'd say.
|
|
||
|
|
||
| ## Routing properties | ||
| You can configure the way Luigi tackles routing in your application in the `routing:` section of the configuration file. For example, you can choose the routing strategy to apply in your application as either hash or path location routing. |
There was a problem hiding this comment.
Here, for example, the you can fits better :)
|
|
||
| ### nodeParamPrefix | ||
| - **type**: string | ||
| - **description**: sets the prefix character when using the `LuigiClient.linkManager().withParam()` function, which provides a simple way to attach query parameters to a view URL for activities such as sorting and filtering. The default character is `~`, but you may also define a custom one. Only this prefix can pass query parameters to micro frontends. A different prefix has to be used to pass parameters to the Luigi app itself in order to avoid potential conflicts between the two. |
There was a problem hiding this comment.
Suggested change
| - **description**: sets the prefix character when using the `LuigiClient.linkManager().withParam()` function, which provides a simple way to attach query parameters to a view URL for activities such as sorting and filtering. The default character is `~`, but you may also define a custom one. Only this prefix can pass query parameters to micro frontends. A different prefix has to be used to pass parameters to the Luigi app itself in order to avoid potential conflicts between the two. | |
| - **description**: sets the prefix character when using the `LuigiClient.linkManager().withParam()` function, which provides a simple way to attach query parameters to a view URL for activities such as sorting and filtering. The default character is `~`, but you may also define a custom one. Only this prefix can pass query parameters to micro frontends. A different prefix has to be used to pass parameters to the Luigi app itself to avoid potential conflicts between the two. |
|
|
||
| ### items | ||
| - **type**: array | ||
| - **description**: defines the list of apps. App element attributes are described below. |
There was a problem hiding this comment.
Apps or applications? I'm fine with either one of them, just asking :)
There was a problem hiding this comment.
In the name appSwitcher, app stands for application. So applications is better, I think :)
Co-Authored-By: Barbara Szwarc <[email protected]>
bszwarc
approved these changes
Oct 28, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Changes proposed in this pull request:
Related issue(s)
Epic #766