Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Optional accessibilityComponentType

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

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

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

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"

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[]

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

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

Optional adjustsFontSizeToFit

adjustsFontSizeToFit: undefined | false | true

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

Optional allowFontScaling

allowFontScaling: undefined | false | true

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

Optional ellipsizeMode

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

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"

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

Optional isHeadline

isHeadline: boolean | undefined

Optional isParagraph

isParagraph: boolean | undefined

Optional isSubheading

isSubheading: boolean | undefined

Optional isTitle

isTitle: boolean | undefined

Optional lineBreakMode

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

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

Optional linkColor

linkColor: string | undefined

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

Optional minimumFontScale

minimumFontScale: undefined | number

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

Optional numberOfLines

numberOfLines: undefined | number

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

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

Invoked on mount and layout changes with

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

Optional onLongPress

onLongPress: undefined | function

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

Optional onMagicTap

onMagicTap: undefined | function

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

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

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

Optional selectable

selectable: undefined | false | true

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

Optional selectionColor

selectionColor: undefined | string

The highlight color of the text.

Optional style

style: StyleProp<TextStyle>

Optional suppressHighlighting

suppressHighlighting: undefined | false | true

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

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

Optional textBreakStrategy

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

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