website logo
👥 Community🎯 Samples on GitHub🚦 System Status
💡 Guides
🚀 Examples
🍕 Developer Reference
⚡️ Changelog
🎥 Video Library
Navigate through spaces
⌘K
Overview
Reference
Actions
Data
UI
Widgets
Docs powered by
Archbee
Reference
UI

jc-text

22min

Text component used mostly in custom components

The schema defines the following properties:

Property

Type

Required

Description

type

component.text

true



instanceId

InstanceId | Expression

false



when

Expression | boolean

false



options

Text Options

true



instanceId (InstanceId | Expression)

when (Expression | boolean)

options (Text Options, required)

Properties of the options object:

Property

Type

Required

Description

value

string | Expression | TextWithFormat | TextLocale

true

Value of the text

align

TextAlign | string

false

Alignment of the text

size

tiny | small | regular | medium | large | extra-large | string

false

Size of the text with predefined values or expression

weight

extra-light | light | regular | semi-bold | bold | extra-bold | string

false

Weight of the text

color

ColorOrConditionalColor

false

Define color of text or color based on conditions. First evaluated to true will be used.

emphasis

extra-low | low | low-medium | medium | high | string

false

Change opacity of text

numberOfLines

number | string

false

Will limit maximum of lines rendered

decoration

underline | line-through | string

false

Text decoration (underline, line-through) or expression

onPress

keg-action-in-background

false

Action that will be triggered by pressing on this component.

value (string | Expression | TextWithFormat | TextLocale, required)

Value of the text

align (TextAlign | string)

Alignment of the text

The object must be any of the following types:

align (TextAlign)

align (string)

size (tiny | small | regular | medium | large | extra-large | string)

Size of the text with predefined values or expression

The object must be any of the following types:

size (string)

weight (extra-light | light | regular | semi-bold | bold | extra-bold | string)

Weight of the text

The object must be any of the following types:

weight (string)

color (ColorOrConditionalColor)

Define color of text or color based on conditions. First evaluated to true will be used.

emphasis (extra-low | low | low-medium | medium | high | string)

Change opacity of text

The object must be any of the following types:

emphasis (string)

numberOfLines (number | string)

Will limit maximum of lines rendered

The object must be any of the following types:

numberOfLines (string)

decoration (underline | line-through | string)

Text decoration (underline, line-through) or expression

The object must be any of the following types:

decoration (string)

onPress (keg-action-in-background)

Action that will be triggered by pressing on this component.



Sub Schemas

The schema defines the following additional types:

TextAlign (enum<string>)

This element must be one of the following enum values:

  • left
  • right
  • center

ColorOrConditionalColor (primary | BasicColor | string | object[])

The object must be any of the following types:

ColorOrConditionalColor (BasicColor)

ColorOrConditionalColor (string)

ColorOrConditionalColor (object[])

The object is an array with all elements of the type object.

The array object has the following properties:

BasicColor (enum<string>)

This element must be one of the following enum values:

  • color1
  • color2
  • color3
  • color4
  • color5
  • color6
  • color7
  • color8
  • color9
  • color10
  • color11
  • color12
  • color13
  • color14



Updated 25 Sep 2023
Did this page help you?
PREVIOUS
jc-text-field
NEXT
jc-titles
Docs powered by
Archbee
TABLE OF CONTENTS
instanceId (InstanceId | Expression)
when (Expression | boolean)
options (Text Options, required)
value (string | Expression | TextWithFormat | TextLocale, required)
align (TextAlign | string)
align (TextAlign)
align (string)
size (tiny | small | regular | medium | large | extra-large | string)
size (string)
weight (extra-light | light | regular | semi-bold | bold | extra-bold | string)
weight (string)
color (ColorOrConditionalColor)
emphasis (extra-low | low | low-medium | medium | high | string)
emphasis (string)
numberOfLines (number | string)
numberOfLines (string)
decoration (underline | line-through | string)
decoration (string)
onPress (keg-action-in-background)
Sub Schemas
TextAlign (enum<string>)
ColorOrConditionalColor (primary | BasicColor | string | object[])
ColorOrConditionalColor (BasicColor)
ColorOrConditionalColor (string)
ColorOrConditionalColor (object[])
BasicColor (enum<string>)
Docs powered by
Archbee
Copyright © 2023 Jigx, Inc. All rights reserved. Terms of Service