Skip to content

PrimeAutoComplete

A FormKit wrapper for PrimeVue's AutoComplete component.

Live Example on Website

Usage

vue
<FormKit type="primeautocomplete" :options="userList" option-label="name" v-model="selectedUser" />

Object-based Example

vue
<script setup>
const userList = [
  { id: '1', name: 'Tom', value: '123' },
  { id: '2', name: 'Tim', value: '124' },
]
const selectedUser = ref()
</script>

<FormKit
  type="primeautocomplete"
  label="Object AutoComplete - Use [t]om"
  :options="userList"
  option-label="name"
  v-model="selectedUser"
/>

Schema-based Example

js
const schema = [
  {
    $formkit: 'primeAutoComplete',
    label: 'Object AutoComplete - Use [t]om',
    options: [
      { id: '1', name: 'Tom', value: '123' },
      { id: '2', name: 'Tim', value: '124' },
    ],
    optionLabel: 'name',
    name: 'selectedUser',
  },
]

Props

NameTypeDescription
ptobjectPass-through options
ptOptionsobjectPass-through options
unstyledbooleanDisable default styles
dropdownbooleanShow dropdown button
multiplebooleanEnable multiple selection
typeaheadnumberDelay for suggestions
optionLabelstringField for label
optionsarraySuggestions list
sizestringInput size
minLengthnumberMinimum input length
placeholderstringPlaceholder text
fluidbooleanFull width input
separatorsarraySeparators for multiple values

See PrimeVue AutoComplete docs for more details.

FormKit PrimeVue Module