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

Cleanup FilterGroups README #2195

Merged
merged 8 commits into from
Jan 5, 2024
Merged

Cleanup FilterGroups README #2195

merged 8 commits into from
Jan 5, 2024

Conversation

ncovercash
Copy link
Member

@ncovercash ncovercash commented Jan 4, 2024

This updates the FilterGroups README to list properties in tables, consistent with most other component documentation in FOLIO, and increasing readability. It also restricts the prop-types of label to a string, which is required due to its usage as an ARIA label. Finally, it also adds a few undocumented props (one of which is required!)

This updates the FilterGroups README to list properties in tables, consistent with most other component documentation in FOLIO, and increasing readability.

This comment has been minimized.

Copy link

github-actions bot commented Jan 4, 2024

Jest Unit Test Statistics

0 tests   0 ✔️  0s ⏱️
0 suites  0 💤
0 files    0

Results for commit e2c6892.

♻️ This comment has been updated with latest results.

This comment has been minimized.

Copy link

github-actions bot commented Jan 4, 2024

BigTest Unit Test Statistics

       1 files  ±0         1 suites  ±0   11s ⏱️ ±0s
1 416 tests ±0  1 395 ✔️ ±0  21 💤 ±0  0 ±0 
1 419 runs  ±0  1 398 ✔️ ±0  21 💤 ±0  0 ±0 

Results for commit e2c6892. ± Comparison against base commit c1faca7.

♻️ This comment has been updated with latest results.

Copy link
Member

@zburke zburke left a comment

Choose a reason for hiding this comment

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

Are you certain about converting from node to string? I know it's just prop-types so the "real" impact here is nothing, but we should still be certain.

lib/FilterControlGroup/FilterControlGroup.js Show resolved Hide resolved
@ncovercash ncovercash requested a review from zburke January 4, 2024 22:21
Copy link

sonarcloud bot commented Jan 5, 2024

Quality Gate Passed Quality Gate passed

Kudos, no new issues were introduced!

0 New issues
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

@ncovercash ncovercash merged commit 8d145e6 into master Jan 5, 2024
6 checks passed
@ncovercash ncovercash deleted the cleanup-filtergroups-readme branch January 5, 2024 16:55
github-actions bot pushed a commit that referenced this pull request Jan 5, 2024
* Cleanup FilterGroups README

This updates the FilterGroups README to list properties in tables, consistent with most other component documentation in FOLIO, and increasing readability.

* FilterControlGroup label must be a string, due to ARIA restrictions

* Update label prop in FilterGroups to be consistent with FilterControlGroup

* Add undocumented props

---------

Co-authored-by: John Coburn <jcoburn@ebsco.com>
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.

4 participants