{"_id":"@brightlayer-ui/icons-hmi","name":"@brightlayer-ui/icons-hmi","dist-tags":{"alpha":"1.0.0-alpha.0","latest":"1.0.0-alpha.0"},"versions":{"1.0.0-alpha.0":{"name":"@brightlayer-ui/icons-hmi","version":"1.0.0-alpha.0","description":"Brightlayer UI HMI icons for MUI","main":"./index.js","repository":{"type":"git","url":"git+https://github.com/etn-ccis/blui-icons.git"},"author":{"name":"Brightlayer UI","email":"brightlayer-ui@eaton.com"},"license":"BSD-3-Clause","peerDependencies":{"@mui/icons-material":"^7.1.1","@mui/material":"^7.1.1"},"scripts":{"clear:dist":"rimraf dist && mkdir dist","copy:core":"mkdir svg && cp ../../design/HMI/*.svg ./svg","clear:core":"rimraf svg","generate:core":"svgr --typescript --out-dir ./tsx --index-template ./templates/index-template.js --template ./templates/svgr-template.js -- ./svg && bash ./scripts/renameFiles.sh","copy:meta":"cp package.json dist/package.json && cp README.md dist/README.md && cp LICENSE dist/LICENSE && cp CHANGELOG.md dist/CHANGELOG.md && cp index.json dist/index.json","compile":"tsc -p ./tsconfig.lib.json","build":"yarn clear:dist && rimraf tsx/* && yarn copy:core && yarn generate:core && yarn clear:core && yarn compile && yarn copy:meta","prettier":"prettier \"**/*.{ts,tsx,js,jsx,json,css,scss,html,md}\" --write","prettier:check":"prettier \"**/*.{ts,tsx,js,jsx,json,css,scss,html,md}\" --check","publish:package":"cd dist && cross-env npm_config_yes=true && npx -p @brightlayer-ui/publish blui-publish","tag:package":"cd dist && cross-env npm_config_yes=true && npx -p @brightlayer-ui/tag blui-tag -s -blui-icons-hmi","test":"./scripts/buildTest.sh"},"bugs":{"url":"https://github.com/etn-ccis/blui-icons/issues"},"prettier":"@brightlayer-ui/prettier-config","homepage":"https://github.com/etn-ccis/blui-icons/tree/master/hmi#brightlayer-ui-hmi-icons-for-mui","devDependencies":{"@svgr/cli":"^6.5.1","cross-env":"^7.0.3","rimraf":"^5.0.5","typescript":"^5.9.3"},"keywords":["icons","hmi","material","material-ui","MUI","brightlayer-ui"],"_id":"@brightlayer-ui/icons-hmi@1.0.0-alpha.0","gitHead":"33b6651cb45e5c5992eefeaa4cabb550d7f4bbb8","types":"./index.d.ts","_nodeVersion":"20.19.6","_npmVersion":"10.8.2","dist":{"integrity":"sha512-cHewQ4K9QspkEFyCKbIhJ8SublBe1bPRgHOllR1Ao5gs6m9dycMX/HRU8A8jvh91qgtRAoRJxTysjBwg4F+t0A==","shasum":"0de72fd6b2acf53ff01e70f5a097cf2bd3698edf","tarball":"https://registry.npmjs.org/@brightlayer-ui/icons-hmi/-/icons-hmi-1.0.0-alpha.0.tgz","fileCount":119,"unpackedSize":85415,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIGCR0Ng5KVAodJIkimABKgIb9f6xjxLP/4mp/SZxL9dOAiEA1lFinzNNhfC812fz2JSZUMElCs39Ra85uMUPyzzPMxE="}]},"_npmUser":{"name":"brightlayerui","email":"brightlayer-ui@eaton.com"},"directories":{},"maintainers":[{"name":"brightlayerui","email":"brightlayer-ui@eaton.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/icons-hmi_1.0.0-alpha.0_1764868652678_0.14408927048882925"},"_hasShrinkwrap":false}},"time":{"created":"2025-12-04T17:17:32.560Z","1.0.0-alpha.0":"2025-12-04T17:17:32.858Z","modified":"2025-12-04T17:17:33.197Z"},"maintainers":[{"name":"brightlayerui","email":"brightlayer-ui@eaton.com"}],"description":"Brightlayer UI HMI icons for MUI","homepage":"https://github.com/etn-ccis/blui-icons/tree/master/hmi#brightlayer-ui-hmi-icons-for-mui","keywords":["icons","hmi","material","material-ui","MUI","brightlayer-ui"],"repository":{"type":"git","url":"git+https://github.com/etn-ccis/blui-icons.git"},"author":{"name":"Brightlayer UI","email":"brightlayer-ui@eaton.com"},"bugs":{"url":"https://github.com/etn-ccis/blui-icons/issues"},"license":"BSD-3-Clause","readme":"[](https://github.com/etn-ccis/blui-icons/actions/workflows/blui-ci.yml)\n\n\n# Brightlayer UI HMI Icons for MUI\n\nThis library contains HMI (Human-Machine Interface) svg icons from [@brightlayer-ui/icons](https://github.com/etn-ccis/blui-icons) for use in React applications using MUI. The icons are made available in the same way that MUI exposes the [Material Icons](https://mui.com/components/icons/).\n\n## Installation\n\nTo install the Brightlayer UI HMI icons from NPM as a dependency for your project, you can run one of the following commands in your project root:\n\n```\nnpm install --save @brightlayer-ui/icons-hmi\nor\nyarn add @brightlayer-ui/icons-hmi\n```\n\n> **NOTE (Peer Dependencies):** Using this package requires you to have @mui/material and @mui/icons-material defined as dependencies in your project's package.json file.\n\n## Usage\n\n### React\n\nOnce you have installed the npm module, you can import the icon components into your application as follows:\n\n```\nimport myIcon from '@brightlayer-ui/icons-hmi/MyIcon';\n...\n\n```\n\nIf you are importing multiple icons, you can save some space by using named imports from the package root:\n\n```\nimport {LockUnlocked} from '@brightlayer-ui/icons-hmi';\n```\n\n### Applying Different Colors\n\nTo change the color of the icon you are using, simply set the CSS color property. This property is inheritable, so if the property is not set on your icon, it will be inherited from the parent container.\n\n```\n\n```\n\n## Available Icons\n\nHMI specific icons for industrial control applications.\n\n> **NOTE**: When using this package, icon names are in TitleCase (e.g., lock_unlocked --> LockUnlocked).\n\n## Building Icon Set (for contributors)\n\nTo build the icons-hmi package:\n\n```\ngit clone https://github.com/etn-ccis/blui-icons\ncd packages/hmi\nyarn build\n```\n\nThis will populate the /dist folder with all of the icon components as well as copy over necessary files for publishing (Readme, package.json, etc.).\n\n### Publishing\n\nTo publish the package:\n\n```\nyarn build\ncd dist\nnpm version < patch | minor | major >\nnpm publish\n```\n\n> **NOTE:** This package must be published from the /dist folder, not the root directory.\n\n## Browser Support\n\nBrightlayer UI Icons for MUI will work with any modern browser. For details refer to our [Browser Support](https://brightlayer-ui.github.io/development/frameworks-web/react#browser-support) documentation.\n","readmeFilename":"README.md","_rev":"1-0e627b3c84bb4c23567e8863e71cc213"}