Liking cljdoc? Tell your friends :D

ascii-emoji

Build Status Clojars Project ![Clojure version][clojure-v]

Use ASCII Emoji, in Clojure!

Usage

Get started using ASCII emojis.

Installation

Leiningen/Boot Project file

[ascii-emoji "0.1.0"]

Include the Library

In the REPL

(require '[ascii-emoji.core :as em])

In your application

(ns my-app.core
  (:require [ascii-emoji.core :as em]))

Use Emojis - Direct Data

Use the emoji map directly.

;; categories
(keys em/emoji-db)

;; all emojis in the "dudes" category
(:dudes em/emoji-db)

;; specific emoji in the dudes category
(get-in em/emoji-db [:dudes :tableflip1])

Use Emojis - Helper Functions

Using the included helper functions to explore/access emojis.

List names

;; names of categories
(em/names)

;; names of emojis from the dudes category
(em/names :dudes)

Describe categories

;; describe all categories
(em/describe)

;; describe specific category
(em/describe :dudes)

Show emojis

;; show first emoji that matches the keyword (from all categories)
(em/show :tableflip1)

;; show the emoji from the specific category
(em/show :tableflip1 :dudes)

Show all emojis

;; show the entire emoji map
(em/show-all)

;; show all of the emojis from the category
(em/show-all :dudes)

Search Emojis

;; search the entire emoji map for the emoji name
(em/search "table")

;; search the specific category for the emoji name
(em/search "table" :dudes)

License

Copyright © 2020 Bill Howe

This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which is available at http://www.eclipse.org/legal/epl-2.0.

This Source Code may also be made available under the following Secondary Licenses when the conditions for such availability set forth in the Eclipse Public License, v. 2.0 are satisfied: GNU General Public License as published by the Free Software Foundation, either version 2 of the License, or (at your option) any later version, with the GNU Classpath Exception which is available at https://www.gnu.org/software/classpath/license.html.


ASCII Data

Some ASCII emojis obtained from: http://asciimoji.com/

The license for that project is:

"THE BEER-WARE LICENSE" (Revision 42):

Volker Wieban thesquidpeople@gmail.com wrote this file.

As long as you retain this notice you can do whatever you want with this stuff. If we meet some day, and you think this stuff is worth it, you can buy me a beer in return.


Can you improve this documentation? These fine people already did:
wdhowe & Bill Howe
Edit on GitHub

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close