angular-utils-ui-breadcrumbs使用心得

时间 2019-12-13

标签 angular utils breadcrumbs 使用心得栏目 AngularJS 繁體版

原文原文链接

angular-utils-ui-breadcrumbs是一个用来自动生成面包屑导航栏的一个插件，须要依赖angular、UIRouter和bootstrap3.css。生成的界面截图以下，点击相应的面包屑会跳转到相应的路由，点击相应的路由也会自动生成相应的面包屑：css

安装：npm install angular-utils-ui-breadcrumbshtml

github：https://github.com/michaelbromley/angularUtils/tree/master/src/directives/uiBreadcrumbsgit

模块依赖：github

var app = angular.module('myapp', ['ui.router.state.events','angularUtils.directives.uiBreadcrumbs']);

这里使用了ui.router.state.events模块，由于该uiBreadcrumbs依赖于$stateChangeSuccess事件，而uiRouter在1.x版本以后推荐使用Transition钩子，为了兼容原来的版本，将不被推荐的state events事件封装到了stateEvent.js文件中，该文件在UIRouter包中，因此咱们须要引入该文件，angularUtils.directives.uiBreadcrumbs模块已经依赖了ui.router模块，咱们不须要在这里重复引入。npm

文件目录结构以下：bootstrap

<!--index.html-->
<!DOCTYPE html>
<html lang="en" ng-app="myapp" ng-strict-di>
<head>
    <meta charset="UTF-8">
    <title>angular-utils-ui-breadcrumbs</title>
    <link href="https://cdn.bootcss.com/bootstrap/3.3.7/css/bootstrap.min.css" rel="stylesheet">
</head>
<body>
<ui-breadcrumbs displayname-property="data.displayName" abstract-proxy-property="data.proxy" template-url="./uiBreadcrumbs.tpl.html"></ui-breadcrumbs>
<ui-view name="home"></ui-view>
</body>
<script src="https://cdn.bootcss.com/angular.js/1.6.0/angular.min.js"></script>
<script src="https://cdn.bootcss.com/angular-ui-router/1.0.3/angular-ui-router.min.js"></script>
<script src="stateEvents.js"></script>
<script src="uiBreadcrumbs.js"></script>
<script src="index.js"></script>
</html>

//index.js
var app = angular.module('myapp', ['ui.router.state.events','angularUtils.directives.uiBreadcrumbs']);

app.config(['$stateProvider', '$urlRouterProvider', ($stateProvider, $urlRouterProvider) =>{
    $urlRouterProvider.otherwise('/home/production');
    $stateProvider
        .state('home', {
            abstract: true,
            url: '/home',
            data: {
              proxy: 'home.info'
            },
            views: {
                'home@': {
                    template: '<div ui-view="content"></div>'
                }
            }
        })
        .state('home.info', {
            url: '/info',
            data: {
                displayName: 'home'
            },
            views: {
                'content@home': {
                    template: '<a ui-sref="^.production">production</a>'
                }
            }
        })
        .state('home.production', {
            url: '/production',
            data: {
              displayName: 'production'
            },
            views: {
                'content@home': {
                    template: '<a ui-sref=".fruits">fruits</a>'
                }
            }
        })
        .state('home.production.fruits', {
            url: '/fruits',
            data: {
                displayName: 'fruits'
            },
            views: {
                'content@home': {
                    template: `<ul>
                        <li><a ui-sref=".detail({type: 'apple'})">apple</a></li>
                        <li><a ui-sref=".detail({type: 'banane'})">banane</a></li>
                        <li><a ui-sref=".detail({type: 'pear'})">pear</a></li>
                    </ul>`
                }
            }
        })
        .state('home.production.fruits.detail', {
            url: '/:type',
            data: {
                displayName: 'detail'
            },
            views: {
                'content@home': {
                    template: '<div>{{$resolve.fruit}}</div>'
                }
            },
            resolve: {
                fruit: ['$stateParams', $stateParams =>{
                    return $stateParams.type
                }]
            }
        })
}]);

下面详细说明一下该插件的使用方法:app

<ui-breadcrumbs displayname-property="data.displayName"
                [template-url=""]
                [abstract-proxy-property=""]>
</ui-breadcrumbs>

dispalyname-property：（必须的），该属性指向了你声明路由时候的state配置对象的某个属性，该属性的值就是在该路由下面包屑会展现的值，若是没有指定，将会展现state的name属性。ide

template-url: （可选）指定uiBreadcrumbs.tpl.html的路径，该文件是ui-breadcrumbs指令的模版，若是不指定，将默认使用如下目录，如下是源码的内容：ui

 　 var moduleName = 'angularUtils.directives.uiBreadcrumbs';
    var templateUrl = 'directives/uiBreadcrumbs/uiBreadcrumbs.tpl.html';

    /**
     * Module
     */
    var module;
    try {
        module = angular.module(moduleName);
    } catch(err) {
        // named module does not exist, so create one
        module = angular.module(moduleName, ['ui.router']);
    }

abstract-proxy-property: （可选）,当使用abstract state的时候，咱们是不可以transition到该状态的。所以咱们就不可以展现该状态的面包屑，由于当点击一个abstract state将会致使一个异常，因此为了解决这种状况，咱们能够让abstract-proxy-property指向一个state config属性，该属性的值是某个state.name,即某个路由，当须要显示abstract state的面包屑的时候，将会寻找该state.name来代替该abstract state，如以上例子，咱们指定了home.info这个状态。url