Emoji
ttkbootstrap.icons.Emoji
A class that contains emoji characters that can be used in the
text
parameter in any tkinter widget with the option.
categories()
staticmethod
Get a set of categories.
Returns:
Type | Description |
---|---|
set |
Emoji categories. |
Examples:
>>> Emoji.categories()
{'component', 'animal-nature', 'objects', 'symbols', 'flags',
'people-body', 'smiley-emotion', 'activities', 'food-drink',
'travel-places'}
Source code in ttkbootstrap/icons.py
@staticmethod
def categories():
"""Get a set of categories.
Returns:
set:
Emoji categories.
Examples:
```python
>>> Emoji.categories()
{'component', 'animal-nature', 'objects', 'symbols', 'flags',
'people-body', 'smiley-emotion', 'activities', 'food-drink',
'travel-places'}
```
"""
cat = set()
for e in Emoji._ITEMS:
cat.add(e.category)
return cat
get(name)
staticmethod
Lookup an emoji by name.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name |
str |
The name of the emoji to lookup. |
required |
Returns:
Type | Description |
---|---|
Union[EmojiItem, None] |
The selected emoji or None if not found. |
Examples:
>>> Emoji.get('winking face')
đ
>>> face = Emoji.get('winking face')
>>> face.name
WINKING FACE
>>> face.category
smiley-emotion
>>> face.subcategory
face.smiling
>>> face.char
đ
Source code in ttkbootstrap/icons.py
@staticmethod
def get(name: str):
"""Lookup an emoji by name.
Parameters:
name (str):
The name of the emoji to lookup.
Returns:
Union[EmojiItem, None]:
The selected emoji or None if not found.
Examples:
```python
>>> Emoji.get('winking face')
đ
>>> face = Emoji.get('winking face')
>>> face.name
WINKING FACE
>>> face.category
smiley-emotion
>>> face.subcategory
face.smiling
>>> face.char
đ
```
"""
for e in Emoji._ITEMS:
if e.name.lower() == name.lower():
return e
subcategories(category=None)
staticmethod
Get a set of all subcategories or for a specific category.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
category |
str |
The name of the category to query. |
None |
Returns:
Type | Description |
---|---|
set |
All subcategories or categories for a specific category. |
Examples:
>>> Emoji.subcategories('activities')
{'award-medal', 'arts & crafts', 'event', 'game', 'sport'}
Source code in ttkbootstrap/icons.py
@staticmethod
def subcategories(category: str = None):
"""Get a set of all subcategories or for a specific category.
Parameters:
category (str):
The name of the category to query.
Returns:
set:
All subcategories or categories for a specific category.
Examples:
```python
>>> Emoji.subcategories('activities')
{'award-medal', 'arts & crafts', 'event', 'game', 'sport'}
```
"""
subcat = set()
for e in Emoji._ITEMS:
if not category:
subcat.add(e.subcategory)
else:
if e.category == category:
subcat.add(e.subcategory)
return subcat