Cấu hình file manifest.json

Bất cứ ứng dụng Mini App nào cũng đều phải có một file manifest.json. File này được sử dụng cấu hình các thông tin chung liên quan tới app. Cụ thể nội dung sau

window

Nhà Phát Triển có thể cấu hình các thông tin sau của một window

tên trườngkiểu dữ liệuý nghĩa
navigationBarBackgroundColorstringmàu background của navigation bar
navigationBarTitleColorstringmàu chữ của title
navigationBarTitleTextstringnội dung của title trên navigation bar
navigationBarTitleAlignstringkiểu align layout của title

navigationBarTitleAlign có thể nhận các giá trị

  • center
  • left
  • right

tabBar

Nhà Phát Triển có thể cấu hình các tab của thông qua trường tabBar.

tên trườngkiểu dữ liệuý nghĩa
activeTitleColorstringmàu chữ của một tab khi được lựa chọn
activeBackgroundColorstringmàu background của một tab khi được lựa chọn
inactiveTitleColorstringmàu chữ của một tab khi không được lựa chọn
inactiveBackgroundColorstringmàu background của một tab khi không được lựa chọn
showLabelbooleannếu giá trị này bằng true, tab sẽ liệt kê title thay vì icon
listlist objectdanh sách các tab

Mỗi một object trong list sẽ chứa các trường sau

tên trườngkiểu dữ liệuý nghĩa
pagePathstringđường dẫn tới pages của tab
iconPathstringđường dẫn tới icon của tab

pages

Nhà Phát Triển có thể khai báo danh sách các pages cho một ứng dụng. Nếu một pages được khai báo trong file manifest.json, Nhà Phát Triển có thể truy cập pages bằng cách sử dụng deeplink.

Chi tiết về deeplink của một pages sẽ được mô tả sau.

Giá trị của pages là một mảng gồm các string, mỗi string là đường dẫn tới một pages. Giá trị đầu tiền của pages sẽ là trang được render đầu tiên khi mở Mini App. Để thêm mới hoặc bỏ đi một pages bạn cần phải thay đổi giá trị của mảng pages.

Việc cấu hình chi tiết của từng page sẽ được mô tả chi tiết ở pages

widgets

Nhà Phát Triển có thể khai báo một danh sách các widgets cho một ứng dụng. Trong file manifest.json, Nhà Phát Triển khai báo một mảng các widgets thông qua giá trị widgets.

Giống như pages, widgets nhận giá trị là một mảng các string trỏ tới dường dẫn của các widgets. Tên của một widgets chính là tên của thư mục định nghĩa widgets.

Ví dụ, Nhà Phát Triển ứng dụng Bán Vé Máy Bay tạo ra một widget với để nhắn nhở Khách Hàng mua vé. Nhà Phát Triển đặt tên widget là remind, widget này có UI như sau

airticket

Trong file manifest.json, Nhà Phát Triển sẽ khai báo widgets như sau

{
...
"widgets": ["widgets/remind"]
}

Giá trị mặc định của manifest.json

Khi bạn sử dụng lệnh tbox init để tạo mới một Mini App, tbox sẽ sinh ra một file manifest.json với nội dung mặc định như sau

{
"window": {
"navigationBarBackgroundColor": "#2DC275",
"navigationBarTitleColor": "#FFFFFF",
"navigationBarTitleText": "Sample Mini App",
"navigationBarTitleAlign": "center"
},
"tabBar": {
"activeTitleColor": "#2DC275",
"activeBackgroundColor": "#ffffff",
"inactiveTitleColor": "#000000",
"inactiveBackgroundColor": "#ffffff",
"showLabel": true,
"list": [
{ "pagePath": "./pages/page1", "iconPath": "./assets/page1.png" },
{ "pagePath": "./pages/page2", "iconPath": "./assets/page2.png" }
]
},
"pages": ["./pages/page1", "./pages/page2"],
"widgets": []
}
Last updated on by Kien Nguyen