wcz-layout 6.7.2 → 8.3.2

package/dist/hooks.d.ts

@@ -0,0 +1,226 @@
+import { t as FormOmittedProps } from "./utils-CvvyM8Xw.js";
+import { AutocompleteProps, ButtonProps, CheckboxProps, RadioGroupProps, SliderProps, SwitchProps, TextFieldProps } from "@mui/material";
+import { FC, ReactNode } from "react";
+import { useTranslation } from "react-i18next";
+import { AlertColor } from "@mui/material/Alert";
+import { useInView } from "react-intersection-observer";
+import { DatePickerProps, DateRangePickerProps, DateTimePickerProps, DateTimeRangePickerProps, TimePickerProps, TimeRangePickerProps } from "@mui/x-date-pickers-pro";
+import { InputAttributes, NumericFormatProps } from "react-number-format/types/types";
+import { PickersTextFieldProps } from "@mui/x-date-pickers/PickersTextField";
+
+//#region src/components/form/FormTextField.d.ts
+interface FormTextFieldProps extends Omit<TextFieldProps, FormOmittedProps> {
+  type?: "color" | "email" | "password" | "search" | "tel" | "text" | "url";
+}
+//#endregion
+//#region src/components/form/FormNumberField.d.ts
+interface FormNumberFieldProps extends Omit<TextFieldProps, FormOmittedProps> {
+  defaultValue?: number | null;
+  options?: Omit<NumericFormatProps<InputAttributes>, "customInput" | "onValueChange" | keyof InputAttributes>;
+}
+//#endregion
+//#region src/components/form/FormAutocomplete.d.ts
+interface FormAutocompleteProps extends Omit<AutocompleteProps<any, boolean, boolean, boolean>, FormOmittedProps> {
+  textFieldProps?: Omit<TextFieldProps, FormOmittedProps>;
+}
+//#endregion
+//#region src/components/form/FormCheckbox.d.ts
+interface FormCheckboxProps extends Omit<CheckboxProps, FormOmittedProps> {
+  label?: string;
+}
+//#endregion
+//#region src/components/form/FormSwitch.d.ts
+interface FormSwitchProps extends Omit<SwitchProps, FormOmittedProps> {
+  label?: string;
+}
+//#endregion
+//#region src/components/form/FormRadioGroup.d.ts
+interface Option {
+  label: string;
+  value: string | number;
+}
+interface FormRadioGroupProps extends Omit<RadioGroupProps, FormOmittedProps> {
+  label?: string;
+  options: Array<Option>;
+}
+//#endregion
+//#region src/components/form/FormSlider.d.ts
+interface FormSliderProps extends Omit<SliderProps, FormOmittedProps> {
+  label?: string;
+}
+//#endregion
+//#region src/components/form/FormDatePicker.d.ts
+interface FormDatePickerProps extends Omit<DatePickerProps, FormOmittedProps> {
+  textFieldProps?: Partial<PickersTextFieldProps>;
+}
+//#endregion
+//#region src/components/form/FormDateRangePicker.d.ts
+interface FormDateRangePickerProps extends Omit<DateRangePickerProps, FormOmittedProps> {
+  textFieldProps?: Partial<PickersTextFieldProps>;
+}
+//#endregion
+//#region src/components/form/FormTimePicker.d.ts
+interface FormTimePickerProps extends Omit<TimePickerProps, FormOmittedProps> {
+  textFieldProps?: Partial<PickersTextFieldProps>;
+}
+//#endregion
+//#region src/components/form/FormTimeRangePicker.d.ts
+interface FormTimeRangePickerProps extends Omit<TimeRangePickerProps, FormOmittedProps> {
+  textFieldProps?: Partial<PickersTextFieldProps>;
+}
+//#endregion
+//#region src/components/form/FormDateTimePicker.d.ts
+interface FormDateTimePickerProps extends Omit<DateTimePickerProps, FormOmittedProps> {
+  textFieldProps?: Partial<PickersTextFieldProps>;
+}
+//#endregion
+//#region src/components/form/FormDateTimeRangePicker.d.ts
+interface FormDateTimeRangePickerProps extends Omit<DateTimeRangePickerProps, FormOmittedProps> {
+  textFieldProps?: Partial<PickersTextFieldProps>;
+}
+//#endregion
+//#region src/components/form/FormSubmitButton.d.ts
+type FormSubmitButtonProps = Omit<ButtonProps, "loading" | "disabled" | "onClick" | "type">;
+declare const useLayoutForm: <TFormData, TOnMount extends import("@tanstack/form-core").FormValidateOrFn<TFormData> | undefined, TOnChange extends import("@tanstack/form-core").FormValidateOrFn<TFormData> | undefined, TOnChangeAsync extends import("@tanstack/form-core").FormAsyncValidateOrFn<TFormData> | undefined, TOnBlur extends import("@tanstack/form-core").FormValidateOrFn<TFormData> | undefined, TOnBlurAsync extends import("@tanstack/form-core").FormAsyncValidateOrFn<TFormData> | undefined, TOnSubmit extends import("@tanstack/form-core").FormValidateOrFn<TFormData> | undefined, TOnSubmitAsync extends import("@tanstack/form-core").FormAsyncValidateOrFn<TFormData> | undefined, TOnDynamic extends import("@tanstack/form-core").FormValidateOrFn<TFormData> | undefined, TOnDynamicAsync extends import("@tanstack/form-core").FormAsyncValidateOrFn<TFormData> | undefined, TOnServer extends import("@tanstack/form-core").FormAsyncValidateOrFn<TFormData> | undefined, TSubmitMeta>(props: import("@tanstack/form-core").FormOptions<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta>) => import("@tanstack/react-form").AppFieldExtendedReactFormApi<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta, {
+    readonly TextField: import("react").FC<FormTextFieldProps>;
+    readonly NumberField: import("react").FC<FormNumberFieldProps>;
+    readonly Autocomplete: import("react").FC<FormAutocompleteProps>;
+    readonly Checkbox: import("react").FC<FormCheckboxProps>;
+    readonly Switch: import("react").FC<FormSwitchProps>;
+    readonly RadioGroup: import("react").FC<FormRadioGroupProps>;
+    readonly Slider: import("react").FC<FormSliderProps>;
+    readonly DatePicker: import("react").FC<FormDatePickerProps>;
+    readonly DateRangePicker: import("react").FC<FormDateRangePickerProps>;
+    readonly TimePicker: import("react").FC<FormTimePickerProps>;
+    readonly TimeRangePicker: import("react").FC<FormTimeRangePickerProps>;
+    readonly DateTimePicker: import("react").FC<FormDateTimePickerProps>;
+    readonly DateTimeRangePicker: import("react").FC<FormDateTimeRangePickerProps>;
+  }, {
+    readonly SubmitButton: import("react").FC<FormSubmitButtonProps>;
+  }>, withLayoutForm: <TFormData, TOnMount extends import("@tanstack/form-core").FormValidateOrFn<TFormData> | undefined, TOnChange extends import("@tanstack/form-core").FormValidateOrFn<TFormData> | undefined, TOnChangeAsync extends import("@tanstack/form-core").FormAsyncValidateOrFn<TFormData> | undefined, TOnBlur extends import("@tanstack/form-core").FormValidateOrFn<TFormData> | undefined, TOnBlurAsync extends import("@tanstack/form-core").FormAsyncValidateOrFn<TFormData> | undefined, TOnSubmit extends import("@tanstack/form-core").FormValidateOrFn<TFormData> | undefined, TOnSubmitAsync extends import("@tanstack/form-core").FormAsyncValidateOrFn<TFormData> | undefined, TOnDynamic extends import("@tanstack/form-core").FormValidateOrFn<TFormData> | undefined, TOnDynamicAsync extends import("@tanstack/form-core").FormAsyncValidateOrFn<TFormData> | undefined, TOnServer extends import("@tanstack/form-core").FormAsyncValidateOrFn<TFormData> | undefined, TSubmitMeta, TRenderProps extends object = {}>({
+    render,
+    props
+  }: import("@tanstack/react-form").WithFormProps<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta, {
+    readonly TextField: import("react").FC<FormTextFieldProps>;
+    readonly NumberField: import("react").FC<FormNumberFieldProps>;
+    readonly Autocomplete: import("react").FC<FormAutocompleteProps>;
+    readonly Checkbox: import("react").FC<FormCheckboxProps>;
+    readonly Switch: import("react").FC<FormSwitchProps>;
+    readonly RadioGroup: import("react").FC<FormRadioGroupProps>;
+    readonly Slider: import("react").FC<FormSliderProps>;
+    readonly DatePicker: import("react").FC<FormDatePickerProps>;
+    readonly DateRangePicker: import("react").FC<FormDateRangePickerProps>;
+    readonly TimePicker: import("react").FC<FormTimePickerProps>;
+    readonly TimeRangePicker: import("react").FC<FormTimeRangePickerProps>;
+    readonly DateTimePicker: import("react").FC<FormDateTimePickerProps>;
+    readonly DateTimeRangePicker: import("react").FC<FormDateTimeRangePickerProps>;
+  }, {
+    readonly SubmitButton: import("react").FC<FormSubmitButtonProps>;
+  }, TRenderProps>) => import("react").FunctionComponent<import("react").PropsWithChildren<NoInfer<[unknown] extends [TRenderProps] ? any : TRenderProps> & {
+    form: import("@tanstack/react-form").AppFieldExtendedReactFormApi<[unknown] extends [TFormData] ? any : TFormData, [import("@tanstack/form-core").FormValidateOrFn<TFormData> | undefined] extends [TOnMount] ? [TOnMount] extends [TOnMount & (import("@tanstack/form-core").FormValidateOrFn<TFormData> | undefined)] ? any : TOnMount : TOnMount, [import("@tanstack/form-core").FormValidateOrFn<TFormData> | undefined] extends [TOnChange] ? [TOnChange] extends [TOnChange & (import("@tanstack/form-core").FormValidateOrFn<TFormData> | undefined)] ? any : TOnChange : TOnChange, [import("@tanstack/form-core").FormValidateOrFn<TFormData> | undefined] extends [TOnChangeAsync] ? [TOnChangeAsync] extends [TOnChangeAsync & (import("@tanstack/form-core").FormValidateOrFn<TFormData> | undefined)] ? any : TOnChangeAsync : TOnChangeAsync, [import("@tanstack/form-core").FormValidateOrFn<TFormData> | undefined] extends [TOnBlur] ? [TOnBlur] extends [TOnBlur & (import("@tanstack/form-core").FormValidateOrFn<TFormData> | undefined)] ? any : TOnBlur : TOnBlur, [import("@tanstack/form-core").FormValidateOrFn<TFormData> | undefined] extends [TOnBlurAsync] ? [TOnBlurAsync] extends [TOnBlurAsync & (import("@tanstack/form-core").FormValidateOrFn<TFormData> | undefined)] ? any : TOnBlurAsync : TOnBlurAsync, [import("@tanstack/form-core").FormValidateOrFn<TFormData> | undefined] extends [TOnSubmit] ? [TOnSubmit] extends [TOnSubmit & (import("@tanstack/form-core").FormValidateOrFn<TFormData> | undefined)] ? any : TOnSubmit : TOnSubmit, [import("@tanstack/form-core").FormValidateOrFn<TFormData> | undefined] extends [TOnSubmitAsync] ? [TOnSubmitAsync] extends [TOnSubmitAsync & (import("@tanstack/form-core").FormValidateOrFn<TFormData> | undefined)] ? any : TOnSubmitAsync : TOnSubmitAsync, [import("@tanstack/form-core").FormValidateOrFn<TFormData> | undefined] extends [TOnDynamic] ? [TOnDynamic] extends [TOnDynamic & (import("@tanstack/form-core").FormValidateOrFn<TFormData> | undefined)] ? any : TOnDynamic : TOnDynamic, [import("@tanstack/form-core").FormValidateOrFn<TFormData> | undefined] extends [TOnDynamicAsync] ? [TOnDynamicAsync] extends [TOnDynamicAsync & (import("@tanstack/form-core").FormValidateOrFn<TFormData> | undefined)] ? any : TOnDynamicAsync : TOnDynamicAsync, [import("@tanstack/form-core").FormValidateOrFn<TFormData> | undefined] extends [TOnServer] ? [TOnServer] extends [TOnServer & (import("@tanstack/form-core").FormValidateOrFn<TFormData> | undefined)] ? any : TOnServer : TOnServer, [unknown] extends [TSubmitMeta] ? any : TSubmitMeta, {
+      readonly TextField: import("react").FC<FormTextFieldProps>;
+      readonly NumberField: import("react").FC<FormNumberFieldProps>;
+      readonly Autocomplete: import("react").FC<FormAutocompleteProps>;
+      readonly Checkbox: import("react").FC<FormCheckboxProps>;
+      readonly Switch: import("react").FC<FormSwitchProps>;
+      readonly RadioGroup: import("react").FC<FormRadioGroupProps>;
+      readonly Slider: import("react").FC<FormSliderProps>;
+      readonly DatePicker: import("react").FC<FormDatePickerProps>;
+      readonly DateRangePicker: import("react").FC<FormDateRangePickerProps>;
+      readonly TimePicker: import("react").FC<FormTimePickerProps>;
+      readonly TimeRangePicker: import("react").FC<FormTimeRangePickerProps>;
+      readonly DateTimePicker: import("react").FC<FormDateTimePickerProps>;
+      readonly DateTimeRangePicker: import("react").FC<FormDateTimeRangePickerProps>;
+    }, {
+      readonly SubmitButton: import("react").FC<FormSubmitButtonProps>;
+    }>;
+  }>>;
+//#endregion
+//#region src/hooks/useDialogs.d.ts
+interface OpenDialogOptions<TResult> {
+  onClose?: (result: TResult) => Promise<void>;
+}
+interface AlertOptions {
+  title?: ReactNode;
+}
+interface ConfirmOptions {
+  title?: ReactNode;
+  cancelText?: ReactNode;
+}
+interface DialogProps<TPayload = undefined, TResult = void> {
+  payload: TPayload;
+  open: boolean;
+  onClose: (result: TResult) => Promise<void>;
+}
+type OpenAlertDialog = (message: ReactNode, options?: AlertOptions) => Promise<void>;
+type OpenConfirmDialog = (message: ReactNode, options?: ConfirmOptions) => Promise<boolean>;
+type DialogComponent<TPayload, TResult> = React.ComponentType<DialogProps<TPayload, TResult>>;
+interface OpenDialog {
+  <TPayload extends undefined, TResult>(Component: DialogComponent<TPayload, TResult>, payload?: TPayload, options?: OpenDialogOptions<TResult>): Promise<TResult>;
+  <TPayload, TResult>(Component: DialogComponent<TPayload, TResult>, payload: TPayload, options?: OpenDialogOptions<TResult>): Promise<TResult>;
+}
+type CloseDialog = <TResult>(dialog: Promise<TResult>, result: TResult) => Promise<TResult>;
+interface DialogHook {
+  alert: OpenAlertDialog;
+  confirm: OpenConfirmDialog;
+  open: OpenDialog;
+  close: CloseDialog;
+}
+declare function useDialogs(): DialogHook;
+//#endregion
+//#region src/contexts/NotificationContext.d.ts
+interface NotificationOptions {
+  severity?: AlertColor;
+  autoHideDuration?: number;
+}
+interface NotificationContextValue {
+  notify: (message: string, options?: NotificationOptions) => void;
+}
+//#endregion
+//#region src/hooks/UseNotification.d.ts
+declare function useNotification(): NotificationContextValue;
+//#endregion
+//#region src/hooks/UseScanDetection.d.ts
+interface Config {
+  /** Time to wait from last character to then trigger an evaluation of the buffer. */
+  timeToEvaluate?: number;
+  /** Average time between characters in milliseconds. Used to determine if input is from keyboard or a scanner. Defaults to 50ms.*/
+  averageWaitTime?: number;
+  /** Character that barcode scanner prefixes input with.*/
+  startCharacter?: Array<string>;
+  /** Character that barcode scanner suffixes input with. Defaults to line return.*/
+  endCharacter?: Array<string>;
+  /** Callback to use on complete scan input.*/
+  onComplete: (code: string) => void;
+  /** Callback to use on error. */
+  onError?: (error: string) => void;
+  /** Minimum length a scanned code should be. Defaults to 0.*/
+  minLength?: number;
+  /** Ignore scan input if this node is focused.*/
+  ignoreIfFocusOn?: Node;
+  /** Stop propagation on keydown event. Defaults to false.*/
+  stopPropagation?: boolean;
+  /** Prevent default on keydown event. Defaults to false.*/
+  preventDefault?: boolean;
+  /** Bind keydown event to this node. Defaults to document.*/
+  container?: Node;
+  /** Indicates if the scanning is enabled. */
+  enabled?: boolean;
+}
+declare const useScanDetection: ({
+  timeToEvaluate,
+  averageWaitTime,
+  startCharacter,
+  endCharacter,
+  onComplete,
+  onError,
+  minLength,
+  ignoreIfFocusOn,
+  stopPropagation,
+  preventDefault,
+  container,
+  enabled
+}: Config) => void;
+//#endregion
+export { type DialogProps, useDialogs, useFieldContext, useFormContext, useInView, useLayoutForm, useNotification, useScanDetection, useTranslation, withLayoutForm };
+//# sourceMappingURL=hooks.d.ts.map