Describes the props for CrossBusyIndicator

export
interface

  IBusyIndicatorProps

### Hierarchy

- IBusyIndicatorProps

## Index

### Properties

- cancelText
- cancelTextStyle
- innerViewStyle
- isBusy
- isCancelButtonVisible
- message
- messageStyle
- modalStyle
- onCancel
- spinnerProps
- testID
- type

## Properties

### Optional cancelText

cancelText: string | undefined

- Defined in components/modals/CrossBusyIndicator.tsx:65

Text for cancel button. Default is "Cancel"

### Optional cancelTextStyle

cancelTextStyle: StyleProp<TextStyle> | undefined

- Defined in components/modals/CrossBusyIndicator.tsx:69

Optional custom style for the cancelText

### Optional innerViewStyle

innerViewStyle: StyleProp<ViewStyle> | undefined

- Defined in components/modals/CrossBusyIndicator.tsx:77

Optional custom style for the inner view, contained in the modal

### isBusy

isBusy: boolean

- Defined in components/modals/CrossBusyIndicator.tsx:32

Determines if the indicator is visible

type

  {boolean}

memberof

  IBusyIndicatorProps

### isCancelButtonVisible

isCancelButtonVisible: boolean

- Defined in components/modals/CrossBusyIndicator.tsx:57

Determines if the modal is cancellable. Otherwise visibility is controlled by isBusy

### Optional message

message: string | undefined

- Defined in components/modals/CrossBusyIndicator.tsx:39

Optional message to show while busy. Defaults to empty string.

type

  {string}

memberof

  IBusyIndicatorProps

### Optional messageStyle

messageStyle: StyleProp<TextStyle> | undefined

- Defined in components/modals/CrossBusyIndicator.tsx:81

Optional custom style for the message

### Optional modalStyle

modalStyle: StyleProp<ViewStyle> | undefined

- Defined in components/modals/CrossBusyIndicator.tsx:73

Optional custom style for the modal view

### Optional onCancel

onCancel: undefined | function

- Defined in components/modals/CrossBusyIndicator.tsx:61

Optional callback for user cancel event.

### Optional spinnerProps

spinnerProps: ICrossSpinnerProps | undefined

- Defined in components/modals/CrossBusyIndicator.tsx:87

Optional properties to configure the spinner

See ICrossSpinnerProps

### Optional testID

testID: string | undefined

- Defined in components/modals/CrossBusyIndicator.tsx:53

Optional test id to assign this component. Default is "1"

type

  {string}

memberof

  IBusyIndicatorProps

### Optional type

type: CrossSpinnerType | undefined

- Defined in components/modals/CrossBusyIndicator.tsx:46

Type of spinner to use

type

  {CrossSpinnerType}

memberof

  IBusyIndicatorProps