-
Notifications
You must be signed in to change notification settings - Fork 18
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(navigation-secondary): improve jsdoc and code tab (#964)
* docs(navigation-secondary): improve jsdoc and code tab * docs(navigation-secondary): improve visible property jsdoc * docs(navigation-secondary): improve shadowparts jsdoc * docs: remove htmlexample shortcode * docs(navigation-secondary): move playground to code tab * docs(navigation-secondary): add system tokens to jsdoc * docs(navigation-secondary): modify required text * docs(navigation-secondary): fix typo in jsdoc * docs(playground): added a border around plaground parts * docs: prefer logical properties * chore(navigation-secondary): add changeset * fix(navigation-secondary): remove defaults from system tokens * docs(navigation-secondary): change path for lightdom to cdn url * chore(navigation-secondary): update changeset * fix(navigation-secondary): remove syntax annotations --------- Co-authored-by: Nikki Massaro Kauffman <nmassaro@redhat.com>
- Loading branch information
Showing
9 changed files
with
182 additions
and
185 deletions.
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| "@rhds/elements": patch | ||
| --- | ||
|
|
||
| `<rh-navigation-secondary>`: corrected css parts and css properties manifest documentation |
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,9 +1,78 @@ | ||
| {% renderOverview %}{% endrenderOverview %} | ||
| {% renderInstallation %} | ||
| ~~~html | ||
| <link rel="stylesheet" href="https://redhatstatic.com/dx/v1-alpha/@rhds/elements@1.0.2/rh-navigation-secondary/rh-navigation-secondary-lightdom.css"> | ||
| ~~~ | ||
| Lightdom CSS is required to ensure a reduced [Cumulative Layout Shift (CLS)](https://web.dev/cls/) experience before the component has fully initialized. | ||
| {% endrenderInstallation %} | ||
|
|
||
| {% renderSlots %}{% endrenderSlots %} | ||
| {% section headline="Usage", headingLevel="2" -%} | ||
| View a live version of this component and see how it can be customized. | ||
| {% playground tagName=tagName %}{% endplayground %} | ||
| {% cta href="./demo/", target="_blank" %} | ||
| View the `<rh-navigation-secondary>` demo in a new tab | ||
| {% endcta %} | ||
| {% endsection %} | ||
|
|
||
| {% renderAttributes %}{% endrenderAttributes %} | ||
| {% section headline="<rh-navigation-secondary>", headingLevel="2" -%} | ||
|
|
||
| {% renderMethods %}{% endrenderMethods %} | ||
| {% renderSlots for='rh-navigation-secondary', level=3 %}{% endrenderSlots %} | ||
|
|
||
| {% renderEvents %}{% endrenderEvents %} | ||
| {% renderAttributes for='rh-navigation-secondary', level=3 %}{% endrenderAttributes %} | ||
|
|
||
| {% renderMethods for='rh-navigation-secondary', level=3 %}{% endrenderMethods %} | ||
|
|
||
| {% renderEvents for='rh-navigation-secondary', level=3 %}{% endrenderEvents %} | ||
|
|
||
| {% renderCssParts for='rh-navigation-secondary', level=3 %}{% endrenderCssParts %} | ||
|
|
||
| {% renderCssCustomProperties for='rh-navigation-secondary', level=3 %}{% endrenderCssCustomProperties %} | ||
| {% endsection %} | ||
|
|
||
| {% section headline="<rh-navigation-secondary-dropdown>", headingLevel="2" -%} | ||
|
|
||
| {% renderSlots for='rh-navigation-secondary-dropdown', level=3 %}{% endrenderSlots %} | ||
|
|
||
| {% renderAttributes for='rh-navigation-secondary-dropdown', level=3 %}{% endrenderAttributes %} | ||
|
|
||
| {% renderMethods for='rh-navigation-secondary-dropdown', level=3 %}{% endrenderMethods %} | ||
|
|
||
| {% renderEvents for='rh-navigation-secondary-dropdown', level=3 %}{% endrenderEvents %} | ||
|
|
||
| {% renderCssParts for='rh-navigation-secondary-dropdown', level=3 %}{% endrenderCssParts %} | ||
|
|
||
| {% renderCssCustomProperties for='rh-navigation-secondary-dropdown', level=3 %}{% endrenderCssCustomProperties %} | ||
|
|
||
| {% endsection %} | ||
|
|
||
| {% section headline="<rh-navigation-secondary-menu>", headingLevel="2" -%} | ||
|
|
||
| {% renderSlots for='rh-navigation-secondary-menu', level=3 %}{% endrenderSlots %} | ||
|
|
||
| {% renderAttributes for='rh-navigation-secondary-menu', level=3 %}{% endrenderAttributes %} | ||
|
|
||
| {% renderMethods for='rh-navigation-secondary-menu', level=3 %}{% endrenderMethods %} | ||
|
|
||
| {% renderEvents for='rh-navigation-secondary-menu', level=3 %}{% endrenderEvents %} | ||
|
|
||
| {% renderCssParts for='rh-navigation-secondary-menu', level=3 %}{% endrenderCssParts %} | ||
|
|
||
| {% renderCssCustomProperties for='rh-navigation-secondary-menu', level=3 %}{% endrenderCssCustomProperties %} | ||
|
|
||
| {% endsection %} | ||
|
|
||
| {% section headline="<rh-navigation-secondary-menu-section>", headingLevel="2" -%} | ||
|
|
||
| {% renderSlots for='rh-navigation-secondary-menu-section', level=3 %}{% endrenderSlots %} | ||
|
|
||
| {% renderAttributes for='rh-navigation-secondary-menu-section', level=3 %}{% endrenderAttributes %} | ||
|
|
||
| {% renderMethods for='rh-navigation-secondary-menu-section', level=3 %}{% endrenderMethods %} | ||
|
|
||
| {% renderEvents for='rh-navigation-secondary-menu-section', level=3 %}{% endrenderEvents %} | ||
|
|
||
| {% renderCssParts for='rh-navigation-secondary-menu-section', level=3 %}{% endrenderCssParts %} | ||
|
|
||
| {% renderCssCustomProperties for='rh-navigation-secondary-menu-section', level=3 %}{% endrenderCssCustomProperties %} | ||
|
|
||
| {% endsection %} |
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
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
Oops, something went wrong.