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 content
raoufswe committed Nov 13, 2024
commit afe13a351248b99b4e2e4a1ce17a13610ce56239
9 changes: 5 additions & 4 deletions apps/pie-docs/src/components/toast/overview/overview.md
Original file line number Diff line number Diff line change
@@ -35,9 +35,8 @@ Toasts are used to inform users about processes within a system. They can also p
dont: {
type: usageTypes.text,
items: [
"Interrupt the user experience.",
"Use a toast of critical information that user needs to action consider using a pop-alert instead.",
"Place the toast over any navigation."
"Don’t use toasts for critical information.",
"Don’t place the toast over any navigational elements."
]
}
} %}
@@ -205,7 +204,7 @@ The toast has a minimum width of 300px and a maximum width of 420px.

## Overflow

If the body copy extends beyond one line, it should automatically wrap to multiple lines. Multi-line text will be truncated so that it does not exceed three lines. For longer text content, consider utilising a pop-up component.
If the body copy extends beyond one line, it should automatically wrap to multiple lines. Multi-line text will be truncated so that it does not exceed three lines. For longer text content, consider an alternative component.

{% contentPageImage {
src:"../../../assets/img/components/toast/overflow.svg",
@@ -219,6 +218,8 @@ If the body copy extends beyond one line, it should automatically wrap to multip

Only one toast is displayed at a time. When toasts are consecutively or simultaneously triggered, their display order is defined by the priority queue.

Each level takes priority over those below it, queues alongside toasts of the same priority, and yields to higher priority levels.

{% componentDetailsTable {
tableData: priorityQueue
} %}
33 changes: 11 additions & 22 deletions apps/pie-docs/src/components/toast/overview/priority-queue.json
Original file line number Diff line number Diff line change
@@ -1,59 +1,48 @@
{
"headings": [
"Priority",
"Variant",
"Behaviour"
"Variant"
],
"rows": [
[
"1",
"Error - actionable",
"Takes precedence over lower priority ones, queuing alongside same priority toasts"
"Error - actionable"
],
[
"2",
"Error",
"Second level priority, and takes precedence over lower priority ones, queuing alongside same priority toasts and yielding to higher priority ones."
"Error"
],
[
"3",
"Warning - actionable",
"Third level priority, and takes precedence over lower priority ones, queuing alongside same priority toasts and yielding to higher priority ones."
"Warning - actionable"
],
[
"4",
"Positive - actionable",
"Fourth level priority, and takes precedence over lower priority ones, queuing alongside same priority toasts and yielding to higher priority ones."
"Positive - actionable"
],
[
"5",
"Info - actionable",
"Fifth level priority, and takes precedence over lower priority ones, queuing alongside same priority toasts and yielding to higher priority ones."
"Info - actionable"
],
[
"6",
"Neutral - actionable",
"Sixth level priority, and takes precedence over lower priority ones, queuing alongside same priority toasts and yielding to higher priority ones."
"Neutral - actionable"
],
[
"7",
"Warning",
"Seventh level priority, and takes precedence over lower priority ones, queuing alongside same priority toasts and yielding to higher priority ones."
"Warning"
],
[
"8",
"Positive",
"Eighth level priority, and takes precedence over lower priority ones, queuing alongside same priority toasts and yielding to higher priority ones."
"Positive"
],
[
"9",
"Info",
"Ninth level priority, and takes precedence over lower priority ones, queuing alongside same priority toasts and yielding to higher priority ones."
"Info"
],
[
"10",
"Neutral",
"Tenth level priority, queuing alongside same priority toasts and yielding to higher priority ones."
"Neutral"
]
]
}