How marmelab/react-admin works
react-admin is a React framework for building browser-based administration apps over REST or GraphQL APIs. The principal workflow configures an Admin with Resources, routes a user to a resource page, loads and displays records, and lets the user create or edit them through forms and a data-provider adapter. The graph also preserves documented capabilities such as access control, filtering, relationships, export, internationalization, notifications, and theming. Most relationships are grounded in README statements or SOURCE INDEX references; unsampled subsystems are shown without speculative call chains.
Main entry points: useListController.ts List controller · useGetList.ts Data operations · Resource.tsx Resource routes · useEditController.ts Create edit show
Components 21
Admin application
- Admin entry
packages/react-admin/src/Admin.tsx - Resource routes
packages/ra-core/src/core/Resource.tsx - Router providers
packages/ra-core/src/routing/RouterProviderContext.tsx
Resource workflows
- List controller
packages/ra-core/src/controller/list/useListController.ts - List query state
packages/ra-core/src/controller/list/queryReducer.ts - Data grid
packages/ra-ui-materialui/src/list/datagrid/Datagrid.tsx - Create edit show
packages/ra-core/src/controller/edit/useEditController.ts - Forms and validation
packages/ra-core/src/form/Form.tsx - Related records
packages/ra-core/src/controller/field/useReferenceManyFieldController.ts - Bulk export
packages/ra-core/src/export/useBulkExport.ts
Core services
- Authentication access
packages/ra-core/src/auth/WithPermissions.tsx - Data operations
packages/ra-core/src/dataProvider/useGetList.ts - Mutation behavior
packages/ra-core/src/dataProvider/useMutationWithMutationMode.ts - Notifications
packages/ra-core/src/notification/NotificationContextProvider.tsx - Internationalization
packages/ra-core/src/i18n/I18nContextProvider.tsx - Preferences
packages/ra-core/src/preferences/usePreference.ts
Adapters and UI
- REST providers
packages/ra-data-simple-rest/src/index.ts - GraphQL providers
packages/ra-data-graphql-simple/src/buildQuery.ts - Material UI
packages/ra-ui-materialui/src/list/datagrid/Datagrid.tsx
Other components
- Admin user
- REST GraphQL API
Connections 22
- Admin user → Admin entry: opens app
- Admin entry → Resource routes: configures resources
- Resource routes → Router providers: routes pages
- Resource routes → List controller: renders list
packages/ra-core/src/controller/list/useListController.ts - Resource routes → Create edit show: renders record pages
- List controller → List query state: uses query state
packages/ra-core/src/controller/list/useListController.ts - List controller → Data operations: loads records
packages/ra-core/src/controller/list/useListController.ts - List controller → Authentication access: checks access
packages/ra-core/src/controller/list/useListController.ts - List controller → Data grid: provides list data
- Data grid → Material UI: renders with
- Create edit show → Data operations: loads record
packages/ra-core/src/controller/edit/useEditController.ts - Create edit show → Mutation behavior: saves changes
packages/ra-core/src/controller/edit/useEditController.ts - Create edit show → Forms and validation: uses form
- Related records → Data operations: loads related records
packages/ra-core/src/controller/field/useReferenceManyFieldController.ts - Bulk export → Data operations: fetches export data
- Data operations → REST providers: dispatches REST calls
- Data operations → GraphQL providers: dispatches GraphQL calls
- REST providers → REST GraphQL API: queries
- GraphQL providers → REST GraphQL API: queries
- Authentication access → Notifications: reports access errors
- Admin entry → Internationalization: configures translations
- List controller → Preferences: supports saved queries