Skip to content

Commit

Permalink
Update usage.mdx
Browse files Browse the repository at this point in the history
Addressing comments from the pull request.
  • Loading branch information
scanlana authored Nov 7, 2024
1 parent f36fdd9 commit d56fe73
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions src/pages/components/modal/usage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -226,15 +226,17 @@ In IBM Style, the modal is referred to as a dialog.
- For example, if the user clicks the **Create access group** button to open the modal, _Create access group_ is the modal title. Modals might also be accessed by clicking a menu item or an icon.
- Be aware of situations where there’s a tendency to mix and match button or icon labels and modal titles. For example, if the icon name is **New user**, use _New user_ as the modal title, not _Create user_.
- If your product has a more conversational tone, use articles (a, an, the) in the modal title even though the button label doesn't include the article, for example _Create an access group_.
- Sometimes, you might need to provide contextual information for the modal, such as when the actions performed using the modal apply to a specific entity and you want to make it clear which entity the actions apply to. In this case, you can use the optional label that is displayed above the title. For example, if the user needs to know the path to the object that they are editing, you might put the path in the optional label. [
- Sometimes, you might need to provide contextual information for the modal, such as when the actions performed using the modal apply to a specific item and you want to make it clear which item the actions apply to.
- In this case, you can use the optional label that is displayed above the title.
- For example, if the user needs to know the path to the object that they are editing, you might put the path in the optional label.

### Modal description

- If the purpose or goal of the modal is not readily apparent, provide a sentence or two of embedded assistance to help the user understand the modal or to provide examples to explain how to use the modal. If the title and the purpose are clear, such as editing an object, do not provide a description.
If the purpose or goal of the modal is not readily apparent, provide a sentence or two of embedded assistance to help the user understand the modal or to provide examples to explain how to use the modal. If the title and the purpose are clear, such as _Edit object_ for the title when the purpose of the modal is to edit an object, a description is not needed.

### Body content

- Include only fields and embedded assistance that are relevant to completing the current task.
- Include only fields, components, and embedded assistance that are relevant to completing the current task.
- Ensure that the text is 80% of the modal’s width. The components can span 100% of the width.
- To add a link to IBM Documentation, include it as a link in the body of the modal.
- Use a clear label, such as _Learn more about topic_ or _IBM Docs_.
Expand Down

0 comments on commit d56fe73

Please sign in to comment.