Preview for components in documentation website #80
Conversation
This file contains hidden or 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
YuKongA
changed the title
YuKongA
changed the title
There was a problem hiding this comment.
Pull Request Overview
Adds interactive live previews to component documentation and updates example code and the docs build workflow.
- Inserts preview iframes into each component’s markdown page for visual demos.
- Updates Kotlin samples: switches state holders from
vartovaland enhances layout code inListPopupandFloatingToolbar. - Extends the GitHub Actions docs workflow to build and publish Compose demo assets.
Reviewed Changes
Copilot reviewed 103 out of 103 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/components/superarrow.md | Added iframe preview container |
| docs/components/smalltitle.md | Added iframe preview container |
| docs/components/slider.md | Added iframe preview container |
| docs/components/searchbar.md | Added iframe preview container |
| docs/components/scaffold.md | Added iframe preview container |
| docs/components/pulltorefresh.md | Added usage warning and external example link; no-live preview |
| docs/components/progressindicator.md | Added iframe preview container |
| docs/components/navigationbar.md | Added iframe preview container |
| docs/components/listpopup.md | Added iframe preview, replaced var with val, added alignment parameter |
| docs/components/iconbutton.md | Added iframe preview container |
| docs/components/icon.md | Added iframe preview container |
| docs/components/floatingtoolbar.md | Added iframe preview, refactored Row/Column layout snippets |
| docs/components/floatingactionbutton.md | Added iframe preview container |
| docs/components/divider.md | Added iframe preview container |
| docs/components/colorpicker.md | Added iframe preview container |
| docs/components/checkbox.md | Added iframe preview container |
| docs/components/card.md | Added iframe preview container |
| docs/components/button.md | Added iframe preview container |
| docs/components/basiccomponent.md | Added iframe preview container |
| .github/workflows/docs.yml | Extended workflow steps to build/demo and move Compose artifacts |
Comments suppressed due to low confidence (1)
docs/components/listpopup.md:33
- The code sample now references
PopupPositionProvider.Alignbut doesn’t show its import. Consider adding the corresponding import statement to the snippet for clarity.
alignment = PopupPositionProvider.Align.Left,
|
|
||
| `SuperArrow` is a directional indicator component in Miuix, typically used for navigation or displaying additional content. It provides a title, summary, and right arrow icon with click interaction support, commonly used in settings, menu items, or list items. | ||
|
|
||
| <div style="position: relative; max-width: 700px; height: 280px; border-radius: 10px; overflow: hidden; border: 1px solid #777;"> |
There was a problem hiding this comment.
[nitpick] This inline styling is repeated across many component docs. Extract these common styles into a shared CSS class to reduce duplication and improve maintainability.
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
YuKongA
added a commit
that referenced
this pull request
Jun 8, 2025
YuKongA
added a commit
that referenced
this pull request
Jun 8, 2025
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.
#77