Coral Spectrum
ExamplesPlaygroundReference Source 
import {Shell} from '@adobe/coral-spectrum/coral-component-shell'
public class | source

ShellHelp

Expression Extends:

class ShellHelp extends BaseComponent(HTMLElement)

Mixin Extends:

HTMLElement, BaseComponent

A Shell Help component

See:

Example:

Markup
<coral-shell-help></coral-shell-help>
JS constructor
new Coral.Shell.Help();

Member Summary

Public Members
public
public

The item collection.
public

The search field placeholder.

Method Summary

Public Methods
public

Indicate to the user that an error has occurred
public

showResults(results: Array<ShellHelpResult>, total: Number, allResultsURL: String)

Show a set of search results.

Public Members

public [timeoutName]: * source

public items: Collection source

The item collection.

  • read-only

public placeholder: String source

The search field placeholder.

  • "" by default.

Public Methods

public showError() source

Indicate to the user that an error has occurred

public showResults(results: Array<ShellHelpResult>, total: Number, allResultsURL: String) source

Show a set of search results.

Params:

NameTypeAttributeDescription
results Array<ShellHelpResult>

A set of search result objects.
total Number

The total number of results.
allResultsURL String

The URL at which all results will be displayed.