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

added README for the "caption" component #52033

Merged
merged 3 commits into from
Jul 10, 2023
Merged

added README for the "caption" component #52033

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7692da2
added README for the caption component
juanmaguitar Jun 28, 2023
2540a7f
Minor adjustments
juanmaguitar Jun 30, 2023
c8c1bae
removed unnecesary space
juanmaguitar Jul 10, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 53 additions & 0 deletions packages/block-editor/src/components/caption/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
## Caption

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. 🚀