settingsDialog

Methods

createSettingsDialog(previewTypesEnabled) → {HTMLElement}static #

Create the settings dialog shown to anonymous users.

Parameters:

Name Type Description
previewTypesEnabled Object
Source:

Returns:

settings dialog

Type
HTMLElement

renderSettingsDialog(model) → {HTMLElement}static #

Parameters:

Name Type Description
model SettingsModel
Source:

Returns:

Type
HTMLElement

escapeChoices(choices) → {SettingsChoiceModel}inner #

Parameters:

Name Type Attributes Description
choices Array.<SettingsChoiceModel> optional
Source:

Returns:

Type
SettingsChoiceModel

Type Definitions

SettingsChoiceModel #

Type:

  • Object

Properties:

Name Type Attributes Description
id string

Portion of the elements' IDs and value of the input.

name string
description string optional
isChecked boolean optional

Whether the setting is checked.

Source:

SettingsModel #

Type:

  • Object

Properties:

Name Type Attributes Description
heading string
closeLabel string
saveLabel string
helpText string
okLabel string
choices Array.<SettingsChoiceModel> optional
Source:

settingsDialog

Methods

createSettingsDialog(previewTypesEnabled) → {HTMLElement}static #

Create the settings dialog shown to anonymous users.

Parameters:

Name Type Description
previewTypesEnabled Object
Source:

Returns:

settings dialog

Type
HTMLElement

renderSettingsDialog(model) → {HTMLElement}static #

Parameters:

Name Type Description
model SettingsModel
Source:

Returns:

Type
HTMLElement

escapeChoices(choices) → {SettingsChoiceModel}inner #

Parameters:

Name Type Attributes Description
choices Array.<SettingsChoiceModel> optional
Source:

Returns:

Type
SettingsChoiceModel

Type Definitions

SettingsChoiceModel #

Type:

  • Object

Properties:

Name Type Attributes Description
id string

Portion of the elements' IDs and value of the input.

name string
description string optional
isChecked boolean optional

Whether the setting is checked.

Source:

SettingsModel #

Type:

  • Object

Properties:

Name Type Attributes Description
heading string
closeLabel string
saveLabel string
helpText string
okLabel string
choices Array.<SettingsChoiceModel> optional
Source: