@matteoaliano/forest-ui 0.2.10 → 0.3.0
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 +123 -0
- package/bin/sync.mjs +18 -34
- package/dist/{chunk-7B6NCKX3.mjs → chunk-EULMNCHH.mjs} +1039 -498
- package/dist/chunk-EULMNCHH.mjs.map +1 -0
- package/dist/{index-DiI9xbOM.d.mts → index-EkBIDmEu.d.mts} +109 -12
- package/dist/{index-DiI9xbOM.d.ts → index-EkBIDmEu.d.ts} +109 -12
- package/dist/index.d.mts +83 -20
- package/dist/index.d.ts +83 -20
- package/dist/index.js +1306 -571
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +233 -69
- package/dist/index.mjs.map +1 -1
- package/dist/theme.d.mts +1 -1
- package/dist/theme.d.ts +1 -1
- package/dist/theme.js +1039 -497
- package/dist/theme.js.map +1 -1
- package/dist/theme.mjs +1 -1
- package/guidelines/FOREST_BE_GUIDELINES.md +90 -0
- package/guidelines/FOREST_FE_GUIDELINES.md +543 -0
- package/guidelines/FOREST_UI_GUIDELINES.md +372 -0
- package/package.json +16 -4
- package/dist/chunk-7B6NCKX3.mjs.map +0 -1
- package/guidelines/FOREST_AI_GUIDELINES.md +0 -344
- package/guidelines/FOREST_DEV_GUIDELINES.md +0 -47
- package/guidelines/themes/FOREST_THEME_ALKEMY_PLUS.md +0 -139
- package/guidelines/themes/FOREST_THEME_DEFAULT.md +0 -70
package/dist/index.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import * as react_jsx_runtime from 'react/jsx-runtime';
|
|
2
2
|
import { Theme } from '@mui/material/styles';
|
|
3
|
-
export { D as DesignTokens, P as PresetVariantConfig, T as ThemePreset, a as
|
|
3
|
+
export { D as DesignTokens, P as PresetVariantConfig, T as ThemePreset, a as alpha, b as avatarColors, c as bg, d as border, e as breadcrumbColors, f as buildTheme, g as buildThemeOptions, h as buttonColors, i as chartColors, j as colors, k as container, l as display, m as fg, n as focusRings, o as fontFamily, p as fontSize, q as fontWeight, r as forestAgencyPreset, s as forestExternalPreset, t as forestInternalPreset, u as forestTheme, v as forestThemeOptions, w as getAvailablePresets, x as getPreset, y as iconColors, z as lineHeight, A as navColors, B as radius, C as registerPreset, E as sliderColors, F as spacing, G as text, H as toggleColors, I as tokenShadows, J as widths } from './index-EkBIDmEu.js';
|
|
4
4
|
import { AutocompleteProps } from '@mui/material/Autocomplete';
|
|
5
5
|
export { AutocompleteProps } from '@mui/material/Autocomplete';
|
|
6
6
|
import { ButtonProps as ButtonProps$1 } from '@mui/material/Button';
|
|
@@ -22,10 +22,14 @@ import { SwitchProps } from '@mui/material/Switch';
|
|
|
22
22
|
export { SwitchProps } from '@mui/material/Switch';
|
|
23
23
|
import { TextFieldProps } from '@mui/material/TextField';
|
|
24
24
|
export { TextFieldProps } from '@mui/material/TextField';
|
|
25
|
+
import * as React$1 from 'react';
|
|
26
|
+
import React__default from 'react';
|
|
27
|
+
import { BoxProps } from '@mui/material';
|
|
25
28
|
import { ToggleButtonProps } from '@mui/material/ToggleButton';
|
|
26
29
|
export { ToggleButtonProps } from '@mui/material/ToggleButton';
|
|
27
30
|
import { ToggleButtonGroupProps } from '@mui/material/ToggleButtonGroup';
|
|
28
31
|
export { ToggleButtonGroupProps } from '@mui/material/ToggleButtonGroup';
|
|
32
|
+
import { DatePickerProps as DatePickerProps$1 } from '@mui/x-date-pickers/DatePicker';
|
|
29
33
|
import { BadgeProps } from '@mui/material/Badge';
|
|
30
34
|
export { BadgeProps } from '@mui/material/Badge';
|
|
31
35
|
import { ChipProps } from '@mui/material/Chip';
|
|
@@ -110,16 +114,38 @@ import { CircularProgressProps } from '@mui/material/CircularProgress';
|
|
|
110
114
|
export { CircularProgressProps } from '@mui/material/CircularProgress';
|
|
111
115
|
import { SkeletonProps } from '@mui/material/Skeleton';
|
|
112
116
|
export { SkeletonProps } from '@mui/material/Skeleton';
|
|
117
|
+
import { ModalProps } from '@mui/material/Modal';
|
|
118
|
+
export { ModalProps } from '@mui/material/Modal';
|
|
119
|
+
import { PopoverProps } from '@mui/material/Popover';
|
|
120
|
+
export { PopoverProps } from '@mui/material/Popover';
|
|
113
121
|
import { SnackbarProps } from '@mui/material/Snackbar';
|
|
114
122
|
export { SnackbarProps } from '@mui/material/Snackbar';
|
|
115
|
-
import
|
|
123
|
+
import { BreadcrumbsProps } from '@mui/material/Breadcrumbs';
|
|
124
|
+
export { BreadcrumbsProps } from '@mui/material/Breadcrumbs';
|
|
125
|
+
import { LinkProps } from '@mui/material/Link';
|
|
126
|
+
export { LinkProps } from '@mui/material/Link';
|
|
127
|
+
import { MenuProps } from '@mui/material/Menu';
|
|
128
|
+
export { MenuProps } from '@mui/material/Menu';
|
|
129
|
+
import { MenuListProps } from '@mui/material/MenuList';
|
|
130
|
+
export { MenuListProps } from '@mui/material/MenuList';
|
|
131
|
+
import { PaginationProps } from '@mui/material/Pagination';
|
|
132
|
+
export { PaginationProps } from '@mui/material/Pagination';
|
|
133
|
+
import { StepperProps } from '@mui/material/Stepper';
|
|
134
|
+
export { StepperProps } from '@mui/material/Stepper';
|
|
135
|
+
import { StepProps } from '@mui/material/Step';
|
|
136
|
+
export { StepProps } from '@mui/material/Step';
|
|
137
|
+
import { StepLabelProps } from '@mui/material/StepLabel';
|
|
138
|
+
export { StepLabelProps } from '@mui/material/StepLabel';
|
|
139
|
+
import { TabsProps } from '@mui/material/Tabs';
|
|
140
|
+
export { TabsProps } from '@mui/material/Tabs';
|
|
141
|
+
import { TabProps } from '@mui/material/Tab';
|
|
142
|
+
export { TabProps } from '@mui/material/Tab';
|
|
116
143
|
import { DrawerProps } from '@mui/material/Drawer';
|
|
117
144
|
import { LineChartProps as LineChartProps$1 } from '@mui/x-charts/LineChart';
|
|
118
145
|
import { BarChartProps as BarChartProps$1 } from '@mui/x-charts/BarChart';
|
|
119
146
|
import { MakeOptional } from '@mui/x-charts/models/helpers';
|
|
120
147
|
import { BarSeriesType } from '@mui/x-charts/models/seriesType/bar';
|
|
121
148
|
import { PieChartProps as PieChartProps$1 } from '@mui/x-charts/PieChart';
|
|
122
|
-
import '@mui/material';
|
|
123
149
|
|
|
124
150
|
interface ForestProviderProps {
|
|
125
151
|
children: React.ReactNode;
|
|
@@ -164,9 +190,32 @@ declare function Switch(props: SwitchProps): react_jsx_runtime.JSX.Element;
|
|
|
164
190
|
|
|
165
191
|
declare function TextField(props: TextFieldProps): react_jsx_runtime.JSX.Element;
|
|
166
192
|
|
|
193
|
+
type SearchProps = Omit<TextFieldProps, "variant"> & {
|
|
194
|
+
onClear?: () => void;
|
|
195
|
+
};
|
|
196
|
+
declare function Search({ value: controlledValue, onChange, onClear, placeholder, slotProps, ...props }: SearchProps): react_jsx_runtime.JSX.Element;
|
|
197
|
+
|
|
198
|
+
interface LogoProps extends BoxProps {
|
|
199
|
+
/** Product variant */
|
|
200
|
+
variant?: 'agency' | 'external' | 'internal';
|
|
201
|
+
/** Logo size */
|
|
202
|
+
size?: 'sm' | 'md' | 'lg' | 'xl';
|
|
203
|
+
/** Whether to show the logomark only (no text) */
|
|
204
|
+
logomarkOnly?: boolean;
|
|
205
|
+
}
|
|
206
|
+
/**
|
|
207
|
+
* Logo component for Forest product suite
|
|
208
|
+
*
|
|
209
|
+
* Displays Forest logo with support for different product variants and sizes.
|
|
210
|
+
*/
|
|
211
|
+
declare const Logo: React$1.ForwardRefExoticComponent<Omit<LogoProps, "ref"> & React$1.RefAttributes<HTMLDivElement>>;
|
|
212
|
+
|
|
167
213
|
declare function ToggleButton(props: ToggleButtonProps): react_jsx_runtime.JSX.Element;
|
|
168
214
|
declare function ToggleButtonGroup(props: ToggleButtonGroupProps): react_jsx_runtime.JSX.Element;
|
|
169
215
|
|
|
216
|
+
type DatePickerProps = DatePickerProps$1;
|
|
217
|
+
declare function DatePicker(props: DatePickerProps): react_jsx_runtime.JSX.Element;
|
|
218
|
+
|
|
170
219
|
declare function Badge(props: BadgeProps): react_jsx_runtime.JSX.Element;
|
|
171
220
|
|
|
172
221
|
declare function Chip(props: ChipProps): react_jsx_runtime.JSX.Element;
|
|
@@ -210,7 +259,7 @@ declare function CardMedia(props: CardMediaProps): react_jsx_runtime.JSX.Element
|
|
|
210
259
|
|
|
211
260
|
declare function Paper(props: PaperProps): react_jsx_runtime.JSX.Element;
|
|
212
261
|
|
|
213
|
-
declare
|
|
262
|
+
declare const Alert: React__default.ForwardRefExoticComponent<Omit<AlertProps, "ref"> & React__default.RefAttributes<HTMLDivElement>>;
|
|
214
263
|
declare function AlertTitle(props: AlertTitleProps): react_jsx_runtime.JSX.Element;
|
|
215
264
|
|
|
216
265
|
declare function Backdrop(props: BackdropProps): react_jsx_runtime.JSX.Element;
|
|
@@ -226,8 +275,28 @@ declare function CircularProgress(props: CircularProgressProps): react_jsx_runti
|
|
|
226
275
|
|
|
227
276
|
declare function Skeleton(props: SkeletonProps): react_jsx_runtime.JSX.Element;
|
|
228
277
|
|
|
278
|
+
declare function Modal(props: ModalProps): react_jsx_runtime.JSX.Element;
|
|
279
|
+
|
|
280
|
+
declare function Popover(props: PopoverProps): react_jsx_runtime.JSX.Element;
|
|
281
|
+
|
|
229
282
|
declare function Snackbar(props: SnackbarProps): react_jsx_runtime.JSX.Element;
|
|
230
283
|
|
|
284
|
+
declare function Breadcrumbs(props: BreadcrumbsProps): react_jsx_runtime.JSX.Element;
|
|
285
|
+
|
|
286
|
+
declare function Link(props: LinkProps): react_jsx_runtime.JSX.Element;
|
|
287
|
+
|
|
288
|
+
declare function Menu(props: MenuProps): react_jsx_runtime.JSX.Element;
|
|
289
|
+
declare function MenuList(props: MenuListProps): react_jsx_runtime.JSX.Element;
|
|
290
|
+
|
|
291
|
+
declare function Pagination(props: PaginationProps): react_jsx_runtime.JSX.Element;
|
|
292
|
+
|
|
293
|
+
declare function Stepper(props: StepperProps): react_jsx_runtime.JSX.Element;
|
|
294
|
+
declare function Step(props: StepProps): react_jsx_runtime.JSX.Element;
|
|
295
|
+
declare function StepLabel(props: StepLabelProps): react_jsx_runtime.JSX.Element;
|
|
296
|
+
|
|
297
|
+
declare function Tabs(props: TabsProps): react_jsx_runtime.JSX.Element;
|
|
298
|
+
declare function Tab(props: TabProps): react_jsx_runtime.JSX.Element;
|
|
299
|
+
|
|
231
300
|
interface SidebarContextValue {
|
|
232
301
|
open: boolean;
|
|
233
302
|
collapsedWidth: number;
|
|
@@ -251,29 +320,27 @@ interface SidebarNavProps extends Omit<DrawerProps, "open" | "variant" | "onClos
|
|
|
251
320
|
/** Whether to show the edge toggle button (default: true for "permanent", false for "hover") */
|
|
252
321
|
showToggle?: boolean;
|
|
253
322
|
/** Content rendered inside the sidebar */
|
|
254
|
-
children:
|
|
323
|
+
children: React__default.ReactNode;
|
|
255
324
|
/** Optional header slot — rendered above children */
|
|
256
|
-
header?:
|
|
325
|
+
header?: React__default.ReactNode;
|
|
257
326
|
/** Optional footer slot — rendered at bottom */
|
|
258
|
-
footer?:
|
|
327
|
+
footer?: React__default.ReactNode;
|
|
259
328
|
}
|
|
260
329
|
declare function SidebarNav({ open, onOpenChange, expandedWidth, collapsedWidth, behavior, showToggle, children, header, footer, sx, ...rest }: SidebarNavProps): react_jsx_runtime.JSX.Element;
|
|
261
330
|
interface SidebarItemProps extends Omit<ListItemButtonProps, "children"> {
|
|
262
331
|
/** Icon element (required — visible in both expanded and collapsed states) */
|
|
263
|
-
icon:
|
|
332
|
+
icon: React__default.ReactNode;
|
|
264
333
|
/** Label text */
|
|
265
334
|
label: string;
|
|
266
335
|
/** Optional content rendered on the right side when expanded (badge, count, etc.) */
|
|
267
|
-
endAdornment?:
|
|
336
|
+
endAdornment?: React__default.ReactNode;
|
|
268
337
|
}
|
|
269
338
|
declare function SidebarItem({ icon, label, endAdornment, sx, ...rest }: SidebarItemProps): react_jsx_runtime.JSX.Element;
|
|
270
339
|
|
|
271
340
|
interface LineChartProps extends Omit<LineChartProps$1, "series"> {
|
|
272
341
|
series?: LineChartProps$1["series"];
|
|
273
|
-
/** Which color palette variant to use (categorical=12 pastel, vibrant=5 bright) */
|
|
274
|
-
palette?: "categorical" | "vibrant";
|
|
275
342
|
}
|
|
276
|
-
declare function LineChart({ series, colors,
|
|
343
|
+
declare function LineChart({ series, colors, ...props }: LineChartProps): react_jsx_runtime.JSX.Element;
|
|
277
344
|
|
|
278
345
|
type ForestBarSeriesType = MakeOptional<BarSeriesType, "type"> & {
|
|
279
346
|
/** Enables diagonal striped fill for comparative data representation */
|
|
@@ -281,18 +348,14 @@ type ForestBarSeriesType = MakeOptional<BarSeriesType, "type"> & {
|
|
|
281
348
|
};
|
|
282
349
|
interface BarChartProps extends Omit<BarChartProps$1, "series"> {
|
|
283
350
|
series?: ForestBarSeriesType[];
|
|
284
|
-
/** Which color palette variant to use (categorical=12 pastel, vibrant=5 bright) */
|
|
285
|
-
palette?: "categorical" | "vibrant";
|
|
286
351
|
}
|
|
287
|
-
declare function BarChart({ series, colors,
|
|
352
|
+
declare function BarChart({ series, colors, ...props }: BarChartProps): react_jsx_runtime.JSX.Element;
|
|
288
353
|
|
|
289
354
|
interface PieChartProps extends Omit<PieChartProps$1, "series"> {
|
|
290
355
|
series?: PieChartProps$1["series"];
|
|
291
|
-
/** Which color palette variant to use (categorical=12 pastel, vibrant=5 bright) */
|
|
292
|
-
palette?: "categorical" | "vibrant";
|
|
293
356
|
}
|
|
294
|
-
declare function PieChart({ series, colors,
|
|
357
|
+
declare function PieChart({ series, colors, ...props }: PieChartProps): react_jsx_runtime.JSX.Element;
|
|
295
358
|
|
|
296
|
-
declare function useChartColors(count: number
|
|
359
|
+
declare function useChartColors(count: number): string[];
|
|
297
360
|
|
|
298
|
-
export { Accordion, AccordionActions, AccordionDetails, AccordionSummary, Alert, AlertTitle, AppBar, Autocomplete, Backdrop, Badge, BarChart, type BarChartProps, Button, ButtonGroup, type ButtonProps, Card, CardActions, CardContent, CardHeader, CardMedia, Checkbox, Chip, CircularProgress, DataGrid, Dialog, DialogActions, DialogContent, DialogContentText, DialogTitle, Divider, Fab, ForestProvider, type ForestProviderProps, LineChart, type LineChartProps, LinearProgress, List, ListItem, ListItemAvatar, ListItemButton, ListItemIcon, ListItemText, ListSubheader, MenuItem, MultiSelect, type MultiSelectOption, type MultiSelectProps, Paper, PieChart, type PieChartProps, Radio, RadioGroup, Select, SidebarItem, type SidebarItemProps, SidebarNav, type SidebarNavProps, Skeleton, Snackbar, Switch, Table, TableBody, TableCell, TableContainer, TableHead, TableRow, TextField, ToggleButton, ToggleButtonGroup, Toolbar, Tooltip, Typography, useChartColors, useSidebar };
|
|
361
|
+
export { Accordion, AccordionActions, AccordionDetails, AccordionSummary, Alert, AlertTitle, AppBar, Autocomplete, Backdrop, Badge, BarChart, type BarChartProps, Breadcrumbs, Button, ButtonGroup, type ButtonProps, Card, CardActions, CardContent, CardHeader, CardMedia, Checkbox, Chip, CircularProgress, DataGrid, DatePicker, type DatePickerProps, Dialog, DialogActions, DialogContent, DialogContentText, DialogTitle, Divider, Fab, ForestProvider, type ForestProviderProps, LineChart, type LineChartProps, LinearProgress, Link, List, ListItem, ListItemAvatar, ListItemButton, ListItemIcon, ListItemText, ListSubheader, Logo, type LogoProps, Menu, MenuItem, MenuList, Modal, MultiSelect, type MultiSelectOption, type MultiSelectProps, Pagination, Paper, PieChart, type PieChartProps, Popover, Radio, RadioGroup, Search, type SearchProps, Select, SidebarItem, type SidebarItemProps, SidebarNav, type SidebarNavProps, Skeleton, Snackbar, Step, StepLabel, Stepper, Switch, Tab, Table, TableBody, TableCell, TableContainer, TableHead, TableRow, Tabs, TextField, ToggleButton, ToggleButtonGroup, Toolbar, Tooltip, Typography, useChartColors, useSidebar };
|