mirror of
https://github.com/MHSanaei/3x-ui.git
synced 2026-07-08 05:36:09 +00:00
93eda06878
Persistent client groups
- New ClientGroup model + client_groups table that holds empty
(placeholder) groups so a user can define a label before any client
references it. ListGroups merges these with the distinct group_name
values already stored on clients and reports {name, clientCount}.
- ClientRecord gains group_name column; the model.Client wire shape
gains a matching `group` JSON field that survives the
inbound.settings → SyncInbound round-trip.
- Rename/Delete on a group mutates client_groups (rename row / delete
row) AND propagates to all matching clients in ClientRecord and in
every owning inbound's settings JSON, all in one transaction.
Bulk operations
- AssignGroup(emails, group) updates clients.group_name + patches each
affected inbound's settings JSON in one read-modify-write per inbound.
Empty group clears the label. Auto-creates the client_groups row when
the user assigns to a brand-new name.
- BulkResetTraffic(emails) loops the existing single-reset path so the
caller can zero traffic across a whole selection or a whole group.
- EmailsByGroup(name) returns just the email list (used by the groups
page to fan a single bulk action over every member).
Endpoints (all under /panel/api/clients)
- GET /groups — summaries with counts
- GET /groups/:name/emails — emails in a group
- POST /groups/create — empty placeholder group
- POST /groups/rename — rename (table + clients + JSON)
- POST /groups/delete — drop label everywhere (clients survive)
- POST /bulkAssignGroup — assign N selected clients
- POST /bulkResetTraffic — reset traffic on a list
Clients page UX
- New Group column (Actions → Client → Group → Inbounds → …) with a
click-to-filter chip.
- FilterDrawer gains a multi-select Group filter whose options come
from the new ClientPageResponse.groups field (sourced from ListGroups
so empty/placeholder groups are pickable too).
- Single-client and bulk-add forms gain a Group AutoComplete pre-loaded
with all known group names.
- New toolbar buttons when selection > 0: "Group ({n})" opens
BulkAssignGroupModal, "Sub links ({n})" opens SubLinksModal.
Sub-links export modal (new SubLinksModal.tsx)
- Table of selected clients with their subscription URL (and JSON URL
when subJsonEnable is on), per-row copy, Copy all, and Download as
sub-links-<timestamp>.txt. Warns when subscription is disabled or
none of the selected clients have a subId.
Dedicated Groups page (new pages/groups/GroupsPage.tsx)
- /groups route + sidebar entry (TagsOutlined icon) + page title key.
- Card-based layout matching Clients/Inbounds/Nodes — summary card with
Total/Grouped/Empty stats, main card with Add Group button + table.
- Per-row More dropdown (icon-first column on the left): Sub links,
Adjust (days+traffic), Reset traffic, Rename, Delete clients in
group, Delete group (keep clients). Empty groups disable the
client-targeted actions.
- Reuses SubLinksModal and ClientBulkAdjustModal — emails for the
group are fetched on demand from GET /groups/:name/emails.
Other polish
- /groups + groups-page selectors added to page-shell.css and
page-cards.css so the new page inherits the same background, padding,
card borders, hover shadow, and summary-card padding.
- .card-toolbar gains a small vertical padding so the larger toolbar
buttons (now default size, matching Inbounds) don't crowd the top of
the card-head on Clients and Groups pages.
302 lines
8.8 KiB
TypeScript
302 lines
8.8 KiB
TypeScript
import { useCallback, useMemo, useState } from 'react';
|
|
import type { ComponentType } from 'react';
|
|
import { useLocation, useNavigate } from 'react-router-dom';
|
|
import { useTranslation } from 'react-i18next';
|
|
import { Drawer, Layout, Menu } from 'antd';
|
|
import type { MenuProps } from 'antd';
|
|
import {
|
|
ApiOutlined,
|
|
ClusterOutlined,
|
|
CloseOutlined,
|
|
DashboardOutlined,
|
|
GithubOutlined,
|
|
HeartOutlined,
|
|
ImportOutlined,
|
|
LogoutOutlined,
|
|
MenuOutlined,
|
|
MoonFilled,
|
|
MoonOutlined,
|
|
SettingOutlined,
|
|
SunOutlined,
|
|
TagsOutlined,
|
|
TeamOutlined,
|
|
ToolOutlined,
|
|
} from '@ant-design/icons';
|
|
|
|
import { HttpUtil } from '@/utils';
|
|
import { pauseAnimationsUntilLeave, useTheme } from '@/hooks/useTheme';
|
|
import './AppSidebar.css';
|
|
|
|
const SIDEBAR_COLLAPSED_KEY = 'isSidebarCollapsed';
|
|
const DONATE_URL = 'https://donate.sanaei.dev/';
|
|
const REPO_URL = 'https://github.com/MHSanaei/3x-ui';
|
|
const LOGOUT_KEY = '__logout__';
|
|
|
|
type IconName = 'dashboard' | 'inbound' | 'team' | 'groups' | 'setting' | 'tool' | 'cluster' | 'logout' | 'apidocs';
|
|
|
|
const iconByName: Record<IconName, ComponentType> = {
|
|
dashboard: DashboardOutlined,
|
|
inbound: ImportOutlined,
|
|
team: TeamOutlined,
|
|
groups: TagsOutlined,
|
|
setting: SettingOutlined,
|
|
tool: ToolOutlined,
|
|
cluster: ClusterOutlined,
|
|
logout: LogoutOutlined,
|
|
apidocs: ApiOutlined,
|
|
};
|
|
|
|
function readCollapsed(): boolean {
|
|
try {
|
|
return JSON.parse(localStorage.getItem(SIDEBAR_COLLAPSED_KEY) || 'false');
|
|
} catch {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
function DonateButton({ ariaLabel }: { ariaLabel: string }) {
|
|
return (
|
|
<a
|
|
href={DONATE_URL}
|
|
target="_blank"
|
|
rel="noopener noreferrer"
|
|
className="sidebar-donate"
|
|
aria-label={ariaLabel}
|
|
title={ariaLabel}
|
|
>
|
|
<HeartOutlined />
|
|
</a>
|
|
);
|
|
}
|
|
|
|
function VersionBadge({ version, collapsed }: { version: string; collapsed?: boolean }) {
|
|
if (!version) return null;
|
|
const label = `v${version}`;
|
|
return (
|
|
<a
|
|
href={REPO_URL}
|
|
target="_blank"
|
|
rel="noopener noreferrer"
|
|
className={`sider-version${collapsed ? ' is-collapsed' : ''}`}
|
|
aria-label={`GitHub ${label}`}
|
|
title={label}
|
|
>
|
|
<GithubOutlined />
|
|
{!collapsed && <span className="sider-version-text">{label}</span>}
|
|
</a>
|
|
);
|
|
}
|
|
|
|
function ThemeCycleButton({ id, isDark, isUltra, onCycle, ariaLabel }: {
|
|
id: string;
|
|
isDark: boolean;
|
|
isUltra: boolean;
|
|
onCycle: () => void;
|
|
ariaLabel: string;
|
|
}) {
|
|
const icon = !isDark ? <SunOutlined /> : !isUltra ? <MoonOutlined /> : <MoonFilled />;
|
|
return (
|
|
<button
|
|
id={id}
|
|
type="button"
|
|
className="sidebar-theme-cycle"
|
|
aria-label={ariaLabel}
|
|
title={ariaLabel}
|
|
onClick={onCycle}
|
|
>
|
|
{icon}
|
|
</button>
|
|
);
|
|
}
|
|
|
|
export default function AppSidebar() {
|
|
const { t } = useTranslation();
|
|
const { isDark, isUltra, toggleTheme, toggleUltra } = useTheme();
|
|
const navigate = useNavigate();
|
|
const { pathname } = useLocation();
|
|
|
|
const [collapsed, setCollapsed] = useState<boolean>(() => readCollapsed());
|
|
const [drawerOpen, setDrawerOpen] = useState(false);
|
|
|
|
const currentTheme: 'light' | 'dark' = isDark ? 'dark' : 'light';
|
|
const panelVersion = window.X_UI_CUR_VER || '';
|
|
|
|
const tabs = useMemo<{ key: string; icon: IconName; title: string }[]>(() => [
|
|
{ key: '/', icon: 'dashboard', title: t('menu.dashboard') },
|
|
{ key: '/inbounds', icon: 'inbound', title: t('menu.inbounds') },
|
|
{ key: '/clients', icon: 'team', title: t('menu.clients') },
|
|
{ key: '/groups', icon: 'groups', title: t('menu.groups') },
|
|
{ key: '/nodes', icon: 'cluster', title: t('menu.nodes') },
|
|
{ key: '/settings', icon: 'setting', title: t('menu.settings') },
|
|
{ key: '/xray', icon: 'tool', title: t('menu.xray') },
|
|
{ key: '/api-docs', icon: 'apidocs', title: t('menu.apiDocs') },
|
|
{ key: LOGOUT_KEY, icon: 'logout', title: t('logout') },
|
|
], [t]);
|
|
|
|
const navItems = useMemo(() => tabs.filter((tab) => tab.icon !== 'logout'), [tabs]);
|
|
const utilItems = useMemo(() => tabs.filter((tab) => tab.icon === 'logout'), [tabs]);
|
|
|
|
const selectedKey = pathname === '' ? '/' : pathname;
|
|
|
|
const toMenuItems = useCallback((items: typeof tabs): MenuProps['items'] =>
|
|
items.map((tab) => {
|
|
const Icon = iconByName[tab.icon];
|
|
return {
|
|
key: tab.key,
|
|
icon: <Icon />,
|
|
label: tab.title,
|
|
};
|
|
}),
|
|
[]);
|
|
|
|
const openLink = useCallback(async (key: string) => {
|
|
if (key === LOGOUT_KEY) {
|
|
await HttpUtil.post('/logout');
|
|
window.location.href = window.X_UI_BASE_PATH || '/';
|
|
return;
|
|
}
|
|
navigate(key);
|
|
}, [navigate]);
|
|
|
|
const onMenuClick = useCallback<NonNullable<MenuProps['onClick']>>(({ key }) => {
|
|
openLink(String(key));
|
|
}, [openLink]);
|
|
|
|
const onSiderCollapse = useCallback((isCollapsed: boolean, type: 'clickTrigger' | 'responsive') => {
|
|
if (type === 'clickTrigger') {
|
|
localStorage.setItem(SIDEBAR_COLLAPSED_KEY, String(isCollapsed));
|
|
setCollapsed(isCollapsed);
|
|
}
|
|
}, []);
|
|
|
|
const cycleTheme = useCallback((id: string) => {
|
|
pauseAnimationsUntilLeave(id);
|
|
if (!isDark) {
|
|
toggleTheme();
|
|
if (isUltra) toggleUltra();
|
|
} else if (!isUltra) {
|
|
toggleUltra();
|
|
} else {
|
|
toggleUltra();
|
|
toggleTheme();
|
|
}
|
|
}, [isDark, isUltra, toggleTheme, toggleUltra]);
|
|
|
|
return (
|
|
<div className="ant-sidebar">
|
|
<Layout.Sider
|
|
theme={currentTheme}
|
|
collapsible
|
|
collapsed={collapsed}
|
|
breakpoint="md"
|
|
onCollapse={onSiderCollapse}
|
|
>
|
|
<div className={`sider-brand${collapsed ? ' sider-brand-collapsed' : ''}`}>
|
|
<div className="brand-block">
|
|
<span className="brand-text">{collapsed ? '3X' : '3X-UI'}</span>
|
|
</div>
|
|
{!collapsed && (
|
|
<div className="brand-actions">
|
|
<DonateButton ariaLabel={t('menu.donate') || 'Donate'} />
|
|
<ThemeCycleButton
|
|
id="theme-cycle"
|
|
isDark={isDark}
|
|
isUltra={isUltra}
|
|
onCycle={() => cycleTheme('theme-cycle')}
|
|
ariaLabel={t('menu.theme')}
|
|
/>
|
|
</div>
|
|
)}
|
|
</div>
|
|
<Menu
|
|
theme={currentTheme}
|
|
mode="inline"
|
|
selectedKeys={[selectedKey]}
|
|
className="sider-nav"
|
|
items={toMenuItems(navItems)}
|
|
onClick={onMenuClick}
|
|
/>
|
|
<Menu
|
|
theme={currentTheme}
|
|
mode="inline"
|
|
selectedKeys={[selectedKey]}
|
|
className="sider-utility"
|
|
items={toMenuItems(utilItems)}
|
|
onClick={onMenuClick}
|
|
/>
|
|
<div className="sider-footer">
|
|
<VersionBadge version={panelVersion} collapsed={collapsed} />
|
|
</div>
|
|
</Layout.Sider>
|
|
|
|
<Drawer
|
|
placement="left"
|
|
closable={false}
|
|
open={drawerOpen}
|
|
rootClassName={currentTheme}
|
|
size="min(82vw, 320px)"
|
|
styles={{
|
|
wrapper: { padding: 0 },
|
|
body: { padding: 0, display: 'flex', flexDirection: 'column', height: '100%' },
|
|
header: { display: 'none' },
|
|
}}
|
|
onClose={() => setDrawerOpen(false)}
|
|
>
|
|
<div className="drawer-header">
|
|
<div className="brand-block">
|
|
<span className="drawer-brand">3X-UI</span>
|
|
</div>
|
|
<div className="drawer-header-actions">
|
|
<DonateButton ariaLabel={t('menu.donate') || 'Donate'} />
|
|
<ThemeCycleButton
|
|
id="theme-cycle-drawer"
|
|
isDark={isDark}
|
|
isUltra={isUltra}
|
|
onCycle={() => cycleTheme('theme-cycle-drawer')}
|
|
ariaLabel={t('menu.theme')}
|
|
/>
|
|
<button
|
|
className="drawer-close"
|
|
type="button"
|
|
aria-label={t('close')}
|
|
onClick={() => setDrawerOpen(false)}
|
|
>
|
|
<CloseOutlined />
|
|
</button>
|
|
</div>
|
|
</div>
|
|
<Menu
|
|
theme={currentTheme}
|
|
mode="inline"
|
|
selectedKeys={[selectedKey]}
|
|
className="drawer-menu drawer-nav"
|
|
items={toMenuItems(navItems)}
|
|
onClick={(info) => { onMenuClick(info); setDrawerOpen(false); }}
|
|
/>
|
|
<Menu
|
|
theme={currentTheme}
|
|
mode="inline"
|
|
selectedKeys={[selectedKey]}
|
|
className="drawer-menu drawer-utility"
|
|
items={toMenuItems(utilItems)}
|
|
onClick={(info) => { onMenuClick(info); setDrawerOpen(false); }}
|
|
/>
|
|
<div className="drawer-footer">
|
|
<VersionBadge version={panelVersion} />
|
|
</div>
|
|
</Drawer>
|
|
|
|
{!drawerOpen && (
|
|
<button
|
|
className="drawer-handle"
|
|
type="button"
|
|
aria-label={t('menu.dashboard')}
|
|
onClick={() => setDrawerOpen(true)}
|
|
>
|
|
<MenuOutlined />
|
|
</button>
|
|
)}
|
|
</div>
|
|
);
|
|
}
|