Currency Column

Currency Column

List Column

currency - displays the value as a formatted currency

total_amount:
    label: Loan amount
    type: currency

This column is introduced after installing the Currency plugin (opens new window) available on the October CMS marketplace. You may install it with the following command.

php artisan plugin:install Responsiv.Currency

The following properties are supported.

PropertyDescription
formatprovides a display format. Supported values: long, short, null.
fromCodespecify the source currency code.
toCodespecify the display currency code.
sitedisplay the currency using the multisite definition context. Default: false
currencyFromread the currency code from another model attribute. Supports dot notation for relations. Default: null

Use the format property to display the column value using a longer format.

total_amount:
    label: Loan amount
    type: currency
    format: long

Set the site property to true if the model value is stored using the multisite definition. This will automatically set the toCode and fromCode values for the site definition.

total_amount:
    label: Loan amount
    type: currency
    site: true

Use the currencyFrom property to lock the display currency to a value stored on the record itself. This is useful for financial records like orders and invoices where the currency is determined at creation time and should not change when the active site changes.

total:
    label: Total
    type: currency
    currencyFrom: currency_code

The property supports dot notation for reading the currency code from a related model.

price:
    label: Price
    type: currency
    currencyFrom: order.currency_code
On This Page