Nayo Admin 中文文档

version: 1.0.0

Built with Teadocs

页面约定

# 页面约定

当你需要为你的Admin新增一个页面的时候,需要遵循以下的页面目录结构和约定

page_name  单独页面的文件夹
├─ api  页面api文件夹
|  └─index.js
├─ components  页面组件文件夹
|  └─index.js
├─ lang  页面语言包文件夹
|  └─index.js
├─ page_name.vue  页面出口组件文件
└─ index.js  页面出口文件

目录由一下几个部分组成:

  1. 页面api文件夹 - api folder
  2. 页面组件文件夹 - components folder
  3. 页面语言包文件夹 - lang folder
  4. 页面出口组件文件 - export .vue file
  5. 页面出口文件index.js - export index.js file

分别说明


  • 页面api文件夹

该文件夹下,需要有一个index.js,作为出口文件

你的api的地址需要存放在这里,然后统一使用index.js进行导出

你不应该在这里写任何发送api或者处理api请求的逻辑,这里仅仅是存放该页面api地址的地方


  • 页面组件文件夹

该文件夹下,需要有一个index.js,作为出口文件

你的Vue组件需要存放在这里,然后通过index.js导出

你不应该在每个组件文件里书写或处理api相关的请求,如果需要api请求,你可以在组件中使用$emit发送api请求事件,然后在页面出口组件文件中捕获事件,发送请求


  • 页面语言包文件夹

该文件夹下,需要有一个index.js,作为出口文件

你的语言包需要存放在这里,格式如下,然后通过index.js导出

lang = {
    cn: {
        hello: "你好"
    },
    en: {
        hello: "hello"
    },
    ...
}

ps: 当你注册语言包后,每个页面对应一个路由,该语言包会以这个路由名称作为命名空间


  • 页面出口组件文件

该文件用于整个页面布局和使用组件

你应该在这个页面处理全部组件的api请求


  • 页面出口文件

通过该文件导出页面出口组件文件