Product
Introducing Enhanced Alert Actions and Triage Functionality
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
@primer/octicons
Advanced tools
Readme
Octicons are a scalable set of icons handcrafted with <3 by GitHub.
NOTE: The compiled files are located in build/
. This directory is located in the published npm package. Which means you can access it when you npm install octicons
. You can also build this directory by following the building octicons directions. The files in the lib/
directory are the raw source files and are not compiled or optimized.
This repository is distributed with npm. After installing npm, you can install octicons
with this command.
$ npm install @primer/octicons --save
For all the usages, we recommend using the CSS located in build/build.css
. This is some simple CSS to normalize the icons and inherit colors.
After installing npm install octicons
you can access the icons like this.
var octicons = require("octicons")
octicons.alert
// { keywords: [ 'warning', 'triangle', 'exclamation', 'point' ],
// path: '<path d="M8.865 1.52c-.18-.31-.51-.5-.87-.5s-.69.19-.87.5L.275 13.5c-.18.31-.18.69 0 1 .19.31.52.5.87.5h13.7c.36 0 .69-.19.86-.5.17-.31.18-.69.01-1L8.865 1.52zM8.995 13h-2v-2h2v2zm0-3h-2V6h2v4z"/>',
// height: '16',
// width: '16',
// symbol: 'alert',
// options:
// { version: '1.1',
// width: '16',
// height: '16',
// viewBox: '0 0 16 16',
// class: 'octicon octicon-alert',
// 'aria-hidden': 'true' },
// toSVG: [Function] }
There will be a key for every icon, with toSVG
and other properties.
octicons.alert.symbol
Returns the string of the symbol name, same as the key for that icon.
octicons.x.symbol
// "x"
octicons.person.path
Returns the string representation of the path of the icon.
octicons.x.path
// <path d="M7.48 8l3.75 3.75-1.48 1.48L6 9.48l-3.75 3.75-1.48-1.48L4.52 8 .77 4.25l1.48-1.48L6 6.52l3.75-3.75 1.48 1.48z"></path>
octicons.issue.options
This is an object of all the attributes that will be added to the output tag.
octicons.x.options
// { version: '1.1', width: '12', height: '16', viewBox: '0 0 12 16', class: 'octicon octicon-x', 'aria-hidden': 'true' }
octicons.alert.width
Returns the icon's true width, based on the svg view box width. Note, this doesn't change if you scale it up with size options, it only is the natural width of the icon.
octicons.alert.height
Returns the icon's true height, based on the svg view box height. Note, this doesn't change if you scale it up with size options, it only is the natural height of the icon.
keywords
Returns an array of keywords for the icon. The data comes from the data file in lib. Consider contributing more aliases for the icons.
octicons.x.keywords
// ["remove", "close", "delete"]
octicons.alert.toSVG()
Returns a string of the <svg>
tag.
octicons.x.toSVG()
// <svg version="1.1" width="12" height="16" viewBox="0 0 12 16" class="octicon octicon-x" aria-hidden="true"><path d="M7.48 8l3.75 3.75-1.48 1.48L6 9.48l-3.75 3.75-1.48-1.48L4.52 8 .77 4.25l1.48-1.48L6 6.52l3.75-3.75 1.48 1.48z"/></svg>
The .toSVG()
method accepts an optional options
object. This is used to add CSS classnames, a11y options, and sizing.
Add more CSS classes to the <svg>
tag.
octicons.x.toSVG({ "class": "close" })
// <svg version="1.1" width="12" height="16" viewBox="0 0 12 16" class="octicon octicon-x close" aria-hidden="true"><path d="M7.48 8l3.75 3.75-1.48 1.48L6 9.48l-3.75 3.75-1.48-1.48L4.52 8 .77 4.25l1.48-1.48L6 6.52l3.75-3.75 1.48 1.48z"/></svg>
Add accessibility aria-label
to the icon.
octicons.x.toSVG({ "aria-label": "Close the window" })
// <svg version="1.1" width="12" height="16" viewBox="0 0 12 16" class="octicon octicon-x" aria-label="Close the window" role="img"><path d="M7.48 8l3.75 3.75-1.48 1.48L6 9.48l-3.75 3.75-1.48-1.48L4.52 8 .77 4.25l1.48-1.48L6 6.52l3.75-3.75 1.48 1.48z"/></svg>
Size the SVG icon larger using width
& height
independently or together.
octicons.x.toSVG({ "width": 45 })
// <svg version="1.1" width="45" height="60" viewBox="0 0 12 16" class="octicon octicon-x" aria-hidden="true"><path d="M7.48 8l3.75 3.75-1.48 1.48L6 9.48l-3.75 3.75-1.48-1.48L4.52 8 .77 4.25l1.48-1.48L6 6.52l3.75-3.75 1.48 1.48z"/></svg>
(c) GitHub, Inc.
When using the GitHub logos, be sure to follow the GitHub logo guidelines.
FAQs
A scalable set of icons handcrafted with <3 by GitHub.
The npm package @primer/octicons receives a total of 46,984 weekly downloads. As such, @primer/octicons popularity was classified as popular.
We found that @primer/octicons demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 14 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
Security News
Polyfill.io has been serving malware for months via its CDN, after the project's open source maintainer sold the service to a company based in China.
Security News
OpenSSF is warning open source maintainers to stay vigilant against reputation farming on GitHub, where users artificially inflate their status by manipulating interactions on closed issues and PRs.