API Docs for:
Show:

IframeStep Class

Extends Widget
Defined in: iframe-step.js:48
Module: iframe-step

The IframeStep provides a widget for browsing among iframes.

Constructor

IframeStep

(
  • config
)

Defined in iframe-step.js:48

Parameters:

  • config Object

    Configuration options for the widget

Methods

_afterOffsetChange

(
  • e
)
private

Defined in iframe-step.js:163

Handles offsetChange event. It deals with CSS classes on boundingBox.

Parameters:

  • e Y.Event

    Event instance.

_uiSetOffset

(
  • offset
)
private

Defined in iframe-step.js:120

Updates UI according to provided offset.

Parameters:

  • offset Number

    The frame offset.

_validateOffset

() Boolean private

Defined in iframe-step.js:179

Validates if the provided offset is valid.

Returns:

Boolean: false if it's illegal.

bindUI

() protected

Defined in iframe-step.js:223

Binds button interaction.

move

(
  • offset
)
public

Defined in iframe-step.js:259

Switches to specific item.

Parameters:

  • offset Boolean | Number

    true if it switches to next iframe. false if it switches to previous iframe. You can also provide a number of offset to show a specific frame.

next

() public

Defined in iframe-step.js:281

Moves to next item.

prev

() public

Defined in iframe-step.js:292

Moves to previous item.

renderUI

() protected

Defined in iframe-step.js:201

Creates the DOM structure for the IframeStep.

syncUI

() protected

Defined in iframe-step.js:244

Synchronizes the DOM state with the attribute settings.

Attributes

frames

Object

Defined in iframe-step.js:62

Frames data collection.

offset

Number

Defined in iframe-step.js:72

Current offset.

Default: 0

offset

Number readonly

Defined in iframe-step.js:86

The amount of iframes.