@rbxts/roact-hooked
Roact hooks based on Kampfkarren's hooks & React Hooks
Install
npm install @rbxts/roact-hooked
Usage with hook detection
Version 2.4.0 adds the withHookDetection function to allow hooks in function components without manually using HOCs.
It modifies Roact.createElement to detect hook use and wrap them in withHooks or withHooksPure HOCs.
// MyComponent.tsx
import Roact from "@rbxts/roact";
import { markPureComponent, useEffect, useState } from "@rbxts/roact-hooked";
interface Props {
name?: string;
}
export default function MyComponent({ name = "David Baszucki" }: Props) {
const [count, setCount] = useState(0);
useEffect(() => {
print("Counter: " + count);
}, [count]);
return (
<textbutton
Size={new UDim2(1, 0, 1, 0)}
Text={`${name} pressed ${count} times`}
Event={{
Activated: () => setCount((value) => value + 1),
}}
/>
);
}
// Optional: mark the component as a PureComponent
markPureComponent(MyComponent);// mount.client.ts
import Roact from "@rbxts/roact";
import { withHookDetection } from "@rbxts/roact-hooked";
import { Players } from "@rbxts/services";
import MyComponent from "./MyComponent";
withHookDetection(Roact);
Roact.mount(<MyComponent />, Players.LocalPlayer.WaitForChild("PlayerGui"));Usage with HOCs
Using the HOCs directly is still possible if you do not want to modify Roact.createElement for hook detection.
import Roact from "@rbxts/roact";
import { withHooks, withHooksPure, useEffect, useState } from "@rbxts/roact-hooked";
interface Props {
name?: string;
}
function MyComponent({ name = "David Baszucki" }: Props) {
const [count, setCount] = useState(0);
useEffect(() => {
print("Counter: " + count);
}, [count]);
return (
<textbutton
Size={new UDim2(1, 0, 1, 0)}
Text={`${name} pressed ${count} times`}
Event={{
Activated: () => setCount((value) => value + 1),
}}
/>
);
}
export default withHooks(MyComponent);
// Optional: wrap the FC in a PureComponent instead
export default withHooksPure(MyComponent);