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

added README for the "caption" component #52033

Merged
merged 3 commits into from
Jul 10, 2023

Conversation

juanmaguitar
Copy link
Contributor

What?

As part of #22891 this PR adds a README.md for this component with some guidance to use.

Why?

Because each component need to have a reference for WordPress developers

How?

By creating a README w/ at least some basic guidance about how to use it

@juanmaguitar
Copy link
Contributor Author

@derekblank as you seem to be the main developer that has been involved in the work of this component I would appreciate your review and any additions in the README you may consider useful for developers using this component

Copy link
Member

@derekblank derekblank left a comment

Choose a reason for hiding this comment

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

LGTM.

Comment on lines 3 to 53
The `Caption` component renders the [caption part](https://wordpress.org/documentation/article/gallery-block/#caption) of some blocks (image, gallery...)

This component encapsulates the "caption" behaviour and styles over a `<RichText>` so it can be used in other components such as the `BlockCaption` component


## Table of contents

1. [Development guidelines](#development-guidelines)
2. [Related components](#related-components)

## Development guidelines

### Usage

Renders a Caption area

```jsx

import { Caption } from '@wordpress/block-editor';

const BlockCaption = ( {
onBlur,
onChange,
onFocus,
isSelected,
shouldDisplay,
text,
insertBlocksAfter,
} ) => (
<View >
<Caption
isSelected={ isSelected }
onBlur={ onBlur }
onChange={ onChange }
onFocus={ onFocus }
shouldDisplay={ shouldDisplay }
value={ text }
insertBlocksAfter={ insertBlocksAfter }
/>
</View>
);

```

### Props

The properties `isSelected`, `onBlur`, `onChange`, `onFocus`, `shouldDisplay`, `value`, `insertBlocksAfter` of this component are passed directly to their related props of its inner `<RichText>` component ([see detailed info about component's props](https://github.com/WordPress/gutenberg/blob/HEAD/packages/block-editor/src/components/rich-text/README.md))

## Related components

Caption components is mostly used by the [`BlockCaption`](https://github.com/WordPress/gutenberg/blob/HEAD/packages/block-editor/src/components/block-caption) component
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
The `Caption` component renders the [caption part](https://wordpress.org/documentation/article/gallery-block/#caption) of some blocks (image, gallery...)
This component encapsulates the "caption" behaviour and styles over a `<RichText>` so it can be used in other components such as the `BlockCaption` component
## Table of contents
1. [Development guidelines](#development-guidelines)
2. [Related components](#related-components)
## Development guidelines
### Usage
Renders a Caption area
```jsx
import { Caption } from '@wordpress/block-editor';
const BlockCaption = ( {
onBlur,
onChange,
onFocus,
isSelected,
shouldDisplay,
text,
insertBlocksAfter,
} ) => (
<View >
<Caption
isSelected={ isSelected }
onBlur={ onBlur }
onChange={ onChange }
onFocus={ onFocus }
shouldDisplay={ shouldDisplay }
value={ text }
insertBlocksAfter={ insertBlocksAfter }
/>
</View>
);
```
### Props
The properties `isSelected`, `onBlur`, `onChange`, `onFocus`, `shouldDisplay`, `value`, `insertBlocksAfter` of this component are passed directly to their related props of its inner `<RichText>` component ([see detailed info about component's props](https://github.com/WordPress/gutenberg/blob/HEAD/packages/block-editor/src/components/rich-text/README.md))
## Related components
Caption components is mostly used by the [`BlockCaption`](https://github.com/WordPress/gutenberg/blob/HEAD/packages/block-editor/src/components/block-caption) component
The `Caption` component renders the [caption part](https://wordpress.org/documentation/article/gallery-block/#caption) of some blocks (image, gallery...).
This component encapsulates the "caption" behaviour and styles over a `<RichText>` so it can be used in other components such as the `BlockCaption` component.
## Table of contents
1. [Development guidelines](#development-guidelines)
2. [Related components](#related-components)
## Development guidelines
### Usage
Renders a Caption area:
```jsx
import { Caption } from '@wordpress/block-editor';
const BlockCaption = ( {
onBlur,
onChange,
onFocus,
isSelected,
shouldDisplay,
text,
insertBlocksAfter,
} ) => (
<View >
<Caption
isSelected={ isSelected }
onBlur={ onBlur }
onChange={ onChange }
onFocus={ onFocus }
shouldDisplay={ shouldDisplay }
value={ text }
insertBlocksAfter={ insertBlocksAfter }
/>
</View>
);

Props

The properties isSelected, onBlur, onChange, onFocus, shouldDisplay, value, insertBlocksAfter of this component are passed directly to their related props of its inner <RichText> component (see detailed info about component's props).

Related components

Caption components are mostly used by the BlockCaption component.

Copy link
Member

Choose a reason for hiding this comment

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

Hey @juanmaguitar, thanks for adding the docs! I just added one really minor suggestion to add punctuation at the end of the sentences to match the writing style of the other README files. Feel free to include it or not as you wish. Otherwise, approved. 🚀

@github-actions
Copy link

Flaky tests detected in 2540a7f.
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/5424201731
📝 Reported issues:

@skorasaurus skorasaurus added the [Type] Developer Documentation Documentation for developers label Jul 3, 2023
@juanmaguitar juanmaguitar removed the request for review from ellatrix July 10, 2023 15:22
@juanmaguitar juanmaguitar merged commit 7318f11 into trunk Jul 10, 2023
48 checks passed
@juanmaguitar juanmaguitar deleted the docs/component-caption-readme branch July 10, 2023 16:16
@github-actions github-actions bot added this to the Gutenberg 16.3 milestone Jul 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants