Skip to content

Commit

Permalink
Update content on instance "G8PxwzFNOD" for "Errors"
Browse files Browse the repository at this point in the history
  • Loading branch information
@knapsack-cloud
knapsack-cloud[bot] authored Jan 10, 2025
1 parent f11fafe commit c78db5e
Show file tree
Hide file tree
Showing 11 changed files with 213 additions and 219 deletions.
48 changes: 48 additions & 0 deletions apps/knapsack/data/blocks/block.LCXJepL3ao.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
{
"id": "LCXJepL3ao",
"data": {
"guidelines": [
{
"id": "tPCjjyQB0C",
"type": "do",
"content": {
"type": "doc",
"content": [
{
"type": "paragraph",
"content": [
{
"text": "Use short phrases. This means you can omit articles such as \"the.\" No ending punctuation is needed when the message has only one phrase.",
"type": "text"
}
]
}
]
}
},
{
"id": "tobi2Ow-6",
"type": "dont",
"content": {
"type": "doc",
"content": [
{
"type": "paragraph",
"content": [
{
"text": "Don't use periods when the message has only one phrase that's not a complete sentence. ",
"type": "text"
}
]
}
]
}
}
],
"tileStyles": {
"imageSize": "none",
"headerBeforeImage": false
}
},
"blockType": "guidelines"
}
22 changes: 22 additions & 0 deletions apps/knapsack/data/blocks/block.UOAvS2msXU.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
{
"id": "UOAvS2msXU",
"data": {
"items": [
{
"fileId": "KvXVAmYdCVAS7hzkOa73Em",
"nodeId": "14855:5791"
},
{
"fileId": "KvXVAmYdCVAS7hzkOa73Em",
"nodeId": "14855:5793"
}
],
"columns": "2",
"imageStyles": {
"fit": "fill",
"size": "auto",
"seamless": true
}
},
"blockType": "design-src-tiles"
}
17 changes: 13 additions & 4 deletions apps/knapsack/data/blocks/block.Ub7z1ZeD3l.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,16 @@
"type": "paragraph",
"content": [
{
"text": "“The email address must include an ‘@’ symbol.”",
"text": "Link to the appropriate in-product help topic when more detailed information may be helpful beyond the brief message. ",
"type": "text"
}
]
},
{
"type": "paragraph",
"content": [
{
"text": "The standard phrase is \"Learn more.\" When it appears at the end of the message, always include a period within the hyperlink. This ensures consistency in the style and translation across the different languages.",
"type": "text"
}
]
Expand All @@ -30,7 +39,7 @@
"type": "paragraph",
"content": [
{
"text": "“Field invalid.”",
"text": "Don't exceed the recommended 40 characters. ",
"type": "text"
}
]
Expand All @@ -40,8 +49,8 @@
}
],
"tileStyles": {
"imageSize": "xsmall",
"headerBeforeImage": true
"imageSize": "none",
"headerBeforeImage": false
}
},
"blockType": "guidelines"
Expand Down
194 changes: 77 additions & 117 deletions apps/knapsack/data/blocks/block.nHHM8ZY1t.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
},
"content": [
{
"text": "Inline error messages provide immediate feedback on specific input fields, helping users understand and resolve issues in context. This reduces frustration and enhances the overall experience.",
"text": "Inline errors are localized, input-specific. They are meant to provide immediate feedback, help users resolve issues in context, and prevent submission of invalid or incomplete data. ",
"type": "text"
}
]
Expand All @@ -36,29 +36,49 @@
},
"content": [
{
"text": "Pattern Categorization",
"text": " ",
"type": "text"
}
]
},
{
"type": "paragraph",
"attrs": {
"textAlign": "left"
},
"content": [
{
"text": "Accessibility",
"type": "text",
"marks": [
{
"type": "bold"
}
]
},
}
]
},
{
"type": "paragraph",
"attrs": {
"textAlign": "left"
},
"content": [
{
"text": ": Inline errors are categorized as ",
"text": "Use ARIA roles (",
"type": "text"
},
{
"text": "localized, input-specific errors",
"text": "aria-describedby",
"type": "text",
"marks": [
{
"type": "bold"
"type": "code"
}
]
},
{
"text": ". They are used to validate user input and prevent the submission of invalid or incomplete data.",
"text": ") to link errors to their fields.",
"type": "text"
}
]
Expand All @@ -70,137 +90,59 @@
},
"content": [
{
"text": "Guidelines",
"text": "Supportive, neutral tone",
"type": "text",
"marks": [
{
"type": "bold"
}
]
},
{
"text": ":",
"type": "text"
}
]
},
{
"type": "bulletList",
"type": "paragraph",
"attrs": {
"textAlign": "left"
},
"content": [
{
"type": "listItem",
"content": [
{
"type": "paragraph",
"attrs": {
"textAlign": "left"
},
"content": [
{
"text": "Tone",
"type": "text",
"marks": [
{
"type": "bold"
}
]
},
{
"text": ": Be empathetic and instructive (example: “Please enter a valid email address”).",
"type": "text"
}
]
}
]
"text": "Focus on communicating how the user can fix the error. Avoid using emotionally charging words such as \"fail,\" \"oops,\" \"sorry,\" \"please\" in these already-tense situations. Learn more in ",
"type": "text"
},
{
"type": "listItem",
"content": [
"text": "Content",
"type": "text",
"marks": [
{
"type": "paragraph",
"type": "link",
"attrs": {
"textAlign": "left"
},
"content": [
{
"text": "Clarity",
"type": "text",
"marks": [
{
"type": "bold"
}
]
},
{
"text": ": Use plain language and avoid jargon.",
"type": "text"
}
]
"rel": "noopener noreferrer nofollow",
"href": "/site/covalent/G8PxwzFNOD/pages/error-messages",
"class": null,
"target": "_self"
}
}
]
},
{
"type": "listItem",
"content": [
{
"type": "paragraph",
"attrs": {
"textAlign": "left"
},
"content": [
{
"text": "Placement",
"type": "text",
"marks": [
{
"type": "bold"
}
]
},
{
"text": ": Position error messages directly below the problematic input field.",
"type": "text"
}
]
}
]
},
"text": ".",
"type": "text"
}
]
},
{
"type": "paragraph",
"attrs": {
"textAlign": "left"
},
"content": [
{
"type": "listItem",
"content": [
"text": "Brevity ",
"type": "text",
"marks": [
{
"type": "paragraph",
"attrs": {
"textAlign": "left"
},
"content": [
{
"text": "Accessibility",
"type": "text",
"marks": [
{
"type": "bold"
}
]
},
{
"text": ": Use ARIA roles (",
"type": "text"
},
{
"text": "aria-describedby",
"type": "text",
"marks": [
{
"type": "code"
}
]
},
{
"text": ") to link errors to their fields",
"type": "text"
}
]
"type": "bold"
}
]
}
Expand All @@ -210,7 +152,25 @@
"type": "paragraph",
"attrs": {
"textAlign": "left"
}
},
"content": [
{
"text": "An in-line error is designed to be close to the text field with a distinct visual style, so the affordance allows the message to be extremely brief and still be clear. Keep a message under 40 characters to not overwhelm the user. ",
"type": "text"
}
]
},
{
"type": "paragraph",
"attrs": {
"textAlign": "left"
},
"content": [
{
"text": "Learn how to write for brevity in these errors:",
"type": "text"
}
]
}
]
}
Expand Down
14 changes: 14 additions & 0 deletions apps/knapsack/data/blocks/block.oKGhL28y0a.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"id": "oKGhL28y0a",
"data": {
"content": {
"type": "doc",
"content": [
{
"type": "paragraph"
}
]
}
},
"blockType": "text-editor"
}
Loading

0 comments on commit c78db5e

Please sign in to comment.