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-entity-field

26min

The schema defines the following properties:

Property

Type

Required

Description

type

component.entity-field

true



instanceId

InstanceId | Expression

false



when

Expression | boolean

false



options

Entity Field Options

true



instanceId (InstanceId | Expression)

when (Expression | boolean)

options (Entity Field Options, required)

Properties of the options object:

Property

Type

Required

Description

label

string | Expression | TextWithFormat | TextLocale

true

Label of field

value

string | Expression | TextWithFormat | TextLocale | boolean

true

Value of field

isMultiline

boolean | string

false

If true, the field can span multiple lines. The default value is false.

contentType

EntityFieldType

false

Type of visual and behaviour of entity field

href

string | Expression | TextWithFormat | TextLocale

false

Eg. Full length url when contentType is link.

rightIcon

icon-name | string

false

Optional custom right icon

isRightIconHidden

boolean | string

false

If true, right icon will be hidden

isHidden

boolean | string

false

If true it will be hidden to user. This is useful

isTrackingTransparencyRequired

boolean | string

false

If TRUE tracking transparency permission modal will be shown before opening the url. Default TRUE

style

object

false



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

Label of field

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

Value of field

The object must be any of the following types:

value (string | Expression | TextWithFormat | TextLocale)

isMultiline (boolean | string)

If true, the field can span multiple lines. The default value is false.

The object must be any of the following types:

isMultiline (string)

Default: false

contentType (EntityFieldType)

Type of visual and behaviour of entity field

href (string | Expression | TextWithFormat | TextLocale)

Eg. Full length url when contentType is link.

rightIcon (icon-name | string)

Optional custom right icon

The object must be any of the following types:

rightIcon (icon-name)

rightIcon (string)

isRightIconHidden (boolean | string)

If true, right icon will be hidden

The object must be any of the following types:

isRightIconHidden (string)

isHidden (boolean | string)

If true it will be hidden to user. This is useful

The object must be any of the following types:

isHidden (string)

isTrackingTransparencyRequired (boolean | string)

If TRUE tracking transparency permission modal will be shown before opening the url. Default TRUE

The object must be any of the following types:

isTrackingTransparencyRequired (string)

style (object)

Properties of the style object:

Property

Type

Required

Description

isPrimary

boolean | string

false

Will overwrite component color with "isPrimary" theme

isNegative

boolean | string

false

Will overwrite component color with "isError" theme

isPositive

boolean | string

false

Will overwrite component color with "isPositive" theme

isWarning

boolean | string

false

Will overwrite component color with "isWarning" theme

isPrimary (boolean | string)

Will overwrite component color with "isPrimary" theme

The object must be any of the following types:

isPrimary (string)

Default: false

isNegative (boolean | string)

Will overwrite component color with "isError" theme

The object must be any of the following types:

isNegative (string)

Default: false

isPositive (boolean | string)

Will overwrite component color with "isPositive" theme

The object must be any of the following types:

isPositive (string)

Default: false

isWarning (boolean | string)

Will overwrite component color with "isWarning" theme

The object must be any of the following types:

isWarning (string)

Default: false



Sub Schemas

The schema defines the following additional types:

EntityFieldType (enum<string>)

This element must be one of the following enum values:

  • default
  • phone
  • email
  • date
  • time
  • link
  • copy
  • signature
  • checkbox

IconType (enum<string>)

This element must be one of the following enum values:

  • light
  • multicolor
  • solid
  • brand
  • flag



Updated 25 Sep 2023
Did this page help you?
PREVIOUS
jc-email-field
NEXT
jc-entity
Docs powered by
Archbee
TABLE OF CONTENTS
instanceId (InstanceId | Expression)
when (Expression | boolean)
options (Entity Field Options, required)
label (string | Expression | TextWithFormat | TextLocale, required)
value (string | Expression | TextWithFormat | TextLocale | boolean, required)
value (string | Expression | TextWithFormat | TextLocale)
isMultiline (boolean | string)
isMultiline (string)
contentType (EntityFieldType)
href (string | Expression | TextWithFormat | TextLocale)
rightIcon (icon-name | string)
rightIcon (icon-name)
rightIcon (string)
isRightIconHidden (boolean | string)
isRightIconHidden (string)
isHidden (boolean | string)
isHidden (string)
isTrackingTransparencyRequired (boolean | string)
isTrackingTransparencyRequired (string)
style (object)
isPrimary (boolean | string)
isPrimary (string)
isNegative (boolean | string)
isNegative (string)
isPositive (boolean | string)
isPositive (string)
isWarning (boolean | string)
isWarning (string)
Sub Schemas
EntityFieldType (enum<string>)
IconType (enum<string>)
Docs powered by
Archbee
Copyright © 2023 Jigx, Inc. All rights reserved. Terms of Service