Module

Module trong một dự án FUI được định nghĩa như một trang được tạo ra nhằm thực hiện một chức năng nhất định trong dự án, có thể là một form để lấy thông tin từ người dùng, một trang báo cáo thống kê, landing page hoặc là bất cứ điều gì bạn có thể làm với một file HTML.

Khởi tạo một module

Để tạo mới một module trong dự án bạn làm theo các bước sau:

  1. Ở form "Thêm mới" sẽ yêu cầu nhập các thông tin sau: - Domain: Tên miền tuỳ chỉnh của bạn sở hữu (Không bắt buộc nhập). - Module ID: Tên phân biệt của module trong dự án (không được đặt trùng). - Module name: Tên mô tả của module (nên đặt rõ ràng để tiện phân biệt sau này khi nhiều module). - HTML Only: Nếu tích vào đồng nghĩa với việc bạn lựa chọn xây dựng module như một file HTML thuần và bỏ qua các chức năng của FUI (các chức năng của FUI sẽ không gọi được trong chế độ HTML Only này).

  2. Sau khi điền xong các thông tin, bấm "Thêm mới" để tạo module.

  3. Module sau khi tạo thành công:

  4. Để xem module, có thể bấm vào ModuleName để xem trang vừa tạo.

Nếu không có domain thì module sẽ có tên miền với cấu trúc sau:

https://fui.vn/[projectID]/[moduleID]

Lưu ý:

  • Nếu không tìm thấy module hãy tải lại trang và tìm module dựa vào Module ID.

  • Ví dụ trên thuộc dự án Example có projectID là ex, thanh menu của module vừa tạo sẽ kế thừa lại menu đã được cấu hình của dự án.

Cấu trúc module

Một module FUI được định nghĩa dưới dạng JSON với cấu trúc như sau:

{
   "data": [],
   "watch": {},
   "controls": [],
   "set": {}
}
  • data: Chứa các dữ liệu được định nghĩa. Cách khai báo data.

  • watch: Sử dụng để theo dõi các giá trị dữ liệu bị thay đổi để thực hiện một lệnh nào đó. Xem thêm.

  • controls: Chứa cấu trúc giao diện người dùng của module. Xem thêm.

  • set: Chứa các cấu hình chung của một module. Xem thêm.

Cấu hình module

Lưu ý:

  • Nếu dự án đã được cấu hình thì tất cả các module của dự án sẽ sử dụng chung một cấu hình của dự án.

  • Chỉ khi các cấu hình trên module được định nghĩa thì sẽ ghi đè lên cấu hình của dự án.

Để cấu hình dự án, bạn thực hiện các bước sau:

  1. Tuỳ chỉnh các giá trị phù hợp của các thuộc tính theo diễn giải phía dưới.

Cấu hình của một module (cũng tương tự project) được định nghĩa có cấu trúc gồm những thuộc tính sau đây:

{
  "ProjectName": "Tuyển sinh",
  "title": "Chương trình đại sứ",
  "apiDomain": "https://api.fui.vn/",
  "login": "https://login.fui.vn/",
  "menubgcolor": "indigo",
  "menucolor": "yellow--text",
  "logo": "https://fui.vn/images/fastUI_White.png",
  "userInfo": "https://api.fui.vn/acc/UserInfo",
  "menu": [
    {
      "name": "Giới thiệu",
      "url": "/gioi-thieu"
    },
    {
      "name": "Quản lý",
      "submenu": [
        {
          "name": "Danh sách đại sứ",
          "url": "/danhsach-daisu"
        },
        {
          "name": "Danh sách học sinh",
          "url": "/danhsach-hocsinh"
        }
      ]
    }
  ]
}

Diễn giải:

  • ProjectName: Tên mô tả của dự án.

  • title: Tên tiều đề của module.

  • apiDomain: Địa chỉ API chung của module.

  • login: Trang xác thực người dùng của module, sẽ được chuyển đến nếu người dùng chưa xác thực.

  • logo: Địa chỉ url của logo hiển thị trên thanh menu.

  • menucolor: Màu chữ của thanh menu.

  • menubgcolor: Màu của thanh menu.

  • userInfo: API để lấy thông tin người dùng sau khi đã xác thực.

  • menu: Mảng chứa cấu trúc menu của module

    • name: Tên hiển thị trên thanh menu.

    • url: Địa chỉ của menu.

    • submenu: Chứa những mục con của menu.

Last updated