Skip to content

Update statescreen api.json #3427

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.

Sign up for GitHub

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
merged 2 commits into from
Dec 2, 2024
Merged

Update statescreen api.json #3427

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
23d6247
wix-noci: update api.json
rnuinoci[bot] Nov 28, 2024
5107272
reorder sections in Overview tab
Inbal-Tish Dec 2, 2024
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
63 changes: 16 additions & 47 deletions src/components/stateScreen/stateScreen.api.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,56 +58,25 @@
"title": "Overview",
"sections": [
{
"type": "list",
"items": [
{
"title": "State Screen with illustration",
"description": "Suitable for success messages, empty states and \"pay-attention\" messages.",
"content": [
{
"value": "https://wixmp-1d257fba8470f1b562a0f5f2.wixmp.com/mads-docs-assets/assets/Components%20Docs/StateScreen/stateScreen_overview_types_illustration.png"
}
]
},
{
"title": "State Screen with Marketing Visual",
"description": "Suitable for FTEs and marketing messages.",
"content": [
{
"value": "https://wixmp-1d257fba8470f1b562a0f5f2.wixmp.com/mads-docs-assets/assets/Components%20Docs/StateScreen/stateScreen_overview_types_visual.png"
}
]
},
{
"title": "State Screen with Cover Image",
"description": "Suitable for FTEs and marketing messages.",
"content": [
{
"value": "https://wixmp-1d257fba8470f1b562a0f5f2.wixmp.com/mads-docs-assets/assets/Components%20Docs/StateScreen/stateScreen_overview_types_cover.png"
}
]
},
{
"title": "State Screen with Text Only",
"description": "Suitable for empty states.",
"content": [
{
"value": "https://wixmp-1d257fba8470f1b562a0f5f2.wixmp.com/mads-docs-assets/assets/Components%20Docs/StateScreen/stateScreen_overview_types_text.png"
}
]
},
"type": "section",
"title": "Overview",
"description": "The State screen component is composed of a visual, title, subtitle, CTA, link button, and disclaimer. Each element is optional and they all can be combined in various ways to meet different needs.\n\nState screens can occupy a full screen or a portion of it. They can be used in both modals and pushed screens.",
"content": [
{
"title": "Error Screen",
"content": [
{
"value": "https://wixmp-1d257fba8470f1b562a0f5f2.wixmp.com/mads-docs-assets/assets/Components%20Docs/StateScreen/stateScreen_overview_types_error.png"
}
],
"description": "Suitable for showcasing and explaining errors."
"value": "https://wixmp-1d257fba8470f1b562a0f5f2.wixmp.com/mads-docs-assets/assets/Components%20Docs/StateScreen/stateScreen_overview.png"
}
],
"layout": "horizontal",
"title": "Types"
"layout": "horizontal"
},
{
"type": "section",
"title": "Visual Types",
"description": "The State Screen component can be used with or without a visual.
A visual can be an illustration, marketing visual, cover image or an icon. ",
"content": [
{
"value": "https://wixmp-1d257fba8470f1b562a0f5f2.wixmp.com/mads-docs-assets/assets/Components%20Docs/StateScreen/stateScreen_overview_visualTypes.png"
}
]
},
{
"type": "list",
Expand Down