Skip to content

PrimeMultiSelect

A FormKit wrapper for PrimeVue's MultiSelect component.

Live Example on Website

Usage

vue
<FormKit type="primemultiselect" :options="options" option-label="label" option-value="value" v-model="selected" />

Object-based Example

vue
<script setup>
const options = [
  { label: 'Every page load', value: 'refresh' },
  { label: 'Every hour', value: 'hourly' },
  { label: 'Every day', value: 'daily' },
]
const schema = [
  { $formkit: 'primeMultiSelect', name: 'cookie_notice', label: 'Cookie notice MultiSelect', optionLabel: 'label', optionValue: 'value', options, help: 'Cookie notice frequency ?' },
  { $formkit: 'primeMultiSelect', name: 'styled', label: 'Styled', style: { background: 'gray' }, class: 'customClass', optionLabel: 'label', optionValue: 'value', options, disabled: true },
  { $formkit: 'primeMultiSelect', name: 'custom', label: 'With Multiple Select and Filter', filter: true, placeholder: 'Please select', optionLabel: 'label', optionValue: 'value', options, validation: 'required' },
]
const data = {}
</script>

<template>
  <FormKit :schema="schema" :data="data" />
</template>

Props

NameTypeDescription
optionsarrayList of options
optionLabelstringField for label
optionValuestringField for value
filterbooleanEnable filtering
placeholderstringPlaceholder text
ptobjectPass-through options
ptOptionsobjectPass-through options
unstyledbooleanDisable default styles
sizestringInput size
......See PrimeVue docs for all props

See PrimeVue MultiSelect docs for more details.

FormKit PrimeVue Module