Skip to Content

Masked Input Widget

by
Odoo

$ 12.99

v 19.0 Third Party
Availability
Odoo Online
Odoo.sh
On Premise
Odoo Apps Dependencies • Contacts (contacts)
• Discuss (mail)
Lines of code 188
Technical Name mindscript_masked_input
LicenseOPL-1
Websitehttps://www.mindscriptech.com/
You bought this module and need support? Click here!
Availability
Odoo Online
Odoo.sh
On Premise
Odoo Apps Dependencies • Contacts (contacts)
• Discuss (mail)
Lines of code 188
Technical Name mindscript_masked_input
LicenseOPL-1
Websitehttps://www.mindscriptech.com/
Mindscript Technologies Logo
⌨ Enforce a clean, consistent format on any field, as the user types.

Masked Input Widget

A backend field widget that enforces a fixed input format live, as the user types. Give a char field a mask like xxxx-xxxxxxx and it formats a phone as 0300-1234567 on the fly, blocks characters that do not fit, inserts the literals (-, /, spaces) for you, shows the required format as a hint, and flags an inline error if the value is incomplete on blur. No new models, no stored data, the field keeps its normal value, just cleanly formatted.

Format As You Type Mask Tokens x · a · * Inline Validation Any Char Field
Masked Input Widget - enforce a clean, consistent format on any field as the user types

What This Module Does

Free-text fields drift into a dozen inconsistent shapes: phone numbers with and without dashes, ID codes with stray spaces, tax numbers nobody can search. This widget locks a field to one format and guides the user into it while they type.

● Format as you type
Each keystroke is checked against the mask. Characters that do not fit are blocked, and the literal separators (-, /, spaces) are inserted automatically, so the value is always cleanly shaped.
● Simple mask tokens
x accepts a digit, a a letter, * any letter or digit. Every other character is a fixed literal placed for you, so any pattern is just a short string like xxxx-xxxxxxx.
● Inline validation & hint
The required format shows as a hint in the field, and an inline error appears if the value is left incomplete or wrong on blur, so bad data never slips through.
Pure front-end widget. No new models and no stored data, the field keeps its normal value. Applied to the contact phone field out of the box, point it at CNIC, NTN, tax IDs, postal codes, or any char field.

How it works

Add the widget to a char field, hand it a mask, and the format is enforced everywhere that field appears.

  1. Install the module. The contact phone field is already wired to the masked_input widget as a working example.
  2. To use it elsewhere, set widget="masked_input" on any char field in a form view and pass a mask via options.
  3. Build the mask from tokens: x for a digit, a for a letter, * for either, plus any literal characters (-, /, space) you want inserted automatically.
  4. As the user types, the value is formatted live, off-pattern keys are blocked, and an inline error shows on blur if it is incomplete.
Note: A mask is just a short string. xxxx-xxxxxxx gives a phone like 0300-1234567, xxxxx-xxxxxxx-x gives a CNIC like 12345-1234567-1, and xxxxxxx-x gives an NTN like 1234567-8. Change the string and the format changes with it, no code required.

See It in Action

From the format hint, through live formatting as you type, to the inline error on an incomplete value.

1. The Hint The field shows the required format up front, so the user knows the exact shape to enter
Masked input field showing the required-format hint
2. As You Type The value is auto-formatted live, with separators inserted for you (for example 0300-1234567)
Masked input field auto-formatting a value as the user types, for example 0300-1234567
3. Inline Error When the format is incomplete, a clear inline error is shown so the value cannot be saved half-typed
Masked input field showing an inline error when the format is incomplete
Mindscript Technologies
Mindscript Technologies

Helping businesses work smarter with tailored Odoo solutions. We deliver custom modules, integrations, and workflow improvements designed for your needs.

info@mindscriptech.com www.mindscriptech.com
© Mindscript Technologies · Odoo Apps & Solutions 
Odoo Proprietary License v1.0

This software and associated files (the "Software") may only be used (executed,
modified, executed after modifications) if you have purchased a valid license
from the authors, typically via Odoo Apps, or if you have received a written
agreement from the authors of the Software (see the COPYRIGHT file).

You may develop Odoo modules that use the Software as a library (typically
by depending on it, importing it and using its resources), but without copying
any source code or material from the Software. You may distribute those
modules under the license of your choice, provided that this license is
compatible with the terms of the Odoo Proprietary License (For example:
LGPL, MIT, or proprietary licenses similar to this one).

It is forbidden to publish, distribute, sublicense, or sell copies of the Software
or modified copies of the Software.

The above copyright notice and this permission notice must be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.

Please log in to comment on this module

  • The author can leave a single reply to each comment.
  • This section is meant to ask simple questions or leave a rating. Every report of a problem experienced while using the module should be addressed to the author directly (refer to the following point).
  • If you want to start a discussion with the author or have a question related to your purchase, please use the support page.