@15gifts/back-office-kit 0.1.0-alpha.0 → 0.1.0-alpha.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +9 -6
- package/dist/browser/back-office-kit.js +6649 -5932
- package/dist/components/Alert/Alert.css.d.ts +1 -0
- package/dist/components/Alert/Alert.d.ts +12 -2
- package/dist/components/Alert/Alert.js +33 -29
- package/dist/components/Alert/Alert.js.map +1 -1
- package/dist/components/Alert/Alert.styles.js +2 -2
- package/dist/components/Alert/Alert.styles.js.map +1 -1
- package/dist/components/AppShell/AppShell.css.d.ts +2 -0
- package/dist/components/AppShell/AppShell.d.ts +3 -1
- package/dist/components/AppShell/AppShell.js +42 -26
- package/dist/components/AppShell/AppShell.js.map +1 -1
- package/dist/components/AppShell/AppShell.styles.js +3 -2
- package/dist/components/AppShell/AppShell.styles.js.map +1 -1
- package/dist/components/Avatar/Avatar.d.ts +1 -0
- package/dist/components/Avatar/Avatar.js.map +1 -1
- package/dist/components/Badge/Badge.css.d.ts +5 -0
- package/dist/components/Badge/Badge.d.ts +4 -1
- package/dist/components/Badge/Badge.js +6 -5
- package/dist/components/Badge/Badge.js.map +1 -1
- package/dist/components/Badge/Badge.styles.js +16 -15
- package/dist/components/Badge/Badge.styles.js.map +1 -1
- package/dist/components/Breadcrumbs/Breadcrumbs.css.d.ts +2 -0
- package/dist/components/Breadcrumbs/Breadcrumbs.d.ts +2 -0
- package/dist/components/Breadcrumbs/Breadcrumbs.js +27 -27
- package/dist/components/Breadcrumbs/Breadcrumbs.js.map +1 -1
- package/dist/components/Breadcrumbs/Breadcrumbs.styles.js +2 -2
- package/dist/components/Breadcrumbs/Breadcrumbs.styles.js.map +1 -1
- package/dist/components/Button/Button.css.d.ts +1 -1
- package/dist/components/Button/Button.d.ts +5 -4
- package/dist/components/Button/Button.js +21 -21
- package/dist/components/Button/Button.js.map +1 -1
- package/dist/components/Button/Button.styles.js.map +1 -1
- package/dist/components/Card/Card.css.d.ts +2 -0
- package/dist/components/Card/Card.d.ts +7 -1
- package/dist/components/Card/Card.js +33 -22
- package/dist/components/Card/Card.js.map +1 -1
- package/dist/components/Card/Card.styles.js +2 -2
- package/dist/components/Card/Card.styles.js.map +1 -1
- package/dist/components/ChatTranscript/ChatTranscript.d.ts +2 -2
- package/dist/components/ChatTranscript/ChatTranscript.js +74 -71
- package/dist/components/ChatTranscript/ChatTranscript.js.map +1 -1
- package/dist/components/Checkbox/Checkbox.d.ts +2 -1
- package/dist/components/Checkbox/Checkbox.js +30 -34
- package/dist/components/Checkbox/Checkbox.js.map +1 -1
- package/dist/components/Checkbox/Checkbox.styles.js.map +1 -1
- package/dist/components/CheckboxGroup/CheckboxGroup.css.d.ts +2 -0
- package/dist/components/CheckboxGroup/CheckboxGroup.d.ts +28 -0
- package/dist/components/CheckboxGroup/CheckboxGroup.js +66 -0
- package/dist/components/CheckboxGroup/CheckboxGroup.js.map +1 -0
- package/dist/components/CheckboxGroup/CheckboxGroup.styles.js +10 -0
- package/dist/components/CheckboxGroup/CheckboxGroup.styles.js.map +1 -0
- package/dist/components/CheckboxGroup/index.d.ts +2 -0
- package/dist/components/Chip/Chip.css.d.ts +2 -0
- package/dist/components/Chip/Chip.d.ts +15 -3
- package/dist/components/Chip/Chip.js +35 -16
- package/dist/components/Chip/Chip.js.map +1 -1
- package/dist/components/Chip/Chip.styles.js +2 -2
- package/dist/components/Chip/Chip.styles.js.map +1 -1
- package/dist/components/Chip/index.d.ts +1 -1
- package/dist/components/ColorPicker/ColorPicker.d.ts +3 -1
- package/dist/components/ColorPicker/ColorPicker.js +46 -47
- package/dist/components/ColorPicker/ColorPicker.js.map +1 -1
- package/dist/components/ColorPicker/ColorPicker.styles.js.map +1 -1
- package/dist/components/Combobox/Combobox.d.ts +28 -4
- package/dist/components/Combobox/Combobox.js +130 -109
- package/dist/components/Combobox/Combobox.js.map +1 -1
- package/dist/components/CopyButton/CopyButton.d.ts +11 -0
- package/dist/components/CopyButton/CopyButton.js +40 -0
- package/dist/components/CopyButton/CopyButton.js.map +1 -0
- package/dist/components/CopyButton/index.d.ts +2 -0
- package/dist/components/DateRangePicker/DateRangePicker.d.ts +10 -3
- package/dist/components/DateRangePicker/DateRangePicker.js +107 -110
- package/dist/components/DateRangePicker/DateRangePicker.js.map +1 -1
- package/dist/components/DateRangePicker/DateRangePicker.styles.js +2 -2
- package/dist/components/DateRangePicker/DateRangePicker.styles.js.map +1 -1
- package/dist/components/DateTimeInput/DateTimeInput.d.ts +1 -1
- package/dist/components/DateTimeInput/DateTimeInput.js +20 -28
- package/dist/components/DateTimeInput/DateTimeInput.js.map +1 -1
- package/dist/components/DateTimeInput/DateTimeInput.styles.js +1 -0
- package/dist/components/DescriptionList/DescriptionList.d.ts +8 -0
- package/dist/components/DescriptionList/DescriptionList.js +2 -1
- package/dist/components/DescriptionList/DescriptionList.js.map +1 -1
- package/dist/components/DetailsSummary/DetailsSummary.css.d.ts +1 -0
- package/dist/components/DetailsSummary/DetailsSummary.d.ts +5 -1
- package/dist/components/DetailsSummary/DetailsSummary.js +15 -15
- package/dist/components/DetailsSummary/DetailsSummary.js.map +1 -1
- package/dist/components/DetailsSummary/DetailsSummary.styles.js +10 -2
- package/dist/components/DetailsSummary/DetailsSummary.styles.js.map +1 -1
- package/dist/components/DetailsSummary/index.d.ts +1 -1
- package/dist/components/Drawer/Drawer.css.d.ts +3 -0
- package/dist/components/Drawer/Drawer.d.ts +24 -3
- package/dist/components/Drawer/Drawer.js +55 -46
- package/dist/components/Drawer/Drawer.js.map +1 -1
- package/dist/components/Drawer/Drawer.styles.js +7 -2
- package/dist/components/Drawer/Drawer.styles.js.map +1 -1
- package/dist/components/EmptyState/EmptyState.css.d.ts +16 -0
- package/dist/components/EmptyState/EmptyState.d.ts +15 -0
- package/dist/components/EmptyState/EmptyState.js +37 -0
- package/dist/components/EmptyState/EmptyState.js.map +1 -0
- package/dist/components/EmptyState/EmptyState.styles.js +15 -0
- package/dist/components/EmptyState/EmptyState.styles.js.map +1 -0
- package/dist/components/EmptyState/index.d.ts +2 -0
- package/dist/components/EnvironmentChip/EnvironmentChip.css.d.ts +5 -0
- package/dist/components/EnvironmentChip/EnvironmentChip.d.ts +13 -5
- package/dist/components/EnvironmentChip/EnvironmentChip.js +14 -3
- package/dist/components/EnvironmentChip/EnvironmentChip.js.map +1 -1
- package/dist/components/EnvironmentChip/EnvironmentChip.styles.js +3 -2
- package/dist/components/EnvironmentChip/EnvironmentChip.styles.js.map +1 -1
- package/dist/components/EnvironmentChip/index.d.ts +2 -2
- package/dist/components/Field/Field.css.d.ts +0 -1
- package/dist/components/Field/Field.d.ts +11 -28
- package/dist/components/Field/Field.js +25 -36
- package/dist/components/Field/Field.js.map +1 -1
- package/dist/components/Field/Field.styles.js +2 -2
- package/dist/components/Field/Field.styles.js.map +1 -1
- package/dist/components/Field/index.d.ts +1 -1
- package/dist/components/Fieldset/Fieldset.d.ts +1 -0
- package/dist/components/Fieldset/Fieldset.js.map +1 -1
- package/dist/components/Fieldset/Fieldset.styles.js.map +1 -1
- package/dist/components/Grid/Grid.css.d.ts +22 -0
- package/dist/components/Grid/Grid.d.ts +21 -0
- package/dist/components/Grid/Grid.js +23 -0
- package/dist/components/Grid/Grid.js.map +1 -0
- package/dist/components/Grid/Grid.styles.js +28 -0
- package/dist/components/Grid/Grid.styles.js.map +1 -0
- package/dist/components/Grid/index.d.ts +2 -0
- package/dist/components/List/List.d.ts +1 -0
- package/dist/components/List/List.js.map +1 -1
- package/dist/components/Loader/Loader.d.ts +1 -1
- package/dist/components/Loader/Loader.js +6 -2
- package/dist/components/Loader/Loader.js.map +1 -1
- package/dist/components/Menu/Menu.d.ts +25 -1
- package/dist/components/Menu/Menu.js +1 -1
- package/dist/components/Menu/Menu.js.map +1 -1
- package/dist/components/Menu/Menu.styles.js.map +1 -1
- package/dist/components/MetricBar/MetricBar.css.d.ts +5 -0
- package/dist/components/MetricBar/MetricBar.d.ts +9 -1
- package/dist/components/MetricBar/MetricBar.js +38 -22
- package/dist/components/MetricBar/MetricBar.js.map +1 -1
- package/dist/components/MetricBar/MetricBar.styles.js +15 -10
- package/dist/components/MetricBar/MetricBar.styles.js.map +1 -1
- package/dist/components/Modal/Modal.d.ts +6 -0
- package/dist/components/Modal/Modal.js +25 -28
- package/dist/components/Modal/Modal.js.map +1 -1
- package/dist/components/Modal/Modal.styles.js +2 -1
- package/dist/components/Modal/Modal.styles.js.map +1 -1
- package/dist/components/NavRail/NavRail.css.d.ts +2 -0
- package/dist/components/NavRail/NavRail.d.ts +22 -7
- package/dist/components/NavRail/NavRail.js +79 -58
- package/dist/components/NavRail/NavRail.js.map +1 -1
- package/dist/components/NavRail/NavRail.styles.js +3 -2
- package/dist/components/NavRail/NavRail.styles.js.map +1 -1
- package/dist/components/NavRail/index.d.ts +1 -1
- package/dist/components/NumberInput/NumberInput.d.ts +9 -1
- package/dist/components/NumberInput/NumberInput.js +37 -31
- package/dist/components/NumberInput/NumberInput.js.map +1 -1
- package/dist/components/PageHeader/PageHeader.css.d.ts +1 -1
- package/dist/components/PageHeader/PageHeader.d.ts +3 -1
- package/dist/components/PageHeader/PageHeader.js +21 -23
- package/dist/components/PageHeader/PageHeader.js.map +1 -1
- package/dist/components/PageHeader/PageHeader.styles.js +1 -1
- package/dist/components/PageHeader/PageHeader.styles.js.map +1 -1
- package/dist/components/Pagination/Pagination.d.ts +5 -0
- package/dist/components/Pagination/Pagination.js.map +1 -1
- package/dist/components/Popover/Popover.d.ts +9 -1
- package/dist/components/Popover/Popover.js +7 -6
- package/dist/components/Popover/Popover.js.map +1 -1
- package/dist/components/Popover/Popover.styles.js.map +1 -1
- package/dist/components/PortalContainer/PortalContainer.d.ts +1 -0
- package/dist/components/PortalContainer/PortalContainer.js.map +1 -1
- package/dist/components/ProgressBar/ProgressBar.css.d.ts +3 -0
- package/dist/components/ProgressBar/ProgressBar.d.ts +5 -1
- package/dist/components/ProgressBar/ProgressBar.js +21 -7
- package/dist/components/ProgressBar/ProgressBar.js.map +1 -1
- package/dist/components/ProgressBar/ProgressBar.styles.js +6 -6
- package/dist/components/ProgressBar/ProgressBar.styles.js.map +1 -1
- package/dist/components/RadioCards/RadioCards.d.ts +8 -2
- package/dist/components/RadioCards/RadioCards.js +40 -44
- package/dist/components/RadioCards/RadioCards.js.map +1 -1
- package/dist/components/SaveBar/SaveBar.d.ts +6 -1
- package/dist/components/SaveBar/SaveBar.js +1 -2
- package/dist/components/SaveBar/SaveBar.js.map +1 -1
- package/dist/components/SaveBar/SaveBar.styles.js.map +1 -1
- package/dist/components/Select/Select.css.d.ts +2 -0
- package/dist/components/Select/Select.d.ts +32 -5
- package/dist/components/Select/Select.js +91 -62
- package/dist/components/Select/Select.js.map +1 -1
- package/dist/components/Select/Select.styles.js +3 -2
- package/dist/components/Select/Select.styles.js.map +1 -1
- package/dist/components/Skeleton/Skeleton.d.ts +2 -0
- package/dist/components/Skeleton/Skeleton.js +20 -19
- package/dist/components/Skeleton/Skeleton.js.map +1 -1
- package/dist/components/Stack/Stack.css.d.ts +4 -1
- package/dist/components/Stack/Stack.d.ts +7 -3
- package/dist/components/Stack/Stack.js.map +1 -1
- package/dist/components/Stack/Stack.styles.js +16 -23
- package/dist/components/Stack/Stack.styles.js.map +1 -1
- package/dist/components/StatCard/StatCard.d.ts +3 -0
- package/dist/components/StatCard/StatCard.js.map +1 -1
- package/dist/components/StatCard/StatCard.styles.js.map +1 -1
- package/dist/components/StatsGrid/StatsGrid.d.ts +3 -6
- package/dist/components/StatsGrid/StatsGrid.js +3 -7
- package/dist/components/StatsGrid/StatsGrid.js.map +1 -1
- package/dist/components/StatusBadge/StatusBadge.d.ts +3 -2
- package/dist/components/StatusBadge/StatusBadge.js.map +1 -1
- package/dist/components/Switch/Switch.d.ts +2 -1
- package/dist/components/Switch/Switch.js +27 -31
- package/dist/components/Switch/Switch.js.map +1 -1
- package/dist/components/Switcher/Switcher.css.d.ts +0 -1
- package/dist/components/Switcher/Switcher.d.ts +13 -1
- package/dist/components/Switcher/Switcher.js +35 -35
- package/dist/components/Switcher/Switcher.js.map +1 -1
- package/dist/components/Switcher/Switcher.styles.js +2 -2
- package/dist/components/Switcher/Switcher.styles.js.map +1 -1
- package/dist/components/Table/Table.css.d.ts +16 -1
- package/dist/components/Table/Table.d.ts +110 -13
- package/dist/components/Table/Table.js +214 -102
- package/dist/components/Table/Table.js.map +1 -1
- package/dist/components/Table/Table.styles.js +7 -6
- package/dist/components/Table/Table.styles.js.map +1 -1
- package/dist/components/Table/index.d.ts +1 -1
- package/dist/components/Tabs/Tabs.d.ts +23 -8
- package/dist/components/Tabs/Tabs.js +1 -1
- package/dist/components/Tabs/Tabs.js.map +1 -1
- package/dist/components/Tabs/Tabs.styles.js.map +1 -1
- package/dist/components/Tabs/index.d.ts +1 -1
- package/dist/components/Tag/Tag.css.d.ts +33 -0
- package/dist/components/Tag/Tag.d.ts +5 -2
- package/dist/components/Tag/Tag.js +23 -6
- package/dist/components/Tag/Tag.js.map +1 -1
- package/dist/components/Tag/Tag.styles.js +12 -1
- package/dist/components/Tag/Tag.styles.js.map +1 -1
- package/dist/components/Tag/index.d.ts +1 -1
- package/dist/components/TextInput/TextInput.d.ts +13 -2
- package/dist/components/TextInput/TextInput.js +45 -48
- package/dist/components/TextInput/TextInput.js.map +1 -1
- package/dist/components/Textarea/Textarea.css.d.ts +2 -0
- package/dist/components/Textarea/Textarea.d.ts +5 -2
- package/dist/components/Textarea/Textarea.js +37 -37
- package/dist/components/Textarea/Textarea.js.map +1 -1
- package/dist/components/Textarea/Textarea.styles.js +3 -2
- package/dist/components/Textarea/Textarea.styles.js.map +1 -1
- package/dist/components/ThemeMenu/ThemeMenu.d.ts +13 -0
- package/dist/components/ThemeMenu/ThemeMenu.js +52 -0
- package/dist/components/ThemeMenu/ThemeMenu.js.map +1 -0
- package/dist/components/ThemeMenu/index.d.ts +2 -0
- package/dist/components/ThemePicker/ThemePicker.d.ts +9 -1
- package/dist/components/ThemePicker/ThemePicker.js +3 -1
- package/dist/components/ThemePicker/ThemePicker.js.map +1 -1
- package/dist/components/TimeInput/TimeInput.d.ts +10 -0
- package/dist/components/TimeInput/TimeInput.js +29 -0
- package/dist/components/TimeInput/TimeInput.js.map +1 -0
- package/dist/components/TimeInput/index.d.ts +2 -0
- package/dist/components/ToggleGroup/ToggleGroup.d.ts +30 -10
- package/dist/components/ToggleGroup/ToggleGroup.js +60 -59
- package/dist/components/ToggleGroup/ToggleGroup.js.map +1 -1
- package/dist/components/ToggleGroup/ToggleGroup.styles.js.map +1 -1
- package/dist/components/ToggleGroup/index.d.ts +1 -1
- package/dist/components/Tooltip/Tooltip.css.d.ts +0 -1
- package/dist/components/Tooltip/Tooltip.d.ts +9 -5
- package/dist/components/Tooltip/Tooltip.js +9 -9
- package/dist/components/Tooltip/Tooltip.js.map +1 -1
- package/dist/components/Tooltip/Tooltip.styles.js +2 -2
- package/dist/components/Tooltip/Tooltip.styles.js.map +1 -1
- package/dist/components/TopBar/TopBar.styles.js.map +1 -1
- package/dist/components/UserMenu/UserMenu.d.ts +4 -3
- package/dist/components/UserMenu/UserMenu.js.map +1 -1
- package/dist/examples/Crm.css.d.ts +3 -0
- package/dist/examples/ExampleShell.d.ts +28 -0
- package/dist/examples/Expenses.css.d.ts +2 -0
- package/dist/examples/HiringTracker.css.d.ts +13 -0
- package/dist/examples/SalesPipeline.css.d.ts +11 -0
- package/dist/foundations/Foundations.css.d.ts +1 -1
- package/dist/index.d.ts +6 -0
- package/dist/index.js +51 -45
- package/dist/styles/input.css.d.ts +8 -0
- package/dist/styles/input.styles.js +3 -2
- package/dist/styles/input.styles.js.map +1 -1
- package/dist/styles/shared.css.d.ts +5 -0
- package/dist/styles/shared.styles.js.map +1 -1
- package/dist/styles.css +1 -1
- package/dist/theme/fontSize.d.ts +4 -4
- package/dist/theme/fontSize.js +8 -23
- package/dist/theme/fontSize.js.map +1 -1
- package/dist/theme/htmlSetting.d.ts +14 -0
- package/dist/theme/htmlSetting.js +33 -0
- package/dist/theme/htmlSetting.js.map +1 -0
- package/dist/theme/theme.d.ts +4 -4
- package/dist/theme/theme.js +18 -33
- package/dist/theme/theme.js.map +1 -1
- package/dist/tokens/index.d.ts +0 -2
- package/dist/tokens.js +1 -2
- package/package.json +6 -2
- package/skills/back-office-kit/SKILL.md +27 -14
- package/skills/back-office-kit/references/artifact-template.html +1 -0
- package/skills/back-office-kit/references/components.md +482 -251
- package/skills/back-office-kit/references/install.md +27 -4
- package/skills/back-office-kit/references/migrate.md +58 -2
- package/skills/back-office-kit/references/patterns.md +129 -33
- package/skills/back-office-kit/references/testing.md +26 -22
- package/dist/tokens/sprinkles.css.d.ts +0 -38
- package/dist/tokens/sprinkles.styles.js +0 -349
- package/dist/tokens/sprinkles.styles.js.map +0 -1
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@15gifts/back-office-kit",
|
|
3
|
-
"version": "0.1.0-alpha.
|
|
3
|
+
"version": "0.1.0-alpha.1",
|
|
4
4
|
"description": "React components and design tokens for Humara's internal, self-serve, SaaS-style tools (back offices, admin consoles, dashboards, ops tools). Not for customer-facing UI.",
|
|
5
5
|
"license": "SEE LICENSE IN LICENSE",
|
|
6
6
|
"type": "module",
|
|
@@ -71,11 +71,14 @@
|
|
|
71
71
|
"dependencies": {
|
|
72
72
|
"@base-ui/react": "1.9.0",
|
|
73
73
|
"@vanilla-extract/recipes": "0.5.7",
|
|
74
|
-
"@vanilla-extract/sprinkles": "1.7.1",
|
|
75
74
|
"clsx": "2.1.1",
|
|
76
75
|
"lucide-react": "1.68.0",
|
|
77
76
|
"react-day-picker": "10.0.2"
|
|
78
77
|
},
|
|
78
|
+
"peerDependencies": {
|
|
79
|
+
"react": "^19.0.0",
|
|
80
|
+
"react-dom": "^19.0.0"
|
|
81
|
+
},
|
|
79
82
|
"devDependencies": {
|
|
80
83
|
"@15gifts/eslint-config-humara": "1.1.1",
|
|
81
84
|
"@changesets/cli": "3.0.3",
|
|
@@ -99,6 +102,7 @@
|
|
|
99
102
|
"react": "19.3.1",
|
|
100
103
|
"react-docgen-typescript": "2.4.0",
|
|
101
104
|
"react-dom": "19.3.1",
|
|
105
|
+
"react-hook-form": "7.91.0",
|
|
102
106
|
"storybook": "10.6.5",
|
|
103
107
|
"tsx": "4.23.15",
|
|
104
108
|
"typescript": "6.0.3",
|
|
@@ -10,27 +10,40 @@ description: Build UI for Humara's internal, self-serve, SaaS-style tools (back
|
|
|
10
10
|
## Workflow
|
|
11
11
|
|
|
12
12
|
1. **Is it set up?** Check `package.json` for `@15gifts/back-office-kit` and the app entry for `import '@15gifts/back-office-kit/styles.css'`. If either is missing, follow [references/install.md](references/install.md). For a Claude artifact, follow its "Claude artifacts" section and start from [references/artifact-template.html](references/artifact-template.html).
|
|
13
|
-
2. **Pick components** from [references/components.md](references/components.md). That's the full catalogue
|
|
14
|
-
3. **Lay out pages** using the recipes in [references/patterns.md](references/patterns.md): app shell,
|
|
13
|
+
2. **Pick components** from [references/components.md](references/components.md). That's the full catalogue (props, helpers, theme functions, types), generated from the source, so trust it over memory. Read it before writing UI.
|
|
14
|
+
3. **Lay out pages** using the recipes in [references/patterns.md](references/patterns.md): app shell, data table page, dashboard, detail view, settings form, conversation view.
|
|
15
15
|
4. **Migrating existing UI?** Follow [references/migrate.md](references/migrate.md).
|
|
16
16
|
5. **Write or update tests** using [references/testing.md](references/testing.md): the role and query for each component, portals, Modal and Drawer behaviour, the jsdom setup, and how to pass test IDs.
|
|
17
|
-
6. **Verify.** Run the app's type-check (`npx tsc --noEmit`, or its `typecheck` script). `vite build` does not check types. Then open the page in light and dark.
|
|
18
|
-
|
|
17
|
+
6. **Verify.** Run the app's type-check (`npx tsc --noEmit`, or its `typecheck` script). `vite build` does not check types. Then open the page in light and dark, and tab through it with the keyboard.
|
|
18
|
+
|
|
19
|
+
## Keep every tool consistent
|
|
20
|
+
|
|
21
|
+
- **One frame level. Don't nest cards.** A `Card`, or a top-level `Fieldset` (it renders as a card), never goes inside another card. If a page is split into cards, its wrapper is plain layout (`Stack`, or straight inside `AppShell`). Inside a card, separate sections with headings and dividers. A `Table` inside a card is fine.
|
|
22
|
+
- **One `primary` Button per view.** Other actions are `secondary`, toolbar and table actions are `ghost`, destructive ones `danger`.
|
|
23
|
+
- **Forms use react-hook-form.** `useForm` owns values, dirty state and validation; `register` the text fields and wrap the rest in `<Controller>`; show messages via each field's `error`; `noValidate` on the `<form>`; a `SaveBar` driven by `formState.dirtyFields` on settings pages. Follow the settings-form recipe in patterns.md. No form state in `useState`, no other form library.
|
|
24
|
+
- **Status colour only through components:** `StatusBadge` for run/job states, `Badge` and `Alert` tones otherwise.
|
|
25
|
+
- **Use component props, not CSS overrides.** Don't restyle library components with `className` or `style` (colours, sizes, padding). If a variant is missing, say so.
|
|
26
|
+
- **Text size:** the default (`md`) is a 16px root with 14px body text. Never set `html { font-size }`, and size your own CSS in rem/em (never px, except 1px borders), so the user's text-size setting scales everything.
|
|
27
|
+
- **Wide tables scroll inside themselves.** Don't wrap `Table` in your own overflow container.
|
|
28
|
+
|
|
29
|
+
## Your own CSS
|
|
30
|
+
|
|
31
|
+
Only for layout or app-specific elements the library doesn't cover.
|
|
32
|
+
|
|
33
|
+
- **Tokens, never raw values.** Colours, fonts and shadows come from CSS variables (`var(--bok-surface)`, `var(--bok-ink)`, `var(--bok-border)`, …) or, in Vanilla Extract apps, `vars` from `@15gifts/back-office-kit/tokens`. No hex, rgb or named colours, no font stacks, no custom shadows.
|
|
34
|
+
- `--bok-accent`/`--bok-success`/`--bok-warning`/`--bok-danger`/`--bok-info` are fills (bars, dots, borders). Text uses the `-ink` variant (`--bok-success-ink`, …).
|
|
35
|
+
- `--bok-font-mono` is for IDs, codes and timestamps-as-identifiers. Everything else uses the default (Poppins).
|
|
36
|
+
- Spacing on a 0.25rem grid (`0.5rem`, `0.75rem`, `1rem`, `1.5rem`, `2rem`).
|
|
37
|
+
- **Use the platform.** Flex/grid for layout (or `Stack`), `gap` instead of margins between siblings, real `<button>`, `<a href>` and `<form onSubmit>` elements instead of clickable `div`s, `:focus-visible` for focus styles, and `@media (prefers-reduced-motion: reduce)` around your own animations. No JavaScript for what CSS can do.
|
|
19
38
|
|
|
20
39
|
## Rules
|
|
21
40
|
|
|
22
41
|
- Import named components from the package root: `import { Button, Card, Table } from '@15gifts/back-office-kit'`.
|
|
23
42
|
- Import `@15gifts/back-office-kit/styles.css` exactly once, at the app entry.
|
|
24
43
|
- The Humara logo is built into `NavRail`. Don't add a logo; set `appName` to the tool's name (e.g. `appName="Persona Service"`), which shows under the logo.
|
|
25
|
-
-
|
|
26
|
-
-
|
|
27
|
-
-
|
|
28
|
-
-
|
|
29
|
-
- Use `vars.font.mono` / `--bok-font-mono` for IDs, codes and timestamps-as-identifiers. Everything else is Poppins.
|
|
30
|
-
- Icons come from `lucide-react`. Pass them as elements sized in em so they scale with text (`icon={<Play size="1em" aria-hidden />}`). Use `1em` beside body text and `1.25em` for slightly heavier icons. You'll see odd values like `1.23em` inside the library: that's today's pixel size divided by the surrounding text size, to keep proportions. Don't copy them, just pick `1em`/`1.25em`.
|
|
31
|
-
- Sizes in your own CSS are rem/em, never px (except 1px borders): the global text-size setting depends on it.
|
|
44
|
+
- Icons come from `lucide-react`. Pass them as elements sized in em so they scale with text: `icon={<Play size="1em" aria-hidden />}`. Use `1em` beside text (buttons, inputs, badges) and `1.25rem` for `NavRail` items. Ignore the odd em values (`1.23em`, …) inside the library source; don't copy them.
|
|
45
|
+
- Links inside library components use the `render` prop with the app's router: `render={<Link to="/runs" />}`. Without a router, use `href`.
|
|
46
|
+
- Every input needs a `label`, even if visually hidden (`hideLabel`). Icon-only buttons need an accessible name.
|
|
47
|
+
- Theme with `setTheme('light' | 'dark' | 'sand' | 'system')`, `useTheme()` or `ThemePicker`. Don't write theme CSS.
|
|
32
48
|
- Lint with ESLint and `@15gifts/eslint-config-humara`, not oxlint (see install.md › Linting).
|
|
33
|
-
- Links inside library components use the `render` prop with the app's router: `render={<Link to="/runs" />}`.
|
|
34
|
-
- Every input needs a `label`, even if visually hidden. Icon-only buttons need `aria-label`.
|
|
35
|
-
- Theme with `setTheme('light' | 'dark' | 'sand' | 'system')` or `useTheme()`. Don't write theme CSS.
|
|
36
49
|
- If something is missing from the library, build it from tokens in the app, and tell the user it might be worth adding to `@15gifts/back-office-kit`.
|
|
@@ -26,6 +26,7 @@
|
|
|
26
26
|
"react-dom": "https://cdn.jsdelivr.net/npm/react-dom@REACT_VERSION/+esm",
|
|
27
27
|
"react-dom/client": "https://cdn.jsdelivr.net/npm/react-dom@REACT_VERSION/client/+esm",
|
|
28
28
|
"htm": "https://cdn.jsdelivr.net/npm/htm@3.1.1/+esm",
|
|
29
|
+
"react-hook-form": "https://cdn.jsdelivr.net/npm/react-hook-form@7.91.0/+esm",
|
|
29
30
|
"lucide-react": "https://cdn.jsdelivr.net/npm/lucide-react@LUCIDE_VERSION/+esm",
|
|
30
31
|
"@15gifts/back-office-kit": "https://cdn.jsdelivr.net/npm/@15gifts/back-office-kit@VERSION/dist/browser/back-office-kit.js"
|
|
31
32
|
}
|