@hperchec/scorpion-ui-template-default/src/router/routes/private/Settings.js

Scorpion UI - Default template

/**
 * @vuepress
 * ---
 * title: Settings route
 * headline: Settings route
 * sidebarTitle: .Settings
 * sidebarDepth: 0 # To disable auto sidebar links
 * prev: false # Disable prev link
 * next: false # Disable prev link
 * ---
 */

import { Core, utils } from '@hperchec/scorpion-ui'

const { capitalize } = utils
const translate = (...args) => Core.context.services['router'].options.translate(...args) // eslint-disable-line dot-notation

/**
 * @name Settings
 * @static
 * @type {PrivateRoute}
 * @description
 * - **Name**: Settings
 * - **Path**: `/settings`
 * - **Params**: *none*
 * - **Query**: *none*
 */
export default {
  /**
   * @description Route path
   * @name Settings.path
   * @type {string}
   * @default /settings
   */
  path: '/settings',
  /**
   * @description Route name
   * @name Settings.name
   * @type {string}
   * @default Settings
   */
  name: 'Settings',
  /**
   * @alias Settings.component
   * @returns {Object}
   * @description
   * Route component. By default, returns `Core.context.vue.components.private.views.settings.Index`
   */
  component: () => Core.context.vue.components.private.views.settings.Index,
  /**
   * Options
   */
  options: {
    /**
     * @description Route meta
     * @alias Settings.meta
     * @type {Object}
     */
    meta: {
      /**
       * @alias Settings.meta.breadcrumb
       * @type {Object}
       * @description Breadcrumb options
       */
      breadcrumb: {
        /**
         * @alias Settings.meta.breadcrumb.schema
         * @default ['<this>']
         */
        schema: [ '<this>' ],
        /**
         * @alias Settings.meta.breadcrumb.title
         * @type {Function}
         * @return {string}
         * @description
         * Return translated Settings view title (translate: `views.Settings.Index.title`)
         */
        title: (vm) => capitalize(translate('views.Settings.Index.title'))
      },
      /**
       * @alias Settings.meta.pageMeta
       * @type {Object}
       * @property {Function} title - Return translated Settings view title (translate: `views.Settings.Index.title`)
       * @description
       * Route page meta
       */
      pageMeta: {
        title: (vm) => capitalize(translate('views.Settings.Index.title'))
      }
    }
  }
}