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-button

18min

Button component used in custom components.

The schema defines the following properties:

Property

Type

Required

Description

type

component.button

true



instanceId

InstanceId | Expression

false



when

Expression | boolean

false



options

Button Options

true



instanceId (InstanceId | Expression)

when (Expression | boolean)

options (Button Options, required)

Properties of the options object:

Property

Type

Required

Description

title

string | Expression | TextWithFormat | TextLocale

true



isCompact

boolean | string

false

If the button should be compact.

type

primary | secondary | tertiary | string

false

Predefined button style

onPress

keg-action-in-background

false

Action that will be triggered by pressing on this component.

icon

Icon

false

Icon to be displayed on the left side or right side of the button.

style

Style

false

Style of the button. More of them can be true. It will be evaluated based on priority.

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

isCompact (boolean | string)

If the button should be compact.

The object must be any of the following types:

isCompact (string)

type (primary | secondary | tertiary | string)

Predefined button style

The object must be any of the following types:

type (string)

onPress (keg-action-in-background)

Action that will be triggered by pressing on this component.

icon (Icon)

Icon to be displayed on the left side or right side of the button.

Properties of the icon object:

Property

Type

Required

Description

left

icon-name | string

false



right

icon-name | string

false



left (icon-name | string)

The object must be any of the following types:

left (icon-name)

left (string)

right (icon-name | string)

The object must be any of the following types:

right (icon-name)

right (string)

style (Style)

Style of the button. More of them can be true. It will be evaluated based on priority.

Properties of the style object:

Property

Type

Required

Description

isDisabled

boolean | string

false

Change style to disable. User can't do anything with button when disabled.

isBusy

boolean | string

false

Displays spinner on button.

isDisabled (boolean | string)

Change style to disable. User can't do anything with button when disabled.

The object must be any of the following types:

isDisabled (string)

isBusy (boolean | string)

Displays spinner on button.

The object must be any of the following types:

isBusy (string)



Updated 25 Sep 2023
Did this page help you?
PREVIOUS
jc-bar-chart
NEXT
jc-card
Docs powered by
Archbee
TABLE OF CONTENTS
instanceId (InstanceId | Expression)
when (Expression | boolean)
options (Button Options, required)
title (string | Expression | TextWithFormat | TextLocale, required)
isCompact (boolean | string)
isCompact (string)
type (primary | secondary | tertiary | string)
type (string)
onPress (keg-action-in-background)
icon (Icon)
left (icon-name | string)
left (icon-name)
left (string)
right (icon-name | string)
right (icon-name)
right (string)
style (Style)
isDisabled (boolean | string)
isDisabled (string)
isBusy (boolean | string)
isBusy (string)
Docs powered by
Archbee
Copyright © 2023 Jigx, Inc. All rights reserved. Terms of Service