Octicons
Primer Octicons
Octicons are a set of SVG icons built by GitHub for GitHub.
#Libraries
This repository contains several libraries. Each of them is in the lib/ folder and gives access to Octicons on a different platform/language.
#JavaScript
The octicons node.js library is the main JavaScript library. With a JavaScript API that can be used in a variety of applications.
| Package | Version |
|---|---|
| @primer/octicons Node.js package with JavaScript API |
 |
| @primer/octicons-react React Octicons components |
 |
| @primer/styled-octicons React Octicons components with Styled System props |
 |
#Ruby
| Package | Version |
|---|---|
| octicons Ruby gem with Ruby API |
 |
| octicons_helper Rails helper for using octicons |
 |
| jekyll-octicons Jekyll plugin for using octicons |
 |
#Icon names and compatibility
The shape-based triangle, triangle-circle, and triangle-fill names follow the square family. Each provides 16px and 24px artwork. git-pull-request-unlisted provides 16px artwork.
| Canonical name | Compatibility name | Preserved behavior |
|---|---|---|
bookmark-fill |
bookmark-filled (deprecated) |
The old name retains its 16px drawing at every display size. |
repo-delete |
repo-deleted (deprecated) |
The old name retains its 16px drawing at every display size. |
triangle-circle |
play (supported) |
The old name retains both original circled drawings, not the bare triangle. |
Compatibility names retain their exports, CSS classes, symbol IDs, and published build/svg paths. An aliasOf property identifies the canonical name in icon data; deprecated: true separately marks a deprecated alias. Catalogues can filter aliasOf entries without removing legacy lookups.
The canonical bookmark-fill and repo-delete names now provide both natural sizes. JavaScript and Ruby helpers retain their existing 24px output when callers omit width and height; an explicit 16px request selects the 16px drawing.
#Contributing
#Feedback, ideas, and bug reports
If you found a bug, have feedback about our Octicon Library, or an idea on how to improve it, please open a new issue in this repo using the appropriate issue template.
#Request an Icon Review (GitHub staff only)
To request an icon review for inclusion in the Octicons Library, open the github/primer issue template chooser and select Icon request.
#Adding or updating an icon
Read through our contributing guide if you want to add or update icons.
#License
(c) GitHub, Inc.
When using the GitHub logos, be sure to follow the GitHub logo guidelines.
Code License: MIT Applies to all other files