Skip to main content

Add emoji to StreamField.

Project description

Wagtail Emoji
====================
Add [NotoEmoji](https://github.com/googlei18n/noto-emoji) icons to StreamField.

![Screenshot](screenshot.png)

**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.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

wagtailemoji-1.0.0-py2.py3-none-any.whl (306.4 kB view details)

Uploaded Python 2Python 3

File details

Details for the file wagtailemoji-1.0.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for wagtailemoji-1.0.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 b5aa1433103e596ad199f92273dc2b99a8780e99025bd93d3d0b9363204ced49
MD5 76988c2ed07a5088928771998647aeea
BLAKE2b-256 c1d30f3c3dd86a14ea961c3b72dbee576b4cf2336ff8818466d3f6b32f05d300

See more details on using hashes here.

Supported by

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