BigglesZX / django-prefixed-textinput

Django widget that extends TextInput to display a non-editable string prefix

django-prefixed-textinput

An extension of the default TextInput widget that displays a read-only string prefix over the input field.

Compatibility

The widget has been tested on Django 3.2 and 4.0 on Python 3.8, though I expect it to be fairly compatible with other versions given the simplicity of the implementation. For now, the package is marked as requiring Python 3.6 or higher.

Styling for the widget includes support for right-to-left (RTL) languages so this should work more or less as expected. Note that IE11 is not supported as the widget styling requires support for CSS Variables.

Installation

$ pip install django-prefixed-textinput

Usage

Add prefixed_textinput to your INSTALLED_APPS setting:

INSTALLED_APPS = [
    # ...
    'prefixed_textinput',
]

Import the widget:

from prefixed_textinput import PrefixedTextInput

Define a custom admin form, which allows overriding the widget for a specific field:

# forms.py
from django import forms
from prefixed_textinput import PrefixedTextInput


class MyModelAdminForm(forms.ModelForm):
    class Meta:
        widgets = {
            'myfield':
                PrefixedTextInput(prefix='FOO'),
        }
        fields = '__all__'

Specify the custom admin form in your admin definition:

# admin.py
from django import admin

from .forms import MyModelAdminForm
from .models import MyModel


@admin.register(MyModel)
class ProductAdmin(admin.ModelAdmin):
    form = MyModelAdminForm

Development

If working locally on the package you can install the development tools via pip:

$ pip install -e .[dev]

Run the bundled Django example project:

$ cd example_project
$ python manage.py migrate
$ python manage.py createsuperuser
$ python manage.py runserver 0.0.0.0:8000
$ open http://localhost:8000/admin/

Navigate to the example Book model in the Bookshop app to see the widget in action.

To lint with flake8:

$ flake8

Issues, Suggestions, Contributions

...are welcome on GitHub. Thanks for your interest in django-prefixed-textinput!