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

Toggle

class Toggle extends BeartropyComponent

Toggle Component.

Renders a toggle switch (checkbox alternative) with autosave support.

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 size.
bool $sm

Small size.
bool $md

Medium size (default).
bool $lg

Large size.
bool $xl

Extra Large size.
bool $primary

Primary color.
bool $beartropy

Beartropy color (default).
bool $red

Red color.
bool $blue

Blue color.
bool $green

Green color.
bool $yellow

Yellow color.
bool $purple

Purple color.
bool $pink

Pink color.
bool $gray

Gray color.
bool $orange

Orange color.
bool $amber

Amber color.
bool $lime

Lime color.
bool $emerald

Emerald color.
bool $teal

Teal color.
bool $cyan

Cyan color.
bool $sky

Sky color.
bool $indigo

Indigo color.
bool $violet

Violet color.
bool $rose

Rose color.
bool $fuchsia

Fuchsia color.
bool $slate

Slate color.
bool $stone

Stone color.
bool $zinc

Zinc color.
bool $neutral

Neutral 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 $name = null, string|null $label = null, string|null $labelPosition = 'right', string|null $color = null, string|null $size = null, mixed $customError = null, bool $disabled = false, string|null $hint = null, string|null $help = null, bool $autosave = false, string $autosaveMethod = 'savePreference', string|null $autosaveKey = null, int $autosaveDebounce = 300)

No description

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 44
__construct(string|null $name = null, string|null $label = null, string|null $labelPosition = 'right', string|null $color = null, string|null $size = null, mixed $customError = null, bool $disabled = false, string|null $hint = null, string|null $help = null, bool $autosave = false, string $autosaveMethod = 'savePreference', string|null $autosaveKey = null, int $autosaveDebounce = 300)

No description

Parameters

string|null $name
string|null $label
string|null $labelPosition
string|null $color
string|null $size
mixed $customError
bool $disabled
string|null $hint
string|null $help
bool $autosave
string $autosaveMethod
string|null $autosaveKey
int $autosaveDebounce

at line 60
View render()

No description

Return Value

View