.. include:: /Includes.rst.txt
.. _typo3-fluid-format-currency:
===============
format.currency
===============
Formats a given float to a currency representation.
Examples
========
Defaults
--------
::
123.456
Output::
123,46
All parameters
--------------
::
54321
Output::
$54,321.00
Inline notation
---------------
::
{someNumber -> f:format.currency(thousandsSeparator: ',', currencySign: 'EUR')}
Output::
54,321,00 EUR
Depending on the value of ``{someNumber}``.
Use dash for decimals without value
-----------------------------------
::
123.00
Output::
123,-
Arguments
=========
.. _format.currency_currencysign:
currencySign
------------
:aspect:`DataType`
string
:aspect:`Required`
false
:aspect:`Description`
The currency sign, eg $ or .
.. _format.currency_decimalseparator:
decimalSeparator
----------------
:aspect:`DataType`
string
:aspect:`Default`
','
:aspect:`Required`
false
:aspect:`Description`
The separator for the decimal point.
.. _format.currency_thousandsseparator:
thousandsSeparator
------------------
:aspect:`DataType`
string
:aspect:`Default`
'.'
:aspect:`Required`
false
:aspect:`Description`
The thousands separator.
.. _format.currency_prependcurrency:
prependCurrency
---------------
:aspect:`DataType`
mixed
:aspect:`Required`
false
:aspect:`Description`
Select if the currency sign should be prepended
.. _format.currency_separatecurrency:
separateCurrency
----------------
:aspect:`DataType`
mixed
:aspect:`Default`
true
:aspect:`Required`
false
:aspect:`Description`
Separate the currency sign from the number by a single space, defaults to true due to backwards compatibility
.. _format.currency_decimals:
decimals
--------
:aspect:`DataType`
mixed
:aspect:`Default`
2
:aspect:`Required`
false
:aspect:`Description`
Set decimals places.
.. _format.currency_usedash:
useDash
-------
:aspect:`DataType`
mixed
:aspect:`Required`
false
:aspect:`Description`
Use the dash instead of decimal 00