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

Remove as summary in filtered search component docs #3353

Merged
merged 1 commit into from
Jun 20, 2023

Conversation

talum
Copy link
Contributor

@talum talum commented Jun 1, 2023

Using as="summary" here results in a React warning.

In the console, it prints out

react_devtools_backend_compact.js:2367 This component should be an instanceof a semantic button or anchor

Removing as="summary" resolves the warning, so I think we should update the docs!

Screenshots

n/a

Merge checklist

  • Added/updated tests
  • Added/updated documentation
  • Changes are SSR compatible
  • 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.

Using as="summary" here results in a React warning.
@talum talum requested a review from a team June 1, 2023 19:06
@talum talum self-assigned this Jun 1, 2023
@talum talum requested a review from broccolinisoup June 1, 2023 19:06
@changeset-bot
Copy link

changeset-bot bot commented Jun 1, 2023

⚠️ No Changeset found

Latest commit: 6256d0c

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

@github-actions
Copy link
Contributor

github-actions bot commented Jun 1, 2023

size-limit report 📦

Path Size
dist/browser.esm.js 101.65 KB (0%)
dist/browser.umd.js 102.21 KB (0%)

Copy link
Member

@broccolinisoup broccolinisoup left a comment

Choose a reason for hiding this comment

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

👋🏻 @talum!

Note: You must use a TextInput and ActionMenu (or native <details> and <summary>) in order for this component to work properly.

Reading the docs with your change in mind, it makes total sense! Thanks for pushing this PR. 🚀

@broccolinisoup
Copy link
Member

I also added skip changeset label because it is a docs change. Let me know if you have any concern! Checks are all looking good, feel free to merge when ready 🚀

@mperrotti
Copy link
Contributor

Just a heads-up: this component will be deprecated soon as a result of #3396

@joshblack joshblack added this pull request to the merge queue Jun 20, 2023
Merged via the queue into main with commit e6366b5 Jun 20, 2023
31 of 32 checks passed
@joshblack joshblack deleted the update-filtered-search-docs branch June 20, 2023 16:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip changeset This change does not need a changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants