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

feat(components): migrate Notification components to TypeScript #637

Merged
merged 7 commits into from
Jul 16, 2020

Conversation

connor-baer
Copy link
Member

Addresses #516.

Purpose

The current Notification component composition is quite brittle because it depends on the proper positioning of each component to work. It also makes it impossible to change the layout and composition of the notifications in the future. This is solved by replacing the subcomponents (NotificationIcon and NotificationButton) with props on the main Notification component.

Approach and changes

  • migrate Notification, NotificationBanner, and NotificationList components to TypeScript

BREAKING CHANGE:
The NotificationIcon and NotificationButton components have been removed. Use the Notification component's icon and children props instead.

Definition of done

  • Development completed
  • Reviewers assigned
  • Unit and integration tests
  • Meets minimum browser support
  • Meets accessibility requirements

BREAKING CHANGE:
The **InlineMessage** component's `type` prop has been renamed to `variant` (🤖
_inline-message-variant-enum_)

feature/typescript-messages
BREAKING CHANGE:
The NotificationIcon and NotificationButton components have been removed. Use the Notification
component's icon and children props instead.

feature/typescript-messages
@connor-baer connor-baer added the feature A new feature or enhancement label Jul 13, 2020
@connor-baer connor-baer added this to the v2.0 milestone Jul 13, 2020
@vercel
Copy link

vercel bot commented Jul 13, 2020

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/sumup-oss/circuit-ui/k27ltdozp
✅ Preview: https://circuit-ui-git-feature-typescript-messages.sumup-oss.vercel.app

@codecov
Copy link

codecov bot commented Jul 13, 2020

Codecov Report

Merging #637 into beta will decrease coverage by 0.02%.
The diff coverage is 97.95%.

Impacted file tree graph

@@            Coverage Diff             @@
##             beta     #637      +/-   ##
==========================================
- Coverage   93.71%   93.69%   -0.03%     
==========================================
  Files         133      131       -2     
  Lines        2213     2219       +6     
  Branches      612      617       +5     
==========================================
+ Hits         2074     2079       +5     
- Misses        117      118       +1     
  Partials       22       22              
Impacted Files Coverage Δ
src/components/Notification/Notification.tsx 95.45% <95.45%> (ø)
src/components/CloseButton/CloseButton.tsx 100.00% <100.00%> (ø)
src/components/InlineMessage/InlineMessage.tsx 94.44% <100.00%> (ø)
...mponents/NotificationBanner/NotificationBanner.tsx 100.00% <100.00%> (ø)
...c/components/NotificationList/NotificationList.tsx 100.00% <100.00%> (ø)

@connor-baer connor-baer merged commit b5fc361 into beta Jul 16, 2020
@connor-baer connor-baer deleted the feature/typescript-messages branch July 16, 2020 14:40
@github-actions
Copy link
Contributor

🎉 This PR is included in version 2.0.0-beta.17 🎉

The release is available on:

Your semantic-release bot 📦🚀

@github-actions
Copy link
Contributor

🎉 This PR is included in version 2.0.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature A new feature or enhancement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants