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(Select): add warning when name is missing from component props #1756

Merged
merged 1 commit into from
Sep 15, 2023

Conversation

booc0mtaco
Copy link
Contributor

Summary:

There have been a few recent cases where Select presented problems for consumers. Namely, certain frameworks expect a form field to appear so that data can be submitted (no pun intended). This is an important behavior, and luckily HeadlessUI supports this in the underlying Listbox component.

Add some documentation to explain this, and a dev-time warning to double-down on the recommendation. In the future, name may be a required prop when using any/all form elements.

Test Plan:

  • Wrote updated automated tests
  • CI tests / new tests are not applicable
  • Manually tested my changes, but I want to keep the details secret
  • Manually tested my changes, and here are the details:
    • Create an alpha publish and try out in edu-stack or traject as a sanity check if changes affect build or deploy, or are breaking, such as token changes, widely used component updates, hooks changes, and major dependency upgrades.

@codecov
Copy link

codecov bot commented Sep 15, 2023

Codecov Report

Merging #1756 (51226de) into next (5ae15ac) will decrease coverage by 0.07%.
The diff coverage is 66.66%.

@@            Coverage Diff             @@
##             next    #1756      +/-   ##
==========================================
- Coverage   92.28%   92.22%   -0.07%     
==========================================
  Files         146      146              
  Lines        2580     2584       +4     
  Branches      665      664       -1     
==========================================
+ Hits         2381     2383       +2     
- Misses        183      200      +17     
+ Partials       16        1      -15     
Files Changed Coverage Δ
src/components/Select/Select.tsx 92.63% <66.66%> (-1.88%) ⬇️

... and 5 files with indirect coverage changes

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@booc0mtaco
Copy link
Contributor Author

Screenshot 2023-09-15 at 13 36 41

@github-actions
Copy link

size-limit report 📦

Path Size
components 95.44 KB (+0.17% 🔺)
styles 32.77 KB (0%)

@booc0mtaco booc0mtaco requested a review from a team September 15, 2023 18:38
Copy link
Contributor

@jeremiah-clothier jeremiah-clothier left a comment

Choose a reason for hiding this comment

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

LGTM!

@booc0mtaco booc0mtaco merged commit e3f2bc1 into next Sep 15, 2023
6 checks passed
@booc0mtaco booc0mtaco deleted the aholloway/EFI-1351 branch September 15, 2023 20:27
@booc0mtaco booc0mtaco mentioned this pull request Sep 22, 2023
booc0mtaco added a commit that referenced this pull request Sep 22, 2023
## [13.3.0](v13.2.0...v13.3.0) (2023-09-22)


### Features

* add event hooks to existing components ([#1757](#1757)) ([9045cf5](9045cf5))
* **Icons:** add 'edit' icon to spritemap ([#1760](#1760)) ([f56983a](f56983a))
* **Select:** add warning when name is missing from component props ([#1756](#1756)) ([e3f2bc1](e3f2bc1))


### Bug Fixes

* remove deprecated tokens from wireframe page ([#1752](#1752)) ([5e388fa](5e388fa))
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.

2 participants