-
Notifications
You must be signed in to change notification settings - Fork 91
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
NO-TICKET: Expose 'informational' as part of the AlertVariation type #3301
Conversation
When using Design System types, directly, in a project, the AlertVariation type is missing the string for the default Alert style, which is "informational," according to the docs. This update just adds that string to the union, but excludes it from the prop typing, since it's the default.
Jenkins, not a wolf |
@kim-cmsds @tamara-corbalt This seems like a perfectly fine thing to include. Probably we want to spin up another PR that replicates the changes here and includes the appropriate labels and milestones. What do you too think? Thanks for this suggestion @Josh68. If I understand this change correctly it seems that the benefit of this inclusion will be available to Typescript for hints? |
Correct, @jack-ryan-nava-pbc. Wherever possible (and hopefully always), we want to use types for design system components from your repo. In this case, for sending alert interaction events to analytics, we want to send the |
I think we're good to merge this in the New Year @kim-cmsds @tamara-corbalt Thanks @Josh68 |
Updated with a merge from |
@kim-cmsds @tamara-corbalt could either of you review and if it looks good to you we'll merge this |
Summary
When using Design System types, directly, in a project, the AlertVariation type is missing the string for the default Alert style, which is "informational," according to the docs. This update just adds that string to the union, but excludes it from the prop typing, since it's the default.
We are passing this detail via Adobe Analytics, so would like to have the "informational" typing exposed.
How to test
There is no impact to the use of the component. When built, a project that imports
AlertVariation
from Design System types should see "informational" as one of the options (in our case, for analytics purposes).Checklist
[WNMGDS-####] Title
or [NO-TICKET] if this is unticketed work.Type
(only one) label for this PR, if it is a breaking change, label should only beType: Breaking
Impacts
, multiple can be selected.If this is a change to design:
If this is a change to code:
yarn test:unit:update
) and browser-test snapshots (yarn test:browser:update
)If this is a change to documentation: