search

TxtProps

@chelseaapps/react-native-elements / Exports / TxtProps

hashtag
Interface: TxtProps

hashtag
Hierarchy

  • TxtElementProps

    ↳ TxtProps

hashtag
Table of contents

hashtag
Properties

  • accessibilityActions

  • accessibilityElementsHidden

  • accessibilityHint

  • accessibilityIgnoresInvertColors

  • accessibilityLabel

  • accessibilityLiveRegion

  • accessibilityRole

  • accessibilityState

  • accessibilityValue

  • accessibilityViewIsModal

  • accessible

  • adjustsFontSizeToFit

  • allowFontScaling

  • android_hyphenationFrequency

  • children

  • dataDetectorType

  • ellipsizeMode

  • importantForAccessibility

  • lineBreakMode

  • maxFontSizeMultiplier

  • minimumFontScale

  • nativeID

  • numberOfLines

  • onAccessibilityAction

  • onAccessibilityEscape

  • onAccessibilityTap

  • onLayout

  • onLongPress

  • onMagicTap

  • onPress

  • onPressIn

  • onPressOut

  • onTextLayout

  • selectable

  • selectionColor

  • style

  • suppressHighlighting

  • testID

  • textBreakStrategy

hashtag
Properties

hashtag
accessibilityActions

• Optional accessibilityActions: readonly Readonly<Object>[]

Provides an array of custom actions available for accessibility.

Inherited from

TxtElementProps.accessibilityActions

Defined in

node_modules/@types/react-native/index.d.ts:2265

hashtag
accessibilityElementsHidden

• Optional accessibilityElementsHidden: boolean

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

platform ios

Inherited from

TxtElementProps.accessibilityElementsHidden

Defined in

node_modules/@types/react-native/index.d.ts:2440

hashtag
accessibilityHint

• Optional accessibilityHint: string

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.

Inherited from

TxtElementProps.accessibilityHint

Defined in

node_modules/@types/react-native/index.d.ts:2284

hashtag
accessibilityIgnoresInvertColors

• Optional accessibilityIgnoresInvertColors: boolean

https://reactnative.dev/docs/accessibility#accessibilityignoresinvertcolorsios

platform ios

Inherited from

TxtElementProps.accessibilityIgnoresInvertColors

Defined in

node_modules/@types/react-native/index.d.ts:2470

hashtag
accessibilityLabel

• Optional accessibilityLabel: 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.

Inherited from

TxtElementProps.accessibilityLabel

Defined in

node_modules/@types/react-native/index.d.ts:2271

hashtag
accessibilityLiveRegion

• Optional 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

Inherited from

TxtElementProps.accessibilityLiveRegion

Defined in

node_modules/@types/react-native/index.d.ts:2418

hashtag
accessibilityRole

• Optional accessibilityRole: AccessibilityRole

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

Inherited from

TxtElementProps.accessibilityRole

Defined in

node_modules/@types/react-native/index.d.ts:2276

hashtag
accessibilityState

• Optional accessibilityState: AccessibilityState

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

Inherited from

TxtElementProps.accessibilityState

Defined in

node_modules/@types/react-native/index.d.ts:2280

hashtag
accessibilityValue

• Optional accessibilityValue: AccessibilityValue

Represents the current value of a component. It can be a textual description of a component's value, or for range-based components, such as sliders and progress bars, it contains range information (minimum, current, and maximum).

Inherited from

TxtElementProps.accessibilityValue

Defined in

node_modules/@types/react-native/index.d.ts:2289

hashtag
accessibilityViewIsModal

• Optional accessibilityViewIsModal: boolean

A Boolean value indicating whether VoiceOver should ignore the elements within views that are siblings of the receiver.

platform ios

Inherited from

TxtElementProps.accessibilityViewIsModal

Defined in

node_modules/@types/react-native/index.d.ts:2446

hashtag
accessible

• Optional accessible: boolean

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

Inherited from

TxtElementProps.accessible

Defined in

node_modules/@types/react-native/index.d.ts:2260

hashtag
adjustsFontSizeToFit

• Optional adjustsFontSizeToFit: boolean

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

Inherited from

TxtElementProps.adjustsFontSizeToFit

Defined in

node_modules/@types/react-native/index.d.ts:950

hashtag
allowFontScaling

• Optional allowFontScaling: boolean

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

Inherited from

TxtElementProps.allowFontScaling

Defined in

node_modules/@types/react-native/index.d.ts:1004

hashtag
android_hyphenationFrequency

• Optional android_hyphenationFrequency: "none" | "balanced" | "normal" | "full" | "high"

Hyphenation strategy

Inherited from

TxtElementProps.android_hyphenationFrequency

Defined in

node_modules/@types/react-native/index.d.ts:990

hashtag
children

• children: ReactNode

Text | Component to be displayed

Inherited from

TxtElementProps.children

Defined in

src/Txt/index.tsx:15arrow-up-right

hashtag
dataDetectorType

• Optional dataDetectorType: null | "none" | "link" | "phoneNumber" | "all" | "email"

Determines the types of data converted to clickable URLs in the text element. By default no data types are detected.

Inherited from

TxtElementProps.dataDetectorType

Defined in

node_modules/@types/react-native/index.d.ts:985

hashtag
ellipsizeMode

• Optional 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

Inherited from

TxtElementProps.ellipsizeMode

Defined in

node_modules/@types/react-native/index.d.ts:1025

hashtag
importantForAccessibility

• Optional 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.

Inherited from

TxtElementProps.importantForAccessibility

Defined in

node_modules/@types/react-native/index.d.ts:2431

hashtag
lineBreakMode

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

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

Inherited from

TxtElementProps.lineBreakMode

Defined in

node_modules/@types/react-native/index.d.ts:1031

