JSDoc: Namespace: theme

Generates the themed representation of a Drupal object.

All requests for themed output must go through this function. It examines the request and routes it to the appropriate theme function. If the current theme does not provide an override function, the generic theme function is called.

Parameters:

Name	Type	Attributes	Description
`func`	function		The name of the theme function to call.
`Additional`	args	<repeatable>	arguments to pass along to the theme function.

Source:

misc/drupal.es6.js, line 630

Returns:

Any data the theme function returns. This could be a plain HTML string, but also a complex object.

Type: string | object | HTMLElement | jQuery

Example

To retrieve the HTML for text that should be emphasized and displayed as a placeholder inside a sentence.

Drupal.theme('placeholder', text);

Methods

(static) ajaxProgressBar($element) → {string}

Provide a wrapper for the AJAX progress bar element.

Parameters:

Name	Type	Description
`$element`	jQuery	Progress bar element.

Source:

misc/ajax.es6.js, line 921

Returns:

The HTML markup for the progress bar.

Type: string

(static) ajaxProgressBar($element) → {string}

Override the default ajaxProgressBar for backwards compatibility.

Parameters:

Name	Type	Description
`$element`	jQuery	Progress bar element.

Source:

themes/stable/js/ajax.es6.js, line 15

Returns:

The HTML markup for the progress bar.

Type: string

(static) ajaxProgressIndicatorFullscreen() → {string}

An animated progress throbber and container element for AJAX operations.

Source:

misc/ajax.es6.js, line 899

Returns:

The HTML markup for the throbber.

Type: string

(static) ajaxProgressIndicatorFullscreen() → {string}

Theme override of the ajax progress indicator for full screen.

Source:

themes/claro/js/ajax.es6.js, line 13

Returns:

The HTML markup for the throbber.

Type: string

(static) ajaxProgressMessage(message) → {string}

Formats text accompanying the AJAX progress throbber.

Parameters:

Name	Type	Description
`message`	string	The message shown on the UI.

Source:

misc/ajax.es6.js, line 910

Returns:

The HTML markup for the throbber.

Type: string

(static) ajaxProgressMessage(message) → {string}

Theme override of the ajax progress message.

Parameters:

Name	Type	Description
`message`	string	The message shown on the UI.

Source:

themes/claro/js/ajax.es6.js, line 43

Returns:

The HTML markup for the throbber.

Type: string

(static) ajaxProgressThrobber(messageopt) → {string}

An animated progress throbber and container element for AJAX operations.

Parameters:

Name	Type	Attributes	Description
`message`	string	<optional>	(optional) The message shown on the UI.

Source:

misc/ajax.es6.js, line 882

Returns:

The HTML markup for the throbber.

Type: string

(static) ajaxProgressThrobber(message) → {string}

Theme override of the ajax progress indicator.

Parameters:

Name	Type	Description
`message`	string	The message shown on the UI.

Source:

themes/claro/js/ajax.es6.js, line 24

Returns:

The HTML markup for the throbber.

Type: string

(static) ajaxWrapperMultipleRootElements($elements)

Provide a wrapper for multiple root elements via Ajax.

Parameters:

Name	Type	Description
`$elements`	jQuery	Response elements after parsing.

Deprecated:

in drupal:8.6.0 and is removed from drupal:10.0.0. Use data with desired wrapper.

Source:

misc/ajax.es6.js, line 1166

See:

https://www.drupal.org/node/2940704

To Do:

Add deprecation warning after it is possible. For more information see: https://www.drupal.org/project/drupal/issues/2973400

(static) ajaxWrapperNewContent($newContent, ajax, response)

Provide a wrapper for new content via Ajax.

Wrap the inserted markup when inserting multiple root elements with an ajax effect.

Parameters:

Name	Type	Description
`$newContent`	jQuery	Response elements after parsing.
`ajax`	Drupal.Ajax	`Drupal.Ajax` object created by `Drupal.ajax`.
`response`	object	The response from the Ajax request.

Deprecated:

in drupal:8.6.0 and is removed from drupal:10.0.0. Use data with desired wrapper.

Source:

misc/ajax.es6.js, line 1135

See:

https://www.drupal.org/node/2940704

To Do:

Add deprecation warning after it is possible. For more information see: https://www.drupal.org/project/drupal/issues/2973400

