{"_id":"@congritta-ui/checkbox","_rev":"1-0f3222e8db1cb67e59009a517e6bdce9","name":"@congritta-ui/checkbox","description":"Checkbox component of Congritta UI framework","dist-tags":{"latest":"0.0.1"},"versions":{"0.0.1":{"name":"@congritta-ui/checkbox","version":"0.0.1","keywords":["ui","styles","css","framework","frontend","congritta","checkbox"],"author":{"url":"https://congritta.com","name":"Alex Congritta","email":"congritta@gmail.com"},"_id":"@congritta-ui/checkbox@0.0.1","maintainers":[{"name":"congritta","email":"congritta@gmail.com"}],"homepage":"https://ui.congritta.com/docs/checkbox","bugs":{"url":"https://github.com/congritta/ui-checkbox/issues"},"dist":{"shasum":"2bafac7b3526fab091ef917d5c196a1348f73a1b","tarball":"https://registry.npmjs.org/@congritta-ui/checkbox/-/checkbox-0.0.1.tgz","fileCount":22,"integrity":"sha512-2AXEl1as9mgbbuHCYWomOcx8P9wq6mdQ6rEeF1BPhEtcht1LzARbvcPho08m/wAX7wutvFo2rEEQJQl5AIR1rA==","signatures":[{"sig":"MEYCIQDd/tLufDSW7NlU9iRpK4K62oY+f6b4jQtJ/5YTGfwb0gIhAKZYNi8ALOwcnOADeazwzbxQakOHJSKdQhmyq8Cg//iF","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":25386},"main":"dist/index.js","types":"./dist/index.d.ts","gitHead":"1727215bf44edb4894ad6b5dd5862d0ddeb56b85","scripts":{"dev":"bash scripts/dev.sh","lint":"bash scripts/lint.sh","build":"bash scripts/build.sh","prepare":"yarn husky install"},"_npmUser":{"name":"congritta","email":"congritta@gmail.com"},"repository":{"url":"git+https://github.com/congritta/ui-checkbox.git","type":"git"},"_npmVersion":"9.5.1","description":"Checkbox component of Congritta UI framework","directories":{},"_nodeVersion":"18.16.0","dependencies":{"react":"^18.2.0","react-dom":"^18.2.0","@types/react":"^18.2.7","@types/react-dom":"^18.2.4"},"_hasShrinkwrap":false,"packageManager":"yarn@3.5.1","devDependencies":{"husky":"^8.0.3","eslint":"latest","esbuild":"^0.17.19","ts-node":"^10.9.1","typescript":"^5.0.4","@types/node":"^20.2.1","eslint-plugin-react":"latest","@typescript-eslint/parser":"latest","esbuild-css-modules-plugin":"^2.7.1","@typescript-eslint/eslint-plugin":"latest"},"_npmOperationalInternal":{"tmp":"tmp/checkbox_0.0.1_1686856696279_0.5683255041335367","host":"s3://npm-registry-packages"},"deprecated":"Package no longer supported. Contact Support at https://www.npmjs.com/support for more info."}},"time":{"created":"2023-06-15T19:18:16.223Z","modified":"2024-07-02T21:32:43.327Z","0.0.1":"2023-06-15T19:18:16.443Z"},"maintainers":[{"name":"congritta","email":"congritta@gmail.com"}],"author":{"url":"https://congritta.com","name":"Alex Congritta","email":"congritta@gmail.com"},"repository":{"url":"git+https://github.com/congritta/ui-checkbox.git","type":"git"},"keywords":["ui","styles","css","framework","frontend","congritta","checkbox"],"homepage":"https://ui.congritta.com/docs/checkbox","bugs":{"url":"https://github.com/congritta/ui-checkbox/issues"},"readme":"# @congritta-ui/checkbox\r\n\r\nThis is checkbox React component and part of [Congritta UI](https://ui.congritta.com)\r\n\r\n## How to install\r\n\r\n1. Install `@congritta-ui/base` if you didn't it yet. (More info at: http://ui.congritta.com/docs/base);\r\n2. Install `@congritta-ui/checkbox`;\r\n\r\nAdd\r\n\r\n```javascript\r\nimport Checkbox from '@congritta-ui/checkbox';\r\n```\r\n\r\ninto your code\r\n\r\n## How to use\r\n\r\nExample:\r\n\r\n```jsx\r\nexport default MyComponentWidthCheckbox() {\r\n  const [value, setValue] = useState(true)\r\n\r\n  return (\r\n    <Checkbox\r\n      isActive={true}\r\n      onTriggered={() => setValue(!value)}\r\n      contents=\"Text for checkbox here\"\r\n    />\r\n  )\r\n}\r\n```\r\n\r\n### Props\r\n\r\n| Prop name                               | Description                                                           | Is Required | Default value                         |\r\n|-----------------------------------------|-----------------------------------------------------------------------|-------------|---------------------------------------|\r\n| isActive                                | Is checkbox active                                                    | true        |                                       |\r\n| contents                                | Contents to the right of checkbox                                     | false       |                                       |\r\n| onTriggered                             | Function that executes when user clicks on Checkbox component         | false       |                                       |\r\n| unactiveIcon                            | svg element of checkbox when inactive                                 | false       | `<Integrated icon>`                   |\r\n| activeIcon                              | svg element of checkbox when active                                   | false       | `<Integrated icon>`                   |\r\n| wrapperClassName                        | Class name for wrapper for adding additional styles                   | false       |                                       |\r\n| iconClassName                           | Class name for checkbox icon wrapper for adding additional styles     | false       |                                       |\r\n| contentsClassName                       | Class name for checkbox contents wrapper for adding additional styles | false       |                                       |\r\n","readmeFilename":"README.md"}