chore (refs T33323): add storybook documentation to DpTabs. #344
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
spiess-demos
requested changes
Jul 3, 2023
Comment on lines
43
to
62
| ## DpTabs Props: | ||
|
|
||
| ``` | ||
| - activeId: is a String type, belongs to data. | ||
|
|
||
| - tabSize: `medium` or `large`, default is `large` | ||
|
|
||
| - useUrlFragment: Active tab state may be persisted via an Url fragment. | ||
| Also, ab clicks are pushed to the browser history to enable state change when browser navigation is used. | ||
| ``` | ||
|
|
||
| ## DpTab Props: | ||
|
|
||
| ``` | ||
| - id: Tab ID. | ||
|
|
||
| - label: The label is passed to the DpTab child component, but then it is used in the parent component DpTabs. | ||
|
|
||
| - suffix: A html string may be passed here which is appended to the tab label. | ||
| ``` |
There was a problem hiding this comment.
Vue component props are typically "auto-documented" by storybook using vue-docgen-api and vue-docgen-loader. At the moment the Storybook docs integraton is broken so that the props are not showing up as expected, however there is no need to document them by hand. Rather we could fill in the blanks by adding docblocks directly above the props themselves.
Co-authored-by: spiess-demos <40452344+spiess-demos@users.noreply.github.com>
Co-authored-by: spiess-demos <40452344+spiess-demos@users.noreply.github.com>
Co-authored-by: spiess-demos <40452344+spiess-demos@users.noreply.github.com>
Co-authored-by: spiess-demos <40452344+spiess-demos@users.noreply.github.com>
Co-authored-by: spiess-demos <40452344+spiess-demos@users.noreply.github.com>
Co-authored-by: spiess-demos <40452344+spiess-demos@users.noreply.github.com>
Co-authored-by: spiess-demos <40452344+spiess-demos@users.noreply.github.com>
spiess-demos
reviewed
Jul 4, 2023
| @@ -6,6 +6,10 @@ Since v0.0.10, this Changelog is formatted according to the [Common Changelog][c | |||
|
|
|||
| ### Added | |||
|
|
|||
| - ([#344](https://github.com/demos-europe/demosplan-ui/pull/344)) docs: add documentation for DpTabs ([@@ahmad-demos](https://github.com/@ahmad-demos)) | |||
|
|
|||
| ### Added | |||
There was a problem hiding this comment.
An "Added" section already exists!
- props not showing up as expected, because Storybook docs integration is broken.
spiess-demos
reviewed
Jul 4, 2023
Co-authored-by: spiess-demos <40452344+spiess-demos@users.noreply.github.com>
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.
https://yaits.demos-deutschland.de/T33323