[REF]: Improve README and release new components: InputButon and FileItemContainer

Author: JinSSJ3

CHANGELOG.md

@@ -12,12 +12,13 @@ All notable changes to this project will be documented in this file. See [standa
 
 <a name="1.1.84"></a>
 
-## [1.1.56](https://github.com/glicht/npm-get-version/compare/v1.0.1...v1.0.2) (2021-09-12)
+## [1.1.84](https://github.com/glicht/npm-get-version/compare/v1.0.1...v1.0.2) (2021-09-12)
 
 ### Features
 
 - Release Input File Button
-- Release Dropzone Label
+- Release FileItemContainer Compnent
+- Improve API doc for all components (now arranged alphabetically)
 
 
 
@@ -36,20 +37,20 @@ All notable changes to this project will be documented in this file. See [standa
 
 ### Features
 
-- added readme status badges ([5c25d8d](https://github.com/glicht/npm-get-version/commit/5c25d8d))
+- added readme status badges 
 
-- Add Travis ci and coveralls integration ([dd6b023](https://github.com/glicht/npm-get-version/commit/dd6b023))
+- Add Travis ci and coveralls integration 
 
-- update README description ([1e59cee](https://github.com/glicht/npm-get-version/commit/1e59cee))
-- Dropzone, FileItem components released
+- update README description 
+- Dropzone, FileItem and FullScreenImage components released
 
 <a name="1.0.1"></a>
 
 ## [1.0.1](https://github.com/glicht/npm-get-version/compare/v1.0.0...v1.0.1) (2021-08-28)
 
 ### Features
 
-- README improvements ([37d57cc](https://github.com/glicht/npm-get-version/commit/37d57cc))
+- README improvements
 
 <a name="1.0.0"></a>
 

README.md

@@ -75,7 +75,7 @@ export interface DropzoneProps extends OverridableProps {
      * must be a function that recieves as first parameter a File Object
      * and must return a boolean value
      */
-    validator?: any;
+    validator?: (f: File) => boolean;
     /**
      * The current number of valid files
      */

build/components/dropzone/components/Dropzone/DropzoneProps.d.ts

@@ -1,4 +1,9 @@
 import { OverridableProps } from "@unlimited-react-components/kernel";
 export interface FileItemContainerProps extends OverridableProps {
+    /**
+     * `grid` will display files in a grid layout. `list` will display
+     * files in a horizontal list.
+     * Convenient for saving space in page.
+     */
     view?: "grid" | "list";
 }

build/components/file-item/components/FileItemContainer/FileItemContainerProps.d.ts

@@ -1,41 +1,41 @@
 import { MaterialButtonProps } from "@unlimited-react-components/material-button";
 export interface InputButtonProps extends MaterialButtonProps {
+    /**
+     * the id of the component
+     */
     id?: string;
     /**
      * whether to accept multiple files or not
      */
     multiple?: boolean;
     /**
-     * the list of mimetypes and extensions of files to accept
+     * The list of mimetypes and extensions of files
+     * to accept. This is a comma separated list of
+     *  mime types or file extensions.
+     * Eg.: image/\*,application/pdf,.psd
      */
     accept?: string;
     /**
      * If given, this label will be shwed inside the button
      */
     label?: string;
     /**
-     * what to do after selecting the files
-     * tipically returns the File[] to the parent component
+     * what to do after selecting the files. Returns the File[] to the parent component
      */
     onChange?: Function;
     /**
    * custom validator
    * must be a function that recieves as first parameter a File Object
    * and must return a boolean value
    */
-    validator?: any;
+    validator?: (f: File) => boolean;
     /**
      * Max number of files to be accepted.
      */
-    maxFiles?: number;
     /**
      * max file size allowed in bytes
      */
     maxFileSize?: number;
-    /**
-     * If true, the dropzone component itself will be clickable
-     */
-    uploadOnSelect?: boolean;
 }
 /**
  * The default props when not given