{"id":22454358,"url":"https://github.com/littensy/rbxts-react","last_synced_at":"2025-08-02T02:31:16.547Z","repository":{"id":179322277,"uuid":"663308450","full_name":"littensy/rbxts-react-ts","owner":"littensy","description":"React for Roblox-TS","archived":true,"fork":false,"pushed_at":"2024-02-16T07:38:34.000Z","size":262,"stargazers_count":11,"open_issues_count":1,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-12-01T08:57:58.499Z","etag":null,"topics":["roact","roblox-ts"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/@rbxts/react-ts","language":"Lua","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/littensy.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2023-07-07T02:46:40.000Z","updated_at":"2024-10-17T01:40:44.000Z","dependencies_parsed_at":null,"dependency_job_id":"b58fcbd8-5ad2-4946-8452-2b0ca6dadf20","html_url":"https://github.com/littensy/rbxts-react-ts","commit_stats":null,"previous_names":["littensy/rbxts-react","littensy/rbxts-react-ts"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/littensy%2Frbxts-react-ts","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/littensy%2Frbxts-react-ts/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/littensy%2Frbxts-react-ts/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/littensy%2Frbxts-react-ts/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/littensy","download_url":"https://codeload.github.com/littensy/rbxts-react-ts/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228209948,"owners_count":17885595,"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","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":["roact","roblox-ts"],"created_at":"2024-12-06T07:07:31.709Z","updated_at":"2024-12-06T07:07:45.149Z","avatar_url":"https://github.com/littensy.png","language":"Lua","readme":"# [`@rbxts/react-ts`](https://www.npmjs.com/package/@rbxts/react-ts)\n\nTo allow React in Roblox-TS, this package combines `jsdotlua/react` and `jsdotlua/roact-compat` and re-exports them with typings from `@rbxts/roact` some types from [the DefinitelyTyped package](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/react/v17/index.d.ts).\n\nThe package also needs to be installed with an alias to trick the compiler into using this package instead of the _actual_ Roact package.\n\n\u003e [!IMPORTANT]\n\u003e This package is superseded by [littensy/rbxts-react](https://github.com/littensy/rbxts-react).\n\n## 📦 Installation\n\n### ⚛️ React for Roblox-TS\n\nFor this package to work, it needs the `@rbxts/roact` alias so that Roblox-TS can use this package for your TSX files.\n\nYou can install with an alias like so:\n\n```bash\nnpm install @rbxts/roact@npm:@rbxts/react-ts@latest\nyarn add @rbxts/roact@npm:@rbxts/react-ts@latest\npnpm add @rbxts/roact@npm:@rbxts/react-ts@latest # SEE NOTE BELOW\n```\n\nMake sure the following alias or something similar is in your `package.json`:\n\n```json\n\"dependencies\": {\n    \"@rbxts/roact\": \"npm:@rbxts/react-ts\",\n}\n```\n\n#### ⚠️ Note for pnpm users\n\nPNPM symlinks packages by default, which doesn't work well with Rojo. You can disable this behavior by adding the following to your `.npmrc`:\n\n```properties\nnode-linker=hoisted\n```\n\n### 📎 ReactRoblox\n\nYou can install `@rbxts/react-roblox` to render React components with `createRoot` instead of `Roact.mount`.\n\n```bash\nnpm install @rbxts/react-roblox\nyarn add @rbxts/react-roblox\npnpm add @rbxts/react-roblox\n```\n\n## ✅ Compatibility\n\nInstalling this package will install React, ReactRoblox, etc. directly under the `@rbxts` folder in located ReplicatedStorage.\n\nIf your package depends on React packages, they may be imported in Luau via `require(script.Parent...Parent.MODULE)` or `require(...node_modules[\"@rbxts\"].MODULE)` depending on your project structure.\n\n\u003cdetails\u003e\n    \u003csummary\u003eSee explorer view\u003c/summary\u003e\n    \u003cimg src=\"images/compatibility.png\" width=\"200\"\u003e\n\u003c/details\u003e\n\n## 📋 Sources\n\nTypes are derived from [DefinitelyTyped](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/react/v17/index.d.ts).\n\nDependencies of this package were published from [littensy/react-lua](https://github.com/littensy/react-lua), which is a fork of [jsdotlua/react-lua](https://github.com/jsdotlua/react-lua).\n","funding_links":[],"categories":["Other"],"sub_categories":["React for Roblox Typescript \u003cimg src=\"roblox-ts.svg\" width=\"18px\" /\u003e"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flittensy%2Frbxts-react","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flittensy%2Frbxts-react","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flittensy%2Frbxts-react/lists"}