-
Notifications
You must be signed in to change notification settings - Fork 33
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[DOC] Document the minimum public API #1060
Conversation
initial thoughts
Co-authored-by: Thomas Bouffard <27200110+tbouffard@users.noreply.github.com>
@@ -24,17 +26,22 @@ export interface GlobalOptions { | |||
navigation?: NavigationConfiguration; | |||
} | |||
|
|||
/** | |||
* @category Initialization | |||
*/ | |||
export interface NavigationConfiguration { | |||
/** | |||
* @default false | |||
*/ | |||
enabled: boolean; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this one is not mandary
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The navigation field in GlobalOptions is already optional.
If the user instantiate this object, the enabled field should be mandatory, else I don't see the point to instantiate this object (or we can not have this field).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
good point, so let's keep it as it is.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just a little modification to simplify the reading ^^
Co-authored-by: Souchet Céline <4921914+csouchet@users.noreply.github.com>
This reverts commit f74fe22
@csouchet I have reverted your suggestion in f111757. Because |
Kudos, SonarCloud Quality Gate passed! |
To re-export a default class: https://stackoverflow.com/questions/36790911/reexport-class-in-typescript |
List initialization, load, and registry API.
Introduce 2 Categories in the documentation
Initialization
: creation of the main object and its configurationInteraction
: user interactions, changes in the visual part of the diagramit looks like that:

closes #593