hashtag
maxFontSizeMultiplier

• Optional maxFontSizeMultiplier: null | number

Specifies largest possible scale a font can reach when allowFontScaling is enabled. Possible values:

  • null/undefined (default): inherit from the parent node or the global default (0)

  • 0: no max, ignore parent/global default

  • = 1: sets the maxFontSizeMultiplier of this node to this value

Inherited from

TxtElementProps.maxFontSizeMultiplier

Defined in

node_modules/@types/react-native/index.d.ts:1090

hashtag
minimumFontScale

• Optional minimumFontScale: number

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

Inherited from

TxtElementProps.minimumFontScale

Defined in

node_modules/@types/react-native/index.d.ts:955

hashtag
nativeID

• Optional nativeID: string

Used to reference react managed views from native code.

Inherited from

TxtElementProps.nativeID

Defined in

node_modules/@types/react-native/index.d.ts:1082

hashtag
numberOfLines

• Optional numberOfLines: 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.

Inherited from

TxtElementProps.numberOfLines

Defined in

node_modules/@types/react-native/index.d.ts:1040

hashtag
onAccessibilityAction

• Optional onAccessibilityAction: (event: AccessibilityActionEvent) => void

Type declaration

▸ (event): void

When accessible is true, the system will try to invoke this function when the user performs an accessibility custom action.

Parameters

Name
Type

event

AccessibilityActionEvent

Returns

void

Inherited from

TxtElementProps.onAccessibilityAction

Defined in

node_modules/@types/react-native/index.d.ts:2294

hashtag
onAccessibilityEscape

• Optional onAccessibilityEscape: () => void

Type declaration

▸ (): void

When accessibile is true, the system will invoke this function when the user performs the escape gesture (scrub with two fingers).

platform ios

Returns

void

Inherited from

TxtElementProps.onAccessibilityEscape

Defined in

node_modules/@types/react-native/index.d.ts:2452

hashtag
onAccessibilityTap

• Optional onAccessibilityTap: () => void

Type declaration

▸ (): void

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

platform ios

Returns

void

Inherited from

TxtElementProps.onAccessibilityTap

Defined in

node_modules/@types/react-native/index.d.ts:2458

hashtag
onLayout

• Optional onLayout: (event: LayoutChangeEvent) => void

Type declaration

▸ (event): void

Invoked on mount and layout changes with

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

Parameters

Name
Type

event

LayoutChangeEvent

Returns

void

Inherited from

TxtElementProps.onLayout

Defined in

node_modules/@types/react-native/index.d.ts:1047

hashtag
onLongPress

• Optional onLongPress: (event: GestureResponderEvent) => void

Type declaration

▸ (event): void

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

Parameters

Name
Type

event

GestureResponderEvent

Returns

void

Inherited from

TxtElementProps.onLongPress

Defined in

node_modules/@types/react-native/index.d.ts:1067

hashtag
onMagicTap

• Optional onMagicTap: () => void

Type declaration

▸ (): void

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

platform ios

Returns

void

Inherited from

TxtElementProps.onMagicTap

Defined in

node_modules/@types/react-native/index.d.ts:2464

hashtag
onPress

• Optional onPress: (event: GestureResponderEvent) => void

Type declaration

▸ (event): void

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

Parameters

Name
Type

event

GestureResponderEvent

Returns

void

Inherited from

TxtElementProps.onPress

Defined in

node_modules/@types/react-native/index.d.ts:1058

hashtag
onPressIn

• Optional onPressIn: (event: GestureResponderEvent) => void

Type declaration

▸ (event): void

Parameters

Name
Type

event

GestureResponderEvent

Returns

void

Inherited from

TxtElementProps.onPressIn

Defined in

node_modules/@types/react-native/index.d.ts:1060

hashtag
onPressOut

• Optional onPressOut: (event: GestureResponderEvent) => void

Type declaration

▸ (event): void

Parameters

Name
Type

event

GestureResponderEvent

Returns

void

Inherited from

TxtElementProps.onPressOut

Defined in

node_modules/@types/react-native/index.d.ts:1061

hashtag
onTextLayout

• Optional onTextLayout: (event: NativeSyntheticEvent<TextLayoutEventData>) => void

Type declaration

▸ (event): void

Invoked on Text layout

Parameters

Name
Type

event

NativeSyntheticEvent<TextLayoutEventData>

Returns

void

Inherited from

TxtElementProps.onTextLayout

Defined in

node_modules/@types/react-native/index.d.ts:1052

hashtag
selectable

• Optional selectable: boolean

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

Inherited from

TxtElementProps.selectable

Defined in

node_modules/@types/react-native/index.d.ts:968

hashtag
selectionColor

• Optional selectionColor: ColorValue

The highlight color of the text.

Inherited from

TxtElementProps.selectionColor

Defined in

node_modules/@types/react-native/index.d.ts:973

hashtag
style

• Optional style: StyleProp<TextStyle>

see https://reactnative.dev/docs/text#style

Inherited from

TxtElementProps.style

Defined in

node_modules/@types/react-native/index.d.ts:1072

hashtag
suppressHighlighting

• Optional suppressHighlighting: boolean

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

Inherited from

TxtElementProps.suppressHighlighting

Defined in

node_modules/@types/react-native/index.d.ts:961

hashtag
testID

• Optional testID: string

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

Inherited from

TxtElementProps.testID

Defined in

node_modules/@types/react-native/index.d.ts:1077

hashtag
textBreakStrategy

• Optional textBreakStrategy: "simple" | "highQuality" | "balanced"

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

Inherited from

TxtElementProps.textBreakStrategy

Defined in

node_modules/@types/react-native/index.d.ts:979

PreviousTextareaLinkPropsNextFieldsType

Last updated

Was this helpful?