Reference Source
import {Search} from '@adobe/coral-spectrum'
public class | source

Search

Expression Extends:

class Search extends BaseFormField(BaseComponent(HTMLElement))

A Search component is a search styled form field.

See:

Example:

Markup
<coral-search></coral-search>
JS constructor
new Coral.Search();

Static Member Summary

Static Public Members
public static

Returns Search variants.

Member Summary

Public Members
public

Whether this field is disabled or not.

public

invalid: *

Inherited from BaseFormField#invalid.

public

Inherited from BaseFormField#labelledBy.

public

Max length for the Input field.

public

Name used to submit the data in a form.

public

Short hint that describes the expected value of the Search.

public

Whether this field is readOnly or not.

public

Whether this field is required or not.

public

The submitted input value.

public

The search's variant. See SearchVariantEnum.

  • SearchVariantEnum.DEFAULT by default.
  • reflected

Method Summary

Public Methods
public

clear()

public

reset()

Static Public Members

public static variant: SearchVariantEnum: * source

Returns Search variants.

Public Members

public disabled: Boolean source

Whether this field is disabled or not.

  • false by default.
  • reflected

public invalid: * source

Inherited from BaseFormField#invalid.

public labelledBy: * source

Inherited from BaseFormField#labelledBy.

public maxLength: Number source

Max length for the Input field.

  • reflected

public name: String source

Name used to submit the data in a form.

  • "" by default.
  • reflected

public placeholder: String source

Short hint that describes the expected value of the Search. It is displayed when the Search is empty.

  • "" by default.
  • reflected

public readOnly: Boolean source

Whether this field is readOnly or not. Indicating that the user cannot modify the value of the control.

  • false by default.
  • reflected

public required: Boolean source

Whether this field is required or not.

  • false by default.
  • reflected

public value: String source

The submitted input value. Changing this value will not trigger an event.

  • "" by default.

public variant: String source

The search's variant. See SearchVariantEnum.

  • SearchVariantEnum.DEFAULT by default.
  • reflected

Public Methods

public clear() source

public reset() source