Skip to content

Latest commit

 

History

History
89 lines (61 loc) · 3.1 KB

UPGRADE-0.7.md

File metadata and controls

89 lines (61 loc) · 3.1 KB
Raw

Upgrade to 0.7

Field factory

ng-admin 0.7 breaks compatibility with 0.5 and makes the "factories" configuration API compulsory. If your configuration uses nga.field(), it will still work woth 0.7. If it uses new Field(), you'll need to follow the 0.6 upgrade guide.

Field type

The Field.type(type) method is no longer supported as a setter. Instead, you should specify the type as the second argument in the nga.field() factory.

- nga.field('created_at').type('date')
+ nga.field('created_at', 'date')

perPage instead of limit

Dashboard view limit() method has been deprecated. Please use the perPage method instead.

Internal Routing Pattern Was Changed

You may have noticed the ng-admin used an internal URL scheme looking like the following:

#/list/posts/
#/create/posts/
#/edit/posts/12
#/delete/posts/12

In 0.7, the internal URL scheme is more natural:

#/posts/list
#/posts/create
#/posts/edit/12
#/posts/delete/12

If you have set custom directives linking to existing ng-admin internal URLs ("states"), you must update them to use the new syntax.

menuView() Is Deprecated

Prior to 0.7, you would customize the appearance of an entity in the menu sidebar using entity.menuView() methods.

post.menuView()
  .order(1)
  .icon('<span class="glyphicon glyphicon-file"></span>');

This menuView() is deprecated in 0.7.

By default, the sidebar menu is still built automatically based on the entities added to the application. But to change the menu, you have to manipulate the main Menu instance. Menu is a new class, with a simple structure, allowing to setup menus and submenus ("child" menus), independently of entities. For instance, you can customize the title and icon of a single menu using the following syntax:

admin.addEntity(post)
admin.menu().getChildByTitle('Post')
    .title('Posts')
    .icon('<span class="glyphicon glyphicon-file"></span>');

However, if the default menu doesn't suit you, it is recommended to build the menu from scratch, as follows:

admin.menu(nga.menu()
  .addChild(nga.menu(post))
  .addChild(nga.menu(comment).title('Comments'))
  .addChild(nga.menu(tag).icon('<span class="glyphicon glyphicon-tags"></span>'))
);

Adding menu children by hand is also the only way to determine the menu order.

The menuView() syntax will still be supported in this version, but removed in the next one.

Passing Object Literal to View.fields() and Using field.order Are Deprecated

Calling view.fields() as a getter (with no argument) used to return an object literal ; starting with 0.7, it now returns an array. Symmetrically, passing an object litteral as argument to the setter methor view.fields(fields) is deprecated ; only arrays are now officially supported.

Additionaly, the order() method, which served to order fields passed in object literal form, is also deprecated.

The proper way to use fields() is to pass an array of fields.

fields([field1, field2])
fields([field1, [field2, field3]])