we-core/lib/Router/breadcrumb.js

We.js is a node.js framework for build real time applications, sites or blogs!

/**
 * Breadcrumb handlers
 */

module.exports = {
  /**
   * add one bredcrumb middleware with name
   *
   * @param {String} name       Express.js middleware
   * @param {Function} middleware Express.js middleware
   */
  add: function add(name, middleware) {
    this.middlewares[name] = middleware;
  },

  /**
   * Middleware for select the breadcrumb middleware handler
   */
  middleware: function metatagMiddleware(req, res, next) {
    if (res.locals.breadcrumbHandler) {
      if (typeof res.locals.breadcrumbHandler === 'function') {
        return res.locals.breadcrumbHandler(req, res, next);
      } else if (req.we.router.breadcrumb.middlewares[res.locals.breadcrumbHandler]) {
        return req.we.router.breadcrumb.middlewares[res.locals.breadcrumbHandler](req, res, next);
      }
    }

    next();
  },

  /**
   * Middleware handlers
   *
   * @type {Object}
   */
  middlewares: {
    /**
     * Default create breadcrumb function
     * @return {Array} Links array with href and text
     */
    create: function createBreadcrumb(req, res, next) {
      res.locals.breadcrumb =
        '<ol class="breadcrumb">'+
          '<li><a href="/">'+res.locals.__('Home')+'</a></li>'+
          '<li><a href="'+
            req.we.router.urlTo(res.locals.resourceName + '.find', req.paramsArray)+
          '">'+res.locals.__(res.locals.resourceName + '.find')+'</a></li>'+
          '<li class="active">'+res.locals.__(res.locals.resourceName + '.create')+'</li>'+
        '</ol>';

      next();
    },

    /**
     * Default find breadcrumb function
     * @return {Array} Links array with href and text
     */
    find: function findBreadcrumb(req, res, next) {
      res.locals.breadcrumb =
        '<ol class="breadcrumb">'+
          '<li><a href="/">'+res.locals.__('Home')+'</a></li>'+
          '<li class="active">'+res.locals.__(res.locals.resourceName + '.find')+'</li>'+
        '</ol>';

      next();
    },

    /**
     * Default findOne breadcrumb function
     * @return {Array} Links array with href and text
     */
    findOne: function findOneBreadcrumb(req, res, next) {
      res.locals.breadcrumb =
        '<ol class="breadcrumb">'+
          '<li><a href="/">'+res.locals.__('Home')+'</a></li>'+
          '<li><a href="'+
            req.we.router.urlTo(res.locals.resourceName + '.find', req.paramsArray)+
          '">'+res.locals.__(res.locals.resourceName + '.find')+'</a></li>'+
          '<li class="active">'+req.we.utils.string(res.locals.title || '').truncate(25).s+'</li>'+
        '</ol>';

      next();
    },

    /**
     * Default edit / update breadcrumb function
     * @return {Array} Links array with href and text
     */
    edit: function editBreadcrumb(req, res, next) {
      if (!res.locals.data) return next();

      res.locals.breadcrumb =
        '<ol class="breadcrumb">'+
          '<li><a href="/">'+res.locals.__('Home')+'</a></li>'+
          '<li><a href="'+
            req.we.router.urlTo(res.locals.resourceName + '.find', req.paramsArray)+
          '">'+res.locals.__(res.locals.resourceName + '.find')+'</a></li>'+
          '<li><a href="'+res.locals.data.getUrlPathAlias()+'">'+
            req.we.utils.string(res.locals.title || '').truncate(25).s+
          '</a></li>'+
          '<li class="active">'+res.locals.__('edit')+'</li>'+
        '</ol>';

      next();
    },

    /**
     * Default delete breadcrumb function
     * @return {Array} Links array with href and text
     */
    delete: function deleteBreadcrumb(req, res, next) {
      if (!res.locals.data) return next();

      res.locals.breadcrumb =
        '<ol class="breadcrumb">'+
          '<li><a href="/">'+res.locals.__('Home')+'</a></li>'+
          '<li><a href="'+
            req.we.router.urlTo(res.locals.resourceName + '.find', req.paramsArray)+
          '">'+res.locals.__(res.locals.resourceName + '.find')+'</a></li>'+
          '<li><a href="'+res.locals.data.getUrlPathAlias()+'">'+
            req.we.utils.string(res.locals.title || '').truncate(25).s+
          '</a></li>'+
          '<li class="active">'+res.locals.__('delete')+'</li>'+
        '</ol>';

      next();
    },

    /**
     * Breadcrumb for /auth/x pages
     */
    auth: function authBreadcrumb(req, res, next) {
      res.locals.breadcrumb =
        '<ol class="breadcrumb">'+
          '<li><a href="/">'+res.locals.__('Home')+'</a></li>'+
          '<li class="active">'+(res.locals.title || '')+'</li>'+
        '</ol>';

      next();
    }
  }
}