summaryrefslogtreecommitdiff
path: root/app/components/switch/switch.props.ts
blob: 8235457018c293f601dbba06294514da03e7e5ca (about) (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
import { StyleProp, ViewStyle } from "react-native"

export interface SwitchProps {
  /**
   * On or off.
   */
  value?: boolean
  /**
   * Fires when the on/off switch triggers.
   *
   * @param newValue The new value we're switching to.
   */
  onToggle?: (newValue: boolean) => void

  /**
   * A style override to apply to the container.  Useful for margins and paddings.
   */
  style?: StyleProp<ViewStyle>

  /**
   * Additional track styling when on.
   */
  trackOnStyle?: StyleProp<ViewStyle>

  /**
   * Additional track styling when off.
   */
  trackOffStyle?: StyleProp<ViewStyle>

  /**
   * Additional thumb styling when on.
   */
  thumbOnStyle?: StyleProp<ViewStyle>

  /**
   * Additional thumb styling when off.
   */
  thumbOffStyle?: StyleProp<ViewStyle>
}