Skip to main content

Add emoji to StreamField.

Project description

Wagtail Emoji :tada:
====================
:clap: Add [NotoEmoji](https://github.com/googlei18n/noto-emoji) icons to StreamField. :bomb: :gun: :smoking: :knife:

![Screenshot](screenshot.png)

:warning: **IMPORTANT: JUST BECAUSE YOU CAN DOESN'T MEAN YOU SHOULD.**

Install
-------

pip install wagtailemoji

Then add `wagtailemoji` to your installed apps.

Usage
-----
### StreamField
Add emoji to StreamField [the regular way](http://docs.wagtail.io/en/latest/topics/streamfield.html#basic-block-types), just set `icon="emoji-something"`. Reference [the full list](https://github.com/alexgleason/wagtailemoji/blob/master/wagtailemoji/static_src/wagtailemoji/scss/wagtailemoji.scss).

### wagtailmodeladmin
[wagtailmodeladmin](https://github.com/rkhleics/wagtailmodeladmin) is supported if you're using Wagtail 1.4 or above. Similar to StreamField, just set `icon="emoji-something"` on your menu item.

### Hallo plugins
You can use emoji on custom Hallo buttons by setting the `icon` option to `icon icon-emoji-something`.

```javascript
button.hallobutton({
label: "Skull",
icon: 'icon icon-emoji-skull',
});
```

### Other parts of the admin
You can include icons anywhere in the admin with:

```html
<i class="icon icon-emoji-something"></i>
```

In Wagtail 1.3.x and below you can only use icons on the page editor screen.

### On the front-end
You can also import this on the front-end, if you want.

```html
{% load staticfiles %}

<link rel="stylesheet" href="{% static 'wagtailemoji/css/wagtailemoji.css' %}">
```

Then include icons anywhere on the front-end with:

```html
<i class="icon icon-emoji-something"></i>
```

### Using wagtailemoji as an optional dependency
If you want to distribute a Wagtail plugin with emoji, you can use this package as an optional dependency by checking if it's installed in Django, and falling back otherwise.

```python
from django.conf import settings
from wagtail.wagtailcore.blocks import StructBlock


class BlockquoteBlock(StructBlock):
quote = TextBlock()
author = TextBlock()

class Meta:
if 'wagtailemoji' in settings.INSTALLED_APPS:
icon = 'emoji-skull'
```

(in this case, the fallback is to do nothing)


Project details


Download files

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

Files for wagtailemoji, version 1.0.2
Filename, size File type Python version Upload date Hashes
Filename, size wagtailemoji-1.0.2-py2.py3-none-any.whl (306.5 kB) File type Wheel Python version py2.py3 Upload date Hashes View hashes
Filename, size wagtailemoji-1.0.2-py3.5.egg (305.5 kB) File type Egg Python version 3.5 Upload date Hashes View hashes
Filename, size wagtailemoji-1.0.2.tar.gz (305.1 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

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