jc-icon

Icon component used mostly in custom components

The schema defines the following properties:

instanceId (InstanceId | Expression)

when (Expression | boolean)

options (Icon Options, required)

Properties of the options object:

icon (icon-name | string, required)

Name of the icon

The object must be any of the following types:

icon (icon-name)

icon (string)

color (ColorOrConditionalColor)

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

emphasis (EmphasisDefinition)

Change opacity of icon

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

Size of the icon with predefined values or expression

The object must be any of the following types:

size (string)

Default: 24

type (basic | contained | duotone | string)

Type of the icon design

The object must be any of the following types:

type (string)

Default: "basic"

shape (circle | rounded | square | string)

Shape of the icon

The object must be any of the following types:

shape (string)

Default: "rounded"

onPress (keg-action-in-background)

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

Sub Schemas

The schema defines the following additional types:

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

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

The object must be any of the following types:

EmphasisDefinition (string)