Interface ColorboxStatic

Index

Call signatures

Properties

Methods

Call signatures

(settings: ColorboxSettings): any

This method allows you to call Colorbox without having to assign it to an element.

Parameters

Returns

any

Properties

public settings: ColorboxSettings

Default settings used for Colorbox calls

Methods

public close()

This method initiates the close sequence, which does not immediately complete. The lightbox will be completely closed only when the cbox_closed event / onClosed callback is fired.

public element(): JQuery

This method is used to fetch the current HTML element that Colorbox is associated with.

Returns

JQuery

public next()

This method moves to the next item in a group and are the same as pressing the 'next' or 'previous' buttons.

public prev()

This method moves to the previous item in a group and are the same as pressing the 'next' or 'previous' buttons.

public remove()

Removes all traces of Colorbox from the document.

public resize()

This allows Colorbox to be resized based on it's own auto-calculations, or to a specific size. This must be called manually after Colorbox's content has loaded.

public resize(settings: ColorboxResizeSettings)

This allows Colorbox to be resized based on it's own auto-calculations, or to a specific size. This must be called manually after Colorbox's content has loaded.

Parameters