SpotHero - SHDialogs - Documentation

Creates a dialog over the content. Events are fired on $(document).

Source:

SHDialogs.add({
    content: $('.my-content')
});

Adds a dialog to the body.

Source:

Name Type Attributes Default Description

options

Object

{}

The options to pass on to the dialog view.

Name	Type	Attributes	Default	Description
`useShim`	Boolean	<optional>	true	Whether to include the shim over the background.
`wrapperClass`	String	<optional>		The class to add to the wrapper.
`showTitle`	Boolean	<optional>	true	Whether to show the title in the dialog.
`title`	String	<optional>		The title of the dialog. Required if showTitle is true.
`width`	String \| Integer	<optional>	'normal'	The width of the dialog. ('extra-slim', 'slim', 'normal' [default], 'wide', 'extra-wide', pixel value [Integer] or percentage ['100%'])
`maxHeight`	Integer	<optional>		The maximum height for the content. Automatically sets overflow to 'auto'.
`noContentPadding`	Boolean	<optional>	false	Disable padding on the content in the dialog.

SHDialogs.add({
    content: $('.my-content'),
    title: 'My Content',
    width: 'wide',
    noContentPadding: true
});

Removes a dialog from the body.

Source:

SHDialogs.remove();