Current Version: 2.1.3

Github: @coralui/coralui-component-shell-help

The Coral.Shell.Help component is a standardized help menu designed to fit into the Shell 3 pattern. The menu typical contains links that are instances of Coral.Shell.Help.Item.

Marketing Cloud Help Community Customer Care What's new in CoralUI Adobe Marketing Cloud Status Getting Started with CoralUI

Show Markup

Coral .Shell.Help API

Constructor

JavaScript:: new Coral.Shell.Help() or document.createElement('coral-shell-help')
HTML Tag:: <coral-shell-help>

Extends

Coral.AnchorList

Sub-components

Coral.Shell.Help.Item

Instance Properties

instance.hidden {Boolean} Reflected

Whether this component is hidden or not.

Inherited From:

Coral.Component#hidden

Default Value:

false

HTML Attribute:

hidden

instance.interaction {String}

Boolean enumeration for List keyboard interaction state.

Properties:

Name	Type	Value	Description
ON	String	on	Keyboard interaction is enabled.
OFF	String	off	Keyboard interaction is disabled.

Inherited From:

Coral.List#interaction

instance.items {Coral.Collection} Readonly

The item collection. See Coral.Collection for more details.

instance.placeholder {String}

The search field placeholder.

Default Value:

HTML Attribute:

placeholder

Methods

Coral.Shell.Help.showError

Indicate to the user that an error has occurred

Coral.Shell.Help.showResults

Show a set of search results.

Parameters:

Name	Type	Description
results	Array.<Coral.Shell.Help~result>	A set of search result objects.
total	Number	The total number of results.
allResultsURL	String	The URL at which all results will be displayed.

instance.get

Get the value of a property.

Parameters:

Name	Type	Description
property	String	The name of the property to fetch the value of.

Returns:

Property value. {*}

Inherited From:

Coral.Component#get

instance.hide

Hide this component.

Returns:: this, chainable {Coral.Component}

Inherited From:

Coral.Component#hide

instance.off

Remove an event listener.

Parameters:

Name	Type	Optional	Description
eventName	String	No	The event name to stop listening for.
selector	String	Yes	The selector that was used for event delegation.
func	function	No	The function that was passed to `on()`.
useCapture	Boolean	Yes	Only remove listeners with `useCapture` set to the value passed in.

Returns:

this, chainable. {Coral.Component}

Inherited From:

Coral.Component#off

instance.on

Add an event listener.

Parameters:

Name	Type	Optional	Description
eventName	String	No	The event name to listen for.
selector	String	Yes	The selector to use for event delegation.
func	function	No	The function that will be called when the event is triggered.
useCapture	Boolean	Yes	Whether or not to listen during the capturing or bubbling phase.

Returns:

this, chainable. {Coral.Component}

Inherited From:

Coral.Component#on

instance.remove

Non-destructively remove this element. It can be re-added by simply appending it to the document again. It will be garbage collected if there are no more references to it.

Inherited From:

Coral.Component#remove

instance.set

Set a single property.

Parameters:

Name	Type	Description
property	String	The name of the property to set.
value	*	The value to set the property to.
silent	Boolean	If true, events should not be triggered as a result of this set.

Returns:

this, chainable. {Coral.Component}

Inherited From:

Coral.Component#set

instance.show

Show this component.

Returns:: this, chainable {Coral.Component}

Inherited From:

Coral.Component#show

instance.trigger

Trigger an event.

Parameters:

Name	Type	Optional	Description
eventName	String	No	The event name to trigger.
props	Object	Yes	Additional properties to make available to handlers as `event.detail`.
bubbles	Boolean	Yes	Set to `false` to prevent the event from bubbling.
cancelable	Boolean	Yes	Set to `false` to prevent the event from being cancelable.

Returns:

CustomEvent object {CustomEvent}

Inherited From:

Coral.Component#trigger

Type Definitions

result

A search result object.

Properties:

Name	Type	Description
title	String	The title of the search result.
href	String	The URL of the search result.
target	String	This property specifies where to display the search result. Use this property only if the href property is present.
tags	Array.<String>	A set of tags associated with the search result.