You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: docs/AccordionForm.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -520,7 +520,7 @@ Check [the `<AutoSave>` component](./AutoSave.md) documentation for more details
520
520
521
521
## Role-Based Access Control (RBAC)
522
522
523
-
Fine-grained permissions control can be added by using the [`<AccordionForm>`](./AuthRBAC.md#accordionform), [`<AccordionFormPanel>`](./AuthRBAC.md#accordionformpanel) and [`<AccordionSection>`](./AuthRBAC.md#accordionsection) components provided by the `@react-admin/ra-enterprise` package.
523
+
Fine-grained permissions control can be added by using the [`<AccordionForm>`](./AuthRBAC.md#accordionform), [`<AccordionFormPanel>`](./AuthRBAC.md#accordionform) and [`<AccordionSection>`](./AuthRBAC.md#accordionsection) components provided by the `@react-admin/ra-enterprise` package.

102
102
103
-
**Tip**: Whats the `<TitlePortal>`? It's a placeholder for the page title, that components in the page can fill using [the `<Title>` component](./Title.md). `<Title>` uses a [React Portal](https://react.dev/reference/react-dom/createPortal) under the hood. `<TitlePortal>` takes all the available space in the app bar, so it "pushes" the following children to the right.
103
+
**Tip**: What's the `<TitlePortal>`? It's a placeholder for the page title, that components in the page can fill using [the `<Title>` component](./Title.md). `<Title>` uses a [React Portal](https://react.dev/reference/react-dom/createPortal) under the hood. `<TitlePortal>` takes all the available space in the app bar, so it "pushes" the following children to the right.
104
104
105
105
**Tip**: `<TitlePortal>` renders a [Material-ui `<Typography>`](https://mui.com/material-ui/react-typography/) element that you can customize by passing your own props:
106
106
@@ -135,7 +135,7 @@ const MyAppBar = () => (
135
135
136
136
## `color`
137
137
138
-
React-admin's `<AppBar>` renders an Material UI `<AppBar>`, which supports a `color` prop to set the app bar color depending on the theme. By default, the app bar color is set to the `secondary` theme color.
138
+
React-admin's `<AppBar>` renders a Material UI `<AppBar>`, which supports a `color` prop to set the app bar color depending on the theme. By default, the app bar color is set to the `secondary` theme color.
139
139
140
140
This means you can set the app bar color to 'default', 'inherit', 'primary', 'secondary', 'transparent', or any string.
Copy file name to clipboardexpand all lines: docs/AutocompleteInput.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -747,7 +747,7 @@ const PostCreate = () => {
747
747
```
748
748
{% endraw %}
749
749
750
-
Use the `create` prop when you want a more polished or complex UI. For example an Material UI `<Dialog>` asking for multiple fields because the choices are from a referenced resource.
750
+
Use the `create` prop when you want a more polished or complex UI. For example a Material UI `<Dialog>` asking for multiple fields because the choices are from a referenced resource.
Copy file name to clipboardexpand all lines: docs/CreateInDialogButton.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -65,7 +65,7 @@ In the above example, `<CreateInDialogButton>` is used to create a new employee
65
65
66
66
`<CreateInDialogButton>` accepts the following props:
67
67
68
-
*`inline`: set to true to display only an Material UI `<IconButton>` instead of the full `<Button>`. The label will still be available as a `<Tooltip>` though.
68
+
*`inline`: set to true to display only a Material UI `<IconButton>` instead of the full `<Button>`. The label will still be available as a `<Tooltip>` though.
69
69
*`icon`: allows to override the default icon.
70
70
*`label`: allows to override the default button label. I18N is supported.
71
71
*`ButtonProps`: object containing props to pass to Material UI's `<Button>`.
Copy file name to clipboardexpand all lines: docs/CreateReactApp.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -71,7 +71,7 @@ Your app is now up and running, you can start tweaking it.
71
71
72
72
If your users might keep the application open for a long time, it's a good idea to add the [`<CheckForApplicationUpdate>`](./CheckForApplicationUpdate.md) component. It will check whether a more recent version of your application is available and prompt users to reload their browser tab.
73
73
74
-
To determine whether your application has been updated, it fetches the current page at a regular interval, builds an hash of the response content (usually the HTML) and compares it with the previous hash.
74
+
To determine whether your application has been updated, it fetches the current page at a regular interval, builds a hash of the response content (usually the HTML) and compares it with the previous hash.
Copy file name to clipboardexpand all lines: docs/EditInDialogButton.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -58,7 +58,7 @@ const CompanyShow = () => (
58
58
59
59
It accepts the following props:
60
60
61
-
*`inline`: set to true to display only an Material UI `<IconButton>` instead of the full `<Button>`. The label will still be available as a `<Tooltip>` though.
61
+
*`inline`: set to true to display only a Material UI `<IconButton>` instead of the full `<Button>`. The label will still be available as a `<Tooltip>` though.
62
62
*`icon`: allows to override the default icon.
63
63
*`label`: allows to override the default button label. I18N is supported.
64
64
*`ButtonProps`: object containing props to pass to Material UI's `<Button>`.
Copy file name to clipboardexpand all lines: docs/Features.md
+3-3
Original file line number
Diff line number
Diff line change
@@ -741,7 +741,7 @@ When users submit a form, or delete a record, the UI reflects their change immed
741
741
742
742
This undo feature is enabled by default, and requires no particular setup on the server side. In fact, react-admin delays the call to the data provider for mutations, to give users a "grace" period. That's why the actual call to `dataProvider.update()` occurs 5 seconds after the user submits an update form - even though the UI reflects the changes immediately.
743
743
744
-
You can disable this feature page by page by choosing a different [mutationMode](./Edit.md#mutationmode).
744
+
You can disable this feature page by page, by choosing a different [mutationMode](./Edit.md#mutationmode).
745
745
746
746
## Roles & Permissions
747
747
@@ -1157,7 +1157,7 @@ For instance, the Saved Queries feature lets users **save a combination of filte
1157
1157
</video>
1158
1158
1159
1159
1160
-
Saved queries persist between sessions, so users can find their custom queries even after closing and reopening the admin. Saved queries are available both for the Filter Button/Form combo and for the `<FilterList>` Sidebar. It's enabled by default for the Filter Button/Form combo but you have to add it yourself in the `<FilterList>` Sidebar.
1160
+
Saved queries persist between sessions, so users can find their custom queries even after closing and reopening the admin. Saved queries are available both for the Filter Button/Form combo and for the `<FilterList>` Sidebar. It's enabled by default for the Filter Button/Form combo, but you have to add it yourself in the `<FilterList>` Sidebar.
1161
1161
1162
1162
```diff
1163
1163
import { FilterList, FilterListItem, List, Datagrid } from 'react-admin';
@@ -1373,7 +1373,7 @@ React-admin is **fully internationalized**.
1373
1373
</video>
1374
1374
1375
1375
1376
-
The default interface messages (for buttons, tooltips, input labels, etc) are in English. You can translate them to any of [the 30+ languages supported by react-admin](./TranslationLocales.md) by importing the appropriate translation package. For instance, to translate to French:
1376
+
The default interface messages (for buttons, tooltips, input labels, etc.) are in English. You can translate them to any of [the 30+ languages supported by react-admin](./TranslationLocales.md) by importing the appropriate translation package. For instance, to translate to French:
Copy file name to clipboardexpand all lines: docs/Inputs.md
+4-4
Original file line number
Diff line number
Diff line change
@@ -54,7 +54,7 @@ All input components accept the following props:
54
54
55
55
React-admin uses [react-hook-form](https://react-hook-form.com/) to control form inputs. Each input component also accepts all react-hook-form [useController](https://react-hook-form.com/docs/usecontroller) hook options.
56
56
57
-
Additional props are passed down to the underlying component (usually an Material UI component). For instance, when setting the `variant` prop on a `<TextInput>` component, the underlying Material UI `<TextField>` receives it, and renders it with a different variant. Refer to the documentation of each Input component to see the underlying Material UI component and its props.
57
+
Additional props are passed down to the underlying component (usually a Material UI component). For instance, when setting the `variant` prop on a `<TextInput>` component, the underlying Material UI `<TextField>` receives it, and renders it with a different variant. Refer to the documentation of each Input component to see the underlying Material UI component and its props.
58
58
59
59
## Which Input Component to Use?
60
60
@@ -596,7 +596,7 @@ import { FormDataConsumer } from 'react-admin';
596
596
597
597
Material UI offers [3 variants for text fields](https://mui.com/material-ui/react-text-field/#basic-textfield): `outlined`, `filled`, and `standard`. The default react-admin theme uses the `filled` variant.
598
598
599
-
Most Input components pass their additional props down to the root component, which is often an Material UI Field component. This means you can pass a `variant` prop to override the variant of a single input:
599
+
Most Input components pass their additional props down to the root component, which is often a Material UI Field component. This means you can pass a `variant` prop to override the variant of a single input:
600
600
601
601
```tsx
602
602
<TextInputsource="name"variant="outlined" />
@@ -761,7 +761,7 @@ Now the component will render with a label:
761
761
762
762
### Using Material UI Field Components
763
763
764
-
Instead of HTML `input` elements, you can use an Material UI component like `TextField`. To bind Material UI components to the form values, use the `useController()` hook:
764
+
Instead of HTML `input` elements, you can use a Material UI component like `TextField`. To bind Material UI components to the form values, use the `useController()` hook:
Copy file name to clipboardexpand all lines: docs/Layout.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -211,7 +211,7 @@ export const MyError = ({
211
211
};
212
212
```
213
213
214
-
**Tip:** [React's Error Boundaries](https://react.dev/reference/react/Component#catching-rendering-errors-with-an-error-boundary) are used internally to display the Error Page whenever an error occurs. Error Boundaries only catch errors during rendering, in lifecycle methods, and in constructors of the components tree. This implies in particular that errors during event callbacks (such as 'onClick') are not concerned. Also note that the Error Boundary component is only set around the main container of React Admin. In particular, you won't see it for errors thrown by the [sidebar Menu](./Menu.md), nor the [AppBar](#customizing-the-appbar-content). This ensures the user is always able to navigate away from the Error Page.
214
+
**Tip:** [React's Error Boundaries](https://react.dev/reference/react/Component#catching-rendering-errors-with-an-error-boundary) are used internally to display the Error Page whenever an error occurs. Error Boundaries only catch errors during rendering, in lifecycle methods, and in constructors of the components tree. This implies in particular that errors during event callbacks (such as 'onClick') are not concerned. Also note that the Error Boundary component is only set around the main container of React Admin. In particular, you won't see it for errors thrown by the [sidebar Menu](./Menu.md), nor the [AppBar](#adding-a-custom-context). This ensures the user is always able to navigate away from the Error Page.
Copy file name to clipboardexpand all lines: docs/List.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -946,7 +946,7 @@ The title can be either a string or a React element.
946
946
947
947
## `sx`: CSS API
948
948
949
-
The `<List>` component accepts the usual `className` prop but you can override many class names injected to the inner components by React-admin thanks to the `sx` property (as most Material UI components, see their [documentation about it](https://mui.com/material-ui/customization/how-to-customize/#overriding-nested-component-styles)). This property accepts the following subclasses:
949
+
The `<List>` component accepts the usual `className` prop, but you can override many class names injected to the inner components by React-admin thanks to the `sx` property (as most Material UI components, see their [documentation about it](https://mui.com/material-ui/customization/how-to-customize/#overriding-nested-component-styles)). This property accepts the following subclasses:
The children of `<LongForm>` must be `<LongForm.Section>` elements.
357
357
358
-
This component adds a section title (using a `<Typography variant="h4">`), then renders each child inside a [Material UI `<Stack>`](https://mui.com/material-ui/react-stack/), and finally adds an Material UI `<Divider>` at the bottom of the section.
358
+
This component adds a section title (using a `<Typography variant="h4">`), then renders each child inside a [Material UI `<Stack>`](https://mui.com/material-ui/react-stack/), and finally adds a Material UI `<Divider>` at the bottom of the section.
359
359
360
360
It accepts the following props:
361
361
@@ -470,7 +470,7 @@ Check [the `<AutoSave>` component](./AutoSave.md) documentation for more details
470
470
471
471
## Role-Based Access Control (RBAC)
472
472
473
-
Fine-grained permissions control can be added by using the [`<LongForm>`](./AuthRBAC.md#longform) and [`<LongFormSection>`](./AuthRBAC.md#longformsection) components provided by the `@react-admin/ra-enterprise` package.
473
+
Fine-grained permissions control can be added by using the [`<LongForm>`](./AuthRBAC.md#longform) and [`<LongFormSection>`](./AuthRBAC.md#longform) components provided by the `@react-admin/ra-enterprise` package.
On mobile devices, the `<Pagination>` component is not very userfriendly. The expected user experience is to reveal more records when the user scrolls to the bottom of the list. This UX is also useful on desktop, for lists with a large number of records.
56
+
On mobile devices, the `<Pagination>` component is not very user-friendly. The expected user experience is to reveal more records when the user scrolls to the bottom of the list. This UX is also useful on desktop, for lists with a large number of records.
`<InfiniteList>` uses a special pagination component, `<InfinitePagination>`, which doesn't display any pagination buttons. Instead, it displays a loading indicator when the user scrolls to the bottom of the list. But you cannot use this `<InfinitePagination>` inside a regular `<List>` component.
88
88
89
-
For more information, see [the `<InfiniteList>` documentation](./InfiniteList.md).
89
+
For more information, see [the `<InfiniteList>` documentation](./InfiniteList.md).
**Tip**: If you use RBAC, use [`ra-rbac`'s `<SimpleForm>` component](./AuthRBAC.md#simpleform) instead. It render its children only if the user has the required permissions.
256
+
**Tip**: If you use RBAC, use [`ra-rbac`'s `<SimpleForm>` component](./AuthRBAC.md#simpleform) instead. It renders its children only if the user has the required permissions.
Copy file name to clipboardexpand all lines: docs/RecordRepresentation.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ title: "The RecordRepresentation Component"
5
5
6
6
Render the record representation, leveraging the [`recordRepresentation`](./Resource.md#recordrepresentation) prop of the parent `<Resource>` component.
7
7
8
-
You can also uses its hook version: [`<useGetRecordRepresentation>`](./useGetRecordRepresentation.md).
8
+
You can also use its hook version: [`<useGetRecordRepresentation>`](./useGetRecordRepresentation.md).
0 commit comments