This repository has been archived by the owner. It is now read-only.
Configuration API to describe an administration interface. Used by ng-admin and react-admin.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
src
tests
.gitignore
.npmignore
.travis.yml
Makefile
README.md
package.json

README.md

admin-config Build Status

Common files used in both ng-admin and ng-admin-react.

Installation

make install

Including In Another Library

Require whatever class you need directly.

// es5
var NumberField = require('admin-config/lib/Field/NumberField');
// es6
import NumberField from "admin-config/lib/Field/NumberField";

Admin-config is written in ES6. You'll need a transpiler to use any of the classes (we recommend Webpack and babel). Here is an example Webpack configuration:

module.exports = {
    // ...
    module: {
        loaders: [
            { test: /node_modules\/admin-config\/.*\.js$/, loader: 'babel' }
        ]
    }
};

Transpiling

In order to increase this library compatibility and to not force other users of this library to use Babel, you need to transpile your ES6 code from src/ to good old ES5 code (in lib/).

Just run:

make transpile

And you are done!

Running Tests

make test