Skip to content

ireade/emoj11y

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

<emoj11y-element>

Published on webcomponents.org

An accessible emoji component

Demo

<emoj11y-element shortname="smile"></emoj11y-element>
<emoj11y-element shortname="dizzy_face" label="I'm so Dizzy"></emoj11y-element>
<emoj11y-element shortname="dancer" skin-tone="4"></emoj11y-element>

Usage

  1. Install with Bower
mkdir emoj11y-demo && cd emoj11y-demo
bower install emoj11y
  1. Include the element on a page
<!doctype html>
<html>
  <head>
    <meta charset="utf-8">
    <title>Emoj11y Demo</title>
    <script src="bower_components/webcomponentsjs/webcomponents-lite.js"></script>
    <link rel="import" href="bower_components/emoj11y/emoj11y-element.html">
  </head>
  <body>
    <emoj11y-element shortname="dancer" skin-tone="4"></emoj11y-element>
  </body>
</html>

Options

Option Description
shortname (required) The shortname for the element. Must be a valid emojione shortname
label An alternate label for the emoji. Defaults to the shortname
skin-tone A number from 1-6 representing the skin tone of the emoji (if applicable)

Contributing

Install the Polymer-CLI

First, make sure you have the Polymer CLI installed. Then run polymer serve to serve your element locally.

Viewing Your Element

$ polymer serve

Running Tests

$ polymer test

Your application is already set up to be tested via web-component-tester. Run polymer test to run your application's test suite locally.