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): Deprecate components #470

Merged
merged 4 commits into from
Sep 18, 2019

Conversation

connor-baer
Copy link
Member

@connor-baer connor-baer commented Sep 14, 2019

Resolves #351 and addresses #469.

Purpose

In preparation for v2 of Circuit UI, we're deprecating a few components to give users a head's up of the upcoming changes.

Approach and changes

  • Remove the HtmlElement component (was only used internally)
  • Deprecate the element prop on the Heading, SubHeading, Text, List and Input components
  • Deprecate the CreditCardDetails, CardNumberInput, NameOnCardInput, SecurityCodeInput, and ExpiryDateInput components in favor of the SumUp card widget
  • Deprecate the Markdown component
  • Deprecate the MaskedInput component
  • Deprecate the Picture component
  • Deprecate the SideNav component
  • Rename ListView to CardList
  • Rename GlobalStyles to BaseStyles and deprecate support for custom styles to discourage wrong usage
  • Update documentation

Definition of done

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

@codecov
Copy link

codecov bot commented Sep 14, 2019

Codecov Report

Merging #470 into canary will decrease coverage by 0.02%.
The diff coverage is 86.95%.

Impacted file tree graph

@@            Coverage Diff             @@
##           canary     #470      +/-   ##
==========================================
- Coverage   76.12%   76.09%   -0.03%     
==========================================
  Files         171      167       -4     
  Lines        2450     2443       -7     
  Branches      430      433       +3     
==========================================
- Hits         1865     1859       -6     
  Misses        466      466              
+ Partials      119      118       -1
Impacted Files Coverage Δ
src/components/Button/Button.js 100% <ø> (ø) ⬆️
src/components/Popover/Popover.js 95.74% <ø> (ø) ⬆️
src/components/Button/constants.js 100% <ø> (ø) ⬆️
src/components/SideNav/SideNav.js 0% <0%> (ø) ⬆️
src/components/RestrictedInput/RestrictedInput.js 75% <0%> (-25%) ⬇️
src/components/MaskedInput/MaskedInput.js 60% <0%> (-40%) ⬇️
...ails/components/ExpiryDateInput/ExpiryDateInput.js 100% <100%> (ø) ⬆️
src/components/Markdown/Markdown.js 100% <100%> (ø) ⬆️
src/components/BaseStyles/BaseStyles.js 100% <100%> (ø)
src/components/CardList/components/Item/Item.js 100% <100%> (ø)
... and 14 more

@connor-baer connor-baer force-pushed the feature/deprecate-components branch 2 times, most recently from c815643 to 0ff1d61 Compare September 17, 2019 15:04
@connor-baer connor-baer added this to the v1.x milestone Sep 17, 2019
@connor-baer connor-baer marked this pull request as ready for review September 17, 2019 16:34
Copy link
Contributor

@mlent mlent left a comment

Choose a reason for hiding this comment

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

Looks good, thanks a ton for tackling this! One step closer to a clean set of components 💅

Copy link
Contributor

@fernandofleury fernandofleury left a comment

Choose a reason for hiding this comment

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

Can you please have look into this file just to be sure?

src/components/CardList/index.js Show resolved Hide resolved
@connor-baer connor-baer removed the request for review from glemmal September 18, 2019 13:45
@connor-baer connor-baer merged commit e14c6cc into canary Sep 18, 2019
@connor-baer connor-baer deleted the feature/deprecate-components branch September 18, 2019 13:45
@ilyanoskov
Copy link
Contributor

🎉 This PR is included in version 1.1.1-canary.15 🎉

The release is available on:

Your semantic-release bot 📦🚀

@ilyanoskov
Copy link
Contributor

🎉 This PR is included in version 1.2.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
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Remove use of HtmlElement
5 participants