Skip to content

Commit

Permalink
Fix modules links
Browse files Browse the repository at this point in the history
  • Loading branch information
djhi committed Apr 11, 2024
1 parent 34e18b1 commit 8cf25fd
Show file tree
Hide file tree
Showing 32 changed files with 93 additions and 93 deletions.
2 changes: 1 addition & 1 deletion docs/AccordionForm.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ You can also use the `<AccordionSection>` component as a child of `<SimpleForm>`
Your browser does not support the video tag.
</video>

Check [the `ra-form-layout` documentation](https://react-admin-ee.marmelab.com/modules/ra-form-layout##accordionform) for more details.
Check [the `ra-form-layout` documentation](https://react-admin-ee.marmelab.com/documentation/ra-form-layout##accordionform) for more details.

## Props

Expand Down
2 changes: 1 addition & 1 deletion docs/AuthRBAC.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: "RBAC"

# Role-Based Access Control (RBAC)

React-admin Enterprise Edition contains [the ra-rbac module](https://react-admin-ee.marmelab.com/modules/ra-rbac)<img class="icon" src="./img/premium.svg" />, which adds fine-grained permissions to your admin. This module extends the `authProvider` and adds replacement for many react-admin components that use these permissions.
React-admin Enterprise Edition contains [the ra-rbac module](https://react-admin-ee.marmelab.com/documentation/ra-rbac)<img class="icon" src="./img/premium.svg" />, which adds fine-grained permissions to your admin. This module extends the `authProvider` and adds replacement for many react-admin components that use these permissions.

<video controls="controls" style="max-width: 96%">
<source src="./img/ra-rbac.mp4" type="video/mp4" />
Expand Down
4 changes: 2 additions & 2 deletions docs/Buttons.md
Original file line number Diff line number Diff line change
Expand Up @@ -306,7 +306,7 @@ export const PostList = () => (

### `<BulkUpdateFormButton>`

This component, part of the [enterprise edition](https://react-admin-ee.marmelab.com/modules/ra-form-layout)<img class="icon" src="./img/premium.svg" />, lets users edit multiple records at once. To be used inside [the `<Datagrid bulkActionButtons>` prop](./Datagrid.md#bulkactionbuttons).
This component, part of the [enterprise edition](https://react-admin-ee.marmelab.com/documentation/ra-form-layout)<img class="icon" src="./img/premium.svg" />, lets users edit multiple records at once. To be used inside [the `<Datagrid bulkActionButtons>` prop](./Datagrid.md#bulkactionbuttons).

The button opens a dialog containing the form passed as children. When the form is submitted, it will call the dataProvider's `updateMany` method with the ids of the selected records.

Expand Down Expand Up @@ -818,7 +818,7 @@ const App = () => (

See [The Menu documentation](./Menu.md) for more details.

**Tip**: If you need a multi-level menu, or a Mega Menu opening panels with custom content, check out [the `ra-navigation`<img class="icon" src="./img/premium.svg" /> module](https://react-admin-ee.marmelab.com/modules/ra-navigation) (part of the [Enterprise Edition](https://react-admin-ee.marmelab.com))
**Tip**: If you need a multi-level menu, or a Mega Menu opening panels with custom content, check out [the `ra-navigation`<img class="icon" src="./img/premium.svg" /> module](https://react-admin-ee.marmelab.com/documentation/ra-navigation) (part of the [Enterprise Edition](https://react-admin-ee.marmelab.com))

<video controls autoplay playsinline muted loop>
<source src="https://react-admin-ee.marmelab.com/modules/assets/ra-multilevelmenu-item.webm" type="video/webm" />
Expand Down
10 changes: 5 additions & 5 deletions docs/Calendar.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: "The Calendar Component"

# `<Calendar>`

This [Enterprise Edition](https://react-admin-ee.marmelab.com)<img class="icon" src="./img/premium.svg" /> component, part of [the `ra-calendar` module](https://react-admin-ee.marmelab.com/modules/ra-calendar), renders a list of events as a calendar.
This [Enterprise Edition](https://react-admin-ee.marmelab.com)<img class="icon" src="./img/premium.svg" /> component, part of [the `ra-calendar` module](https://react-admin-ee.marmelab.com/documentation/ra-calendar), renders a list of events as a calendar.

<video controls autoplay playsinline muted loop>
<source src="https://react-admin-ee.marmelab.com/modules/assets/ra-calendar.webm" type="video/webm" />
Expand Down Expand Up @@ -263,7 +263,7 @@ Check the possible values for `CalendarProps` in the [`<Calendar>`](#calendar) a

### `EditDialogProps`

For content edition, `<CompleteCalendar>` relies on [ra-form-layout's `<EditDialog>`](https://react-admin-ee.marmelab.com/modules/ra-form-layout#createdialog--editdialog) to display its child form in a dialog.
For content edition, `<CompleteCalendar>` relies on [ra-form-layout's `<EditDialog>`](https://react-admin-ee.marmelab.com/documentation/ra-form-layout#createdialog--editdialog) to display its child form in a dialog.

You can customize `<EditDialog>` props like `title`, `redirect`, `onSuccess` and `onFailure` by passing a custom `EditDialogProps` prop.

Expand Down Expand Up @@ -296,11 +296,11 @@ const EventList = () => (
```
{% endraw %}

Check the possible values for `EditDialogProps` in [the `<EditDialog>` component documentation](https://react-admin-ee.marmelab.com/modules/ra-form-layout#createdialog--editdialog).
Check the possible values for `EditDialogProps` in [the `<EditDialog>` component documentation](https://react-admin-ee.marmelab.com/documentation/ra-form-layout#createdialog--editdialog).

### `CreateDialogProps`

For content addition, `<CompleteCalendar>` relies on [ra-form-layout's `<CreateDialog>`](https://react-admin-ee.marmelab.com/modules/ra-form-layout#createdialog--editdialog) to display its child form in a dialog.
For content addition, `<CompleteCalendar>` relies on [ra-form-layout's `<CreateDialog>`](https://react-admin-ee.marmelab.com/documentation/ra-form-layout#createdialog--editdialog) to display its child form in a dialog.

You can customize `<CreateDialog>` props like `title`, `redirect`, `onSuccess` and `onFailure` by passing a custom `CreateDialogProps` prop.

Expand Down Expand Up @@ -328,7 +328,7 @@ const EventList = () => (
```
{% endraw %}

Check the possible values for `CreateDialogProps` in [the `<CreateDialog>` component documentation](https://react-admin-ee.marmelab.com/modules/ra-form-layout#createdialog--editdialog).
Check the possible values for `CreateDialogProps` in [the `<CreateDialog>` component documentation](https://react-admin-ee.marmelab.com/documentation/ra-form-layout#createdialog--editdialog).

### `mutationOptions`

Expand Down
6 changes: 3 additions & 3 deletions docs/ContainerLayout.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This [Enterprise Edition](https://react-admin-ee.marmelab.com)<img class="icon"

![Container layout](https://react-admin-ee.marmelab.com/modules/assets/ra-navigation/latest/container-layout.png)

`<ContainerLayout>` is part of the [ra-navigation](https://react-admin-ee.marmelab.com/modules/ra-navigation#containerlayout) package.
`<ContainerLayout>` is part of the [ra-navigation](https://react-admin-ee.marmelab.com/documentation/ra-navigation#containerlayout) package.

## Usage

Expand Down Expand Up @@ -72,7 +72,7 @@ const MyLayout = props => <ContainerLayout {...props} maxWidth="md" />;

## `menu`

By default, `<ContainerLayout>` renders one menu item per resource in the admin. To reorder the menu, omit resources, or add custom pages, pass a custom menu element to the `menu` prop. This element should be [a `<HorizontalMenu>` component](#horizontalmenu) with `<HorizontalMenu.Item>` children. Each child should have a `value` corresponding to the [application location](https://react-admin-ee.marmelab.com/modules/ra-navigation#concepts) of the target, and can have a `to` prop corresponding to the target location if different from the app location.
By default, `<ContainerLayout>` renders one menu item per resource in the admin. To reorder the menu, omit resources, or add custom pages, pass a custom menu element to the `menu` prop. This element should be [a `<HorizontalMenu>` component](#horizontalmenu) with `<HorizontalMenu.Item>` children. Each child should have a `value` corresponding to the [application location](https://react-admin-ee.marmelab.com/documentation/ra-navigation#concepts) of the target, and can have a `to` prop corresponding to the target location if different from the app location.

```jsx
import {
Expand Down Expand Up @@ -211,7 +211,7 @@ This menu automatically detects and highlights the current location.

### Usage

Create a menu component based on `<HorizontalMenu>` and `<HorizontalMenu.Item>` children. Each child should have a `value` corresponding to the [application location](https://react-admin-ee.marmelab.com/modules/ra-navigation#concepts) of the target, and can have a `to` prop corresponding to the target location if different from the app location.
Create a menu component based on `<HorizontalMenu>` and `<HorizontalMenu.Item>` children. Each child should have a `value` corresponding to the [application location](https://react-admin-ee.marmelab.com/documentation/ra-navigation#concepts) of the target, and can have a `to` prop corresponding to the target location if different from the app location.

```jsx
import { HorizontalMenu } from '@react-admin/ra-navigation';
Expand Down
2 changes: 1 addition & 1 deletion docs/CreateDialog.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ npm install --save @react-admin/ra-form-layout
yarn add @react-admin/ra-form-layout
```

**Tip**: [`ra-form-layout`](https://react-admin-ee.marmelab.com/modules/ra-form-layout#createdialog-editdialog--showdialog) is hosted in a private npm registry. You need to subscribe to one of the [Enterprise Edition](https://react-admin-ee.marmelab.com/) plans to access this package.
**Tip**: [`ra-form-layout`](https://react-admin-ee.marmelab.com/documentation/ra-form-layout#createdialog-editdialog--showdialog) is hosted in a private npm registry. You need to subscribe to one of the [Enterprise Edition](https://react-admin-ee.marmelab.com/) plans to access this package.

Then, add the `<CreateDialog>` component as a sibling to a `<List>` component.

Expand Down
2 changes: 1 addition & 1 deletion docs/CreateInDialogButton.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ npm install --save @react-admin/ra-form-layout
yarn add @react-admin/ra-form-layout
```

**Tip**: [`ra-form-layout`](https://react-admin-ee.marmelab.com/modules/ra-form-layout#createindialogbutton-editindialogbutton-and-EditInDialogButton) is hosted in a private npm registry. You need to subscribe to one of the [Enterprise Edition](https://react-admin-ee.marmelab.com/) plans to access this package.
**Tip**: [`ra-form-layout`](https://react-admin-ee.marmelab.com/documentation/ra-form-layout#createindialogbutton-editindialogbutton-and-EditInDialogButton) is hosted in a private npm registry. You need to subscribe to one of the [Enterprise Edition](https://react-admin-ee.marmelab.com/) plans to access this package.

Then, put `<CreateInDialogButton>` wherever you would put a `<CreateButton>`, and use the same children as you would for a `<Create>` component (e.g. a `<SimpleForm>`):

Expand Down
2 changes: 1 addition & 1 deletion docs/DualListInput.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ The form value for the source must be an array of the selected values, e.g.
}
```

Check [the `ra-relationships` documentation](https://react-admin-ee.marmelab.com/modules/ra-relationships) for more details.
Check [the `ra-relationships` documentation](https://react-admin-ee.marmelab.com/documentation/ra-relationships) for more details.

## Props

Expand Down
30 changes: 15 additions & 15 deletions docs/Ecosystem.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,21 +11,21 @@ While most of the react-admin components come from the [marmelab/react-admin](ht

[React-admin Enterprise Edition](https://react-admin-ee.marmelab.com) provides additional packages:

- [@react-admin/ra-ai](https://react-admin-ee.marmelab.com/modules/ra-ai): Components powered by Artificial Intelligence (AI) to boost user productivity. Suggest completion for user inputs, fix and improve large chunks of text in React-Admin forms.
- [@react-admin/ra-audit-log](https://react-admin-ee.marmelab.com/modules/ra-audit-log): Keep track of user actions, and get an overview of the activity of your admin.
- [@react-admin/ra-calendar](https://react-admin-ee.marmelab.com/modules/ra-calendar): Display and manipulate events, drag and resize appointments, and browse a calendar in react-admin apps.
- [@react-admin/ra-editable-datagrid](https://react-admin-ee.marmelab.com/modules/ra-editable-datagrid): Enhance the features of react-admin's `<Datagrid>` component, including an "edit-in-place" experience.
- [@react-admin/ra-enterprise](https://react-admin-ee.marmelab.com/modules/ra-enterprise): Preconfigured components replacing the default react-admin ones to quickly integrate the Enterprise Edition modules.
- [@react-admin/ra-form-layout](https://react-admin-ee.marmelab.com/modules/ra-form-layout): New form layouts for complex data entry tasks (accordion, wizard, autosave, etc.).
- [@react-admin/ra-json-schema-form](https://react-admin-ee.marmelab.com/modules/ra-json-schema-form): Build forms based on a JSON Schema description
- [@react-admin/ra-markdown](https://react-admin-ee.marmelab.com/modules/ra-markdown): Markdown field and Input
- [@react-admin/ra-navigation](https://react-admin-ee.marmelab.com/modules/ra-navigation): New page layouts, Menus layouts, Smart Breadcrumb, and hooks to handle the user location.
- [@react-admin/ra-relationships](https://react-admin-ee.marmelab.com/modules/ra-relationships): A set of alternative inputs and fields to edit relationships, including many-to-many relationships using a join table.
- [@react-admin/ra-rbac](https://react-admin-ee.marmelab.com/modules/ra-rbac): Role-Based Access Control for React-admin apps. This module extends the authProvider to manage roles and fine-grained permissions, and adds replacement for many react-admin components that use these permissions.
- [@react-admin/ra-realtime](https://react-admin-ee.marmelab.com/modules/ra-realtime): Hooks and UI components for collaborative applications where several people work in parallel. It allows publishing and subscribing to real-time events, updating views when another user pushes a change, notifying end users of events, and preventing data loss when two editors work on the same resource concurrently.
- [@react-admin/ra-search](https://react-admin-ee.marmelab.com/modules/ra-search): Plug your search engine and let users search across all resources via a smart Omnibox.
- [@react-admin/ra-tour](https://react-admin-ee.marmelab.com/modules/ra-tour): Guide users through tutorials to showcase and explain important features of your interfaces.
- [@react-admin/ra-tree](https://react-admin-ee.marmelab.com/modules/ra-tree): Tree hooks and components for react-admin. Allows to display, edit, and rearrange tree structures like directories, categories, etc.
- [@react-admin/ra-ai](https://react-admin-ee.marmelab.com/documentation/ra-ai): Components powered by Artificial Intelligence (AI) to boost user productivity. Suggest completion for user inputs, fix and improve large chunks of text in React-Admin forms.
- [@react-admin/ra-audit-log](https://react-admin-ee.marmelab.com/documentation/ra-audit-log): Keep track of user actions, and get an overview of the activity of your admin.
- [@react-admin/ra-calendar](https://react-admin-ee.marmelab.com/documentation/ra-calendar): Display and manipulate events, drag and resize appointments, and browse a calendar in react-admin apps.
- [@react-admin/ra-editable-datagrid](https://react-admin-ee.marmelab.com/documentation/ra-editable-datagrid): Enhance the features of react-admin's `<Datagrid>` component, including an "edit-in-place" experience.
- [@react-admin/ra-enterprise](https://react-admin-ee.marmelab.com/documentation/ra-enterprise): Preconfigured components replacing the default react-admin ones to quickly integrate the Enterprise Edition modules.
- [@react-admin/ra-form-layout](https://react-admin-ee.marmelab.com/documentation/ra-form-layout): New form layouts for complex data entry tasks (accordion, wizard, autosave, etc.).
- [@react-admin/ra-json-schema-form](https://react-admin-ee.marmelab.com/documentation/ra-json-schema-form): Build forms based on a JSON Schema description
- [@react-admin/ra-markdown](https://react-admin-ee.marmelab.com/documentation/ra-markdown): Markdown field and Input
- [@react-admin/ra-navigation](https://react-admin-ee.marmelab.com/documentation/ra-navigation): New page layouts, Menus layouts, Smart Breadcrumb, and hooks to handle the user location.
- [@react-admin/ra-relationships](https://react-admin-ee.marmelab.com/documentation/ra-relationships): A set of alternative inputs and fields to edit relationships, including many-to-many relationships using a join table.
- [@react-admin/ra-rbac](https://react-admin-ee.marmelab.com/documentation/ra-rbac): Role-Based Access Control for React-admin apps. This module extends the authProvider to manage roles and fine-grained permissions, and adds replacement for many react-admin components that use these permissions.
- [@react-admin/ra-realtime](https://react-admin-ee.marmelab.com/documentation/ra-realtime): Hooks and UI components for collaborative applications where several people work in parallel. It allows publishing and subscribing to real-time events, updating views when another user pushes a change, notifying end users of events, and preventing data loss when two editors work on the same resource concurrently.
- [@react-admin/ra-search](https://react-admin-ee.marmelab.com/documentation/ra-search): Plug your search engine and let users search across all resources via a smart Omnibox.
- [@react-admin/ra-tour](https://react-admin-ee.marmelab.com/documentation/ra-tour): Guide users through tutorials to showcase and explain important features of your interfaces.
- [@react-admin/ra-tree](https://react-admin-ee.marmelab.com/documentation/ra-tree): Tree hooks and components for react-admin. Allows to display, edit, and rearrange tree structures like directories, categories, etc.

## Third-Party Packages

Expand Down
2 changes: 1 addition & 1 deletion docs/EditDialog.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ npm install --save @react-admin/ra-form-layout
yarn add @react-admin/ra-form-layout
```

**Tip**: [`ra-form-layout`](https://react-admin-ee.marmelab.com/modules/ra-form-layout#createdialog-editdialog--showdialog) is hosted in a private npm registry. You need to subscribe to one of the [Enterprise Edition](https://react-admin-ee.marmelab.com/) plans to access this package.
**Tip**: [`ra-form-layout`](https://react-admin-ee.marmelab.com/documentation/ra-form-layout#createdialog-editdialog--showdialog) is hosted in a private npm registry. You need to subscribe to one of the [Enterprise Edition](https://react-admin-ee.marmelab.com/) plans to access this package.

Then, add the `<EditDialog>` component as a sibling to a `<List>` component.

Expand Down
2 changes: 1 addition & 1 deletion docs/EditInDialogButton.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ npm install --save @react-admin/ra-form-layout
yarn add @react-admin/ra-form-layout
```

**Tip**: [`ra-form-layout`](https://react-admin-ee.marmelab.com/modules/ra-form-layout#createindialogbutton-editindialogbutton-and-EditInDialogButton) is hosted in a private npm registry. You need to subscribe to one of the [Enterprise Edition](https://react-admin-ee.marmelab.com/) plans to access this package.
**Tip**: [`ra-form-layout`](https://react-admin-ee.marmelab.com/documentation/ra-form-layout#createindialogbutton-editindialogbutton-and-EditInDialogButton) is hosted in a private npm registry. You need to subscribe to one of the [Enterprise Edition](https://react-admin-ee.marmelab.com/) plans to access this package.

Then, put `<EditInDialogButton>` wherever you would put an `<EditButton>`, and use the same children as you would for an [`<Edit>`](./Edit.md) component (e.g. a `<SimpleForm>`):

Expand Down
2 changes: 1 addition & 1 deletion docs/EditTutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -226,7 +226,7 @@ export const BookEdit = () => {
};
```

React-admin proposes alternative form layouts ([`<TabbedForm>`](./TabbedForm.md), [`<AccordionForm>`](./AccordionForm.md), [`<WizardForm>`](./WizardForm.md), [`<CreateDialog>, <EditDialog> & <ShowDialog>`](https://react-admin-ee.marmelab.com/modules/ra-form-layout#createdialog-editdialog--showdialog) as well as a headless [`<Form>`](./Form.md) component.
React-admin proposes alternative form layouts ([`<TabbedForm>`](./TabbedForm.md), [`<AccordionForm>`](./AccordionForm.md), [`<WizardForm>`](./WizardForm.md), [`<CreateDialog>, <EditDialog> & <ShowDialog>`](https://react-admin-ee.marmelab.com/documentation/ra-form-layout#createdialog-editdialog--showdialog) as well as a headless [`<Form>`](./Form.md) component.

### Using Input Components

Expand Down
Loading

0 comments on commit 8cf25fd

Please sign in to comment.