Base Lightning Component

DELETED - Non-Locker Compliant

The Base Lightning component takes care of handling the logic split between the CaseCreation and Search Lightning components. All of its properties, events, and options are thus shared with the CaseCreation Lightning Component and Search Lightning Component.

This component isn’t meant to be used alone, and is documented here for reference purposes only.

Usage

This component isn’t meant to be used alone. You should instead use the CaseCreation Lightning Component or Search Lightning Component.

Resources Included With This Component

This component doesn’t include any resources.

Aura Events

This component offers the following Aura events:

ResourcesLoaded

Fired when all of the component resources have finished loading. This doesn’t include the Interface Editor resources, which are loaded separately.

InterfaceEditorResourcesLoaded

Fired when the resources for the Interface Editor have finished loading.

InterfaceContentLoaded

Fired when the search interface has finished loading.

InterfaceContentInitialized

Fired when the search interface is initialized.

GetSearchToken

Fired when the search token has been fetched (see Generating a Custom Search Token for Lightning Components).

Options

This component offers the following options:

name

The name of the Visualforce component that should act as your search interface.

Depending on the Lightning component you’re using, this could either be a search or a case creation Visualforce component.

This option doesn’t have a default value.

searchHub

The name of the searchHub to be sent to Coveo Usage Analytics (Coveo UA).

This option should have the same value as name.

autoInitialize

Whether the component should automatically initialize itself.

When this option is set to false, you need to handle the initialization yourself through external code.

Default value is true.

autoInjectBasicQuery

Whether the component should inject a query by default.

Default value is true.

autoInjectBasicOptions

Whether the interface should automatically configure a set of options for the interface.

Default value is true.

debug

Whether to load the non-minified versions of the different resources.

Setting this option to true enables more logging, but can be slower overall. Only enable this when developing or debugging components.

Default value is false.

Recommended Articles