Skip to main content

Rich web editor widgets in the Django Admin

Project description

# Django-editor-widgets


This package provides some custom widgets to use monaco or tinymce editors in django admin.


## Installation

To install the package by `pip` run following command

```sh
$ pip install git+https://github.com/giorgi94/django-editor-widgets.git
```

## Usage

To start using the package in your project, you need to open `settings.py` file and add following lines

```python
# settings.py
import os

# sets paths to static files for widgets
from djangoeditorwidgets.defaults import *


# Application definition

INSTALLED_APPS = [
...
'djangoeditorwidgets',
...
]

```

Now we can start using the widgets. To use tinymce we need to override widget in form
```python
# forms.py
from django import forms
from djangoeditorwidgets.widgets import TinymceWidget
from .models import TextModel


class TextModelForm(forms.ModelForm):

class Meta:
model = TextModel
fields = '__all__'
widgets = {
'text': TinymceWidget()
}
```

The package also provides custom fields, and widgets are already set for them.

```python
# models.py
from django.db import models
from djangoeditorwidgets.fields import XMLField, JsonField


class TextModel(models.Model):
title = models.CharField(max_length=50)
text = models.TextField()

def __str__(self):
return self.title


class XMLModel(models.Model):
title = models.CharField(max_length=50)
text = XMLField()

def __str__(self):
return self.title


class JSONModel(models.Model):
title = models.CharField(max_length=50)
text = JsonField()

def __str__(self):
return self.title

```
You don't need to use this fields and only change widgets in forms, but this fields provide simple validations.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-editor-widgets-1.0.tar.gz (2.1 MB view details)

Uploaded Source

Built Distribution

django_editor_widgets-1.0-py3-none-any.whl (2.1 MB view details)

Uploaded Python 3

File details

Details for the file django-editor-widgets-1.0.tar.gz.

File metadata

  • Download URL: django-editor-widgets-1.0.tar.gz
  • Upload date:
  • Size: 2.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.5.0.1 requests/2.9.1 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.29.0 CPython/3.6.8

File hashes

Hashes for django-editor-widgets-1.0.tar.gz
Algorithm Hash digest
SHA256 bac7fcf5fb13abd250df2c7a1ffa5eb5ca3b194d92f62bacc3dd3fbde579a020
MD5 0ce238d56e0314b9f6a38a3ae03047f8
BLAKE2b-256 36f3f783dc8d1355de0438b6cbb67f6aa298fd789914625f267152ae36e6b4c7

See more details on using hashes here.

File details

Details for the file django_editor_widgets-1.0-py3-none-any.whl.

File metadata

  • Download URL: django_editor_widgets-1.0-py3-none-any.whl
  • Upload date:
  • Size: 2.1 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.5.0.1 requests/2.9.1 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.29.0 CPython/3.6.8

File hashes

Hashes for django_editor_widgets-1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 31fefb3c2cef269a261e11a5c84eb9ff422ff154f2eb26f71f143c59045b55c4
MD5 0202b68f8f631a0fd390a91da75e5f30
BLAKE2b-256 f770e3313eac5920aae731622c97a7a06f92bb07698748d294af538163556dff

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page