@torq-north/react-tools 1.2.0 → 1.3.0

package/dist/src/Form/Components/FileEditorField/FileEditorField.d.ts

@@ -1,9 +1,5 @@
-import { Asset } from "../../../MUI/Components/FileDisplay/asset";
 import { CommonFieldProps } from "../../Types";
 import { Accept } from "react-dropzone";
-export interface PrexistingAsset {
-}
-export type FileType = (Asset | File)[] | Asset | File | string | null | undefined;
 export interface FileEditorFieldProps extends CommonFieldProps<{}> {
     multiple?: boolean;
     placeholder?: boolean;
@@ -11,4 +7,4 @@ export interface FileEditorFieldProps extends CommonFieldProps<{}> {
     maxFiles?: number;
     forceError?: boolean;
 }
-export declare function FileEditorField({ name, label, icon, showSpace, multiple, disabled, helperText, placeholder, required, slotProps, accept, forceError, }: FileEditorFieldProps): import("react/jsx-runtime").JSX.Element;
+export declare function FileEditorField({ name, label, icon, showSpace, multiple, disabled, helperText, placeholder, required, slotProps, accept, maxFiles, forceError, }: FileEditorFieldProps): import("react/jsx-runtime").JSX.Element;

package/dist/src/Form/Components/FileEditorField/useFileEditorField.d.ts

@@ -1,40 +1,6 @@
 import { UseFieldConfig } from "react-final-form";
-import { DropzoneOptions } from "react-dropzone";
-import { Asset } from "../../../MUI/Components/FileDisplay/asset";
-export type FileEditorOptions = Pick<DropzoneOptions, "accept" | "multiple" | "maxSize" | "minSize" | "maxFiles"> & {
-    disabled?: boolean;
-    fieldProps?: UseFieldConfig;
+import { FileType } from "../../../MUI/Components/FileEditor";
+export declare function useFileEditorField(name: string, options?: {
     required?: boolean;
-};
-export declare function useFileEditorField(name: string, options: FileEditorOptions): {
-    dragOverDropzone: boolean;
-    getRootProps: <T extends import("react-dropzone").DropzoneRootProps>(props?: T) => T;
-    getInputProps: <T extends import("react-dropzone").DropzoneInputProps>(props?: T) => T;
-    open: () => void;
-    removeFile: (file: Asset | File) => void;
-    values: (Asset | File)[];
-    showError: boolean;
-    setShowError: import("react").Dispatch<import("react").SetStateAction<boolean>>;
-    errorMessage: string;
-    meta: {
-        active?: boolean;
-        data?: Record<string, any>;
-        dirty?: boolean;
-        dirtySinceLastSubmit?: boolean;
-        error?: any;
-        initial?: any;
-        invalid?: boolean;
-        length?: number;
-        modified?: boolean;
-        modifiedSinceLastSubmit?: boolean;
-        pristine?: boolean;
-        submitError?: any;
-        submitFailed?: boolean;
-        submitSucceeded?: boolean;
-        submitting?: boolean;
-        touched?: boolean;
-        valid?: boolean;
-        validating?: boolean;
-        visited?: boolean;
-    };
-};
+    fieldProps?: UseFieldConfig;
+}): import("react-final-form").FieldRenderProps<FileType, HTMLElement, any>;

package/dist/src/Form/Components/FileEditorField.d.ts

@@ -0,0 +1,13 @@
+import React from "react";
+import { CommonFieldProps } from "../Types";
+import { Accept } from "react-dropzone";
+export interface FileEditorFieldProps extends CommonFieldProps<{}> {
+    multiple?: boolean;
+    placeholder?: React.ReactNode;
+    accept?: Accept;
+    maxFiles?: number;
+    maxSize?: number;
+    minSize?: number;
+    forceError?: boolean;
+}
+export declare function FileEditorField({ name, label, icon, showSpace, multiple, disabled, helperText, placeholder, required, slotProps, accept, maxFiles, maxSize, minSize, forceError, validators, }: FileEditorFieldProps): import("react/jsx-runtime").JSX.Element;

package/dist/src/Form/Utilities/isFileRequired.d.ts

@@ -0,0 +1,3 @@
+import type { FileType } from "../../MUI/Components/FileEditor";
+import type { Validator } from "../Types/Validator";
+export declare const isFileRequired: Validator<FileType>;

package/dist/src/MUI/Components/FileEditor/DropIndicator.d.ts

@@ -0,0 +1,9 @@
+import { BoxProps } from "@mui/material";
+import { StyledComponent } from "@emotion/styled";
+type DropIndicatorProps = BoxProps & {
+    dragOver: boolean;
+    multiple: boolean | undefined;
+    disabled?: boolean;
+};
+export declare const DropIndicator: StyledComponent<DropIndicatorProps>;
+export {};

package/dist/src/MUI/Components/FileEditor/FileEditor.d.ts

@@ -0,0 +1,8 @@
+import React from "react";
+import { FileEditorOptions, FileType } from "./useFileEditor";
+export interface FileEditorProps extends FileEditorOptions {
+    value: FileType;
+    onChange: (value: FileType) => void;
+    placeholder?: React.ReactNode;
+}
+export declare function FileEditor({ value, onChange, multiple, disabled, placeholder, accept, maxFiles, maxSize, minSize, }: FileEditorProps): import("react/jsx-runtime").JSX.Element;

package/dist/src/MUI/Components/FileEditor/index.d.ts

@@ -0,0 +1,4 @@
+export { FileEditor } from "./FileEditor";
+export type { FileEditorProps } from "./FileEditor";
+export { useFileEditor } from "./useFileEditor";
+export type { FileEditorOptions, FileType } from "./useFileEditor";

package/dist/src/MUI/Components/FileEditor/useFileEditor.d.ts

@@ -0,0 +1,17 @@
+import { DropzoneOptions } from "react-dropzone";
+import { Asset } from "../FileDisplay/asset";
+export type FileType = (Asset | File)[] | Asset | File | string | null | undefined;
+export type FileEditorOptions = Pick<DropzoneOptions, "accept" | "multiple" | "maxSize" | "minSize" | "maxFiles"> & {
+    disabled?: boolean;
+};
+export declare function useFileEditor(value: FileType, onChange: (value: FileType) => void, options: FileEditorOptions): {
+    dragOverDropzone: boolean;
+    getRootProps: <T extends import("react-dropzone").DropzoneRootProps>(props?: T) => T;
+    getInputProps: <T extends import("react-dropzone").DropzoneInputProps>(props?: T) => T;
+    open: () => void;
+    removeFile: (file: Asset | File) => void;
+    values: (Asset | File)[];
+    showError: boolean;
+    setShowError: import("react").Dispatch<import("react").SetStateAction<boolean>>;
+    errorMessage: string;
+};

package/dist/src/index.d.ts

@@ -10,6 +10,7 @@ export * from "./MUI/Components/LoaderButton";
 export * from "./MUI/Components/ExtendedPagination";
 export * from "./MUI/Components/FileDisplay";
 export * from "./MUI/Components/FileDropper";
+export * from "./MUI/Components/FileEditor";
 export * from "./MUI/Components/EditableBlock";
 export * from "./MUI/Components/LabeledValue";
 export * from "./MUI/Components/TabSet";

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@torq-north/react-tools",
   "type": "module",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "description": "A collection of commonly used utilities",
   "author": "@torq-north",
   "license": "SEE LICENCE.md",
@@ -22,7 +22,8 @@
     "ladle": "npx ladle serve",
     "build": "rollup -c",
     "predeploy": "npm run build",
-    "deploy": "npm publish --access public"
+    "deploy": "npm publish --access public",
+    "typewatch": "tsc -w --noEmit"
   },
   "keywords": [],
   "peerDependencies": {