{"_id":"@buildingradar/icons_library","name":"@buildingradar/icons_library","dist-tags":{"latest":"0.0.1"},"versions":{"0.0.1":{"name":"@buildingradar/icons_library","description":"An icon library package for React applications","version":"0.0.1","keywords":["Lucide","React","Feather","Icons","Icon","SVG","Feather Icons","Fontawesome","Font Awesome"],"author":{"name":"Building Radar Frontend Team","email":"c.riva@buildingradar.com"},"main":"dist/cjs/br-icons.js","main:umd":"dist/umd/br-icons.js","module":"dist/esm/br-icons.js","unpkg":"dist/umd/br-icons.min.js","typings":"dist/br-icons.d.ts","sideEffects":false,"devDependencies":{"@lucide/rollup-plugins":"^1.0.0","@types/react":"^18.2.37","@changesets/cli":"^2.27.5","@vitejs/plugin-react":"^4.2.1","jest-serializer-html":"^7.1.0","react":"18.2.0","react-dom":"18.2.0","rollup":"^4.22.4","rollup-plugin-dts":"^6.1.0","typescript":"^4.9.5","vite":"5.1.8","dotenv-cli":"^7.4.2","@lucide/build-icons":"1.1.0"},"peerDependencies":{"react":"^16.5.1 || ^17.0.0 || ^18.0.0 || ^19.0.0-rc"},"publishConfig":{"access":"public"},"scripts":{"build":"pnpm clean && pnpm build:icons && pnpm typecheck && pnpm build:bundles","clean":"rm -rf dist && rm -rf stats && rm -rf ./src/icons/*.ts && rm -f dynamicIconImports.*","build:icons":"build-icons --output=./src --templateSrc=./scripts/exportTemplate.mjs --withAliases --renderUniqueKey --withDynamicImports --separateAliasesFile --aliasesFileExtension=.ts --iconFileExtension=.ts --exportFileName=index.ts","build:bundles":"rollup -c ./rollup.config.mjs","typecheck":"tsc","typecheck:watch":"tsc -w","changeset":"changeset","changeset-empty":"changeset --empty","bump":"changeset version","pub":"pnpm build && dotenv -e .env npm publish","release":"pnpm publish --no-git-checks"},"_id":"@buildingradar/icons_library@0.0.1","_integrity":"sha512-S3kTKl2UtYoos8MI/i9hCnCKW5ms7bcm4b+mDymbdwpaSSnNdYce3qv7nN+DtFFL3KLd2bRLORDbI8PZf5fHVg==","_resolved":"/tmp/d8786feb5f70cec144203ea9e4e54ba3/buildingradar-icons_library-0.0.1.tgz","_from":"file:buildingradar-icons_library-0.0.1.tgz","_nodeVersion":"21.7.3","_npmVersion":"10.5.0","dist":{"integrity":"sha512-S3kTKl2UtYoos8MI/i9hCnCKW5ms7bcm4b+mDymbdwpaSSnNdYce3qv7nN+DtFFL3KLd2bRLORDbI8PZf5fHVg==","shasum":"21bb4263886b4064d9a981cd0deb67e78f18b513","tarball":"https://registry.npmjs.org/@buildingradar/icons_library/-/icons_library-0.0.1.tgz","fileCount":28,"unpackedSize":128091,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCef8hsfoNyCz89XP9jYIz8Wo1e76UAgVbD8t71eAUd5wIgfnY1jZTbWVImC8J/V+qt/Py5dPw6ROMXuftngHnSIao="}]},"_npmUser":{"name":"alpharabdugeni","email":"a.abuduaini@buildingradar.com"},"directories":{},"maintainers":[{"name":"alpharabdugeni","email":"a.abuduaini@buildingradar.com"},{"name":"frbr","email":"f.oeztuerk@buildingradar.com"},{"name":"cesarriva_br","email":"c.riva@buildingradar.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/icons_library_0.0.1_1732140812974_0.6209354616988703"},"_hasShrinkwrap":false}},"time":{"created":"2024-11-20T22:13:32.897Z","0.0.1":"2024-11-20T22:13:33.166Z","modified":"2024-11-20T22:13:33.466Z"},"maintainers":[{"name":"alpharabdugeni","email":"a.abuduaini@buildingradar.com"},{"name":"frbr","email":"f.oeztuerk@buildingradar.com"},{"name":"cesarriva_br","email":"c.riva@buildingradar.com"}],"description":"An icon library package for React applications","keywords":["Lucide","React","Feather","Icons","Icon","SVG","Feather Icons","Fontawesome","Font Awesome"],"author":{"name":"Building Radar Frontend Team","email":"c.riva@buildingradar.com"},"readme":"# Br Icons Library\n\nThis library is a fork of ['lucide-react'](https://github.com/lucide-icons/lucide/tree/main/packages/lucide-react)\n\nThis library is used for implementation of the custom icons for react applications to be used in complementary with Lucide icons.\n\n> What is lucide? Read it [here](https://github.com/lucide-icons/lucide#what-is-lucide).\n\n\n## Installation\n\n```sh\npnpm install @buildingradar/icons_library\n```\n\n## How to use\n\nFirst of all: make sure the icon conforms to the standards as described in [docs/icon-design-guide.md](https://lucide.dev/guide/design/icon-design-guide), most importantly\n- Icons must be designed on a **24 by 24 pixels** canvas.\n- For each icon these attributes are applied, corresponding to the above rules.\n\n```xml\n<svg\n  xmlns=\"http://www.w3.org/2000/svg\"\n  width=\"24\"\n  height=\"24\"\n  viewBox=\"0 0 24 24\"\n  fill=\"none\"\n  stroke=\"currentColor\"\n  stroke-width=\"2\"\n  stroke-linecap=\"round\"\n  stroke-linejoin=\"round\"\n>\n  <!-- SVGElements -->\n</svg>\n```\n- Allowed Elements\nSVG files may only contain simple path and shape elements, which may not have any attributes other than sizing and spacing.\\\nIn practice only the following elements and attributes are allowed:\n* `<path d>`\n* `<line x1 x2>`\n* `<polygon points>`\n* `<polyline points>`\n* `<circle cx cy r>`\n* `<ellipse cx cy rx ry>`\n* `<rect x y width height rx>`\n\nThis also means that no transforms, filters, fills or explicit strokes are allowed.\n\nNever use [`<use>`](https://developer.mozilla.org/en-US/docs/Web/SVG/Element/use). While it may sometimes seem like a good way to optimize file size, there's no way to ensure that the referenced element IDs will be unique once the SVGs are embedded in HTML documents.\n\n\nIn the ./icons directory, paste the svg file, and create a json file according to `icon.schema.json`. You can copy paste existing json of other icons and edit accordingly. The file name should be identical, in kebap-case. For example `inbox-search.svg` & `inbox-search.json`.\n\nYou should not modify anything else. Files in any other directory is forked from Lucide's repository. \n\nThe `pnpm build` command will auto generate TypeScript code and modules for icons. You don't need to do anything else.\n\n\n## Previews\n\nStorybook is not implemented for this repository. \n\nSteps to link this repo to other repo without publishing intermediate versions:\n\n- change the version number in `package.json` to a higher, temporary version. It helps for other repositories to recognize this is a different version and link correctly. \n- `pnpm build` to build,\n- `npm link` to create link for this repo\n- run `npm link @buildingradar/icons_library` in your repo using this lib\n- you can now import the new icons you added!\n\nYou can also publish test versions.\n\n- change the version number in `package.json` to a higher, temporary version. (e.g. `1.0.1-alpha.1`)\n- `npm publish`\n- use it in your repo \n","readmeFilename":"README.md"}