Django-Colorful 技术文档

1. 安装指南

要安装 Django-Colorful 扩展，请使用 pip 包管理器运行以下命令：

pip install django-colorful

确保 'colorful' 被添加到你的 INSTALLED_APPS 设置中：

INSTALLED_APPS.append('colorful')

2. 项目的使用说明

Django-Colorful 提供了一个数据库和表单字段，允许您以 RGB 格式接受和存储颜色。

要将颜色字段添加到模型中，首先需要从 colorful.fields 导入 RGBColorField。然后在模型定义中添加该字段：

from django.db import models
from colorful.fields import RGBColorField

class Tag(models.Model):
    color = RGBColorField()

RGBColorField 类还接受一个 colors 关键字参数，可以设置为一个颜色列表，该列表中的颜色将作为预设颜色面板显示：

color = RGBColorField(colors=['#FF0000', '#00FF00', '#0000FF'])

ColorFieldWidget 应提供一个基于 JavaScript 的替代方案，用于不支持 HTML5 颜色输入的浏览器。

注意：如果希望在使用 Django Grappelli 时启用 HTML5 颜色输入，请确保在设置文件中将 GRAPPELLI_CLEAN_INPUT_TYPES 设置为 False。

3. 项目API使用文档

Django-Colorful 主要提供了一个字段类型 RGBColorField，可用于模型中，以下是该字段的简要API文档：

• RGBColorField: 用于模型的字段，存储颜色值，接受一个可选的 colors 参数来定义预置颜色列表。

4. 项目安装方式

项目的安装方式已在“安装指南”一节中详细说明。简要概括如下：

1. 使用 pip 命令安装 django-colorful 包。
2. 在 Django 项目的 INSTALLED_APPS 中添加 'colorful'。