globals-shared

Sub Schemas

The schema defines the following additional types:

ColorCondition (object)

Properties of the ColorCondition object:

when (Expression | boolean, required)

The object must be any of the following types:

when (Expression)

color (primary | BasicColor | Expression, required)

The object must be any of the following types:

color (BasicColor)

color (Expression)

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

TextFieldType (enum<string>)

This element must be one of the following enum values:

• number
• string
• boolean
• email

DatePickerMode (enum<string>)

This element must be one of the following enum values:

• date
• time
• datetime

FieldType (TextFieldType | DatePickerMode | media | dropdown)

Type of field

The object must be any of the following types:

FieldType (TextFieldType)

FieldType (DatePickerMode)

SwipeableActionColor (primary | StatusColor)

The object must be any of the following types:

SwipeableActionColor (StatusColor)

StatusColor (enum<string>)

This element must be one of the following enum values:

• positive
• negative
• warning

SwipeableAction (object)

Swipeable actions used on jc-list-item

Properties of the SwipeableAction object:

icon (Nullable<IconName>)

Icon displayed on action

label (TextValue)

Label displayed on action

color (SwipeableActionColor)

Color of action

Default: "primary"

onPress (keg-action-in-background, required)

Action executed when pressed

Nullable<IconName> (icon-name | null)

The object must be any of the following types:

Nullable<IconName> (icon-name)

TextValue (string | Expression | TextWithFormat | TextLocale)

Text that can be evaluated, translated, formatted

The object must be any of the following types:

TextValue (Expression)

TextValue (TextWithFormat)

TextValue (TextLocale)

TextWithFormat (Text With Format)

Text that can be evaluated, translated, formatted

Properties of the TextWithFormat object:

text (string | Expression | TextLocale, required)

The object must be any of the following types:

text (Expression)

text (TextLocale)

format (TextFormatExpressions)

TextLocale (Text Locale)

Text that can be translated

Properties of the TextLocale object:

defaultMessage (string | Expression)

The object must be any of the following types:

defaultMessage (Expression)

values (TextLocaleValues)

TextLocaleValues (Primitive | Expression)

TextFormatExpressions (Date & Number Format)

Properties of the TextFormatExpressions object:

numberStyle (TextNumberStyle | Expression)

Is one of the values decimal, currency, percent or unit identifying the type of quantity being measured. See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/NumberFormat/NumberFormat

The object must be any of the following types:

numberStyle (TextNumberStyle)

numberStyle (Expression)

minimumIntegerDigits (number | Expression)

The minimum number of integer digits to use. Possible values are from 1 to 21; the default is 1. Numbers will be padded with leading zeroes if necessary.

The object must be any of the following types:

minimumIntegerDigits (Expression)

minimumFractionDigits (number | Expression)

A non-negative integer value indicating the minimum fraction digits to be used. Numbers will be rounded or padded with trailing zeroes if necessary.

The object must be any of the following types:

minimumFractionDigits (Expression)

maximumFractionDigits (number | Expression)

A non-negative integer value indicating the maximum fraction digits to be used. Numbers will be rounded or padded with trailing zeroes if necessary.

The object must be any of the following types:

maximumFractionDigits (Expression)

minimumSignificantDigits (number | Expression)

A positive integer value indicating the minimum fraction digits to be shown. If present, the formatter uses however many fraction digits are required to display the specified number of significant digits.

The object must be any of the following types:

minimumSignificantDigits (Expression)

maximumSignificantDigits (number | Expression)

A positive integer value indicating the maximum fraction digits to be shown. If present, the formatter uses however many fraction digits are required to display the specified number of significant digits.

The object must be any of the following types:

maximumSignificantDigits (Expression)

signDisplay (TextSignDisplay | Expression)

Is one of the values auto, always, never, or exceptZero, specifying whether to show the sign on negative numbers only, positive and negative numbers including zero, neither positive nor negative numbers, or positive and negative numbers but not zero. In scientific notation, this slot affects the sign display of the mantissa but not the exponent.

The object must be any of the following types:

signDisplay (TextSignDisplay)

signDisplay (Expression)

unit (NumberUnit | string | Expression)

The unit to use in unit formatting. Possible values are core unit identifiers, defined in UTS #35, Part 2, Section 6. Pairs of simple units can be concatenated with "-per-" to make a compound unit. There is no default value; if the style is unit, the unit property must be provided. See https://tc39.es/ecma402/#table-sanctioned-single-unit-identifiers

