useItems
Commons
stable
Normalises the polymorphic items prop accepted by list-based components (Select, Combobox, Autocomplete, List). Transforms raw item arrays into internal list item descriptors and provides bidirectional model value transformers (in from model, out to model) that respect returnObject mode and a custom value comparator.
API
Signature
Signature TypeScript complète extraite du fichier du composable.
Interfaces consommées
IItemProps
IInternalListItem
API
Paramètres
Paramètres d'entrée acceptés par ce composable.
- propsrequisIItemProps & { itemType?: string }
- Component props extending IItemProps (items, itemTitle, itemValue, itemProps, returnObject, valueComparator). itemType is an optional tag used during transformation.
API
Valeurs de retour
Propriétés et méthodes exposées par l'objet retourné par le composable.
- items
- Computed array of normalised internal list items derived from props.items. Recomputes whenever props.items changes.
- transformIn
- Converts an array of model values (or raw objects in returnObject mode) to the matching internal list item descriptors. Handles null-item and custom comparator edge cases.
- transformOut
- Converts selected internal list items back to the model value format: raw objects when returnObject is true, item values otherwise.
Usage
Exemples
Extraits de code prêts à coller.
Normalise a string item list
Round-trip with transformIn / transformOut