### Hierarchy

- TextProps
  - TextProps

## Index

### Properties

- accessibilityComponentType
- accessibilityElementsHidden
- accessibilityHint
- accessibilityIgnoresInvertColors
- accessibilityLabel
- accessibilityLiveRegion
- accessibilityRole
- accessibilityStates
- accessibilityTraits
- accessible
- adjustsFontSizeToFit
- allowFontScaling
- ellipsizeMode
- importantForAccessibility
- lineBreakMode
- minimumFontScale
- nativeID
- numberOfLines
- onAccessibilityTap
- onLayout
- onLongPress
- onMagicTap
- onPress
- selectable
- selectionColor
- style
- styles
- suppressHighlighting
- testID
- textBreakStrategy

## Properties

### Optional accessibilityComponentType

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

Inherited from AccessibilityPropsAndroid.accessibilityComponentType

- Defined in /Users/artalat/Coding/bluebase/core/node_modules/@types/react-native/index.d.ts:1899

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/artalat/Coding/bluebase/core/node_modules/@types/react-native/index.d.ts:1929

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

platform

  ios

### Optional accessibilityHint

accessibilityHint: undefined | string

Inherited from AccessibilityProps.accessibilityHint

- Defined in /Users/artalat/Coding/bluebase/core/node_modules/@types/react-native/index.d.ts:1872

An accessibility hint helps users understand what will happen when they perform an action on the accessibility element when that result is not obvious from the accessibility label.

### Optional accessibilityIgnoresInvertColors

accessibilityIgnoresInvertColors: undefined | false | true

Inherited from AccessibilityPropsIOS.accessibilityIgnoresInvertColors

- Defined in /Users/artalat/Coding/bluebase/core/node_modules/@types/react-native/index.d.ts:1954

https://facebook.github.io/react-native/docs/accessibility#accessibilityignoresinvertcolorsios

platform

  ios

### Optional accessibilityLabel

accessibilityLabel: undefined | string

Inherited from AccessibilityProps.accessibilityLabel

- Defined in /Users/artalat/Coding/bluebase/core/node_modules/@types/react-native/index.d.ts:1858

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/artalat/Coding/bluebase/core/node_modules/@types/react-native/index.d.ts:1907

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 accessibilityRole

accessibilityRole: AccessibilityRole

Inherited from AccessibilityProps.accessibilityRole

- Defined in /Users/artalat/Coding/bluebase/core/node_modules/@types/react-native/index.d.ts:1863

Accessibility Role tells a person using either VoiceOver on iOS or TalkBack on Android the type of element that is focused on.

### Optional accessibilityStates

accessibilityStates: AccessibilityState[]

Inherited from AccessibilityProps.accessibilityStates

- Defined in /Users/artalat/Coding/bluebase/core/node_modules/@types/react-native/index.d.ts:1867

Accessibility State tells a person using either VoiceOver on iOS or TalkBack on Android the state of the element currently focused on.

### Optional accessibilityTraits

accessibilityTraits: AccessibilityTrait | AccessibilityTrait[]

Inherited from AccessibilityPropsIOS.accessibilityTraits

- Defined in /Users/artalat/Coding/bluebase/core/node_modules/@types/react-native/index.d.ts:1936

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/artalat/Coding/bluebase/core/node_modules/@types/react-native/index.d.ts:1852

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/artalat/Coding/bluebase/core/node_modules/@types/react-native/index.d.ts:813

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/artalat/Coding/bluebase/core/node_modules/@types/react-native/index.d.ts:851

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/artalat/Coding/bluebase/core/node_modules/@types/react-native/index.d.ts:870

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/artalat/Coding/bluebase/core/node_modules/@types/react-native/index.d.ts:1920

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 lineBreakMode

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

Inherited from TextProps.lineBreakMode

- Defined in /Users/artalat/Coding/bluebase/core/node_modules/@types/react-native/index.d.ts:876

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

### Optional minimumFontScale

minimumFontScale: undefined | number

Inherited from TextPropsIOS.minimumFontScale

- Defined in /Users/artalat/Coding/bluebase/core/node_modules/@types/react-native/index.d.ts:818

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

### Optional nativeID

nativeID: undefined | string

Inherited from TextProps.nativeID

- Defined in /Users/artalat/Coding/bluebase/core/node_modules/@types/react-native/index.d.ts:919

Used to reference react managed views from native code.

### Optional numberOfLines

numberOfLines: undefined | number

Inherited from TextProps.numberOfLines

- Defined in /Users/artalat/Coding/bluebase/core/node_modules/@types/react-native/index.d.ts:885

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/artalat/Coding/bluebase/core/node_modules/@types/react-native/index.d.ts:1942

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/artalat/Coding/bluebase/core/node_modules/@types/react-native/index.d.ts:892

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/artalat/Coding/bluebase/core/node_modules/@types/react-native/index.d.ts:904

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

### Optional onMagicTap

onMagicTap: undefined | function

Inherited from AccessibilityPropsIOS.onMagicTap

- Defined in /Users/artalat/Coding/bluebase/core/node_modules/@types/react-native/index.d.ts:1948

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/artalat/Coding/bluebase/core/node_modules/@types/react-native/index.d.ts:898

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

### Optional selectable

selectable: undefined | false | true

Inherited from TextPropsAndroid.selectable

- Defined in /Users/artalat/Coding/bluebase/core/node_modules/@types/react-native/index.d.ts:831

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/artalat/Coding/bluebase/core/node_modules/@types/react-native/index.d.ts:836

The highlight color of the text.

### Optional style

style: StyleProp<TextStyle>

Inherited from TextProps.style

- Defined in /Users/artalat/Coding/bluebase/core/node_modules/@types/react-native/index.d.ts:909

see

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

### Optional styles

styles: undefined | object

- Defined in native/Text/Text.tsx:6

### Optional suppressHighlighting

suppressHighlighting: undefined | false | true

Inherited from TextPropsIOS.suppressHighlighting

- Defined in /Users/artalat/Coding/bluebase/core/node_modules/@types/react-native/index.d.ts:824

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/artalat/Coding/bluebase/core/node_modules/@types/react-native/index.d.ts:914

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

### Optional textBreakStrategy

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

Inherited from TextPropsAndroid.textBreakStrategy

- Defined in /Users/artalat/Coding/bluebase/core/node_modules/@types/react-native/index.d.ts:842

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

Generated using TypeDoc