https://github.com/valerauko/sirius

Tiny library to find the name of Unicode characters
https://github.com/valerauko/sirius

clojure emoji hacktoberfest unicode

Last synced: 2 months ago
JSON representation

Tiny library to find the name of Unicode characters

• Host: GitHub
• URL: https://github.com/valerauko/sirius
• Owner: valerauko
• License: epl-2.0
• Created: 2020-06-25T16:42:06.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2020-07-01T08:41:29.000Z (over 4 years ago)
• Last Synced: 2024-07-11T15:20:53.820Z (5 months ago)
• Topics: clojure, emoji, hacktoberfest, unicode
• Language: Clojure
• Homepage:
• Size: 286 KB
• Stars: 12
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Sirius

[Why so serious?](https://www.youtube.com/watch?v=F_5dP_83O7o) 🤪 Emoji are all over the place, but they [can be a burden for accessibility](https://www.ashleysheridan.co.uk/blog/Emoji+and+Accessibility#making_accessible_to_assistive_tech). Look at that tiny yellow face and figure out if it's crying in joy or horror...

Things would be easier if all the emoji had nice `aria-label` attributes that showed up on hover, right? While Sirius won't generate HTML for you, it will give you the Unicode name of any character you give it.

## Installation

[![Clojars Project](https://img.shields.io/clojars/v/net.valerauko/sirius.svg)](https://clojars.org/net.valerauko/sirius)

```

[net.valerauko/sirius "1.1.0"]

```

```

net.valerauko/sirius {:mvn/version "1.1.0"}

```

## Usage

Ask it about a single character you have at hand. It can be a Character like `\a`, a single-character string (`"a"`), even numeric or byte representations of letters.

```

=> (name-of "♎")

"LIBRA"

=> (name-of \☕)

"HOT BEVERAGE"

```

As you can see, the names are the raw, all-caps name from the [Unicode database](http://www.unicode.org/Public/UNIDATA/UnicodeData.txt). If you need it in any other shape (and you probably will), please convert it yourself.

## License

Copyright © 2020 @valerauko

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.

Also see the [license of the Unicode "DATA FILES"](https://www.unicode.org/license.html).