The object must be any of the following types:

unit (NumberUnit)

unit (Expression)

unitDisplay (TextUnitDisplay | Expression)

The unit formatting style to use in unit formatting, the defaults is short. Is one of the values short, narrow, or long, specifying whether to display the unit as a symbol, narrow symbol, or localized long name if formatting with the "unit" style. It is only used when numberStyle has the value "unit".

The object must be any of the following types:

unitDisplay (TextUnitDisplay)

unitDisplay (Expression)

numberingSystem (TextNumberingSystem | Expression)

Is a value with the "type" given in Unicode Technical Standard 35 for the numbering system used for formatting.

The object must be any of the following types:

numberingSystem (TextNumberingSystem)

numberingSystem (Expression)

currency (string | Expression)

Is a value with the currency code identifying the currency to be used if formatting with the "currency" unit type. It is only used when numberStyle has the value "currency".

The object must be any of the following types:

currency (Expression)

notation (TextNotation | Expression)

Is one of the values standard, scientific, engineering, or compact, specifying whether the number should be displayed without scaling, scaled to the units place with the power of ten in scientific notation, scaled to the nearest thousand with the power of ten in scientific notation, or scaled to the nearest locale-dependent compact decimal notation power of ten with the corresponding compact decimal notation affix.

The object must be any of the following types:

notation (TextNotation)

notation (Expression)

compactDisplay (TextCompactDisplay | Expression)

Only used when notation is "compact". Takes either short (default) or long. It is only used when notation has the value compact.

The object must be any of the following types:

compactDisplay (TextCompactDisplay)

compactDisplay (Expression)

currencyDisplay (TextCurrencyDisplay | Expression)

Is one of the values code, symbol, narrowSymbol or name, specifying whether to display the currency as an ISO 4217 alphabetic currency code, a localized currency symbol, or a localized currency name if formatting with the "currency" style. It is only used when numberStyle has the value currency.

The object must be any of the following types:

currencyDisplay (TextCurrencyDisplay)

currencyDisplay (Expression)

currencySign (TextCurrencySign | Expression)

Is one of the values standard or accounting, specifying whether to render negative numbers in accounting format, often signified by parenthesis. It is only used when numberStyle has the value currency and when signDisplay is not never.

The object must be any of the following types:

currencySign (TextCurrencySign)

currencySign (Expression)

dateFormat (TextDateFormat | Expression)

The object must be any of the following types:

dateFormat (TextDateFormat)

dateFormat (Expression)

NumberFormatExpressions (Number Format)

See https://tc39.es/ecma402/#sec-intl.numberformat.prototype.resolvedoptions

Properties of the NumberFormatExpressions object:

numberStyle (TextNumberStyle | Expression)

Is one of the values decimal, currency, percent or unit identifying the type of quantity being measured. See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/NumberFormat/NumberFormat

The object must be any of the following types:

numberStyle (TextNumberStyle)

numberStyle (Expression)

minimumIntegerDigits (number | Expression)

The minimum number of integer digits to use. Possible values are from 1 to 21; the default is 1. Numbers will be padded with leading zeroes if necessary.

The object must be any of the following types:

minimumIntegerDigits (Expression)

minimumFractionDigits (number | Expression)

A non-negative integer value indicating the minimum fraction digits to be used. Numbers will be rounded or padded with trailing zeroes if necessary.

The object must be any of the following types:

minimumFractionDigits (Expression)

maximumFractionDigits (number | Expression)

A non-negative integer value indicating the maximum fraction digits to be used. Numbers will be rounded or padded with trailing zeroes if necessary.

The object must be any of the following types:

maximumFractionDigits (Expression)

minimumSignificantDigits (number | Expression)

A positive integer value indicating the minimum fraction digits to be shown. If present, the formatter uses however many fraction digits are required to display the specified number of significant digits.

The object must be any of the following types:

minimumSignificantDigits (Expression)

maximumSignificantDigits (number | Expression)

A positive integer value indicating the maximum fraction digits to be shown. If present, the formatter uses however many fraction digits are required to display the specified number of significant digits.

The object must be any of the following types:

maximumSignificantDigits (Expression)

signDisplay (TextSignDisplay | Expression)

