@matteoaliano/forest-ui 1.2.3 → 1.2.5

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/dist/index.d.mts CHANGED
@@ -23,6 +23,7 @@ import { IconButtonProps as IconButtonProps$1 } from '@mui/material/IconButton';
23
23
  import * as React$1 from 'react';
24
24
  import React__default from 'react';
25
25
  import { ToggleButtonProps as ToggleButtonProps$1 } from '@mui/material/ToggleButton';
26
+ import { ToggleButtonGroupProps as ToggleButtonGroupProps$1 } from '@mui/material/ToggleButtonGroup';
26
27
  import { DatePickerProps as DatePickerProps$1 } from '@mui/x-date-pickers/DatePicker';
27
28
  export { default as FormControl, FormControlProps } from '@mui/material/FormControl';
28
29
  export { default as FormControlLabel, FormControlLabelProps } from '@mui/material/FormControlLabel';
@@ -168,7 +169,6 @@ export { default as CardHeader, CardHeaderProps } from '@mui/material/CardHeader
168
169
  export { default as CardMedia, CardMediaProps } from '@mui/material/CardMedia';
169
170
  export { default as MenuItem, MenuItemProps } from '@mui/material/MenuItem';
170
171
  export { default as SwipeableDrawer, SwipeableDrawerProps } from '@mui/material/SwipeableDrawer';
171
- export { default as ToggleButtonGroup, ToggleButtonGroupProps } from '@mui/material/ToggleButtonGroup';
172
172
  export { default as Toolbar, ToolbarProps } from '@mui/material/Toolbar';
173
173
 
