1. class
  2. Beartropy
  3. \
  4. Ui
  5. \
  6. Components
  7. \
  8. FileDropzone

FileDropzone

class FileDropzone extends BeartropyComponent

FileDropzone component.

A drag-and-drop file upload area with client-side validation, image previews, existing-file support, and Livewire integration.

Traits

HasPresets

Trait HasPresets.

HasErrorBag

Trait HasErrorBag.

Properties

string|null $size

Component size (md, lg, etc.) used for preset resolution.

 from  BeartropyComponent
string|null $id

Component ID.
string|null $name

Input name.
string|null $label

Label text.
string|null $color

Color preset.
bool $multiple

Allow multiple files.
string|null $accept

File accept attribute (e.g. "image/*,.pdf").
int|null $maxFileSize

Max file size in bytes (null = no limit).
int|null $maxFiles

Max number of files (null = unlimited).
string|null $placeholder

Override empty-state text.
bool $preview

Show image previews.
bool $clearable

Allow clearing selection.
bool $disabled

Disabled state.
mixed $customError

Custom error message.
string|null $help

Help text.
string|null $hint

Hint text (alias for help).
array $existingFiles

Existing files [{name, url, size?, type?}].

Color Presets
bool $primary

Primary color (alias for beartropy).
bool $beartropy

Beartropy color.
bool $red

Red color.
bool $orange

Orange color.
bool $amber

Amber color.
bool $yellow

Yellow color.
bool $lime

Lime color.
bool $green

Green color.
bool $emerald

Emerald color.
bool $teal

Teal color.
bool $cyan

Cyan color.
bool $sky

Sky color.
bool $blue

Blue color.
bool $indigo

Indigo color.
bool $violet

Violet color.
bool $purple

Purple color.
bool $fuchsia

Fuchsia color.
bool $pink

Pink color.
bool $rose

Rose color.
bool $slate

Slate color.
bool $gray

Gray color.
bool $zinc

Zinc color.
bool $neutral

Neutral color.
bool $stone

Stone color.

Methods

array
getComponentPresets(string|null $componentName = null, ComponentAttributeBag|null $attributes = null)

Compute component presets based on context.

from  HasPresets
array
loadPresets(string $componentName)

No description

from  HasPresets
array
loadComponentDefaults(string $componentName)

No description

from  HasPresets
bool
detectHasVariants(array $colors)

No description

from  HasPresets
array
computeSupports(array $sizes, array $colorsArray, array $defaults, array $magicProps)

No description

from  HasPresets
array
resolveSize(array $supports, array $sizes, array $defaults, array $magicProps)

No description

from  HasPresets
array
resolveVariant(array $supports, array $colorsArray, array $componentPresets, array $defaults, array $magicProps, bool $hasVariants)

No description

from  HasPresets
array
resolveColor(array $supports, array $colorsArray, array $componentPresets, array $defaults, array $magicProps, string|null $variant, bool $hasVariants)

No description

from  HasPresets
array
resolveFill(array $supports, array $attributes, array $defaults)

No description

from  HasPresets
string
buildCacheKey(string $component, array $supports, string|null $size, string|null $variant, string|null $color, bool $shouldFill)

No description

from  HasPresets
void
syncInstanceProps(array $supports, string|null $size, string|null $variant, string|null $color)

No description

from  HasPresets
array
buildPresetNames(array $supports, string|null $size, string|null $variant, string|null $color, bool $shouldFill, string $sizeOrigin, string $variantOrigin, string $colorOrigin, string $fillOrigin)

No description

from  HasPresets
void
debugWarnings(array $supports, array $sizePreset, array $colorPreset, string $componentName, string|null $variant, string|null $color)

No description

from  HasPresets
array
getErrorState(ComponentAttributeBag|null $attributes = null, ViewErrorBag|MessageBag|null $errors = null, string|null $error = null)

Determine the error state for a specific field.

from  HasErrorBag
array
getWireModelState(ComponentAttributeBag|null $attributes = null)

Analyze wire:model attributes to determine binding state.

from  BeartropyComponent
array
getSizePreset(string|null $componentName = null, array|ComponentAttributeBag|null $attributes = null, string $defaultSize = 'md')

Resolve the size preset for the component.

from  BeartropyComponent
__construct(string|null $id = null, string|null $name = null, string|null $label = null, string|null $color = null, bool $multiple = true, string|null $accept = null, int|null $maxFileSize = null, int|null $maxFiles = null, string|null $placeholder = null, bool $preview = true, bool $clearable = true, bool $disabled = false, mixed $customError = null, string|null $help = null, string|null $hint = null, array $existingFiles = [])

Create a new FileDropzone component instance.

string
formatBytes(int $bytes)

Format bytes to a human-readable string.

string
getAcceptHint()

Build the accept/size hint string shown below the dropzone icon.

View
render()

Get the view / contents that represent the component.

Details

in HasPresets at line 21
array getComponentPresets(string|null $componentName = null, ComponentAttributeBag|null $attributes = null)

Compute component presets based on context.

Parameters

string|null $componentName

Component key.
ComponentAttributeBag|null $attributes

Attributes bag.

Return Value

array

[colorPreset, sizePreset, shouldFill, presetNames]

in HasPresets at line 59
protected array loadPresets(string $componentName)

No description

Parameters

string $componentName

Return Value

array

in HasPresets at line 73
protected array loadComponentDefaults(string $componentName)

No description

Parameters

string $componentName

Return Value

