Skip to content
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

feat(pie-docs): DSW-2475 toast overview page #2040

Merged
merged 22 commits into from
Nov 15, 2024
Merged
Changes from 1 commit
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
31bccfa
feat(pie-docs): DSW-2475 added images to toast docs
thejfreitas Nov 8, 2024
e89d2df
feat(pie-docs): DSW-2475 created overview page for toast in the docs
thejfreitas Nov 8, 2024
45dc2fa
Merge branch 'main' into dsw-2475-pie-toast-overview-docs
thejfreitas Nov 8, 2024
30fe1a2
feat(pie-docs): DSW-2475 added changesets
thejfreitas Nov 8, 2024
ff0087a
Merge branch 'main' into dsw-2475-pie-toast-overview-docs
raoufswe Nov 11, 2024
5fb1c8f
fix(pie-docs): DSW-2475 update order list styles
raoufswe Nov 11, 2024
236a014
Merge branch 'main' into dsw-2475-pie-toast-overview-docs
raoufswe Nov 11, 2024
1147efd
Merge branch 'main' into dsw-2475-pie-toast-overview-docs
raoufswe Nov 12, 2024
b49f47a
fix(pie-docs): DSW-2475 update alt messages
raoufswe Nov 12, 2024
771771b
fix(pie-docs): DSW-2475 update content
raoufswe Nov 13, 2024
afe13a3
fix(pie-docs): DSW-2475 update content
raoufswe Nov 13, 2024
1c6b95d
fix(pie-docs): DSW-2475 update content
raoufswe Nov 13, 2024
d7a19ff
Merge branch 'main' into dsw-2475-pie-toast-overview-docs
xander-marjoram Nov 13, 2024
fe96ccf
fix(pie-docs): DSW-2475 update resource table
raoufswe Nov 13, 2024
b2ac4af
Merge branch 'main' into dsw-2475-pie-toast-overview-docs
raoufswe Nov 13, 2024
34838fc
Merge branch 'main' into dsw-2475-pie-toast-overview-docs
raoufswe Nov 14, 2024
c95d7c5
fix(pie-docs): DSW-2475 add motion docs
raoufswe Nov 14, 2024
8024347
fix(pie-docs): DSW-2475 update resource table
raoufswe Nov 14, 2024
16edcb3
Merge branch 'main' into dsw-2475-pie-toast-overview-docs
raoufswe Nov 14, 2024
dc96076
fix(pie-docs): DSW-2475 routes
raoufswe Nov 14, 2024
ff00e4a
Merge branch 'main' into dsw-2475-pie-toast-overview-docs
raoufswe Nov 15, 2024
aca9df5
Merge branch 'main' into dsw-2475-pie-toast-overview-docs
raoufswe Nov 15, 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
Prev Previous commit
Next Next commit
fix(pie-docs): DSW-2475 update alt messages
raoufswe committed Nov 12, 2024
commit b49f47ab0a99bec7087b60573fb2a557799ab53a
41 changes: 18 additions & 23 deletions apps/pie-docs/src/components/toast/overview/overview.md
Original file line number Diff line number Diff line change
@@ -82,7 +82,7 @@ If you require additional text for your message, please use the multi-line compo

{% contentPageImage {
src:"../../../assets/img/components/toast/variations-multi-line.svg",
alt: "A toast component on its multi-line variation.",
alt: "A toast component with multiple lines of text. The text is truncated so that a maximum of three lines are shown.",
width: 300
} %}

@@ -96,7 +96,7 @@ To create a stronger impact with your message, you can use strong variant. This

{% contentPageImage {
src:"../../../assets/img/components/toast/modifiers-strong.svg",
alt: "Multiple toasts with strong modifier.",
alt: "The info, warning, success and error toast variants with the strong modifier applied.",
width: 866
} %}

@@ -116,7 +116,7 @@ To create a message with less prominence you can use the subtle variant.

{% contentPageImage {
src:"../../../assets/img/components/toast/modifiers-subtle.svg",
alt: "Multiple toasts with strong modifier.",
alt: "Multiple toasts with the subtle modifier.",
width: 788
} %}

