Merge pull request #9086 from marmelab/doc-improve-documentation-about-disabling-features-bulk-actions-etc

[Doc] add sections to explain explicitly how to disable features like bulk actions

Author: djhi

docs/Datagrid.md

@@ -1201,3 +1201,36 @@ const MyCustomList = () => {
     );
 };
 ```
+
+## How to disable checkboxes
+
+You can disable bulk actions altogether by passing `false` to the `bulkActionButtons` prop. In this case, the checkboxes column doesn’t show up anymore.
+
+```tsx
+import { Datagrid, List } from 'react-admin';
+
+export const PostList = () => (
+    <List>
+        <Datagrid bulkActionButtons={false}>
+            ...
+        </Datagrid>
+    </List>
+);
+```
+
+## Disable column sorting
+
+In a `<Datagrid>`, users can change the sort field and order by clicking on the column headers. You may want to disable this behavior for a given field (e.g. for reference or computed fields). In that case, pass a `false` value to the `sortable` prop on the field.
+
+```jsx
+const PostList = () => (
+    <List>
+        <Datagrid>
+            <TextField source="title" />
+            <ReferenceField source="author_id" sortable={false}>
+                <TextField source="name" />
+            </ReferenceField>
+        </Datagrid>
+    </List>
+);
+```

docs/Fields.md

@@ -368,6 +368,17 @@ const BookEdit = () => (
 );
 ```
 
+## Hiding A Field Label
+
+You can opt out of the label decoration by passing `false` to the `label` prop.
+
+```jsx
+// No label will be added
+<TextField source="author.name" label={false} />
+```
+
+**Note**: This prop has no effect when rendering a field outside a `<Datagrid>`, a `<SimpleShowLayout>`, a `<TabbedShowLayout>`, a `<SimpleForm>`, or a `<TabbedForm>`.
+
 ## Conditional Formatting
 
 If you want to format a field depending on the value, create another component wrapping this field, and set the `sx` prop depending on the field value:

docs/Inputs.md

@@ -910,3 +910,13 @@ You can find components for react-admin in third-party repositories.
 - [@react-page/react-admin](https://react-page.github.io/docs/#/integration-react-admin): ReactPage is a rich content editor and comes with a ready-to-use React-admin input component. [check out the demo](https://react-page.github.io/examples/reactadmin)
 
 - **DEPRECATED V3** [LoicMahieu/aor-tinymce-input](https://github.com/LoicMahieu/aor-tinymce-input): a TinyMCE component, useful for editing HTML
+
+## Hiding the label
+
+You can set `label={false}` on an input component to hide its label.
+
+```jsx
+<TextInput source="title" /> {/* input label is "Title" */}
+<TextInput source="title" label="Post title" /> {/* input label is "Post title" */}
+<TextInput source="title" label={false} /> {/* input has no label */}
+```

docs/List.md

@@ -1006,4 +1006,46 @@ const PostList = () => (
 );
 ```
 
-The list will automatically update when a new record is created, or an existing record is updated or deleted.
+The list will automatically update when a new record is created, or an existing record is updated or deleted.
+
+## How to render an empty list
+
+You can set the `empty` props value to `false` to bypass the empty page display and render an empty list instead.
+
+```tsx
+import { List } from 'react-admin';
+
+const ProductList = () => (
+    <List empty={false}>
+        ...
+    </List>
+)
+```
+
+## How to remove the `<ExportButton>`
+
+You can remove the `<ExportButton>` by passing `false` to the `exporter` prop.
+
+```tsx
+import { List } from 'react-admin';
+
+const ProductList = () => (
+    <List exporter={false}>
+        ...
+    </List>
+)
+```
+
+## How to disable storing the list parameters in the Store
+
+You can disable the `storeKey` feature by setting the `storeKey` prop to `false`. When disabled, the list parameters will not be persisted in [the Store](./Store.md).
+
+```tsx
+import { List } from 'react-admin';
+
+const ProductList = () => (
+    <List storeKey={false}>
+        ...
+    </List>
+)
+```

docs/ReferenceField.md

@@ -301,3 +301,12 @@ React-admin accumulates and deduplicates the ids of the referenced records to ma
 ```
 
 Then react-admin renders the `<PostList>` with a loader for the `<ReferenceField>`, fetches the API for the related users in one call (`dataProvider.getMany('users', { ids: [789,735] }`), and re-renders the list once the data arrives. This accelerates the rendering and minimizes network load.
+
+## Removing the link
+
+You can prevent `<ReferenceField>` from adding a link to its children by setting `link` to `false`.
+
+```jsx
+// No link
+<ReferenceField source="user_id" reference="users" link={false} />
+```

docs/ReferenceOneField.md

@@ -223,3 +223,13 @@ const BookShow = () => (
 );
 ```
 {% endraw %}
+
+## Removing the link
+
+By default, `<ReferenceOneField>` links to the edition page of the related record. You can disable this behavior by setting the `link` prop to `false`.
+
+```jsx
+<ReferenceOneField label="Genre" reference="book_details" target="book_id" link={false}>
+    <TextField source="genre" />
+</ReferenceOneField>
+```

docs/SimpleShowLayout.md

@@ -206,6 +206,29 @@ The `<SimpleShowLayout>` component accepts the usual `className` prop but you ca
 
 To override the style of all instances of `<SimpleShowLayout>` using the [Material UI style overrides](https://mui.com/material-ui/customization/theme-components/#theme-style-overrides), use the `RaSimpleShowLayout` key.
 
+## Hiding the labels
+
+You can disable the `<Labeled>` decoration added by `<SimpleShowLayout>` by passing setting `label={false}` on a field:
+
+```jsx
+const PostShow = () => (
+    <Show>
+        <SimpleShowLayout>
+            <TextField label={false} source="title" />
+        </SimpleShowLayout>
+    </Show>
+);
+
+// translates to
+const PostShow = () => (
+    <Show>
+        <Stack>
+            <TextField source="title" />
+        </Stack>
+    </Show>
+);
+```
+
 ## See Also
 
 * [Field components](./Fields.md)