For the complete documentation index, see llms.txt. This page is also available as Markdown.

jig-header

The jig-header component can be used in any type of jig. It serves as a container for specifying headers. It cannot be used without a component image, location, or video-player inside the component.

The images can be preloaded and cached using the asset folder's images file. The images will be displayed even when you are offline. For more details, refer to Assets.

Configuration options

Some properties are common to all components, see Common component properties for the properties and their configuration options.

Core structure

children

Specifies which component will be used inside the jig-header. There are several options:

height

Specifies the height of the header.

  • small

  • medium

  • tiny

isTitleVisible

Setting it to true hides the jig title. The default setting is true.

logo

Defines a custom logo image for the jig-header navigation bar. The image source uri of the logo can be either a remote URL or a local file resource. The currently supported formats are PNG, JPG, JPEG, BMP, GIF, WebP (Android only), and PSD (iOS only).

actions

Choose an action from the available list, such as go-to to open a different jig or open-url to navigate to a website. The selected action appears as a link in the top right corner of the header. Set the icon property in the action to display the action link as an icon instead of text. Styles of actions are inherited, for example, disabling the link. You can add multiple action links in the header, but ensure they accommodate the jig title and overall screen design. To prevent the jig title and header action links from overlapping while scrolling, use either one text action or up to three icon actions.

Considerations

  • Using the location component in the header can significantly increase memory usage and impact performance, particularly on Android devices.

  • If the address used in a location component is incorrect or incomplete, it may return the nearest estimated location instead of the intended one. This can mislead users and direct them to the wrong address.

  • You can display a hero-style header even when no child components are present, simply assign a height value to the header. If no height is provided, the header defaults to a compact size.

  • By default, the title is left-aligned. When no children are present and a header height is defined, the title shifts to center alignment.

Examples and code snippets

Jig-header with image

Header with image - tiny
Header with image - tiny
Header with image - small
Header with image - small
Header with image - medium
Header with image - medium

This example shows a component.jig-header with property children: component.image and the difference between the set heights.

Examples: See the code samples using static data in GitHub for tiny, small and medium headers.

Jig-header with height only (no children)

Jig-header with location

Location in header
Location in header

This example shows a component.jig-header with property children: component.location and the difference between the set heights. Refer to the location component for additional location setup options.

Examples: See the code samples using static data in GitHub for small and medium headers.

Jig-header with video-player

Small - header with video player
Small - header with video player
Medium - header with video player
Medium - header with video player

This example shows a component.jig-header with property children: component.video-player. and the difference between the set heights.

Examples: See the code samples using static data in GitHub for small and medium headers.

Jig header with an action
Jig header with an action

This example shows a component.jig-header configured with an action. The action displays as a link in the top right corner of the header. Ensure the action is visible and not obscured by the header image or video. The open-url action is configured to open the Jigx website.

Jig-header with multiple actions (icons)

Jig header with icon actions
Jig header with icon actions

This example demonstrates a component.jig-header configured with three open-url actions, displayed as icons in the top right corner of the header. Styling is applied to two of the icons to ensure visibility. Make sure the actions are not obscured by the header image/video or the jig title when scrolling. The open-url actions open various Jigx websites.

Jig-header actions without header children

In this example, we use the jig-header action to create two actions with icons: one to open an info-modal and another to go-to a different jig.

The jig-header has no children (such as an image, location, or video player), which allows for greater flexibility in the header.

Jig-header action
Jig-header action
Logo in jig-header
Company Logo in jig-header

In this example only the company logo is visible in the header of the jig. The logo property is configured in the jig-header and the jig title is hidden.

Examples: See the code samples in GitHub.

Jig-header with logo and title

In this example the company logo and title are visible in the header of the jig. The logo property is configured in the jig-header and the jig title is visible.

Examples: See the code samples in GitHub.

For the title to be visible with the logo ensure the height property is set to tiny.

Jig-header with logo and title
Jig-header with logo and title

Jig-header with logo, title and children (image)

Logo with title and background image in jig-header
Logo, title & background image in jig-header

In this example the company logo is visible in the header of the jig with a background image, and the title is visible.

Examples: See the code samples in GitHub.

Jig-header with logo and an action

In this example the company logo is visible in the header of the jig and an action button is configured to open an info-modal. The jig title is hidden.

Examples: See the code samples in GitHub.

Logo and action button in jig-header
Logo & action button in jig-header

Last updated

Was this helpful?