mirror of
https://github.com/MHSanaei/3x-ui.git
synced 2026-11-05 20:55:29 +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.
49 lines
1.5 KiB
TypeScript
49 lines
1.5 KiB
TypeScript
import type { Meta, StoryObj } from '@storybook/react-vite';
|
|
import { Switch } from 'antd';
|
|
import { BellOutlined } from '@ant-design/icons';
|
|
|
|
import { NotificationCard } from './NotificationCard';
|
|
|
|
const meta = {
|
|
title: 'UI/Notifications/NotificationCard',
|
|
component: NotificationCard,
|
|
tags: ['autodocs'],
|
|
parameters: {
|
|
layout: 'padded',
|
|
docs: {
|
|
description: {
|
|
component:
|
|
'Small outlined card that groups a notification channel — an icon and title in the header, a control in the top-right `extra` slot (typically a toggle), and the channel settings as its body.',
|
|
},
|
|
},
|
|
},
|
|
argTypes: {
|
|
icon: { description: 'Leading icon shown before the title.' },
|
|
title: { description: 'Channel name shown in the header.' },
|
|
extra: { description: 'Top-right slot, typically an enable/disable Switch.' },
|
|
children: { description: 'Card body — the channel settings.' },
|
|
},
|
|
} satisfies Meta<typeof NotificationCard>;
|
|
|
|
export default meta;
|
|
|
|
type Story = StoryObj<typeof meta>;
|
|
|
|
export const Default: Story = {
|
|
args: {
|
|
icon: <BellOutlined />,
|
|
title: 'Telegram',
|
|
extra: <Switch defaultChecked aria-label="Enable Telegram notifications" />,
|
|
children: <span>Push a message to the configured chat when an event fires.</span>,
|
|
},
|
|
};
|
|
|
|
export const Disabled: Story = {
|
|
args: {
|
|
icon: <BellOutlined />,
|
|
title: 'Email',
|
|
extra: <Switch aria-label="Enable email notifications" />,
|
|
children: <span>Email delivery is turned off for this channel.</span>,
|
|
},
|
|
};
|