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

Improves input type definitions #3025

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Improves input type definitions #3025

wants to merge 3 commits into from

Conversation

gburnett
Copy link
Contributor

@gburnett gburnett commented Apr 6, 2022 •
edited
Loading

Fixes #

Improves ref and event handler types for Input and InnerInput.

Additional description

CONTRIBUTOR checklist (do not remove)

Please complete for every pull request

  • First-time contributors should sign the Contributor License Agreement. It's a fancy way of saying that you are giving away your contribution to this project. If you haven't before, wait a few minutes and a bot will comment on this pull request with instructions.
  • npm run lint:fix has been run and linting passes.
  • Mocha, Jest (Storyshots), and components/component-docs.json CI tests pass (npm test).
  • Tests have been added for new props to prevent regressions in the future. See readme.
  • Review the appropriate Storybook stories. Open http://localhost:9001/.
  • Review tests are passing in the browser. Open http://localhost:8001/.
  • Review markup conforms to SLDS by looking at DOM snapshot strings.

REVIEWER checklist (do not remove)

  • CircleCI tests pass. This includes linting, Mocha, Jest, Storyshots, and components/component-docs.json tests.
  • Tests have been added for new props to prevent regressions in the future. See readme.
  • Review the appropriate Storybook stories. Open http://localhost:9001/.
  • The Accessibility panel of each Storybook story has 0 violations (aXe). Open http://localhost:9001/.
  • Review tests are passing in the browser. Open http://localhost:8001/.
  • Review markup conforms to SLDS by looking at DOM snapshot strings.
Required only if there are markup / UX changes
  • Add year-first date and commit SHA to last-slds-markup-review in package.json and push.
  • Request a review of the deployed Heroku app by the Salesforce UX Accessibility Team.
  • Add year-first review date, and commit SHA, last-accessibility-review, to package.json and push.
  • While the contributor's branch is checked out, run npm run local-update within locally cloned site repo to confirm the site will function correctly at the next release.

gburnett
gburnett commented Apr 6, 2022
View reviewed changes
components/input.d.ts
Comment on lines +137 to +139
| React.ChangeEvent<HTMLInputElement>
| React.KeyboardEvent<HTMLButtonElement>
| React.MouseEvent<HTMLButtonElement>,
Copy link
Contributor Author

Choose a reason for hiding this comment

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

ChangeEvent is typical. I think that KeyboardEvent and MouseEvent will be encountered when performStep is invoked.

@gburnett gburnett changed the title Gburnett/input type definitions Improves input type definitions Apr 6, 2022
@gburnett
Copy link
Contributor Author

gburnett commented Apr 7, 2022

Checks are failing to install dependencies. I think that this is unrelated to my changes.

@interactivellama
Copy link
Contributor

Looks better! Will try to get tests running.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@interactivellama interactivellama interactivellama approved these changes

Assignees
No one assigned
Labels
cla:signed
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@gburnett @interactivellama