diff --git a/docs/api/item.md b/docs/api/item.md index 16df7d28462..cc15d8b6265 100644 --- a/docs/api/item.md +++ b/docs/api/item.md @@ -47,7 +47,7 @@ If a visual is required to interact with the item, such as an icon button, then doText="Align visuals on the same side in a list" doNotText="Don't render visuals with different alignments in the same list" doImage={A list with several items. Each item has an icon and visible text describing the item. The icon in each item is rendered at the start of the line.} - doNotImage={A list with several items. Each item has an icon and visible text describing the item. Some icons are rendered at the start of the line, and some icons are rendered at the end of the line} + doNotImage={A list with several items. Each item has an icon and visible text describing the item. Some icons are rendered at the start of the line, and some icons are rendered at the end of the line} /> In the example below, we are creating two lists with supporting visuals. The first list uses icons, and the second list uses avatars. The visuals are decorative, so they all have `aria-hidden="true"`. Additionally, they are presented consistently in the `start` slot. @@ -65,7 +65,7 @@ The text content type includes form control labels or other visible text. This t doText="Move long text outside of the list" doNotText="Don't try to fit long text in an item" doImage={A list with an item that contains a checked checkbox indicating the user wants to receive emails. Text describing how often the user will receive emails as well as how to unsubscribe from emails is placed underneath the list.} - doNotImage={A list with an item that contains a checked checkbox indicating the user wants to receive emails. Text describing how often the user will receive emails as well as how to unsubscribe from emails is placed as a single paragraph inline with the checkbox, making the text hard to read and increasing the height of the item.} + doNotImage={A list with an item that contains a checked checkbox indicating the user wants to receive emails. Text describing how often the user will receive emails as well as how to unsubscribe from emails is placed as a single paragraph inline with the checkbox, making the text hard to read and increasing the height of the item.} /> In the example below, we are creating a list with different types of text. The "First Name" and "Last Name" labels serve to indicate what to type into the text inputs. @@ -87,7 +87,7 @@ Metadata provides additional context for an item such as status text or counts. doText="Add only the most important metadata" doNotText="Don't add too much metadata as it can overwhelm or confuse the user." doImage={A list that contains several items, each representing a different to-do list. A count of how many tasks in each to-do list is placed at the end of each item.} - doNotImage={A list that contains several items, each representing a different to-do list. Two counts are placed at the end of each item: One count that states the total number of tasks, and another count that states the total number of tasks that are due today.} + doNotImage={A list that contains several items, each representing a different to-do list. Two counts are placed at the end of each item: One count that states the total number of tasks, and another count that states the total number of tasks that are due today.} /> } - doNotImage={A list that contains several items, each representing a contact. Each item has text that states the contact's name as well as several actions including pinning the contact, sharing the contact, and deleting the contact. The actions are placed directly on the item. Since there are so many actions, some of the text is cut off.} + doNotImage={A list that contains several items, each representing a contact. Each item has text that states the contact's name as well as several actions including pinning the contact, sharing the contact, and deleting the contact. The actions are placed directly on the item. Since there are so many actions, some of the text is cut off.} /> In the example below, we are creating a list of contacts. Each item is a stubbed button intended to bring you to the full contact page for that item. There are additional actions associated with each item that users can reveal by swiping on the item. @@ -135,7 +135,7 @@ Controls are form components such as checkboxes, inputs, radios, and more. Each doText="Place inputs with metadata outside of the list." doNotText="Don't put metadata for inputs in the list." doImage={There is an email input and a password input. Both have helper text associated with them. Since both are placed outside of a list it is clear which input each helper text is associated with.} - doNotImage={There is a list containing an email input and a password input. Both have helper texts associated with them. However, the divider between each item and between the helper text makes it hard to tell which input each helper text is associated with.} + doNotImage={There is a list containing an email input and a password input. Both have helper texts associated with them. However, the divider between each item and between the helper text makes it hard to tell which input each helper text is associated with.} /> } - doNotImage={There is one list of inputs. One of the inputs is a password input with text below the input that says 'Password must be at least 16 characters'. However, this text is placed directly above another input, so it's not immediately clear which input the text is associated with.} + doNotImage={There is one list of inputs. One of the inputs is a password input with text below the input that says 'Password must be at least 16 characters'. However, this text is placed directly above another input, so it's not immediately clear which input the text is associated with.} /> } - doNotImage={There are two lists of inputs. The first list contains a password input. Below that list contains text that says 'Password must be at least 16 characters'. The second list contains an email input. This second list is separated so the password length requirement text is clearly associated with the password input above.} + doNotImage={There are two lists of inputs. The first list contains a password input. Below that list contains text that says 'Password must be at least 16 characters'. The second list contains an email input. This second list is separated so the password length requirement text is clearly associated with the password input above.} /> In the example below, we are creating a list of to-do tasks. Each item has a checkbox and an input. The checkbox lets the user mark a task as complete, and the input lets the user change the name of the task. diff --git a/static/img/item/actions-dont.jpg b/static/img/item/actions-do-not.jpg similarity index 100% rename from static/img/item/actions-dont.jpg rename to static/img/item/actions-do-not.jpg diff --git a/static/img/item/controls-count-dont.jpg b/static/img/item/controls-count-do-not.jpg similarity index 100% rename from static/img/item/controls-count-dont.jpg rename to static/img/item/controls-count-do-not.jpg diff --git a/static/img/item/controls-metadata-dont.jpg b/static/img/item/controls-metadata-do-not.jpg similarity index 100% rename from static/img/item/controls-metadata-dont.jpg rename to static/img/item/controls-metadata-do-not.jpg diff --git a/static/img/item/controls-metadata-list-dont.jpg b/static/img/item/controls-metadata-list-do-not.jpg similarity index 100% rename from static/img/item/controls-metadata-list-dont.jpg rename to static/img/item/controls-metadata-list-do-not.jpg diff --git a/static/img/item/long-text-dont.jpg b/static/img/item/long-text-do-not.jpg similarity index 100% rename from static/img/item/long-text-dont.jpg rename to static/img/item/long-text-do-not.jpg diff --git a/static/img/item/metadata-relevant-dont.jpg b/static/img/item/metadata-relevant-do-not.jpg similarity index 100% rename from static/img/item/metadata-relevant-dont.jpg rename to static/img/item/metadata-relevant-do-not.jpg diff --git a/static/img/item/visuals-dont.jpg b/static/img/item/visuals-do-not.jpg similarity index 100% rename from static/img/item/visuals-dont.jpg rename to static/img/item/visuals-do-not.jpg