https://github.com/laurenskling/keystone-list-prepend

add prepend method to keystone.List() to unshift the given fields into the list
https://github.com/laurenskling/keystone-list-prepend

Last synced: 3 days ago
JSON representation

add prepend method to keystone.List() to unshift the given fields into the list

• Host: GitHub
• URL: https://github.com/laurenskling/keystone-list-prepend
• Owner: laurenskling
• Created: 2018-12-18T18:17:05.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2018-12-18T19:26:17.000Z (almost 6 years ago)
• Last Synced: 2024-10-03T15:06:52.470Z (about 1 month ago)
• Language: JavaScript
• Size: 4.88 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# keystone-list-prepend

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

instead of `push`ing fields to the end of the List, it `unshift`s 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);

```