keystone-list-prepend v1.0.1

keystone-list-prepend

This is a rewrite of https://github.com/keystonejs/keystone/blob/master/lib/list/add.js

instead of pushing fields to the end of the List, it unshifts them to the beginning.

why?

If you inherit from a List and add fields into it, they'll always end up at the end of the screen in the admin UI. Mostly, you are inheriting from a List because it has some default fields. You don't want these fields on top in your admin UI, but you want the List specific fields first. By unshifting, you can add fields to the top of the page.

How to use

This package injects a function on the List prototype in keystone. Use it like .add, e.g.:

const MyList = keystone.List('MyList');
MyList.prepend({
  newField: {
    type: String
  }
});
MyList.register();

This feature makes the most sense with inherits:

const BaseList = keystone.List('BaseList');
BaseList.add({
  name: {
    type: String
  },
  originalField: {
    type: String
  }
});
BaseList.register();

const MyList = keystone.List('MyList', {
  inherits: BaseList,
});
MyList.prepend({
  topField: {
    type: String,
  }
});
MyList.register();

topField will now be shown before originalField in the admin UI.

installation

This package will register itself onto the prototype of the given keystone instance. Just require (or import) it and pass it keystone:

const keystone = require('keystone');
require('keystone-list-prepend')(keystone);