Emojis for Go 😄🐢🚀
Follow this link to view the reference documentation: GoDoc Reference 📝
To install the turtle library run:
go get github.com/hackebrot/turtle
If you would also like to use the turtle CLI app run:
go get github.com/hackebrot/turtle/cmd/turtle
See the turtle CLI README for more information.
turtle.Emojis is a map which contains all emojis available in turtle.
You can use it to look up emoji by their name.
package main
import (
"fmt"
"os"
"github.com/hackebrot/turtle"
)
func main() {
name := "turtle"
emoji, ok := turtle.Emojis[name]
if !ok {
fmt.Fprintf(os.Stderr, "no emoji found for name: %v\n", name)
os.Exit(1)
}
fmt.Printf("Name: %q\n", emoji.Name)
fmt.Printf("Char: %s\n", emoji.Char)
fmt.Printf("Category: %q\n", emoji.Category)
fmt.Printf("Keywords: %q\n", emoji.Keywords)
}Name: "turtle"
Char: 🐢
Category: "animals_and_nature"
Keywords: ["animal" "slow" "nature" "tortoise"]
Use Search() to find all emojis with a name that contains the search string.
package main
import (
"fmt"
"os"
"github.com/hackebrot/turtle"
)
func main() {
s := "computer"
emojis := turtle.Search(s)
if emojis == nil {
fmt.Fprintf(os.Stderr, "no emojis found for search: %v\n", s)
os.Exit(1)
}
fmt.Printf("%s: %s\n", s, emojis)
}computer: [💻 🖱 🖥 ]
Use Category() to find all emojis of the specified category.
package main
import (
"fmt"
"os"
"github.com/hackebrot/turtle"
)
func main() {
c := "travel_and_places"
emojis := turtle.Category(c)
if emojis == nil {
fmt.Fprintf(os.Stderr, "no emojis found for category: %v\n", c)
os.Exit(1)
}
fmt.Printf("%s: %s\n", c, emojis)
}travel_and_places: [🚡 ✈️ 🚑 ]
Use Keyword() to find all emojis by a keyword.
package main
import (
"fmt"
"os"
"github.com/hackebrot/turtle"
)
func main() {
k := "happy"
emojis := turtle.Keyword(k)
if emojis == nil {
fmt.Fprintf(os.Stderr, "no emoji found for keyword: %v\n", k)
os.Exit(1)
}
fmt.Printf("%s: %s\n", k, emojis)
}happy: [😊 😁 😀 😂 ]
Emoji names, categories and keywords are based on the fantastic muan/emojilib keyword library 📖
At this point, the turtle project supports the emojis that are also available on GitHub. See the GitHub REST API documentation for more information.
If you encounter any problems, please file an issue along with a detailed description.
Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
Distributed under the terms of the MIT license, turtle is free and open source software.