Skip to main content

A usefull and incredible Django application that allow you to use emoticons in your templates :)

Project description

Build Status - develop branch Coverage of the code

Django-emoticons is a django application providing utilities to add emoticons in your templates. Pretty incredible no?

Install

Once you have installed the package in your PYTHON_PATH, register the emoticons app in your INSTALLED_APPS project’s section.

INSTALLED_APPS = (
  ...
  'emoticons',
  ...
)

Usage

Filter Usage

For our example we will make a template who display the field content of a model, this field has this value:

Coding is fun and sexy :D

So in our templates we will load the emoticons_tags library and use the emoticons filter:

{% load emoticons_tags %}

{{ object.content|emoticons }}

Which will render:

Coding is fun and sexy smile

Tag Usage

The emoticons app also provides a tag named emoticons for converting raw text.

{% load emoticons_tags %}
{% emoticons %}
Documenting is boring but usefull :p
{% endemoticons %}

Which will render :

Documenting is boring but usefull razz

Index

If you want to retrieve a list of all availables emoticons you can use the emoticons_index tag.

{% load emoticons_tags %}
{% emoticons_index as emoticons_list %}
{% for emoticons in emoticons_list %}
<p>{{ emoticons.0|emoticons }}: {{ emoticons|join:" " }}</p>
{% endfor %}

Settings

You can use differents settings for customizing the application:

  • EMOTICONS_DIRECTORY

    The directory where the emoticons files are located, use 'emoticons' as default.

  • EMOTICONS_LIST

    The list of the emoticons used by the application, something like this:

    (('(devil)', 'devil.gif'),
     ('(angel)', 'angel.gif'),
     ((':)', ':-)', ':=)', '(smile)'), 'smile.gif'),
     ((':(', ':-(', ':=(', '(sad)'), 'sadsmile.gif'),
    )
    

If the HTML code of the emoticons does not fit to your needs, you can override the 'emoticons/emoticon.html' template to adjust it.

Project details


Release history Release notifications

History Node

1.2

This version
History Node

1.1.2

History Node

1.1.1

History Node

1.1

History Node

1.0.1

History Node

1.0

History Node

0.1.1

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
django_emoticons-1.1.2-py2.py3-none-any.whl (142.6 kB) Copy SHA256 hash SHA256 Wheel 2.7 May 4, 2014
django-emoticons-1.1.2.tar.gz (118.0 kB) Copy SHA256 hash SHA256 Source None May 4, 2014

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page