@wavy/react-ui 0.0.49 → 0.0.51

package/dist/main.d.ts

@@ -6,7 +6,7 @@ import { NoUndefinedField, SafeOmit, FileDetails, Prettify, AddPrefix, TaskResul
 import { IconType } from 'react-icons';
 import * as CSS from 'csstype';
 import CSS__default from 'csstype';
-import { AvatarGroupProps as AvatarGroupProps$1, SpinnerProps as SpinnerProps$1, Drawer as Drawer$1, FileUpload, InputProps, InputAddonProps, InputElementProps, AvatarRootProps, FloatProps, CloseButtonProps, Dialog as Dialog$1, MenuRootProps, SegmentGroupRootProps, Steps, Tooltip as Tooltip$1, SeparatorProps as SeparatorProps$1 } from '@chakra-ui/react';
+import { SwitchRootProps, AvatarGroupProps as AvatarGroupProps$1, SpinnerProps as SpinnerProps$1, Drawer as Drawer$1, FileUpload, InputProps, InputAddonProps, InputElementProps, AvatarRootProps, FloatProps, CloseButtonProps, Dialog as Dialog$1, MenuRootProps, SegmentGroupRootProps, Steps, Tooltip as Tooltip$1, SeparatorProps as SeparatorProps$1 } from '@chakra-ui/react';
 export { MenuRootProps, UseStepsProps, useSteps } from '@chakra-ui/react';
 import { JSX as JSX$1 } from '@emotion/react/jsx-runtime';
 import { StepsVariant } from 'node_modules/@chakra-ui/react/dist/types/styled-system/generated/recipes.gen';
@@ -1478,6 +1478,24 @@ interface BasicOptionProps extends Partial<Record<"leadingEl" | "trailingEl", Re
 }
 declare function BasicOption(props: BasicOptionProps): react_jsx_runtime.JSX.Element;
 
