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

Icon

class Icon extends BeartropyComponent

Icon Component.

Renders icons from various sets (Heroicons, Lucide, FontAwesome, Beartropy SVG). Colors are applied via Tailwind classes on the class prop — no color presets.

Blade Props

Magic Attributes (Size)

Traits

HasPresets

Trait HasPresets.

HasErrorBag

Trait HasErrorBag.

Properties

string|null $size

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

 from  BeartropyComponent
bool $xs

Extra Small.
bool $sm Small.
bool $md

Medium (default).
bool $lg Large.
bool $xl

Extra Large.

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 $name, string|null $size = null, string $class = '', bool $solid = false, bool $outline = false, string|null $set = null, string|null $variant = null)

No description

object
getClasses(string|null $iconSize)

Resolve icon classes and component names.

View
render()

No description

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 31
__construct(string $name, string|null $size = null, string $class = '', bool $solid = false, bool $outline = false, string|null $set = null, string|null $variant = null)

No description

Parameters

string $name

Icon name (e.g. 'home', 'heroicon-s-home', 'fa-home').
string|null $size

Size preset key (xs, sm, md, lg, xl).
string $class

Additional CSS classes.
bool $solid

Force solid variant.
bool $outline

Force outline variant.
string|null $set

Icon set override (heroicons, lucide, fontawesome, beartropy).
string|null $variant

Variant override (solid, outline).

at line 50
object getClasses(string|null $iconSize)

Resolve icon classes and component names.

Logic to determine which icon set, variant, and component to render.

Parameters

string|null $iconSize

Size classes.

Return Value

object

at line 99
View render()

No description

Return Value

View