@bdt-component-library/file-upload NPM

FileUpload Component

About

This is a component published as its own package from our component library monorepo: https://github.com/BenefitsDataTrust/ui-components. Setup instructions, as well as higher-level goals and concerns can be found from the main project README.

Description

Handles display of file upload.

API

prop	type	required	default	explanation
className	string	no	n/a	Adds an optional classname to form if using form and to label
disabled	boolean	no	undefined	Determines input disabled state
variant	enum("solid", "outlined", "text")	no	"solid"	Determines the button style variant
id	string	yes	no	Input id attr
helperText	string	no	undefined	Adds optional helper text for input
required	boolean	no	undefined	Determines if the checkbox input is a required field
nativeRequired	boolean	no	undefined	Determines if the checkbox input is a required field (native)
name	string	no	no	Input name attr
label	string	yes	no	Input label text
loading	boolean	no	undefined	Determines input loading state
inputRef	any	no	undefined	Allows specifying react ref for input
onChangeAction	function("File", "FileReader")	no	undefined	Event handler for onloadend events
withForm	boolean	no	true	Determines if the input occurs as part of a form
noBottomMargin	boolean	no	false	Determines whether or not there is a bottom margin around FileUpload