Skip to content
UI Brok

Loading…

No results

Browse catalog

Currency Input

A money input with a currency-symbol affordance and live locale formatting; the visible field shows the formatted amount while a hidden field submits the raw decimal.

Preview

Shown formatted; submitted as a raw decimal.

Controls

Disabled
Theme
Surface
Direction
Viewport

Device view renders in an isolated frame so real responsive breakpoints apply. Switch to Full for overflowing popovers.

Installation

terminal 
php artisan ui:add currency-input

Behavior layer (Alpine)

This component installs a self-registering Alpine module to resources/js/ui/currency-input.js. Import the behavior layer once from your bundle so it loads (it hooks alpine:init):

resources/js/ui/index.js JS 
import './currency-input.js';

Registry contract

Install confidence

php artisan ui:add currency-input writes only the generated targets below. The CLI validates each file hash before writing and prompts before replacing local changes unless --force is used.

Version
1.0.0
License
open
Stability
stable
Contract
v2
Foundation
≥ 1.0.0
Type Generated target
blade resources/views/components/ui/currency-input/currency-input.blade.php
js resources/js/ui/currency-input.js

Registry dependencies

None.

Package dependencies

composer: jml/brok:^1.0

npm: alpinejs

Guidance

Specialized input

Collect constrained information with error-reducing formatting.

Use when

  • Use when formatting, validation, or constrained entry meaningfully reduces errors, such as OTP, phone, currency, password, or numeric entry. Do not add specialized behavior if a plain field would be simpler and more forgiving.

Avoid when

  • Avoid using currency-input as a default simply because it is available in the library. Choose it only when its interaction cost, visibility, and behavior match the job to be done.
Task length
short
Interaction cost
medium
Interruptiveness
none
Input precision
precise
Mobile / touch risk
medium
Accessibility risk
high
Needs background context
No
Comparison needed
No

Preferred alternatives

  • Plain text or number field with validation

Anti-patterns

  • Adding formatting behavior that makes correction harder

API

manifest knowledge + registry-derived coverage

Props

Prop Type / values Default Description
disabled false|true false Documented catalog control used by the preview workbench.
name mixed|null null Declared by @props in the registry Blade source.
value mixed|null null Declared by @props in the registry Blade source.
currency string USD Declared by @props in the registry Blade source.
locale string en-US Declared by @props in the registry Blade source.
size string md Declared by @props in the registry Blade source.
invalid bool false Declared by @props in the registry Blade source.
placeholder mixed|null null Declared by @props in the registry Blade source.

Slots

  • x-ui.currency-input.currency-input — Installed subcomponent from the registry item.

Data slots

currency-input currency-input-display

Capabilities

wcag-2.2-aa-target interactive responsive rtl darkMode localized

Behavior

  • Uses server-rendered Blade and semantic HTML.
  • Installs a JavaScript behavior module when the registry item includes resources/js/ui files.
  • Declares registry capability flags: a11y, interactive, responsive, rtl, darkMode, localized.

Usage

previews.components.currency-input.default.blade.php Blade 
<div class="mx-auto w-full max-w-xs">
    <x-ui.field name="price" label="Price" hint="Shown formatted; submitted as a raw decimal.">
        <x-ui.currency-input name="price" currency="EUR" locale="nl-NL" :value="1234.5" />
    </x-ui.field>
</div>

Accessibility & localization

WCAG 2.2 AA RTL-ready data-slot Keyboard focus-visible Localized labels
  • Accessibility target: wcag-2.2-aa-target.
  • Uses semantic HTML and a stable data-slot attribute for styling/scripting hooks.
  • Focus-visible rings use the ring token so keyboard focus is always visible.
  • Disabled and invalid states are conveyed to assistive tech, not by color alone.
  • Targets WCAG 2.2 AA; verify contrast in light, dark, admin and customer surfaces above.
  • Labels go through __() and the component uses logical properties (ms-*, text-start, start-*) so it mirrors correctly — flip the preview to RTL to confirm.

Source

The exact, editable file ui:add writes into your app — copy it or own the whole thing. Previews render this same code; there are no preview-only components.

Changelog

Current version: v1.0.0. See the site changelog for the full release history.