{"_id":"@dicta/mui-color","_rev":"4-906cfe9b849225c26eaebfe349478f4f","time":{"created":"2022-01-15T17:24:13.862Z","2.0.0-beta.3":"2022-01-15T17:15:27.190Z","modified":"2022-04-05T04:23:17.717Z","2.0.0-beta.4":"2022-01-15T17:24:14.094Z"},"name":"@dicta/mui-color","dist-tags":{"latest":"2.0.0-beta.4"},"versions":{"2.0.0-beta.4":{"name":"@dicta/mui-color","version":"2.0.0-beta.4","description":"The lightest colorpicker for React Mui v5. No dependencies. It uses Hooks and support Typescript, and more !","main":"index.js","module":"./esm/index.js","typings":"index.d.ts","homepage":"https://mikbry.github.io/mui-color/","repository":{"type":"git","url":"https://github.com/mikbry/mui-color.git"},"bugs":{"url":"https://github.com/mikbry/mui-color/issues"},"author":{"name":"Mik","email":"mik@miklabs.com"},"license":"MIT","keywords":["react","color picker","react-component","colorpicker","picker","tiny","color","mui","material-ui","material design","react-color","typescript"],"peerDependencies":{"@emotion/react":"^11.5.0","@emotion/styled":"^11.3.0","@mui/material":"^5.2.2","@mui/styles":"^5.2.2","material-ui-popup-state":"^1.5.3","prop-types":"^15.7.2","react":"^16.0.0 || ^17.0.0","react-dom":"^16.0.0 || ^17.0.0"},"dependencies":{},"licenseText":"MIT License\n\nCopyright (c) 2020 Mik\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n","_id":"@dicta/mui-color@2.0.0-beta.4","dist":{"shasum":"5b58aa54b1768337126617206c15395d26bc20dc","integrity":"sha512-gYjhurcAeDuR34scFWYWyMvMEUa9czfK4Pw82wTA44i8JM2SbdxydJxjz/QA5VcNZXgD4IXu5EOfNa0J2lABqA==","tarball":"https://registry.npmjs.org/@dicta/mui-color/-/mui-color-2.0.0-beta.4.tgz","fileCount":10,"unpackedSize":252857,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJh4wM+CRA9TVsSAnZWagAA+TkP/1SXXv/r6WBplJJZCBvW\nBbKJQFl1toW0X/fgEKYGRIvWZ7HaqRQqGlivFvJtuSJFRVGC+G5b7bX/NJah\nBwXZ0TiHYvKbX9Qpvq7Pi+4yZ9FxS+mbK2DUp4atWLRrCeOH4q+jCo6h35Zf\n16zXLs9KlV+0sLTaesd1SADeOZLiaEry324G97zq+lJOouRMqv8L0osd3cui\nyh4IWLRMV59ayPRsJyQMuwnn+say9LDD+IvA0INXxZnp9yHwPxk804hRVwVR\nfZN/3ABUwClTuLRzxn+S3tw4hNxe7UMUpvA+WxSvCXUA6xDzfGrWCICi2dod\nwrBYIY4vslR1mSHSKLggrXLVmfTpk9KU72lEf6+iM/VBSTURkFg510bt7bbp\nu5YQUjnjYLxrdtAK2xwI0x8plmaz04qG013WrmLXQl+zuDylWlvmvCHGKktt\nDgoF6BalbQodHoOmiNTKXDkArES+uAxlSWipqVLw8sWk6F4YOUBZiCLReCDs\notPfJkt+IOFY7SG0UEEvGp1TDYjRv5PYiqrc7/TEtkBD+cRo05RkejDIixmB\nOlrPuCs/j6mWEffESC6nV/qCQQm1mgxl4/aJsFiXRn1mgtb3KVWZPq9reWTf\n3Q3Ez8/W7BwLnQiOr1Nj2m/wN5S9UHEXKDJeaitr6jo2DDdXPsaMAyjVOArM\nzKYO\r\n=5zxY\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIGwqhAK55ZxF4dcDrYNrXHuGvBJz9/mYVnO8NyCe476IAiASTQYCqxtBNHtae5GPwyNjPFLzzLCac2InJ1w/mVX7yw=="}]},"_npmUser":{"name":"dicta","email":"victorivandd97@gmail.com"},"directories":{},"maintainers":[{"name":"dicta","email":"victorivandd97@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/mui-color_2.0.0-beta.4_1642267453932_0.924329055514489"},"_hasShrinkwrap":false}},"maintainers":[{"name":"dicta","email":"victorivandd97@gmail.com"}],"description":"The lightest colorpicker for React Mui v5. No dependencies. It uses Hooks and support Typescript, and more !","homepage":"https://mikbry.github.io/mui-color/","keywords":["react","color picker","react-component","colorpicker","picker","tiny","color","mui","material-ui","material design","react-color","typescript"],"repository":{"type":"git","url":"https://github.com/mikbry/mui-color.git"},"author":{"name":"Mik","email":"mik@miklabs.com"},"bugs":{"url":"https://github.com/mikbry/mui-color/issues"},"license":"MIT","readme":"# `mui-color` picker and other components\n\n[![Build Status][action-image]][action-url]\n[![codecov][codecov-image]][codecov-url]\n[![NPM version][npm-image]][npm-url]\n[![License][license-image]][license-url]\n[![minisize][min-image]][min-url]\n[![dependency status][deps-svg]][deps-url]\n[![dev dependency status][dev-deps-svg]][dev-deps-url]\n[![peer dependency status][peer-deps-svg]][peer-deps-url]\n[![Downloads][downloads-image]][downloads-url]\n\n[action-image]: https://github.com/mikbry/mui-color/workflows/Build%20and%20Deploy/badge.svg\n[action-url]: https://mikbry.github.io/mui-color/\n[codecov-image]: https://codecov.io/gh/mikbry/mui-color/branch/master/graph/badge.svg?token=K4P0vnM5fh\n[codecov-url]: https://codecov.io/gh/mikbry/mui-color\n[npm-image]: https://img.shields.io/npm/v/mui-color.svg\n[npm-url]: https://npmjs.org/package/mui-color\n[license-image]: https://img.shields.io/github/license/mikbry/mui-color\n[License-url]:https://github.com/mikbry/mui-color/blob/master/LICENSE\n[min-image]:https://badgen.net/bundlephobia/min/mui-color\n[min-url]:https://bundlephobia.com/result?p=mui-color\n[deps-svg]: https://david-dm.org/mikbry/mui-color.svg\n[deps-url]: https://david-dm.org/mikbry/mui-color\n[dev-deps-svg]: https://david-dm.org/mikbry/mui-color/dev-status.svg\n[dev-deps-url]: https://david-dm.org/mikbry/mui-color#info=devDependencies\n[peer-deps-svg]: https://david-dm.org/mikbry/mui-color/peer-status.svg\n[peer-deps-url]: https://david-dm.org/mikbry/mui-color#info=peerDependencies\n[downloads-image]: http://img.shields.io/npm/dm/mui-color.svg\n[downloads-url]: http://npm-stat.com/charts.html?package=mui-color\n\n# Preview port of Material-ui-color to Mui v5\n\n> Collections of color components for [material-ui](https://github.com/mui-org/material-ui). No dependencies, small, highly customizable and theming support !\n\n\n\n![Video of ColorPicker](./images/muicc-v0-2.webp)\n\n## Contents\n\n- [Why another ColorPicker?](#why-another-colorpicker)\n- [Documentation](#documentation)\n- [Requirements](#requirements)\n- [Install](#install)\n- [Usage](#usage)\n- [Roadmap](#roadmap)\n- [Contribute](#contribute)\n- [License](#license)\n\n## Why another ColorPicker ?\n\n- Fully compatible with Material-UI : theming and low level components\n- Highly customizable ColorPicker : gradient picker, palette, input format, deferred mode\n-  Small in size (<30kb) without any direct dependencies\n- Use modern React hook and coding conventions\n- Documentation made with Storybook, using Component Story Format and MDX\n\n## Documentation\n\nFull documentation is available here :\n\nhttps://mikbry.github.io/mui-color/\n\n### Examples \n\n> You can find examples [here](EXAMPLES.md) and [here](/examples).\n\nAlso in codesanbox\n\n- Javascript : https://codesandbox.io/s/mui-color-qb4vm?file=/src/App.jsx\n\n- Typescript : https://codesandbox.io/s/mui-color-picker-qvcg3?file=/src/App.tsx\n\n\n## Requirements\n- Works on modern browsers supporting ES6+ (Not compatible with IE)\n- React and Material-UI frameworks\n\n## Install\n\n```bash\nyarn add mui-color\n```\n\nOr using npm\n```bash\nnpm install mui-color\n```\n\n## Usage\n\nyou need to have in your dependencies:\n\n```\n    \"@mui/material\": \"^4.11.2\",\n    \"material-ui-popup-state\": \"^1.7.1\",\n    \"prop-types\": \"^15.7.2\",\n    \"react\": \"^17.0.1\",\n    \"react-dom\": \"^17.0.1\",\n```\n\n`mui-color` bring 5 components.\n\n### `<ColorPicker/>`\n\nA popover component to display a color tool box. It uses `ColorBox` and `material-ui-popup-state`.\n\n```javascript\nimport { ColorPicker } from 'mui-color';\n\nexport const Container = () => (\n  <div>\n    <ColorPicker defaultValue=\"transparent\"/>\n  </div>\n);\n```\n\nAt first it display a button + an input\n\n[ColorPicker documentation](https://mikbry.github.io/mui-color/?path=/story/components-colorpicker--basic)\n\n### `<ColorBox />`\n\nA component to display a color tool box\n```javascript\nimport { ColorBox } from 'mui-color';\n\nexport const Container = () => (\n  <div>\n    <ColorBox defaultValue=\"transparent\"/>\n  </div>\n);\n```\n\n[ColorBox documentation](https://mikbry.github.io/mui-color/?path=/story/components-colorbox--basic)\n\n### `<ColorInput />`\n\nAn input component to display/edit color values in different format (plain, hex, rgb, hsl, hsv).\n\n```javascript\nimport { ColorInput } from 'mui-color';\n\nexport const Container = () => (\n  <div>\n    <ColorInput defaultValue=\"red\"/>\n  </div>\n);\n```\n\n[ColorInput documentation](https://mikbry.github.io/mui-color/?path=/story/components-colorinput--basic)\n\n### `<ColorPalette />`\n\nA component to display a grid of color buckets.\n\n```javascript\nimport { ColorPalette } from 'mui-color';\n\nconst palette = {\n  red: '#ff0000',\n  blue: '#0000ff',\n  green: '#00ff00',\n  yellow: 'yellow',\n  cyan: 'cyan',\n  lime: 'lime',\n  gray: 'gray',\n  orange: 'orange',\n  purple: 'purple',\n  black: 'black',\n  white: 'white',\n  pink: 'pink',\n  darkblue: 'darkblue',\n};\n\nexport const Container = () => (\n  <div>\n    <ColorPalette palette={palette} />\n  </div>\n);\n```\n\n[ColorPalette documentation](https://mikbry.github.io/mui-color/?path=/story/components-colorpalette--basic)\n\n### `<ColorButton />`\n\nDisplays a button filled with a color\n\n```javascript\nimport { ColorButton } from 'mui-color';\n\nexport const Container = () => (\n  <div>\n    <ColorButton color=\"red\"/>\n  </div>\n);\n```\n\n[ColorButton documentation](https://mikbry.github.io/mui-color/?path=/story/components-colorbutton--basic)\n\n## Roadmap\n\n### v1.0.0 - [Current version](https://github.com/mikbry/mui-color/releases/tag/v1.0.0)\n- remove `styled-components` to have less dependencies and reduce size\n- display wrong color using a red checked box\n- bugs fixes\n\n## Contribute\n\nContributions welcome! Read the [contribution guidelines](CONTRIBUTING.md) first.\n\n\n## License\n\nReleased under MIT License\n","readmeFilename":"README.md"}