PixiDom - v1.0.0
    Preparing search index...

    Type Alias ToggleOptions

    Configuration options for creating a Toggle component.

    type ToggleOptions = {
        animationOptions?: AnimationOptions;
        backgroundOutline?: OutlineOptions;
        borderRadius: number;
        height: number;
        labelOptions?: LabelOptions;
        offBackgroundColor: Color;
        offCircleColor: Color;
        offToggleColor?: Color;
        onBackgroundColor: Color;
        onCircleColor: Color;
        onToggleColor?: Color;
        startingValue?: boolean;
        width: number;
    }
    Index

    Properties

    animationOptions? backgroundOutline? borderRadius height labelOptions? offBackgroundColor offCircleColor offToggleColor? onBackgroundColor onCircleColor onToggleColor? startingValue? width

    Properties

    animationOptions?: AnimationOptions

    Optional animation configuration for state transitions

    backgroundOutline?: OutlineOptions

    Optional outline/border for the toggle background

    borderRadius: number

    Border radius as a percentage (0-100)

    height: number

    Height of the toggle in pixels

    labelOptions?: LabelOptions

    Optional text labels for ON/OFF states

    offBackgroundColor: Color

    Background color when toggle is OFF. Accepts any Color format.

    offCircleColor: Color

    Circle/handle color when toggle is OFF. Accepts any Color format.

    offToggleColor?: Color

    Use offCircleColor instead

    onBackgroundColor: Color

    Background color when toggle is ON. Accepts any Color format.

    onCircleColor: Color

    Circle/handle color when toggle is ON. Accepts any Color format.

    onToggleColor?: Color

    Use onCircleColor instead

    startingValue?: boolean

    Initial toggle state (true = ON, false = OFF). Set without triggering animation.

    width: number

    Width of the toggle in pixels

    Settings

    Member Visibility

    On This Page

    Properties