Skip to content

Commit

Permalink
[BC BREAK] Rename main view to ng-admin
Browse files Browse the repository at this point in the history
  • Loading branch information
@fzaninotto
fzaninotto committed Sep 19, 2016
1 parent cc21984 commit efa2374
Show file tree
Hide file tree
Showing 7 changed files with 72 additions and 22 deletions.
4 changes: 2 additions & 2 deletions README.md
View file
Expand Up @@ -74,7 +74,7 @@ If you don't have a module bundler, don't worry: you can still include `ng-admin

## Bootstraping your Admin

Just add a `<div ui-view>` into your HTML, add a `ng-app` attribute on your `body`, and configure the admin:
Add the `ng-admin.min.css` and `ng-admin.min.js` to the HTML, add a `<div ui-view="ng-admin">`, and configure the admin:

``` html
<!doctype html>
Expand All @@ -84,7 +84,7 @@ Just add a `<div ui-view>` into your HTML, add a `ng-app` attribute on your `bod
<link rel="stylesheet" href="node_modules/ng-admin/build/ng-admin.min.css">
</head>
<body ng-app="myApp">
<div ui-view></div>
<div ui-view="nh-admin"></div>
<script src="node_modules/ng-admin/build/ng-admin.min.js"></script>
<script type="text/javascript">
var myApp = angular.module('myApp', ['ng-admin']);
Expand Down
46 changes: 46 additions & 0 deletions UPGRADE-1.0.md
View file
@@ -1,5 +1,51 @@
# Upgrade to 1.0

## [BC Break] ng-admin now attaches to a named view

Ng-admin used to attach to the following element in your main `index.html`:

```js
<div ui-view></div>
```

Starting with 1.0, you now have to name the ui-view of ng-admin:

```js
<div ui-view="ng-admin">
```

Not upgrading your `index.html` will result in a blank page.

## [BC Break] Custom pages must use declare 'ng-admin' as parent instead of 'main'

If you added [custom pages](doc/Custom-pages.md), you probably declared a route with a `parent: 'main'`. The main view isn't named 'parent' anymore, but 'ng-admin'. Therefore, all the state definitions for custom pages must be updated:

```js
// from
myApp.config(function ($stateProvider) {
$stateProvider.state('send-post', {
parent: 'main',
url: '/sendPost/:id',
params: { id: null },
controller: sendPostController,
controllerAs: 'controller',
template: sendPostControllerTemplate
});
});

