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.

Sign up for GitHub

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

Jump to bottom

feat!: release chip, searchfield, pagination, form.autosuggest #2964

Merged
merged 9 commits into from
Jan 19, 2024
Merged

feat!: release chip, searchfield, pagination, form.autosuggest #2964

merged 9 commits into from
Jan 19, 2024

Conversation

adamstankiewicz
Copy link
Member

@adamstankiewicz adamstankiewicz commented Dec 22, 2023 •
edited
Loading

Description

These changes include already-reviewed breaking changes for Chip, SearchField, Pagination, and Form.Autosuggest. Must be merged as a breaking change.

  • Include release notes / documentation in the GitHub release.
  • Communicate out release notes to FWG and PWG Slack channels.

Deploy Preview

Include a direct link to your changes in this PR's deploy preview here (e.g., a specific component page).

Merge Checklist

  • If your update includes visual changes, have they been reviewed by a designer? Send them a link to the Netlify deploy preview, if applicable.
  • Does your change adhere to the documented style conventions?
  • Do any prop types have missing descriptions in the Props API tables in the documentation site (check deploy preview)?
  • Were your changes tested using all available themes (see theme switcher in the header of the deploy preview, under the "Settings" icon)?
  • Were your changes tested in the example app?
  • Is there adequate test coverage for your changes?
  • Consider whether this change needs to reviewed/QA'ed for accessibility (a11y). If so, please add wittjeff and adamstankiewicz as reviewers on this PR.

Post-merge Checklist

  • Verify your changes were released to NPM at the expected version.
  • If you'd like, share your contribution in #show-and-tell.
  • 🎉 🙌 Celebrate! Thanks for your contribution.

@netlify Netlify
Copy link

netlify bot commented Dec 22, 2023 •
edited
Loading

✅ Deploy Preview for paragon-openedx ready!

Name Link
🔨 Latest commit 8416547
🔍 Latest deploy log https://app.netlify.com/sites/paragon-openedx/deploys/65a99f68c620ac000875c7b4
😎 Deploy Preview https://deploy-preview-2964--paragon-openedx.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@adamstankiewicz adamstankiewicz changed the title Release/chip searchfield pagination feat!: release chip, searchfield, pagination Dec 22, 2023
@viktorrusakov viktorrusakov force-pushed the release/chip-searchfield-pagination branch from d132fcf to 8c09b4f Compare December 28, 2023 08:24
@codecov Codecov
Copy link

codecov bot commented Dec 28, 2023 •
edited
Loading

Codecov Report

Attention: 3 lines in your changes are missing coverage. Please review.

Comparison is base (b858230) 93.00% compared to head (8416547) 93.18%.
Report is 1 commits behind head on master.

Files Patch % Lines
src/Pagination/PaginationContext.jsx 97.05% 2 Missing ⚠️
src/Form/FormAutosuggest.jsx 99.28% 1 Missing ⚠️
Additional details and impacted files 
@@            Coverage Diff             @@
##           master    #2964      +/-   ##
==========================================
+ Coverage   93.00%   93.18%   +0.18%     
==========================================
  Files         236      249      +13     
  Lines        4273     4342      +69     
  Branches     1033     1036       +3     
==========================================
+ Hits         3974     4046      +72     
+ Misses        295      292       -3     
  Partials        4        4

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@viktorrusakov viktorrusakov marked this pull request as draft December 28, 2023 09:41
@adamstankiewicz adamstankiewicz force-pushed the release/chip-searchfield-pagination branch from 8c09b4f to e187749 Compare January 18, 2024 17:57
@adamstankiewicz adamstankiewicz changed the title feat!: release chip, searchfield, pagination feat!: release chip, searchfield, pagination, form.autosuggest Jan 18, 2024
@brian-smith-tcril @PKulkoRaccoonGang
@khudym @viktorrusakov
feat!: update Autosuggest component to better support freeform and se…
35485ef 
…lected values (#2899)

This updates the Autosuggest component to provide the consumer with:
* The value entered in the textbox by the user
* The selected value (as it is displayed in the dropdown)
* The id of the selected option

This also allows the consumer to determine if the Autosuggest component should be in an error state when
* No text has been entered
* Text has been entered, but not selection has been made
* An external validation check has failed - "customError"

The consumer will provide error messages for the appropriate error states

BREAKING CHANGE: value of Autosuggest component is now an object instead of a string
BREAKING CHANGE: Autosuggest component now uses onChange instead of onSelected
BREAKING CHANGE: Autosuggest component now takes in different error messages for value/selection required, and custom errors

---------

Co-authored-by: Peter Kulko <93188219+PKulkoRaccoonGang@users.noreply.github.com>
Co-authored-by: Kyr <40792129+khudym@users.noreply.github.com>
Co-authored-by: Viktor Rusakov <vrusakov66@gmail.com>
@adamstankiewicz adamstankiewicz marked this pull request as ready for review January 18, 2024 21:14
brian-smith-tcril
brian-smith-tcril approved these changes Jan 18, 2024
View reviewed changes
Copy link
Contributor

@brian-smith-tcril brian-smith-tcril left a comment

Choose a reason for hiding this comment

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

Overall LGTM!

One small non-blocking nit: hovering over the search field icon looks a little odd

without the "Search:" text it seems mostly fine, it just feels a little strange that it touches the edges of the textbox
image

With the "Search:" text it seems a little squished
image

side by side
image
image

I'd be more than happy to make a small issue for that and we can address it after the breaking change ships.

@adamstankiewicz
Copy link
Member Author

The above PR feedback has been addressed and release notes have been drafted to add into the corresponding GitHub release once this PR lands on master.

Merging this PR should publish a new v22 release to NPM (as well as creating a new v23 alpha release). We will need to ensure any other shared JS repos that rely on Paragon as a peer dependency can support v22 (e.g., @edx/frontend-platform).

@adamstankiewicz adamstankiewicz merged commit 0274f10 into master Jan 19, 2024
10 checks passed
@adamstankiewicz adamstankiewicz deleted the release/chip-searchfield-pagination branch January 19, 2024 14:17
adamstankiewicz added a commit that referenced this pull request Jan 19, 2024
@adamstankiewicz
Revert "feat!: release chip, searchfield, pagination, form.autosuggest (
08d18d6 
#2964)"

This reverts commit 0274f10.
@adamstankiewicz adamstankiewicz restored the release/chip-searchfield-pagination branch January 19, 2024 14:56
@adamstankiewicz adamstankiewicz mentioned this pull request Jan 19, 2024
Merged
10 tasks
adamstankiewicz added a commit that referenced this pull request Jan 19, 2024
@adamstankiewicz
Revert "feat!: release chip, searchfield, pagination, form.autosuggest (
4ba0b6d 
#2964)" (#2994)

This reverts commit 0274f10.
@openedx-semantic-release-bot
Copy link

🎉 This PR is included in version 22.0.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@kdmccormick kdmccormick deleted the release/chip-searchfield-pagination branch May 8, 2024 19:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@PKulkoRaccoonGang PKulkoRaccoonGang PKulkoRaccoonGang approved these changes

@brian-smith-tcril brian-smith-tcril brian-smith-tcril approved these changes

Assignees
No one assigned
Labels
released
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@adamstankiewicz @openedx-semantic-release-bot @PKulkoRaccoonGang @brian-smith-tcril @khudym @viktorrusakov