Skip to main content
Feedback

Default legacy player options

warning

The content on this page is outdated and will not receive updates. For the most up-to-date feature, refer to Setting up and managing flows.

The default legacy player supports various options that allow you to modify the behaviour of the player. You can customize these options as required in a custom player.

The most commonly used options are covered below.

Collaboration

Defines whether the collaboration feature is enabled in a Flow using the player. Collaboration feature allows multiple users to co-browse a Flow in real-time.

collaboration: {
    isEnabled: false
    },

  • true: Enables collaboration feature for flows using the player.

  • false: This is the default setting. Collaboration feature is disabled.

Defines the behaviour of the player navigation components used in a Flow.

navigation: {
    isFixed: true,
    isWizard: false
    },

  • isFixed: This will 'pin' the navigation bar to the top of the browser window to maintain visibility.

    • true: This is the default setting. The navigation bar is fixed to the top of the browser window.

    • false: The navigation bar will not be fixed to the top of the browser window.

  • isWizard: This will render the navigation bar as a 'wizard'.

    • true: Any navigation bar in a Flow run using the player will be displayed as a 'wizard'. For example:

      Navigation bar wizard

    • false: This is the default setting. Navigation will be displayed as a normal Flow navigation bar.

ReplaceUrl

Defines the composition of the Flow url. For example, whether a Flow url remains as a Run url or has the Join url appended. Refer to System state values.

replaceUrl: true,

  • true: This is the default setting. This means that when a Flow is launched it will replace the Run url with a Join url to ensure that the same Flow state is used for the Flow.

  • false: Disable the Join url behaviour and launch a new Flow state each time; the Flow will use the Run url each time instead. This can be useful to create a more bookmark-friendly url as using the Flow url will always a launch a new copy of the Flow, rather than rejoining the Flow state.

Theme

Defines the theme that the player is based on. Themes provide a quick way of customising the appearance of a web application player without having to rebuild the application or apply custom CSS. Refer to Player themes.

theme: queryParameters['theme']

  • Remove the queryparameters[] string and simply reference the theme you wish to apply to the player. For example, change this to 'theme: 'slate'' to apply the 'slate' theme to any flows using the player.

  • Leaving this set to the default will allow the theme of the player to be modified using the Flow url.

On this Page