Skip to main content

Multiselect


The Multiselect element displays a dropdown list that allows selection of multiple values. It supports read-only display, error validation, placeholder labels, and checkboxes for user clarity. Use this component for filters, preference selections, and categorized tags.

Multiselect dropdown with multiple checked values

Properties

PropertyValueDescription
TypeMultiselectUI component type
Identifier32Unique element ID
GroupFieldPart of the Field group
ValueYStores selected items
MandatoryYRequires input when configured
ErrorYDisplays validation feedback
MinNot defined
MaxNot defined
Read-onlyYCan render in non-editable form
ListYRenders dropdown with checkable list
Text, IconYSupports label text or icon
ChildrenDoes not allow nested components
EventYEmits changes when selections update
ShadeYApplies styling based on selection state

Usage Example

<Multiselect
label="Status"
options={[
{ value: 'new', label: 'New requests' },
{ value: 'offered', label: 'Offered appointments' },
{ value: 'scheduled', label: 'Scheduled appointments' },
{ value: 'after', label: 'After visit' },
{ value: 'cancelled', label: 'Cancelled / Refused' }
]}
onChange={handleStatusChange}
/>

SDK Integration

The Appointment Filter panel uses this element to refine appointment queries. The selection updates a real-time list in both desktop and mobile layouts.

Method: /profile/appointments/filter

This method filters appointments based on the selected status or other parameters such as date range or patient name.


Example UI Placement

LevelIDTypeValueDescription
1statusMultiselectAppointment status filtersIncludes multiple states

Notes

  • Use when multiple related options must be selected.
  • Avoid excessive item counts that reduce clarity.
  • Pair with clear Apply or Reset actions in filter contexts.