SimpleIcons4J

SimpleIcons4J is a Java implementation of the simple-icons JavaScript library and is inspired by simpleicons.org.

This library currently supports simple-icons v6.16.0.

Installation

<dependency>
    <groupId>org.silentsoft</groupId>
    <artifactId>simpleicons4j</artifactId>
    <version>1.9.0</version>
</dependency>

Usage

Icon icon = SimpleIcons.get("simpleicons");

or creating instance explicitly like:

Icon icon = new SimpleiconsIcon();

Object Structure

Icon{
    title="Simple Icons",
    slug="simpleicons",
    hex="111111",
    source="https://simpleicons.org/",
    svg="<svg role=\"img\" viewBox=\"0 0 24 24\" xmlns=\"http://www.w3.org/2000/svg\">...</svg>",
    path="M12 12v-1.5c-2.484 ...",
    guidelines="https://simpleicons.org/styleguide",
    license=License{
        type="...",
        url="https://example.com/"
    }
}

Slugs

Supported slugs can be found here.

Class Naming Exceptions

.NET is available as DotnetIcon.
/e/ is available as EIcon.
1001Tracklists is available as OnethousandonetracklistsIcon.
1Password is available as OnepasswordIcon.
3M is available as ThreemIcon.
42 is available as FourtytwoIcon.
4chan is available as FourchanIcon.
4D is available as FourdIcon.
500px is available as FivehundredpxIcon.

Testing

$ mvn clean test-compile exec:java test

Packaging

$ mvn clean test-compile exec:java package

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please note we have a CODE_OF_CONDUCT, please follow it in all your interactions with the project.

License

Please refer to LICENSE.

silentsoft / simpleicons4j

readme