Skip to content

Update button api.json #3376

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 62 additions & 0 deletions src/components/button/button.api.json
Original file line number Diff line number Diff line change
Expand Up @@ -893,6 +893,68 @@
"type": "section"
}
]
},
{
"title": "UX",
"sections": [
{
"type": "list",
"items": [
{
"title": "Unclear buttons hierarchy",
"description": "Have a clear hierarchy of your buttons. Decide which one of the actions in your screen is the main one and use a Primary button for it. All other buttons should be secondary and tertiary in the way they look. Destructive actions should be treated likewise. ",
"content": [
{
"value": "https://wixmp-1d257fba8470f1b562a0f5f2.wixmp.com/mads-docs-assets/assets/Components Docs/Button/button_UX_dosDonts_hierarchy.png"
}
]
},
{
"title": "Inappropriate buttons layout",
"description": "Make sure you’re using a layout that can accommodate actions text. ",
"content": [
{
"value": "https://wixmp-1d257fba8470f1b562a0f5f2.wixmp.com/mads-docs-assets/assets/Components Docs/Button/button_UX_dosDonts_layout.png"
}
]
},
{
"title": "Action text truncation/ellipsis",
"description": "Action text truncation or ellipsis should be avoided at all costs.\nActions should be clear and down to the point. 
In case the action is complex, consider displaying an explanatory text outside the actual button component. ",
"content": [
{
"value": "https://wixmp-1d257fba8470f1b562a0f5f2.wixmp.com/mads-docs-assets/assets/Components Docs/Button/button_UX_dosDonts_truncation.png"
}
]
}
],
"title": "Do’s & Don'ts",
"description": "There are a few things to avoid when implementing buttons in your screen:"
},
{
"type": "list",
"items": [
{
"title": "Full Width Button",
"description": "Medium prominence. Used in management screens for the main action, e.g. ‘Add New’",
"content": [
{
"value": "https://wixmp-1d257fba8470f1b562a0f5f2.wixmp.com/mads-docs-assets/assets/Components Docs/Button/button_UX_comparison1.png"
}
]
},
{
"title": "Floating Button",
"description": "High prominence. Used as the main CTA on the screen, e.g. ‘Join Now’, ‘Create’",
"content": [
{
"value": "https://wixmp-1d257fba8470f1b562a0f5f2.wixmp.com/mads-docs-assets/assets/Components Docs/Button/button_UX_comparison2.png"
}
]
}
]
}
]
}
]
}
Expand Down