{"_id":"@abw/react-icon","name":"@abw/react-icon","dist-tags":{"latest":"0.0.3"},"versions":{"0.0.3":{"name":"@abw/react-icon","version":"0.0.3","description":"A description for react-icon","type":"module","main":"./dist/react-icon.umd.cjs","module":"./dist/react-icon.js","exports":{".":{"import":"./dist/react-icon.js","require":"./dist/react-icon.umd.cjs"}},"author":{"name":"Andy Wardley"},"licence":"ISC","keywords":["react"],"repository":{"type":"git","url":"git+https://github.com/abw/react-icon.git"},"bugs":{"url":"https://github.com/abw/react-icon/issues"},"dependencies":{"@abw/badger-utils":"^1.0.21","react":"^18.2.0","react-dom":"^18.2.0"},"devDependencies":{"@abw/badger-css":"^0.2.8","@abw/badger-react-ui":"^0.0.1","@abw/badger-timestamp":"^1.0.4","@abw/react-context":"^2.0.3","@abw/react-night-and-day":"^0.0.6","@abw/svg-icon-librarian":"^1.0.9","@testing-library/jest-dom":"^6.1.4","@testing-library/react":"^14.1.0","@types/react":"^18.2.37","@types/react-dom":"^18.2.15","@vitejs/plugin-react":"^4.1.1","@vitest/coverage-v8":"^0.34.6","@vitest/ui":"^0.34.6","eslint":"^8.53.0","eslint-plugin-react":"^7.33.2","jsdom":"^22.1.0","react-router-dom":"^6.18.0","react-syntax-highlighter":"^15.5.0","sass":"^1.69.5","vite":"^4.5.0","vite-jsconfig-paths":"^2.0.1","vite-plugin-svgr":"^4.1.0","vitest":"^0.34.6"},"scripts":{"dev":"vite --config vite.docs.js","test":"vitest --ui --coverage","build":"$npm_execpath build:lib && $npm_execpath build:docs","build:lib":"vite build","build:docs":"vite build --config vite.docs.js","preview":"vite preview --config vite.docs.js","lint":"eslint 'lib/**/*.{js,jsx}' 'src/**/*.{js,jsx}'","icons":"svg-icon-librarian -f icons/config.yaml -c icons/custom -o lib/iconlib.js -y"},"homepage":"https://github.com/abw/react-icon#readme","_id":"@abw/react-icon@0.0.3","_integrity":"sha512-oA80ZnUfXK1wijTJkyhhCz3+kAr11uO4OMRkVdfNg0NZApJop7bpaRNHgAo/K47+UsvUWtGB+f/4JmO+MCQCdg==","_resolved":"/private/var/folders/jw/y_b__hgj1n39hh2qgp9s8dnc0000gn/T/fb58c95c01bc4790a98b44349be4195b/abw-react-icon-0.0.3.tgz","_from":"file:abw-react-icon-0.0.3.tgz","_nodeVersion":"18.12.1","_npmVersion":"8.19.2","dist":{"integrity":"sha512-oA80ZnUfXK1wijTJkyhhCz3+kAr11uO4OMRkVdfNg0NZApJop7bpaRNHgAo/K47+UsvUWtGB+f/4JmO+MCQCdg==","shasum":"f78587694a31492dcc0303e82f51f27a666561ca","tarball":"https://registry.npmjs.org/@abw/react-icon/-/react-icon-0.0.3.tgz","fileCount":4,"unpackedSize":28123,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIG88g//UrKDVuMpVmL9ADZHpKOs7NvmoO9P6mYnfrYZeAiEA3805w6GEFNebzF2xeJLdjl9y7EwmQXHslQk8IjwBkFU="}]},"_npmUser":{"name":"abw","email":"abw@wardley.org"},"directories":{},"maintainers":[{"name":"abw","email":"abw@wardley.org"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/react-icon_0.0.3_1700405848407_0.07450894310256628"},"_hasShrinkwrap":false}},"time":{"created":"2023-11-19T14:57:28.301Z","0.0.3":"2023-11-19T14:57:28.629Z","modified":"2023-11-19T14:57:28.867Z"},"maintainers":[{"name":"abw","email":"abw@wardley.org"}],"description":"A description for react-icon","homepage":"https://github.com/abw/react-icon#readme","keywords":["react"],"repository":{"type":"git","url":"git+https://github.com/abw/react-icon.git"},"author":{"name":"Andy Wardley"},"bugs":{"url":"https://github.com/abw/react-icon/issues"},"readme":"# react-icon\n\nThis module implements a React component for rendering SVG icons.\n\nWhat makes this unique is that icon names can have modifiers to change the\norientation, size, position and style properties of the icon.  For example,\nif you have an `arrow` icon defined, pointing up, then specifying the name\nas `arrow-right` will rotate it through 90 degrees to point to the right.\n\nSimilarly, `arrow-thick` will increase the stroke width and `arrow-thin` will\nreduce it.\n\nSee the [website](https://abw.github.io/react-icon) for full documentation\nand examples.\n\n## Getting Started\n\nAdd the `@abw/react-icon` module to your project using your favourite\npackage manager.\n\n```bash\n## using npm\n$ npm add @abw/react-icon\n\n## using yarn\n$ yarn add @abw/react-icon\n\n## using pnpm\n$ pnpm add @abw/react-icon\n```\n\nYou can then import the modules and start using them.\n\n```jsx\nimport { Icon } from '@abw/react-icon'\n\nconst YourComponent = () =>\n  <Icon name=\"arrow-right\"/>\n\nexport default YourComponent\n```\n\n## Notes for Maintainers\n\nCheck out the repository.\n\n```bash\n$ git clone https://github.com/abw/react-icon.git\n$ cd react-icon\n```\n\nInstall the dependencies.\n\n```bash\n$ pnpm install\n```\n\nTo run the development server.\n\n```bash\n$ pnpm dev\n```\n\nTo run the tests.\n\n```bash\n$ pnpm test\n```\n\nTo build for production.\n\n```bash\n$ pnpm build\n```\n\nTo build just the library code for production.\n\n```bash\n$ pnpm build:lib\n```\n\nTo build just the the documentation.\n\n```bash\n$ pnpm build:docs\n```\n\nTo preview the documentation.\n\n```bash\n$ pnpm preview\n```\n\nCheck source code for formatting errors.\n\n```bash\n$ pnpm lint\n```\n\n## Author\n\nAndy Wardley","readmeFilename":"README.md"}