@fruits-chain/react-native-xiaoshu
Version:
React Native UI library
57 lines (56 loc) • 1.27 kB
TypeScript
export interface SwitchProps<ActiveValueT = any, InactiveValueT = any> {
/**
* 开关选中状态
* @default false
*/
value?: ActiveValueT | InactiveValueT;
/**
* 默认值
*/
defaultValue?: ActiveValueT | InactiveValueT;
/**
* 是否为加载状态
* @default false
*/
loading?: boolean;
/**
* 是否为禁用状态
* @default false
*/
disabled?: boolean;
/**
* 开关尺寸
*/
size?: number;
/**
* 打开时的背景色
*/
activeColor?: string;
/**
* 关闭时的背景色
*/
inactiveColor?: string;
/**
* 打开时对应的值
* @default true
*/
activeValue?: ActiveValueT;
/**
* 关闭时对应的值
* @default false
*/
inactiveValue?: InactiveValueT;
/**
* 点击时触发
*/
onPress?: Function;
/**
* 开关状态切换时触发
*/
onChange?: (v: ActiveValueT | InactiveValueT) => void;
/**
* 切换状态前,返回 false 可阻止关闭,支持返回 Promise
* @param v 切换后的值
*/
beforeChange?: (v: ActiveValueT | InactiveValueT) => ActiveValueT | InactiveValueT | Promise<ActiveValueT | InactiveValueT>;
}