+interface SwitchProps extends Partial<Record<`${"track" | "thumb"}Indicator`, Partial<Record<"on" | "off", React__default.ReactNode>>>>, Partial<Record<`${"thumb" | "track"}Style`, 
+/** Apply conditional styles based on the `checked` state. */
+(checked: boolean) => SafeOmit<CSS.Properties, "backgroundColor" | "color" | "borderColor"> & {
+    backgroundColor?: BasicColor$1;
+    color?: BasicColor$1;
+    borderColor?: BasicColor$1;
+}>> {
+    defaultChecked?: boolean;
+    checked?: boolean;
+    label?: string;
+    disabled?: boolean;
+    size?: SwitchRootProps["size"];
+    /**@default "solid" */
+    variant?: SwitchRootProps["variant"];
+    onChange?: (checked: boolean) => void;
+}
+declare function Switch(props: SwitchProps): react_jsx_runtime.JSX.Element;
+
 interface DebounceProps {
     /**@default 300 */
     delay?: number;
@@ -3292,23 +3310,71 @@ declare function usePostRenderEffect(effect: React__default.EffectCallback, deps
 interface ComputedStyleProps extends SafeOmit<BasicStyleProps, "className"> {
     children?: React__default.ReactNode;
 }
-declare function useComputedStyle(elementTag: keyof HTMLElementTagNameMap, props: ComputedStyleProps, options?: Partial<{
-    debug: boolean;
-    inject: () => CSS.Properties;
-}>): {
+declare function useComputedStyle(options: {
+    /**@default "div" */
+    tag?: keyof HTMLElementTagNameMap;
+    style: ComputedStyleProps;
+    inject?: () => CSS.Properties;
+}): {
     style: {
         [key: string]: string;
     };
 };
 
-declare function useManagedRef<T extends NonFunction<any>>(initialValue: CastFn<T>, options?: Partial<{
-    onChange: (currentValue: T, previousValue: T) => void;
+type UpdaterFunction<T> = (value: T) => T;
+/** A more controlled state management hook */
+declare function useStore<T extends NonFunction<any>>(options: {
+    /** The defaultValue of the store.
+     * @note This can either be defined expicitly, or via the return value of an initializer function.
+     * @warning Attempting to store a function will throw an error.
+     */
+    defaultValue: CastFn<T>;
+    readOnly?: boolean;
+    /**Re-renders the component when the value is changed
+     * @default false
+     */
+    reactive?: boolean;
+    /** Stores the data in either session-storage or local storage under the specified key
+     * and attempts to fetch that data when the component first mounts. If no value is found,
+     * the provided defaultValue is used.
+     */
+    persist?: {
+        key: string;
+        /**@default "session-storage" */
+        storage?: "session-storage" | "local-storage";
+        /**Delete the persisted data when the component unmounts
+         * @default false */
+        deleteOnUnmount?: boolean;
+    };
+    /** Determine if a value (post-transformation) should be stored.
+     * @return whether the value should be stored or not
+     */
+    validate?: (value: T) => boolean;
+    /** Called when the validate callback returns false
+     * @param value The value that failed to pass validation
+     */
+    onValidationFail?: (value: T) => void;
+    onChange?: (currentValue: T, previousValue: T) => void;
     /** Transform the updated value before the onChange method is called*/
-    transform: (value: T) => T;
-}>): {
+    transform?: (value: T) => T;
+}): {
     debug: () => Record<"difference" | "from" | "to", T | T[]>;
-    upsert: (value: T | ((value: T) => T)) => void;
+    /**
+     * @warning Attempting to store a function will throw an error.
+     */
+    upsert: (value: T | UpdaterFunction<T>, options?: Partial<{
+        /** Skips the onChange callback for the store */
+        skipOnChange: boolean;
+        /** Skips re-rendering the store.
+         * @note This is only effective when the store is reactive
+         */
+        skipRender: boolean;
+        /** Skips the validate callback */
+        skipValidation: boolean;
+        bypassReadOnly: boolean;
+    }>) => void;
     read: () => T;
+    /** Completely removes all the stored data (including persisted data) */
     delete: () => void;
 };
 
@@ -3340,6 +3406,7 @@ declare function useRerender(): {
     triggerRerender: () => void;
 };
 
+/**@deprecated Migrate to useStore (set the reactive option to true, and configure the persist option) */
 declare function useSessionStorage<Value extends NonFunction<any>>(key: string, initialValue: Value): readonly [Value, (update: Value | ((previousValue: Value) => Value)) => void, () => void];
 
 declare function useEvent<EventMapper extends Record<string, any>>(options?: Partial<{
@@ -3357,7 +3424,7 @@ declare function useEvent<EventMapper extends Record<string, any>>(options?: Par
     dettach: (key: keyof EventMapper) => boolean;
 };
 
-/**A hook that allows you to optionally skip re-rendering on state change  */
+/**@deprecated Migrate to useStore  */
 declare function useSmartState<T>(value?: CastFn<T>): readonly [T, (value: T | ((previousValue: T) => T), options?: {
     skipRender: boolean;
 }) => void];
@@ -3426,4 +3493,4 @@ declare function remAsPx(rem: number): string;
 declare function isOverflown(element: HTMLElement): boolean;
 declare function computedCssVariable(cssVariable: string): string;
 
-export { AttachmentsButton, AttachmentsDialog, Avatar, AvatarGroup, type AvatarGroupProps, type AvatarProps, Badge, type BadgeProps, BasicButton, type BasicColor$1 as BasicColor, BasicDiv, BasicImg, BasicOl, BasicOption, BasicSelect, BasicSpan, type BasicStyleProps, BasicTable, BasicTableProps, _default as Calendar, CalendarDialog, CancelButton, Card, CardProps, Checkbox, type CheckboxProps, ColorResources, type ComputedStyleProps, ConfirmationDialog, type ConfirmationDialogProps, CopyButton, CssColors, type CssProperties, CssShapes, CssSpacing, Debounce, type DebounceProps, DeleteButton, Dialog, DialogProps, Disclaimer, type DisclaimerProps, DownloadButton, Drawer, DrawerProps, EditButton, Editable, type EditableProps, EmailComposer, EmptyState, EmptyStateProps, ErrorTooltip, EventContainer, type EventContainerProps, ExpandableButton, FancyFormDialog, type FancyFormDialogProps, FileDropzone, type FileDropzoneProps, FileViewer, FileViewerProps, FontSize, Indicator, type IndicatorProps, type InlineCss, ItemInfo, type ItemInfoProps, JsonViewer, type JwtVerificationStatus, JwtVerifier, type JwtVerifierProps, MediaCard, MediaCardProps, Menu, type MenuPlacement, MoneyDisplayCard, NegativeButton, NextButton, NoButton, OpenButton, OptionsButton, PageIndicator, type PageIndicatorProps, PageSlider, type PageSliderProps, Paper, type PaperProps, PasteButton, PaymentOptionsButton, PaymentOptionsDialog, PictureUploader, Popover, type PopoverProps, PositiveButton, PreviousButton, ProfileCard, ProfileCardProps, ProgressBar, type ProgressBarProps, ReceiptCard, SaveButton, SearchTextField, SegmentedControls, type SegmentedControlsProps, SendButton, Separator, type SeparatorProps, SignInWidget, SimpleFormDialog, type SimpleFormDialogProps, Spinner, type SpinnerProps, Status, type StatusProps, Stepper, type StepperProps, SubmitButton, Tag, type TagProps, TaskLogger, TaskResultDialog, Terminal, TextField, type TextFieldProps, Timeline, TimelineProps, Tooltip, type TooltipPlacement, type TooltipProps, UploadButton, UploadReceiptButton, type UseModalControlsReturn, type UsePageSliderControllerReturn, UserProfile, VerifyButton, VerifyTextField, UiProvider as WavyUi, YesButton, YesNoButtonGroup, YesOrNoForm, applyBasicStyle, bankTransferPaymentOption, borderRadius, buildCSS, computedCssVariable, convertHexUnitTo256, cssTransition, definePaymentOption, disabledBorderRadius, dragElement, ellipsis, flexCenter, getFileIcon, getPaperDim, getScrollParent, hexToRgba, inAppPaymentOption, isOverflown, isSpanMultiLine, isValidHex, nativeEllipsis, noSpaceStyle, paperStyle, remAsPx, remToPx, resolveBasicColor, restrictLineCount, rgbToRgba, screenHasMaxWidth, screenHasMinWidth, solidBorder, stripHtml, tiledBackground, useAsyncEffect, useComputedStyle, useEvent, useManagedRef, useModalControls, usePageSliderController, usePopoverContext, usePostRenderEffect, useRerender, useSessionStorage, useSmartState };
+export { AttachmentsButton, AttachmentsDialog, Avatar, AvatarGroup, type AvatarGroupProps, type AvatarProps, Badge, type BadgeProps, BasicButton, type BasicColor$1 as BasicColor, BasicDiv, BasicImg, BasicOl, BasicOption, BasicSelect, BasicSpan, type BasicStyleProps, BasicTable, BasicTableProps, _default as Calendar, CalendarDialog, CancelButton, Card, CardProps, Checkbox, type CheckboxProps, ColorResources, type ComputedStyleProps, ConfirmationDialog, type ConfirmationDialogProps, CopyButton, CssColors, type CssProperties, CssShapes, CssSpacing, Debounce, type DebounceProps, DeleteButton, Dialog, DialogProps, Disclaimer, type DisclaimerProps, DownloadButton, Drawer, DrawerProps, EditButton, Editable, type EditableProps, EmailComposer, EmptyState, EmptyStateProps, ErrorTooltip, EventContainer, type EventContainerProps, ExpandableButton, FancyFormDialog, type FancyFormDialogProps, FileDropzone, type FileDropzoneProps, FileViewer, FileViewerProps, FontSize, Indicator, type IndicatorProps, type InlineCss, ItemInfo, type ItemInfoProps, JsonViewer, type JwtVerificationStatus, JwtVerifier, type JwtVerifierProps, MediaCard, MediaCardProps, Menu, type MenuPlacement, MoneyDisplayCard, NegativeButton, NextButton, NoButton, OpenButton, OptionsButton, PageIndicator, type PageIndicatorProps, PageSlider, type PageSliderProps, Paper, type PaperProps, PasteButton, PaymentOptionsButton, PaymentOptionsDialog, PictureUploader, Popover, type PopoverProps, PositiveButton, PreviousButton, ProfileCard, ProfileCardProps, ProgressBar, type ProgressBarProps, ReceiptCard, SaveButton, SearchTextField, SegmentedControls, type SegmentedControlsProps, SendButton, Separator, type SeparatorProps, SignInWidget, SimpleFormDialog, type SimpleFormDialogProps, Spinner, type SpinnerProps, Status, type StatusProps, Stepper, type StepperProps, SubmitButton, Switch, type SwitchProps, Tag, type TagProps, TaskLogger, TaskResultDialog, Terminal, TextField, type TextFieldProps, Timeline, TimelineProps, Tooltip, type TooltipPlacement, type TooltipProps, UploadButton, UploadReceiptButton, type UseModalControlsReturn, type UsePageSliderControllerReturn, UserProfile, VerifyButton, VerifyTextField, UiProvider as WavyUi, YesButton, YesNoButtonGroup, YesOrNoForm, applyBasicStyle, bankTransferPaymentOption, borderRadius, buildCSS, computedCssVariable, convertHexUnitTo256, cssTransition, definePaymentOption, disabledBorderRadius, dragElement, ellipsis, flexCenter, getFileIcon, getPaperDim, getScrollParent, hexToRgba, inAppPaymentOption, isOverflown, isSpanMultiLine, isValidHex, nativeEllipsis, noSpaceStyle, paperStyle, remAsPx, remToPx, resolveBasicColor, restrictLineCount, rgbToRgba, screenHasMaxWidth, screenHasMinWidth, solidBorder, stripHtml, tiledBackground, useAsyncEffect, useComputedStyle, useEvent, useModalControls, usePageSliderController, usePopoverContext, usePostRenderEffect, useRerender, useSessionStorage, useSmartState, useStore };