Registry / prod-utils / admin-on-rest

admin-on-rest

JSON →
library1.4.1jsnpmunverified

A deprecated frontend framework for building admin applications on top of REST services, using ES6, React, and Material UI. v1.4.1 (latest) - No longer actively maintained; replaced by react-admin (v3+). Release cadence was irregular. Key differentiators included optimistic rendering, relationship support, and i18n. Last release in 2018. Do not use for new projects.

npm install admin-on-rest
INSTALL
IMPORT
SIG · ADMIN-ON-REST
A
admin-on-rest
prod-utilsjavascriptv1.4.1
harness data pending
Install & Compatibility
Where this runs

No compatibility data collected yet for this library.

Code
Verified usage

Verified import paths — ran on the pinned version, not inferred.

Admin
import { Admin } from 'admin-on-rest';
const Admin = require('admin-on-rest').Admin;
ESM default export? This is a named export. Avoid require().
Resource
import { Resource } from 'admin-on-rest';
import Resource from 'admin-on-rest';
Resource is a named export, not default.
List
import { List } from 'admin-on-rest';
import { List } from 'admin-on-rest/lib/mui/list';
Do not import from internal paths; they may change.
simpleRestClient
import { simpleRestClient } from 'admin-on-rest';
import simpleRestClient from 'admin-on-rest';
Named export.
TextField
import { TextField } from 'admin-on-rest';
Works as expected.

Minimal admin app with a resource 'posts' using a simple REST client and a datagrid list view.

import React from 'react'; import { render } from 'react-dom'; import { simpleRestClient, Admin, Resource, List, Datagrid, TextField } from 'admin-on-rest'; const PostList = (props) => ( <List {...props}> <Datagrid> <TextField source="id" /> <TextField source="title" /> </Datagrid> </List> ); const App = () => ( <Admin restClient={simpleRestClient('http://localhost:3000')}> <Resource name="posts" list={PostList} /> </Admin> ); render(<App />, document.getElementById('root'));
Debug
Known issues
gotchaPackage is deprecated. Last release 2018. Use react-admin instead.
fix
Migrate to react-admin (react-admin.com).
affects: >=1.0.0
deprecatedsimpleRestClient may not work with modern API conventions. Use jsonServerRestClient in react-admin.
fix
Migrate to react-admin and use its REST clients.
affects: >=1.0.0
breakingReact 15.4 or 16.0 beta required. Not compatible with React 16.2+ or 17.
fix
Use React 15.4 or 16.0 beta. Upgrade to react-admin for newer React.
affects: >=1.0.0
gotchaMaterial UI v0.x peer dependency. Not compatible with Material-UI v1+.
fix
Use compatible version of material-ui (0.x).
affects: >=1.0.0
deprecatedAlternative for react-autosuggest may be missing; some UI components deprecated since v1.3.
fix
Check release notes for component replacements.
affects: >=1.3.0
gotchaNo built-in support for GraphQL or advanced auth flows. Limited extensibility.
fix
Switch to react-admin for full feature set.
affects: >=1.0.0
Errors
Common errors & fixes
Error: Cannot find module 'admin-on-rest'
Package not installed.
fix
npm install --save-dev admin-on-rest
Warning: React version mismatch. Expected >=15.4.0 || ^16.0.0-beta.5
Incompatible React version.
fix
Install React 15.4 or 16.0.0-beta.5 exactly.
TypeError: Cannot destructure property 'stringify' of ...
Missing dependency 'query-string'.
fix
npm install query-string@5 (v6+ incompatible).
Module not found: Can't resolve 'material-ui'
Material-UI not installed.
fix
npm install material-ui@0.x
admin-on-rest: 'getMuiTheme' is not exported from 'material-ui/styles'
Material-UI v0.x not installed.
fix
Ensure material-ui version is 0.x, not 1+.
Upgrade
Version history
1.4.1latest on npm
Audit
Dependencies
reactrequiredRequired as peer dependency for component rendering.
react-domrequiredRequired as peer dependency for DOM rendering.
material-uioptionalUsed internally for UI components; must be installed separately.
Agent activity
4 hits · last 30 days
node
4
Resources