Skip to content

Props

<VueCurrencyConverter> accepts a large set of props to control behavior, appearance, and data sources. All props are optional — sensible defaults are provided.

PropTypeDefaultDescription
modelValueModel— (req)Bound value for v-model. Holds the current state of the currency input.
listConfigPartial<ListParams>see belowConfiguration for the currency list / behavior. Any subset of ListParams. Unspecified fields fall back to component defaults (below).
itemHeightnumberFixed pixel height for each item row (overrides CSS var–driven sizing if provided).
sizeSizeComponent size token used by your design system (e.g., sm, md, …). Controls overall spacing/row heights via CSS vars.
disabledbooleanfalseDisables user interaction with the input and list.

listConfig

KeyTypeDefaultDescription
itemsPerViewnumberDEFAULT_ITEMS_PER_VIEWHow many items are visible in the scroll viewport.
itemHeightnumberPer-item row height (px). If omitted, size/CSS vars are used.
availableCurrenciesCurrencyCode[]Optional allowlist of currencies to display.
animationNamestringCustom CSS animation name for list transitions.
reversebooleanfalseReverses list order.
needFormatbooleantrueWhether to live-format typed values (e.g., thousands separators).
openBlockedbooleanfalseIf true, prevents opening the dropdown/list.
item.hideCodebooleanfalseHide the currency code (e.g., USD).
item.hideNamebooleanfalseHide the currency name (e.g., “US Dollar”).
item.hideSymbolbooleanfalseHide the currency symbol (e.g., $).