(static) checkbox() → {string}

Theme function for a checkbox.

Source:

misc/checkbox.es6.js, line 13

Returns:

The HTML markup for the checkbox.

Type: string

(static) checkbox() → {string}

Constructs a checkbox input element.

Source:

themes/claro/js/checkbox.es6.js, line 13

Returns:

A string representing a DOM fragment.

Type: string

(static) checkbox() → {string}

Constructs a checkbox input element.

Source:

themes/olivero/js/checkbox.es6.js, line 13

Returns:

A string representing a DOM fragment.

Type: string

(static) ckeditorButtonGroupNameForm() → {string}

Themes a form for changing the title of a CKEditor button group.

Source:

modules/ckeditor/js/ckeditor.admin.es6.js, line 530

Returns:

A HTML string for the form for the title of a CKEditor button group.

Type: string

(static) ckeditorButtonGroupNamesToggle() → {string}

Themes a button that will toggle the button group names in active config.

Source:

modules/ckeditor/js/ckeditor.admin.es6.js, line 540

Returns:

A HTML string for the button to toggle group names.

Type: string

(static) ckeditorNewButtonGroup() → {string}

Themes a button that will prompt the user to name a new button group.

Source:

modules/ckeditor/js/ckeditor.admin.es6.js, line 550

Returns:

A HTML string for the button to create a name for a new button group.

Type: string

(static) ckeditorRow() → {string}

Themes a blank CKEditor row.

Source:

modules/ckeditor/js/ckeditor.admin.es6.js, line 500

Returns:

A HTML string for a CKEditor row.

Type: string

(static) ckeditorToolbarGroup() → {string}

Themes a blank CKEditor button group.

Source:

modules/ckeditor/js/ckeditor.admin.es6.js, line 510

Returns:

A HTML string for a CKEditor button group.

Type: string

(static) contextualTrigger() → {string}

A trigger is an interactive element often bound to a click handler.

Source:

modules/contextual/js/contextual.es6.js, line 272

Returns:

A string representing a DOM fragment.

Type: string

(static) dateHelp(dateDesc) → {string}

Theme function for no-native-datepicker date input help text.

Parameters:

Name	Type	Description
`dateDesc`	string	The help text.

Source:

misc/date.es6.js, line 161

Returns:

The HTML markup for the help text.

Type: string

(static) dateTimeHelp(dateId, timeId, dateDesc, timeDesc) → {string}

Theme function for no-native-datepicker date+time inputs help text.

Parameters:

Name	Type	Description
`dateId`	string	The date input aria-describedby value.
`timeId`	string	The time input aria-describedby value.
`dateDesc`	string	The date help text.
`timeDesc`	string	The time help text.

Source:

misc/date.es6.js, line 179

Returns:

The HTML markup for the help text.

Type: string

(static) detailsSummarizedContentText(textopt) → {string}

Formats the summarized details content text.

Parameters:

Name	Type	Attributes	Description
`text`	string \| null	<optional>	(optional) The summarized content text displayed in the summary.

Source:

misc/details-summarized-content.es6.js, line 104

Returns:

The formatted summarized content text.

Type: string

(static) detailsSummarizedContentText(textopt) → {string}

Theme override of summarized details content text.

Parameters:

Name	Type	Attributes	Description
`text`	string \| null	<optional>	(optional) The summarized content displayed in the summary.

Source:

themes/claro/js/details.es6.js, line 74

Returns:

The formatted summarized content text.

Type: string

(static) detailsSummarizedContentWrapper() → {string}

The element containing a wrapper for summarized details content.

Source:

misc/details-summarized-content.es6.js, line 93

Returns:

The markup for the element that will contain the summarized content.

Type: string

(static) detailsSummarizedContentWrapper() → {string}

Theme override providing a wrapper for summarized details content.

Source:

themes/claro/js/details.es6.js, line 63

Returns:

The markup for the element that will contain the summarized content.

Type: string

(static) dropbuttonToggle(options) → {string}

A toggle is an interactive element often bound to a click handler.

Parameters:

Name Type Description

options

object

Options object.

Properties

Name	Type	Attributes	Description
`title`	string	<optional>	The button text.

Source:

misc/dropbutton/dropbutton.es6.js, line 231

Returns:

A string representing a DOM fragment.

Type: string

(static) dropbuttonToggle(options) → {string}

