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

Simplify the Input element type #2306

Draft
wants to merge 1 commit into
base: next
Choose a base branch
from
Draft

Conversation

connor-baer
Copy link
Member

@connor-baer connor-baer commented Nov 27, 2023

Purpose

Describe what you are trying to accomplish

HTMLInputElement and HTMLTextAreaElement

doesn't reflect the intended and real-world usage

hide complexity inside the design system and simplify the public API

Approach and changes

  • Deprecated the InputElement interface. Use the HTMLInputElement or HTMLTextAreaElement interfaces instead.
  • Narrowed the Input's element type to HTMLInputElement and the TextArea's element type to HTMLTextAreaElement. This affects refs and event handlers.

Definition of done

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

Copy link

changeset-bot bot commented Nov 27, 2023

⚠️ No Changeset found

Latest commit: 617dae5

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

vercel bot commented Nov 27, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
oss-circuit-ui ✅ Ready (Inspect) Visit Preview Nov 27, 2023 1:41pm

Copy link

codecov bot commented Nov 27, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (124df4a) 97.16% compared to head (617dae5) 97.16%.
Report is 3 commits behind head on next.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             next    #2306   +/-   ##
=======================================
  Coverage   97.16%   97.16%           
=======================================
  Files         251      251           
  Lines       19923    19930    +7     
  Branches     1226     1226           
=======================================
+ Hits        19358    19365    +7     
  Misses        551      551           
  Partials       14       14           
Files Coverage Δ
...cuit-ui/components/CurrencyInput/CurrencyInput.tsx 100.00% <100.00%> (ø)
...ages/circuit-ui/components/DateInput/DateInput.tsx 83.87% <100.00%> (ø)
packages/circuit-ui/components/Input/Input.tsx 96.71% <100.00%> (+0.11%) ⬆️
packages/circuit-ui/components/Input/index.ts 100.00% <100.00%> (ø)
.../circuit-ui/components/SearchInput/SearchInput.tsx 90.19% <100.00%> (ø)
...ckages/circuit-ui/components/TextArea/TextArea.tsx 100.00% <100.00%> (ø)
...es/circuit-ui/components/TextArea/useAutoExpand.ts 100.00% <100.00%> (ø)

@connor-baer connor-baer changed the base branch from main to next November 30, 2023 12:26

This comment was marked as outdated.

@connor-baer
Copy link
Member Author

This change has been postponed until the next major release.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant