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.

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

[Doc] Fix links anchors #5875

Merged
merged 7 commits into from
Feb 11, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@
* [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))
* [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))
* [Doc] Fix various typos in Input components prop lists ([5777](https://github.com/marmelab/react-admin/pull/5777)) ([WiXSL](https://github.com/WiXSL))
* [Do] Fix typo in `saveModifiers` code comment ([5770](https://github.com/marmelab/react-admin/pull/5770)) ([DjebbZ](https://github.com/DjebbZ))
* [Doc] Fix typo in `saveModifiers` code comment ([5770](https://github.com/marmelab/react-admin/pull/5770)) ([DjebbZ](https://github.com/DjebbZ))
* [Doc] Fix `<AutocompleteInput resettable>` prop isn't documented ([5769](https://github.com/marmelab/react-admin/pull/5769)) ([fzaninotto](https://github.com/fzaninotto))
* [Doc] Fix minor typos in code comments ([5758](https://github.com/marmelab/react-admin/pull/5758)) ([WiXSL](https://github.com/WiXSL))
* [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))
Expand Down
2 changes: 1 addition & 1 deletion docs/Admin.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Here are all the props accepted by the component:
- [`i18nProvider`](#i18nprovider)
- [`title`](#title)
- [`dashboard`](#dashboard)
- [`disableTelemetry`](#disableTelemetry)
- [`disableTelemetry`](#disabletelemetry)
- [`catchAll`](#catchall)
- [`menu`](#menu)
- [`theme`](#theme)
Expand Down
2 changes: 1 addition & 1 deletion docs/CreateEdit.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ You can customize the `<Create>` and `<Edit>` components using the following pro
* [`aside`](#aside-component)
* [`component`](#component)
* [`undoable`](#undoable) (`<Edit>` only) (deprecated)
* [`mutationMode`](#mutationMode) (`<Edit>` only)
* [`mutationMode`](#mutationmode) (`<Edit>` only)
* [`onSuccess`](#onsuccess)
* [`onFailure`](#onfailure)
* [`transform`](#transform)
Expand Down
2 changes: 2 additions & 0 deletions docs/Ecosystem.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,8 @@ See the [Translation](./Translation.md#available-locales) page.

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

## Authorization Management

- **[Access Control List (ACL) for Resources](https://github.com/marmelab/ra-auth-acl)**: [marmelab/ra-auth-acl](https://github.com/marmelab/ra-auth-acl)

## Data Providers
Expand Down
24 changes: 12 additions & 12 deletions docs/List.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,19 +17,19 @@ The `<List>` component fetches the list of records from the data provider, and r

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

* [`title`](#page-title)
* [`title`](#title)
* [`actions`](#actions)
* [`exporter`](#exporter)
* [`bulkActionButtons`](#bulk-action-buttons)
* [`filters`](#filters) (a React element used to display the filter form)
* [`filterDefaultValues`](#filter-default-values) (the default values for `alwaysOn` filters)
* [`perPage`](#records-per-page)
* [`sort`](#default-sort-field)
* [`filter`](#permanent-filter) (the permanent filter used in the REST request)
* [`pagination`](#pagination)
* [`aside`](#aside-component)
* [`empty`](#empty-page)
- [`syncWithLocation`](#synchronize-with-url)
* [`bulkActionButtons`](#bulkactionbuttons)
* [`filters`](#filters-filter-inputs) (a React element used to display the filter form)
* [`filterDefaultValues`](#filterdefaultvalues) (the default values for `alwaysOn` filters)
* [`perPage`](#perpage-pagination-size)
* [`sort`](#sort-default-sort-field--order)
* [`filter`](#filter-permanent-filter) (the permanent filter used in the REST request)
* [`pagination`](#pagination-pagination-component)
* [`aside`](#aside-aside-component)
* [`empty`](#empty-empty-page-component)
* [`syncWithLocation`](#synchronize-with-url)

```jsx
// in src/posts.js
Expand Down Expand Up @@ -910,7 +910,7 @@ const PostFilter = (props) => (

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.

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

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

Expand Down
3 changes: 2 additions & 1 deletion docs/Reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,8 @@ title: "Reference"
* [`<Labeled>`](./Inputs.md#using-labeled)
* [`<LanguageSwitcher>`](https://marmelab.com/ra-enterprise/modules/ra-preferences#languageswitcher-store-the-locale-in-preferences)<img class="icon" src="./img/premium.svg" />
* [`<Layout>`](./Theming.md#using-a-custom-layout)
* [`<Loading>`](./Theming.md#Loading)
* [`<Loading>`](./Theming.md#loading)
* [`<LinearProgress>`](./Theming.md#linearprogress)
* [`<Logout>`](./Theming.md#using-a-custom-logout-button)
* [`linkToRecord`](./Fields.md#linking-to-other-records)
* [`<List>`](./List.md#the-list-component)
Expand Down
4 changes: 2 additions & 2 deletions docs/Translation.md
Original file line number Diff line number Diff line change
Expand Up @@ -703,8 +703,8 @@ This solution is all-or-nothing: you can't silence only *some* missing translati

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:

- To display translatable fields, use the [`<TranslatableFields>`](/Fields.html#translatable-fields) component
- To edit translatable fields, use the [`<TranslatableInputs>`](/Inputs.html#translatable-inputs) component
- To display translatable fields, use the [`<TranslatableFields>`](./Fields.md#translatable-fields) component
- To edit translatable fields, use the [`<TranslatableInputs>`](./Inputs.md#translatable-inputs) component

They both expect the translatable values to have the following structure:

Expand Down
1 change: 1 addition & 0 deletions packages/ra-ui-materialui/src/layout/LinearProgress.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ const useStyles = makeStyles(
* @typedef {Object} Props the props you can use
* @prop {Object} classes CSS class names
* @prop {string} className CSS class applied to the LinearProgress component
* @prop {integer} timeout Milliseconds to wait before showing the progress bar. One second by default
*
* @param {Props} props
*/
Expand Down