Documentation

Web Item Target

Defines the way a web item link is opened in the browser, such as in a modal or inline dialog.

Example

{
  "target": {
    "type": "inlinedialog",
    "options": {
      "onHover": true,
      "offsetY": "20px",
      "offsetX": "30px"
    }
  }
}

Properties

options

Type
object
Description

An object containing options which vary based on the type of web item target you are implementing.

Inline Dialog Options
Name Type Description
onHover Boolean determines whether the inline-Dialog will show on a mouseOver or mouseClick of the trigger
showDelay Number | String determines how long in milliseconds after a show trigger is fired (such as a trigger click) until the dialog is shown
width Number | String sets how wide the inline-dialog is in pixels
offsetX Number | String sets an offset distance of the inline-dialog from the trigger element along the x-axis in pixels
offsetY Number | String sets an offset distance of the inline-dialog from the trigger element along the y-axis in pixels
isRelativeToMouse Boolean determines if the dialog should be shown relative to where the mouse is at the time of the event trigger (normally a click) if set to false the dialog will show aligned to the left of the trigger with the arrow showing at the center
closeOthers Boolean determines if all other dialogs on the screen are closed when this one is opened
onTop Boolean determines if the dialog should be shown above the trigger or not. If this option is true but there is insufficient room above the trigger the inline-dialog will be flipped to display below it
persistent Boolean this option, ignores the 'closeOthers' option

Expand

Dialog Options
Name Type Description
width Number | String sets how wide the inline-dialog is in pixels
height Number | String sets how high the inline-dialog is in pixels

Expand

type

Type
string
Defaults to
page
Allowed values
  • page
  • dialog
  • inlinedialog
    • Description

    Defines how the web-item content should be loaded by the page. By default, the web-item is loaded in the same page. The target can be set to open the web-item url as a modal dialog or an inline dialog.