department-of-veterans-affairs / vets-design-system-documentation

Repository for design.va.gov website
https://design.va.gov
58 stars 64 forks source link

Maintenance Banner web component: Announcement and documentation update #1510

Closed k80bowman closed 1 year ago

k80bowman commented 2 years ago

Description

Dependent on department-of-veterans-affairs/vets-design-system-documentation#1508

Announce the component at least in the #vfs-frontend channel. No need to include information on a migration script, we don't need one for this component (it's only used in one place, see note in department-of-veterans-affairs/vets-design-system-documentation#1509)

Add component to Storybook, update component documentation in design.va.gov, and add note about component release to the What's new? page.

Details

Sample announcement:

:wave: The Design System has just published a new version of component-library which includes , as well as made it available in vets-website. The migration script is also capable of automatically migrating your directories to this new component. Why does this matter to me The new additional info Web Component has a number of enhancements/fixes: Keyboard control with space and "Enter" key Design fix for the blue border when expanded Improved colors for contrast & consistency The web component is already loaded into the site, so removing your old AdditionalInfo imports will reduce application bundle size and improve performance. How do I migrate First, make sure your branch is using the latest master, and run yarn install. We have a script that you can use to assist with this process. You pass it two arguments: --directory - the directory you wish to migrate --component - the name of the React component to find and transform into a web component For example, to run this migration in the platform directory, you would run: yarn migrate-component --dir src/platform --component AdditionalInfo


NOTE: One change with is that it no longer exposes onClick for an external analytics event. There is still an internal component-library-analytics event that gets fired which includes the action (expand/collapse) and the trigger text. Just be aware of this so that you don't lose any tracking data that may be used in your dashboards. Reach out to us if you have any questions/concerns about this.

Acceptance Criteria

caw310 commented 1 year ago

No longer relevant.