Skip to content

Commit e0de8c3

Browse files
authored
Merge pull request #5875 from WiXSL/fix-reference-links
[Doc] Fix links anchors
2 parents ca05a1c + dc95cca commit e0de8c3

File tree

8 files changed

+22
-18
lines changed

8 files changed

+22
-18
lines changed

CHANGELOG.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@
6464
* [TypeScript] Fix the type of the custom `theme` used in `<Admin>` ([5784](https://github.com/marmelab/react-admin/pull/5784)) ([djhi](https://github.com/djhi))
6565
* [TypeScript] Fix the return type of the `exporter` function used in `<List>` ([5782](https://github.com/marmelab/react-admin/pull/5782)) ([ohbarye](https://github.com/ohbarye))
6666
* [Doc] Fix various typos in Input components prop lists ([5777](https://github.com/marmelab/react-admin/pull/5777)) ([WiXSL](https://github.com/WiXSL))
67-
* [Do] Fix typo in `saveModifiers` code comment ([5770](https://github.com/marmelab/react-admin/pull/5770)) ([DjebbZ](https://github.com/DjebbZ))
67+
* [Doc] Fix typo in `saveModifiers` code comment ([5770](https://github.com/marmelab/react-admin/pull/5770)) ([DjebbZ](https://github.com/DjebbZ))
6868
* [Doc] Fix `<AutocompleteInput resettable>` prop isn't documented ([5769](https://github.com/marmelab/react-admin/pull/5769)) ([fzaninotto](https://github.com/fzaninotto))
6969
* [Doc] Fix minor typos in code comments ([5758](https://github.com/marmelab/react-admin/pull/5758)) ([WiXSL](https://github.com/WiXSL))
7070
* [Doc] Fix bad return types and typos in jsDocs for `ra-core` and `ra-ui-material-ui` packages ([5690](https://github.com/marmelab/react-admin/pull/5690)) ([WiXSL](https://github.com/WiXSL))

docs/Admin.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Here are all the props accepted by the component:
3232
- [`i18nProvider`](#i18nprovider)
3333
- [`title`](#title)
3434
- [`dashboard`](#dashboard)
35-
- [`disableTelemetry`](#disableTelemetry)
35+
- [`disableTelemetry`](#disabletelemetry)
3636
- [`catchAll`](#catchall)
3737
- [`menu`](#menu)
3838
- [`theme`](#theme)

docs/CreateEdit.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ You can customize the `<Create>` and `<Edit>` components using the following pro
9999
* [`aside`](#aside-component)
100100
* [`component`](#component)
101101
* [`undoable`](#undoable) (`<Edit>` only) (deprecated)
102-
* [`mutationMode`](#mutationMode) (`<Edit>` only)
102+
* [`mutationMode`](#mutationmode) (`<Edit>` only)
103103
* [`onSuccess`](#onsuccess)
104104
* [`onFailure`](#onfailure)
105105
* [`transform`](#transform)

docs/Ecosystem.md

+2
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,8 @@ See the [Translation](./Translation.md#available-locales) page.
3939

4040
See the [Auth Provider](./Authentication.md#available-providers) page. Here is a list of additional packages:
4141

42+
## Authorization Management
43+
4244
- **[Access Control List (ACL) for Resources](https://github.com/marmelab/ra-auth-acl)**: [marmelab/ra-auth-acl](https://github.com/marmelab/ra-auth-acl)
4345

4446
## Data Providers

docs/List.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -17,19 +17,19 @@ The `<List>` component fetches the list of records from the data provider, and r
1717

1818
Here is the minimal code necessary to display a list of posts using a `<Datagrid>`:
1919

20-
* [`title`](#page-title)
20+
* [`title`](#title)
2121
* [`actions`](#actions)
2222
* [`exporter`](#exporter)
23-
* [`bulkActionButtons`](#bulk-action-buttons)
24-
* [`filters`](#filters) (a React element used to display the filter form)
25-
* [`filterDefaultValues`](#filter-default-values) (the default values for `alwaysOn` filters)
26-
* [`perPage`](#records-per-page)
27-
* [`sort`](#default-sort-field)
28-
* [`filter`](#permanent-filter) (the permanent filter used in the REST request)
29-
* [`pagination`](#pagination)
30-
* [`aside`](#aside-component)
31-
* [`empty`](#empty-page)
32-
- [`syncWithLocation`](#synchronize-with-url)
23+
* [`bulkActionButtons`](#bulkactionbuttons)
24+
* [`filters`](#filters-filter-inputs) (a React element used to display the filter form)
25+
* [`filterDefaultValues`](#filterdefaultvalues) (the default values for `alwaysOn` filters)
26+
* [`perPage`](#perpage-pagination-size)
27+
* [`sort`](#sort-default-sort-field--order)
28+
* [`filter`](#filter-permanent-filter) (the permanent filter used in the REST request)
29+
* [`pagination`](#pagination-pagination-component)
30+
* [`aside`](#aside-aside-component)
31+
* [`empty`](#empty-empty-page-component)
32+
* [`syncWithLocation`](#synchronize-with-url)
3333

3434
```jsx
3535
// in src/posts.js
@@ -910,7 +910,7 @@ const PostFilter = (props) => (
910910

911911
Children of the `<Filter>` component are regular inputs. That means you can build sophisticated filters based on references, array values, etc. `<Filter>` hides all inputs in the filter form by default, except those that have the `alwaysOn` prop.
912912

913-
**Tip**: For technical reasons, react-admin does not accept children of `<Filter>` having both a `defaultValue` and `alwaysOn`. To set default values for always on filters, use the [`filterDefaultValues`](#filter-default-values) prop of the <List> component instead.
913+
**Tip**: For technical reasons, react-admin does not accept children of `<Filter>` having both a `defaultValue` and `alwaysOn`. To set default values for always on filters, use the [`filterDefaultValues`](#filterdefaultvalues) prop of the <List> component instead.
914914

915915
To inject the filter form in a `<List>`, use the `filters` prop:
916916

docs/Reference.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,8 @@ title: "Reference"
7070
* [`<Labeled>`](./Inputs.md#using-labeled)
7171
* [`<LanguageSwitcher>`](https://marmelab.com/ra-enterprise/modules/ra-preferences#languageswitcher-store-the-locale-in-preferences)<img class="icon" src="./img/premium.svg" />
7272
* [`<Layout>`](./Theming.md#using-a-custom-layout)
73-
* [`<Loading>`](./Theming.md#Loading)
73+
* [`<Loading>`](./Theming.md#loading)
74+
* [`<LinearProgress>`](./Theming.md#linearprogress)
7475
* [`<Logout>`](./Theming.md#using-a-custom-logout-button)
7576
* [`linkToRecord`](./Fields.md#linking-to-other-records)
7677
* [`<List>`](./List.md#the-list-component)

docs/Translation.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -703,8 +703,8 @@ This solution is all-or-nothing: you can't silence only *some* missing translati
703703
704704
Some of your records may contain fields that are translated in multiple languages. It's common, in such cases, to offer an interface allowing admin users to see and edit each translation. React-admin provides 2 components for that:
705705
706-
- To display translatable fields, use the [`<TranslatableFields>`](/Fields.html#translatable-fields) component
707-
- To edit translatable fields, use the [`<TranslatableInputs>`](/Inputs.html#translatable-inputs) component
706+
- To display translatable fields, use the [`<TranslatableFields>`](./Fields.md#translatable-fields) component
707+
- To edit translatable fields, use the [`<TranslatableInputs>`](./Inputs.md#translatable-inputs) component
708708
709709
They both expect the translatable values to have the following structure:
710710

packages/ra-ui-materialui/src/layout/LinearProgress.tsx

+1
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ const useStyles = makeStyles(
2828
* @typedef {Object} Props the props you can use
2929
* @prop {Object} classes CSS class names
3030
* @prop {string} className CSS class applied to the LinearProgress component
31+
* @prop {integer} timeout Milliseconds to wait before showing the progress bar. One second by default
3132
*
3233
* @param {Props} props
3334
*/

0 commit comments

Comments
 (0)