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
Widgets

jw-status

18min

The schema defines the following properties:

Property

Type

Required

Description

type

widget.status

true



instanceId

InstanceId | Expression

false



options

Status Widget Options

true



instanceId (InstanceId | Expression)

options (Status Widget Options, required)

Properties of the options object:

Property

Type

Required

Description

footer

string | Expression | TextWithFormat | TextLocale

false

Footer text of widget

footerAlign

enum<string>

false

Footer text align

placeholders

object[]

false

Widget specific placeholders config

statuses

StatusCondition[]

true

Define at least one or more statuses based on conditions. First evaluated to true will be used.

footer (string | Expression | TextWithFormat | TextLocale)

Footer text of widget

footerAlign (enum<string>)

Footer text align

This element must be one of the following enum values:

  • left
  • right
  • center

placeholders (object[])

Widget specific placeholders config

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

The array object has the following properties:

statuses (StatusCondition[], required)

Define at least one or more statuses based on conditions. First evaluated to true will be used.

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



Sub Schemas

The schema defines the following additional types:

StatusCondition (object)

Status Condition

Properties of the StatusCondition object:

Property

Type

Required

Description

when

string | boolean

true



color

primary | StatusColor | BasicColor

false

Color of icon

icon

icon-name

true

Define icon of status

top

jc-titles

false

Top part of widget

bottom

jc-titles

false

Bottom part of widget

when (string | boolean, required)

The object must be any of the following types:

when (string)

color (primary | StatusColor | BasicColor)

Color of icon

The object must be any of the following types:

color (StatusColor)

color (BasicColor)

Default: "primary"

icon (icon-name, required)

Define icon of status

top (jc-titles)

Top part of widget

bottom (jc-titles)

Bottom part of widget

StatusColor (enum<string>)

This element must be one of the following enum values:

  • positive
  • negative
  • warning

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
jw-location
NEXT
jw-value
Docs powered by
Archbee
TABLE OF CONTENTS
instanceId (InstanceId | Expression)
options (Status Widget Options, required)
footer (string | Expression | TextWithFormat | TextLocale)
footerAlign (enum<string>)
placeholders (object[])
statuses (StatusCondition[], required)
Sub Schemas
StatusCondition (object)
when (string | boolean, required)
when (string)
color (primary | StatusColor | BasicColor)
color (StatusColor)
color (BasicColor)
icon (icon-name, required)
top (jc-titles)
bottom (jc-titles)
StatusColor (enum<string>)
BasicColor (enum<string>)
Docs powered by
Archbee
Copyright © 2023 Jigx, Inc. All rights reserved. Terms of Service