174
174
  interface ForestProviderProps {
@@ -298,11 +298,22 @@ interface LogoProps extends Omit<BoxProps<'svg'>, 'component' | 'children'> {
298
298
  declare const Logo: React$1.ForwardRefExoticComponent<Omit<LogoProps, "ref"> & React$1.RefAttributes<SVGSVGElement>>;
299
299
 
300
300
  type ToggleButtonVariant = "contained" | "outlined";
301
+ type ToggleButtonGroupProps = ToggleButtonGroupProps$1 & {
302
+ /**
303
+ * Visual style for every child `<ToggleButton>`, so the whole segmented
304
+ * control is styled as one unit. `"outlined"` (default) is the transparent,
305
+ * grey-bordered face; `"contained"` is the charcoal faux-3D one. A child's
306
+ * own `variant` prop still wins.
307
+ */
308
+ variant?: ToggleButtonVariant;
309
+ };
310
+ declare function ToggleButtonGroup({ variant, ...props }: ToggleButtonGroupProps): react_jsx_runtime.JSX.Element;
301
311
  type ToggleButtonProps = ToggleButtonProps$1 & {
302
312
  /**
303
- * Visual style, matching `<ButtonGroup>`'s variants. `"contained"` (default)
304
- * is the charcoal faux-3D face; `"outlined"` is the transparent, grey-bordered
305
- * one. Selected stays "pressed in" in both.
313
+ * Visual style, matching `<ButtonGroup>`'s variants. `"outlined"` (default)
314
+ * is the transparent, grey-bordered face; `"contained"` is the charcoal
315
+ * faux-3D one. Selected stays "pressed in" in both. Inside a
316
+ * `<ToggleButtonGroup>`, omitting this inherits the group's variant.
306
317
  */
307
318
  variant?: ToggleButtonVariant;
308
319
  };
@@ -509,8 +520,12 @@ interface SidebarNavProps extends Omit<DrawerProps, "open" | "variant" | "onClos
509
520
  header?: React__default.ReactNode;
510
521
  /** Optional footer slot — rendered at bottom */
511
522
  footer?: React__default.ReactNode;
523
+ /** How far to either side of the sidebar's edge the pointer counts as "on the
524
+ * edge", in px. Inside this band the toggle fades in and tracks the pointer
525
+ * vertically; outside it the toggle is hidden. (default: 12) */
526
+ toggleEdgeAllowance?: number;
512
527
  }
513
- declare function SidebarNav({ open, onOpenChange, expandedWidth, collapsedWidth, behavior, showToggle, children, header, footer, sx, ...rest }: SidebarNavProps): react_jsx_runtime.JSX.Element;
528
+ declare function SidebarNav({ open, onOpenChange, expandedWidth, collapsedWidth, behavior, showToggle, children, header, footer, toggleEdgeAllowance, sx, ...rest }: SidebarNavProps): react_jsx_runtime.JSX.Element;
514
529
  interface SidebarItemProps extends ListItemButtonProps {
515
530
  /** Icon element (required — visible in both expanded and collapsed states) */
516
531
  icon: React__default.ReactNode;
@@ -558,6 +573,12 @@ interface AppShellProps {
558
573
  * sticky AppBar (brand / search / actions + the color-mode toggle) over a
559
574
  * SidebarNav and a main content area. Render a <Page> as children.
560
575
  *
576
+ * The AppBar and the sidebar read as one continuous L-shaped chrome — they
577
+ * already share `bg.primary`, so the shell drops the borders that used to cut
578
+ * them apart. The main region is then a lifted surface tucked into the corner
579
+ * they form: rounded at the top-left only, flush with the right and bottom
580
+ * window edges.
581
+ *
561
582
  * Below the "sm" breakpoint the sidebar becomes a temporary overlay drawer
562
583
  * opened by a hamburger button in the AppBar.
563
584
  */
@@ -622,4 +643,4 @@ declare function ScatterChart({ series, colors, ...props }: ScatterChartProps):
622
643
  type GaugeProps = GaugeProps$1;
623
644
  declare function Gauge(props: GaugeProps): react_jsx_runtime.JSX.Element;
624
645
 
625
- export { AppBarNavItem, type AppBarNavItemProps, AppShell, type AppShellNavItem, type AppShellProps, BarChart, type BarChartProps, Button, ButtonGroup, type ButtonProps, Card, type CardProps, Chip, DatePicker, type DatePickerProps, Drawer, Fab, type ForestCardColor, type ForestChipColor, type ForestChipProps, ForestProvider, type ForestProviderProps, Gauge, IconButton, type IconButtonProps, type IconButtonVariant, LineChart, type LineChartProps, Logo, type LogoProps, MultiSelect, type MultiSelectOption, type MultiSelectProps, Page, type PageBreadcrumb, type PageProps, PieChart, type PieChartProps, Popover, ScatterChart, Search, type SearchProps, Select, SidebarItem, type SidebarItemProps, SidebarNav, type SidebarNavProps, ToggleButton, type ToggleButtonProps, Tooltip, useChartColors, useSidebar };
646
+ export { AppBarNavItem, type AppBarNavItemProps, AppShell, type AppShellNavItem, type AppShellProps, BarChart, type BarChartProps, Button, ButtonGroup, type ButtonProps, Card, type CardProps, Chip, DatePicker, type DatePickerProps, Drawer, Fab, type ForestCardColor, type ForestChipColor, type ForestChipProps, ForestProvider, type ForestProviderProps, Gauge, IconButton, type IconButtonProps, type IconButtonVariant, LineChart, type LineChartProps, Logo, type LogoProps, MultiSelect, type MultiSelectOption, type MultiSelectProps, Page, type PageBreadcrumb, type PageProps, PieChart, type PieChartProps, Popover, ScatterChart, Search, type SearchProps, Select, SidebarItem, type SidebarItemProps, SidebarNav, type SidebarNavProps, ToggleButton, ToggleButtonGroup, type ToggleButtonGroupProps, type ToggleButtonProps, type ToggleButtonVariant, Tooltip, useChartColors, useSidebar };
package/dist/index.d.ts CHANGED
@@ -23,6 +23,7 @@ import { IconButtonProps as IconButtonProps$1 } from '@mui/material/IconButton';
23
23
  import * as React$1 from 'react';
24
24
  import React__default from 'react';
25
25
  import { ToggleButtonProps as ToggleButtonProps$1 } from '@mui/material/ToggleButton';
26
+ import { ToggleButtonGroupProps as ToggleButtonGroupProps$1 } from '@mui/material/ToggleButtonGroup';
26
27
  import { DatePickerProps as DatePickerProps$1 } from '@mui/x-date-pickers/DatePicker';
27
28
  export { default as FormControl, FormControlProps } from '@mui/material/FormControl';
28
29
  export { default as FormControlLabel, FormControlLabelProps } from '@mui/material/FormControlLabel';
@@ -168,7 +169,6 @@ export { default as CardHeader, CardHeaderProps } from '@mui/material/CardHeader
168
169
  export { default as CardMedia, CardMediaProps } from '@mui/material/CardMedia';
169
170
  export { default as MenuItem, MenuItemProps } from '@mui/material/MenuItem';
170
171
  export { default as SwipeableDrawer, SwipeableDrawerProps } from '@mui/material/SwipeableDrawer';
171
- export { default as ToggleButtonGroup, ToggleButtonGroupProps } from '@mui/material/ToggleButtonGroup';
172
172
  export { default as Toolbar, ToolbarProps } from '@mui/material/Toolbar';
173
173
 
174
174
  interface ForestProviderProps {
@@ -298,11 +298,22 @@ interface LogoProps extends Omit<BoxProps<'svg'>, 'component' | 'children'> {
298
298
  declare const Logo: React$1.ForwardRefExoticComponent<Omit<LogoProps, "ref"> & React$1.RefAttributes<SVGSVGElement>>;
299
299
 
300
300
  type ToggleButtonVariant = "contained" | "outlined";
301
+ type ToggleButtonGroupProps = ToggleButtonGroupProps$1 & {
302
+ /**
303
+ * Visual style for every child `<ToggleButton>`, so the whole segmented
304
+ * control is styled as one unit. `"outlined"` (default) is the transparent,
305
+ * grey-bordered face; `"contained"` is the charcoal faux-3D one. A child's
306
+ * own `variant` prop still wins.
307
+ */
308
+ variant?: ToggleButtonVariant;
309
+ };
310
+ declare function ToggleButtonGroup({ variant, ...props }: ToggleButtonGroupProps): react_jsx_runtime.JSX.Element;
301
311
  type ToggleButtonProps = ToggleButtonProps$1 & {
302
312
  /**
303
- * Visual style, matching `<ButtonGroup>`'s variants. `"contained"` (default)
304
- * is the charcoal faux-3D face; `"outlined"` is the transparent, grey-bordered
305
- * one. Selected stays "pressed in" in both.
313
+ * Visual style, matching `<ButtonGroup>`'s variants. `"outlined"` (default)
314
+ * is the transparent, grey-bordered face; `"contained"` is the charcoal
315
+ * faux-3D one. Selected stays "pressed in" in both. Inside a
316
+ * `<ToggleButtonGroup>`, omitting this inherits the group's variant.
306
317
  */
307
318
  variant?: ToggleButtonVariant;
308
319
  };
@@ -509,8 +520,12 @@ interface SidebarNavProps extends Omit<DrawerProps, "open" | "variant" | "onClos
509
520
  header?: React__default.ReactNode;
510
521
  /** Optional footer slot — rendered at bottom */
511
522
  footer?: React__default.ReactNode;
523
+ /** How far to either side of the sidebar's edge the pointer counts as "on the
524
+ * edge", in px. Inside this band the toggle fades in and tracks the pointer
525
+ * vertically; outside it the toggle is hidden. (default: 12) */
526
+ toggleEdgeAllowance?: number;
512
527
  }
513
- declare function SidebarNav({ open, onOpenChange, expandedWidth, collapsedWidth, behavior, showToggle, children, header, footer, sx, ...rest }: SidebarNavProps): react_jsx_runtime.JSX.Element;
528
+ declare function SidebarNav({ open, onOpenChange, expandedWidth, collapsedWidth, behavior, showToggle, children, header, footer, toggleEdgeAllowance, sx, ...rest }: SidebarNavProps): react_jsx_runtime.JSX.Element;
514
529
  interface SidebarItemProps extends ListItemButtonProps {
515
530
  /** Icon element (required — visible in both expanded and collapsed states) */
516
531
  icon: React__default.ReactNode;
@@ -558,6 +573,12 @@ interface AppShellProps {
558
573
  * sticky AppBar (brand / search / actions + the color-mode toggle) over a
559
574
  * SidebarNav and a main content area. Render a <Page> as children.
560
575
  *
576
+ * The AppBar and the sidebar read as one continuous L-shaped chrome — they
577
+ * already share `bg.primary`, so the shell drops the borders that used to cut
578
+ * them apart. The main region is then a lifted surface tucked into the corner
579
+ * they form: rounded at the top-left only, flush with the right and bottom
580
+ * window edges.
581
+ *
561
582
  * Below the "sm" breakpoint the sidebar becomes a temporary overlay drawer
562
583
  * opened by a hamburger button in the AppBar.
563
584
  */
@@ -622,4 +643,4 @@ declare function ScatterChart({ series, colors, ...props }: ScatterChartProps):
622
643
  type GaugeProps = GaugeProps$1;
623
644
  declare function Gauge(props: GaugeProps): react_jsx_runtime.JSX.Element;
624
645
 
625
- export { AppBarNavItem, type AppBarNavItemProps, AppShell, type AppShellNavItem, type AppShellProps, BarChart, type BarChartProps, Button, ButtonGroup, type ButtonProps, Card, type CardProps, Chip, DatePicker, type DatePickerProps, Drawer, Fab, type ForestCardColor, type ForestChipColor, type ForestChipProps, ForestProvider, type ForestProviderProps, Gauge, IconButton, type IconButtonProps, type IconButtonVariant, LineChart, type LineChartProps, Logo, type LogoProps, MultiSelect, type MultiSelectOption, type MultiSelectProps, Page, type PageBreadcrumb, type PageProps, PieChart, type PieChartProps, Popover, ScatterChart, Search, type SearchProps, Select, SidebarItem, type SidebarItemProps, SidebarNav, type SidebarNavProps, ToggleButton, type ToggleButtonProps, Tooltip, useChartColors, useSidebar };
646
+ export { AppBarNavItem, type AppBarNavItemProps, AppShell, type AppShellNavItem, type AppShellProps, BarChart, type BarChartProps, Button, ButtonGroup, type ButtonProps, Card, type CardProps, Chip, DatePicker, type DatePickerProps, Drawer, Fab, type ForestCardColor, type ForestChipColor, type ForestChipProps, ForestProvider, type ForestProviderProps, Gauge, IconButton, type IconButtonProps, type IconButtonVariant, LineChart, type LineChartProps, Logo, type LogoProps, MultiSelect, type MultiSelectOption, type MultiSelectProps, Page, type PageBreadcrumb, type PageProps, PieChart, type PieChartProps, Popover, ScatterChart, Search, type SearchProps, Select, SidebarItem, type SidebarItemProps, SidebarNav, type SidebarNavProps, ToggleButton, ToggleButtonGroup, type ToggleButtonGroupProps, type ToggleButtonProps, type ToggleButtonVariant, Tooltip, useChartColors, useSidebar };