# ionicons-api-plugin

**Repository Path**: mirrors_jenkinsci/ionicons-api-plugin

## Basic Information

- **Project Name**: ionicons-api-plugin
- **Description**: Jenkins plugin providing ionicons
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-08-23
- **Last Updated**: 2026-04-04

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

IoniconsAPI plugin
==============================
[![Build Status](https://ci.jenkins.io/buildStatus/icon?job=Plugins/ionicons-api-plugin/main)](https://ci.jenkins.io/job/plugins/job/ionicons-api-plugin/)
[![Gitter](https://badges.gitter.im/jenkinsci/ux-sig.svg)](https://gitter.im/jenkinsci/ux-sig?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
[![Jenkins Plugin](https://img.shields.io/jenkins/plugin/v/ionicons-api.svg)](https://plugins.jenkins.io/ionicons-api/)
[![Jenkins Plugin Installs](https://img.shields.io/jenkins/plugin/i/ionicons-api.svg?color=blue)](https://plugins.jenkins.io/ionicons-api/)
[![Contributors](https://img.shields.io/github/contributors/jenkinsci/ionicons-api-plugin.svg)](https://github.com/jenkinsci/ionicons-api-plugin/graphs/contributors)

## Usage

This plugin provides [ionicons](https://ionic.io/ionicons), also known as "symbols", for your Jenkins plugins.

Add the ionicons-api as dependency to your `pom.xml`:

See the [plugin site](https://plugins.jenkins.io/ionicons-api/dependencies/) for a snippet.

To use a symbol, reference the icon as following:

### Jelly
```xml
<l:icon src="symbol-symbolName-outline plugin-ionicons-api" />
```

### Groovy
```groovy
l.icon(src:"symbol-symbolName-outline plugin-ionicons-api")
```

### Java

```java
@Override
public String getIconClassName() {
    return "symbol-symbolName-outline plugin-ionicons-api";
}
```

Preferably, use symbols containing `-outline`, if available, they fit the best in the Jenkins UI and are used in the Jenkins plugin ecosystem.

A list of all symbols is available on [the Ionicons website](https://ionic.io/ionicons).

Custom icon additions are documented [on GitHub](docs/additions.md).

More information about symbols and themes in Jenkins can be found on [weekly.ci.jenkins.io](https://weekly.ci.jenkins.io/design-library/symbols/).

If an icon is not theme-able, please raise an [issue](https://github.com/jenkinsci/ionicons-api-plugin/issues/new/choose).