Skip to Content
Account
Enter the email address on your account.
Forgot Your Username?
Enter your password.
Forgot Your Password?

Or continue with

Developer

VariantPrice Form Field

2 Min Read
On This Page

VariantPriceField is a FormField subclass that renders a Bootstrap 5 input-group pairing the store's currency symbol with a decimal text input. It is used on the product variant form wherever a price needs visual currency context — matching the style of the main product pricing section.

Key Classes

ClassFilePurpose
VariantPriceFieldadministrator/components/com_j2commerce/src/Field/VariantPriceField.phpRenders the currency-prefixed input
CurrencyHelperadministrator/components/com_j2commerce/src/Helper/CurrencyHelper.phpgetSymbol() — returns the active store currency symbol

Rendered Output

The field generates a Bootstrap 5 input-group:

<div class="input-group">
    <span class="input-group-text">$</span>
    <input type="text" name="jform[attribs][j2commerce][variable][123][price]"
           id="jform_attribs_j2commerce_variable_123_price"
           value="19.99"
           class="form-control"
           inputmode="decimal">
</div>

The currency symbol ($, €, £, etc.) is resolved at render time from CurrencyHelper::getSymbol() using the component's active currency setting.

Supported Attributes

AttributeMaps toDescription
classclass on <input>Additional CSS classes appended after form-control
hintplaceholder on <input>Placeholder text, e.g. 0.00
readonlyreadonly on <input>Prevents editing
disableddisabled on <input>Disables the input
requiredrequired on <input>HTML5 required constraint

The field always renders inputmode="decimal" to trigger the numeric keyboard on mobile devices.

XML Usage

<!-- File: administrator/components/com_j2commerce/forms/variant.xml (example) -->

<form addfieldprefix="J2Commerce\Component\J2commerce\Administrator\Field">
    <fieldset name="pricing">
        <field
            name="price"
            type="VariantPrice"
            label="COM_J2COMMERCE_FIELD_VARIANT_PRICE_LABEL"
            description="COM_J2COMMERCE_FIELD_VARIANT_PRICE_DESC"
            hint="0.00"
            filter="float"
        />
    </fieldset>
</form>

XML Attributes

AttributeTypeDefaultDescription
typestring—Must be VariantPrice
hintstring—Placeholder text shown when empty
filterstringstringRecommended: float to sanitize numeric input
requiredboolfalseMark field as required
readonlyboolfalsePrevent value changes
disabledboolfalseDisable the control
classstring—Additional CSS classes on <input>

Usage in Plugin Forms

Use VariantPrice in any plugin form where a price with the currency symbol context is needed:

<!-- File: plugins/j2commerce/app_yourplugin/config.xml -->

<?xml version="1.0" encoding="UTF-8"?>
<config>
    <fields name="params">
        <fieldset name="basic" label="COM_PLUGINS_BASIC_FIELDSET_LABEL">
            <field
                name="minimum_order_value"
                type="VariantPrice"
                addfieldprefix="J2Commerce\Component\J2commerce\Administrator\Field"
                label="PLG_J2COMMERCE_APP_YOURPLUGIN_FIELD_MIN_ORDER_LABEL"
                description="PLG_J2COMMERCE_APP_YOURPLUGIN_FIELD_MIN_ORDER_DESC"
                hint="0.00"
                filter="float"
                default="0.00"
            />
        </fieldset>
    </fields>
</config>

Input-Group Pattern

The Bootstrap 5 input-group pattern used here keeps label, symbol, and input visually cohesive without extra markup. When using this field inside a Joomla subform (e.g. the variant repeater), the input-group renders correctly without any additional JavaScript wiring.

  • Advanced Pricing — Price rule and special pricing architecture

Still stuck? Our team can help.

Back to Top