{"bugs":{"url":"https://github.com/primer/octicons/issues"},"dist":{"shasum":"94238d5431389c11be0eafa59976abdeea85d8e8","tarball":"https://registry.npmjs.org/octicons/-/octicons-0.0.0-49f1512.tgz","fileCount":191,"integrity":"sha512-C1Cguos3tTtAAIrFsG5+XMswq3PCZm+iBWIGTKY0BZtJxmoyetQVO9TW1Vf912WYukEZWByHZWJ+a2JrgcDa/A==","signatures":[{"sig":"MEYCIQC/OFwM8QkrW8K5EyBBu7907mmiwSp3XSB2laqPDvT1jAIhAJg/leHz3KgSeAcNZYSwnVx8kaqiktvZitL2NpyHByQL","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":167825,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJccH8qCRA9TVsSAnZWagAAtmcP/jN9hPPr8odMSsHsI9Oq\n1qmxWwB1IvzvCTnfvJRjIaR4ZV4g+wzfDhr1y7gSdZfL7Zp/NXf0dHkuT+KL\njVEwGmYMonrRzDgF1oxqNHWSUmSo8Shi36GRItG8Z32qegsLF3NMksCZ5NSG\nUgFS8lpyrTh/V5GdDCszYPaI0q3UO/v1vCefcg2YwFa0ULrLKIg6/6nNoY7c\nZGL/Xgmzx4WfFtFdtrLouEedbAlCzhAss48jDHH8Ku92ZvNv6CNhkSN8cf4v\nvoFEhvtfplX66H5xYFrctHhHsS3glJJx4mEItamrQIU4yYi8+DkjWbQUffc6\n6+/0Gkyn65lZFbDc+EhDW1Ks6/Nmu6SJIrwEMAC32sk9OgpjhB9TWgtLTKLX\nBqB00gpJMIdHfKHTOv3mnM0/qWEPiOM/zPwuM/NA+uspcqs1O90PzugLNNYW\nI3C+b4K7Na1mY3cvj/4ER5BILtjGlZ1D8haB7IVsnccZhqDdTC4A1WaxyzRX\nJMPqF5X/J4YqnV/XnylFq6oOM+LaBfAiCvxAm1p00Gegl4g25cNyiPLytcAQ\nEkCtfkDzbyrPKDj8ELFUYOaZA9hGOYndD4+O0qL0ykA/vSZpwht4bw65/eJc\njDCm7ZZAD5F6zASobZnhFOU9228cpGrQ2ovL+sbkgihmYZzu27IYq8/CCFCl\nVfBF\r\n=Ih8f\r\n-----END PGP SIGNATURE-----\r\n"},"main":"index.js","name":"octicons","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: '<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\"/>',\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// <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>\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 `<svg>` tag.\n\n```js\nocticons.x.toSVG()\n// <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>\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 `<svg>` tag.\n\n```js\nocticons.x.toSVG({ \"class\": \"close\" })\n// <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>\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// <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>\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// <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>\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","license":"MIT","scripts":{"lint":"eslint index.js tests/*.js","test":"ava --verbose 'tests/*.js'","build":"script/build.js"},"_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":"6.4.1","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":"emilybrick","email":"emily.brick@buzzfeed.com"},{"name":"emplums","email":"eplummer26@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":"10.15.1","dependencies":{"object-assign":"^4.1.1"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"ava":"^0.22.0","eslint":"^5.8.0","eslint-plugin-github":"^1.6.0"},"_npmOperationalInternal":{"tmp":"tmp/octicons_0.0.0-49f1512_1550876457632_0.8460287975806222","host":"s3://npm-registry-packages"},"_id":"octicons@0.0.0-49f1512","version":"0.0.0-49f1512"}