Properties for the CrossLabel component. Control component type using isTitle, isCaption, isHeadline, isSubheading and isParagraph.

Create an URL link using onPressUrlTarget and customize color using linkColor.

Inherits react-native Text's TextProps

### Hierarchy

- TextProps
  - ICrossLabelProps

## Index

### Properties

- accessibilityComponentType
- accessibilityElementsHidden
- accessibilityLabel
- accessibilityLiveRegion
- accessibilityTraits
- accessible
- adjustsFontSizeToFit
- allowFontScaling
- ellipsizeMode
- importantForAccessibility
- isCaption
- isHeadline
- isParagraph
- isSubheading
- isTitle
- lineBreakMode
- linkColor
- minimumFontScale
- numberOfLines
- onAccessibilityTap
- onLayout
- onLongPress
- onMagicTap
- onPress
- onPressUrlTarget
- selectable
- selectionColor
- style
- suppressHighlighting
- testID
- textBreakStrategy

## Properties

### Optional accessibilityComponentType

accessibilityComponentType: "none" | "button" | "radiobutton_checked" | "radiobutton_unchecked"

Inherited from AccessibilityPropsAndroid.accessibilityComponentType

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1857

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.

platform

  android

### Optional accessibilityElementsHidden

accessibilityElementsHidden: undefined | false | true

Inherited from AccessibilityPropsIOS.accessibilityElementsHidden

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1887

A Boolean value indicating whether the accessibility elements contained within this accessibility element are hidden to the screen reader.

platform

  ios

### Optional accessibilityLabel

accessibilityLabel: undefined | string

Inherited from AccessibilityProps.accessibilityLabel

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1846

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.

### Optional accessibilityLiveRegion

accessibilityLiveRegion: "none" | "polite" | "assertive"

Inherited from AccessibilityPropsAndroid.accessibilityLiveRegion

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1865

Indicates to accessibility services whether the user should be notified when this view changes. Works for Android API >= 19 only. See http://developer.android.com/reference/android/view/View.html#attr_android:accessibilityLiveRegion for references.

platform

  android

### Optional accessibilityTraits

accessibilityTraits: AccessibilityTrait | AccessibilityTrait[]

Inherited from AccessibilityPropsIOS.accessibilityTraits

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1894

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.

platform

  ios

### Optional accessible

accessible: undefined | false | true

Inherited from AccessibilityProps.accessible

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1840

When true, indicates that the view is an accessibility element. By default, all the touchable elements are accessible.

### Optional adjustsFontSizeToFit

adjustsFontSizeToFit: undefined | false | true

Inherited from TextPropsIOS.adjustsFontSizeToFit

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:811

Specifies whether font should be scaled down automatically to fit given style constraints.

### Optional allowFontScaling

allowFontScaling: undefined | false | true

Inherited from TextProps.allowFontScaling

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:849

Specifies whether fonts should scale to respect Text Size accessibility settings. The default is `true`.

### Optional ellipsizeMode

ellipsizeMode: "head" | "middle" | "tail" | "clip"

Inherited from TextProps.ellipsizeMode

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:868

This can be one of the following values:

- `head` - 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"
- `middle` - 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"
- `tail` - 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..."
- `clip` - Lines are not drawn past the edge of the text container.

The default is `tail`.

`numberOfLines` must be set in conjunction with this prop.

> `clip` is working only for iOS

### Optional importantForAccessibility

importantForAccessibility: "auto" | "yes" | "no" | "no-hide-descendants"

Inherited from AccessibilityPropsAndroid.importantForAccessibility

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1878

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 http://developer.android.com/reference/android/R.attr.html#importantForAccessibility for references.

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.

### Optional isCaption

isCaption: boolean | undefined

- Defined in components/labels/CrossLabel.tsx:55

Displays text as a react-native paper Caption component

### Optional isHeadline

isHeadline: boolean | undefined

- Defined in components/labels/CrossLabel.tsx:39

Displays text as a react-native paper Headline component

### Optional isParagraph

isParagraph: boolean | undefined

- Defined in components/labels/CrossLabel.tsx:51

Displays text as a react-native paper Paragraph component

### Optional isSubheading

isSubheading: boolean | undefined

- Defined in components/labels/CrossLabel.tsx:47

Displays text as a react-native paper Subheading component

### Optional isTitle

isTitle: boolean | undefined

- Defined in components/labels/CrossLabel.tsx:43

Displays text as a react-native paper Title component

### Optional lineBreakMode

lineBreakMode: "head" | "middle" | "tail" | "clip"

Inherited from TextProps.lineBreakMode

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:874

Line Break mode. Works only with numberOfLines. clip is working only for iOS

### Optional linkColor

linkColor: string | undefined

- Defined in components/labels/CrossLabel.tsx:35

Optional color for the link. Default is 'blue'. See also onPressUrlTarget

### Optional minimumFontScale

minimumFontScale: undefined | number

Inherited from TextPropsIOS.minimumFontScale

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:816

Specifies smallest possible scale a font can reach when adjustsFontSizeToFit is enabled. (values 0.01-1.0).

### Optional numberOfLines

numberOfLines: undefined | number

Inherited from TextProps.numberOfLines

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:883

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.

This prop is commonly used with `ellipsizeMode`.

### Optional onAccessibilityTap

onAccessibilityTap: undefined | function

Inherited from AccessibilityPropsIOS.onAccessibilityTap

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1900

When `accessible` is true, the system will try to invoke this function when the user performs accessibility tap gesture.

platform

  ios

### Optional onLayout

onLayout: undefined | function

Inherited from TextProps.onLayout

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:890

Invoked on mount and layout changes with

{nativeEvent: { layout: {x, y, width, height}}}.

### Optional onLongPress

onLongPress: undefined | function

Inherited from TextProps.onLongPress

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:902

This function is called on long press. e.g., `onLongPress={this.increaseSize}>``

### Optional onMagicTap

onMagicTap: undefined | function

Inherited from AccessibilityPropsIOS.onMagicTap

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1906

When accessible is true, the system will invoke this function when the user performs the magic tap gesture.

platform

  ios

### Optional onPress

onPress: undefined | function

Inherited from TextProps.onPress

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:896

This function is called on press. Text intrinsically supports press handling with a default highlight state (which can be disabled with suppressHighlighting).

### Optional onPressUrlTarget

onPressUrlTarget: undefined | string

- Defined in components/labels/CrossLabel.tsx:31

An url to open when user clicks the label. Styles the label as a clickable "link"

### Optional selectable

selectable: undefined | false | true

Inherited from TextPropsAndroid.selectable

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:829

Lets the user select text, to use the native copy and paste functionality.

### Optional selectionColor

selectionColor: undefined | string

Inherited from TextPropsAndroid.selectionColor

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:834

The highlight color of the text.

### Optional style

style: StyleProp<TextStyle>

Inherited from TextProps.style

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:907

see

  https://facebook.github.io/react-native/docs/text.html#style

### Optional suppressHighlighting

suppressHighlighting: undefined | false | true

Inherited from TextPropsIOS.suppressHighlighting

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:822

When `true`, no visual change is made when text is pressed down. By default, a gray oval highlights the text on press down.

### Optional testID

testID: undefined | string

Inherited from TextProps.testID

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:912

Used to locate this view in end-to-end tests.

### Optional textBreakStrategy

textBreakStrategy: "simple" | "highQuality" | "balanced"

Inherited from TextPropsAndroid.textBreakStrategy

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:840

Set text break strategy on Android API Level 23+ default is `highQuality`.