Overrides the dropbutton toggle markup.

We have to keep the 'dropbutton-toggle' CSS class because the dropbutton JS operates with that one.

Parameters:

Name Type Description

options

object

Options object.

Properties

Name	Type	Attributes	Description
`title`	string	<optional>	The button text.

Source:

themes/claro/js/dropbutton.es6.js, line 21

Returns:

A string representing a DOM fragment.

Type: string

(static) filterFilterHTMLUpdateMessage(tags) → {string}

Theme function for the filter_html update message.

Parameters:

Name	Type	Description
`tags`	Array	An array of the new tags that are to be allowed.

Source:

modules/filter/filter.filter_html.admin.es6.js, line 363

Returns:

The corresponding HTML.

Type: string

(static) layoutBuilderPrependContentPreviewPlaceholderLabel(contentPreviewPlaceholderText) → {string}

Creates content preview placeholder label markup.

Parameters:

Name	Type	Description
`contentPreviewPlaceholderText`	string	The text content of the placeholder label

Source:

modules/layout_builder/js/layout-builder.es6.js, line 437

Returns:

A HTML string of the placeholder label.

Type: string

(static) localeTranslateChangedMarker() → {string}

Creates markup for a changed translation marker.

Source:

modules/locale/locale.admin.es6.js, line 106

Returns:

Markup for the marker.

Type: string

(static) localeTranslateChangedWarning() → {string}

Creates markup for the translation changed warning.

Source:

modules/locale/locale.admin.es6.js, line 118

Returns:

Markup for the warning.

Type: string

(static) mediaEmbedEditButton() → {string}

Themes the edit button for a media embed.

Source:

modules/media/js/media_embed_ckeditor.theme.es6.js, line 26

Returns:

An HTML string to insert in the CKEditor.

Type: string

(static) mediaEmbedPreviewError() → {string}

Themes the error displayed when the media embed preview fails.

Source:

modules/media/js/media_embed_ckeditor.theme.es6.js, line 15

See:

media-embed-error.html.twig

Returns:

A string representing a DOM fragment.

Type: string

(static) mediaEmbedPreviewError(error) → {string}

Themes the error displayed when the media embed preview fails.

Parameters:

Name	Type	Description
`error`	string	The error message to display

Source:

themes/bartik/js/classy/media_embed_ckeditor.theme.es6.js, line 18

See:

media-embed-error.html.twig

Returns:

A string representing a DOM fragment.

Type: string

(static) mediaEmbedPreviewError(error) → {string}

Themes the error displayed when the media embed preview fails.

Parameters:

Name	Type	Description
`error`	string	The error message to display

Source:

themes/claro/js/classy/media_embed_ckeditor.theme.es6.js, line 18

See:

media-embed-error.html.twig

Returns:

A string representing a DOM fragment.

Type: string

(static) mediaEmbedPreviewError(error) → {string}

Themes the error displayed when the media embed preview fails.

Parameters:

Name	Type	Description
`error`	string	The error message to display

Source:

themes/classy/js/media_embed_ckeditor.theme.es6.js, line 18

See:

media-embed-error.html.twig

Returns:

A string representing a DOM fragment.

Type: string

(static) mediaEmbedPreviewError(error) → {string}

Themes the error displayed when the media embed preview fails.

Parameters:

Name	Type	Description
`error`	string	The error message to display

Source:

themes/seven/js/classy/media_embed_ckeditor.theme.es6.js, line 18

See:

media-embed-error.html.twig

Returns:

A string representing a DOM fragment.

Type: string

(static) mediaLibrarySelectionCount() → {string}

Theme function for the selection count.

Source:

modules/media_library/js/media_library.ui.es6.js, line 420

Returns:

The corresponding HTML.

Type: string

(static) message(message, options) → {HTMLElement}

Theme function for a message.

Parameters:

Name Type Description

message

object

The message object.

Properties

Name	Type	Description
`text`	string	The message text.

options

object

The message context.

Properties

Name	Type	Description
`type`	string	The message type.
`id`	string	ID of the message, for reference.

Source:

misc/message.es6.js, line 236

Returns:

A DOM Node.

Type: HTMLElement

(static) message(message, options) → {HTMLElement}

Overrides message theme function.

Parameters:

Name Type Description

message

object

The message object.

Properties

