refactor(docs): use iframes instead of in-page examples #750
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
reinschaap
requested changes
Jan 15, 2025
Comment on lines
+22
to
+28
| <li><a href="#example-navigation">Navigatie</a></li> | ||
| <li><a href="#example-with-content-wrapper">Navigatie met content wrapper</a></li> | ||
| <li><a href="#example-with-search">Navigatie met zoekveld</a></li> | ||
| <li><a href="#example-with-logo">Navigatie en logo</a></li> | ||
| <li><a href="#example-with-multiple-menus">Navigatie met meerdere menu's</a></li> | ||
| <li><a href="#example-with-form-button">Navigatie met formulier-knop</a></li> | ||
| <li><a href="#example-with-logo-above">Navigatie met logo bovenaan</a></li> |
There was a problem hiding this comment.
Suggested change
| <li><a href="#example-navigation">Navigatie</a></li> | |
| <li><a href="#example-with-content-wrapper">Navigatie met content wrapper</a></li> | |
| <li><a href="#example-with-search">Navigatie met zoekveld</a></li> | |
| <li><a href="#example-with-logo">Navigatie en logo</a></li> | |
| <li><a href="#example-with-multiple-menus">Navigatie met meerdere menu's</a></li> | |
| <li><a href="#example-with-form-button">Navigatie met formulier-knop</a></li> | |
| <li><a href="#example-with-logo-above">Navigatie met logo bovenaan</a></li> | |
| <li><a href="#example-navigation">Navigatie</a></li> | |
| <li><a href="#example-navigation-with-content-wrapper">Navigatie met content wrapper</a></li> | |
| <li><a href="#example-navigation-with-search">Navigatie met zoekveld</a></li> | |
| <li><a href="#example-navigation-with-logo">Navigatie en logo</a></li> | |
| <li><a href="#example-navigation-with-multiple-menus">Navigatie met meerdere menu's</a></li> | |
| <li><a href="#example-navigation-with-form-button">Navigatie met formulier-knop</a></li> | |
| <li><a href="#example-navigation-with-logo-above">Navigatie met logo bovenaan</a></li> |
Ik heb deze nog explicietere benaming ook doorgevoerd in de targets (zie verderop)
There was a problem hiding this comment.
The URLs are /components/header-navigation#example-*, I intentionally left off the extra navigation, except for #example-navigation because I thought just #example would be too similar to #examples. But perhaps we can think of a better name than "Navigation" for the first example and solve two naming issues with one... ehm... stone?
| `} | ||
| /> | ||
|
|
||
| <h3 id="example-with-content-wrapper">Navigatie met content wrapper</h3> |
There was a problem hiding this comment.
Suggested change
| <h3 id="example-with-content-wrapper">Navigatie met content wrapper</h3> | |
| <h3 id="example-navigation-with-content-wrapper">Navigatie met content wrapper</h3> |
| `} | ||
| /> | ||
|
|
||
| <h3 id="example-with-search">Navigatie met zoekveld</h3> |
There was a problem hiding this comment.
Suggested change
| <h3 id="example-with-search">Navigatie met zoekveld</h3> | |
| <h3 id="example-navigation-with-search">Navigatie met zoekveld</h3> |
| `} | ||
| /> | ||
|
|
||
| <h3 id="example-with-logo">Navigatie en logo</h3> |
There was a problem hiding this comment.
Suggested change
| <h3 id="example-with-logo">Navigatie en logo</h3> | |
| <h3 id="example-navigation-with-logo">Navigatie en logo</h3> |
docs/src/routes/components/sidemenu/next-to-page-collapsible/+page.svelte
Outdated
Show resolved
Hide resolved
docs/src/routes/components/sidemenu/next-to-page-collapsible/+page.svelte
Outdated
Show resolved
Hide resolved
docs/src/routes/components/sidemenu/next-to-page-collapsible/+page.svelte
Show resolved
Hide resolved
docs/src/routes/examples/sidemenu-in-page-expandable/+page.svelte
Outdated
Show resolved
Hide resolved
Co-authored-by: Rein Schaap <[email protected]>
Co-authored-by: Rein Schaap <[email protected]>
Co-authored-by: Rein Schaap <[email protected]>
Co-authored-by: Rein Schaap <[email protected]>
Co-authored-by: Rein Schaap <[email protected]>
Co-authored-by: Rein Schaap <[email protected]>
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.
This PR refactors the way header and sidemenu examples are presented. Instead of "abusing" the docs page itself, the visual examples are now on separate pages and presented in the docs in iframes.
Not "abusing" the page itself removes the need for layout overrides, removing the need for the
(docs)route group.