Website logo
✅ Sign up👥 Community🎯 Samples on GitHub🚦 System Status
💡 Guides
🚀 Examples
🍕 Developer Reference
⚡️ Changelog
🎥 Video Library
Navigate through spaces
⌘K
Welcome to Jigx Documentation
Getting started
Creating an account
Install the Jigx Builder
Use templates to create apps
Create an app from scratch
Use pre-built solutions
Planning your app
Understanding the basics
Jigx Overview
Jigx Concepts
Authentication
Jigx color palette
Jigx icons
Building Apps with Jigx
Jigx Builder Overview
Install
Settings
Editor
Create a new Jigx Solution
Publishing a solution
Debugging
Home Hub Experience
Index settings
Templates
Inputs & Outputs
Forms
Data
Expressions
Advanced Expressions
Expressions - cheatsheet
Notifications
Stories
Localization
Tips, tricks and shortcuts
Administration
Management Overview
Permissions - User Roles
Users
Solutions
Notifications
Organization Settings
Troubleshooting (Organization)
Quick Start
My profile
Docs powered by Archbee
Building Apps with Jigx

Index settings

10min

In the index.jigx file you set many important solution settings, including the main information about the solution, the home hub set up, and properties reusable throughout the solution.

Name, title, category, description

  • Name - Your internal solution name
  • Title - This name displays in your app, and Management
  • Category - A predefined list of solution categories to choose from
  • Description - A description you provide for your solution
index.jigx
title: jigx-samples
name: jigx-samples
category: personal
description: All examples found on docs.jigx.com can be experienced in this comprehensive sample solution


Widgets, home, stories

Widgets, home, and stories are properties used to build your home hub.

index.jigx
stories:
  - story-group-video
  - story-group-image
  
home:
  - instanceId: home-jig
    jigId: home-jig

widgets: 
  - size: 2x2
    jigId: widget
  - size: 1x1
    jigId: small-widget


For more details please refer to the Home Hub Experience.

OnLoad, OnFocus, OnRefresh

These properties allow you to configure Actions executed in various scenarios.

  • OnLoad - when the jig loads for the first time
  • OnFocus - when the jig receives focus
  • OnRefresh - when the jig refreshes
index.jigx (onLoad)
index.jigx (onFocus)
index.jigx (onRefresh)
onLoad: 
  type: action.set-state
  options:
    state: =@ctx.solution.state.loginTimestamp
    value: =$now()


Assets

Image assets in solutions

The assets property preloads and caches the images when the solution downloads or updates. This allows the images to display when the app is offline. Every item in assets needs to start with one of the following:

  • http:
  • https:
  • ftp:
  • file:
  • content:
  • res:
  • android.resources:
  • data:image/png;base64
  • data:image/jpeg;base64
index.jigx
assets:
  images:
    - "https://google.com/image.png"
    - "https://google.com/image1.jpeg"


Icon assets in solutions

All icons used throughout a solution are automatically added to the index.jigx file as assets. This improves performance of the app and ensures that all icons are available when the mobile device is offline and the app is in use.

The following applies to the asset list:

  • Each icon change detection automatically causes an update of the assets: icon: list in the index.jigx file.
  • All icons from all  files are added to the asset list, expect icons referenced or listed within datasources e.g., =@ctx.datasources.ds.icon. You can manually add these icons to the asset list in the index.jigx file.
  • Icons are added to the asset list automatically or you can manually add icons to the list.
    • Automatically generated icons are indicated by a comment # auto-generated after the icon name in the list
    • Manually added icons do not have the comment added
Icon asset list in index.jigx
Icon asset list in index.jigx


Expressions

Use the expressions property to set expressions that are reusable throughout the solution.

index.jigx
jig.jigx
expressions:
  user: =@ctx.user.displayName
  timezone: =@ctx.system.timezone.name
  altitude: =@ctx.system.geolocation.coords.altitude


For more details and examples refer to the Shared Expressions section in Expressions.

Dependencies

In the dependencies property, you can define the mobile app build version compatible with the YAML configuration.

If the current mobile app build version does not meet the criteria, the 'Out of date' screen will appear (displayed on the right ), with a message that an update is required. Tapping the Update button redirects you to your app settings to update the version of the app.





index.jigx
dependencies:
  mobileApp: '>1.0.0'




Out of date app screen
Out of date app screen






Updated 02 Nov 2023
Did this page help you?
PREVIOUS
Home Hub Experience
NEXT
Templates
Docs powered by Archbee
TABLE OF CONTENTS
Name, title, category, description
Widgets, home, stories
OnLoad, OnFocus, OnRefresh
Assets
Image assets in solutions
Icon assets in solutions
Expressions
Dependencies
Docs powered by Archbee
Copyright © 2023 Jigx, Inc. All rights reserved. Terms of Service