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

[WNMGDS-2864] Add utility actions pattern guidance page #3198

Merged
merged 30 commits into from
Sep 10, 2024

Conversation

jack-ryan-nava-pbc
Copy link
Collaborator

@jack-ryan-nava-pbc jack-ryan-nava-pbc commented Aug 12, 2024

Summary

Ticket

Added new guidance page for the utility actions pattern.

Note
The design will differ on this branch because the EmailIcon is being imported from the local Doc Site component rather than the Design System. A ticket is up to fix this issue.

How to test

  1. Run the doc site locally, or check the deployed demo url.
  2. Confirm you can navigate to '.../patterns/utility-actions/' on the doc site
  3. Confirm the copy on the page matches the copy listed in Confluence under the heading "Draft Guidance"

Checklist

  • Prefixed the PR title with the Jira ticket number as [WNMGDS-####] Title or [NO-TICKET] if this is unticketed work.
  • Selected appropriate Type (only one) label for this PR, if it is a breaking change, label should only be Type: Breaking
  • Selected appropriate Impacts, multiple can be selected.
  • Selected appropriate release milestone

This is a change to documentation:

  • Checked for spelling and grammatical errors

Screenshots:

With EmailIcon collision:
Screenshot 2024-09-09 at 9 58 51 AM

Without EmailIcon collision:
Screenshot 2024-09-09 at 12 39 41 PM

@jack-ryan-nava-pbc jack-ryan-nava-pbc self-assigned this Aug 12, 2024
@jack-ryan-nava-pbc jack-ryan-nava-pbc added Impacts: Documentation Indicates that this item relates to documentation Type: Added Indicates a new feature. labels Aug 12, 2024
@jack-ryan-nava-pbc jack-ryan-nava-pbc marked this pull request as draft August 12, 2024 14:07
@jack-ryan-nava-pbc jack-ryan-nava-pbc changed the title WIP: [WNMGDS-2864] Add utility actions pattern guidnace page WIP: [WNMGDS-2864] Add utility actions pattern guidance page Aug 12, 2024
This reverts commit fd0f3bc.
tamara-corbalt and others added 7 commits August 14, 2024 15:03
* Add PrintIcon component.

* Removed fillColor attribute from PrintIcon componet and removed lint from incons.stories.tsx
)

Copy changes and add ability to handle control arguments
* Adds Email and RSS icons.

* Adds Link and What's New Icons

