Application Configuration

Application configuration is described by next props:

config

The config object can have the following fields:

title

Starting with v2020.4

A string used as an application title.

Applied to: admin apps, user apps, all roles

renderOnInit

A Boolean value that indicates whether or not the application is to be rendered immediately after initialization.

Can be important for blind drop when the application is initialized but not rendered by default, because the app is not shown immediately on the page so rendering can be delayed.

Default value: false

Applied to: admin apps, user apps, all roles

unrenderOnHide

A Boolean value that indicates whether or not the application can be unrendered when hidden.
Used while switching between applications without closing them.
If specified as true, the application is able to restore its state.

Default value: false

Applied to: admin apps, user apps, all roles

isMultiInstance

A Boolean value that indicates whether or not the application can have multiple instances.

Default value: false

Applied to: admin apps, user apps, all roles

allowedContext

Starting with v2020.4

Describes what context application can open. See for detail Application Allowed Context.

Default value: none

NOTE: Before 2022.3 default value for allowedContext - all

inspectorConfig

Allows to configure the Asset Inspector.

Applied to: Core apps that are displayed in the main layout zone

  • tabs
    Additional tabs description for the Asset Inspector when an app is opened

Example:

{
    inspectorConfig:
    {
        tabs: [{
            name: "company-project-tab-name",
            order: 0,
            type:"avid-nux-search-app.search-result-details-pane"
        }]
    }
}

Each tab config has to contain the following properties:

  • name:
    string, tab name
  • order:
    number, is used for tab positioning in the Asset Tab Container
  • type:
    string, view type

breakpoints

Configuration for the adaptive layout.
Each breakpoint value is the minimum width of the application
(dom element offsetWidth) with a specified CSS attribute.
Using the specified CSS attribute you can set different layout settings.

List of existing properties:
- medium
- wide
- wider
- extrawide
- narrow

Example:

breakpoints: {
0: ‘narrow’,
705: ‘medium’,
945: ‘wide’,
1350: ‘extrawide’,
}

hides the left panel on narrow screens:

  :global([data-app-mode='narrow']) {
    .left-panel {
      min-width: 0px;
      width: 0;
      animation-duration: 0.1s;
      animation-name: slideout;
      animation-fill-mode: forwards;
    }
  }

Applied to: admin apps, user apps, all roles

rightZone

A Boolean value that indicates whether or not the application is located in the right zone.
If the rightZone value is true, no dock/undock button is shown.

Applied to: user apps, defines if an app is a Right Zone app

Allows configuring how the app menu is constructed.
Currently allows to specify a view that provides a menu for the application. When clicking the app menu button, the menu from the specific view within that application is shown. To do so, specify the view property with a value that is either the view type or label of the corresponding view.

Example:

1
2
3
menu: {
  view: 'avid-nux-dashboard',
}

Applied to: admin apps, user apps, all roles

inspector

NOTE: This prop is deprecated, removed in 2020.4

NOTE: Starting with v2020.4, apps configuration does not affect if Asset Editor is undocked/docked initially.

A Boolean value that indicates if the inspector is undocked/docked alongside the app.
If hideInspector is set to true, the inspectorConfig property is not applied.

Applied to: Core apps that are displayed in the main layout zone

hideInspector

NOTE: This prop is deprecated, removed in 2022.3

Warning. This application property is deprecated. Starting with v2020.4, Asset Editor (inspector) is always visible.

A Boolean value that indicates whether or not the inspector is completely hidden in the layout when the app is in the main zone.

Applied to: Core apps that are displayed in the main layout zone

dockable

NOTE: This prop is deprecated, removed in 2022.3

Warning. This application property is deprecated. Starting with v2020.4, the dockable property is defined by application role.
If application is in the main or in the docked layout zone, then application can be docked (dock/undock button is shown).

A Boolean value that indicates whether or not the application can be docked.
If the dockable value is false, the application cannot be dragged to the docked zone, no dock/undock button is shown.

Applied to: user apps, defines if an app is a Core app

Configures the look and behavior of the icon in the Fast Bar.

Applied to: admin apps, user apps, all roles

The menuIcon object must have the following fields:

  • icon

Specify icon in your application configuration as utf-8 encoded string or base-64 encoding:

icon: "data:image/svg+xml,%3C?xml version='1.0' ...";
  • gradient

CSS gradient colors that are associated with the app or menu icon, e.g. ['#433ede', '#2a5cf5'].

  • color

CSS color that is associated with the app (deprecated), e.g. 'rgb(232, 108, 49)' or '#AABBCC'.

  • group

An integer value for grouping several applications in the menu.
Applications with the same group value are in one group.
Groups are sorted in ascending order.
Groups with values less than 0 are located on the right side of the menu.

  • orderInGroup

An integer value for sorting application icons inside the group.

  • title

NOTE: Deprecated starting with v2020.2. Use config > title instead.

A string used as an application title.

NOTE: This prop is deprecated, removed in 2022.3

The header object can have the following fields:

  • hideIcon

A Boolean value used for hiding an app icon.

  • hideClose

A Boolean value used for hiding an app close button.

  • headerClass

A string used as a custom className for the header element to provide styling.