Link copied!

Contacts API

API Reference vce-contact-preview

HTML Attributes API

Name Description Type Required Default value
html string
content object

API Reference vce-recent-contacts

HTML Attributes API

Name Description Type Required Default value
translations Sets the translations RecentContactsTranslations {label: 'Recent contacts'}
step Step increment for number number 1

Contact

{
  id: string;
  firstName: string;
  lastName: string;
  email: string;
}

RecentContactsTranslations

{
   label: string;
}

Events

Event Description Returns
connected.recent-contacts Fires on connect 
{ bubbles: true }
disconnected.recent-contacts Fires on disconnect 
{}}
select Fires on select 
{ type: 'select',
contact:  {
  id: string;
  firstName: string;
  lastName: string;
  email: string;
}      }
remove Fires on remove 
{ type: 'remove',
contact:  {
  id: string;
  firstName: string;
  lastName: string;
  email: string;
}      }

API Reference vce-simple-search-field

HTML Attributes API

Name Description Type Required Default value
value String to search for string
loading Show loading spinner boolean
translations Image URL SimpleSearchFieldTranslations {placeholder: 'Start typing a search term}

SimpleSearchFieldTranslations

{
   placeholder: string;
}

Events

Event Description Returns
search Fires on search field change and on click 
 { detail: { value } }

API Reference vce-search-results

HTML Attributes API

Name Description Type Required Default value
contacts Array of Contact string

Contact

{
  id: string;
  firstName: string;
  lastName: string;
  email: string;
}

Events

Event Description Returns
add Fires on click 
{ type: 'add',
contact:  {
  id: string;
  firstName: string;
  lastName: string;
  email: string;
}      }