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

Improve getLabel functions #1311

Merged
merged 2 commits into from
Apr 26, 2022
Merged

Improve getLabel functions #1311

merged 2 commits into from
Apr 26, 2022

Conversation

seancolsen
Copy link
Contributor

This PR cleans up getLabel props for a few components, with the following goals.

  • Don't use a labelKey argument within the getLabel prop.

    Rationale: The consuming component has two ways of customizing the label. Either (a) via the labelKey prop, or (b) via the getLabel prop. When using (b), then (a) should be irrelevant. The getLabel function signature is simpler when it does not concern itself with labelKey.

  • Allow getLabel to return an instance of ComponentAndProps.

  • Make all getLabel props consistently use the type LabelGetter<Option> across all relevant components.

Checklist

  • My pull request has a descriptive title (not a vague title like Update index.md).
  • My pull request targets the master branch of the repository
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no visible errors.

Developer Certificate of Origin

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@seancolsen seancolsen requested review from a team and pavish and removed request for a team April 26, 2022 11:39
@seancolsen seancolsen added the pr-status: review A PR awaiting review label Apr 26, 2022
Copy link
Member

@pavish pavish left a comment

Choose a reason for hiding this comment

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

Looks good!

@pavish pavish enabled auto-merge April 26, 2022 15:07
@seancolsen seancolsen disabled auto-merge April 26, 2022 15:08
@seancolsen
Copy link
Contributor Author

Thanks for the review @pavish. Kriti and I are currently trying to figure out how to get this merged without the readthedocs check passing.

@seancolsen seancolsen merged commit e2fedad into master Apr 26, 2022
@seancolsen seancolsen deleted the refactor_getLabel branch April 26, 2022 15:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pr-status: review A PR awaiting review
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

2 participants