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

Components: Update Autocomplete usage example #49965

Merged
merged 2 commits into from
May 1, 2023

Conversation

chad1008
Copy link
Contributor

Fixes #16624, #33852

What?

Updates the Autocomplete component README file with more a more useful description and example.

Why?

The current example gives a basic picture of the components functionality, but doesn't work on its own, in large part because Autocomplete is tightly coupled with other packages/components like the block editor and RichText

How?

The updated README clarifies that Autocomplete isn't intended as a standalone component and provides an example of how to integrate new completers in the WordPress Block Editor.

Testing Instructions

Using the examples provided, try creating a small plugin, and confirm that it functions as expected without any errors.

@chad1008 chad1008 requested review from mirka and ciampo April 20, 2023 19:48
@chad1008 chad1008 self-assigned this Apr 20, 2023
@chad1008 chad1008 added the [Package] Components /packages/components label Apr 20, 2023
@github-actions
Copy link

Flaky tests detected in 9ca7134.
Some tests passed with failed attempts. The failures may not be related to this commit but are still reported for visibility. See the documentation for more information.

🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/4758305626
📝 Reported issues:

@chad1008 chad1008 marked this pull request as ready for review April 24, 2023 11:34
@chad1008 chad1008 requested a review from ajitbohra as a code owner April 24, 2023 11:34
Copy link
Member

@mirka mirka left a comment

Choose a reason for hiding this comment

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

Makes sense and works as expected 👍

The autocompleter working in the block editor

@chad1008 chad1008 merged commit 9bd374b into trunk May 1, 2023
@chad1008 chad1008 deleted the remove-autocomplete-example branch May 1, 2023 12:31
@github-actions github-actions bot added this to the Gutenberg 15.8 milestone May 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Package] Components /packages/components
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Autocomplete example in README.md gives error
2 participants