Name	Type	Description
`text`	string	The message text.

options

object

The message context.

Properties

Name	Type	Description
`type`	string	The message type.
`id`	string	ID of the message, for reference.

Source:

themes/claro/js/messages.es6.js, line 24

Returns:

A DOM Node.

Type: HTMLElement

(static) message(message, options) → {HTMLElement}

Overrides message theme function.

Parameters:

Name Type Description

message

object

The message object.

Properties

Name	Type	Description
`text`	string	The message text.

options

object

The message context.

Properties

Name	Type	Description
`type`	string	The message type.
`id`	string	ID of the message, for reference.

Source:

themes/olivero/js/messages.es6.js, line 55

Returns:

A DOM Node.

Type: HTMLElement

(static) nodePreviewModal() → {string}

Theme function for node preview modal.

Source:

modules/node/node.preview.es6.js, line 103

Returns:

Markup for the node preview modal.

Type: string

(static) passwordConfirmMessage(passwordSettings) → {string}

Constructs a password confirm message element.

Parameters:

Name Type Description

passwordSettings

object

An object containing password related settings and translated text to display.

Properties

Name	Type	Description
`confirmTitle`	string	The translated confirm description that labels the actual confirm text.

Source:

modules/user/tests/themes/password_theme_function_test/js/password-theme-functions.es6.js, line 65

Returns:

Markup for the password confirm message.

Type: string

(static) passwordConfirmMessage(passwordSettings) → {string}

Constructs a password confirm message element.

Parameters:

Name Type Description

passwordSettings

object

An object containing password related settings and translated text to display.

Properties

Name	Type	Description
`confirmTitle`	string	The translated confirm description that labels the actual confirm text.

Source:

modules/user/user.theme.es6.js, line 19

Returns:

Markup for the password confirm message.

Type: string

(static) passwordConfirmMessage(passwordSettings) → {string}

Constructs a password confirm message element.

Parameters:

Name Type Description

passwordSettings

object

An object containing password related settings and translated text to display.

Properties

Name	Type	Description
`confirmTitle`	string	The translated confirm description that labels the actual confirm text.

Source:

themes/claro/js/user.theme.es6.js, line 28

Returns:

Markup for the password confirm message.

Type: string

(static) passwordConfirmMessage() → {string}

Constructs a password confirm message element

Source:

themes/stable/js/user.theme.es6.js, line 13

Returns:

A string representing a DOM fragment.

Type: string

(static) passwordConfirmMessage(passwordSettings) → {string}

Constructs a password confirm message element.

Parameters:

Name Type Description

passwordSettings

object

An object containing password related settings and translated text to display.

Properties

Name	Type	Description
`confirmTitle`	string	The translated confirm description that labels the actual confirm text.

Source:

themes/stable9/js/user.theme.es6.js, line 19

Returns:

Markup for the password confirm message.

Type: string

(static) passwordStrength(passwordSettings) → {string}

Constructs a password strength message.

Parameters:

Name Type Description

passwordSettings

object

An object containing password related settings and translated text to display.

Properties

Name	Type	Description
`strengthTitle`	string	The title that precedes the strength text.

Source:

modules/user/tests/themes/password_theme_function_test/js/password-theme-functions.es6.js, line 19

Returns:

Markup for password strength message.

Type: string

(static) passwordStrength(passwordSettings) → {string}

Constructs a password strength message.

Parameters:

Name Type Description

passwordSettings

object

An object containing password related settings and translated text to display.

Properties

Name	Type	Description
`strengthTitle`	string	The title that precedes the strength text.

Source:

modules/user/user.theme.es6.js, line 37

Returns:

Markup for password strength message.

Type: string

(static) passwordStrength(passwordSettings) → {string}

Constructs a password strength message.

Parameters:

Name Type Description

passwordSettings

object

An object containing password related settings and translated text to display.

Properties

Name	Type	Description
`strengthTitle`	string	The title that precedes the strength text.

Source:

themes/claro/js/user.theme.es6.js, line 46

Returns:

Markup for the password strength indicator.

Type: string

(static) passwordStrength(passwordSettings) → {string}

Constructs a password strength message.

Parameters:

Name Type Description

passwordSettings

object

An object containing password related settings and translated text to display.

Properties

Name	Type	Description
`strengthTitle`	string	The title that precedes the strength text.

Source:

