JSDoc: o-stepped-progress

event:"oShare.open"

Type: object

The `oShare.open` open event fires when a social network share action is triggered, to open a new window.

Links

• ""oShare.open"" event on Github

event:"oShare.ready"

Type: object

The `oShare.ready` fires when a o-share instance has been initialised.

Links

• ""oShare.ready"" event on Github

new Share(rootEl)

Methods

• init - (inner) Initialises the Share class, rendering the o-share element if it's empty with [config](#config) options, or from corresponding data attributes and sets up dom-delegates. Dispatches 'oShare.ready' at the end
• destroy - (instance) Destroys the Share instance, disables dom-delegates
• init(rootEl) - (static) Initialises all o-share components inside the element passed as the first parameter

Links

• "Share" class on Github

new SteppedProgressStep(stepElement, parent)

Represents a step in a stepped progress component.

Class constructor.

Methods

• isComplete - (instance) Get whether the step has the "complete" state.
• isCurrent - (instance) Get whether the step has the "current" state.
• isError - (instance) Get whether the step has the "error" state.
• isFuture - (instance) Get whether the step has no explicit state (and so is a future step).
• markAsComplete - (instance) Set the step's state to "complete".
• markAsCurrent - (instance) Set the step's state to "current".
• markAsError - (instance) Set the step's state to "error".
• markAsFuture - (instance) Remove all states from the step (marking it as a future step).

Links

• "SteppedProgressStep" class on Github

new SteppedProgress(steppedProgressElement, options)

Represents a stepped progress component.

Class constructor.

Methods

• getSteps - (instance) Get an array of steps.
• getCompletedSteps - (instance) Get an array of steps with a "completed" status.
• hasStepAtIndex(index) - (instance) Get whether a step exists at a given index (0-based).
• getStepAtIndex(index) - (instance) Get the step at a given index (0-based).
• getCurrentStep - (instance) Get the step which has the "current" state. If there are multiple steps with this state then the last one will be returned.
• getLastStep - (instance) Get the last step in the stepped progress.
• isComplete - (instance) Get whether all steps have the "completed" state.
• getNextStep - (instance) Get the next future step (a step which does not have the "current", "complete", or "error" states). If no such step exists, the last step will be returned.
• progress - (instance) Mark the current step as "complete" and then mark the next step as "current". If all steps have the "complete" state then this method does nothing.
• getDataAttributes(steppedProgressElement) - (static) Get the data attributes from the stepped progress element. If the component is being set up declaratively, this method is used to extract the data attributes from the DOM.
• init(rootElement, options) - (static) Initialise stepped progress component.

Links

• "SteppedProgress" class on Github

Share~init

Inner Function

Initialises the Share class, rendering the o-share element if it's empty with config options, or from corresponding data attributes and sets up dom-delegates. Dispatches 'oShare.ready' at the end

Returns

• undefined

Fires Event

• event:"oShare.ready"

Links

• "init" function on Github

Share#destroy

Instance Method

Destroys the Share instance, disables dom-delegates

Returns

• undefined

Links

• "destroy" function on Github

Share.init(rootEl)

Static Method

Initialises all o-share components inside the element passed as the first parameter

Returns

• Share | Array.<Share> - - A Share or an array of Shares

Links

• "init" function on Github

SteppedProgressStep#isComplete

Instance Method

Get whether the step has the "complete" state.

Returns

• boolean - Returns whether the step is complete.

Links

• "isComplete" function on Github

SteppedProgressStep#isCurrent

Instance Method

Get whether the step has the "current" state.

Returns

• boolean - Returns whether the step is current.

Links

• "isCurrent" function on Github

SteppedProgressStep#isError

Instance Method

Get whether the step has the "error" state.

Returns

• boolean - Returns whether the step has an error.

Links

• "isError" function on Github

SteppedProgressStep#isFuture

Instance Method

Get whether the step has no explicit state (and so is a future step).

Returns

• boolean - Returns whether the step has no explicit state.

Links

• "isFuture" function on Github

SteppedProgressStep#markAsComplete

Instance Method

Set the step's state to "complete".

Returns

• void

Links

• "markAsComplete" function on Github

SteppedProgressStep#markAsCurrent

Instance Method

Set the step's state to "current".

Returns

• void

Links

• "markAsCurrent" function on Github

SteppedProgressStep#markAsError

Instance Method

Set the step's state to "error".

Returns

• void

Links

• "markAsError" function on Github

SteppedProgressStep#markAsFuture

Instance Method

Remove all states from the step (marking it as a future step).

Returns

• void

Links

• "markAsFuture" function on Github

SteppedProgress#getSteps

Instance Method

Get an array of steps.

Returns

• Array.<SteppedProgressStep> - Returns an array of steps.

Links

• "getSteps" function on Github

SteppedProgress#getCompletedSteps

Instance Method

Get an array of steps with a "completed" status.

Returns

• Array.<SteppedProgressStep> - Returns an array of steps.

Links

• "getCompletedSteps" function on Github

SteppedProgress#hasStepAtIndex(index)

Instance Method

Get whether a step exists at a given index (0-based).

Returns

• boolean - Returns whether a step exists at a given index.

Links

• "hasStepAtIndex" function on Github

SteppedProgress#getStepAtIndex(index)

Instance Method

Get the step at a given index (0-based).

Returns

• SteppedProgressStep - Returns the step at the given index.

Links

• "getStepAtIndex" function on Github

SteppedProgress#getCurrentStep

Instance Method

Get the step which has the "current" state. If there are multiple steps with this state then the last one will be returned.

Returns

• SteppedProgressStep - Returns the current step.

Links

• "getCurrentStep" function on Github

SteppedProgress#getLastStep

Instance Method

Get the last step in the stepped progress.

Returns

• SteppedProgressStep - Returns the last step.

Links

• "getLastStep" function on Github

SteppedProgress#isComplete

Instance Method

Get whether all steps have the "completed" state.

Returns

• boolean - Returns whether all steps are completed.

Links

• "isComplete" function on Github

SteppedProgress#getNextStep

Instance Method

Get the next future step (a step which does not have the "current", "complete", or "error" states). If no such step exists, the last step will be returned.

Returns

• SteppedProgressStep - Returns the next step.

Links

• "getNextStep" function on Github

SteppedProgress#progress

Instance Method

Mark the current step as "complete" and then mark the next step as "current". If all steps have the "complete" state then this method does nothing.

Returns

• void

Links

• "progress" function on Github

SteppedProgress.getDataAttributes(steppedProgressElement)

Static Method

Get the data attributes from the stepped progress element. If the component is being set up declaratively, this method is used to extract the data attributes from the DOM.

Returns

• object - Returns an options object constructed from the DOM.

Links

• "getDataAttributes" function on Github

SteppedProgress.init(rootElement, options)

Static Method

Initialise stepped progress component.

Returns

• SteppedProgress | Array.<SteppedProgress> - Returns a stepped progress instance, or an array of instances.

Links

• "init" function on Github