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.

Sign up for GitHub

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

Jump to bottom

ServerSideRender: Update documentation for placeholder props #33030

Merged
merged 1 commit into from
Jun 29, 2021
Merged

ServerSideRender: Update documentation for placeholder props #33030

merged 1 commit into from
Jun 29, 2021

Conversation

Mamaduka
Copy link
Member

Description

Updates documentation for EmptyResponsePlaceholder, ErrorResponsePlaceholder and LoadingResponsePlaceholder. Also adds basic usage example.

Similar to #29925

It's best to pass a component to renderAppender, as is done in most core blocks. Passing a callback function will cause React to treat this as a new function component on every render causing reconciliation issues.

Types of changes

Documentation

@Mamaduka Mamaduka self-assigned this Jun 28, 2021
@Mamaduka Mamaduka added [Package] Server Side Render /packages/server-side-render [Type] Developer Documentation Documentation for developers labels Jun 28, 2021
@Mamaduka Mamaduka requested a review from gziolo June 28, 2021 11:13
@Mamaduka Mamaduka mentioned this pull request Jun 28, 2021
Closed
@Mamaduka Mamaduka requested a review from talldan June 29, 2021 04:03
jorgefilipecosta
jorgefilipecosta approved these changes Jun 29, 2021
View reviewed changes
Copy link
Member

@jorgefilipecosta jorgefilipecosta left a comment

Choose a reason for hiding this comment

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

LGTM 👍 Thank you for fixing this documentation issue!

packages/server-side-render/README.md
@@ -67,25 +67,35 @@ E.g: `{ post_id: 12 }`.

### EmptyResponsePlaceholder

This is a [render prop](https://reactjs.org/docs/render-props.html). When the api response is empty, the value of this prop is rendered. The render prop will receive the value of the api response as well as all props passed into `ServerSideRenderer`.
The component is rendered when the API response is empty. The component will receive the value of the API response, and all props passed into `ServerSideRenderer`.
Copy link
Member

Choose a reason for hiding this comment

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

I confirmed that the props are in fact components and not render props. It is unfortunate that our documentation was wrong all this time.

@Mamaduka
Copy link
Member Author

Thanks for the review, @jorgefilipecosta.

@Mamaduka Mamaduka merged commit 07406cd into trunk Jun 29, 2021
@Mamaduka Mamaduka deleted the update/server-side-renderer-docs branch June 29, 2021 18:50
@github-actions github-actions bot added this to the Gutenberg 11.0 milestone Jun 29, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jorgefilipecosta jorgefilipecosta jorgefilipecosta approved these changes

@gziolo gziolo Awaiting requested review from gziolo

@talldan talldan Awaiting requested review from talldan

Assignees

@Mamaduka Mamaduka

Labels
[Package] Server Side Render /packages/server-side-render [Type] Developer Documentation Documentation for developers
Projects
None yet
Milestone
Gutenberg 11.0
Development

Successfully merging this pull request may close these issues.
2 participants
@Mamaduka @jorgefilipecosta