Fix code examples for SyncCard component#282
Open
devmount wants to merge 2 commits into
Open
Conversation
MelissaAutumn
requested changes
May 13, 2026
Member
MelissaAutumn
left a comment
There was a problem hiding this comment.
Looks good, I have a code example suggestion though.
Also will the border-box break any existing usage on appointment? 🤔
| parameters: { | ||
| docs: { | ||
| source: { | ||
| code: '<sync-card\n title="Title"\n v-model="[\n { key: 0, label: \'Option 1\', checked: false },\n { key: 1, label: \'Option 2\', checked: true },\n { key: 2, label: \'Option 3\', checked: false },\n ]"\n/>', |
Member
There was a problem hiding this comment.
Can v-models be given a inline list? Maybe we should do:
Suggested change
| code: '<sync-card\n title="Title"\n v-model="[\n { key: 0, label: \'Option 1\', checked: false },\n { key: 1, label: \'Option 2\', checked: true },\n { key: 2, label: \'Option 3\', checked: false },\n ]"\n/>', | |
| code: 'const model = ref([\n { key: 0, label: \'Option 1\', checked: false },\n { key: 1, label: \'Option 2\', checked: true },\n { key: 2, label: \'Option 3\', checked: false },\n ]);\n<sync-card\n title="Title"\n v-model="model"\n/>', |
Member
There was a problem hiding this comment.
(Please check that the newlines make sense 😅
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
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.
What changed?
This change improves the demo code examples and enhances the stories for the
SyncCardcomponent. Stories are now grouped by slot or property. Component names and HTML attributes are now in dash-case. Reactivity for the default story is kept intact.Additionally a style issue was fixed, where the list items did overflow their parent container.
Why?
More organized and consistent documentation.
Limitations and Notes
I removed the FilySync Story since it doesn't show properties or slots that weren't shown before. If you still want to keep it, let me know!
Applicable Issues
Closes #267
Screenshots
There weren't any notable changes in the story structure.