@@ -141,15 +141,15 @@ When incorporating an icon into a Toast, it is essential to ensure that the icon
items: [{
src: "../../../assets/img/components/toast/modifiers-icons-do.svg",
width: "456px",
alt: "Two toast components with close icon button"
alt: "Two toast components using approved icons for the error and info states."
}]
},
dont: {
type: usageTypes.image,
items: [{
src: "../../../assets/img/components/toast/modifiers-icons-dont.svg",
width: "280px",
alt: "A toast without close icon button nor dismiss button"
alt: "An error toast using an unapproved icon"
}]
}
} %}
@@ -172,7 +172,7 @@ If you are using actions, only use the pre-built button in the toast.
items: [{
src: "../../../assets/img/components/toast/modifiers-actions-dont.svg",
width: "280px",
alt: "A toast with a wrong dismiss button variation"
alt: "A toast incorrectly using a custom dismiss button."
}]
}
} %}
@@ -197,7 +197,7 @@ The toast has a minimum width of 300px and a maximum width of 420px.

{% contentPageImage {
src:"../../../assets/img/components/toast/sizes-width.svg",
alt: "A regular toast and a multi-line toast.",
alt: "A 420px wide toast",
width: 420
} %}

@@ -235,14 +235,14 @@ By default the toast automatically disappears after 5 seconds. However, the user
{% contentPageImage {
src: "../../../assets/img/components/toast/behaviours-toast.svg",
width: 300,
alt: "A toast without close icon button nor dismiss button."
alt: "A toast without a close icon button nor a dismiss button."
} %}
{% endcontentItem %}
{% contentItem %}
{% contentPageImage {
src: "../../../assets/img/components/toast/behaviours-toast-with-close-icon-button.svg",
width: 300,
alt: "A toast without with a close icon button."
alt: "A toast with a close icon button."
} %}
{% endcontentItem %}
{% endcontentLayout %}
@@ -252,7 +252,7 @@ By default the toast automatically disappears after 5 seconds. However, the user
{% contentPageImage {
src: "../../../assets/img/components/toast/behaviours-toast-with-dismiss-button.svg",
width: 300,
alt: "A toast without a dismiss button."
alt: "A toast with a dismiss button."
} %}
{% endcontentItem %}
{% endcontentLayout %}
@@ -266,14 +266,14 @@ If the toast includes a close icon button or button with a dismissing purpose, t
{% contentPageImage {
src: "../../../assets/img/components/toast/behaviours-toast-with-close-icon-button.svg",
width: 300,
alt: "A toast without with a close icon button."
alt: "A toast with a close icon button."
} %}
{% endcontentItem %}
{% contentItem %}
{% contentPageImage {
src: "../../../assets/img/components/toast/behaviours-toast-with-dismiss-button.svg",
width: 300,
alt: "A toast without a dismiss button."
alt: "A toast with a dismiss button."
} %}
{% endcontentItem %}
{% endcontentLayout %}
@@ -289,14 +289,14 @@ If the toast includes a close option, the user can select either option to autom
{% contentPageImage {
src: "../../../assets/img/components/toast/interactions-close-icon-button.svg",
width: 300,
alt: "A toast without with a close icon button."
alt: "A toast with a close icon button."
} %}
{% endcontentItem %}
{% contentItem %}
{% contentPageImage {
src: "../../../assets/img/components/toast/interactions-dismiss-button.svg",
width: 300,
alt: "A toast without a dismiss button."
alt: "A toast with a dismiss button."
} %}
{% endcontentItem %}
{% endcontentLayout %}
@@ -311,7 +311,7 @@ A toast should be located at the bottom left of the page’s content are; exclud

{% contentPageImage {
src:"../../../assets/img/components/toast/layout-ltr-position.svg",
alt: "A toast placed at the bottom of the page in LTR position."
alt: "A toast placed at the bottom-left of a page with a left-to-right direction."
} %}

{% list {
@@ -327,7 +327,7 @@ A toast should be located at the bottom right of the page’s content are; exclu

{% contentPageImage {
src:"../../../assets/img/components/toast/layout-rtl-position.svg",
alt: "A toast placed at the bottom of the page in RTL position."
alt: "A toast placed at the bottom-left of a page with a right-to-left direction."
} %}

{% list {
@@ -347,7 +347,7 @@ Here are some examples of Toast in left-to-right context:

{% contentPageImage {
src:"../../../assets/img/components/toast/example-ltr-toast.svg",
alt: "A Toast in left-to-right context.",
alt: "A toast component in a left-to-right context.",
width: 272
} %}

@@ -358,19 +358,14 @@ Here are some examples of Toast in right-to-left context:

{% contentPageImage {
src:"../../../assets/img/components/toast/example-rtl-toast.svg",
alt: "A Toast in right-to-left context.",
alt: "A toast component in a right-to-left context.",
width: 272
} %}

---

## Resources

{% notification {
type: "warning",
message: "We’re currently working on updating our Toast documentation, please see the resources below."
} %}

{% resourceTable {
componentName: 'Toast'
} %}