@nxgt/material 3.101.0 → 3.104.0

package/dist/lib/hooks/index.d.ts

@@ -1,6 +1,7 @@
 export * from './resolve-theme.js';
 export * from './unsaved-guard-rules.js';
 export * from './use-allowed-transitions.js';
+export * from './use-barcode-scanner.js';
 export * from './use-countdown.js';
 export { useCspNonce } from './use-csp-nonce.js';
 export * from './use-drafts.js';

package/dist/lib/hooks/use-barcode-scanner.d.ts

@@ -0,0 +1,39 @@
+import { ScannerOptions, ScannerResult } from '@nxgt/material-core/barcode-scanner';
+export { createScanner, DEFAULT_SCANNER_MAX_GAP, DEFAULT_SCANNER_MIN_LENGTH, type Scanner, type ScannerOptions, type ScannerResult, } from '@nxgt/material-core/barcode-scanner';
+export type UseBarcodeScannerOptions = ScannerOptions & {
+    /** Called with the code when a scan ends. The Enter that closed it is swallowed. */
+    onScan: (code: string) => void;
+    /** Off while false: nothing is listened to and nothing is swallowed. Default `true`. */
+    enabled?: boolean;
+    /**
+     * A CSS selector of the form fields a scan is also accepted in (a search
+     * field). A scan is always accepted outside form fields; every other
+     * `input`, `textarea`, `select` and editable element is typed in.
+     */
+    acceptIn?: string;
+    /**
+     * Called for each key the scanner looked at, after it did, with what it
+     * made of the key and the characters buffered so far. A screen with its own
+     * shortcuts skips them while `pending.length > 1`: those keys are a scan's.
+     */
+    onKey?: (event: KeyboardEvent, state: {
+        result: ScannerResult;
+        pending: string;
+    }) => void;
+};
+type KeyTarget = Pick<Document, 'addEventListener' | 'removeEventListener'>;
+/**
+ * The framework-free binding behind `useBarcodeScanner`: one capture-phase
+ * `keydown` listener on `target`. Returns what removes it.
+ */
+export declare function attachBarcodeScanner(target: KeyTarget, { onScan, acceptIn, onKey, maxGap, minLength, }: Omit<UseBarcodeScannerOptions, 'enabled'>): () => void;
+/**
+ * Hears a keyboard-wedge barcode reader anywhere on the page: a run of keys
+ * each within `maxGap` ms (50) of the last, at least `minLength` (4) long,
+ * closed by Enter, reaches `onScan(code)`. Slower or shorter runs are typing
+ * and are left alone, as are Ctrl, Meta and Alt chords and key repeat. Scans
+ * are accepted outside form fields, and in the fields `acceptIn` names. The
+ * callbacks are read from a ref: a new function each render never re-binds
+ * the listener. Does nothing on the server.
+ */
+export declare function useBarcodeScanner(options: UseBarcodeScannerOptions): void;

package/dist/lib/i18n/resources/en/en.d.ts

@@ -70,6 +70,7 @@ export declare const en: {
             processing: string;
             failed: string;
             "form-failed": string;
+            "type-phrase": string;
         };
         "scroll-progress": string;
         "skip-link": string;
@@ -1373,6 +1374,9 @@ export declare const en: {
             "unit-named": string;
             "use-typed": string;
         };
