native-base/src/components/primitives/Switch/types.ts

Essential cross-platform UI components for React Native

import type { SwitchProps } from 'react-native';
import type {
  CustomProps,
  ThemeComponentSizeType,
  ResponsiveValue,
} from '../../../components/types';
import type { IColors } from '../../../theme/base/colors';
import type { InterfaceBoxProps } from '../Box';
import type { ColorSchemeType } from '../../../components/types';

export interface InterfaceSwitchProps
  extends Omit<SwitchProps, 'tintColor'>,
    InterfaceBoxProps<ISwitchProps> {
  /**
   * The size (width and height) of the switch.
   * @default md
   */
  size?: ThemeComponentSizeType<'Switch'>;
  /**
   * If true, set the disabled to the invalid state.
   */
  isDisabled?: boolean;
  /**
   * If true, set the hovered state.
   */
  isHovered?: boolean;
  /**
   * The input name of the Switch when used in a form.
   */
  name?: string;
  /**
   * Function called when the state of the Switch changes.
   */
  onToggle?: (...args: any) => void;
  /**
   * If true, set the Switch to the checked state.
   */
  isChecked?: boolean;
  /**
   * If true, the checkbox will be initially checked.
   */
  defaultIsChecked?: boolean;
  /**
   * If true, set the switch to the invalid state.
   */
  isInvalid?: boolean;
  /**
   * The track color of the Switch when on.
   */
  onTrackColor?: ResponsiveValue<IColors | (string & {})>;
  /**
   * The track color of the Switch when off.
   */
  offTrackColor?: ResponsiveValue<IColors | (string & {})>;
  /**
   * The thumb color of the Switch when on.
   */
  onThumbColor?: ResponsiveValue<IColors | (string & {})>;
  /**
   * The thumb color of the Switch when off.
   */
  offThumbColor?: ResponsiveValue<IColors | (string & {})>;
  /**
   * Color scheme to be used for the Switch
   */
  colorScheme?: ColorSchemeType;
  /**
   * Props when Switch is hovered. Accepts all the Switch props.
   */
  _hover?: Omit<Partial<ISwitchProps>, '_hover'>;
}

export type ISwitchProps = InterfaceSwitchProps & CustomProps<'Switch'>;