@ticmakers-react-native/onboarding/docs/md/interfaces/_onboarding_index_d_.ionboardingstate.md

TIC Makers - React Native Onboarding

[@ticmakers-react-native/onboarding](../README.md) > ["Onboarding/index.d"](../modules/_onboarding_index_d_.md) > [IOnboardingState](../interfaces/_onboarding_index_d_.ionboardingstate.md)

# Interface: IOnboardingState

Interface to define the state of the Onboarding component

*__interface__*: IOnboardingState

## Hierarchy

**IOnboardingState**

## Index

### Properties

* [backgroundColorAnim](_onboarding_index_d_.ionboardingstate.md#backgroundcoloranim)
* [currentPage](_onboarding_index_d_.ionboardingstate.md#currentpage)
* [height](_onboarding_index_d_.ionboardingstate.md#height)
* [previousPage](_onboarding_index_d_.ionboardingstate.md#previouspage)
* [width](_onboarding_index_d_.ionboardingstate.md#width)

---

## Properties

<a id="backgroundcoloranim"></a>

###  backgroundColorAnim

**● backgroundColorAnim**: *`Value` \| `ValueXY`*

*Defined in Onboarding/index.d.ts:451*

A React-Animated value to define background animation

*__type__*: {(Animated.Value \| Animated.ValueXY)}

___
<a id="currentpage"></a>

###  currentPage

**● currentPage**: *`number`*

*Defined in Onboarding/index.d.ts:458*

A number to define what is the current page

*__type__*: {number}

*__default__*: 0

___
<a id="height"></a>

###  height

**● height**: *`number`*

*Defined in Onboarding/index.d.ts:464*

Define a custom height to the pages

*__type__*: {number}

___
<a id="previouspage"></a>

###  previousPage

**● previousPage**: *`number`*

*Defined in Onboarding/index.d.ts:470*

A number to define what is the previous page

*__type__*: {number}

___
<a id="width"></a>

###  width

**● width**: *`number`*

*Defined in Onboarding/index.d.ts:476*

Define a custom width to the pages

*__type__*: {number}

___