
  • Documentation
  • Demos
  • Blog
  • Enterprise Edition
  • 4.16
    • latest (5.8.0)
    • 5.7
    • 5.6
    • 5.5
    • 5.4
    • 5.3
    • 5.2
    • 5.1
    • 5.0
    • 4.16
    • 3.19
    • 2.9
    • Older versions
    • Getting Started
    • Tutorial
    • Features
    • Key concepts
    • What's new?
    • Create React Admin
    • Vite
    • Next.js
    • Remix
    • Community
    • Upgrading to v4
      App Configuration
    • <Admin>
    • <Resource>
    • <CustomRoutes>
      Data Fetching
    • Introduction
    • Supported backends
    • Writing A Data Provider
    • Querying the API
    • Real-time Updates & Locks
    • useDataProvider
    • useGetList
    • useInfiniteGetList
    • useGetOne
    • useGetMany
    • useGetManyReference
    • useCreate
    • useUpdate
    • useUpdateMany
    • useDelete
    • useDeleteMany
    • useGetTree
    • withLifecycleCallbacks
    • fetchJson
      Security
    • Introduction
    • Supported backends
    • Writing An Auth Provider
    • Permissions
    • RBAC
    • <Authenticated>
    • <IfCanAccess>
    • <WithPermissions>
    • useAuthProvider
    • useAuthenticated
    • useAuthState
    • useGetIdentity
    • useLogin
    • useLogout
    • usePermissions
    • useCanAccess
    • canAccess
    • addRefreshAuthToAuthProvider
    • addRefreshAuthToDataProvider
      List Page
    • Introduction
    • Filtering The List
    • <List>
    • <ListBase>
    • <ListGuesser>
    • <InfiniteList>
    • <TreeWithDetails>
    • <Datagrid>
    • <DatagridAG>
    • <SimpleList>
    • <SingleFieldList>
    • <EditableDatagrid>
    • <Calendar>
    • <FilterButton>
    • <FilterList>
    • <FilterLiveSearch>
    • <SavedQueriesList>
    • <StackedFilters>
    • <Pagination>
    • <SortButton>
    • <SelectColumnsButton>
    • <Count>
    • <WithListContext>
    • useListContext
    • useList
    • useListController
    • useUnselect
    • useUnselectAll
      Creation & Edition Pages
    • Introduction
    • Form Validation
    • <Create>
    • <CreateBase>
    • <Edit>
    • <EditBase>
    • <EditGuesser>
    • <SimpleForm>
    • <TabbedForm>
    • <Form>
    • <LongForm>
    • <AccordionForm>
    • <WizardForm>
    • <EditDialog>
    • <EditInDialogButton>
    • <CreateDialog>
    • <CreateInDialogButton>
    • <JsonSchemaForm>
    • <Toolbar>
    • <SaveButton>
    • <AutoSave>
    • useCreateContext
    • useCreateController
    • useEditContext
    • useEditController
    • useSaveContext
    • useRegisterMutationMiddleware
    • useUnique
      Show Page
    • Introduction
    • <Show>
    • <ShowBase>
    • <ShowGuesser>
    • <SimpleShowLayout>
    • <TabbedShowLayout>
    • <Labeled>
    • <ShowInDialogButton>
    • useShowContext
    • useShowController
      Common
    • <WithRecord>
    • useRecordContext
    • useGetRecordId
    • useNotify
    • useRedirect
    • useRefresh
      Fields
    • Introduction
    • Fields for Relationships
    • <ArrayField>
    • <BooleanField>
    • <ChipField>
    • <DateField>
    • <EmailField>
    • <FileField>
    • <FunctionField>
    • <ImageField>
    • <MarkdownField>
    • <NumberField>
    • <ReferenceField>
    • <ReferenceArrayField>
    • <ReferenceManyField>
    • <ReferenceManyCount>
    • <ReferenceManyToManyField>
    • <ReferenceOneField>
    • <RichTextField>
    • <SelectField>
    • <TextField>
    • <TranslatableFields>
    • <UrlField>
    • <WrapperField>
      Inputs
    • Introduction
    • <ArrayInput>
    • <AutocompleteInput>
    • <AutocompleteArrayInput>
    • <BooleanInput>
    • <CheckboxGroupInput>
    • <DateInput>
    • <DateTimeInput>
    • <DualListInput>
    • <FileInput>
    • <ImageInput>
    • <MarkdownInput>
    • <NullableBooleanInput>
    • <NumberInput>
    • <PasswordInput>
    • <PredictiveTextInput>
    • <RadioButtonGroupInput>
    • <ReferenceInput>
    • <ReferenceArrayInput>
    • <ReferenceManyInput>
    • <ReferenceManyToManyInput>
    • <ReferenceNodeInput>
    • <ReferenceOneInput>
    • <RichTextInput>
    • <SearchInput>
    • <SelectInput>
    • <SelectArrayInput>
    • <SimpleFormIterator>
    • <SmartRichTextInput>
    • <TextInput>
    • <TimeInput>
    • <TranslatableInputs>
    • <TreeInput>
    • useInput
      Preferences
    • Introduction
    • useStore
    • useRemoveFromStore
    • useResetStore
    • useStoreContext
    • <Configurable>
      I18N Provider and Translations
    • Introduction
    • Setting Up
    • Supported Locales
    • Translating UI Components
    • Writing an i18nProvider
    • useTranslate
    • useLocaleState
    • <LocalesMenuButton>
      Other UI components
    • <Layout>
    • <ContainerLayout>
    • <SolarLayout>
    • <AppBar>
    • <Menu>
    • <MultiLevelMenu>
    • <IconMenu>
    • <Title>
    • <Breadcrumb>
    • <Search>
    • <SearchWithResult>
    • <Confirm>
    • Buttons
    • <RevisionsButton>
    • <CheckForApplicationUpdate>
    • <UpdateButton>
    • <RecordRepresentation>
    • <PrevNextButtons>
    • useDefineAppLocation
    • useGetRecordRepresentation
      Theming
    • Introduction
    • The sx prop
    • Application Theme
    • <Box>, <Stack> and <Grid>
    • <ToggleThemeButton>
    • useMediaQuery
    • useTheme
      Realtime
    • Introduction
    • Data Provider Requirements
    • usePublish
    • useSubscribe
    • useSubscribeCallback
    • useSubscribeToRecord
    • useSubscribeToRecordList
    • useLock
    • useUnlock
    • useGetLock
    • useGetLockLive
    • useGetLocks
    • useGetLocksLive
    • useLockOnMount
    • useLockOnCall
    • useGetListLive
    • useGetOneLive
    • <ListLive>
    • <EditLive>
    • <ShowLive>
    • <MenuLive>
      Recipes
    • Caching
    • Routing
    • Unit Testing
    • Advanced tutorials
  • Ecosystem
  • FAQ
  • Index
  • Beginner mode is on. Turn it off to reveal more documentation for advanced components.

Getting Started

30 minutes tutorial, installation instructions


App configuration

<Admin>, <Resource> and routing explained.


Data Fetching

Plugging in a REST or GraphQL API with dataProvider


Security

Authentication, roles and permissions with authProvider


List pages

<List>, <Datagrid>, filters, sorting, etc.


Forms & Edition pages

<Edit>, <Create>, <Form>, validation, etc.


Show pages

<Show>, <SimpleShowLayout>, etc.


Common Hooks

useRecordContext, useNotify, useRedirect, etc.


Fields

<TextField>, <SelectField>, <ReferenceField>, etc.


Inputs

<TextInput>, <DateInput>, <AutocompleteInput>, etc.


Preferences

useStore and configurable components


I18N

Localize the interface in multiple languages


UI components

App building blocks: <Menu>, <Breadcrumb>, <Button>, etc.


Theming

Customizing the look and feel


Realtime

Pub/Sub, live updates, menu badges, locks.


Recipes

For advanced configuration

Need help with your React-admin app?
Turn to Marmelab, its creators and seasoned full-stack JS development agency.
Get in touch to hire an expert for a day, or a team for a month.