Instruqt Docs
  • 🚩Getting started
    • Overview
    • Setting up
      • Study Room
    • Quickstart
  • 🛤️Tracks
    • Manage tracks
      • Create tracks
      • Edit locally
      • Test tracks
      • Track logs
      • Track time limits
      • Track feedback
      • Developer workflow
      • Track tags
      • Track authors
      • Delete tracks
      • Custom layouts
      • Version control
      • Loading experience
    • Challenges
      • Create challenges
      • Challenge tabs
      • Challenge order
      • Skip challenges
      • Add quizzes
      • Assignment display
      • Assignment editor
    • Share tracks
      • Live Events
        • Instructor tools
      • Track invites
      • Embed tracks
      • Landing pages
  • 🏖️Sandboxes
    • Overview
    • Sandbox hosts
      • Add hosts
      • Custom VM images
      • Custom container images
      • Public images
      • Windows VMs
      • Website service
      • SSL certificates
    • Cloud accounts
      • Securing your cloud accounts
      • Cloud Client
      • AWS accounts
        • AWS Environment Variables
        • AWS Managed Policies
        • AWS IAM Policies
        • AWS SCP Policies
      • Azure subscriptions
        • Azure Environment Variables
        • Azure Roles
        • Azure Resource Providers
      • GCP projects
        • GCP Environment Variables
        • GCP IAM Permissions
    • Lifecycle scripts
      • Scripting overview
      • Track scripts
      • Challenge scripts
      • Example scripts
      • Helper scripts
    • UI Checks
    • Global Sandbox Settings
      • Hot start
      • Sandbox presets
      • Custom resources
      • Cloud services and regions
        • Allowed services and regions
    • Secrets and variables
      • Runtime variables
      • Runtime parameters
      • Secrets
  • ⚙️Settings
    • Integrations
      • Salesforce (Beta)
      • HubSpot (Beta)
      • HubSpot (Using zapier)
      • LTI
      • Version control
        • GitHub
    • Authentication
      • SSO
      • API keys
    • Platform
      • API
      • Webhooks
      • Track limits
  • 💡Reference
    • Feature overview
    • Instruqt CLI
      • Commands
      • Configuration files
      • Assets
    • Instruqt platform
      • Networking
      • Host machine types
      • Quotas and limits
      • Roles and permissions
      • Network access
      • Requirements
  • 🛟Resources
    • Content design tips
    • Advanced use cases
    • Templates
    • FAQ
      • Running Windows Client Hosts on Instruqt
      • Using Cleanup Scripts in SaaS and Cloud Environments
      • Instruqt Regional Configurations and Restrictions
      • Troubleshooting Instruqt CLI Authentication Issues
      • Copy a Track from One Organization to Another via CLI
      • Network Configuration: IP and MAC Address Control
      • Container Troubleshooting in Instruqt
Powered by GitBook
On this page
  • What are Custom Layouts
  • How to configure custom layouts
  • Themes

Was this helpful?

Edit on GitHub
  1. Tracks
  2. Manage tracks

Custom layouts

Learn how to enable, and customise your lab layouts and themes. Custom layouts help you create a tailored lab experience for your product.

PreviousDelete tracksNextVersion control

Last updated 6 months ago

Was this helpful?

Read the docs below or view this video to learn more about activating the new lab UI and how to create custom layouts for your challenges.

What are Custom Layouts

Custom layouts allow you to customise the tab panels of a lab for an entire play, or customise the layout of each individual challenge for a more tailored experience.

In the screen shot above, we show a lab with custom layouts enabled. Users entering the lab will all have this layout by default.

How to configure custom layouts

  1. You can create your custom layouts from the same Layout & Theming widget on the sidebar of a track dashboard.

  2. Click the Edit button next to the Layout label.

Choosing a layout for all challenges in your track.

  1. If you want to have the same, simple layout for your lab, simply enable on the Use track layout for all challenges toggle on the layout landing page. You now have useful default layouts that should easily fit most use cases.

  2. Save changes, and you're done! Your lab should now be using the default layout for each of your challenges.

Customising layouts for individual challenges.

  1. Select the challenge you want to customise and drag-and-drop tabs to your desired outcome.

  2. Save your changes, and you're done! The challenge should now be reflecting the specific layout you have designed for the challenge.

You can customise each challenge to best fit your product and how you design your content.

Customise the layout for the whole track

Open up your track.yml file, under the lab_config options you can configure the default_layout option, and toggle override_challenge_layout to true, configuring the layout for the entire lab.

# track.yml
...
lab_config:
  theme:
    name: modern-dark
  override_challenge_layout: false
  default_layout: AssignmentLeft
...

Layout API for lab_config

Field
Options
Description

theme.name

modern-dark or original

These two options are the only current themes available. A modern take on the Instruqt lab, and the classic original colour scheme.

override_challenge_layout

true or false

Tells Instruqt to use the default track layout for your lab. And overrides any custom layouts you have enabled for any challenge.

default_layout

AssignmentRight, AssignmentLeft, or AssignmentBottom

Selects which default layout you would like to have for a track.

Customise layout for an individual challenge

You can also manage the individual, custom layouts as code, by adding a serialised string.

# <challenge_slug>/assignment.md frontmatter block
...
lab_config:
  custom_layout: '{"root":{"children":[{"branch":{"children":[{"leaf":{"tabs":["assignment"],"activeTabId":"assignment","size":50}},{"leaf":{"tabs":["feedback"],"activeTabId":"feedback","size":50}}],"size":49}},{"leaf":{"tabs":["xpbbhgg2ilnm","vcly1o5zid56","jvcbfq9tblpa","zaw51ozikez1","dmyxy9cxga73"],"activeTabId":"xpbbhgg2ilnm","size":50}}],"orientation":"Horizontal"}}'
...

Themes

ModernDark
Original
  1. Enable New Lab UI for the track.

  2. In the Layout & Theming widget select between the ModernDark theme and the Original colour scheme. \

  3. The track will now use the selected theme for all plays.

Refer to the How to configure layouts and .

🛤️
check the API here
A lab set up with custom layouts.
The Layout configuration page.