@ticmakers-react-native/onboarding
Version:
TIC Makers - React Native Onboarding
1,006 lines • 81.3 kB
HTML
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>IOnboardingProps | @ticmakers-react-native/onboarding</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">@ticmakers-react-native/onboarding</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-only-exported" />
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../globals.html">Globals</a>
</li>
<li>
<a href="../modules/_onboarding_index_d_.html">"Onboarding/index.d"</a>
</li>
<li>
<a href="_onboarding_index_d_.ionboardingprops.html">IOnboardingProps</a>
</li>
</ul>
<h1>Interface IOnboardingProps</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Interface to define the props of the Onboarding component</p>
</div>
<dl class="tsd-comment-tags">
<dt>interface</dt>
<dd><p>IOnboardingProps</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">IOnboardingProps</span>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_onboarding_index_d_.ionboardingprops.html#donecomponent" class="tsd-kind-icon">Done<wbr>Component</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_onboarding_index_d_.ionboardingprops.html#dotcomponent" class="tsd-kind-icon">Dot<wbr>Component</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_onboarding_index_d_.ionboardingprops.html#nextcomponent" class="tsd-kind-icon">Next<wbr>Component</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_onboarding_index_d_.ionboardingprops.html#prevcomponent" class="tsd-kind-icon">Prev<wbr>Component</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_onboarding_index_d_.ionboardingprops.html#skipcomponent" class="tsd-kind-icon">Skip<wbr>Component</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_onboarding_index_d_.ionboardingprops.html#allowfontscalingbuttons" class="tsd-kind-icon">allow<wbr>Font<wbr>Scaling<wbr>Buttons</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_onboarding_index_d_.ionboardingprops.html#allowfontscalingtext" class="tsd-kind-icon">allow<wbr>Font<wbr>Scaling<wbr>Text</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_onboarding_index_d_.ionboardingprops.html#backgroundcoloranim" class="tsd-kind-icon">background<wbr>Color<wbr>Anim</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_onboarding_index_d_.ionboardingprops.html#bottombarheight" class="tsd-kind-icon">bottom<wbr>Bar<wbr>Height</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_onboarding_index_d_.ionboardingprops.html#bottombarhighlight" class="tsd-kind-icon">bottom<wbr>Bar<wbr>Highlight</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_onboarding_index_d_.ionboardingprops.html#bottombarstyle" class="tsd-kind-icon">bottom<wbr>Bar<wbr>Style</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_onboarding_index_d_.ionboardingprops.html#containerstyle" class="tsd-kind-icon">container<wbr>Style</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_onboarding_index_d_.ionboardingprops.html#controlstatusbar" class="tsd-kind-icon">control<wbr>Status<wbr>Bar</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_onboarding_index_d_.ionboardingprops.html#currentpage" class="tsd-kind-icon">current<wbr>Page</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_onboarding_index_d_.ionboardingprops.html#defaultpages" class="tsd-kind-icon">default<wbr>Pages</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_onboarding_index_d_.ionboardingprops.html#donelabel" class="tsd-kind-icon">done<wbr>Label</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_onboarding_index_d_.ionboardingprops.html#doneposition" class="tsd-kind-icon">done<wbr>Position</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_onboarding_index_d_.ionboardingprops.html#donestyle" class="tsd-kind-icon">done<wbr>Style</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_onboarding_index_d_.ionboardingprops.html#dotcolorselected" class="tsd-kind-icon">dot<wbr>Color<wbr>Selected</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_onboarding_index_d_.ionboardingprops.html#dotselectedstyle" class="tsd-kind-icon">dot<wbr>Selected<wbr>Style</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_onboarding_index_d_.ionboardingprops.html#dotscolor" class="tsd-kind-icon">dots<wbr>Color</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_onboarding_index_d_.ionboardingprops.html#dotsposition" class="tsd-kind-icon">dots<wbr>Position</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_onboarding_index_d_.ionboardingprops.html#dotssize" class="tsd-kind-icon">dots<wbr>Size</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_onboarding_index_d_.ionboardingprops.html#dotsstyle" class="tsd-kind-icon">dots<wbr>Style</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_onboarding_index_d_.ionboardingprops.html#flatlistprops" class="tsd-kind-icon">flatlist<wbr>Props</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_onboarding_index_d_.ionboardingprops.html#headercontainerstyle" class="tsd-kind-icon">header<wbr>Container<wbr>Style</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_onboarding_index_d_.ionboardingprops.html#height" class="tsd-kind-icon">height</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_onboarding_index_d_.ionboardingprops.html#hidedone" class="tsd-kind-icon">hide<wbr>Done</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_onboarding_index_d_.ionboardingprops.html#hidedots" class="tsd-kind-icon">hide<wbr>Dots</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_onboarding_index_d_.ionboardingprops.html#hidenext" class="tsd-kind-icon">hide<wbr>Next</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_onboarding_index_d_.ionboardingprops.html#hideskip" class="tsd-kind-icon">hide<wbr>Skip</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_onboarding_index_d_.ionboardingprops.html#imagecontainerstyle" class="tsd-kind-icon">image<wbr>Container<wbr>Style</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_onboarding_index_d_.ionboardingprops.html#nextlabel" class="tsd-kind-icon">next<wbr>Label</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_onboarding_index_d_.ionboardingprops.html#nextposition" class="tsd-kind-icon">next<wbr>Position</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_onboarding_index_d_.ionboardingprops.html#nextstyle" class="tsd-kind-icon">next<wbr>Style</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_onboarding_index_d_.ionboardingprops.html#onchangepage" class="tsd-kind-icon">on<wbr>Change<wbr>Page</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_onboarding_index_d_.ionboardingprops.html#ondone" class="tsd-kind-icon">on<wbr>Done</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_onboarding_index_d_.ionboardingprops.html#onskip" class="tsd-kind-icon">on<wbr>Skip</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_onboarding_index_d_.ionboardingprops.html#pages" class="tsd-kind-icon">pages</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_onboarding_index_d_.ionboardingprops.html#paginationprops" class="tsd-kind-icon">pagination<wbr>Props</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_onboarding_index_d_.ionboardingprops.html#prevlabel" class="tsd-kind-icon">prev<wbr>Label</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_onboarding_index_d_.ionboardingprops.html#prevposition" class="tsd-kind-icon">prev<wbr>Position</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_onboarding_index_d_.ionboardingprops.html#prevstyle" class="tsd-kind-icon">prev<wbr>Style</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_onboarding_index_d_.ionboardingprops.html#previouspage" class="tsd-kind-icon">previous<wbr>Page</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_onboarding_index_d_.ionboardingprops.html#skiplabel" class="tsd-kind-icon">skip<wbr>Label</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_onboarding_index_d_.ionboardingprops.html#skipposition" class="tsd-kind-icon">skip<wbr>Position</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_onboarding_index_d_.ionboardingprops.html#skipstyle" class="tsd-kind-icon">skip<wbr>Style</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_onboarding_index_d_.ionboardingprops.html#skiptopage" class="tsd-kind-icon">skip<wbr>ToPage</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_onboarding_index_d_.ionboardingprops.html#statusbarstyle" class="tsd-kind-icon">status<wbr>Bar<wbr>Style</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_onboarding_index_d_.ionboardingprops.html#subtitlestyle" class="tsd-kind-icon">subtitle<wbr>Style</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_onboarding_index_d_.ionboardingprops.html#titlestyle" class="tsd-kind-icon">title<wbr>Style</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_onboarding_index_d_.ionboardingprops.html#transitionanimationduration" class="tsd-kind-icon">transition<wbr>Animation<wbr>Duration</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_onboarding_index_d_.ionboardingprops.html#useprevious" class="tsd-kind-icon">use<wbr>Previous</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_onboarding_index_d_.ionboardingprops.html#width" class="tsd-kind-icon">width</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="donecomponent" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Done<wbr>Component</h3>
<div class="tsd-signature tsd-kind-icon">Done<wbr>Component<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">TypeComponent</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in Onboarding/index.d.ts:101</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>A React-Native component to replace the done button</p>
</div>
<dl class="tsd-comment-tags">
<dt>type</dt>
<dd><p>{TypeComponent}</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="dotcomponent" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Dot<wbr>Component</h3>
<div class="tsd-signature tsd-kind-icon">Dot<wbr>Component<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">TypeComponent</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in Onboarding/index.d.ts:107</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>A React-Native component to replace the pagination dot</p>
</div>
<dl class="tsd-comment-tags">
<dt>type</dt>
<dd><p>{TypeComponent}</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="nextcomponent" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Next<wbr>Component</h3>
<div class="tsd-signature tsd-kind-icon">Next<wbr>Component<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">TypeComponent</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in Onboarding/index.d.ts:113</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>A React-Native component to replace the next button</p>
</div>
<dl class="tsd-comment-tags">
<dt>type</dt>
<dd><p>{TypeComponent}</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="prevcomponent" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Prev<wbr>Component</h3>
<div class="tsd-signature tsd-kind-icon">Prev<wbr>Component<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">TypeComponent</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in Onboarding/index.d.ts:119</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>A React-Native component to replace the previous button</p>
</div>
<dl class="tsd-comment-tags">
<dt>type</dt>
<dd><p>{TypeComponent}</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="skipcomponent" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Skip<wbr>Component</h3>
<div class="tsd-signature tsd-kind-icon">Skip<wbr>Component<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">TypeComponent</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in Onboarding/index.d.ts:125</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>A React-Native component to replace the skip button</p>
</div>
<dl class="tsd-comment-tags">
<dt>type</dt>
<dd><p>{TypeComponent}</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="allowfontscalingbuttons" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> allow<wbr>Font<wbr>Scaling<wbr>Buttons</h3>
<div class="tsd-signature tsd-kind-icon">allow<wbr>Font<wbr>Scaling<wbr>Buttons<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in Onboarding/index.d.ts:132</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Font scaling can cause troubles with high-resolution screens. You may want to disable it</p>
</div>
<dl class="tsd-comment-tags">
<dt>type</dt>
<dd><p>{boolean}</p>
</dd>
<dt>default</dt>
<dd><p>true</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="allowfontscalingtext" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> allow<wbr>Font<wbr>Scaling<wbr>Text</h3>
<div class="tsd-signature tsd-kind-icon">allow<wbr>Font<wbr>Scaling<wbr>Text<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in Onboarding/index.d.ts:139</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Font scaling can cause troubles with high-resolution screens. You may want to disable it</p>
</div>
<dl class="tsd-comment-tags">
<dt>type</dt>
<dd><p>{boolean}</p>
</dd>
<dt>default</dt>
<dd><p>true</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="backgroundcoloranim" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> background<wbr>Color<wbr>Anim</h3>
<div class="tsd-signature tsd-kind-icon">background<wbr>Color<wbr>Anim<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Value</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ValueXY</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in Onboarding/index.d.ts:145</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>A React-Animated value to define background animation</p>
</div>
<dl class="tsd-comment-tags">
<dt>type</dt>
<dd><p>{(Animated.Value | Animated.ValueXY)}</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="bottombarheight" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> bottom<wbr>Bar<wbr>Height</h3>
<div class="tsd-signature tsd-kind-icon">bottom<wbr>Bar<wbr>Height<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in Onboarding/index.d.ts:152</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>A number for the height of the bottom bar</p>
</div>
<dl class="tsd-comment-tags">
<dt>type</dt>
<dd><p>{number}</p>
</dd>
<dt>default</dt>
<dd><p>60</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="bottombarhighlight" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> bottom<wbr>Bar<wbr>Highlight</h3>
<div class="tsd-signature tsd-kind-icon">bottom<wbr>Bar<wbr>Highlight<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in Onboarding/index.d.ts:159</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>A bool flag indicating whether the bottom bar should be highlighted</p>
</div>
<dl class="tsd-comment-tags">
<dt>type</dt>
<dd><p>{boolean}</p>
</dd>
<dt>default</dt>
<dd><p>true</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="bottombarstyle" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> bottom<wbr>Bar<wbr>Style</h3>
<div class="tsd-signature tsd-kind-icon">bottom<wbr>Bar<wbr>Style<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">TypeStyle</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in Onboarding/index.d.ts:165</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Set a custom style to the bottom bar (pagination style)</p>
</div>
<dl class="tsd-comment-tags">
<dt>type</dt>
<dd><p>{TypeStyle}</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="containerstyle" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> container<wbr>Style</h3>
<div class="tsd-signature tsd-kind-icon">container<wbr>Style<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">object</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in Onboarding/index.d.ts:171</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Override the default container styles</p>
</div>
<dl class="tsd-comment-tags">
<dt>type</dt>
<dd><p>{object}</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="controlstatusbar" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> control<wbr>Status<wbr>Bar</h3>
<div class="tsd-signature tsd-kind-icon">control<wbr>Status<wbr>Bar<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in Onboarding/index.d.ts:178</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>A bool flag indicating whether the status bar should change with the background color</p>
</div>
<dl class="tsd-comment-tags">
<dt>type</dt>
<dd><p>{boolean}</p>
</dd>
<dt>default</dt>
<dd><p>true</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="currentpage" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> current<wbr>Page</h3>
<div class="tsd-signature tsd-kind-icon">current<wbr>Page<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in Onboarding/index.d.ts:185</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>A number to define what is the current page</p>
</div>
<dl class="tsd-comment-tags">
<dt>type</dt>
<dd><p>{number}</p>
</dd>
<dt>default</dt>
<dd><p>0</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="defaultpages" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> default<wbr>Pages</h3>
<div class="tsd-signature tsd-kind-icon">default<wbr>Pages<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in Onboarding/index.d.ts:192</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Use 3 pages by default</p>
</div>
<dl class="tsd-comment-tags">
<dt>type</dt>
<dd><p>{boolean}</p>
</dd>
<dt>default</dt>
<dd><p>false</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="donelabel" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> done<wbr>Label</h3>
<div class="tsd-signature tsd-kind-icon">done<wbr>Label<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in Onboarding/index.d.ts:198</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Define a text to show in done button</p>
</div>
<dl class="tsd-comment-tags">
<dt>type</dt>
<dd><p>{string}</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="doneposition" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> done<wbr>Position</h3>
<div class="tsd-signature tsd-kind-icon">done<wbr>Position<span class="tsd-signature-symbol">:</span> <a href="../modules/_pagination_index_d_.html#typepaginationposition" class="tsd-signature-type">TypePaginationPosition</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in Onboarding/index.d.ts:205</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Define the position where the done button will be displayed</p>
</div>
<dl class="tsd-comment-tags">
<dt>type</dt>
<dd><p>{TypePaginationPosition}</p>
</dd>
<dt>default</dt>
<dd><p>right</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="donestyle" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> done<wbr>Style</h3>
<div class="tsd-signature tsd-kind-icon">done<wbr>Style<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">TypeStyle</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in Onboarding/index.d.ts:211</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Apply a custom style to the done button</p>
</div>
<dl class="tsd-comment-tags">
<dt>type</dt>
<dd><p>{TypeStyle}</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="dotcolorselected" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> dot<wbr>Color<wbr>Selected</h3>
<div class="tsd-signature tsd-kind-icon">dot<wbr>Color<wbr>Selected<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in Onboarding/index.d.ts:217</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Apply a custom color to the pagination Dot selected</p>
</div>
<dl class="tsd-comment-tags">
<dt>type</dt>
<dd><p>{string}</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="dotselectedstyle" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> dot<wbr>Selected<wbr>Style</h3>
<div class="tsd-signature tsd-kind-icon">dot<wbr>Selected<wbr>Style<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">TypeStyle</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in Onboarding/index.d.ts:223</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Apply a custom style to the pagination Dot selected</p>
</div>
<dl class="tsd-comment-tags">
<dt>type</dt>
<dd><p>{TypeStyle}</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="dotscolor" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> dots<wbr>Color</h3>
<div class="tsd-signature tsd-kind-icon">dots<wbr>Color<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in Onboarding/index.d.ts:229</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Apply a custom color to all pagination Dot</p>
</div>
<dl class="tsd-comment-tags">
<dt>type</dt>
<dd><p>{string}</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="dotsposition" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> dots<wbr>Position</h3>
<div class="tsd-signature tsd-kind-icon">dots<wbr>Position<span class="tsd-signature-symbol">:</span> <a href="../modules/_pagination_index_d_.html#typepaginationposition" class="tsd-signature-type">TypePaginationPosition</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in Onboarding/index.d.ts:236</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Define the position where the pagination dots will be displayed</p>
</div>
<dl class="tsd-comment-tags">
<dt>type</dt>
<dd><p>{TypePaginationPosition}</p>
</dd>
<dt>default</dt>
<dd><p>center</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="dotssize" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> dots<wbr>Size</h3>
<div class="tsd-signature tsd-kind-icon">dots<wbr>Size<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in Onboarding/index.d.ts:242</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Apply a size to the pagination dots</p>
</div>
<dl class="tsd-comment-tags">
<dt>type</dt>
<dd><p>{number}</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="dotsstyle" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> dots<wbr>Style</h3>
<div class="tsd-signature tsd-kind-icon">dots<wbr>Style<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">TypeStyle</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in Onboarding/index.d.ts:248</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Apply a custom style to the pagination dots</p>
</div>
<dl class="tsd-comment-tags">
<dt>type</dt>
<dd><p>{TypeStyle}</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="flatlistprops" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> flatlist<wbr>Props</h3>
<div class="tsd-signature tsd-kind-icon">flatlist<wbr>Props<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">object</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in Onboarding/index.d.ts:254</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Additional props for the <FlatList> which holds all the pages</p>
</div>
<dl class="tsd-comment-tags">
<dt>type</dt>
<dd><p>{object}</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="headercontainerstyle" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> header<wbr>Container<wbr>Style</h3>
<div class="tsd-signature tsd-kind-icon">header<wbr>Container<wbr>Style<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">TypeStyle</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in Onboarding/index.d.ts:260</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Apply a custom style to the header container</p>
</div>
<dl class="tsd-comment-tags">
<dt>type</dt>
<dd><p>{TypeStyle}</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="height" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> height</h3>
<div class="tsd-signature tsd-kind-icon">height<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in Onboarding/index.d.ts:266</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Define a custom height to the pages</p>
</div>
<dl class="tsd-comment-tags">
<dt>type</dt>
<dd><p>{number}</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="hidedone" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> hide<wbr>Done</h3>
<div class="tsd-signature tsd-kind-icon">hide<wbr>Done<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in Onboarding/index.d.ts:273</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Set true for hide the done button</p>
</div>
<dl class="tsd-comment-tags">
<dt>type</dt>
<dd><p>{boolean}</p>
</dd>
<dt>default</dt>
<dd><p>false</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="hidedots" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> hide<wbr>Dots</h3>
<div class="tsd-signature tsd-kind-icon">hide<wbr>Dots<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in Onboarding/index.d.ts:280</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Set true for hide the pagination dots</p>
</div>
<dl class="tsd-comment-tags">
<dt>type</dt>
<dd><p>{boolean}</p>
</dd>
<dt>default</dt>
<dd><p>false</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="hidenext" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> hide<wbr>Next</h3>
<div class="tsd-signature tsd-kind-icon">hide<wbr>Next<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in Onboarding/index.d.ts:287</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Set true to hide the next button</p>
</div>
<dl class="tsd-comment-tags">
<dt>type</dt>
<dd><p>{boolean}</p>
</dd>
<dt>default</dt>
<dd><p>false</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="hideskip" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> hide<wbr>Skip</h3>
<div class="tsd-signature tsd-kind-icon">hide<wbr>Skip<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in Onboarding/index.d.ts:294</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Set true to hide the skip button</p>
</div>
<dl class="tsd-comment-tags">
<dt>type</dt>
<dd><p>{boolean}</p>
</dd>
<dt>default</dt>
<dd><p>false</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="imagecontainerstyle" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> image<wbr>Container<wbr>Style</h3>
<div class="tsd-signature tsd-kind-icon">image<wbr>Container<wbr>Style<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">object</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in Onboarding/index.d.ts:300</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Override the default image container styles</p>
</div>
<dl class="tsd-comment-tags">
<dt>type</dt>
<dd><p>{object}</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="nextlabel" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> next<wbr>Label</h3>
<div class="tsd-signature tsd-kind-icon">next<wbr>Label<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in Onboarding/index.d.ts:307</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>A text to show in the next button</p>
</div>
<dl class="tsd-comment-tags">
<dt>type</dt>
<dd><p>{string}</p>
</dd>
<dt>default</dt>
<dd><p>Next</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="nextposition" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> next<wbr>Position</h3>
<div class="tsd-signature tsd-kind-icon">next<wbr>Position<span class="tsd-signature-symbol">:</span> <a href="../modules/_pagination_index_d_.html#typepaginationposition" class="tsd-signature-type">TypePaginationPosition</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in Onboarding/index.d.ts:314</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Define the position where the next button will be displayed</p>
</div>
<dl class="tsd-comment-tags">
<dt>type</dt>
<dd><p>{TypePaginationPosition}</p>
</dd>
<dt>default</dt>
<dd><p>right</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="nextstyle" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> next<wbr>Style</h3>
<div class="tsd-signature tsd-kind-icon">next<wbr>Style<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">TypeStyle</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in Onboarding/index.d.ts:320</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Apply a custom style to the next button</p>
</div>
<dl class="tsd-comment-tags">
<dt>type</dt>
<dd><p>{TypeStyle}</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="onchangepage" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> on<wbr>Change<wbr>Page</h3>
<div class="tsd-signature tsd-kind-icon">on<wbr>Change<wbr>Page<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">function</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in Onboarding/index.d.ts:326</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>A function that receives the page index as a parameter on page change</p>
</div>
<dl class="tsd-comment-tags">
<dt>type</dt>
<dd><p>{Function}</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="ondone" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> on<wbr>Done</h3>
<div class="tsd-signature tsd-kind-icon">on<wbr>Done<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">function</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in Onboarding/index.d.ts:332</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>A callback that is fired after the Onboarding is completed</p>
</div>
<dl class="tsd-comment-tags">
<dt>type</dt>
<dd><p>{Function}</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="onskip" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> on<wbr>Skip</h3>
<div class="tsd-signature tsd-kind-icon">on<wbr>Skip<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">function</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in Onboarding/index.d.ts:338</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>A callback that is fired if the Onboarding is skipped</p>
</div>
<dl class="tsd-comment-tags">
<dt>type</dt>
<dd><p>{Function}</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="pages" class="tsd-anchor"></a>
<h3>pages</h3>
<div class="tsd-signature tsd-kind-icon">pages<span class="tsd-signature-symbol">:</span> <a href="_onboarding_index_d_.ionboardingpage.html" class="tsd-signature-type">IOnboardingPage</a><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in Onboarding/index.d.ts:344</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>A array of pages to show in the component</p>
</div>
<dl class="tsd-comment-tags">
<dt>type</dt>
<dd><p>{IOnboardingPage[]}</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="paginationprops" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> pagination<wbr>Props</h3>
<div class="tsd-signature tsd-kind-icon">pagination<wbr>Props<span class="tsd-signature-symbol">:</span> <a href="_pagination_index_d_.ipaginationprops.html" class="tsd-signature-type">IPaginationProps</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in Onboarding/index.d.ts:350</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Define additional props for the pagination</p>
</div>
<dl class="tsd-comment-tags">
<dt>type</dt>
<dd><p>{IPaginationProps}</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="prevlabel" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> prev<wbr>Label</h3>
<div class="tsd-signature tsd-kind-icon">prev<wbr>Label<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="ts