// to
myApp.config(function ($stateProvider) {
$stateProvider.state('send-post', {
parent: 'ng-admin', // <= this has changed
url: '/sendPost/:id',
params: { id: null },
controller: sendPostController,
controllerAs: 'controller',
template: sendPostControllerTemplate
});
});
```

## Angular 1.4

Previous versions of ng-admin relied on Angular 1.3. Version 1.0 bumps the angular version requirement to 1.4.
Expand Down
4 changes: 2 additions & 2 deletions doc/Custom-pages.md
View file
Expand Up @@ -9,7 +9,7 @@ ng-admin uses [AngularUI Router](https://github.com/angular-ui/ui-router) to def
```js
myApp.config(function ($stateProvider) {
$stateProvider.state('send-post', {
parent: 'main',
parent: 'ng-admin',
url: '/sendPost/:id',
params: { id: null },
controller: sendPostController,
Expand All @@ -19,7 +19,7 @@ myApp.config(function ($stateProvider) {
});
```

Here the `controllerAs` property defines the name of the controller in the template. Also worth noting: `parent: 'main'` means that the "send-post" page will be displayed inside the main layout.
Here the `controllerAs` property defines the name of the controller in the template. Also worth noting: `parent: 'ng-admin'` means that the "send-post" page will be displayed inside the main ng-admin layout.

## Page Controller and Template

Expand Down
6 changes: 3 additions & 3 deletions examples/blog/config.js
View file
Expand Up @@ -579,7 +579,7 @@

app.config(['$stateProvider', function ($stateProvider) {
$stateProvider.state('send-post', {
parent: 'main',
parent: 'ng-admin',
url: '/sendPost/:id',
params: { id: null },
controller: sendPostController,
Expand All @@ -590,15 +590,15 @@

// custom page with menu item
var customPageTemplate = '<div class="row"><div class="col-lg-12">' +
'<ma-view-actions><ma-back-button></ma-back-button></ma-view-actions>' +
'<div class="page-header">' +
'<ma-view-actions><ma-back-button></ma-back-button></ma-view-actions>' +
'<h1>Stats</h1>' +
'<p class="lead">You can add custom pages, too</p>' +
'</div>' +
'</div></div>';
app.config(['$stateProvider', function ($stateProvider) {
$stateProvider.state('stats', {
parent: 'main',
parent: 'ng-admin',
url: '/stats',
template: customPageTemplate
});
Expand Down
2 changes: 1 addition & 1 deletion examples/blog/index.html
View file
Expand Up @@ -12,7 +12,7 @@
</style>
</head>
<body ng-app="myApp" ng-strict-di>
<div ui-view></div>
<div ui-view="ng-admin"></div>
<script src="build/fakerest.js" type="text/javascript"></script>
<script src="build/sinon-server.js" type="text/javascript"></script>
<script src="data.js" type="text/javascript"></script>
Expand Down
12 changes: 6 additions & 6 deletions src/javascripts/ng-admin/Crud/routing.js
View file
Expand Up @@ -50,7 +50,7 @@ function routing($stateProvider) {
params: {
entity: null
},
parent: 'main',
parent: 'ng-admin',
controller: 'ListLayoutController',
controllerAs: 'llCtrl',
templateProvider: templateProvider('ListView', listLayoutTemplate),
Expand Down Expand Up @@ -146,7 +146,7 @@ function routing($stateProvider) {

$stateProvider
.state('show', {
parent: 'main',
parent: 'ng-admin',
url: '/:entity/show/:id?sortField&sortDir',
controller: 'ShowController',
controllerAs: 'showController',
Expand Down Expand Up @@ -241,7 +241,7 @@ function routing($stateProvider) {

$stateProvider
.state('create', {
parent: 'main',
parent: 'ng-admin',
url: '/:entity/create?{defaultValues:json}',
controller: 'FormController',
controllerAs: 'formController',
Expand Down Expand Up @@ -296,7 +296,7 @@ function routing($stateProvider) {

$stateProvider
.state('edit', {
parent: 'main',
parent: 'ng-admin',
url: '/:entity/edit/:id?sortField&sortDir',
controller: 'FormController',
controllerAs: 'formController',
Expand Down Expand Up @@ -409,7 +409,7 @@ function routing($stateProvider) {

$stateProvider
.state('delete', {
parent: 'main',
parent: 'ng-admin',
url: '/:entity/delete/:id',
controller: 'DeleteController',
controllerAs: 'deleteController',
Expand Down Expand Up @@ -448,7 +448,7 @@ function routing($stateProvider) {

$stateProvider
.state('batchDelete', {
parent: 'main',
parent: 'ng-admin',
url: '/:entity/batch-delete/{ids:json}',
controller: 'BatchDeleteController',
controllerAs: 'batchDeleteController',
Expand Down
20 changes: 12 additions & 8 deletions src/javascripts/ng-admin/Main/config/routing.js
View file
Expand Up @@ -16,17 +16,21 @@ function entryConstructorProvider() {

function routing($stateProvider, $urlRouterProvider) {

$stateProvider.state('main', {
$stateProvider.state('ng-admin', {
abstract: true,
controller: 'AppController',
controllerAs: 'appController',
templateProvider: ['NgAdminConfiguration', function(Configuration) {
return Configuration().layout() || layoutTemplate;
}]
views: {
'ng-admin': {
controller: 'AppController',
controllerAs: 'appController',
templateProvider: ['NgAdminConfiguration', function(Configuration) {
return Configuration().layout() || layoutTemplate;
}]
}
}
});

$stateProvider.state('dashboard', {
parent: 'main',
parent: 'ng-admin',
url: '/dashboard?sortField&sortDir',
params: {
sortField: null,
Expand Down Expand Up @@ -112,7 +116,7 @@ function routing($stateProvider, $urlRouterProvider) {
});

$stateProvider.state('ma-404', {
parent: 'main',
parent: 'ng-admin',
template: errorTemplate
});

Expand Down

0 comments on commit efa2374

Please sign in to comment.