mirror of https://github.com/MHSanaei/3x-ui.git synced 2026-05-13 13:58:22 +00:00

History

MHSanaei 46b6f8c66c Some checks are pending CI / go-test (push) Waiting to run Details CI / govulncheck (push) Waiting to run Details CI / frontend (push) Waiting to run Details CodeQL Advanced / Analyze (go) (push) Waiting to run Details CodeQL Advanced / Analyze (actions) (push) Waiting to run Details CodeQL Advanced / Analyze (javascript-typescript) (push) Waiting to run Details Release 3X-UI / build (386) (push) Waiting to run Details Release 3X-UI / build (amd64) (push) Waiting to run Details Release 3X-UI / build (arm64) (push) Waiting to run Details Release 3X-UI / build (armv5) (push) Waiting to run Details Release 3X-UI / build (armv6) (push) Waiting to run Details Release 3X-UI / build (armv7) (push) Waiting to run Details Release 3X-UI / build (s390x) (push) Waiting to run Details Release 3X-UI / Build for Windows (push) Waiting to run Details feat(routing): drag-reorder rules, split balancer column, mobile card layout - Grip-handle drag-and-drop on the # cell to reorder rules, built on Pointer Events so the same code works for mouse, touch, and pen (HTML5 drag doesn't fire from touch on iOS Safari). 5px threshold keeps quick taps from triggering a reorder; up/down arrow menu items stay as a keyboard/a11y fallback. Drop indicator is a 2px blue line on the target edge; dragged row fades to 40%. - Split the old combined target column into Outbounds and Balancer columns. Each row now has exactly one populated cell — green outbound tag or purple balancer tag. - Mobile drops the a-table (520px+ of column widths overflowed every phone) for a stacked card layout: # + grip + actions on top, an "Inbound → Outbound/Balancer" flow row in the middle, and criteria chips (domain, IP, port, src IP/port, L4, protocol, user, VLESS) below for whichever fields are actually set. Multi-value chips collapse to "first +N" with full value on hover.		2026-05-13 15:30:25 +02:00
..
src	feat(routing): drag-reorder rules, split balancer column, mobile card layout	2026-05-13 15:30:25 +02:00
.gitignore	Vue3 migration (#4198 )	2026-05-09 17:47:35 +02:00
api-docs.html	feat(ui): use the host as the browser tab title prefix	2026-05-13 14:23:57 +02:00
eslint.config.js	fix: reality random target/sni buttons not working (#4337 ) (#4340 )	2026-05-13 14:42:20 +02:00
inbounds.html	feat(ui): use the host as the browser tab title prefix	2026-05-13 14:23:57 +02:00
index.html	feat(ui): use the host as the browser tab title prefix	2026-05-13 14:23:57 +02:00
login.html	feat(ui): use the host as the browser tab title prefix	2026-05-13 14:23:57 +02:00
nodes.html	feat(ui): use the host as the browser tab title prefix	2026-05-13 14:23:57 +02:00
package-lock.json	Security hardening: sessions, SSRF, CSP nonce, CSRF logout, trusted proxies (#4275 )	2026-05-13 12:52:52 +02:00
package.json	Security hardening: sessions, SSRF, CSP nonce, CSRF logout, trusted proxies (#4275 )	2026-05-13 12:52:52 +02:00
README.md	Vue3 migration (#4198 )	2026-05-09 17:47:35 +02:00
settings.html	feat(ui): use the host as the browser tab title prefix	2026-05-13 14:23:57 +02:00
subpage.html	Vue3 migration (#4198 )	2026-05-09 17:47:35 +02:00
vite.config.js	feat(panel): in-panel API documentation page	2026-05-11 13:57:42 +02:00
xray.html	feat(ui): use the host as the browser tab title prefix	2026-05-13 14:23:57 +02:00

README.md

3x-ui frontend

Vue 3 + Ant Design Vue 4 + Vite. Multi-page app — one HTML entry per panel route — built into ../web/dist/ and embedded into the Go binary via embed.FS.

Dev

npm install
npm run dev

Vite serves on http://localhost:5173/. API calls and /panel/* routes proxy to the Go panel at http://localhost:2053/, so start the Go panel first (go run main.go) and then Vite.

The proxy auto-rewrites /panel, /panel/settings, /panel/inbounds, /panel/xray to the matching Vite-served HTML in dev mode (see MIGRATED_ROUTES in vite.config.js), so the sidebar's production-style links work without round-tripping through Go.

Production build

npm run build

Outputs to ../web/dist/ (HTML at the root, hashed JS/CSS under assets/). The Go binary embeds this directory at compile time and web/controller/dist.go serves the per-page HTML.

Lint

npm run lint

ESLint 10 with eslint.config.js (flat config) — vue3-recommended plus a few rule overrides for the project's formatting style.

Layout

frontend/
├── *.html                 # Vite entry HTML, one per panel route
├── eslint.config.js
├── vite.config.js
└── src/
    ├── entries/           # Per-page bootstrap (createApp + mount)
    ├── pages/             # One folder per route, each with the page
    │   ├── index/         # component + helpers + sub-components
    │   ├── login/
    │   ├── inbounds/
    │   ├── xray/
    │   ├── settings/
    │   └── sub/
    ├── components/        # Cross-page Vue components
    ├── composables/       # Reusable reactive logic (useTheme, …)
    ├── api/               # Axios setup, CSRF interceptor
    ├── i18n/              # vue-i18n init (locales live in web/translation/)
    ├── models/            # Inbound, Outbound, Status, … domain classes
    └── utils/             # HttpUtil, ObjectUtil, LanguageManager, …

Adding a new page

Add frontend/<page>.html referencing /src/entries/<page>.js.
Add src/entries/<page>.js that imports the page component and mounts it.
Add the page component under src/pages/<page>/.
Register the entry in rollupOptions.input in vite.config.js.
If the page is reachable from the sidebar at /panel/<route>, add it to MIGRATED_ROUTES so the dev proxy serves the Vite HTML.
Wire the Go controller to serveDistPage(c, "<page>.html").