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

Add a leading spinner to the TextField component #2895

Merged
merged 4 commits into from
Jun 11, 2024

Conversation

camertron
Copy link
Contributor

@camertron camertron commented Jun 10, 2024

Authors: Please fill out this form carefully and completely.

Reviewers: By approving this Pull Request you are approving the code change, as well as its deployment and mitigation plans.
Please read this description carefully. If you feel there is anything unclear or missing, please ask for updates.

What are you trying to accomplish?

This PR adds a leading spinner to Primer::Alpha::TextField. Currently, the component itself does not make use of the spinner, but the component's auto-check functionality could eventually use it. I decided not to implement such functionality at this time, since my work is currently focused on implementing our new SelectPanel component in dotcom. The spinner will come in handy over there to indicate a loading state when results are being fetched from the sever.

The spinner can be shown via the showLeadingSpinner() method in JavaScript, and hidden via hideLeadingSpinner().

Screenshots

Here's a video showing the text field with a magnifying glass as its leading visual, which is eventually replaced with a spinner, then replaced with the magnifying glass again.

text_field_spinner.mov

Integration

No changes necessary in production.

Risk Assessment

  • Low risk the change is small, highly observable, and easily rolled back.
  • Medium risk changes that are isolated, reduced in scope or could impact few users. The change will not impact library availability.
  • High risk changes are those that could impact customers and SLOs, low or no test coverage, low observability, or slow to rollback.

Accessibility

  • No new axe scan violation - This change does not introduce any new axe scan violations.

Merge checklist

  • Added/updated tests
  • Added/updated documentation
  • Added/updated previews (Lookbook)
  • Tested in Chrome
  • Tested in Firefox
  • Tested in Safari
  • Tested in Edge

Take a look at the What we look for in reviews section of the contributing guidelines for more information on how we review PRs.

Copy link

changeset-bot bot commented Jun 10, 2024

🦋 Changeset detected

Latest commit: 35c9ee4

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@primer/view-components Minor

Not sure what this means? Click here to learn what changesets are.

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

@camertron camertron marked this pull request as ready for review June 10, 2024 18:31
@camertron camertron requested a review from a team as a code owner June 10, 2024 18:31
@camertron camertron requested review from mperrotti and jonrohan and removed request for mperrotti June 10, 2024 18:31
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.

2 participants