fabiocaccamo/django-colorfieldPublic

NotificationsYou must be signed in to change notification settings
Fork96
Star645

🎨 color field for django models with a nice color-picker in the admin.

License

MIT license

645 stars 96 forks Branches Tags Activity

Star

Notifications

You must be signed in to change notification settings

Branches Tags

Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 388 Commits
.github		.github
colorfield		colorfield
tests		tests
.gitattributes		.gitattributes
.gitignore		.gitignore
.pre-commit-config.yaml		.pre-commit-config.yaml
CHANGELOG.md		CHANGELOG.md
CODE_OF_CONDUCT.md		CODE_OF_CONDUCT.md
LICENSE.txt		LICENSE.txt
MANIFEST.in		MANIFEST.in
README.md		README.md
SECURITY.md		SECURITY.md
pyproject.toml		pyproject.toml
requirements-test.txt		requirements-test.txt
requirements.txt		requirements.txt
runtests.py		runtests.py
setup.py		setup.py
tox.ini		tox.ini

Repository files navigation

django-colorfield

simple color field for your models with a nice color-picker in the admin-interface.

Installation

Runpip install django-colorfield
Addcolorfield tosettings.INSTALLED_APPS
Runpython manage.py collectstatic
Restart your application server

Usage

Settings

This package doesn't need any setting.

Models

Just add color field(s) to your models like this:

fromcolorfield.fieldsimportColorFieldfromdjango.dbimportmodelsclassMyModel(models.Model):color=ColorField(default='#FF0000')

Field Options

These are the supported custom options:format,image_field,samples

format

The following formats are supported:hex(default),hexa,rgb,rgba.

fromcolorfield.fieldsimportColorFieldfromdjango.dbimportmodelsclassMyModel(models.Model):color=ColorField(format="hexa")

image_field

It is possible to auto-populate the field value getting the color from an image using theimage_field option.

The color will be calculated from thetop-left pixel color of the image each time the model instance is saved.

fromcolorfield.fieldsimportColorFieldfromdjango.dbimportmodelsclassMyModel(models.Model):image=models.ImageField(upload_to="images")color=ColorField(image_field="image")

samples

It is possible to provide a palette of colors to choose from to the widget using thesamples option.

This optionis not restrictive (on the contrary ofchoices option), it is also possible to choose another color from the spectrum.

fromcolorfield.fieldsimportColorFieldfromdjango.dbimportmodelsclassMyModel(models.Model):COLOR_PALETTE= [        ("#FFFFFF","white", ),        ("#000000","black", ),    ]# not restrictive, allows the selection of another color from the spectrum.color=ColorField(samples=COLOR_PALETTE)# restrictive, it is mandatory to choose a color from the palettecolor=ColorField(choices=COLOR_PALETTE)

Forms

Model forms

Thecolorfield.fields.ColorField can be used in Django model forms (django.forms.ModelForm) to provide a color picker widget.When used in a model form, the field automatically validates the color format based on the specifiedformat (e.g.,hex,rgb,rgba).

fromdjangoimportformsclassMyModelForm(forms.ModelForm):classMeta:model=MyModelfields= ["color"]

Plain forms

Thecolorfield.forms.ColorField can be used in plain Django forms (django.forms.Form) to provide a color-picker widget.This is useful when you need a color input outside of a model context.

fromdjangoimportformsfromcolorfield.formsimportColorFieldclassMyForm(forms.Form):color=ColorField(initial="#FF0000",format="hex")

Admin

The admin will kindly provide a simplecolor picker for all color fields. :)

Testing

# clone repositorygit clone https://github.com/fabiocaccamo/django-colorfield.git&&cd django-colorfield# create virtualenv and activate itpython -m venv venv&&. venv/bin/activate# upgrade pippython -m pip install --upgrade pip# install requirementspip install -r requirements.txt -r requirements-test.txt# install pre-commit to run formatters and linterspre-commit install --install-hooks# run teststox# orpython runtests.py# orpython -m djangotest --settings"tests.settings"