Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vladimirvivien/emojiis
Emojiis is a Go module for emoji icon search
https://github.com/vladimirvivien/emojiis
emojis go golang
Last synced: 2 days ago
JSON representation
Emojiis is a Go module for emoji icon search
- Host: GitHub
- URL: https://github.com/vladimirvivien/emojiis
- Owner: vladimirvivien
- License: mit
- Created: 2024-01-31T21:35:05.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-02-02T22:48:59.000Z (9 months ago)
- Last Synced: 2024-06-21T15:37:07.570Z (5 months ago)
- Topics: emojis, go, golang
- Language: Go
- Homepage:
- Size: 90.8 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://pkg.go.dev/github.com/vladimirvivien/emojiis)
# emojiis
Emojiis is a Go module that exposes a programmatic API to search and retrieve emoji icons using descriptive terms.
## Version 2.0.0 released
Version 2.0 uses a JSON file (from https://github.com/milesj/emojibase)
for its dataset, containing all commonly used emojis.
The API has been updated (if you use v1.xx, some functions may break after you update).
Features:
* Ability to search the full set of common emojis
* Support for inclusion and exclusion search terms
* Ability to search by emoji tags
See our API [documentation](https://pkg.go.dev/github.com/vladimirvivien/emojiis)
## Installation
To get started with the module, use the `go get` command to pull down the packages:
```
go get github.com/vladimirvivien/emojiis/[email protected]
```
## Usage
Here is a simple example of how to use the API:
```go
emojis := search.All(search.Params{
Include: []string{"face"},
Exclude: []string{"smile", "laugh", "grin", "upside-down"}
})
```
Returns:
```
[]string{"🐵", "🐶", "🐱", "🐯", "🦊"}
```
Or, search by tags only:
```go
emojis := search.ByTags("fruits")
```
Returns:
```go
[]string{"🍇", "🍈", "🍉", "🍊", "🍋"}
```