README.adoc

Emoji Symbols API Plugin

Introduction

This plugin provides Unicode emojis as symbols to be used by other plugins.

The SVG files bundled by the plugin render the emojis as text rather than path. This allows emojis to be interpreted by the browser being used.

• Introduction
• Usage
  • Jelly
  • Groovy
  • Java
  • Plugins

Usage

The symbol names follow the pattern of symbol-emoji_NAME plugin-emoji-symbols-api.

Helper methods such as io.jenkins.plugins.emoji.symbols.Emojis.getIconClassName are provided by the plugin for easier generation of symbol identifiers.

For a list of all available emojis and their names click here.

Jelly

Simply define the icon by using

<l:icon src="symbol-emoji_sloth plugin-emoji-symbols-api" />

or use the helper methods to generate the icon class name for you

<j:invokeStatic var="emoji" method="getIconClassName" className="io.jenkins.plugins.emoji.symbols.Emojis">
    <j:arg value="sloth"/>
</j:invokeStatic>

<l:icon src="${emoji}" />

Groovy

Simply define the icon by using

l.icon(src: "symbol-emoji_sloth plugin-emoji-symbols-api")

or use the helper methods to generate the icon class name for you

import io.jenkins.plugins.emoji.symbols.Emojis

def emoji = Emojis.getIconClassName("sloth")
l.icon(src: emoji)

Java

Simply define the icon by using

public String getIconClassName() {
    return "symbol-emoji_sloth plugin-emoji-symbols-api";
}

or use the helper methods to generate the icon class name for you

import io.jenkins.plugins.emoji.symbols.Emojis;

public String getIconClassName() {
    return Emojis.getIconClassName("sloth");
}

Plugins

Simply define the icon by using

node {
    // usage in the badge-plugin
    addBadge(icon: "symbol-emoji_sloth plugin-emoji-symbols-api")
}

or use the helper methods to generate the icon class name for you

import io.jenkins.plugins.emoji.symbols.Emojis

node {
    // usage in the badge-plugin
    def emoji = Emojis.getIconClassName("sloth")
    addBadge(icon: emoji)
}