themes/stable/js/user.theme.es6.js, line 28

Returns:

Markup for password strength message.

Type: string

(static) passwordStrength(passwordSettings) → {string}

Constructs a password strength message.

Parameters:

Name Type Description

passwordSettings

object

An object containing password related settings and translated text to display.

Properties

Name	Type	Description
`strengthTitle`	string	The title that precedes the strength text.

Source:

themes/stable9/js/user.theme.es6.js, line 37

Returns:

Markup for password strength message.

Type: string

(static) passwordSuggestions(passwordSettings, tips) → {string}

Constructs password suggestions tips.

Parameters:

Name Type Description

passwordSettings

object

An object containing password related settings and translated text to display.

Properties

Name	Type	Description
`hasWeaknesses`	string	The title that precedes tips.

tips

Array.<string>

Array containing the tips.

Source:

modules/user/tests/themes/password_theme_function_test/js/password-theme-functions.es6.js, line 46

Returns:

Markup for password suggestions.

Type: string

(static) passwordSuggestions(passwordSettings, tips) → {string}

Constructs password suggestions tips.

Parameters:

Name Type Description

passwordSettings

object

An object containing password related settings and translated text to display.

Properties

Name	Type	Description
`hasWeaknesses`	string	The title that precedes tips.

tips

Array.<string>

Array containing the tips.

Source:

modules/user/user.theme.es6.js, line 64

Returns:

Markup for password suggestions.

Type: string

(static) passwordSuggestions(passwordSettings, tips) → {string}

Constructs password suggestions tips.

Parameters:

Name Type Description

passwordSettings

object

An object containing password related settings and translated tex t to display.

Properties

Name	Type	Description
`hasWeaknesses`	string	The title that precedes tips.

tips

Array.<string>

Array containing the tips.

Source:

themes/claro/js/user.theme.es6.js, line 73

Returns:

Markup for the password suggestions.

Type: string

(static) placeholder(str) → {string}

Formats text for emphasized display in a placeholder inside a sentence.

Parameters:

Name	Type	Description
`str`	string	The text to format (plain-text).

Source:

misc/drupal.es6.js, line 645

Returns:

The formatted text (html).

Type: string

(static) progressBar(id) → {string}

Theme function for the progress bar.

Parameters:

Name	Type	Description
`id`	string	The id for the progress bar.

Source:

misc/progress.es6.js, line 16

Returns:

The HTML for the progress bar.

Type: string

(static) quickeditBackstage(settings) → {string}

Theme function for a "backstage" for the Quick Edit module.

Parameters:

Name Type Description

settings

object

Settings object used to construct the markup.

Properties

Name	Type	Description
`id`	string	The id to apply to the backstage.

Source:

modules/quickedit/js/theme.es6.js, line 18

Returns:

The corresponding HTML.

Type: string

(static) quickeditButtons(settings) → {string}

Theme function for buttons of the Quick Edit module.

Can be used for the buttons both in the toolbar toolgroups and in the modal.

Parameters:

Name Type Description

settings

object

Settings object used to construct the markup.

Properties

Name	Type	Description
`buttons`	Array	String type: the type of the button (defaults to 'button') Array classes: the classes of the button. String label: the label of the button.

Source:

modules/quickedit/js/theme.es6.js, line 141

Returns:

The corresponding HTML.

Type: string

(static) quickeditEntityToolbar(settings) → {string}

Theme function for a toolbar container of the Quick Edit module.

Parameters:

Name Type Description

settings

object

Settings object used to construct the markup.

Properties

Name	Type	Description
`id`	string	the id to apply to the backstage.

Source:

modules/quickedit/js/theme.es6.js, line 35

Returns:

The corresponding HTML.

Type: string

(static) quickeditEntityToolbarFence() → {string}

Element defining a containing box for the placement of the entity toolbar.

Source:

modules/quickedit/js/theme.es6.js, line 76

Returns:

The corresponding HTML.

Type: string

(static) quickeditEntityToolbarLabel(settings) → {string}

Theme function for a toolbar container of the Quick Edit module.

Parameters:

Name Type Description

settings

object

Settings object used to construct the markup.

Properties

Name	Type	Description
`entityLabel`	string	The title of the active entity.
`fieldLabel`	string	The label of the highlighted or active field.

Source:

modules/quickedit/js/theme.es6.js, line 63

