@rbxts/scribe-react 2.5.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 ericplane
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/NOTICE

@@ -0,0 +1,21 @@
+Scribe
+Copyright (c) 2026 ericplane
+Licensed under the MIT License (see LICENSE).
+
+This product bundles a modified copy of ProfileStore v1.0.3:
+
+    ProfileStore
+    Copyright (c) loleris / MAD STUDIO
+    https://github.com/MadStudioRoblox/ProfileStore
+    Licensed under the Apache License, Version 2.0.
+
+The bundled copy lives at src/Internal/Store/ProfileStore.luau and HAS BEEN
+MODIFIED. Every modification is marked `SCRIBE PATCH` in that file and summarised
+in its header. A copy of the Apache License, Version 2.0 is included at
+licenses/ProfileStore-Apache-2.0.txt.
+
+The licence text is kept OUTSIDE src/ on purpose. Everything under src/ is packed
+into the released .rbxm, where a plain text file has no place and whose contents
+Roblox scans for off-platform links -- and the licence is full of them. Attribution
+travels with the code in the file header, which is what Apache-2.0 section 4
+actually asks for; the full text travels with the source package.

package/README.md

@@ -0,0 +1,5 @@
+# @rbxts/scribe-react
+
+Optional Scribe addon. Install only if you use it.
+
+See [the roblox-ts guide](https://scribe.ericplane.dev/roblox-ts/) for usage.

package/Scribe-source-map.json

@@ -0,0 +1 @@
+{"version":"2.5.0","format":1,"description":"Segments are [packedLine, sourceLine]. Use the last segment at or before the packed line, then add its line offset.","files":{"addons/ui/ScribeReact.luau":{"sourceSha256":"129371347fee37556b753b9ba8c1ba7a20f4a5764c595b505cd53ec3d6b8eb0b","packedSha256":"6e85c1c51649d96cd3b8b3106766f782f1373103ffad31a5e1cbfea632127929","segments":[[1,1]],"packagePath":"init.luau"}}}

package/index.d.ts

@@ -0,0 +1,16 @@
+import type React = require("@rbxts/react");
+import type Scribe from "@rbxts/scribe";
+
+/** Bind the shared Luau adapter to the React installation used by your game. */
+declare function ScribeReact(react: Pick<typeof React, "useState" | "useEffect" | "useBinding">): ScribeReact.Adapter;
+
+declare namespace ScribeReact {
+	interface Adapter {
+		/** Use inside a component. Changes re-render the component. */
+		readonly useScribe: <T>(this: void, accessor: Scribe.ReadableNode<T>) => T;
+		/** Use inside a component. Changes update the binding without a re-render. */
+		readonly useScribeBinding: <T>(this: void, accessor: Scribe.ReadableNode<T>) => React.Binding<T>;
+	}
+}
+
+export = ScribeReact;

package/init.luau

@@ -0,0 +1,41 @@
+--!strict
+-- React adapter. Copy into your game; not part of the Scribe package.
+--   local Scribe = require(path.to.ScribeReact)(React)
+--   local coins = Scribe.useScribe(Data.Coins)          -- re-renders
+--   local coins = Scribe.useScribeBinding(Data.Coins)   -- property only
+--
+-- useState + useEffect, not useSyncExternalStore: that is React 18 and jsdotlua
+-- React 17.2.1 does not export it.
+
+return function(React: any)
+	local Adapter = {}
+
+	--- State tracking one accessor. Re-renders on every change.
+	function Adapter.useScribe(accessor: any): any
+		local value, setValue = React.useState(accessor.Get)
+		React.useEffect(function()
+			-- Re-read before subscribing: a write landing between render and effect is
+			-- otherwise missed, and the UI sits on the stale first value forever.
+			setValue(accessor.Get())
+			return accessor.Changed(function(new)
+				setValue(new)
+			end)
+		end, { accessor })
+		return value
+	end
+
+	--- A binding instead of state: updates the property without re-rendering. Prefer it
+	--- for a value that only feeds Text or Size.
+	function Adapter.useScribeBinding(accessor: any): any
+		local binding, setBinding = React.useBinding(accessor.Get())
+		React.useEffect(function()
+			setBinding(accessor.Get())
+			return accessor.Changed(function(new)
+				setBinding(new)
+			end)
+		end, { accessor })
+		return binding
+	end
+
+	return Adapter
+end

package/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "@rbxts/scribe-react",
+  "version": "2.5.0",
+  "description": "Optional react addon for Scribe",
+  "main": "init.luau",
+  "types": "index.d.ts",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ericplane/Scribe.git"
+  },
+  "homepage": "https://scribe.ericplane.dev/",
+  "author": "ericplane",
+  "peerDependencies": {
+    "@rbxts/scribe": "^2.5.0",
+    "@rbxts/react": "^17.0.0 || ^17.3.7-ts.2"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}