Additional Participants Component - Scheduler UI Components

nylas-additional-participants

Overview

The nylas-additional-participants component is a form input for adding additional participants to an event.

Version2.1.0
Install (React)npm install @nylas/react
Import (React)import { NylasAdditionalParticipants } from '@nylas/react';
Import (CDN)You do not need to individually import the component, just import the parent component either nylas-scheduling or nylas-scheduler-editor.

Example


Properties

PropertyAttributeDescriptionTypeDefault
selectedLanguageThe selected language.LANGUAGE_CODE.de | LANGUAGE_CODE.en | LANGUAGE_CODE.es | LANGUAGE_CODE.fr | LANGUAGE_CODE.ja | LANGUAGE_CODE.ko | LANGUAGE_CODE.nl | LANGUAGE_CODE.sv | LANGUAGE_CODE.zh | undefinedundefined

Standalone Props

ⓘ NOTE: The following props are automatically configured when used within nylas-scheduler-editor. Set these props manually only if you’re using the component independently.
PropertyAttributeDescriptionTypeDefault
currentUserThe logged in userundefined | { id: string; email: string; name?: string | undefined; provider?: string | undefined; }undefined
currentUserCalendarsThe list of user’s calendars.Calendar[] | undefinedundefined
eventParticipantsThe event participantsParticipant[] | undefinedundefined
nameThe name of the componentstring'participants'
participantOptionsThe additional participants options from the configAdditionalParticipant[] | undefinedundefined
roundRobinConfigIf the config is round robinboolean | undefinedundefined
selectedConfigurationThe selected configConfiguration | undefinedundefined
themeConfigThe theme configuration.undefined | { '--nylas-primary'?: string | undefined; '--nylas-info'?: string | undefined; '--nylas-success'?: string | undefined; '--nylas-warning'?: string | undefined; '--nylas-error'?: string | undefined; '--nylas-error-pressed'?: string | undefined; '--nylas-base-0'?: string | undefined; '--nylas-base-25'?: string | undefined; '--nylas-base-50'?: string | undefined; '--nylas-base-100'?: string | undefined; '--nylas-base-200'?: string | undefined; '--nylas-base-300'?: string | undefined; '--nylas-base-400'?: string | undefined; '--nylas-base-500'?: string | undefined; '--nylas-base-600'?: string | undefined; '--nylas-base-700'?: string | undefined; '--nylas-base-800'?: string | undefined; '--nylas-base-900'?: string | undefined; '--nylas-base-950'?: string | undefined; '--nylas-color-blue-50'?: string | undefined; '--nylas-color-blue-100'?: string | undefined; '--nylas-color-blue-300'?: string | undefined; '--nylas-color-blue-500'?: string | undefined; '--nylas-color-blue-700'?: string | undefined; '--nylas-color-blue-900'?: string | undefined; '--nylas-color-red-50'?: string | undefined; '--nylas-color-red-100'?: string | undefined; '--nylas-color-red-300'?: string | undefined; '--nylas-color-red-500'?: string | undefined; '--nylas-color-red-700'?: string | undefined; '--nylas-color-red-900'?: string | undefined; '--nylas-color-green-50'?: string | undefined; '--nylas-color-green-100'?: string | undefined; '--nylas-color-green-300'?: string | undefined; '--nylas-color-green-500'?: string | undefined; '--nylas-color-green-700'?: string | undefined; '--nylas-color-green-900'?: string | undefined; '--nylas-color-yellow-50'?: string | undefined; '--nylas-color-yellow-100'?: string | undefined; '--nylas-color-yellow-300'?: string | undefined; '--nylas-color-yellow-500'?: string | undefined; '--nylas-color-yellow-700'?: string | undefined; '--nylas-color-yellow-900'?: string | undefined; '--nylas-color-purple-50'?: string | undefined; '--nylas-color-purple-100'?: string | undefined; '--nylas-color-purple-300'?: string | undefined; '--nylas-color-purple-500'?: string | undefined; '--nylas-color-purple-700'?: string | undefined; '--nylas-color-purple-900'?: string | undefined; '--nylas-color-sky-50'?: string | undefined; '--nylas-color-sky-100'?: string | undefined; '--nylas-color-sky-300'?: string | undefined; '--nylas-color-sky-500'?: string | undefined; '--nylas-color-sky-700'?: string | undefined; '--nylas-color-sky-900'?: string | undefined; '--nylas-color-black'?: string | undefined; '--nylas-color-grey-900'?: string | undefined; '--nylas-color-grey-800'?: string | undefined; '--nylas-color-grey-700'?: string | undefined; '--nylas-color-grey-600'?: string | undefined; '--nylas-color-grey-500'?: string | undefined; '--nylas-color-grey-400'?: string | undefined; '--nylas-color-grey-300'?: string | undefined; '--nylas-color-grey-200'?: string | undefined; '--nylas-color-grey-100'?: string | undefined; '--nylas-color-grey-50'?: string | undefined; '--nylas-color-white'?: string | undefined; '--nylas-font-family'?: string | undefined; '--nylas-font-size'?: string | undefined; '--nylas-border-radius'?: string | undefined; '--nylas-border-radius-2x'?: string | undefined; '--nylas-border-radius-3x'?: string | undefined; }undefined

Events

EventDescriptionType
valueChangedThis event is fired when the selected participants change.CustomEvent<{ value: string; name: string; }>

Shadow Parts

PartDescription
"nadtnlpart"
"nadtnlpart__add-participant"The add participant button of the component.
"nadtnlpart__content"The content of the component.
"nadtnlpart__error"
"nadtnlpart__input"The input of the component.
"nadtnlpart__input_group"The input group of the component.
"nadtnlpart__input_wrapper"The input wrapper of the component.
"nadtnlpart__org-as-participant"
"nadtnlpart__remove-participant"The remove participant button of the component.
"nadtnlpart__subtitle"The subtitle of the component.
"nadtnlpart__title"The title of the component.

Built with StencilJS