Returns:

The corresponding HTML.

Type: string

(static) quickeditFieldToolbar(settings) → {string}

Theme function for a toolbar container of the Quick Edit module.

Parameters:

Name Type Description

settings

object

Settings object used to construct the markup.

Properties

Name	Type	Description
`id`	string	The id to apply to the toolbar container.

Source:

modules/quickedit/js/theme.es6.js, line 91

Returns:

The corresponding HTML.

Type: string

(static) quickeditFormContainer(settings) → {string}

Theme function for a form container of the Quick Edit module.

Parameters:

Name Type Description

settings

object

Settings object used to construct the markup.

Properties

Name	Type	Description
`id`	string	The id to apply to the toolbar container.
`loadingMsg`	string	The message to show while loading.

Source:

modules/quickedit/js/theme.es6.js, line 174

Returns:

The corresponding HTML.

Type: string

(static) quickeditImageDropzone(settings) → {string}

Theme function for the dropzone element of the Image module's in-place editor.

Parameters:

Name Type Description

settings

object

Settings object used to construct the markup.

Properties

Name	Type	Description
`state`	string	State of the upload.
`text`	string	Text to display inline with the dropzone element.

Source:

modules/image/js/theme.es6.js, line 36

Returns:

The corresponding HTML.

Type: string

(static) quickeditImageErrors(settings) → {string}

Theme function for validation errors of the Image in-place editor.

Parameters:

Name Type Description

settings

object

Settings object used to construct the markup.

Properties

Name	Type	Description
`errors`	string	Already escaped HTML representing error messages.

Source:

modules/image/js/theme.es6.js, line 18

Returns:

The corresponding HTML.

Type: string

(static) quickeditImageToolbar(settings) → {string}

Theme function for the toolbar of the Image module's in-place editor.

Parameters:

Name Type Description

settings

object

Settings object used to construct the markup.

Properties

Name	Type	Description
`alt_field`	bool	Whether or not the "Alt" field is enabled for this field.
`alt_field_required`	bool	Whether or not the "Alt" field is required for this field.
`alt`	string	The current value for the "Alt" field.
`title_field`	bool	Whether or not the "Title" field is enabled for this field.
`title_field_required`	bool	Whether or not the "Title" field is required for this field.
`title`	string	The current value for the "Title" field.

Source:

modules/image/js/theme.es6.js, line 66

Returns:

The corresponding HTML.

Type: string

(static) quickeditToolgroup(settings) → {string}

Theme function for a toolbar toolgroup of the Quick Edit module.

Parameters:

Name Type Description

settings

object

Settings object used to construct the markup.

Properties

Name	Type	Attributes	Description
`id`	string	<optional>	The id of the toolgroup.
`classes`	string		The class of the toolgroup.
`buttons`	Array		See `Drupal.theme.quickeditButtons`.

Source:

modules/quickedit/js/theme.es6.js, line 110

Returns:

The corresponding HTML.

Type: string

(static) tableDragCellContentWrapper() → {string}

Constructs the wrapper for the initial content of the drag cell.

Source:

themes/claro/js/tabledrag.es6.js, line 1813

Returns:

A string representing a DOM fragment.

Type: string

(static) tableDragCellItemsWrapper() → {string}

Constructs the wrapper for the whole table drag cell.

Source:

themes/claro/js/tabledrag.es6.js, line 1803

Returns:

A string representing a DOM fragment.

Type: string

(static) tableDragChangedMarker() → {string}

Source:

misc/tabledrag.es6.js, line 1648

Returns:

Markup for the marker.

Type: string

(static) tableDragChangedMarker() → {string}

Source:

themes/claro/js/tabledrag.es6.js, line 1763

Returns:

Markup for the marker.

Type: string

(static) tableDragChangedWarning() → {string}

Source:

misc/tabledrag.es6.js, line 1666

Returns:

Markup for the warning.

Type: string

(static) tableDragChangedWarning() → {Array}

Get rid of irritating tabledrag messages.

Source:

modules/views_ui/js/ajax.es6.js, line 154

Returns:

An array of messages. Always empty array, to get rid of the messages.

Type: Array

(static) tableDragChangedWarning() → {string}

Source:

themes/claro/js/tabledrag.es6.js, line 1781

Returns:

Markup for the warning.

Type: string

