Add autogenerated luigi client api docs #137
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
jesusreal
requested review from
antiheld,
bszwarc,
dariadomagala-sap,
hardl,
kazydek,
klaudiagrz,
kwiatekus,
maxmarkus,
pekura,
tomekpapiernik and
y-kkamil
as code owners
maxmarkus
reviewed
Oct 12, 2018
client/luigi-client.js
Outdated
| */ | ||
| showLoadingIndicator: function showLoadingIndicator() { | ||
| window.parent.postMessage({ msg: 'luigi.show-loading-indicator' }, '*'); | ||
| }, | ||
| /** | ||
| * Hides the spinner | ||
| * Removes the loading indicator. Use it after calling {@link #showLoadingIndicator showLoadingIndicator()} or to hide the indicator when you use the `loadingIndicator.hideAutomatically: false` Node configuration. |
There was a problem hiding this comment.
Can loadingIndicator.hideAutomatically be linked to the configuration?
There was a problem hiding this comment.
Linked to navigation-configuration.md#nodes
client/luigi-client.js
Outdated
| /** | ||
| * Shows a spinner with backdrop to block the micro front-end frame | ||
| * Adds a backdrop with a loading indicator for the micro front-end frame. This overrides the `loadingIndicator.enabled` setting. |
There was a problem hiding this comment.
Can loadingIndicator.enabled be linked to the configuration?
There was a problem hiding this comment.
Linked to navigation-configuration.md#nodes
client/luigi-client.js
Outdated
| * Usage: linkManager.fromContext("currentTeam").navigate("path") | ||
| * @param {object} navigationContext | ||
| * */ | ||
| * Sets the current navigation context to that of a specific parent Node that has the `navigationContext` field declared in its navigation configuration. This navigation context is then used by navigate function. |
There was a problem hiding this comment.
Can we link navigationContext to the configuration documentation?
There was a problem hiding this comment.
Linked to navigation-configuration.md#nodes
bszwarc
suggested changes
Oct 15, 2018
docs/luigi-client-api.md
Outdated
|
|
||
| Returns the configuration object of the active navigation Node. | ||
|
|
||
| Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** node parameters |
docs/luigi-client-api.md
Outdated
|
|
||
| - `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. You must use the function [goBack()](#goBack) to navigate back afterwards. You can use this feature at unlimited levels.The preserved views are discarded as soon as the standard [navigate()](#navigate) function is in use in place of [goBack()](#goBack) . |
docs/luigi-client-api.md
Outdated
| LuigiClient.linkManager().fromContext('project').navigate('/settings') | ||
| ``` | ||
|
|
||
| Returns **[linkManager](#linkmanager)** link manager instance |
maxmarkus
suggested changes
Oct 15, 2018
bszwarc
reviewed
Oct 15, 2018
docs/luigi-client-api.md
Outdated
|
|
||
| Checks if there are one or more preserved views. Can be used to show a back button. | ||
|
|
||
| Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** a boolean with the information if there is a preserved view available to which a user can return.. |
maxmarkus
approved these changes
Oct 16, 2018
stanleychh
pushed a commit
to stanleychh/luigi
that referenced
this pull request
Dec 30, 2021
* Move luigi client docu from readmes to inline code * Add npm scripts for documentation * generate first version of documentation * update auto generated docu to latest status * Point index readme links to new autogenerated docu sections * Clean up docu * Add links for other sections references and consistency for fields mentioned in docu * Refactor private variables and wrap initialization logic in a function * refactor link manager * Move setContext and hasHash methods to inner scopes * set initial value fromClosestContext option in link manager to false * Remove old documentation files * Add instructions for docu generation in Luigi readme file * Add dependency for documentation generation on luigi client * Update links in documentation based on pr review * Update documentation based on technical writer review * Small grammatical fix in documentation * update husky dependency and add pre-push hook for luigi client docu validation
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)