* Exchange (') for curly (’)
@jack-ryan-nava-pbc jack-ryan-nava-pbc changed the title WIP: [WNMGDS-2864] Add utility actions pattern guidance page [WNMGDS-2864] Add utility actions pattern guidance page Aug 16, 2024
@jack-ryan-nava-pbc jack-ryan-nava-pbc marked this pull request as ready for review August 16, 2024 13:15
@jack-ryan-nava-pbc jack-ryan-nava-pbc marked this pull request as ready for review August 19, 2024 21:03
jack-ryan-nava-pbc and others added 17 commits August 21, 2024 15:08
* Run prettier on json files

* Update lint-staged config to format json files
* Export vars and function needed in release script

* Reorder imports and add new reviewers

* Add new utility functions used by bumpVersions

* Handle staging files properly

* Export correct function from versions

* export readJson so maybe we capture new line with read file'
'

* big refactor add comments break up inline for loop and associated functions

* Wrap removal of top level package json in try catch and uncomment woopsie

* Add maybe more helpful comment

* Further refactoring

* Looks like a big refactor but basically moved all code to a new file

* Adding functionality so we don't lose newline at end of json files

* [NO-TICKET] Automatically format json files (#3206)

* Run prettier on json files

* Update lint-staged config to format json files

* Undo new line addition when writing json

* Fix typo

* Move version number into our main function to make usage clearer

---------

Co-authored-by: Patrick Wolfert <patrick.wolfert@adhocteam.us>
* Publish

 - @cmsgov/design-system@11.0.0-beta.0
 - @cmsgov/ds-cms-gov@11.0.0-beta.0
 - @cmsgov/ds-healthcare-gov@15.0.0-beta.0
 - @cmsgov/ds-medicare-gov@13.0.0-beta.0

* [NO-TICKET] Manually updates "@cmsgov/design-system" version in package dependencies (#3201)

manually updates dependency of "@cmsgov/design-system" version

* Reverts design-system-tokens version back to 0.0.1

---------

Co-authored-by: Kim Niedermaier <kimniedermaier+cmsds@navapbc.com>
Co-authored-by: Patrick Wolfert <patrick.wolfert@adhocteam.us>
* Basic migration script for v11 variable/class changes

* These two variables weren't removed!

We need to update our release notes, because that was a mistake

* Fix syntax error (stray single quote)

* Fix regex group not getting printed in the replacement text

* Mention the migration script in the blog post and explain how to use it
…gh `HelpDrawer` (#3210)

Fix `onAnalyticsEvent` prop bleeding into `dialog` DOM elements through `HelpDrawer`

Without this fix, the unit test I added will print errors to the console like this:

```
console.error
    Warning: Unknown event handler property `onAnalyticsEvent`. It will be ignored.
        at dialog
        at NativeDialog (/Users/patrickwolfert/Projects/design-system/packages/design-system/src/components/NativeDialog/NativeDialog.tsx:38:3)
        at Drawer (/Users/patrickwolfert/Projects/design-system/packages/design-system/src/components/Drawer/Drawer.tsx:73:5)
        at HelpDrawer (/Users/patrickwolfert/Projects/design-system/packages/design-system/src/components/HelpDrawer/HelpDrawer.tsx:13:11)
```
Be more informative about what `defaultMenuLinks` returns in the types

Previously the return type was `{}`, which is useless to teams trying to use that functions themselves
update v11 blog post to remove reference to removing the privacy settings dialog
* filter out the core design system

* Add comment and make conditional more readable

* make conditional more readable
* Initial set of default values added to props tables

* Updated storybook snaps
* Update all themes to make inline tool tips black

* Udpate playwright vrt snapshots

* Updating css snapshots

* Updated css themes and custom tooltip scss styling to maybe no avail

* setting tooltip color to match base color of surrounding text

* Restore weirdly changed snapshots curious if CI browser tests pass

* [WNMGDS-2875] Fix Release script take 2 (#3205)

* Export vars and function needed in release script

* Reorder imports and add new reviewers

* Add new utility functions used by bumpVersions

* Handle staging files properly

* Export correct function from versions

* export readJson so maybe we capture new line with read file'
'

* big refactor add comments break up inline for loop and associated functions

* Wrap removal of top level package json in try catch and uncomment woopsie

* Add maybe more helpful comment

* Further refactoring

* Looks like a big refactor but basically moved all code to a new file

* Adding functionality so we don't lose newline at end of json files

* [NO-TICKET] Automatically format json files (#3206)

* Run prettier on json files

* Update lint-staged config to format json files

* Undo new line addition when writing json

* Fix typo

* Move version number into our main function to make usage clearer

---------

Co-authored-by: Patrick Wolfert <patrick.wolfert@adhocteam.us>

* Undoing accidental hover styling change

---------

Co-authored-by: Patrick Wolfert <patrick.wolfert@adhocteam.us>
This reverts commit fd0f3bc.
### Usage

- Utility actions are ghost buttons for available actions that do not take priority over primary or secondary call-to-actions (CTAs).
- Placement should be in the page header and top, right aligned.
Copy link
Collaborator

@tamara-corbalt tamara-corbalt Sep 10, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a suggestion, but it might be clearer to write "top-right aligned" vs "top, right aligned."

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree, but since this is approved copy we'll keep it as is. Thanks!

@jack-ryan-nava-pbc jack-ryan-nava-pbc merged commit c4e3aa0 into main Sep 10, 2024
1 check passed
@jack-ryan-nava-pbc jack-ryan-nava-pbc deleted the jryan/wnmgds-2864-utility-actions-guidance branch September 10, 2024 13:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Impacts: Documentation Indicates that this item relates to documentation Type: Added Indicates a new feature.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants