mirror of
https://github.com/MHSanaei/3x-ui.git
synced 2026-11-06 05:05:01 +03:00
MHSanaei
7078abc14a
Storybook existed only as an undocumented local tool: 9 of 24 reusable components had stories, autodocs pages were bare prop tables, nothing built or tested the stories, and no contributor doc mentioned the workbench existed. Every reusable component under src/components/ now has a co-located story with enriched autodocs (component descriptions plus per-prop argTypes, kept as string metadata since the repo bans line comments). Stories double as headless Chromium tests through the Storybook vitest addon, with axe accessibility checks enforced as errors and play-function interaction tests covering the modals, the RHF field bridge, the config block, and the select-all buttons. The preview now mirrors the panel's real theme DOM (body class, shared AntD theme config, seeded theme storage) so what stories render matches production. CI and make verify gain a static Storybook build as a compile gate, and the frontend test job installs Chromium so story tests run on every PR. Contributor docs (frontend README, CONTRIBUTING, agent guides) document the workbench, the story conventions, and the Controls setup. Node engines move to 24 LTS and gen:api drops the type-stripping flags that Node 24 makes default.
78 lines
1.9 KiB
TypeScript
78 lines
1.9 KiB
TypeScript
import type { Meta, StoryObj } from '@storybook/react-vite';
|
|
|
|
import { ThemeProvider } from '@/hooks/useTheme';
|
|
|
|
import ClientTrafficCell from './ClientTrafficCell';
|
|
|
|
const GiB = 1024 ** 3;
|
|
|
|
const meta = {
|
|
title: 'Clients/ClientTrafficCell',
|
|
component: ClientTrafficCell,
|
|
tags: ['autodocs'],
|
|
decorators: [
|
|
(Story) => (
|
|
<ThemeProvider>
|
|
<Story />
|
|
</ThemeProvider>
|
|
),
|
|
],
|
|
parameters: {
|
|
layout: 'padded',
|
|
docs: {
|
|
description: {
|
|
component:
|
|
'Traffic usage cell for the clients table: used bytes, a color-coded progress bar, and the quota (or an infinity icon for unlimited clients), with an upload/download/remaining breakdown in a hover popover.',
|
|
},
|
|
},
|
|
},
|
|
argTypes: {
|
|
up: { description: 'Uploaded bytes counted against the client.' },
|
|
down: { description: 'Downloaded bytes counted against the client.' },
|
|
total: { description: 'Traffic quota in bytes; 0 or less renders as unlimited.' },
|
|
enabled: { description: 'Grays the bar out when the client is disabled.' },
|
|
trafficDiff: { description: 'Headroom in bytes below the quota at which the bar shifts from green to orange.' },
|
|
compact: { description: 'Smaller bar and tighter layout for dense table rows.' },
|
|
},
|
|
} satisfies Meta<typeof ClientTrafficCell>;
|
|
|
|
export default meta;
|
|
|
|
type Story = StoryObj<typeof meta>;
|
|
|
|
export const Default: Story = {
|
|
args: {
|
|
up: 6 * GiB,
|
|
down: 35 * GiB,
|
|
total: 100 * GiB,
|
|
trafficDiff: 5 * GiB,
|
|
},
|
|
};
|
|
|
|
export const Unlimited: Story = {
|
|
args: {
|
|
up: 87 * GiB,
|
|
down: 940 * GiB,
|
|
total: 0,
|
|
},
|
|
};
|
|
|
|
export const Depleted: Story = {
|
|
args: {
|
|
up: 9 * GiB,
|
|
down: 42 * GiB,
|
|
total: 50 * GiB,
|
|
trafficDiff: 5 * GiB,
|
|
},
|
|
};
|
|
|
|
export const DisabledCompact: Story = {
|
|
args: {
|
|
up: 2 * GiB,
|
|
down: 11 * GiB,
|
|
total: 40 * GiB,
|
|
enabled: false,
|
|
compact: true,
|
|
},
|
|
};
|