{"id":18782876,"url":"https://github.com/rescript-react-native/checkbox","last_synced_at":"2025-08-01T16:05:59.349Z","repository":{"id":40732962,"uuid":"206010045","full_name":"rescript-react-native/checkbox","owner":"rescript-react-native","description":"ReScript bindings for @react-native-community/checkbox","archived":false,"fork":false,"pushed_at":"2023-02-09T07:13:54.000Z","size":961,"stargazers_count":4,"open_issues_count":3,"forks_count":3,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-07-27T01:58:30.640Z","etag":null,"topics":["checkbox","react","react-native","rescript","rescript-react","rescript-react-native"],"latest_commit_sha":null,"homepage":"","language":"ReScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rescript-react-native.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2019-09-03T06:58:59.000Z","updated_at":"2024-02-20T00:55:03.000Z","dependencies_parsed_at":"2023-02-08T10:01:18.647Z","dependency_job_id":"b4f0ba69-3d49-425c-a2b0-f37e1778fd20","html_url":"https://github.com/rescript-react-native/checkbox","commit_stats":{"total_commits":30,"total_committers":6,"mean_commits":5.0,"dds":"0.23333333333333328","last_synced_commit":"41c2721ea6d87bb5ef71b08bbc207512b76d5845"},"previous_names":["reason-react-native/checkbox"],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/rescript-react-native/checkbox","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rescript-react-native%2Fcheckbox","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rescript-react-native%2Fcheckbox/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rescript-react-native%2Fcheckbox/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rescript-react-native%2Fcheckbox/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rescript-react-native","download_url":"https://codeload.github.com/rescript-react-native/checkbox/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rescript-react-native%2Fcheckbox/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":268256777,"owners_count":24221050,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-01T02:00:08.611Z","response_time":67,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["checkbox","react","react-native","rescript","rescript-react","rescript-react-native"],"created_at":"2024-11-07T20:37:21.374Z","updated_at":"2025-08-01T16:05:59.321Z","avatar_url":"https://github.com/rescript-react-native.png","language":"ReScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# `@rescript-react-native/checkbox`\n\n[![Build Status](https://github.com/rescript-react-native/checkbox/workflows/Build/badge.svg)](https://github.com/rescript-react-native/checkbox/actions)\n[![Version](https://img.shields.io/npm/v/@rescript-react-native/checkbox.svg)](https://www.npmjs.com/@rescript-react-native/checkbox)\n[![ReScript Forum](https://img.shields.io/discourse/posts?color=e6484f\u0026label=ReScript%20Forum\u0026server=https%3A%2F%2Fforum.rescript-lang.org)](https://forum.rescript-lang.org/)\n\n[ReScript](https://rescript-lang.org) bindings for\n[`@react-native-community/react-native-checkbox`](https://github.com/react-native-checkbox/react-native-checkbox).\n\nThe module will be exposed as `ReactNativeCheckbox`.\n\nVersion x.y.z of `@rescript-react-native/checkbox` is intended to be compatible\nwith version x.y.z of `@react-native-community/react-native-checkbox`.\n\n## Installation\n\nWhen\n[`@react-native-community/react-native-checkbox`](https://github.com/react-native-checkbox/react-native-checkbox)\nis properly installed \u0026 configured by following their installation instructions,\nyou can install the bindings:\n\n```console\nnpm install @rescript-react-native/checkbox\n# or\nyarn add @rescript-react-native/checkbox\n```\n\n`@rescript-react-native/checkbox` should be added to `bs-dependencies` in your\n`bsconfig.json`. For example,\n\n```diff\n{\n  //...\n  \"bs-dependencies\": [\n    \"@rescript/react\",\n    \"rescript-react-native\",\n    // ...\n+    \"@rescript-react-native/checkbox\"\n  ],\n  //...\n}\n```\n\n## Usage\n\n### Types\n\n#### `CheckBoxEvent.t`\n\nAssuming `checkboxEvent` is `CheckBoxEvent.t`, you can access\n\n```rescript\ncheckboxEvent.nativeEvent.target // =\u003e int\ncheckboxEvent.nativeEvent.value // =\u003e bool\n```\n\n`value` represents value of the checkbox as updated by the event.\n\n#### `element`\n\nType to be used in `ref` and with `NativeMethods`, as with other components in\nReact Native bindings.\n\n#### `ref`\n\nis an alias for `React.Ref.t(Js.nullable(element))`.\n\n### CheckBox common props\n\nAll props are optional.\n\n#### `value: bool`\n\nValue of the checkbox. When `true`, checkbox will be checked. Default value is\n`false`.\n\n#### `onChange: checkBoxEvent =\u003e unit`\n\nReturns a [native event](#checkBoxEvent).\n\n#### `onValueChange`\n\nReturns the new `bool` value.\n\n#### `testID: string`\n\nUsed to locate this view in end-to-end tests.\n\n### CheckBox Android props\n\n#### `disabled: bool`\n\nWhen `true`, user will not be able to toggle the checkbox. Default value is\n`false`.\n\n#### `tintColors`\n\n```rescript\ntintColors:\n  (~_true: int=?, ~_false: int=?, unit) =\u003e tintColors\n```\n\nValue for `_true` will be used when the checkbox is checked, and value for\n`_false` will be used when it is not checked.\n\n### CheckBox iOS props\n\n#### `lineWidth: float`\n\nThe width of the lines of the check mark and box. Defaults to `2.0`.\n\n#### `hideBox: bool`\n\nControl if the box should be hidden or not. Defaults to `false`\n\n#### `` boxType: `circle or `square ``\n\nThe type of box to use. Defaults to `` `circle ``\n\n#### `tintColor: Color.t`\n\nThe color of the box when the checkbox is Off. Defaults to `#aaaaaa`\n\n#### `onCheckColor: Color.t`\n\nThe color of the check mark when it is On. Defaults to `#007aff`\n\n#### `onFillColor: Color.t`\n\nThe color of the inside of the box when it is On. Defaults to transparent\n\n#### `onTintColor: Color.t`\n\nThe color of the line around the box when it is On. Defaults to `#007aff`\n\n#### `animationDuration: float`\n\nThe duration in seconds of the animations. Defaults to 0.5\n\n#### `` onAnimationType: `stroke or `fill or `bounce or `flat or `oneStroke or `fade ``\n\nThe type of animation to use when the checkbox gets checked. Defaults to\n`` `stroke ``\n\n#### `` offAnimationType: `stroke or `fill or `bounce or `flat or `oneStroke or `fade ``\n\nThe type of animation to use when the checkbox gets unchecked. Defaults to\n`` `stroke ``\n\n### `View` props\n\nRefer to\n[`rescript-react-native`](https://github.com/rescript-react-native/react-native)\n[documentation](https://rescript-react-native.github.io/en/docs/components/View/).\n\n---\n\n## Changelog\n\nCheck the [changelog](./CHANGELOG.md) for more information about recent\nreleases.\n\n## Contribute\n\nRead the [contribution guidelines](https://github.com/rescript-react-native/.github/blob/master/CONTRIBUTING.md) before contributing.\n\n## Code of Conduct\n\nWe want this community to be friendly and respectful to each other. Please read\n[our full code of conduct](https://github.com/rescript-react-native/.github/blob/master/CODE_OF_CONDUCT.md) so that you can understand what\nactions will and will not be tolerated.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frescript-react-native%2Fcheckbox","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frescript-react-native%2Fcheckbox","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frescript-react-native%2Fcheckbox/lists"}