This is a lower-level API. Lower-level APIs are not recommended for most projects, and may not be available on all plans. See our page on recommended deployment patterns for more information.
Initialization Option Assess API

scroll_to_test

When enabled, this allows Assess API to scroll the page to the top of its assessment container when the session starts.

Note This feature is useful for long pages where the user may scroll past the assessment container, moving it out of focus.

Values

Request object key navigation.scroll_to_test

Default: true

This option can be initialized as one of the following types: boolean object.

  • Type boolean
    Enable scrolling to the top of the assessment container without any additional offset.
  • Type object
    • offset_top number

      Enable scrolling above top of the assessment container based on the offset.

      Note This setting is useful when having a custom header above the assessment container.

      Example: 10
Was this article helpful?