Skip to content

Commit 2be9066

Browse files
committed
Improve buttons documentation for label prop
1 parent 2559a74 commit 2be9066

File tree

1 file changed

+24
-1
lines changed

1 file changed

+24
-1
lines changed

docs/Buttons.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -736,6 +736,12 @@ export const PostCreateButton = () => (
736736
);
737737
```
738738

739+
Custom labels are automatically translated, so you can use a translation key, too:
740+
741+
```jsx
742+
<CreateButton label="resources.comments.actions.create" />
743+
```
744+
739745
### `scrollToTop`
740746

741747
By default, `<CreateButton>` scrolls the page to the top after redirecting. You can disable it as follows:
@@ -1072,6 +1078,12 @@ export const PostEditButton = () => (
10721078
);
10731079
```
10741080

1081+
Custom labels are automatically translated, so you can use a translation key, too:
1082+
1083+
```jsx
1084+
<EditButton label="resources.comments.actions.edit" />
1085+
```
1086+
10751087
### `scrollToTop`
10761088

10771089
By default, `<EditButton>` scrolls the page to the top after redirecting. You can disable it as follows:
@@ -1273,6 +1285,12 @@ You can also customize this label by specifying a custom `label` prop:
12731285
<ListButton label="See all comments" />
12741286
```
12751287

1288+
Custom labels are automatically translated, so you can use a translation key, too:
1289+
1290+
```jsx
1291+
<ListButton label="resources.comments.actions.list" />
1292+
```
1293+
12761294
### `scrollToTop`
12771295

12781296
By default, `<ListButton>` scrolls the page to the top after redirecting. You can disable it as follows:
@@ -1447,13 +1465,18 @@ export const en = {
14471465

14481466
You can also customize this label by specifying a custom `label` prop:
14491467

1450-
14511468
```jsx
14521469
export const PostShowButton = () => (
14531470
<ShowButton label="Display" />
14541471
);
14551472
```
14561473

1474+
Custom labels are automatically translated, so you can use a translation key, too:
1475+
1476+
```jsx
1477+
<ShowButton label="resources.comments.actions.show" />
1478+
```
1479+
14571480
### `scrollToTop`
14581481

14591482
By default, `<ShowButton>` scrolls the page to the top after redirecting. You can disable it as follows:

0 commit comments

Comments
 (0)