WeUI+ Documentation

WeUI+ is a comprehensive Mobile UI library designed for developing HTML5 and WeChat Official Account (公众号) applications. It is built upon Zepto 1.2 and WeUI 1.13, offering nearly 100 components and plugins to provide a highly complete mobile user interface experience.

Key features include:

• Extensive component library (nearly 100 plugins/components).
• Support for mobile-specific interactions (e.g., shake, pull-to-refresh, image galleries).
• Built-in backend services (recently migrated from PHP to Golang).
• Cross-platform compatibility for mobile web environments.

You can view the live online demonstration of the WeUI+ components and plugins at the following URL:

https://weui.shanliwawa.top

The latest versions of WeUI+ use a Golang-based backend. You can run the included server by executing the compiled binary. Once running, access the service via your browser at:

http://127.0.0.1:8080

The backend can be compiled using Go. To ensure the binary is as small as possible, use the -ldflags "-s -w" flags. You can further compress the resulting binary using the upx tool.

Important: When compiling (for example, in WSL2), ensure that CGO is disabled, as enabling it may result in non-functional binaries.

# Windows
go build -ldflags "-s -w" -o win-weui-amd64.exe

# Linux
go build -ldflags "-s -w" -o linux-weui-amd64

The backend is designed to be compiled without cgo, allowing for easy cross-platform compilation. It requires goframe2 or higher and sqlite.

When compiling, ensure you follow the requirements for the target system. The project provides pre-compiled binaries for Windows 10 and Linux.

The WeUI+ server is a Go application built using the GoFrame framework. By default, it runs on port 8885 and serves static files from the ./weui directory.

Default Access

• Local Access: http://127.0.0.1:8885
• Static Files: Accessible via the /weui prefix (e.g., http://127.0.0.1:8885/weui/index.html).

Requirements

• A SQLite database file located at weui/db.db.
• A weui/ver file containing two lines: the version string and the date.
• A weui/README.md file for the /v1/md endpoint.

The project provides a utility library located at js/fn.js. In newer versions (v6.03+), these functions are exported using ES modules. To use specific functions, you must import them explicitly to avoid bloating your bundle.

Example of importing specific utilities:

import { md5, dump } from 'js/fn.js';

import {md5,dump} from 'js/fn.js'

Page View Tracking

• GET /v1/pvuv: Tracks page views (PV/UV).
  • Parameters: types (string) and md5 (string, required).
  • Behavior: If the md5 hash for the page/type combination doesn't exist in the stat table, it creates a new record. Otherwise, it increments the num field.

Security and Utilities

• GET /v1/code: Generates a base64-encoded captcha image using base64Captcha. Returns a JSON object with the img string.
• POST /v1/upimg: Converts a base64 image string into a physical file.
  • Parameter: imgbase64 (the full data URI string).
  • Behavior: Saves the image to ./weui/php/image using a SHA1 hash of the data as the filename and returns the file path.
• GET /v1/getimg: Generates a dynamic solid-color PNG image.
  • Parameter: c (format: widthxheight, e.g., 100x100).

These endpoints provide lookup services for city and province data stored in the database.

• POST /v1/getcity: Look up a city name by its code.
  • Parameter: code (string).
• POST /v1/getpy: Search for cities using Pinyin.
  • Parameter: py (string).
• POST /v1/getso: Search for cities using a keyword match on the name.
  • Parameter: kw (string).