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

Fix Popper documentation consistency #2197

Merged
merged 6 commits into from
Jan 5, 2024
Merged

Fix Popper documentation consistency #2197

merged 6 commits into from
Jan 5, 2024

Conversation

ncovercash
Copy link
Member

@ncovercash ncovercash commented Jan 4, 2024

There are several props available to the Popper component which were not documented in the README.

Additionally, the placements auto-start and auto-end were missing from the AVAILABLE_PLACEMENTS array, despite being valid (looks like I missed these in #2004, whoops).

@ncovercash ncovercash changed the title Add missing props to Popper README Fix Popper documentation consistency Jan 4, 2024
Copy link

github-actions bot commented Jan 4, 2024

Jest Unit Test Statistics

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

Results for commit 52e8432. ± Comparison against base commit cafbd45.

♻️ This comment has been updated with latest results.

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 52e8432. ± Comparison against base commit cafbd45.

♻️ 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.

Consider creating a Jira for this PR so we have way to document which release contains the auto-start and auto-end props.

@JohnC-80
Copy link
Contributor

JohnC-80 commented Jan 4, 2024

Things might get interesting for this component when we look at migrating to floating-ui and its possibilities for placement... Will potentially mean even more docs changes, so if we want to hold on this, will be okay...

@ncovercash
Copy link
Member Author

@JohnC-80 IMO we should go ahead and merge this — the "new" placements are already accepted per the readme and supported by the code, just forgotten in the prop-types, so we're not adding something new

Copy link

sonarqubecloud 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 2237df6 into master Jan 5, 2024
5 checks passed
github-actions bot pushed a commit that referenced this pull request Jan 5, 2024
@ncovercash ncovercash deleted the popper-readme-fix branch January 5, 2024 16:20
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