Is one of the values auto, always, never, or exceptZero, specifying whether to show the sign on negative numbers only, positive and negative numbers including zero, neither positive nor negative numbers, or positive and negative numbers but not zero. In scientific notation, this slot affects the sign display of the mantissa but not the exponent.

The object must be any of the following types:

signDisplay (TextSignDisplay)

signDisplay (Expression)

unit (NumberUnit | string | Expression)

The unit to use in unit formatting. Possible values are core unit identifiers, defined in UTS #35, Part 2, Section 6. Pairs of simple units can be concatenated with "-per-" to make a compound unit. There is no default value; if the style is unit, the unit property must be provided. See https://tc39.es/ecma402/#table-sanctioned-single-unit-identifiers

The object must be any of the following types:

unit (NumberUnit)

unit (Expression)

unitDisplay (TextUnitDisplay | Expression)

The unit formatting style to use in unit formatting, the defaults is short. Is one of the values short, narrow, or long, specifying whether to display the unit as a symbol, narrow symbol, or localized long name if formatting with the "unit" style. It is only used when numberStyle has the value "unit".

The object must be any of the following types:

unitDisplay (TextUnitDisplay)

unitDisplay (Expression)

numberingSystem (TextNumberingSystem | Expression)

Is a value with the "type" given in Unicode Technical Standard 35 for the numbering system used for formatting.

The object must be any of the following types:

numberingSystem (TextNumberingSystem)

numberingSystem (Expression)

currency (string | Expression)

Is a value with the currency code identifying the currency to be used if formatting with the "currency" unit type. It is only used when numberStyle has the value "currency".

The object must be any of the following types:

currency (Expression)

notation (TextNotation | Expression)

Is one of the values standard, scientific, engineering, or compact, specifying whether the number should be displayed without scaling, scaled to the units place with the power of ten in scientific notation, scaled to the nearest thousand with the power of ten in scientific notation, or scaled to the nearest locale-dependent compact decimal notation power of ten with the corresponding compact decimal notation affix.

The object must be any of the following types:

notation (TextNotation)

notation (Expression)

compactDisplay (TextCompactDisplay | Expression)

Only used when notation is "compact". Takes either short (default) or long. It is only used when notation has the value compact.

The object must be any of the following types:

compactDisplay (TextCompactDisplay)

compactDisplay (Expression)

currencyDisplay (TextCurrencyDisplay | Expression)

Is one of the values code, symbol, narrowSymbol or name, specifying whether to display the currency as an ISO 4217 alphabetic currency code, a localized currency symbol, or a localized currency name if formatting with the "currency" style. It is only used when numberStyle has the value currency.

The object must be any of the following types:

currencyDisplay (TextCurrencyDisplay)

currencyDisplay (Expression)

currencySign (TextCurrencySign | Expression)

Is one of the values standard or accounting, specifying whether to render negative numbers in accounting format, often signified by parenthesis. It is only used when numberStyle has the value currency and when signDisplay is not never.

The object must be any of the following types:

currencySign (TextCurrencySign)

currencySign (Expression)

TextNumberStyle (enum<string>)

The formatting style to use, the default is decimal.

This element must be one of the following enum values:

• decimal
• currency
• percent
• unit

TextSignDisplay (enum<string>)

When to display the sign for the number; defaults to "auto".

This element must be one of the following enum values:

• auto
• always
• never

NumberUnit (enum<string>)

The unit to use in unit formatting. Possible values are core unit identifiers, defined in UTS #35, Part 2, Section 6. Pairs of simple units can be concatenated with "-per-" to make a compound unit. There is no default value; if the style is unit, the unit property must be provided. See https://tc39.es/ecma402/#table-sanctioned-single-unit-identifiers

This element must be one of the following enum values:

• acre
• bit
• byte
• celsius
• centimeter
• day
• degree
• fahrenheit
• fluid-ounce
• foot
• gallon
• gigabit
• gigabyte
• gram
• hectare
• hour
• inch
• kilobit
• kilobyte
• kilogram
• kilometer
• liter
• megabit
• megabyte
• meter
• mile
• mile-scandinavian
• milliliter
• millimeter
• millisecond
• minute
• month
• ounce
• percent
• petabyte
• pound
• second
• stone
• terabit
• terabyte
• week
• yard
• year

TextUnitDisplay (enum<string>)

The unit formatting style to use in unit formatting, the default is short.

