UNPKG

@ticmakers-react-native/onboarding

Version:

TIC Makers - React Native Onboarding

828 lines 62.1 kB
<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>DoneButton | @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/_pagination_index_d_.html">&quot;Pagination/index.d&quot;</a> </li> <li> <a href="_pagination_index_d_.donebutton.html">DoneButton</a> </li> </ul> <h1>Class DoneButton&lt;SS&gt;</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>Class to define the component DoneButton used in Onboarding</p> </div> <dl class="tsd-comment-tags"> <dt>class</dt> <dd><p>DoneButton</p> </dd> <dt>extends</dt> <dd><p>{Button}</p> </dd> </dl> </div> </section> <section class="tsd-panel tsd-type-parameters"> <h3>Type parameters</h3> <ul class="tsd-type-parameters"> <li> <h4>SS</h4> </li> </ul> </section> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <span class="tsd-signature-type">Button</span> <ul class="tsd-hierarchy"> <li> <span class="target">DoneButton</span> </li> </ul> </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 tsd-is-not-exported"> <h3>Properties</h3> <ul class="tsd-index-list"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-not-exported"><a href="_pagination_index_d_.donebutton.html#fadeanimation" class="tsd-kind-icon">fade<wbr>Animation</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-not-exported"><a href="_pagination_index_d_.donebutton.html#fadeduration" class="tsd-kind-icon">fade<wbr>Duration</a></li> </ul> </section> <section class="tsd-index-section tsd-is-not-exported"> <h3>Methods</h3> <ul class="tsd-index-list"> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-not-exported"><a href="_pagination_index_d_.donebutton.html#buttoncomponent" class="tsd-kind-icon">Button<wbr>Component</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported"><a href="_pagination_index_d_.donebutton.html#buttoncontent" class="tsd-kind-icon">Button<wbr>Content</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported"><a href="_pagination_index_d_.donebutton.html#iconleft" class="tsd-kind-icon">Icon<wbr>Left</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported"><a href="_pagination_index_d_.donebutton.html#iconright" class="tsd-kind-icon">Icon<wbr>Right</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported"><a href="_pagination_index_d_.donebutton.html#title" class="tsd-kind-icon">Title</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported"><a href="_pagination_index_d_.donebutton.html#unsafe_componentwillmount" class="tsd-kind-icon">UNSAFE_<wbr>component<wbr>Will<wbr>Mount</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported"><a href="_pagination_index_d_.donebutton.html#unsafe_componentwillreceiveprops" class="tsd-kind-icon">UNSAFE_<wbr>component<wbr>Will<wbr>Receive<wbr>Props</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported"><a href="_pagination_index_d_.donebutton.html#unsafe_componentwillupdate" class="tsd-kind-icon">UNSAFE_<wbr>component<wbr>Will<wbr>Update</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported"><a href="_pagination_index_d_.donebutton.html#componentdidcatch" class="tsd-kind-icon">component<wbr>Did<wbr>Catch</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-not-exported"><a href="_pagination_index_d_.donebutton.html#componentdidmount" class="tsd-kind-icon">component<wbr>Did<wbr>Mount</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported"><a href="_pagination_index_d_.donebutton.html#componentdidupdate" class="tsd-kind-icon">component<wbr>Did<wbr>Update</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported"><a href="_pagination_index_d_.donebutton.html#componentwillmount" class="tsd-kind-icon">component<wbr>Will<wbr>Mount</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported"><a href="_pagination_index_d_.donebutton.html#componentwillreceiveprops" class="tsd-kind-icon">component<wbr>Will<wbr>Receive<wbr>Props</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported"><a href="_pagination_index_d_.donebutton.html#componentwillunmount" class="tsd-kind-icon">component<wbr>Will<wbr>Unmount</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported"><a href="_pagination_index_d_.donebutton.html#componentwillupdate" class="tsd-kind-icon">component<wbr>Will<wbr>Update</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported"><a href="_pagination_index_d_.donebutton.html#getsnapshotbeforeupdate" class="tsd-kind-icon">get<wbr>Snapshot<wbr>Before<wbr>Update</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-not-exported"><a href="_pagination_index_d_.donebutton.html#render" class="tsd-kind-icon">render</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported"><a href="_pagination_index_d_.donebutton.html#shouldcomponentupdate" class="tsd-kind-icon">should<wbr>Component<wbr>Update</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group tsd-is-not-exported"> <h2>Properties</h2> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-not-exported"> <a name="fadeanimation" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> fade<wbr>Animation</h3> <div class="tsd-signature tsd-kind-icon">fade<wbr>Animation<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Animated.Value</span></div> <aside class="tsd-sources"> <ul> <li>Defined in Pagination/index.d.ts:386</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Initial value to the animation</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-not-exported"> <a name="fadeduration" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> fade<wbr>Duration</h3> <div class="tsd-signature tsd-kind-icon">fade<wbr>Duration<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 Pagination/index.d.ts:391</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Duration of the animation</p> </div> </div> </section> </section> <section class="tsd-panel-group tsd-member-group tsd-is-not-exported"> <h2>Methods</h2> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-not-exported"> <a name="buttoncomponent" class="tsd-anchor"></a> <h3>Button<wbr>Component</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon">Button<wbr>Component<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">TypeComponent</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in Pagination/index.d.ts:409</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Method that renders the button</p> </div> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">TypeComponent</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported"> <a name="buttoncontent" class="tsd-anchor"></a> <h3>Button<wbr>Content</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon">Button<wbr>Content<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">TypeComponent</span><span class="tsd-signature-symbol">[]</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Inherited from Button.ButtonContent</p> <ul> <li>Defined in /home/hackettyam/www/@ticmakers/react-native/OnBoarding/node_modules/@ticmakers-react-native/button/index.d.ts:363</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Method that return a array of components for the button content</p> </div> <dl class="tsd-comment-tags"> <dt>memberof</dt> <dd><p>Button</p> </dd> </dl> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">TypeComponent</span><span class="tsd-signature-symbol">[]</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported"> <a name="iconleft" class="tsd-anchor"></a> <h3>Icon<wbr>Left</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon">Icon<wbr>Left<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">TypeComponent</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Inherited from Button.IconLeft</p> <ul> <li>Defined in /home/hackettyam/www/@ticmakers/react-native/OnBoarding/node_modules/@ticmakers-react-native/button/index.d.ts:377</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Method that return the icon left component</p> </div> <dl class="tsd-comment-tags"> <dt>memberof</dt> <dd><p>Button</p> </dd> </dl> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">TypeComponent</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported"> <a name="iconright" class="tsd-anchor"></a> <h3>Icon<wbr>Right</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon">Icon<wbr>Right<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">TypeComponent</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Inherited from Button.IconRight</p> <ul> <li>Defined in /home/hackettyam/www/@ticmakers/react-native/OnBoarding/node_modules/@ticmakers-react-native/button/index.d.ts:384</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Method that return the icon right component</p> </div> <dl class="tsd-comment-tags"> <dt>memberof</dt> <dd><p>Button</p> </dd> </dl> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">TypeComponent</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported"> <a name="title" class="tsd-anchor"></a> <h3>Title</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon">Title<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">TypeComponent</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Inherited from Button.Title</p> <ul> <li>Defined in /home/hackettyam/www/@ticmakers/react-native/OnBoarding/node_modules/@ticmakers-react-native/button/index.d.ts:370</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Method thar return the title component</p> </div> <dl class="tsd-comment-tags"> <dt>memberof</dt> <dd><p>Button</p> </dd> </dl> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">TypeComponent</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported"> <a name="unsafe_componentwillmount" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> UNSAFE_<wbr>component<wbr>Will<wbr>Mount</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon">UNSAFE_<wbr>component<wbr>Will<wbr>Mount<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Inherited from DeprecatedLifecycle.UNSAFE_componentWillMount</p> <ul> <li>Defined in /home/hackettyam/www/@ticmakers/react-native/OnBoarding/node_modules/@types/react/index.d.ts:638</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Called immediately before mounting occurs, and before <code>Component#render</code>. Avoid introducing any side-effects or subscriptions in this method.</p> </div> <p>This method will not stop working in React 17.</p> <p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.</p> <dl class="tsd-comment-tags"> <dt>deprecated</dt> <dd><p>16.3, use componentDidMount or the constructor instead</p> </dd> <dt>see</dt> <dd><p><a href="https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state">https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state</a></p> </dd> <dt>see</dt> <dd><p><a href="https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path">https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</a></p> </dd> </dl> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported"> <a name="unsafe_componentwillreceiveprops" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> UNSAFE_<wbr>component<wbr>Will<wbr>Receive<wbr>Props</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon">UNSAFE_<wbr>component<wbr>Will<wbr>Receive<wbr>Props<span class="tsd-signature-symbol">(</span>nextProps<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">IButtonProps</span><span class="tsd-signature-symbol">&gt;</span>, nextContext<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Inherited from DeprecatedLifecycle.UNSAFE_componentWillReceiveProps</p> <ul> <li>Defined in /home/hackettyam/www/@ticmakers/react-native/OnBoarding/node_modules/@types/react/index.d.ts:670</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes.</p> </div> <p>Calling <code>Component#setState</code> generally does not trigger this method.</p> <p>This method will not stop working in React 17.</p> <p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.</p> <dl class="tsd-comment-tags"> <dt>deprecated</dt> <dd><p>16.3, use static getDerivedStateFromProps instead</p> </dd> <dt>see</dt> <dd><p><a href="https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props">https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props</a></p> </dd> <dt>see</dt> <dd><p><a href="https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path">https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</a></p> </dd> </dl> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>nextProps: <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">IButtonProps</span><span class="tsd-signature-symbol">&gt;</span></h5> </li> <li> <h5>nextContext: <span class="tsd-signature-type">any</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported"> <a name="unsafe_componentwillupdate" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> UNSAFE_<wbr>component<wbr>Will<wbr>Update</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon">UNSAFE_<wbr>component<wbr>Will<wbr>Update<span class="tsd-signature-symbol">(</span>nextProps<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">IButtonProps</span><span class="tsd-signature-symbol">&gt;</span>, nextState<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">IButtonState</span><span class="tsd-signature-symbol">&gt;</span>, nextContext<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Inherited from DeprecatedLifecycle.UNSAFE_componentWillUpdate</p> <ul> <li>Defined in /home/hackettyam/www/@ticmakers/react-native/OnBoarding/node_modules/@types/react/index.d.ts:698</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Called immediately before rendering when new props or state is received. Not called for the initial render.</p> </div> <p>Note: You cannot call <code>Component#setState</code> here.</p> <p>This method will not stop working in React 17.</p> <p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.</p> <dl class="tsd-comment-tags"> <dt>deprecated</dt> <dd><p>16.3, use getSnapshotBeforeUpdate instead</p> </dd> <dt>see</dt> <dd><p><a href="https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update">https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update</a></p> </dd> <dt>see</dt> <dd><p><a href="https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path">https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</a></p> </dd> </dl> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>nextProps: <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">IButtonProps</span><span class="tsd-signature-symbol">&gt;</span></h5> </li> <li> <h5>nextState: <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">IButtonState</span><span class="tsd-signature-symbol">&gt;</span></h5> </li> <li> <h5>nextContext: <span class="tsd-signature-type">any</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported"> <a name="componentdidcatch" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> component<wbr>Did<wbr>Catch</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon">component<wbr>Did<wbr>Catch<span class="tsd-signature-symbol">(</span>error<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, errorInfo<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ErrorInfo</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Inherited from ComponentLifecycle.componentDidCatch</p> <ul> <li>Defined in /home/hackettyam/www/@ticmakers/react-native/OnBoarding/node_modules/@types/react/index.d.ts:567</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>error: <span class="tsd-signature-type">Error</span></h5> </li> <li> <h5>errorInfo: <span class="tsd-signature-type">ErrorInfo</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-not-exported"> <a name="componentdidmount" class="tsd-anchor"></a> <h3>component<wbr>Did<wbr>Mount</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon">component<wbr>Did<wbr>Mount<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Overrides ComponentLifecycle.componentDidMount</p> <ul> <li>Defined in Pagination/index.d.ts:397</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Method that fire when the component is mounted</p> </div> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported"> <a name="componentdidupdate" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> component<wbr>Did<wbr>Update</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon">component<wbr>Did<wbr>Update<span class="tsd-signature-symbol">(</span>prevProps<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">IButtonProps</span><span class="tsd-signature-symbol">&gt;</span>, prevState<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">IButtonState</span><span class="tsd-signature-symbol">&gt;</span>, snapshot<span class="tsd-signature-symbol">?: </span><a href="" class="tsd-signature-type">SS</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Inherited from NewLifecycle.componentDidUpdate</p> <ul> <li>Defined in /home/hackettyam/www/@ticmakers/react-native/OnBoarding/node_modules/@types/react/index.d.ts:609</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Called immediately after updating occurs. Not called for the initial render.</p> </div> <p>The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.</p> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>prevProps: <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">IButtonProps</span><span class="tsd-signature-symbol">&gt;</span></h5> </li> <li> <h5>prevState: <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">IButtonState</span><span class="tsd-signature-symbol">&gt;</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> snapshot: <a href="" class="tsd-signature-type">SS</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported"> <a name="componentwillmount" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> component<wbr>Will<wbr>Mount</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon">component<wbr>Will<wbr>Mount<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Inherited from DeprecatedLifecycle.componentWillMount</p> <ul> <li>Defined in /home/hackettyam/www/@ticmakers/react-native/OnBoarding/node_modules/@types/react/index.d.ts:624</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Called immediately before mounting occurs, and before <code>Component#render</code>. Avoid introducing any side-effects or subscriptions in this method.</p> </div> <p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.</p> <dl class="tsd-comment-tags"> <dt>deprecated</dt> <dd><p>16.3, use componentDidMount or the constructor instead; will stop working in React 17</p> </dd> <dt>see</dt> <dd><p><a href="https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state">https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state</a></p> </dd> <dt>see</dt> <dd><p><a href="https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path">https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</a></p> </dd> </dl> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported"> <a name="componentwillreceiveprops" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> component<wbr>Will<wbr>Receive<wbr>Props</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon">component<wbr>Will<wbr>Receive<wbr>Props<span class="tsd-signature-symbol">(</span>nextProps<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">IButtonProps</span><span class="tsd-signature-symbol">&gt;</span>, nextContext<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Inherited from DeprecatedLifecycle.componentWillReceiveProps</p> <ul> <li>Defined in /home/hackettyam/www/@ticmakers/react-native/OnBoarding/node_modules/@types/react/index.d.ts:653</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes.</p> </div> <p>Calling <code>Component#setState</code> generally does not trigger this method.</p> <p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.</p> <dl class="tsd-comment-tags"> <dt>deprecated</dt> <dd><p>16.3, use static getDerivedStateFromProps instead; will stop working in React 17</p> </dd> <dt>see</dt> <dd><p><a href="https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props">https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props</a></p> </dd> <dt>see</dt> <dd><p><a href="https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path">https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</a></p> </dd> </dl> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>nextProps: <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">IButtonProps</span><span class="tsd-signature-symbol">&gt;</span></h5> </li> <li> <h5>nextContext: <span class="tsd-signature-type">any</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported"> <a name="componentwillunmount" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> component<wbr>Will<wbr>Unmount</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon">component<wbr>Will<wbr>Unmount<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Inherited from ComponentLifecycle.componentWillUnmount</p> <ul> <li>Defined in /home/hackettyam/www/@ticmakers/react-native/OnBoarding/node_modules/@types/react/index.d.ts:562</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in <code>componentDidMount</code>.</p> </div> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported"> <a name="componentwillupdate" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> component<wbr>Will<wbr>Update</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon">component<wbr>Will<wbr>Update<span class="tsd-signature-symbol">(</span>nextProps<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">IButtonProps</span><span class="tsd-signature-symbol">&gt;</span>, nextState<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">IButtonState</span><span class="tsd-signature-symbol">&gt;</span>, nextContext<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Inherited from DeprecatedLifecycle.componentWillUpdate</p> <ul> <li>Defined in /home/hackettyam/www/@ticmakers/react-native/OnBoarding/node_modules/@types/react/index.d.ts:683</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Called immediately before rendering when new props or state is received. Not called for the initial render.</p> </div> <p>Note: You cannot call <code>Component#setState</code> here.</p> <p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.</p> <dl class="tsd-comment-tags"> <dt>deprecated</dt> <dd><p>16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17</p> </dd> <dt>see</dt> <dd><p><a href="https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update">https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update</a></p> </dd> <dt>see</dt> <dd><p><a href="https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path">https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</a></p> </dd> </dl> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>nextProps: <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">IButtonProps</span><span class="tsd-signature-symbol">&gt;</span></h5> </li> <li> <h5>nextState: <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">IButtonState</span><span class="tsd-signature-symbol">&gt;</span></h5> </li> <li> <h5>nextContext: <span class="tsd-signature-type">any</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported"> <a name="getsnapshotbeforeupdate" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> get<wbr>Snapshot<wbr>Before<wbr>Update</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon">get<wbr>Snapshot<wbr>Before<wbr>Update<span class="tsd-signature-symbol">(</span>prevProps<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">IButtonProps</span><span class="tsd-signature-symbol">&gt;</span>, prevState<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">IButtonState</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">SS</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Inherited from NewLifecycle.getSnapshotBeforeUpdate</p> <ul> <li>Defined in /home/hackettyam/www/@ticmakers/react-native/OnBoarding/node_modules/@types/react/index.d.ts:603</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Runs before React applies the result of <code>render</code> to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before <code>render</code> causes changes to it.</p> </div> <p>Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.</p> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>prevProps: <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">IButtonProps</span><span class="tsd-signature-symbol">&gt;</span></h5> </li> <li> <h5>prevState: <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">IButtonState</span><span class="tsd-signature-symbol">&gt;</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">SS</span> <span class="tsd-signature-symbol"> | </span> <span class="tsd-signature-type">null</span> </h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-not-exported"> <a name="render" class="tsd-anchor"></a> <h3>render</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon">render<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">TypeComponent</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Overrides Button.render</p> <ul> <li>Defined in Pagination/index.d.ts:403</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Method that renders the component</p> </div> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">TypeComponent</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported"> <a name="shouldcomponentupdate" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> should<wbr>Component<wbr>Update</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon">should<wbr>Component<wbr>Update<span class="tsd-signature-symbol">(</span>nextProps<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">IButtonProps</span><span class="tsd-signature-symbol">&gt;</span>, nextState<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">IButtonState</span><span class="tsd-signature-symbol">&gt;</span>, nextContext<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Inherited from ComponentLifecycle.shouldComponentUpdate</p> <ul> <li>Defined in /home/hackettyam/www/@ticmakers/react-native/OnBoarding/node_modules/@types/react/index.d.ts:557</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Called to determine whether the change in props and state should trigger a re-render.</p> </div> <p><code>Component</code> always returns true. <code>PureComponent</code> implements a shallow comparison on props and state and returns true if any props or states have changed.</p> <p>If false is returned, <code>Component#render</code>, <code>componentWillUpdate</code> and <code>componentDidUpdate</code> will not be called.</p> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>nextProps: <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">IButtonProps</span><span class="tsd-signature-symbol">&gt;</span></h5> </li> <li> <h5>nextState: <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">IButtonState</span><span class="tsd-signature-symbol">&gt;</span></h5> </li> <li> <h5>nextContext: <span class="tsd-signature-type">any</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4> </li> </ul> </section> </section> </div> <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> <nav class="tsd-navigation primary"> <ul> <li class="globals "> <a href="../globals.html"><em>Globals</em></a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/_dot_dot_.html">"<wbr>Dot/<wbr>Dot"</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/_dot_index_d_.html">"<wbr>Dot/index.d"</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/_dot_styles_.html">"<wbr>Dot/styles"</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/_dots_dots_.html">"<wbr>Dots/<wbr>Dots"</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/_dots_index_d_.html">"<wbr>Dots/index.d"</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/_dots_styles_.html">"<wbr>Dots/styles"</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/_onboarding_onboarding_.html">"<wbr>Onboarding/<wbr>Onboard