Leave Yamada UI a star
StarFileInput is a component used for users to select files.
Description
The visual color appearance of the component.
Type
"blackAlpha" | "whiteAlpha" | "amber" | "blue" | "info" | "link" | "primary" | "cyan" | "emerald" | "flashy" | "fuchsia" | "gray" | "green" | "success" | "indigo" | "lime" | "neutral" | "orange" | "warning" | "pink" | "purple" | "red" | "danger" | "rose" | "sky" | "teal" | "violet" | "secondary" | "yellow"Description
The component that displays uploaded files.
Type
FC<{ index: number; value: File }>Description
The initial value of the file input.
Type
File[]Description
If true, the form control will be disabled.
Type
booleanDefault
falseDescription
The border color when the input is invalid.
Type
"border" | BorderColor | "amber.50" | "amber.100" | "amber.200" | "amber.300" | "amber.400" | "amber.500" | "amber.600" | "amber.700" | "amber.800" | "amber.900" | ... 320 more ... | [...]Description
The border color when the input is focused.
Type
"border" | BorderColor | "amber.50" | "amber.100" | "amber.200" | "amber.300" | "amber.400" | "amber.500" | "amber.600" | "amber.700" | "amber.800" | "amber.900" | ... 320 more ... | [...]Description
A callback that formats the name of the uploaded file.
Type
(value: File, index: number) => stringDescription
If true, the form control will be invalid.
Type
booleanDefault
falseDescription
If true, the form control will be disabled.
Deprecated
Use disabled instead.
Type
booleanDefault
falseDescription
If true, the form control will be invalid.
Deprecated
Use invalid instead.
Type
booleanDefault
falseDescription
If true, the form control will be readonly.
Deprecated
Use readOnly instead.
Type
booleanDefault
falseDescription
If true, the form control will be required.
Deprecated
Use required instead.
Type
booleanDefault
falseDescription
Function to be called when a file change event occurs.
Type
(files: File[] | undefined) => voidDescription
If true, the form control will be readonly.
Type
booleanDefault
falseDescription
If true, the form control will be required.
Type
booleanDefault
falseDescription
Ref to a reset function.
Type
type ONLY_FOR_FORMAT =
| ((instance: (() => void) | null) => void)
| MutableRefObject<(() => void) | null>Description
The string to separate uploaded files.
Type
stringDefault
','Description
The size of the FileInput.
Type
"xs" | "sm" | "md" | "lg" | "xl"Default
"md"Description
The value of the file input.
Type
File[]Description
The variant of the FileInput.
Type
"filled" | "flushed" | "outline" | "unstyled"Default
"outline"Edit this page on GitHub