array

in HasPresets at line 88
protected bool detectHasVariants(array $colors)

No description

Parameters

array $colors

Return Value

bool

in HasPresets at line 116
protected array computeSupports(array $sizes, array $colorsArray, array $defaults, array $magicProps)

No description

Parameters

array $sizes
array $colorsArray
array $defaults
array $magicProps

Return Value

array

in HasPresets at line 137
protected array resolveSize(array $supports, array $sizes, array $defaults, array $magicProps)

No description

Parameters

array $supports
array $sizes
array $defaults
array $magicProps

Return Value

array

in HasPresets at line 174
protected array resolveVariant(array $supports, array $colorsArray, array $componentPresets, array $defaults, array $magicProps, bool $hasVariants)

No description

Parameters

array $supports
array $colorsArray
array $componentPresets
array $defaults
array $magicProps
bool $hasVariants

Return Value

array

in HasPresets at line 223
protected array resolveColor(array $supports, array $colorsArray, array $componentPresets, array $defaults, array $magicProps, string|null $variant, bool $hasVariants)

No description

Parameters

array $supports
array $colorsArray
array $componentPresets
array $defaults
array $magicProps
string|null $variant
bool $hasVariants

Return Value

array

in HasPresets at line 293
protected array resolveFill(array $supports, array $attributes, array $defaults)

No description

Parameters

array $supports
array $attributes
array $defaults

Return Value

array

in HasPresets at line 338
protected string buildCacheKey(string $component, array $supports, string|null $size, string|null $variant, string|null $color, bool $shouldFill)

No description

Parameters

string $component
array $supports
string|null $size
string|null $variant
string|null $color
bool $shouldFill

Return Value

string

in HasPresets at line 349
protected void syncInstanceProps(array $supports, string|null $size, string|null $variant, string|null $color)

No description

Parameters

array $supports
string|null $size
string|null $variant
string|null $color

Return Value

void

in HasPresets at line 365
protected array buildPresetNames(array $supports, string|null $size, string|null $variant, string|null $color, bool $shouldFill, string $sizeOrigin, string $variantOrigin, string $colorOrigin, string $fillOrigin)

No description

Parameters

array $supports
string|null $size
string|null $variant
string|null $color
bool $shouldFill
string $sizeOrigin
string $variantOrigin
string $colorOrigin
string $fillOrigin

Return Value

array

in HasPresets at line 384
protected void debugWarnings(array $supports, array $sizePreset, array $colorPreset, string $componentName, string|null $variant, string|null $color)

No description

Parameters

array $supports
array $sizePreset
array $colorPreset
string $componentName
string|null $variant
string|null $color

Return Value

void

in HasErrorBag at line 24
array getErrorState(ComponentAttributeBag|null $attributes = null, ViewErrorBag|MessageBag|null $errors = null, string|null $error = null)

Determine the error state for a specific field.

Checks both the session error bag and specific error attributes. Looks up errors by wire:model value or name attribute.

Parameters

ComponentAttributeBag|null $attributes

Component attributes.
ViewErrorBag|MessageBag|null $errors

Global error bag.
string|null $error

Specific error message override.

Return Value

array

[hasError, firstErrorMessage]

in BeartropyComponent at line 33
array getWireModelState(ComponentAttributeBag|null $attributes = null)

Analyze wire:model attributes to determine binding state.

Detects if wire:model is present and if it uses dot notation (e.g., user.name).

Parameters

ComponentAttributeBag|null $attributes

Component attributes.

Return Value

array

[hasWireModel, wireModelValue, hasDotNotation, parsedDotNotationValue]

in BeartropyComponent at line 64
array getSizePreset(string|null $componentName = null, array|ComponentAttributeBag|null $attributes = null, string $defaultSize = 'md')

Resolve the size preset for the component.

Checks:

  1. Explicit $this->size.
  2. Magic attributes (e.g., <x-button sm />).
  3. Default size.

Parameters

string|null $componentName

Component name (used for context).
array|ComponentAttributeBag|null $attributes

Attributes array or bag.
string $defaultSize

Default size key.

Return Value

array

The resolved size preset configuration.

at line 76
__construct(string|null $id = null, string|null $name = null, string|null $label = null, string|null $color = null, bool $multiple = true, string|null $accept = null, int|null $maxFileSize = null, int|null $maxFiles = null, string|null $placeholder = null, bool $preview = true, bool $clearable = true, bool $disabled = false, mixed $customError = null, string|null $help = null, string|null $hint = null, array $existingFiles = [])

Create a new FileDropzone component instance.

Parameters

string|null $id

Component ID.
string|null $name

Input name.
string|null $label

Label text.
string|null $color

Color preset.
bool $multiple

Allow multiple files.
string|null $accept

File accept attribute.
int|null $maxFileSize

Max file size in bytes.
int|null $maxFiles

Max number of files.
string|null $placeholder

Override empty-state text.
bool $preview

Show image previews.
bool $clearable

Allow clearing selection.
bool $disabled

Disabled state.
mixed $customError

Custom error message.
string|null $help

Help text.
string|null $hint

Hint text (alias for help).
array $existingFiles

Existing files.

at line 101
string formatBytes(int $bytes)

Format bytes to a human-readable string.

Parameters

int $bytes

Return Value

string

at line 119
string getAcceptHint()

Build the accept/size hint string shown below the dropzone icon.

Return Value

string

at line 137
View render()

Get the view / contents that represent the component.

Return Value

View