Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IOnboardingPage

Interface to define the properties of a page

interface

IOnboardingPage

Hierarchy

  • IOnboardingPage

Index

Properties

Optional Component

Component: TypeComponent

A React Component or Element to show the page

type

{TypeComponent}

Optional backgroundColor

backgroundColor: undefined | string

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

type

{string}

default

white

Optional backgroundImage

backgroundImage: TypeImageSource

A background image for the page

type

{TypeImageSource}

Optional containerStyle

containerStyle: TypeStyle

Set a custom style to the container of the page

type

{TypeStyle}

Optional header

header: TypeComponent

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

type

{TypeComponent}

Optional headerStyle

headerStyle: TypeStyle

Apply a custom style to the header

type

{TypeStyle}

Optional image

image: TypeComponent | IImageProps

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

type

{TypeComponent}

Optional imageStyle

imageStyle: TypeStyle

Apply a custom style to the image

type

{TypeStyle}

Optional subtitle

subtitle: undefined | string

A string OR a React-Native component

type

{string}

Optional subtitleStyle

subtitleStyle: TypeStyle

Modify styles of a specific page's subtitle

type

{TypeStyle}

Optional title

title: undefined | string

A string OR a React-Native component

type

{string}

Optional titleStyle

titleStyle: TypeStyle

Modify styles of a specific page's title

type

{TypeStyle}

Generated using TypeDoc