{"bugs":{"url":"https://github.com/primer/octicons/issues"},"dist":{"shasum":"a2cad32855c4d839f129b796e4967677116988a8","tarball":"https://registry.npmjs.org/octicons/-/octicons-7.2.0-alpha.a16c63d2.tgz","fileCount":183,"integrity":"sha512-twVFI9fDsFtIlnrdolG3OpvGBFVDomw0IN+k8Vhl8UrSF9BkkxgSpkpQ141M77lOMAOZNTZcip1fweH/7P3kvw==","signatures":[{"sig":"MEYCIQDAcT/4Lc25okOyBihfU8Q2d1I+RumVvZz6uLQagTgI7QIhANcqlHPOiheSSDpkfJGOlmyzt+i42O2IEqN+hvglrnNI","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":147983},"main":"index.js","name":"octicons","files":["index.js","index.scss","build"],"style":"index.scss","author":{"name":"GitHub Inc."},"readme":"# GitHub Octicons\n\n[![npm version](https://img.shields.io/npm/v/octicons.svg)](https://www.npmjs.org/package/octicons)\n[![Build Status](https://travis-ci.org/primer/octicons.svg?branch=master)](https://travis-ci.org/primer/octicons)\n\n> Octicons are a scalable set of icons handcrafted with <3 by GitHub.\n\n## Install\n\n**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](#building-octicons). The files in the `lib/` directory are the raw source files and are not compiled or optimized.\n\n#### npm\n\nThis repository is distributed with [npm][npm]. After [installing npm][install-npm], you can install `octicons` with this command.\n\n```\n$ npm install octicons --save\n```\n\n## Usage\n\nFor 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.\n\n### Node\n\nAfter installing `npm install octicons` you can access the icons like this.\n\n```js\nvar octicons = require(\"octicons\")\nocticons.alert\n// { keywords: [ 'warning', 'triangle', 'exclamation', 'point' ],\n// path: '',\n// height: '16',\n// width: '16',\n// symbol: 'alert',\n// options:\n// { version: '1.1',\n// width: '16',\n// height: '16',\n// viewBox: '0 0 16 16',\n// class: 'octicon octicon-alert',\n// 'aria-hidden': 'true' },\n// toSVG: [Function] }\n```\n\nThere will be a key for every icon, with [`toSVG`](#octiconsalerttosvg) and other properties.\n\n#### `octicons.alert.symbol`\n\nReturns the string of the symbol name, same as the key for that icon.\n\n```js\nocticons.x.symbol\n// \"x\"\n```\n\n#### `octicons.person.path`\n\nReturns the string representation of the path of the icon.\n\n```js\nocticons.x.path\n// \n```\n\n#### `octicons.issue.options`\n\nThis is an object of all the attributes that will be added to the output tag.\n\n```js\nocticons.x.options\n// { version: '1.1', width: '12', height: '16', viewBox: '0 0 12 16', class: 'octicon octicon-x', 'aria-hidden': 'true' }\n```\n\n#### `octicons.alert.width`\n\nReturns 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._\n\n#### `octicons.alert.height`\n\nReturns 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._\n\n#### `keywords`\n\nReturns an array of keywords for the icon. The data comes from the [data file in lib](../data.json). Consider contributing more aliases for the icons.\n\n```js\nocticons.x.keywords\n// [\"remove\", \"close\", \"delete\"]\n```\n\n#### `octicons.alert.toSVG()`\n\nReturns a string of the `` tag.\n\n```js\nocticons.x.toSVG()\n// \n```\n\nThe `.toSVG()` method accepts an optional `options` object. This is used to add CSS classnames, a11y options, and sizing.\n\n##### class\n\nAdd more CSS classes to the `` tag.\n\n```js\nocticons.x.toSVG({ \"class\": \"close\" })\n// \n```\n\n##### aria-label\n\nAdd accessibility `aria-label` to the icon.\n\n```js\nocticons.x.toSVG({ \"aria-label\": \"Close the window\" })\n// \n```\n\n##### width & height\n\nSize the SVG icon larger using `width` & `height` independently or together.\n\n```js\nocticons.x.toSVG({ \"width\": 45 })\n// \n```\n\n## License\n\n(c) GitHub, Inc.\n\nWhen using the GitHub logos, be sure to follow the [GitHub logo guidelines](https://github.com/logos).\n\n[MIT](./LICENSE) \n\n[primer]: https://github.com/primer/primer\n[docs]: http://primercss.io/\n[npm]: https://www.npmjs.com/\n[install-npm]: https://docs.npmjs.com/getting-started/installing-node\n[sass]: http://sass-lang.com/\n[sketch-document]: https://github.com/primer/octicons/blob/master/lib/octicons-master.sketch\n","license":"MIT","scripts":{"test":"ava --verbose 'tests/*.js'","prepare":"../../script/build-svg ./build && ../../script/build-json ./build && cp index.scss build/build.css","publish":"../../script/notify success package.json"},"_npmUser":{"name":"primer-css","email":"design-systems@github.com"},"homepage":"https://octicons.github.com","keywords":["GitHub","icons","svg","octicons"],"repository":{"url":"git+https://github.com/primer/octicons.git","type":"git"},"_npmVersion":"5.6.0","description":"A scalable set of icons handcrafted with <3 by GitHub.","directories":{},"maintainers":[{"name":"broccolini","email":"diana.mounter@gmail.com"},{"name":"dgraham","email":"david.malcom.graham@gmail.com"},{"name":"jonrohan","email":"yes@jonrohan.codes"},{"name":"josh","email":"josh@joshpeek.com"},{"name":"keithamus","email":"npm@keithcirkel.co.uk"},{"name":"koddsson","email":"koddsson@gmail.com"},{"name":"mdo","email":"markdotto@gmail.com"},{"name":"mislav","email":"mislav.marohnic@gmail.com"},{"name":"mschoening","email":"max@max.wtf"},{"name":"muan","email":"me@muanchiou.com"},{"name":"primer-css","email":"design-systems@github.com"},{"name":"shawnbot","email":"shawnbot-npm@nym.hush.com"}],"_nodeVersion":"8.10.0","dependencies":{"object-assign":"^4.1.1"},"_hasShrinkwrap":false,"readmeFilename":"README.md","_npmOperationalInternal":{"tmp":"tmp/octicons_7.2.0-alpha.a16c63d2_1521492577516_0.46089570047675954","host":"s3://npm-registry-packages"},"_id":"octicons@7.2.0-alpha.a16c63d2","version":"7.2.0-alpha.a16c63d2"}