UNPKG

react-native-cross-components

Version:
395 lines 20.8 kB
<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>ICrossSpinnerProps | Crossplatform React-Native Core</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">Crossplatform React-Native Core</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> </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="../index.html">Globals</a> </li> <li> <a href="../modules/_components_animations_crossspinner_.html">&quot;components/animations/CrossSpinner&quot;</a> </li> <li> <a href="_components_animations_crossspinner_.icrossspinnerprops.html">ICrossSpinnerProps</a> </li> </ul> <h1>Interface ICrossSpinnerProps</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>Properties for the <a href="../modules/_components_animations_crossspinner_.html#crossspinner">CrossSpinner</a> component</p> </div> </div> </section> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <span class="tsd-signature-type">BallIndicatorProps</span> <ul class="tsd-hierarchy"> <li> <span class="target">ICrossSpinnerProps</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 "> <h3>Properties</h3> <ul class="tsd-index-list"> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_components_animations_crossspinner_.icrossspinnerprops.html#animationduration" class="tsd-kind-icon">animation<wbr>Duration</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_components_animations_crossspinner_.icrossspinnerprops.html#animationeasing" class="tsd-kind-icon">animation<wbr>Easing</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_components_animations_crossspinner_.icrossspinnerprops.html#color" class="tsd-kind-icon">color</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_components_animations_crossspinner_.icrossspinnerprops.html#count" class="tsd-kind-icon">count</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_components_animations_crossspinner_.icrossspinnerprops.html#size" class="tsd-kind-icon">size</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_components_animations_crossspinner_.icrossspinnerprops.html#style" class="tsd-kind-icon">style</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_components_animations_crossspinner_.icrossspinnerprops.html#testid" class="tsd-kind-icon">testID</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_components_animations_crossspinner_.icrossspinnerprops.html#type" class="tsd-kind-icon">type</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 tsd-is-inherited"> <a name="animationduration" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> animation<wbr>Duration</h3> <div class="tsd-signature tsd-kind-icon">animation<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"> <p>Inherited from BaseIndicatorProps.animationDuration</p> <ul> <li>Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native-indicators/index.d.ts:20</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Animation duration in ms</p> </div> <dl class="tsd-comment-tags"> <dt>default1200</dt> <dd></dd> </dl> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a name="animationeasing" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> animation<wbr>Easing</h3> <div class="tsd-signature tsd-kind-icon">animation<wbr>Easing<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">EasingFunction</span></div> <aside class="tsd-sources"> <p>Inherited from BaseIndicatorProps.animationEasing</p> <ul> <li>Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native-indicators/index.d.ts:14</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Animation easing function</p> </div> <dl class="tsd-comment-tags"> <dt>default</dt> <dd><p>Easing.linear</p> </dd> </dl> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a name="color" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> color</h3> <div class="tsd-signature tsd-kind-icon">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"> <p>Inherited from BallIndicatorProps.color</p> <ul> <li>Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native-indicators/index.d.ts:50</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Component color</p> </div> <dl class="tsd-comment-tags"> <dt>default</dt> <dd><p>&#39;rgb(0, 0, 0)&#39;</p> </dd> </dl> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a name="count" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> count</h3> <div class="tsd-signature tsd-kind-icon">count<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"> <p>Inherited from BallIndicatorProps.count</p> <ul> <li>Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native-indicators/index.d.ts:55</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Component count</p> </div> <dl class="tsd-comment-tags"> <dt>default</dt> <dd><p>8</p> </dd> </dl> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a name="size" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> size</h3> <div class="tsd-signature tsd-kind-icon">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"> <p>Inherited from BallIndicatorProps.size</p> <ul> <li>Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native-indicators/index.d.ts:60</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Base component size</p> </div> <dl class="tsd-comment-tags"> <dt>default</dt> <dd><p>40</p> </dd> </dl> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="style" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> style</h3> <div class="tsd-signature tsd-kind-icon">style<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/crossplatformsweden/react-native-components/blob/f6485d7/source/components/animations/CrossSpinner.tsx#L48">components/animations/CrossSpinner.tsx:48</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Optional custom styles</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="testid" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> testID</h3> <div class="tsd-signature tsd-kind-icon">testID<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/crossplatformsweden/react-native-components/blob/f6485d7/source/components/animations/CrossSpinner.tsx#L49">components/animations/CrossSpinner.tsx:49</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="type" class="tsd-anchor"></a> <h3>type</h3> <div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <a href="../modules/_components_animations_crossspinner_.html#crossspinnertype" class="tsd-signature-type">CrossSpinnerType</a></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/crossplatformsweden/react-native-components/blob/f6485d7/source/components/animations/CrossSpinner.tsx#L44">components/animations/CrossSpinner.tsx:44</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Type of animatoon <a href="../modules/_components_animations_crossspinner_.html#crossspinnertype">CrossSpinnerType</a></p> </div> </div> </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="../index.html"><em>Globals</em></a> </li> <li class="current tsd-kind-external-module"> <a href="../modules/_components_animations_crossspinner_.html">"components/animations/<wbr>Cross<wbr>Spinner"</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/_components_buttons_crossbutton_.html">"components/buttons/<wbr>Cross<wbr>Button"</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/_components_input_crosseditor_.html">"components/input/<wbr>Cross<wbr>Editor"</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/_components_labels_crosslabel_.html">"components/labels/<wbr>Cross<wbr>Label"</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/_components_modals_crossbusyindicator_.html">"components/modals/<wbr>Cross<wbr>Busy<wbr>Indicator"</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/_index_.html">"index"</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/_styles_.html">"styles"</a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> </ul> <ul class="current"> <li class="current tsd-kind-interface tsd-parent-kind-external-module"> <a href="_components_animations_crossspinner_.icrossspinnerprops.html" class="tsd-kind-icon">ICross<wbr>Spinner<wbr>Props</a> <ul> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a href="_components_animations_crossspinner_.icrossspinnerprops.html#animationduration" class="tsd-kind-icon">animation<wbr>Duration</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a href="_components_animations_crossspinner_.icrossspinnerprops.html#animationeasing" class="tsd-kind-icon">animation<wbr>Easing</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a href="_components_animations_crossspinner_.icrossspinnerprops.html#color" class="tsd-kind-icon">color</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a href="_components_animations_crossspinner_.icrossspinnerprops.html#count" class="tsd-kind-icon">count</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a href="_components_animations_crossspinner_.icrossspinnerprops.html#size" class="tsd-kind-icon">size</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="_components_animations_crossspinner_.icrossspinnerprops.html#style" class="tsd-kind-icon">style</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="_components_animations_crossspinner_.icrossspinnerprops.html#testid" class="tsd-kind-icon">testID</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="_components_animations_crossspinner_.icrossspinnerprops.html#type" class="tsd-kind-icon">type</a> </li> </ul> </li> </ul> <ul class="after-current"> <li class=" tsd-kind-type-alias tsd-parent-kind-external-module"> <a href="../modules/_components_animations_crossspinner_.html#crossspinnertype" class="tsd-kind-icon">Cross<wbr>Spinner<wbr>Type</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module"> <a href="../modules/_components_animations_crossspinner_.html#crossspinner" class="tsd-kind-icon">Cross<wbr>Spinner</a> </li> </ul> </nav> </div> </div> </div> <footer> <div class="container"> <h2>Legend</h2> <div class="tsd-legend-group"> <ul class="tsd-legend"> <li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li> <li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li> <li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li> <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li> <li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li> <li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li> <li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li> <li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li> <li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li> <li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li> <li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li> <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li> <li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li> <li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li> <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li> <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li> <li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li> <li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li> </ul> </div> </div> </footer> <div class="overlay"></div> <script src="../assets/js/main.js"></script> <script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script> </body> </html>