From cb7f85b9d0e5ad15dbe8de8b5cc74755be62c32b Mon Sep 17 00:00:00 2001
From: Jose Manuel Serrano Amaut <a20122128@pucp.pe>
Date: Sun, 19 Mar 2023 01:10:12 -0500
Subject: [PATCH] [REF]: Change DropzoneActions type name width ActionButtons
---
.../dropzone/components/dropzone/Dropzone.tsx | 9 +-
.../components/dropzone/DropzoneProps.ts | 82 +++++++++----------
2 files changed, 43 insertions(+), 48 deletions(-)
diff --git a/src/files-ui/components/dropzone/components/dropzone/Dropzone.tsx b/src/files-ui/components/dropzone/components/dropzone/Dropzone.tsx
index 7390524..d05306c 100644
--- a/src/files-ui/components/dropzone/components/dropzone/Dropzone.tsx
+++ b/src/files-ui/components/dropzone/components/dropzone/Dropzone.tsx
@@ -32,10 +32,11 @@ import {
import { mergeProps } from "../../../overridable";
import InputHidden from "../../../input-hidden/InputHidden";
import {
+ ActionButtons,
defaultDrozoneProps,
// DEFAULT_BORDER_RADIUS,
//DropzoneActionButton,
- DropzoneActions,
+ //DropzoneActions,
DropzoneProps,
FooterConfig,
HeaderConfig,
@@ -76,10 +77,10 @@ const Dropzone: React.FC<DropzoneProps> = (props: DropzoneProps) => {
onUploadFinish,
//styling
background,
- minHeight,
color,
+ minHeight,
style,
- textColor,
+ //textColor,
className,
//label
label,
@@ -129,7 +130,7 @@ const Dropzone: React.FC<DropzoneProps> = (props: DropzoneProps) => {
cleanButton,
style: containerStyle,
className: containerClassName,
- } = actionButtons as DropzoneActions;
+ } = actionButtons as ActionButtons;
const styleBorderRadius: string | number | undefined = style?.borderRadius;
diff --git a/src/files-ui/components/dropzone/components/dropzone/DropzoneProps.ts b/src/files-ui/components/dropzone/components/dropzone/DropzoneProps.ts
index 2bdd281..c5ee403 100644
--- a/src/files-ui/components/dropzone/components/dropzone/DropzoneProps.ts
+++ b/src/files-ui/components/dropzone/components/dropzone/DropzoneProps.ts
@@ -32,25 +32,26 @@ export interface DropzoneFullProps extends OverridableComponentProps {
value?: ExtFile[];
/////////////// VALIDATION STAGE ///////////////
- /**
- * The max file size allowed in bytes
- */
- maxFileSize?: number;
- /**
- * The max number of files to be accepted.
- */
- maxFiles?: number;
/**
* The default implementation of accept
* checks the file's mime type or extension
- * against this list. This is a comma
- * separated list of mime types or file extensions.
+ * against this list. This is a comma-separated
+ * list of one or more file types, or unique file type specifiers,
+ * describing which file types to allow.
* E.g.:
* ```js
* acccept="image/*, application/pdf, .psd"
* ```
*/
accept?: string;
+ /**
+ * The max number of files to be accepted.
+ */
+ maxFiles?: number;
+ /**
+ * The max file size allowed in bytes.
+ */
+ maxFileSize?: number;
/**
* The custom validator to validate files that are selected or dropped in dropzone compoent.
* Must be a function that recieves as first parameter a File Object
@@ -66,13 +67,11 @@ export interface DropzoneFullProps extends OverridableComponentProps {
/**
* When given, "clean" button will be visible if validation is active.
* This event is triggered when "clean button is clicked"
- * Returns as first parameter the list of files without not valid files
*/
onClean?: Function;
/**
- * Flag that indicates that dropzone will automatically remove non valid files.
- * This will happen every time user drops files or selects files from file dialog.
- * This flag will only work if validation is active.
+ * If true, the component will automatically remove non valid files when user
+ * drops files or selects them from file dialog. This flag will only work if validation is active.
*/
autoClean?: boolean;
/**
@@ -88,42 +87,37 @@ export interface DropzoneFullProps extends OverridableComponentProps {
* The configuration needed for uploading the files.
* When "uploadConfig" is not given or uploadConfig.url is undefined
* the upload button will not be visible
- * and uploadOnDrop flag will not work
+ * and uploadOnDrop prop flag will not work.
*/
uploadConfig?: UploadConfig;
/**
- * Flag that indicates Dropzone to perform a fake upload process.
- * If given or true, will ignore `uploadConfig` prop, will show
+ * If set, the component will simulate the upload operation by randomly
+ setting the upload status and message on each uploadable{" "}
+ <TypeHighlight>ExtFile</TypeHighlight>. It will also set a fake
+ progress. Also the `uploadConfig` prop will be ignored and will show
* the upload button
- * Will respond with random upload status on every uploadable file
*/
fakeUpload?: boolean;
/**
- * This event is triggered when upload process starts
- * also returns the list of files that will be uploaded,
- * Unlike Onchange, onUploadStart will only return a list of files thta are candidates to be uploaded,
- * in case they are valid or upload status is "error"
+ * Callback fired when the upload process starts.
*/
- onUploadStart?: (extFiles: ExtFile[]) => void;
+ onUploadStart?: (uploadAbleFiles: ExtFile[]) => void;
/**
- * This event returns as first aparameter the list of responses for each file following the structure:
- * responses = [
- * {id: <the file id>, serverResponse: the server response}
- * ]
+ * Callback fired when the upload process ends.
*/
- onUploadFinish?: (extFiles: ExtFile[]) => void;
+ onUploadFinish?: (uploadedFiles: ExtFile[]) => void;
/////////////// STYLING ///////////
//borderRadius?: string | number;
/**
- * The background color for dropzone container,
+ * The background color for dropzone container.
* @default 'transparent'
*/
background?: string;
/**
- * The min height of the container in string format
- * If the value is given un number format "px" will be assumed
+ * The min height of the component.
+ * If the value is given in number format, "px" will be assumed
* @default "180px"
*
* examples:
@@ -166,11 +160,9 @@ export interface DropzoneFullProps extends OverridableComponentProps {
onDragLeave?: (evt: React.DragEvent<HTMLDivElement>) => void;
//ACTION BUTTONS
- /**
- * The configuration needed for uploading the files.
- * When "uploadConfig" is not given or uploadConfig.url is undefined
- * the upload button will not be visible
- * and uploadOnDrop flag will not work
+ /** If set, buttons will be added on the before or after of the component.
+ This buttons triggresthe common opertions of the component such as
+ clean, upload, abort and delete all.
*/
actionButtons?: DropzoneActions;
@@ -183,21 +175,21 @@ export interface DropzoneFullProps extends OverridableComponentProps {
// HEADER AND FOOTER
/**
- * If false, hides the dropzone footer
+ * If false, hides the dropzone footer.
* @default true
*/
footer?: boolean;
/**
- * If false, hides the dropzone header
+ * If false, hides the dropzone header.
* @default true
*/
header?: boolean;
/**
- * Configuration related to the dropzone header
+ * Configuration related to the dropzone header.
*/
headerConfig?: HeaderConfig;
/**
- * Configuration related to the dropzone footer
+ * Configuration related to the dropzone footer.
*/
footerConfig?: FooterConfig;
@@ -209,8 +201,7 @@ export interface DropzoneFullProps extends OverridableComponentProps {
disabled?: boolean;
//CLICKABLE
/**
- * If true, the dropzone component itself will be clickable
- * If false, the file dialog will not be opened
+ * If false, the component will not be clickable. So, file dialog will not be opened.
* @default true
*/
clickable?: boolean;
@@ -256,7 +247,7 @@ export type FooterConfig = {
noMissingFilesLabel?: boolean;
customMessage?: JSX.Element;
-
+
customFooter?: JSX.Element;
}
@@ -268,7 +259,7 @@ export type DropzoneActionButton = {
className?: string;
resetStyles?: boolean;
onClick?: Function;
- disabled?:boolean;
+ disabled?: boolean;
}
export interface DropzoneActions {
@@ -280,6 +271,9 @@ export interface DropzoneActions {
deleteButton?: DropzoneActionButton;
cleanButton?: DropzoneActionButton;
}
+export type ActionButtons = {
+ [P in keyof DropzoneActions]: DropzoneActions[P]
+}
type DefDivProps = React.HTMLProps<HTMLDivElement>;
--
GitLab