Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Add ra-enterprise packages to Ecosystem documentation #5284

Merged
merged 4 commits into from
Sep 24, 2020
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
27 changes: 17 additions & 10 deletions docs/Ecosystem.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,19 @@ title: "Ecosystem"

# Ecosystem

- [Inputs and Fields](#inputs-and-fields)
- [Translations](#translations)
- [Authentication Providers](#authentication-providers)
- [Authorization Management](#authorization-management)
- [Data Providers](#data-providers)
- [User Interface](#user-interface)
- [Miscellaneous](#miscellaneous)
- [List Related Components](#list-related-components)
- [Fields](#fields)
- [Inputs](#inputs)
- [Translations](#translations)
- [Authentication Providers](#authentication-providers)
- [Authorization Management](#authorization-management)
- [Data Providers](#data-providers)
- [User Interface](#user-interface)
- [Miscellaneous](#miscellaneous)

## List Related Components

See the [List](./List.md#third-party-components) page.

## Fields

Expand Down Expand Up @@ -45,9 +51,10 @@ See the [Data Provider](./DataProviders.md#available-providers) page.

## Miscellaneous

- [marmelab/ra-tree-ui-materialui](https://github.com/marmelab/react-admin/blob/master/packages/ra-tree-ui-materialui/): Components to show data represented as a tree. Only compatible with react-admin v2 for now.
- [marmelab/ra-tree-core](https://github.com/marmelab/react-admin/blob/master/packages/ra-tree-core/): Components providing the logic but no UI to show data represented as a tree. Only compatible with react-admin v2 for now.
- [ra-customizable-datagrid](https://github.com/fizix-io/ra-customizable-datagrid): plugin that allows to hide / show columns dynamically.
- [@react-admin/ra-preferences](https://marmelab.com/ra-enterprise/modules/ra-preferences) <img class="icon" src="./img/premium.svg" />: a [ra-enterprise](https://marmelab.com/ra-enterprise) module which persists user preferences (language, theme, filters, datagrid columns, sidebar position, etc) in local storage.
- [@react-admin/ra-navigation](https://marmelab.com/ra-enterprise/modules/ra-navigation) <img class="icon" src="./img/premium.svg" />: a [ra-enterprise](https://marmelab.com/ra-enterprise) module which offers specialized UI components (`<Breadcrumb>`, `<MultiLevelMenu>`) and hooks (`useDefineAppLocation`, `useAppLocationstate`) to organize pages in a tree structure, and provide navigation widgets () to help users find their way in that structure.
- [@react-admin/ra-realtime](https://marmelab.com/ra-enterprise/modules/ra-realtime) <img class="icon" src="./img/premium.svg" />: a [ra-enterprise](https://marmelab.com/ra-enterprise) module which provides hooks and UI components to lock records, live update views when a change occurs in the background, and notify the user of these events.
- [@react-admin/ra-tour](https://marmelab.com/ra-enterprise/modules/ra-tour) <img class="icon" src="./img/premium.svg" />: a [ra-enterprise](https://marmelab.com/ra-enterprise) module which provides a way to guide users through tutorials to showcase and explain important features of your interfaces.
- [FusionWorks/react-admin-google-maps](https://github.com/FusionWorks/react-admin-google-maps): Input/view components for displaying location using Google Maps.
- [api-platform/admin](https://api-platform.com/docs/admin): create a fully featured admin using React Admin for API supporting the [Hydra Core Vocabulary](https://www.hydra-cg.com/), including but not limited to APIs created using the [API Platform framework](https://api-platform.com)
- [zifnab87/ra-component-factory](https://github.com/zifnab87/ra-component-factory): a centralized configuration of immutability/visibility of fields/menu-links/action buttons, easy re-ordering of fields/properties and tab reorganization based on permission roles
Expand Down
3 changes: 2 additions & 1 deletion docs/Fields.md
Original file line number Diff line number Diff line change
Expand Up @@ -1064,9 +1064,10 @@ PriceField.defaultProps = {

You can find components for react-admin in third-party repositories.

- [MarkdownField](https://marmelab.com/ra-enterprise/modules/ra-markdown#markdownfield) from [@react-admin/ra-markdown](https://marmelab.com/ra-enterprise/modules/ra-markdown) <img class="icon" src="./img/premium.svg" />: a [ra-enterprise](https://marmelab.com/ra-enterprise) component which can display markdown content.
- [ReferenceManyToManyField](https://marmelab.com/ra-enterprise/modules/ra-relationships#referencemanytomanyfield) from [@react-admin/ra-relationships](https://marmelab.com/ra-enterprise/modules/ra-relationships) <img class="icon" src="./img/premium.svg" />: a [ra-enterprise](https://marmelab.com/ra-enterprise) component which fetches a list of referenced records by lookup in an associative table, and passes the records down to its child component, which must be an iterator component.
- [OoDeLally/react-admin-clipboard-list-field](https://github.com/OoDeLally/react-admin-clipboard-list-field): a quick and customizable copy-to-clipboard field.


## Writing Your Own Field Component

If you don't find what you need in the list above, you can write your own Field component. It must be a regular React component, accepting not only a `source` attribute, but also a `record` attribute. React-admin will inject the `record` based on the API response data at render time. The field component only needs to find the `source` in the `record` and display it.
Expand Down
3 changes: 3 additions & 0 deletions docs/Inputs.md
Original file line number Diff line number Diff line change
Expand Up @@ -1465,6 +1465,9 @@ const dateParser = v => {

You can find components for react-admin in third-party repositories.

- [MarkdownInput](https://marmelab.com/ra-enterprise/modules/ra-markdown) from [@react-admin/ra-markdown](https://marmelab.com/ra-enterprise/modules/ra-markdown) <img class="icon" src="./img/premium.svg" />: a [ra-enterprise](https://marmelab.com/ra-enterprise) component which allows to edit markdown content with a WYSIWYG editor.
- [DualListInput](https://marmelab.com/ra-enterprise/modules/ra-relationships#duallistinput) from [@react-admin/ra-relationships](https://marmelab.com/ra-enterprise/modules/ra-relationships) <img class="icon" src="./img/premium.svg" />: a [ra-enterprise](https://marmelab.com/ra-enterprise) component which allows to select from a list of choices using two lists.
- [ReferenceManyToManyInput](https://marmelab.com/ra-enterprise/modules/ra-relationships#referencemanytomanyinput) from [@react-admin/ra-relationships](https://marmelab.com/ra-enterprise/modules/ra-relationships) <img class="icon" src="./img/premium.svg" />: a [ra-enterprise](https://marmelab.com/ra-enterprise) component which allows to create, edit or remove relationships between two resources sharing an associative table.
- [vascofg/react-admin-color-input](https://github.com/vascofg/react-admin-color-input): a color input using [React Color](https://casesandberg.github.io/react-color/), a collection of color pickers.
- [vascofg/react-admin-date-inputs](https://github.com/vascofg/react-admin-date-inputs): a collection of Date Inputs, based on [material-ui-pickers](https://material-ui-pickers.firebaseapp.com/)
- [maluramichael/ra-input-markdown](https://github.com/maluramichael/ra-input-markdown): a markdown editor, based on [react-mde](https://github.com/andrerpena/react-mde) and [showdown](https://github.com/showdownjs/showdown)
Expand Down
8 changes: 8 additions & 0 deletions docs/List.md
Original file line number Diff line number Diff line change
Expand Up @@ -2395,6 +2395,14 @@ export const CommentList = (props) => (

As you can see, nothing prevents you from using `<Field>` components inside your own components... provided you inject the current `record`. Also, notice that components building links require the `basePath` component, which is also available from `useListContext`.

## Third-Party Components

You can find components for react-admin in third-party repositories.

- [ra-editable-datagrid](https://marmelab.com/ra-enterprise/modules/ra-editable-datagrid) <img class="icon" src="./img/premium.svg" />: a [ra-enterprise](https://marmelab.com/ra-enterprise) component which offers an "edit-in-place" experience in a `<Datagrid>`.
- [ra-tree](https://marmelab.com/ra-enterprise/modules/ra-tree) <img class="icon" src="./img/premium.svg" />: tree hooks and components from the [ra-enterprise](https://marmelab.com/ra-enterprise) package. This module is agnostic as to how you store the tree structure in the backend side.
- [ra-customizable-datagrid](https://github.com/fizix-io/ra-customizable-datagrid): plugin that allows to hide / show columns dynamically.

## Displaying Fields Depending On The User Permissions

You might want to display some fields or filters only to users with specific permissions.
Expand Down
11 changes: 11 additions & 0 deletions docs/css/style-v5.css
Original file line number Diff line number Diff line change
Expand Up @@ -394,3 +394,14 @@ ul.sidenav code {
margin: 10px 0 10px 20px;
font-size: 16px;
}

.markdown-section .icon {
box-shadow: none;
margin: 0;
width: 32px;
height: 32px;
transform: translate(0, 40%);
margin-top: -16px;
margin-left: -4px;
margin-right: -4px;
}
1 change: 1 addition & 0 deletions docs/img/premium.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.