paulpatarinski / emoji-mart-stencil

Port of the popular react emoji-mart component

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool


Emoji Mart is a Slack-like customizable
emoji picker component

picker

Missive | Team email, team chat, team tasks, one app
Brought to you by the Missive team

What?

Port of the popular react emoji-mart component

Why?

To use in non-react apps (Ionic, angular apps..others)

How?

Stencil is a compiler for building fast web apps using Web Components.

Stencil combines the best concepts of the most popular frontend frameworks into a compile-time rather than run-time tool. Stencil takes TypeScript, JSX, a tiny virtual DOM layer, efficient one-way data binding, an asynchronous rendering pipeline (similar to React Fiber), and lazy-loading out of the box, and generates 100% standards-based Web Components that run in any browser supporting the Custom Elements v1 spec.

Stencil components are just Web Components, so they work in any major framework or with no framework at all.

Contributing

npm install
npm start

To build the component for production, run:

npm run build

To run the unit tests for the components, run:

npm test

Need help? Check out stencil docs here.

Using this component

Script tag

  • Publish to NPM
  • Put a script tag similar to this <script src='https://unpkg.com/my-component@0.0.1/dist/mycomponent.js'></script> in the head of your index.html
  • Then you can use the element anywhere in your template, JSX, html etc

Node Modules

  • Run npm install my-component --save
  • Put a script tag similar to this <script src='node_modules/my-component/dist/mycomponent.js'></script> in the head of your index.html
  • Then you can use the element anywhere in your template, JSX, html etc

In a stencil-starter app

  • Run npm install my-component --save
  • Add { name: 'my-component' } to your collections
  • Then you can use the element anywhere in your template, JSX, html etc

Credits

Since this is just a port all credit goes to the writers of https://github.com/missive/emoji-mart & the Missive team. As well as the Ionic team for creating https://github.com/ionic-team/stencil. Thank you for doing all the hard work

About

Port of the popular react emoji-mart component

License:MIT License


Languages

Language:TypeScript 99.8%Language:HTML 0.1%Language:JavaScript 0.0%