To emote | əˈmōt | is to display emotions openly, especially while acting. But the word also has a meaning in internet history. The original internet chat tool, IRC, provided a /me
command, which allowed IRC channel participants to share emotion.
If my name were friendlybug80
on IRC, when I typed /me jumps for joy
, all IRC channel participants would see
* friendlybug80 jumps for joy
The 3rd-person * friendlybug75 jumps for joy
is an emote.
tl;dr The emote widget (and its associated server) allows virtual event attendees watching the event stream to share their emotion with other attendees and the presenter in real time. It's a higher fidelity, virtual-only version of clapping.
- git
- node
- API server deployed or running locally https://github.com/heroku-examples/emote-server
git clone [email protected]:heroku-examples/emote-widget.git
cd emote-widget
- Update the
apiDomain
inconfig.js
to your API server's domain. npm install
npm run dev
-
npm run build
to generate adist/emote.widget.iife.js
file -
Include
emote.widget.iife.js
inside the<head>
tags of the HTML page into which you want to embed the widget.<script type="text/javascript" src="emote.widget.iife.js"></script> <!-- main.js can be found in the dist folder in this project -->
-
Add the
<emote-widget>
HTML element within the<body>
of the page. It doesn't matter where within the body you put it. The widget will be absolutely positioned on the page using CSS.<emote-widget talk-id="mytalk" open="true"></emote-widget>
- The
talk-id
valuemytalk
is a unique string identifier for the current talk. You'll need to update this when the talk changes. See the next step for more details. - Set
open
tofalse
if you want to start your Widget closed - Add absolute positioning to your site's CSS to adjust were it appears.
emote-widget { position: absolute; right: 0; bottom: 0; }
- The
-
Write some JavaScript to update the
talk-id
attribute's value when the talk changes. This will reset the counters to zero and record future clicks toward the newtalk-id
value. Thetalk-id
value can be any string, but make sure it's unique for each "segment" (e.g. talk, panel discussion, keynote, etc) of your event for which you want to uniquely capture emote events. Something like the following can be used, but you'll have to implement a way to invoke the function when the talk changes.updatTalkId(talkId) { const widget = document.querySelector('emote-widget'); widget.setAttribute('talk-id', '<NEW_TALK_ID>'); }
Changing the emojis:
-
Create and export your new emoji in svg format. Ours are square, 47px x 47px.
-
Use a base64 converter on each new emoji. We used https://www.base64-image.de/
-
Copy the css the converter outputs into
Button.scss
andanimation.js
under the corresponding classes.