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

Block Editor: Add README for RecursionProvider #52334

Merged
merged 2 commits into from
Jul 5, 2023

Conversation

tyxla
Copy link
Member

@tyxla tyxla commented Jul 5, 2023

What?

This PR adds a README for the RecursionProvider component and useHasRecursion hook.

Fixes #52065.

Why?

Part of #22891 where we aim to document all block editor components.

How?

Just adding a README.

Noting that this intentionally lacks a screenshot because the component's function isn't presentational.

Testing Instructions

Not needed.

Testing Instructions for Keyboard

None.

Screenshots or screencast

None.

@tyxla tyxla added [Type] Developer Documentation Documentation for developers [Package] Block editor /packages/block-editor labels Jul 5, 2023
@tyxla tyxla requested a review from mburridge July 5, 2023 14:24
@tyxla tyxla self-assigned this Jul 5, 2023
@tyxla tyxla requested a review from ellatrix as a code owner July 5, 2023 14:24
Copy link
Contributor

@mburridge mburridge left a comment

Choose a reason for hiding this comment

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

Thanks once again @tyxla . You're knocking out of the park with these readme's!


# `useHasRecursion()`

Used in conjunction with `RecursionProvider`, this hook us used to identify if a block has already been rendered.
Copy link
Contributor

Choose a reason for hiding this comment

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

Minor typo:

this hook us is used to identify

Copy link
Member Author

Choose a reason for hiding this comment

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

Good catch, thanks 🙌 Fixed in 6ff3fa5

@tyxla tyxla enabled auto-merge (squash) July 5, 2023 14:37
@tyxla tyxla merged commit b3d8ff3 into trunk Jul 5, 2023
50 checks passed
@tyxla tyxla deleted the add/recursion-provider-readme branch July 5, 2023 15:04
@github-actions github-actions bot added this to the Gutenberg 16.2 milestone Jul 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Package] Block editor /packages/block-editor [Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add README.md file for recursion-provider component
2 participants