jig.fullscreen

The jig.full-screen allows you to configure a component that covers the entire screen of the jig with no other elements visible. This is useful for creating a full screen of a location screen.

Considerations

This jig type does not allow for a description or header properties.
The location component can be used in the jig.full-screen.
When using an action within the jig, check that the action button does not overlap the fullscreen functionality. The best practice is not to use an action with the full-screen jig, as the action button covers elements shown in the full-screen.
Avoid using the home button with a web-view. This ensures that the web-view can make full use of the available screen space.
It is not recommended to use a full-screen jig in a composite jig, combining the fullscreen with another jig will not provide the optimal layout for the jig.

Configuration options

Some properties are common to all jig types, see Common jig type properties for a list and their configuration options.

The jig.full-screen can be configured in the following way in Jigx Builder.

Core structure

component

Select the component to display as a full-screen, the available components are:

component.chat
component.custom-component
component.location
component.web-view

title

Give the jig a title that is displayed at the top of the screen. If you do not want to show a title in a jig use title: ' '.

type

Select jig.full-screen

Examples and code snippets

Full-screen of a map

In this example the location to the Seattle Aquarium is shown in full screen using jig type jig.full-screen, component.location and Dynamic Data datasource called address.

Refer to the location component for additional location setup options.

Examples: See the full code sample using dynamic data in GitHub.

title: Aquarium Location
type: jig.full-screen

component:
  type: component.location
  options:
    viewPoint:
      address: 1483 Alaskan Way, Seattle, US
      zoomLevel: 15
    markers:
      data: [email protected]
      item:
        type: component.marker-item
        options:
          address: 1483 Alaskan Way, Seattle, US
          children:
            type: component.icon
            options:
              size: medium
              color: negative
              icon: end-marker

type: datasource.sqlite
options:
  provider: DATA_PROVIDER_DYNAMIC
  entities:
    - entity: default/location
  query: |
    SELECT
      '$.id',
      '$.address',
      '$.address-us',
      '$.category',  
      '$.lat',
      '$.lng',
      '$.city',
      '$.country',
      '$.street'
    FROM [default/location] WHERE '$.category' = "location"

Chatbot in a full-screen jig

See the chatbot with OpenAI example.

Good evening