div-tooltip

Tooltip.

Parameters

Parameters Description
div

object

Required parameter.

An element that will be shown in a tooltip. If there are tooltips inside an element, they won't be shown.

The value has the type div.

Available platforms: Android, iOS, web.

List of possible values:

  • div-image
  • div-gif-image
  • div-text
  • div-separator
  • div-container
  • div-grid
  • div-gallery
  • div-pager
  • div-tabs
  • div-state
  • div-custom
  • div-indicator
  • div-slider
  • div-switch
  • div-input
  • div-select
  • div-video
  • id

    string

    Required parameter.

    Tooltip ID. It is used to avoid re-showing. It must be unique for all element tooltips.

    Available platforms: Android, iOS, web.

    position

    string

    Required parameter.

    The position of a tooltip relative to an element it belongs to.

    Possible values: left, top-left, top, top-right, right, bottom-right, bottom, bottom-left, center.

    Available platforms: Android, iOS, web.

    animation_in

    object

    Tooltip appearance animation. By default, the tooltip will be appearing gradually with an offset from the anchor point by 10 dp.

    The value has the type div-animation.

    Available platforms: Android, web.

    animation_out

    object

    Tooltip disappearance animation. By default, the tooltip will disappear gradually with an offset from the anchor point by 10 dp.

    The value has the type div-animation.

    Available platforms: Android, web.

    close_by_tap_outside

    bool

    Allows dismissing tooltip by tapping outside of it.

    Default value: true.

    Available platforms: iOS.

    duration

    int

    Duration of the tooltip visibility in milliseconds. When the value is set to 0, the tooltip will be visible until the user hides it.

    Restriction for the value x: x >= 0.

    Default value: 5000.

    Available platforms: Android, iOS, web.

    mode

    object

    Tooltip modes.

    The value has the type div-tooltip-mode.

    Default value: { "type": "modal" }.

    Functionality is under development.

    List of possible values:

  • div-tooltip-mode-non-modal
  • div-tooltip-mode-modal
  • offset

    object

    Shift relative to an anchor point.

    The value has the type div-point.

    Available platforms: Android, iOS, web.

    tap_outside_actions

    array

    Specifies actions triggered by tapping outside the tooltip.

    Available platforms: iOS.

    JSON
    {
      animation_in: {
        duration: "int",
        end_value: "number",
        interpolator: "string",
        items: [ div-animation, ... ],
        name*: "string",
        repeat: div-count,
        start_delay: "int",
        start_value: "number"
      },
      animation_out: {
        duration: "int",
        end_value: "number",
        interpolator: "string",
        items: [ div-animation, ... ],
        name*: "string",
        repeat: div-count,
        start_delay: "int",
        start_value: "number"
      },
      close_by_tap_outside: "bool",
      div*: div,
      duration: "int",
      id*: "string",
      mode: div-tooltip-mode,
      offset: {
        x*: {
          unit: "string",
          value*: "number"
        },
        y*: {
          unit: "string",
          value*: "number"
        }
      },
      position*: "string",
      tap_outside_actions: [
        {
          download_callbacks: {
            on_fail_actions: [ div-action, ... ],
            on_success_actions: [ div-action, ... ]
          },
          is_enabled: "bool_int",
          log_id*: "string",
          log_url: "string",
          menu_items: [
            {
              action: div-action,
              actions: [ div-action, ... ],
              text*: "string"
            },
            ...
          ],
          payload: "object",
          referer: "string",
          scope_id: "string",
          target: "string",
          typed: div-action-typed,
          url: "string"
        },
        ...
      ]
    }
    
    Previous