react-better-html 1.1.180 → 1.1.182

package/dist/index.d.mts

@@ -2,6 +2,7 @@ import { WebTarget } from 'styled-components';
 import * as react from 'react';
 import { ComponentProps, ReactNode } from 'react';
 import * as react_jsx_runtime from 'react/jsx-runtime';
+import { useNavigate, useLocation, useInRouterContext, useSearchParams } from 'react-router-dom';
 
 type PluginName = "alerts" | "react-router-dom" | "localStorage";
 type BetterHtmlPluginConstructor<T extends object = object> = (config?: T) => BetterHtmlPlugin<T>;
@@ -586,7 +587,7 @@ declare function useForm<FormFields extends Record<string | number, string | num
     dropdownRefs: Record<keyof FormFields, HTMLDivElement | undefined>;
     toggleInputRefs: Record<keyof FormFields, ToggleInputRef | undefined>;
     validate: () => {};
-    onSubmit: (event: React.FormEvent<HTMLFormElement>) => Promise<void>;
+    onSubmit: (event?: React.FormEvent<HTMLFormElement>) => Promise<void>;
     reset: () => void;
     requiredFields: (keyof FormFields)[] | undefined;
     isDirty: boolean;
@@ -700,7 +701,7 @@ declare const ColorThemeSwitch: typeof ColorThemeSwitchComponent & {
 type FilterPreset = "today" | "yesterday" | "tomorrow" | "thisWeek" | "thisMonth" | "thisYear" | "lastWeek" | "lastMonth" | "lastYear" | "nextWeek" | "nextMonth" | "nextYear";
 type ListFilterValue = {
     label?: string;
-    value: string;
+    value: number | string;
     count: number;
 };
 type TableFilterData = {
@@ -713,7 +714,7 @@ type TableFilterData = {
     max?: string;
 } | {
     type: "list";
-    list?: string[];
+    list?: ListFilterValue["value"][];
 };
 type TextColumn<DataItem> = {
     type: "text";
@@ -930,6 +931,34 @@ declare const Foldable: typeof FoldableComponent & {
     box: typeof FoldableComponent.box;
 };
 
+type MenuItem = {
+    text: string;
+    iconName: IconName | AnyOtherString;
+    href?: string;
+    onClick?: (item: MenuItem) => void;
+    disabled?: boolean;
+    hidden?: boolean;
+    children?: MenuItem[];
+};
+type SideMenuProps = {
+    items: MenuItem[];
+    logoAssetName?: AssetName | AnyOtherString;
+    logoUrl?: string;
+    logoText?: string;
+    logoFontFamily?: string;
+    collapsable?: boolean;
+    widthMobileHandle?: boolean;
+};
+type SideMenuComponentType = {
+    (props: SideMenuProps): React.ReactElement;
+    pageHolder: (props: SideMenuPageHolderProps) => React.ReactElement;
+};
+declare const SideMenuComponent: SideMenuComponentType;
+type SideMenuPageHolderProps = PageHolderProps & {};
+declare const SideMenu: typeof SideMenuComponent & {
+    pageHolder: typeof SideMenuComponent.pageHolder;
+};
+
 type AppConfig = {
     contentMaxWidth: number;
 };
@@ -951,6 +980,10 @@ type BetterHtmlConfig = {
             style?: ComponentStyleConfig<"default" | "secondary" | "destructive" | "icon" | "upload">;
             tagReplacement?: ComponentTagReplacementConfig<"buttonComponent" | "linkComponent">;
         };
+        sideMenu?: {
+            /** @default 300 */
+            width?: number;
+        };
     };
 };
 
@@ -1020,6 +1053,12 @@ declare const alertControls: {
     createAlert: (alert: OmitProps<Alert, "id">) => Alert;
     removeAlert: (alertId: string) => void;
 };
+declare const sideMenuControls: {
+    expand: () => void;
+    collapse: () => void;
+    open: () => void;
+    close: () => void;
+};
 declare const colorThemeControls: {
     toggleTheme: (theme?: ColorTheme) => void;
 };
@@ -1053,7 +1092,12 @@ type AlertsPluginOptions = {
 declare const defaultAlertsPluginOptions: Required<AlertsPluginOptions>;
 declare const alertsPlugin: BetterHtmlPluginConstructor<AlertsPluginOptions>;
 
-type ReactRouterDomPluginOptions = {};
+type ReactRouterDomPluginOptions = {
+    useNavigate: typeof useNavigate;
+    useLocation: typeof useLocation;
+    useInRouterContext: typeof useInRouterContext;
+    useSearchParams: typeof useSearchParams;
+};
 declare const defaultReactRouterDomPluginOptions: Required<ReactRouterDomPluginOptions>;
 declare const reactRouterDomPlugin: BetterHtmlPluginConstructor<ReactRouterDomPluginOptions>;
 
@@ -1071,4 +1115,4 @@ type LocalStoragePluginOptions = {
 declare const defaultLocalStoragePluginOptions: Required<LocalStoragePluginOptions>;
 declare const localStoragePlugin: BetterHtmlPluginConstructor<LocalStoragePluginOptions>;
 
-export { type Alert, type AlertType, type AlertsPluginOptions, type AppConfig, type AssetName, type AssetsConfig, type BetterHtmlConfig, type BetterHtmlPlugin, _default as BetterHtmlProvider, type BetterHtmlProviderConfig, type BrowserName, Button, type ButtonProps, Chip, type ChipProps, type Color, type ColorName, type ColorTheme, ColorThemeSwitch, type ColorThemeSwitchProps, type Colors, type ComponentHoverStyle, type ComponentMarginProps, type ComponentPaddingProps, type DeepPartialRecord, Div, type DivProps, _default$3 as Divider, Dropdown, type DropdownOption, type DropdownProps, type ExcludeOptions, Foldable, type FoldableProps, type FoldableRef, Form, type FormProps, FormRow, type FormRowProps, type HorizontalDividerProps, _default$5 as Icon, type IconName, type IconProps, type IconsConfig, _default$4 as Image, type ImageProps, InputField, type InputFieldProps, _default$1 as Label, type LabelProps, Loader, type LoaderConfig, type LoaderName, type LoaderProps, type LocalStoragePluginOptions, Modal, type ModalProps, type ModalRef, type OmitProps, PageHeader, type PageHeaderProps, PageHolder, type PageHolderProps, type PartialRecord, type PickAllRequired, type PickValue, type PluginName, type ReactRouterDomPluginOptions, type Styles, type TabGroup, Table, type TableColumn, type TableFilterData, type TableProps, type TableRef, Tabs, type TabsProps, type TabsRef, Text, type TextAs, type TextProps, type TextareaFieldProps, type Theme, type ThemeConfig, _default$2 as ToggleInput, type ToggleInputProps, type ToggleInputRef, Tooltip, type TooltipProps, type TooltipRef, type VerticalDividerProps, alertControls, alertsPlugin, colorThemeControls, countries, darkenColor, defaultAlertsPluginOptions, defaultLocalStoragePluginOptions, defaultReactRouterDomPluginOptions, desaturateColor, eventPreventDefault, eventPreventStop, eventStopPropagation, filterHover, formatPhoneNumber, generateLocalStorage, generateRandomString, getBrowser, getFormErrorObject, isMobileDevice, lightenColor, loaderControls, localStoragePlugin, reactRouterDomPlugin, saturateColor, useAlertControls, useBetterHtmlContext, useBooleanState, useDebounceState, useForm, useLoader, useLoaderControls, useMediaQuery, usePageResize, usePageScroll, useTheme, useUrlQuery };
+export { type Alert, type AlertType, type AlertsPluginOptions, type AppConfig, type AssetName, type AssetsConfig, type BetterHtmlConfig, type BetterHtmlPlugin, _default as BetterHtmlProvider, type BetterHtmlProviderConfig, type BrowserName, Button, type ButtonProps, Chip, type ChipProps, type Color, type ColorName, type ColorTheme, ColorThemeSwitch, type ColorThemeSwitchProps, type Colors, type ComponentHoverStyle, type ComponentMarginProps, type ComponentPaddingProps, type DeepPartialRecord, Div, type DivProps, _default$3 as Divider, Dropdown, type DropdownOption, type DropdownProps, type ExcludeOptions, Foldable, type FoldableProps, type FoldableRef, Form, type FormProps, FormRow, type FormRowProps, type HorizontalDividerProps, _default$5 as Icon, type IconName, type IconProps, type IconsConfig, _default$4 as Image, type ImageProps, InputField, type InputFieldProps, _default$1 as Label, type LabelProps, Loader, type LoaderConfig, type LoaderName, type LoaderProps, type LocalStoragePluginOptions, type MenuItem, Modal, type ModalProps, type ModalRef, type OmitProps, PageHeader, type PageHeaderProps, PageHolder, type PageHolderProps, type PartialRecord, type PickAllRequired, type PickValue, type PluginName, type ReactRouterDomPluginOptions, SideMenu, type Styles, type TabGroup, Table, type TableColumn, type TableFilterData, type TableProps, type TableRef, Tabs, type TabsProps, type TabsRef, Text, type TextAs, type TextProps, type TextareaFieldProps, type Theme, type ThemeConfig, _default$2 as ToggleInput, type ToggleInputProps, type ToggleInputRef, Tooltip, type TooltipProps, type TooltipRef, type VerticalDividerProps, alertControls, alertsPlugin, colorThemeControls, countries, darkenColor, defaultAlertsPluginOptions, defaultLocalStoragePluginOptions, defaultReactRouterDomPluginOptions, desaturateColor, eventPreventDefault, eventPreventStop, eventStopPropagation, filterHover, formatPhoneNumber, generateLocalStorage, generateRandomString, getBrowser, getFormErrorObject, isMobileDevice, lightenColor, loaderControls, localStoragePlugin, reactRouterDomPlugin, saturateColor, sideMenuControls, useAlertControls, useBetterHtmlContext, useBooleanState, useDebounceState, useForm, useLoader, useLoaderControls, useMediaQuery, usePageResize, usePageScroll, useTheme, useUrlQuery };

package/dist/index.d.ts

@@ -2,6 +2,7 @@ import { WebTarget } from 'styled-components';
 import * as react from 'react';
 import { ComponentProps, ReactNode } from 'react';
 import * as react_jsx_runtime from 'react/jsx-runtime';
+import { useNavigate, useLocation, useInRouterContext, useSearchParams } from 'react-router-dom';
 
 type PluginName = "alerts" | "react-router-dom" | "localStorage";
 type BetterHtmlPluginConstructor<T extends object = object> = (config?: T) => BetterHtmlPlugin<T>;
@@ -586,7 +587,7 @@ declare function useForm<FormFields extends Record<string | number, string | num
     dropdownRefs: Record<keyof FormFields, HTMLDivElement | undefined>;
     toggleInputRefs: Record<keyof FormFields, ToggleInputRef | undefined>;
     validate: () => {};
-    onSubmit: (event: React.FormEvent<HTMLFormElement>) => Promise<void>;
+    onSubmit: (event?: React.FormEvent<HTMLFormElement>) => Promise<void>;
     reset: () => void;
     requiredFields: (keyof FormFields)[] | undefined;
     isDirty: boolean;
@@ -700,7 +701,7 @@ declare const ColorThemeSwitch: typeof ColorThemeSwitchComponent & {
 type FilterPreset = "today" | "yesterday" | "tomorrow" | "thisWeek" | "thisMonth" | "thisYear" | "lastWeek" | "lastMonth" | "lastYear" | "nextWeek" | "nextMonth" | "nextYear";
 type ListFilterValue = {
     label?: string;
-    value: string;
+    value: number | string;
     count: number;
 };
 type TableFilterData = {
@@ -713,7 +714,7 @@ type TableFilterData = {
     max?: string;
 } | {
     type: "list";
-    list?: string[];
+    list?: ListFilterValue["value"][];
 };
 type TextColumn<DataItem> = {
     type: "text";
@@ -930,6 +931,34 @@ declare const Foldable: typeof FoldableComponent & {
     box: typeof FoldableComponent.box;
 };
 
+type MenuItem = {
+    text: string;
+    iconName: IconName | AnyOtherString;
+    href?: string;
+    onClick?: (item: MenuItem) => void;
+    disabled?: boolean;
+    hidden?: boolean;
+    children?: MenuItem[];
+};
+type SideMenuProps = {
+    items: MenuItem[];
+    logoAssetName?: AssetName | AnyOtherString;
+    logoUrl?: string;
+    logoText?: string;
+    logoFontFamily?: string;
+    collapsable?: boolean;
+    widthMobileHandle?: boolean;
+};
+type SideMenuComponentType = {
+    (props: SideMenuProps): React.ReactElement;
+    pageHolder: (props: SideMenuPageHolderProps) => React.ReactElement;
+};
+declare const SideMenuComponent: SideMenuComponentType;
+type SideMenuPageHolderProps = PageHolderProps & {};
+declare const SideMenu: typeof SideMenuComponent & {
+    pageHolder: typeof SideMenuComponent.pageHolder;
+};
+
 type AppConfig = {
     contentMaxWidth: number;
 };
@@ -951,6 +980,10 @@ type BetterHtmlConfig = {
             style?: ComponentStyleConfig<"default" | "secondary" | "destructive" | "icon" | "upload">;
             tagReplacement?: ComponentTagReplacementConfig<"buttonComponent" | "linkComponent">;
         };
+        sideMenu?: {
+            /** @default 300 */
+            width?: number;
+        };
     };
 };
 
@@ -1020,6 +1053,12 @@ declare const alertControls: {
     createAlert: (alert: OmitProps<Alert, "id">) => Alert;
     removeAlert: (alertId: string) => void;
 };
+declare const sideMenuControls: {
+    expand: () => void;
+    collapse: () => void;
+    open: () => void;
+    close: () => void;
+};
 declare const colorThemeControls: {
     toggleTheme: (theme?: ColorTheme) => void;
 };
@@ -1053,7 +1092,12 @@ type AlertsPluginOptions = {
 declare const defaultAlertsPluginOptions: Required<AlertsPluginOptions>;
 declare const alertsPlugin: BetterHtmlPluginConstructor<AlertsPluginOptions>;
 
-type ReactRouterDomPluginOptions = {};
+type ReactRouterDomPluginOptions = {
+    useNavigate: typeof useNavigate;
+    useLocation: typeof useLocation;
+    useInRouterContext: typeof useInRouterContext;
+    useSearchParams: typeof useSearchParams;
+};
 declare const defaultReactRouterDomPluginOptions: Required<ReactRouterDomPluginOptions>;
 declare const reactRouterDomPlugin: BetterHtmlPluginConstructor<ReactRouterDomPluginOptions>;
 
@@ -1071,4 +1115,4 @@ type LocalStoragePluginOptions = {
 declare const defaultLocalStoragePluginOptions: Required<LocalStoragePluginOptions>;
 declare const localStoragePlugin: BetterHtmlPluginConstructor<LocalStoragePluginOptions>;
 
-export { type Alert, type AlertType, type AlertsPluginOptions, type AppConfig, type AssetName, type AssetsConfig, type BetterHtmlConfig, type BetterHtmlPlugin, _default as BetterHtmlProvider, type BetterHtmlProviderConfig, type BrowserName, Button, type ButtonProps, Chip, type ChipProps, type Color, type ColorName, type ColorTheme, ColorThemeSwitch, type ColorThemeSwitchProps, type Colors, type ComponentHoverStyle, type ComponentMarginProps, type ComponentPaddingProps, type DeepPartialRecord, Div, type DivProps, _default$3 as Divider, Dropdown, type DropdownOption, type DropdownProps, type ExcludeOptions, Foldable, type FoldableProps, type FoldableRef, Form, type FormProps, FormRow, type FormRowProps, type HorizontalDividerProps, _default$5 as Icon, type IconName, type IconProps, type IconsConfig, _default$4 as Image, type ImageProps, InputField, type InputFieldProps, _default$1 as Label, type LabelProps, Loader, type LoaderConfig, type LoaderName, type LoaderProps, type LocalStoragePluginOptions, Modal, type ModalProps, type ModalRef, type OmitProps, PageHeader, type PageHeaderProps, PageHolder, type PageHolderProps, type PartialRecord, type PickAllRequired, type PickValue, type PluginName, type ReactRouterDomPluginOptions, type Styles, type TabGroup, Table, type TableColumn, type TableFilterData, type TableProps, type TableRef, Tabs, type TabsProps, type TabsRef, Text, type TextAs, type TextProps, type TextareaFieldProps, type Theme, type ThemeConfig, _default$2 as ToggleInput, type ToggleInputProps, type ToggleInputRef, Tooltip, type TooltipProps, type TooltipRef, type VerticalDividerProps, alertControls, alertsPlugin, colorThemeControls, countries, darkenColor, defaultAlertsPluginOptions, defaultLocalStoragePluginOptions, defaultReactRouterDomPluginOptions, desaturateColor, eventPreventDefault, eventPreventStop, eventStopPropagation, filterHover, formatPhoneNumber, generateLocalStorage, generateRandomString, getBrowser, getFormErrorObject, isMobileDevice, lightenColor, loaderControls, localStoragePlugin, reactRouterDomPlugin, saturateColor, useAlertControls, useBetterHtmlContext, useBooleanState, useDebounceState, useForm, useLoader, useLoaderControls, useMediaQuery, usePageResize, usePageScroll, useTheme, useUrlQuery };
+export { type Alert, type AlertType, type AlertsPluginOptions, type AppConfig, type AssetName, type AssetsConfig, type BetterHtmlConfig, type BetterHtmlPlugin, _default as BetterHtmlProvider, type BetterHtmlProviderConfig, type BrowserName, Button, type ButtonProps, Chip, type ChipProps, type Color, type ColorName, type ColorTheme, ColorThemeSwitch, type ColorThemeSwitchProps, type Colors, type ComponentHoverStyle, type ComponentMarginProps, type ComponentPaddingProps, type DeepPartialRecord, Div, type DivProps, _default$3 as Divider, Dropdown, type DropdownOption, type DropdownProps, type ExcludeOptions, Foldable, type FoldableProps, type FoldableRef, Form, type FormProps, FormRow, type FormRowProps, type HorizontalDividerProps, _default$5 as Icon, type IconName, type IconProps, type IconsConfig, _default$4 as Image, type ImageProps, InputField, type InputFieldProps, _default$1 as Label, type LabelProps, Loader, type LoaderConfig, type LoaderName, type LoaderProps, type LocalStoragePluginOptions, type MenuItem, Modal, type ModalProps, type ModalRef, type OmitProps, PageHeader, type PageHeaderProps, PageHolder, type PageHolderProps, type PartialRecord, type PickAllRequired, type PickValue, type PluginName, type ReactRouterDomPluginOptions, SideMenu, type Styles, type TabGroup, Table, type TableColumn, type TableFilterData, type TableProps, type TableRef, Tabs, type TabsProps, type TabsRef, Text, type TextAs, type TextProps, type TextareaFieldProps, type Theme, type ThemeConfig, _default$2 as ToggleInput, type ToggleInputProps, type ToggleInputRef, Tooltip, type TooltipProps, type TooltipRef, type VerticalDividerProps, alertControls, alertsPlugin, colorThemeControls, countries, darkenColor, defaultAlertsPluginOptions, defaultLocalStoragePluginOptions, defaultReactRouterDomPluginOptions, desaturateColor, eventPreventDefault, eventPreventStop, eventStopPropagation, filterHover, formatPhoneNumber, generateLocalStorage, generateRandomString, getBrowser, getFormErrorObject, isMobileDevice, lightenColor, loaderControls, localStoragePlugin, reactRouterDomPlugin, saturateColor, sideMenuControls, useAlertControls, useBetterHtmlContext, useBooleanState, useDebounceState, useForm, useLoader, useLoaderControls, useMediaQuery, usePageResize, usePageScroll, useTheme, useUrlQuery };