Package io.jenkins.plugins.fontawesome.api

Class SvgTag

java.lang.Object
io.jenkins.plugins.fontawesome.api.SvgTag
public class SvgTag extends Object
Textual SVG tag representation that shows a FontAwesome icon.
Author:
Ullrich Hafner

  • Constructor Details

    • SvgTag

      public SvgTag(String iconName)
      Creates a new SvgTag that renders the specified SVG icon of FontAwesome.
      Parameters:
      iconName - the name of the icon (without fa- prefix), e.g. chevron-circle-up.

    • SvgTag

      public SvgTag(String iconName, io.jenkins.plugins.util.JenkinsFacade jenkinsFacade)
      Creates a new SvgTag that renders the specified SVG icon of FontAwesome.
      Parameters:
      iconName - the name of the icon (without fa- prefix), e.g. chevron-circle-up.
      jenkinsFacade - Jenkins facade to replaced with a stub during unit tests

  • Method Details

    • fontAwesomeSvgIcon

      public static SvgTag fontAwesomeSvgIcon(String iconName)
      Creates a new SvgTag that renders the specified SVG icon of FontAwesome.
      Parameters:
      iconName - the name of the icon (without fa- prefix), e.g. chevron-circle-up.
      Returns:
      the HTML tag

    • withClasses

      public SvgTag withClasses(String... classNames)
      Uses the specified class names for this SVG tag. Adds the tag svg-icon as well as class.
      Parameters:
      classNames - the additional class names, might be empty
      Returns:
      this tag

    • render

      public String render()
      Renders this tag into plain HTML String representation.
      Returns:
      the tag as HTML String