Skip to main content

Interface: TextWidgetProps

Hierarchy​

Properties​

text​

• text: string

Text to show

style​

• Optional style: TextWidgetStyle

truncate​

• Optional truncate: "START" | "MIDDLE" | "END"

How to truncate the text if it cannot fit

maxLines​

• Optional maxLines: number

Maximum number of lines to if text overflows in next line

allowFontScaling​

• Optional allowFontScaling: boolean

Specifies whether fonts should scale to respect Text Size accessibility settings.

Default

true

clickAction​

• Optional clickAction: string

A string that will define an action that will be emited when clicking the widget.

There are a few special values for clickAction that will not emit the action, but will execute the action in the background.

Those are:

  • "OPEN_APP" - This clickAction does not require clickActionData, and if set on a section of the widget it will open the application when clicked
  • "OPEN_URI" - This clickAction requires a clickActionData that contains { uri: 'some-uri' }. The uri can be a web uri (https://google.com), or an app deep link (androidwidgetexample://deep-link) For the link to open a screen in the app deep linking must be set up

Inherited from​

ClickActionProps.clickAction

clickActionData​

• Optional clickActionData: Record<string, unknown>

Additional data that will be passed when the widget is clicked.

If clickAction is OPEN_URI it must contain { uri: 'some-uri' }

Inherited from​

ClickActionProps.clickActionData

accessibilityLabel​

• Optional accessibilityLabel: string

Accessibility label for screen readers. Can be set on the root component or any clickable component. When set on the root component, it applies to the entire widget. When set on a clickable component, it describes that specific clickable area.

Inherited from​

ClickActionProps.accessibilityLabel