This element must be one of the following enum values:

• long
• short
• narrow

TextNumberingSystem (enum<string>)

This element must be one of the following enum values:

• arab
• arabext
• bali
• beng
• deva
• fullwide
• gujr
• guru
• hanidec
• khmr
• knda
• laoo
• latn
• limb
• mlym
• mong
• mymr
• orya
• tamldec
• telu
• thai
• tibt

TextNotation (enum<string>)

The formatting that should be displayed for the number, the default is standard

This element must be one of the following enum values:

• standard
• scientific
• engineering
• compact

TextCompactDisplay (enum<string>)

Only used when notation is compact. Takes either short (default) or long.

This element must be one of the following enum values:

• short
• long

TextCurrencyDisplay (enum<string>)

How to display the currency in currency formatting.

This element must be one of the following enum values:

• symbol
• code
• name
• narrowSymbol

TextCurrencySign (enum<string>)

In many locales, accounting format means to wrap the number with parentheses instead of appending a minus sign. You can enable this formatting by setting the currencySign option to "accounting". The default value is "standard".

This element must be one of the following enum values:

• standard
• accounting

TextDateFormat (string | )

The object must be any of the following types:

TextDateFormat

This element must be one of the following enum values:

• default
• fromNow
• toNow

KegInstanceId (InstanceId | Expression)

The object must be any of the following types:

KegInstanceId (InstanceId)

KegInstanceId (Expression)

Additional restrictions:

• Regex pattern: ^([a-zA-Z][a-zA-Z0-9_-]{0,48}[a-zA-Z0-9])|(=[\s]*[\S][\S\s]*)$

When (Expression | boolean)

If the property is set to 'false', the component won't be displayed. Default is 'true'.

The object must be any of the following types:

When (Expression)

ParameterExpressions (Expression | Primitive)

Named parameters with values or expressions

GoBackTo (enum<string>)

Specify where we go next.

This element must be one of the following enum values:

• previous
• home
• stay

Default: "previous"

IconElement (icon)

Properties of the IconElement object:

icon (icon-name | Expression, required)

Icon name/id

The object must be any of the following types:

icon (icon-name)

icon (Expression)

isContained (boolean | Expression)

Whether or not has background

The object must be any of the following types:

isContained (Expression)

isDuotone (boolean | Expression)

Displays background and icon in the same color

The object must be any of the following types:

isDuotone (Expression)

onPress (keg-action-in-background)

Action Keg component that will be triggered by pressing on this button.

NumberWithFormat (object)

Properties of the NumberWithFormat object:

value (number | Expression, required)

Value

The object must be any of the following types:

value (Expression)

format (NumberFormatExpressions)

Format of value

JigSummaryConfiguration (object)

Properties of the JigSummaryConfiguration object:

children (jc-summary, required)

Configuration of children

JigPlaceholders (object)

Properties of the JigPlaceholders object:

when (Expression | boolean)

Whether or not these placeholders are displayed on the screen / jig

The object must be any of the following types:

when (Expression)

title (TextValue, required)

Custom placeholder title

Default: "No data to display"

icon (PlaceholderIcon)

Define custom icon on placeholders

Default: "missing-data"

onPress (keg-action-on-button)

Define action that triggers after pressing placeholder button

PlaceholderIcon (enum<string>)

This element must be one of the following enum values:

• missing-data
• loading-data
• is-offline
• oil-drop
• helicopter
• scan-qr

JigBadgeValue (number | Expression | empty)

Value for badge:

• number: only integer number is displayed. When 0, no batch is displayed.
• Expression: see Expression details
• empty: display empty badge (red circle)

The object must be any of the following types:

JigBadgeValue (Expression)

JigBadge (object)

Display badge close to jig widget.

Properties of the JigBadge object:

when (Expression | boolean)

The object must be any of the following types:

when (Expression)

value (JigBadgeValue, required)

TextFormat (Date & Number Format)

Properties of the TextFormat object:

numberStyle (TextNumberStyle)

signDisplay (TextSignDisplay)

unit (NumberUnit)

unitDisplay (TextUnitDisplay)

numberingSystem (TextNumberingSystem)

notation (TextNotation)

compactDisplay (TextCompactDisplay)

currencyDisplay (TextCurrencyDisplay)

currencySign (TextCurrencySign)

dateFormat (TextDateFormat)

JigInputs (JigInputs | )