+        "quantity-stepper": {
+            remove: string;
+        };
         "markdown-textarea-field": {
             write: string;
             preview: string;
@@ -1460,6 +1464,19 @@ export declare const en: {
             invalid: string;
             open: string;
         };
+        "status-menu": {
+            trigger: string;
+            current: string;
+            confirms: string;
+            "confirm-default": string;
+            locked: string;
+            unavailable: string;
+            saving: string;
+            changed: string;
+            failed: string;
+            close: string;
+            choose: string;
+        };
         stepper: {
             step: string;
             completed: string;
@@ -3535,6 +3552,17 @@ export declare const en: {
                 cancel: string;
             };
         };
+        keypad: {
+            commit: string;
+            tender: string;
+            total: string;
+            change: string;
+            due: string;
+            shortcuts: string;
+            "change-label": string;
+            "due-label": string;
+            amount: string;
+        };
         "record-actions": {
             archive: string;
             restore: string;

package/dist/lib/i18n/resources/en/material.json.d.ts

@@ -59,7 +59,8 @@ declare const _default: {
 		"cancel": "Cancel",
 		"processing": "Processing...",
 		"failed": "The action failed.",
-		"form-failed": "The form could not be loaded."
+		"form-failed": "The form could not be loaded.",
+		"type-phrase": "Type {phrase} to confirm"
 	},
 	"scroll-progress": "Scroll progress",
 	"skip-link": "Skip to content",
@@ -1363,6 +1364,9 @@ declare const _default: {
 		"unit-named": "{label} unit",
 		"use-typed": "Use “{unit}”"
 	},
+	"quantity-stepper": {
+		"remove": "Remove {label}"
+	},
 	"markdown-textarea-field": {
 		"write": "Write",
 		"preview": "Preview",
@@ -1450,6 +1454,19 @@ declare const _default: {
 		"invalid": "Enter a valid URL",
 		"open": "Open URL"
 	},
+	"status-menu": {
+		"trigger": "Status of {label}: {status}",
+		"current": "Current status",
+		"confirms": "Asks first",
+		"confirm-default": "Change the status to {label}?",
+		"locked": "Locked",
+		"unavailable": "Not available from {status}",
+		"saving": "Saving the status of {label}",
+		"changed": "Status of {label} changed to {status}",
+		"failed": "The status of {label} could not be changed",
+		"close": "Close",
+		"choose": "Choose a status"
+	},
 	"stepper": {
 		"step": "Step {step}",
 		"completed": "Completed",
@@ -3191,7 +3208,7 @@ declare const _default: {
 			"modulo": "Modulo",
 			"separator": "Argument separator",
 			"answer": "Previous answer",
-			"double-zero": "Double zero",
+			"double-zero": "00, double zero",
 			"quantity": "Enter a quantity",
 			"discount": "Enter a discount",
 			"add-line": "Add to ticket",
@@ -3525,6 +3542,17 @@ declare const _default: {
 			"cancel": "Cancel"
 		}
 	},
+	"keypad": {
+		"commit": "Enter",
+		"tender": "Tender",
+		"total": "Total",
+		"change": "Change {amount}",
+		"due": "Still due {amount}",
+		"shortcuts": "Quick amounts",
+		"change-label": "Change",
+		"due-label": "Still due",
+		"amount": "Amount {amount}"
+	},
 	"record-actions": {
 		"archive": "Archive",
 		"restore": "Restore",

package/dist/lib/i18n/resources/fr/fr.d.ts

@@ -70,6 +70,7 @@ export declare const fr: {
             processing: string;
             failed: string;
             "form-failed": string;
+            "type-phrase": string;
         };
         "scroll-progress": string;
         "skip-link": string;
@@ -1373,6 +1374,9 @@ export declare const fr: {
             "unit-named": string;
             "use-typed": string;
         };
+        "quantity-stepper": {
+            remove: string;
+        };
         "markdown-textarea-field": {
             write: string;
             preview: string;
@@ -1460,6 +1464,19 @@ export declare const fr: {
             invalid: string;
             open: string;
         };
+        "status-menu": {
+            trigger: string;
+            current: string;
+            confirms: string;
+            "confirm-default": string;
+            locked: string;
+            unavailable: string;
+            saving: string;
+            changed: string;
+            failed: string;
+            close: string;
+            choose: string;
+        };
         stepper: {
             step: string;
             completed: string;
@@ -3535,6 +3552,17 @@ export declare const fr: {
                 cancel: string;
             };
         };
+        keypad: {
+            commit: string;
+            tender: string;
+            total: string;
+            change: string;
+            due: string;
+            shortcuts: string;
+            "change-label": string;
+            "due-label": string;
+            amount: string;
+        };
         "record-actions": {
             archive: string;
             restore: string;

package/dist/lib/i18n/resources/fr/material.json.d.ts

@@ -59,7 +59,8 @@ declare const _default: {
 		"cancel": "Annuler",
 		"processing": "Traitement en cours…",
 		"failed": "L’action a échoué.",
-		"form-failed": "Le formulaire n’a pas pu être chargé."
+		"form-failed": "Le formulaire n’a pas pu être chargé.",
+		"type-phrase": "Saisissez {phrase} pour confirmer"
 	},
 	"scroll-progress": "Progression du défilement",
 	"skip-link": "Aller au contenu",
@@ -1363,6 +1364,9 @@ declare const _default: {
 		"unit-named": "Unité de {label}",
 		"use-typed": "Utiliser « {unit} »"
 	},
+	"quantity-stepper": {
+		"remove": "Retirer {label}"
+	},
 	"markdown-textarea-field": {
 		"write": "Écrire",
 		"preview": "Aperçu",
@@ -1450,6 +1454,19 @@ declare const _default: {
 		"invalid": "Saisissez une URL valide",
 		"open": "Ouvrir l’URL"
 	},
+	"status-menu": {
+		"trigger": "Statut de {label} : {status}",
+		"current": "Statut actuel",
+		"confirms": "Demande confirmation",
+		"confirm-default": "Changer le statut en {label} ?",
+		"locked": "Verrouillé",
+		"unavailable": "Indisponible depuis {status}",
+		"saving": "Enregistrement du statut de {label}",
+		"changed": "Statut de {label} changé en {status}",
+		"failed": "Le statut de {label} n'a pas pu être changé",
+		"close": "Fermer",
+		"choose": "Choisir un statut"
+	},
 	"stepper": {
 		"step": "Étape {step}",
 		"completed": "Terminée",
@@ -3191,7 +3208,7 @@ declare const _default: {
 			"modulo": "Modulo",
 			"separator": "Séparateur d’arguments",
 			"answer": "Dernier résultat",
-			"double-zero": "Double zéro",
+			"double-zero": "00, double zéro",
 			"quantity": "Saisir une quantité",
 			"discount": "Saisir une remise",
 			"add-line": "Ajouter au ticket",
@@ -3525,6 +3542,17 @@ declare const _default: {
 			"cancel": "Annuler"
 		}
 	},
+	"keypad": {
+		"commit": "Valider",
+		"tender": "Encaisser",
+		"total": "Total",
+		"change": "Monnaie à rendre {amount}",
+		"due": "Reste à payer {amount}",
+		"shortcuts": "Montants rapides",
+		"change-label": "Monnaie",
+		"due-label": "Reste à payer",
+		"amount": "Montant {amount}"
+	},
 	"record-actions": {
 		"archive": "Archiver",
 		"restore": "Restaurer",

package/dist/lib/i18n/resources/resources.d.ts

@@ -68,6 +68,7 @@ export declare const resources: {
                 processing: string;
                 failed: string;
                 "form-failed": string;
+                "type-phrase": string;
             };
             "scroll-progress": string;
             "skip-link": string;
@@ -1371,6 +1372,9 @@ export declare const resources: {
                 "unit-named": string;
                 "use-typed": string;
             };
+            "quantity-stepper": {
+                remove: string;
+            };
             "markdown-textarea-field": {
                 write: string;
                 preview: string;
@@ -1458,6 +1462,19 @@ export declare const resources: {
                 invalid: string;
                 open: string;
             };
+            "status-menu": {
+                trigger: string;
+                current: string;
+                confirms: string;
+                "confirm-default": string;
+                locked: string;
+                unavailable: string;
+                saving: string;
+                changed: string;
+                failed: string;
+                close: string;
+                choose: string;
+            };
             stepper: {
                 step: string;
                 completed: string;
@@ -3533,6 +3550,17 @@ export declare const resources: {
                     cancel: string;
                 };
             };
+            keypad: {
+                commit: string;
+                tender: string;
+                total: string;
+                change: string;
+                due: string;
+                shortcuts: string;
+                "change-label": string;
+                "due-label": string;
+                amount: string;
+            };
             "record-actions": {
                 archive: string;
                 restore: string;
@@ -3668,6 +3696,7 @@ export declare const resources: {
                 processing: string;
                 failed: string;
                 "form-failed": string;
+                "type-phrase": string;
             };
             "scroll-progress": string;
             "skip-link": string;
@@ -4971,6 +5000,9 @@ export declare const resources: {
                 "unit-named": string;
                 "use-typed": string;
             };
+            "quantity-stepper": {
+                remove: string;
+            };
             "markdown-textarea-field": {
                 write: string;
                 preview: string;
@@ -5058,6 +5090,19 @@ export declare const resources: {
                 invalid: string;
                 open: string;
             };
+            "status-menu": {
+                trigger: string;
+                current: string;
+                confirms: string;
+                "confirm-default": string;
+                locked: string;
+                unavailable: string;
+                saving: string;
+                changed: string;
+                failed: string;
+                close: string;
+                choose: string;
+            };
             stepper: {
                 step: string;
                 completed: string;
@@ -7133,6 +7178,17 @@ export declare const resources: {
                     cancel: string;
                 };
             };
+            keypad: {
+                commit: string;
+                tender: string;
+                total: string;
+                change: string;
+                due: string;
+                shortcuts: string;
+                "change-label": string;
+                "due-label": string;
+                amount: string;
+            };
             "record-actions": {
                 archive: string;
                 restore: string;