admin-config

0.12.4 verified Fri May 01 auth: no javascript maintenance

Shared configuration and entity definitions for ng-admin and react-admin, two admin-panel generators by marmelab. Version 0.12.4 (latest as of 2021) provides ES6 classes for fields, references, and validation used across both frameworks. The package has been in maintenance mode since 2017, with no active development. It requires a transpiler (Babel) for use in Node.js or bundlers. Designed as an internal dependency, it is not intended for direct use in application code.

Common errors

error Cannot find module 'admin-config' ↓

cause Package does not have a main entry point; must import from subpath.

fix

Use 'import Field from 'admin-config/lib/Field/Field'' instead of 'import { Field } from 'admin-config'.

error Unexpected token import ↓

cause Package uses ES6 modules without transpilation in older Node/bundler setups.

fix

Configure transpiler (e.g., Babel) to process files under node_modules/admin-config.

error Cannot find module 'babel-preset-es2015' ↓

cause Missing Babel preset when transpiling admin-config in a project.

fix

Install babel-preset-es2015 and add it to your .babelrc or webpack config.

Warnings

breaking Package is not directly importable via 'admin-config' entry point; all imports must be from subpaths under lib/. ↓

fix Use deep imports like 'admin-config/lib/Field/NumberField'.

deprecated Package is in maintenance mode; no new features added. Use react-admin or ng-admin directly. ↓

fix Avoid depending on admin-config directly; it is an internal dependency.

gotcha Requires transpilation (Babel) for ES6 code; not shipped as ES5. ↓

fix Add babel loader for node_modules/admin-config in webpack config.

Install

npm install admin-config

yarn add admin-config

pnpm add admin-config

Imports

NumberField

wrong

const NumberField = require('admin-config/lib/Field/NumberField')

correct

import NumberField from 'admin-config/lib/Field/NumberField'

Deep import from lib folder required; package does not expose a main index.

ReferenceField

wrong

import { ReferenceField } from 'admin-config'

correct

import ReferenceField from 'admin-config/lib/Field/ReferenceField'

No barrel exports; must import individual files from lib/Field/.

Validation

wrong

const adminConfig = require('admin-config')

correct

import Validation from 'admin-config/lib/Validation'

Validation class is at admin-config/lib/Validation.

Field

wrong

import { Field } from 'admin-config'

correct

import Field from 'admin-config/lib/Field/Field'

Base Field class; all field types are subclasses under lib/Field/

Quickstart

Demonstrates importing NumberField and Validation classes from deep paths and using them with validation (ES6 modules).

// Install: npm install admin-config
// Note: This package is meant for ng-admin/react-admin internal use.
// To use a field class:
import NumberField from 'admin-config/lib/Field/NumberField';

const myField = new NumberField('price');
console.log(myField.name()); // 'price'
myField.label('Price');
console.log(myField.label()); // 'Price'

// For validation:
import Validation from 'admin-config/lib/Validation';
const validation = new Validation({ min: 0, max: 1000 });
console.log(validation.isValid(50)); // true
console.log(validation.isValid(2000)); // false