@canutin/svelte-currency-input 0.3.0 → 0.4.0

package/README.md

@@ -58,15 +58,16 @@ This is more or less what `<CurrencyInput />` looks like under the hood:
 
 ## API
 
-| Option            | Type      | Default     | Description                                                                                                                                         |
-| ----------------- | --------- | ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
-| value             | `number`  | `undefined` | Initial value. If left `undefined` a formatted value of `0` is visible as a placeholder                                                             |
-| locale            | `string`  | `en-US`     | Overrides default locale. [Examples](https://gist.github.com/ncreated/9934896)                                                                      |
-| currency          | `string`  | `USD`       | Overrides default currency. [Examples](https://github.com/datasets/currency-codes/blob/master/data/codes-all.csv)                                   |
-| name              | `string`  | `total`     | Applies the name to the [input fields](#how-it-works) for _unformatted_ (e.g `[name=total]`) and _formatted_ (e.g. `[name=formatted-total]`) values |
-| required          | `boolean` | `false`     | Marks the inputs as required                                                                                                                        |
-| disabled          | `boolean` | `false`     | Marks the inputs as disabled                                                                                                                        |
-| isNegativeAllowed | `boolean` | `true`      | If `false`, forces formatting only to positive values and ignores `--positive` and `--negative` styling modifiers                                   |
+| Option            | Type            | Default     | Description                                                                                                                                         |
+| ----------------- | --------------- | ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
+| value             | `number`        | `undefined` | Initial value. If left `undefined` a formatted value of `0` is visible as a placeholder                                                             |
+| locale            | `string`        | `en-US`     | Overrides default locale. [Examples](https://gist.github.com/ncreated/9934896)                                                                      |
+| currency          | `string`        | `USD`       | Overrides default currency. [Examples](https://github.com/datasets/currency-codes/blob/master/data/codes-all.csv)                                   |
+| name              | `string`        | `total`     | Applies the name to the [input fields](#how-it-works) for _unformatted_ (e.g `[name=total]`) and _formatted_ (e.g. `[name=formatted-total]`) values |
+| required          | `boolean`       | `false`     | Marks the inputs as required                                                                                                                        |
+| disabled          | `boolean`       | `false`     | Marks the inputs as disabled                                                                                                                        |
+| placeholder       | `number` `null` | `0`         | Overrides the default placeholder. Setting the value to a `number` will display it as formatted. Setting it to `null` will not show a placeholder   |
+| isNegativeAllowed | `boolean`       | `true`      | If `false`, forces formatting only to positive values and ignores `--positive` and `--negative` styling modifiers                                   |
 
 ## Styling
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@canutin/svelte-currency-input",
-	"version": "0.3.0",
+	"version": "0.4.0",
 	"exports": {
 		".": "./index.js"
 	},

package/src/lib/CurrencyInput.svelte

@@ -1,17 +1,18 @@
 <script lang="ts">
-	export let value: number = 0;
-	export let locale: string = 'en-US';
-	export let currency: string = 'USD';
-	export let name: string = 'total';
+	const DEFAULT_LOCALE = 'en-US';
+	const DEFAULT_CURRENCY = 'USD';
+	const DEFAULT_NAME = 'total';
+	const DEFAULT_VALUE = 0;
+
+	export let value: number = DEFAULT_VALUE;
+	export let locale: string = DEFAULT_LOCALE;
+	export let currency: string = DEFAULT_CURRENCY;
+	export let name: string = DEFAULT_NAME;
 	export let required: boolean = false;
 	export let disabled: boolean = false;
+	export let placeholder: number | null = DEFAULT_VALUE;
 	export let isNegativeAllowed: boolean = true;
 
-	let formattedValue = '';
-	$: isZero = value === 0;
-	$: isNegative = value < 0;
-	$: value, applyFormatting();
-
 	// Formats value as: e.g. $1,523.00 | -$1,523.00
 	const formatCurrency = (
 		value: number,
@@ -26,18 +27,26 @@
 		}).format(value);
 	};
 
-	const placeholder = formatCurrency(0, 2, 2); // e.g. '$0.00'
-	const currencySymbol = formatCurrency(0, 0)
-		.replace('0', '') // e.g. '$0' > '$'
-		.replace(/\u00A0/, ''); // e.g '0 €' > '€'
-	const currencyDecimal = new Intl.NumberFormat(locale).format(1.1).charAt(1); // '.' or ','
+	// Checks if the key pressed is allowed
+	const handleKeyDown = (event: KeyboardEvent) => {
+		const isDeletion = event.key === 'Backspace' || event.key === 'Delete';
+		const isModifier = event.metaKey || event.altKey || event.ctrlKey;
+		const isArrowKey = event.key === 'ArrowLeft' || event.key === 'ArrowRight';
+		const isInvalidCharacter = !/^\d|,|\.|-$/g.test(event.key); // Keys that are not a digit, comma, period or minus sign
+
+		if (!isDeletion && !isModifier && !isArrowKey && isInvalidCharacter) event.preventDefault();
+	};
 
 	// Updates `value` by stripping away the currency formatting
-	const setValue = (event?: KeyboardEvent) => {
-		// Don't format if the user is typing a currencyDecimal point
-		if (event?.key === currencyDecimal) return;
+	const setUnformattedValue = (event: KeyboardEvent) => {
+		// Don't format if the user is typing a `currencyDecimal` point
+		const currencyDecimal = new Intl.NumberFormat(locale).format(1.1).charAt(1); // '.' or ','
+		if (event.key === currencyDecimal) return;
 
 		// If `formattedValue` is ['$', '-$', "-"] we don't need to continue
+		const currencySymbol = formatCurrency(0, 0)
+			.replace('0', '') // e.g. '$0' > '$'
+			.replace(/\u00A0/, ''); // e.g '0 €' > '€'
 		const ignoreSymbols = [currencySymbol, `-${currencySymbol}`, '-'];
 		const strippedUnformattedValue = formattedValue.replace(' ', '');
 		if (ignoreSymbols.includes(strippedUnformattedValue)) return;
@@ -48,7 +57,7 @@
 			: formattedValue.replace(/[^0-9,.]/g, '');
 
 		// Reverse the value when minus is pressed
-		if (isNegativeAllowed && event?.key === '-') value = value * -1;
+		if (isNegativeAllowed && event.key === '-') value = value * -1;
 
 		// Finally set the value
 		if (Number.isNaN(parseFloat(unformattedValue))) {
@@ -62,9 +71,15 @@
 		}
 	};
 
-	const applyFormatting = () => {
+	const setFormattedValue = () => {
 		formattedValue = isZero ? '' : formatCurrency(value, 2, 0);
 	};
+
+	let formattedValue = '';
+	let formattedPlaceholder = placeholder !== null ? formatCurrency(placeholder, 2, 2) : '';
+	$: isZero = value === 0;
+	$: isNegative = value < 0;
+	$: value, setFormattedValue();
 </script>
 
 <div class="currencyInput">
@@ -80,10 +95,11 @@
 		inputmode="numeric"
 		name={`formatted-${name}`}
 		required={required && !isZero}
-		{placeholder}
+		placeholder={formattedPlaceholder}
 		{disabled}
 		bind:value={formattedValue}
-		on:keyup={setValue}
+		on:keydown={handleKeyDown}
+		on:keyup={setUnformattedValue}
 	/>
 </div>
 

package/src/routes/+page.svelte

@@ -18,13 +18,19 @@
 	<div class="demoForm__container">
 		<CurrencyInput name="total" value={-42069.69} />
 		<CurrencyInput name="rent" />
+		<CurrencyInput name="balance" value={1234.56} isNegativeAllowed={false} placeholder={null} />
 		<CurrencyInput name="cashflow" value={5678.9} />
-		<CurrencyInput name="balance" value={1234.56} isNegativeAllowed={false} />
 
 		<CurrencyInput name="amount" value={5678.9} {locale} {currency} />
-		<CurrencyInput name="deficit" value={1234.56} isNegativeAllowed={false} {locale} {currency} />
 		<CurrencyInput name="loss" value={97532.95} disabled={true} {locale} {currency} />
 		<CurrencyInput name="cost" value={-42069.69} {locale} {currency} />
+		<CurrencyInput
+			name="deficit"
+			placeholder={1234.56}
+			isNegativeAllowed={false}
+			{locale}
+			{currency}
+		/>
 	</div>
 
 	<nav class="demoForm__output">

package/tests/svelte-currency-input.test.ts

@@ -71,16 +71,16 @@ test.describe('CurrencyInput', () => {
 					'formatted-total': '-$42,069.69',
 					rent: '0',
 					'formatted-rent': '',
-					cashflow: '5678.9',
-					'formatted-cashflow': '$5,678.9',
 					balance: '1234.56',
 					'formatted-balance': '$1,234.56',
+					cashflow: '5678.9',
+					'formatted-cashflow': '$5,678.9',
 					amount: '5678.9',
 					'formatted-amount': '€ 5.678,9',
-					deficit: '1234.56',
-					'formatted-deficit': '€ 1.234,56',
 					cost: '-42069.69',
-					'formatted-cost': '€ -42.069,69'
+					'formatted-cost': '€ -42.069,69',
+					deficit: '0',
+					'formatted-deficit': ''
 				},
 				null,
 				2
@@ -136,6 +136,74 @@ test.describe('CurrencyInput', () => {
 		await expect(rentUnformattedInput).toHaveValue('0');
 	});
 
+	test("Incorrect characters can't be entered", async ({ page }) => {
+		await page.goto('/');
+
+		const isMacOs = process.platform === 'darwin';
+		const rentUnformattedInput = page.locator('.currencyInput__unformatted[name=rent]');
+		const rentFormattedInput = page.locator('.currencyInput__formatted[name="formatted-rent"]');
+
+		// Check the there is no value in the input
+		await expect(rentUnformattedInput).toHaveValue('0');
+		await expect(rentFormattedInput).toHaveValue('');
+
+		// Check typing letters doesn't do anything
+		await rentFormattedInput.focus();
+		await page.keyboard.type('abc');
+		await expect(rentUnformattedInput).toHaveValue('0');
+		await expect(rentFormattedInput).toHaveValue('');
+
+		// Check keyboard combinations don't do anything
+		await page.keyboard.press('Shift+A');
+		await expect(rentFormattedInput).toHaveValue('');
+
+		// Check keyboard shortcuts are allowed
+		await page.keyboard.type('420.69');
+		await expect(rentFormattedInput).toHaveValue('$420.69');
+		await expect(rentUnformattedInput).toHaveValue('420.69');
+
+		// Select all
+		isMacOs ? await page.keyboard.press('Meta+A') : await page.keyboard.press('Control+A');
+
+		// Check "Backspace" works
+		await page.keyboard.press('Backspace');
+		await expect(rentUnformattedInput).toHaveValue('0');
+		await expect(rentFormattedInput).toHaveValue('');
+
+		// Add data to the field again
+		await page.keyboard.type('-420.69');
+		await expect(rentFormattedInput).toHaveValue('-$420.69');
+		await expect(rentUnformattedInput).toHaveValue('-420.69');
+
+		// Select all
+		isMacOs ? await page.keyboard.press('Meta+A') : await page.keyboard.press('Control+A');
+
+		// Check "Delete" also works
+		await page.keyboard.press('Delete');
+		await expect(rentUnformattedInput).toHaveValue('0');
+		await expect(rentFormattedInput).toHaveValue('');
+	});
+
+	test('Placeholders can be overriden', async ({ page }) => {
+		await page.goto('/');
+
+		// Default placeholder
+		const rentFormattedInput = page.locator('.currencyInput__formatted[name="formatted-rent"]');
+		await expect(rentFormattedInput).toHaveAttribute('placeholder', '$0.00');
+
+		// Null placeholder
+		const balanceFormattedInput = page.locator(
+			'.currencyInput__formatted[name="formatted-balance"]'
+		);
+		await expect(balanceFormattedInput).toHaveAttribute('placeholder', '');
+
+		// Overriden placeholder
+		const deficitFormattedInput = page.locator(
+			'.currencyInput__formatted[name="formatted-deficit"]'
+		);
+		await expect(deficitFormattedInput).toHaveAttribute('placeholder', '€ 1.234,56'); // The space is `%A0`, not `%20`
+	});
+
 	test.skip('Updating chained inputs have the correct behavior', async () => {
 		// TODO
 	});