react-native-cross-components

<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>ICrossLabelProps | 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_labels_crosslabel_.html">"components/labels/CrossLabel"</a> </li> <li> <a href="_components_labels_crosslabel_.icrosslabelprops.html">ICrossLabelProps</a> </li> </ul> <h1>Interface ICrossLabelProps</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="../classes/_components_labels_crosslabel_.crosslabel.html">CrossLabel</a> component. Control component type using <a href="_components_labels_crosslabel_.icrosslabelprops.html#istitle">isTitle</a>, <a href="_components_labels_crosslabel_.icrosslabelprops.html#iscaption">isCaption</a>, <a href="_components_labels_crosslabel_.icrosslabelprops.html#isheadline">isHeadline</a>, <a href="_components_labels_crosslabel_.icrosslabelprops.html#issubheading">isSubheading</a> and <a href="_components_labels_crosslabel_.icrosslabelprops.html#isparagraph">isParagraph</a>.</p> </div> <p>Create an URL link using <a href="_components_labels_crosslabel_.icrosslabelprops.html#onpressurltarget">onPressUrlTarget</a> and customize color using <a href="_components_labels_crosslabel_.icrosslabelprops.html#linkcolor">linkColor</a>.</p> <p>Inherits react-native Text's <a href="https://facebook.github.io/react-native/docs/text.html#props" class="external">TextProps</a></p> </div> </section> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <span class="tsd-signature-type">TextProps</span> <ul class="tsd-hierarchy"> <li> <span class="target">ICrossLabelProps</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_labels_crosslabel_.icrosslabelprops.html#accessibilitycomponenttype" class="tsd-kind-icon">accessibility<wbr>Component<wbr>Type</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_components_labels_crosslabel_.icrosslabelprops.html#accessibilityelementshidden" class="tsd-kind-icon">accessibility<wbr>Elements<wbr>Hidden</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_components_labels_crosslabel_.icrosslabelprops.html#accessibilitylabel" class="tsd-kind-icon">accessibility<wbr>Label</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_components_labels_crosslabel_.icrosslabelprops.html#accessibilityliveregion" class="tsd-kind-icon">accessibility<wbr>Live<wbr>Region</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_components_labels_crosslabel_.icrosslabelprops.html#accessibilitytraits" class="tsd-kind-icon">accessibility<wbr>Traits</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_components_labels_crosslabel_.icrosslabelprops.html#accessible" class="tsd-kind-icon">accessible</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_components_labels_crosslabel_.icrosslabelprops.html#adjustsfontsizetofit" class="tsd-kind-icon">adjusts<wbr>Font<wbr>Size<wbr>ToFit</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_components_labels_crosslabel_.icrosslabelprops.html#allowfontscaling" class="tsd-kind-icon">allow<wbr>Font<wbr>Scaling</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_components_labels_crosslabel_.icrosslabelprops.html#ellipsizemode" class="tsd-kind-icon">ellipsize<wbr>Mode</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_components_labels_crosslabel_.icrosslabelprops.html#importantforaccessibility" class="tsd-kind-icon">important<wbr>For<wbr>Accessibility</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_components_labels_crosslabel_.icrosslabelprops.html#iscaption" class="tsd-kind-icon">is<wbr>Caption</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_components_labels_crosslabel_.icrosslabelprops.html#isheadline" class="tsd-kind-icon">is<wbr>Headline</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_components_labels_crosslabel_.icrosslabelprops.html#isparagraph" class="tsd-kind-icon">is<wbr>Paragraph</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_components_labels_crosslabel_.icrosslabelprops.html#issubheading" class="tsd-kind-icon">is<wbr>Subheading</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_components_labels_crosslabel_.icrosslabelprops.html#istitle" class="tsd-kind-icon">is<wbr>Title</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_components_labels_crosslabel_.icrosslabelprops.html#linebreakmode" class="tsd-kind-icon">line<wbr>Break<wbr>Mode</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_components_labels_crosslabel_.icrosslabelprops.html#linkcolor" class="tsd-kind-icon">link<wbr>Color</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_components_labels_crosslabel_.icrosslabelprops.html#minimumfontscale" class="tsd-kind-icon">minimum<wbr>Font<wbr>Scale</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_components_labels_crosslabel_.icrosslabelprops.html#numberoflines" class="tsd-kind-icon">number<wbr>OfLines</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_components_labels_crosslabel_.icrosslabelprops.html#onaccessibilitytap" class="tsd-kind-icon">on<wbr>Accessibility<wbr>Tap</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_components_labels_crosslabel_.icrosslabelprops.html#onlayout" class="tsd-kind-icon">on<wbr>Layout</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_components_labels_crosslabel_.icrosslabelprops.html#onlongpress" class="tsd-kind-icon">on<wbr>Long<wbr>Press</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_components_labels_crosslabel_.icrosslabelprops.html#onmagictap" class="tsd-kind-icon">on<wbr>Magic<wbr>Tap</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_components_labels_crosslabel_.icrosslabelprops.html#onpress" class="tsd-kind-icon">on<wbr>Press</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_components_labels_crosslabel_.icrosslabelprops.html#onpressurltarget" class="tsd-kind-icon">on<wbr>Press<wbr>Url<wbr>Target</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_components_labels_crosslabel_.icrosslabelprops.html#selectable" class="tsd-kind-icon">selectable</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_components_labels_crosslabel_.icrosslabelprops.html#selectioncolor" class="tsd-kind-icon">selection<wbr>Color</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_components_labels_crosslabel_.icrosslabelprops.html#style" class="tsd-kind-icon">style</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_components_labels_crosslabel_.icrosslabelprops.html#suppresshighlighting" class="tsd-kind-icon">suppress<wbr>Highlighting</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_components_labels_crosslabel_.icrosslabelprops.html#testid" class="tsd-kind-icon">testID</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_components_labels_crosslabel_.icrosslabelprops.html#textbreakstrategy" class="tsd-kind-icon">text<wbr>Break<wbr>Strategy</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="accessibilitycomponenttype" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> accessibility<wbr>Component<wbr>Type</h3> <div class="tsd-signature tsd-kind-icon">accessibility<wbr>Component<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"none"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"button"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"radiobutton_checked"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"radiobutton_unchecked"</span></div> <aside class="tsd-sources"> <p>Inherited from AccessibilityPropsAndroid.accessibilityComponentType</p> <ul> <li>Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1857</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>In some cases, we also want to alert the end user of the type of selected component (i.e., that it is a “button”). If we were using native buttons, this would work automatically. Since we are using javascript, we need to provide a bit more context for TalkBack. To do so, you must specify the ‘accessibilityComponentType’ property for any UI component. For instances, we support ‘button’, ‘radiobutton_checked’ and ‘radiobutton_unchecked’ and so on.</p> </div> <dl class="tsd-comment-tags"> <dt>platform</dt> <dd><p>android</p> </dd> </dl> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a name="accessibilityelementshidden" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> accessibility<wbr>Elements<wbr>Hidden</h3> <div class="tsd-signature tsd-kind-icon">accessibility<wbr>Elements<wbr>Hidden<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"> <p>Inherited from AccessibilityPropsIOS.accessibilityElementsHidden</p> <ul> <li>Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1887</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>A Boolean value indicating whether the accessibility elements contained within this accessibility element are hidden to the screen reader.</p> </div> <dl class="tsd-comment-tags"> <dt>platform</dt> <dd><p>ios</p> </dd> </dl> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a name="accessibilitylabel" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> accessibility<wbr>Label</h3> <div class="tsd-signature tsd-kind-icon">accessibility<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"> <p>Inherited from AccessibilityProps.accessibilityLabel</p> <ul> <li>Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1846</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Overrides the text that's read by the screen reader when the user interacts with the element. By default, the label is constructed by traversing all the children and accumulating all the Text nodes separated by space.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a name="accessibilityliveregion" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> accessibility<wbr>Live<wbr>Region</h3> <div class="tsd-signature tsd-kind-icon">accessibility<wbr>Live<wbr>Region<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"none"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"polite"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"assertive"</span></div> <aside class="tsd-sources"> <p>Inherited from AccessibilityPropsAndroid.accessibilityLiveRegion</p> <ul> <li>Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1865</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Indicates to accessibility services whether the user should be notified when this view changes. Works for Android API >= 19 only. See <a href="http://developer.android.com/reference/android/view/View.html#attr_android:accessibilityLiveRegion">http://developer.android.com/reference/android/view/View.html#attr_android:accessibilityLiveRegion</a> for references.</p> </div> <dl class="tsd-comment-tags"> <dt>platform</dt> <dd><p>android</p> </dd> </dl> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a name="accessibilitytraits" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> accessibility<wbr>Traits</h3> <div class="tsd-signature tsd-kind-icon">accessibility<wbr>Traits<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">AccessibilityTrait</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">AccessibilityTrait</span><span class="tsd-signature-symbol">[]</span></div> <aside class="tsd-sources"> <p>Inherited from AccessibilityPropsIOS.accessibilityTraits</p> <ul> <li>Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1894</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Accessibility traits tell a person using VoiceOver what kind of element they have selected. Is this element a label? A button? A header? These questions are answered by accessibilityTraits.</p> </div> <dl class="tsd-comment-tags"> <dt>platform</dt> <dd><p>ios</p> </dd> </dl> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a name="accessible" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> accessible</h3> <div class="tsd-signature tsd-kind-icon">accessible<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"> <p>Inherited from AccessibilityProps.accessible</p> <ul> <li>Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1840</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>When true, indicates that the view is an accessibility element. By default, all the touchable elements are accessible.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a name="adjustsfontsizetofit" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> adjusts<wbr>Font<wbr>Size<wbr>ToFit</h3> <div class="tsd-signature tsd-kind-icon">adjusts<wbr>Font<wbr>Size<wbr>ToFit<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"> <p>Inherited from TextPropsIOS.adjustsFontSizeToFit</p> <ul> <li>Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:811</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Specifies whether font should be scaled down automatically to fit given style constraints.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a name="allowfontscaling" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> allow<wbr>Font<wbr>Scaling</h3> <div class="tsd-signature tsd-kind-icon">allow<wbr>Font<wbr>Scaling<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"> <p>Inherited from TextProps.allowFontScaling</p> <ul> <li>Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:849</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Specifies whether fonts should scale to respect Text Size accessibility settings. The default is <code>true</code>.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a name="ellipsizemode" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> ellipsize<wbr>Mode</h3> <div class="tsd-signature tsd-kind-icon">ellipsize<wbr>Mode<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"head"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"middle"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"tail"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"clip"</span></div> <aside class="tsd-sources"> <p>Inherited from TextProps.ellipsizeMode</p> <ul> <li>Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:868</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>This can be one of the following values:</p> </div> <ul> <li><code>head</code> - The line is displayed so that the end fits in the container and the missing text at the beginning of the line is indicated by an ellipsis glyph. e.g., "...wxyz"</li> <li><code>middle</code> - The line is displayed so that the beginning and end fit in the container and the missing text in the middle is indicated by an ellipsis glyph. "ab...yz"</li> <li><code>tail</code> - The line is displayed so that the beginning fits in the container and the missing text at the end of the line is indicated by an ellipsis glyph. e.g., "abcd..."</li> <li><code>clip</code> - Lines are not drawn past the edge of the text container.</li> </ul> <p>The default is <code>tail</code>.</p> <p><code>numberOfLines</code> must be set in conjunction with this prop.</p> <blockquote> <p><code>clip</code> is working only for iOS</p> </blockquote> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a name="importantforaccessibility" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> important<wbr>For<wbr>Accessibility</h3> <div class="tsd-signature tsd-kind-icon">important<wbr>For<wbr>Accessibility<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"auto"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"yes"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"no"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"no-hide-descendants"</span></div> <aside class="tsd-sources"> <p>Inherited from AccessibilityPropsAndroid.importantForAccessibility</p> <ul> <li>Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1878</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Controls how view is important for accessibility which is if it fires accessibility events and if it is reported to accessibility services that query the screen. Works for Android only. See <a href="http://developer.android.com/reference/android/R.attr.html#importantForAccessibility">http://developer.android.com/reference/android/R.attr.html#importantForAccessibility</a> for references.</p> </div> <p>Possible values: 'auto' - The system determines whether the view is important for accessibility - default (recommended). 'yes' - The view is important for accessibility. 'no' - The view is not important for accessibility. 'no-hide-descendants' - The view is not important for accessibility, nor are any of its descendant views.</p> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="iscaption" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> is<wbr>Caption</h3> <div class="tsd-signature tsd-kind-icon">is<wbr>Caption<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</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/labels/CrossLabel.tsx#L56">components/labels/CrossLabel.tsx:56</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Displays text as a <a href="https://callstack.github.io/react-native-paper/caption.html" class="external">react-native paper Caption component</a></p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="isheadline" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> is<wbr>Headline</h3> <div class="tsd-signature tsd-kind-icon">is<wbr>Headline<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</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/labels/CrossLabel.tsx#L40">components/labels/CrossLabel.tsx:40</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Displays text as a <a href="https://callstack.github.io/react-native-paper/headline.html" class="external">react-native paper Headline component</a></p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="isparagraph" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> is<wbr>Paragraph</h3> <div class="tsd-signature tsd-kind-icon">is<wbr>Paragraph<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</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/labels/CrossLabel.tsx#L52">components/labels/CrossLabel.tsx:52</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Displays text as a <a href="https://callstack.github.io/react-native-paper/paragraph.html" class="external">react-native paper Paragraph component</a></p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="issubheading" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> is<wbr>Subheading</h3> <div class="tsd-signature tsd-kind-icon">is<wbr>Subheading<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</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/labels/CrossLabel.tsx#L48">components/labels/CrossLabel.tsx:48</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Displays text as a <a href="https://callstack.github.io/react-native-paper/subheading.html" class="external">react-native paper Subheading component</a></p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="istitle" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> is<wbr>Title</h3> <div class="tsd-signature tsd-kind-icon">is<wbr>Title<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</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/labels/CrossLabel.tsx#L44">components/labels/CrossLabel.tsx:44</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Displays text as a <a href="https://callstack.github.io/react-native-paper/title.html" class="external">react-native paper Title component</a></p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a name="linebreakmode" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> line<wbr>Break<wbr>Mode</h3> <div class="tsd-signature tsd-kind-icon">line<wbr>Break<wbr>Mode<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"head"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"middle"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"tail"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"clip"</span></div> <aside class="tsd-sources"> <p>Inherited from TextProps.lineBreakMode</p> <ul> <li>Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:874</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Line Break mode. Works only with numberOfLines. clip is working only for iOS</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="linkcolor" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> link<wbr>Color</h3> <div class="tsd-signature tsd-kind-icon">link<wbr>Color<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/labels/CrossLabel.tsx#L36">components/labels/CrossLabel.tsx:36</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Optional color for the link. Default is 'blue'. See also <a href="_components_labels_crosslabel_.icrosslabelprops.html#onpressurltarget">onPressUrlTarget</a></p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a name="minimumfontscale" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> minimum<wbr>Font<wbr>Scale</h3> <div class="tsd-signature tsd-kind-icon">minimum<wbr>Font<wbr>Scale<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 TextPropsIOS.minimumFontScale</p> <ul> <li>Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:816</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Specifies smallest possible scale a font can reach when adjustsFontSizeToFit is enabled. (values 0.01-1.0).</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a name="numberoflines" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> number<wbr>OfLines</h3> <div class="tsd-signature tsd-kind-icon">number<wbr>OfLines<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 TextProps.numberOfLines</p> <ul> <li>Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:883</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Used to truncate the text with an ellipsis after computing the text layout, including line wrapping, such that the total number of lines does not exceed this number.</p> </div> <p>This prop is commonly used with <code>ellipsizeMode</code>.</p> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a name="onaccessibilitytap" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> on<wbr>Accessibility<wbr>Tap</h3> <div class="tsd-signature tsd-kind-icon">on<wbr>Accessibility<wbr>Tap<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"> <p>Inherited from AccessibilityPropsIOS.onAccessibilityTap</p> <ul> <li>Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1900</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>When <code>accessible</code> is true, the system will try to invoke this function when the user performs accessibility tap gesture.</p> </div> <dl class="tsd-comment-tags"> <dt>platform</dt> <dd><p>ios</p> </dd> </dl> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a name="onlayout" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> on<wbr>Layout</h3> <div class="tsd-signature tsd-kind-icon">on<wbr>Layout<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"> <p>Inherited from TextProps.onLayout</p> <ul> <li>Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:890</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Invoked on mount and layout changes with</p> </div> <p>{nativeEvent: { layout: {x, y, width, height}}}.</p> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a name="onlongpress" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> on<wbr>Long<wbr>Press</h3> <div class="tsd-signature tsd-kind-icon">on<wbr>Long<wbr>Press<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"> <p>Inherited from TextProps.onLongPress</p> <ul> <li>Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:902</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>This function is called on long press. e.g., <code>onLongPress={this.increaseSize}>`</code></p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a name="onmagictap" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> on<wbr>Magic<wbr>Tap</h3> <div class="tsd-signature tsd-kind-icon">on<wbr>Magic<wbr>Tap<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"> <p>Inherited from AccessibilityPropsIOS.onMagicTap</p> <ul> <li>Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1906</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>When accessible is true, the system will invoke this function when the user performs the magic tap gesture.</p> </div> <dl class="tsd-comment-tags"> <dt>platform</dt> <dd><p>ios</p> </dd> </dl> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a name="onpress" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> on<wbr>Press</h3> <div class="tsd-signature tsd-kind-icon">on<wbr>Press<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"> <p>Inherited from TextProps.onPress</p> <ul> <li>Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:896</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>This function is called on press. Text intrinsically supports press handling with a default highlight state (which can be disabled with suppressHighlighting).</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="onpressurltarget" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> on<wbr>Press<wbr>Url<wbr>Target</h3> <div class="tsd-signature tsd-kind-icon">on<wbr>Press<wbr>Url<wbr>Target<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 <a href="https://github.com/crossplatformsweden/react-native-components/blob/f6485d7/source/components/labels/CrossLabel.tsx#L32">components/labels/CrossLabel.tsx:32</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>An url to open when user clicks the label. Styles the label as a clickable "link"</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a name="selectable" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> selectable</h3> <div class="tsd-signature tsd-kind-icon">selectable<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"> <p>Inherited from TextPropsAndroid.selectable</p> <ul> <li>Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:829</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Lets the user select text, to use the native copy and paste functionality.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a name="selectioncolor" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> selection<wbr>Color</h3> <div class="tsd-signature tsd-kind-icon">selection<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"> <p>Inherited from TextPropsAndroid.selectionColor</p> <ul> <li>Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:834</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The highlight color of the text.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <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">StyleProp</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TextStyle</span><span class="tsd-signature-symbol">></span></div> <aside class="tsd-sources"> <p>Inherited from TextProps.style</p> <ul> <li>Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:907</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> <dt>see</dt> <dd><p><a href="https://facebook.github.io/react-native/docs/text.html#style">https://facebook.github.io/react-native/docs/text.html#style</a></p> </dd> </dl> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a name="suppresshighlighting" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> suppress<wbr>Highlighting</h3> <div class="tsd-signature tsd-kind-icon">suppress<wbr>Highlighting<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"> <p>Inherited from TextPropsIOS.suppressHighlighting</p> <ul> <li>Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:822</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>When <code>true</code>, no visual change is made when text is pressed down. By default, a gray oval highlights the text on press down.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <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">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <p>Inherited from TextProps.testID</p> <ul> <li>Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:912</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Used to locate this view in end-to-end tests.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a name="textbreakstrategy" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> text<wbr>Break<wbr>Strategy</h3> <div class="tsd-signature tsd-kind-icon">text<wbr>Break<wbr>Strategy<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"simple"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"highQuality"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"balanced"</span></div> <aside class="tsd-sources"> <p>Inherited from TextPropsAndroid.textBreakStrategy</p> <ul> <li>Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:840</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Set text break strategy on Android API Level 23+ default is <code>highQuality</code>.</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=" 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="current 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"> <li class=" tsd-kind-class tsd-parent-kind-external-module tsd-has-type-parameter"> <a href="../classes/_components_labels_crosslabel_.crosslabel.html" class="tsd-kind-icon">Cross<wbr>Label</a> </li> </ul> <ul class="current"> <li class="current tsd-kind-interface tsd-parent-kind-external-module"> <a href="_components_labels_crosslabel_.icrosslabelprops.html" class="tsd-kind-icon">ICross<wbr>Label<wbr>Props</a> <ul> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a href="_components_labels_crosslabel_.icrosslabelprops.html#accessibilitycomponenttype" class="tsd-kind-icon">accessibility<wbr>Component<wbr>Type</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a href="_components_labels_crosslabel_.icrosslabelprops.html#accessibilityelementshidden" class="tsd-kind-icon">accessibility<wbr>Elements<wbr>Hidden</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a href="_components_labels_crosslabel_.icrosslabelprops.html#accessibilitylabel" class="tsd-kind-icon">accessibility<wbr>Label</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a href="_components_labels_crosslabel_.icrosslabelprops.html#accessibilityliveregion" class="tsd-kind-icon">accessibility<wbr>Live<wbr>Region</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a href="_components_labels_crosslabel_.icrosslabelprops.html#accessibilitytraits" class="tsd-kind-icon">accessibility<wbr>Traits</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a href="_components_labels_crosslabel_.icrosslabelprops.html#accessible" class="tsd-kind-icon">accessible</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a href="_components_labels_crosslabel_.icrosslabelprops.html#adjustsfontsizetofit" class="tsd-kind-icon">adjusts<wbr>Font<wbr>Size<wbr>ToFit</a> </li>