littensy/rbxts-roact-hooked

Roact hooks based on Kampfkarren's implementation & React Hooks

rbxts-roact-hooked's Issues

withHookDetection returns `void`

Looking at the source code, withHookDetection() should return Roact?.

Version conflicts result in unusual behavior with Hooks

Functions like resolveCurrentComponent() do not return the same component between different versions of roact-hooked. So, packages that provide useful hooks should use roact-hooked as a peer dependency.

However, should resolveCurrentComponent() be consistent between different instances, anyways? It would keep track of rendering components with _G to make it less error-prone.

Is this change worth it, or would a descriptive error message be enough?

useState set function types are incorrect

const [attributeValue, setAttributeValue] = useState(instance?.GetAttribute(attribute));
useEffect(() => setAttributeValue(instance?.GetAttribute(attribute)), [instance, attribute]);

setAttributeValue() claims it returns void, but actually returns the new state.

In my case, this caused effect.destroy to become true:
https://github.com/littensy/rbxts-roact-hooked/blob/master/src/hooks.lua#L156

Which then caused this check to pass:
https://github.com/littensy/rbxts-roact-hooked/blob/master/src/hooks.lua#L150

Which then throws an error here, because it's doing coroutine.create(true):
https://github.com/littensy/rbxts-roact-hooked/blob/master/src/NoYield.lua#L30

Re-export Roact

Re-export the Roact API with in-built support for hooks. This should help simplify imports and code.

Use LuaTuple return types

Would help to have hooks return lua tuples instead of arrays to make use in Luau easier

Move `stories` outside of `src`

I don't want to keep this directory in src, but I do not know how to move it outside while also including it in roblox-ts for testing in Roblox Studio

Write tests and refactor code

Code should have unit tests instead of stories for better coverage.

Switch to exposing hooks through a "dispatcher" rather than having that logic be in a file.