@types/switchery/index.d.ts

TypeScript definitions for switchery

declare var switchery: Switchery.SwitcheryStatic;
export default switchery;
export as namespace Switchery;

declare namespace Switchery {
    interface SwitcheryStatic {
        new(node: Node, options?: Options): Switchery;
    }

    interface Options {
        /**
         * color of the switch element (HEX or RGB value)
         * @default '#64bd63'
         */
        color?: string | undefined;
        /**
         * secondary color for background color and border, when the switch is off
         * @default '#dfdfdf'
         */
        secondaryColor?: string | undefined;
        /**
         * color of the jack/handle element
         * @default '#fff'
         */
        jackColor?: string | undefined;
        /**
         * color of unchecked jack/handle element
         * @default 'null'
         */
        jackSecondaryColor?: string | undefined;
        /**
         * class name for the switch element (by default styled in switchery.css)
         * @default 'switchery'
         */
        className?: string | undefined;
        /**
         * enable or disable click events and changing the state of the switch (boolean value)
         * @default false
         */
        disabled?: boolean | undefined;
        /**
         * opacity of the switch when it's disabled (0 to 1)
         * @default 0.5
         */
        disabledOpacity?: number | undefined;
        /**
         * length of time that the transition will take, ex. '0.4s', '1s', '2.2s' (Note: transition speed of the handle is twice shorter)
         * @default '0.1s'
         */
        speed?: string | undefined;
        /**
         * size of the switch element (small or large)
         * @default 'default'
         */
        size?: string | undefined;
    }
}

interface Switchery {
    /**
     * Unbinding all event handlers attached to the switch element to prepare the object for garbage collection.
     * @returns {void}
     */
    destroy(): void;

    /**
     * Enable disabled switch by re-adding event handlers and changing the opacity to 1.
     * @returns {void}
     */
    enable(): void;

    /**
     * Disable switch by unbinding attached events and changing opacity to disabledOpacity value
     * @returns {void}
     */
    disable(): void;

    /**
     * Check if switch is currently disabled by checking the readonly and disabled attributes on the checkbox and the disabled option set via JS.
     *  If any of those are present, the returned value is true.
     * @returns {boolean} whether it's disabled or not.
     */
    isDisabled(): boolean;
}