https://github.com/bixat/django_icon_picker
A custom Django model field that allows users to select icons from a predefined set.
https://github.com/bixat/django_icon_picker
django font-awesome icon-pick iconify icons material-icons
Last synced: 28 days ago
JSON representation
A custom Django model field that allows users to select icons from a predefined set.
- Host: GitHub
- URL: https://github.com/bixat/django_icon_picker
- Owner: bixat
- Created: 2024-03-20T18:29:08.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-06-10T18:16:08.000Z (4 months ago)
- Last Synced: 2025-06-10T19:44:46.618Z (4 months ago)
- Topics: django, font-awesome, icon-pick, iconify, icons, material-icons
- Language: Python
- Homepage: https://pypi.org/project/django-icon-picker/
- Size: 516 KB
- Stars: 4
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Django Icon Picker
## Overview
Django Icon Picker is a custom Django model field that allows users to select icons from a predefined set. It supports both SVG icons and icon IDs, depending on the configuration.
## Features
- **SVG File Support**: If the `ICON_PICKER_PATH` is defined in your Django settings, the Icon Picker will download the selected SVG file and save it to the specified path. The path to the saved SVG file will be stored in the `icon` field of the form.
- **Icon ID Support**: If the `ICON_PICKER_PATH` is not defined, the Icon Picker will store the ID of the selected icon in the `icon` field.
- **Easy Integration**: Use the `IconPicker` widget as a model field widget in your Django forms.
## Screenshot
## Installation & Usage
### Step 1: Install Django Icon Picker
First, ensure you have Django Icon Picker installed in your project. If not, you can install it using pip:
```bash
pip install django-icon-picker
```
Add `django_icon_picker` to `INSTALLED_APPS`:
```python
# settings.py
INSTALLED_APPS = [
# Other installed apps...
'django_icon_picker',
]
```
Update `urls.py` (required for SVG file download functionality):
```python
from django.contrib import admin
from django.urls import path, include
from django.conf import settings
from django.conf.urls.static import static
urlpatterns = [
path("admin/", admin.site.urls),
path("icon_picker/", include("django_icon_picker.urls")),
]
if settings.DEBUG:
urlpatterns += static(settings.MEDIA_URL, document_root=settings.MEDIA_ROOT)
```
### Step 2: Configure Django Settings
If you want to use SVG files, define the `ICON_PICKER_PATH` in your Django settings. This is the path where the SVG files will be saved.
```python
# settings.py
ICON_PICKER_PATH = 'media'
# Default icon color
ICON_PICKER_COLOR = "#00bcc9"
```
### Step 3: Use IconField in your model
```python
from django.db import models
from django_icon_picker.field import IconField
from django.utils.html import format_html
class ExampleModel(models.Model):
icon = IconField(max_length=255)
name = models.CharField(max_length=255)
def svg_icon(self):
return format_html(
'
'.format(
f"/{self.icon}"
if self.icon.endswith(".svg")
else f"https://api.iconify.design/{self.icon}.svg",
f"Icon for {self.name}"
)
)
def __str__(self):
return self.name
```
## Configuration Options
| Setting | Default | Description |
|---------|---------|-------------|
| `ICON_PICKER_PATH` | `None` | Path where SVG files will be saved. If not defined, only icon IDs are stored. |
| `ICON_PICKER_COLOR` | `"#00bcc9"` | Default color for icons |
## Requirements
- Django >= 3.0
- Python >= 3.6
## License
This project is licensed under the MIT License.
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
## Conclusion
Django Icon Picker provides a simple and effective way to include icon selection functionality in your Django forms. Whether you need to work with SVG files or icon IDs, this widget has you covered.