Skip to content
Jenkins plug-in that provides the free fonts of Font Awesome
Java Shell
Branch: master
Clone or download

Latest commit

Fetching latest commit…
Cannot retrieve the latest commit at this time.

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.dependabot Initialize repository. Nov 3, 2019
.github Use same workflows and names for all modules. Mar 29, 2020
.mvn
codacy Remove broken CheckStyle configuration. Jan 14, 2020
etc
src Update svg tag to be compatible with Jenkins 2.222. Feb 25, 2020
.gitattributes Initialize repository. Nov 3, 2019
.gitignore
.remarkrc
CHANGELOG.md
Jenkinsfile
LICENSE Initialize repository. Nov 3, 2019
README.adoc Use same workflows and names for all modules. Mar 29, 2020
go.sh
package-lock.json
package.json
pom.xml

README.adoc

Font Awesome Jenkins Plugin

Jenkins Plugin Jenkins Version JDK8 License: MIT

Provides Font Awesome for Jenkins Plugins. Font Awesome has vector icons and social logos, according to their self-perception it is the web’s most popular icon set and toolkit. Currently, it contains more than 1,500 free icons.

This plugin contains the latest WebJars release and corresponding Jenkins UI elements.

How to use the plugin

Jenkins plugins typically do not use icons very frequently. Most plugins provide an icon for the actions and that’s it. If you intend to use icons in other places, plugin authors are left on their own: the recommended Tango icon set is more than 10 years old and too limited nowadays. There are several options available, but the most popular is the Font Awesome Icon Set. It provides more than 1500 free icons that follow the same design guidelines:

Font Awesome icons
Figure 1. Font Awesome icons in Jenkins plugins

In order to use Font Awesome icons in a plugin you simply need add a dependency to the latest version of this plugin:

<dependency>
  <groupId>io.jenkins.plugins</groupId>
  <artifactId>font-awesome-api</artifactId>
  <version>[latest version]</version>
</dependency>

Then use the new tag svg-icon in your jelly view:

index.jelly
<j:jelly xmlns:j="jelly:core" xmlns:st="jelly:stapler" xmlns:l="/lib/layout" xmlns:fa="/font-awesome">

  [...]
  <fa:svg-icon name="check-double" class="no-issues-banner"/>
  [...]

</j:jelly>

If you are generating views using Java code, then you also can use the class SvgTag to generate the HTML markup for such an icon.

Jenkins GitHub Actions GitHub pull requests

You can’t perform that action at this time.