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

TIC Makers - React Native Onboarding

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

# Interface: IOnboardingPage

Interface to define the properties of a page

*__interface__*: IOnboardingPage

## Hierarchy

**IOnboardingPage**

## Index

### Properties

* [Component](_onboarding_index_d_.ionboardingpage.md#component)
* [backgroundColor](_onboarding_index_d_.ionboardingpage.md#backgroundcolor)
* [backgroundImage](_onboarding_index_d_.ionboardingpage.md#backgroundimage)
* [containerStyle](_onboarding_index_d_.ionboardingpage.md#containerstyle)
* [header](_onboarding_index_d_.ionboardingpage.md#header)
* [headerStyle](_onboarding_index_d_.ionboardingpage.md#headerstyle)
* [image](_onboarding_index_d_.ionboardingpage.md#image)
* [imageStyle](_onboarding_index_d_.ionboardingpage.md#imagestyle)
* [subtitle](_onboarding_index_d_.ionboardingpage.md#subtitle)
* [subtitleStyle](_onboarding_index_d_.ionboardingpage.md#subtitlestyle)
* [title](_onboarding_index_d_.ionboardingpage.md#title)
* [titleStyle](_onboarding_index_d_.ionboardingpage.md#titlestyle)

---

## Properties

<a id="component"></a>

### `<Optional>` Component

**● Component**: *`TypeComponent`*

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

A React Component or Element to show the page

*__type__*: {TypeComponent}

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

### `<Optional>` backgroundColor

**● backgroundColor**: *`undefined` \| `string`*

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

A background color. The color of the font and dots adapts to the background color

*__type__*: {string}

*__default__*: white

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

### `<Optional>` backgroundImage

**● backgroundImage**: *`TypeImageSource`*

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

A background image for the page

*__type__*: {TypeImageSource}

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

### `<Optional>` containerStyle

**● containerStyle**: *`TypeStyle`*

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

Set a custom style to the container of the page

*__type__*: {TypeStyle}

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

### `<Optional>` header

**● header**: *`TypeComponent`*

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

A React-Native component to display at the header of the page

*__type__*: {TypeComponent}

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

### `<Optional>` headerStyle

**● headerStyle**: *`TypeStyle`*

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

Apply a custom style to the header

*__type__*: {TypeStyle}

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

### `<Optional>` image

**● image**: *`TypeComponent` \| `IImageProps`*

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

A React-Native component to display at the top of the page

*__type__*: {TypeComponent}

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

### `<Optional>` imageStyle

**● imageStyle**: *`TypeStyle`*

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

Apply a custom style to the image

*__type__*: {TypeStyle}

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

### `<Optional>` subtitle

**● subtitle**: *`undefined` \| `string`*

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

A string OR a React-Native component

*__type__*: {string}

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

### `<Optional>` subtitleStyle

**● subtitleStyle**: *`TypeStyle`*

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

Modify styles of a specific page's subtitle

*__type__*: {TypeStyle}

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

### `<Optional>` title

**● title**: *`undefined` \| `string`*

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

A string OR a React-Native component

*__type__*: {string}

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

### `<Optional>` titleStyle

**● titleStyle**: *`TypeStyle`*

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

Modify styles of a specific page's title

*__type__*: {TypeStyle}

___