(static) tableDragHandle() → {string}

Source:

misc/tabledrag.es6.js, line 1699

Returns:

HTML markup for a tableDrag handle.

Type: string

(static) tableDragHandle() → {string}

Constructs the table drag handle.

Source:

themes/claro/js/tabledrag.es6.js, line 1793

Returns:

A string representing a DOM fragment.

Type: string

(static) tableDragIndentation() → {string}

Source:

misc/tabledrag.es6.js, line 1658

Returns:

Markup for the indentation.

Type: string

(static) tableDragIndentation() → {string}

Source:

themes/claro/js/tabledrag.es6.js, line 1773

Returns:

Markup for the indentation.

Type: string

(static) tableDragToggle() → {string}

The button for toggling table row weight visibility.

Source:

misc/tabledrag.es6.js, line 1678

Returns:

HTML markup for the weight toggle button and its container.

Type: string

(static) tableDragToggle(action, text) → {string}

Constructs the weight column toggle.

The 'tabledrag-toggle-weight' CSS class should be kept since it is used elsewhere as well (e.g. in tests).

Parameters:

Name	Type	Description
`action`	string	The action the toggle will perform.
`text`	string	The text content of the toggle.

Source:

themes/claro/js/tabledrag.es6.js, line 1831

Returns:

A string representing a DOM fragment.

Type: string

(static) tableDragToggleWrapper() → {string}

Constructs the wrapper of the weight column toggle.

The 'tabledrag-toggle-weight-wrapper' CSS class should be kept since it is used by Views UI and inside off-canvas dialogs.

Source:

themes/claro/js/tabledrag.es6.js, line 1859

Returns:

A string representing a DOM fragment.

Type: string

(static) toggleButtonContent(show) → {string}

The contents of the toggle weight button.

Parameters:

Name	Type	Description
`show`	boolean	If the table weights are currently displayed.

Source:

misc/tabledrag.es6.js, line 1692

Returns:

HTML markup for the weight toggle button content.s

Type: string

(static) toolbarMenuItemToggle(options) → {string}

A toggle is an interactive element often bound to a click handler.

Parameters:

Name Type Description

options

object

Options for the button.

Properties

Name	Type	Description
`class`	string	Class to set on the button.
`action`	string	Action for the button.
`text`	string	Used as label for the button.

Source:

modules/toolbar/js/toolbar.menu.es6.js, line 199

Returns:

A string representing a DOM fragment.

Type: string

(static) toolbarOrientationToggle() → {string}

A toggle is an interactive element often bound to a click handler.

Source:

modules/toolbar/js/toolbar.es6.js, line 305

Returns:

A string representing a DOM fragment.

Type: string

(static) verticalTab(settings) → {object}

Theme function for a vertical tab.

Parameters:

Name Type Description

settings

object

An object with the following keys:

Properties

Name	Type	Description
`title`	string	The name of the tab.

Source:

misc/vertical-tabs.es6.js, line 284

Returns:

This function has to return an object with at least these keys:

item: The root tab jQuery element
link: The anchor tag that acts as the clickable area of the tab (jQuery version)
summary: The jQuery element that contains the tab summary

Type: object

(static) verticalTab(settings) → {object}

Theme function for a vertical tab.

Parameters:

Name Type Description

settings

object

An object with the following keys:

Properties

Name	Type	Description
`title`	string	The name of the tab.

Source:

themes/claro/js/vertical-tabs.es6.js, line 397

Returns:

This function has to return an object with at least these keys:

item: The root tab jQuery element
link: The anchor tag that acts as the clickable area of the tab (jQuery version)
summary: The jQuery element that contains the tab summary

Type: object

(static) verticalTabActiveTabIndicator() → {string}

Themes the active vertical tab menu item message.

Source:

themes/claro/js/vertical-tabs.es6.js, line 443

Returns:

A string representing the DOM fragment.

Type: string

(static) verticalTabListWrapper() → {string}

The wrapper of the vertical tab menu items.

Source:

themes/claro/js/vertical-tabs.es6.js, line 434

Returns:

A string representing the DOM fragment.

Type: string

(static) verticalTabsWrapper() → {string}

Wrapper of the menu and the panes.

Source:

themes/claro/js/vertical-tabs.es6.js, line 425

Returns:

A string representing the DOM fragment.

Type: string