@alepha/react 0.9.2 → 0.9.4

package/README.md

@@ -34,6 +34,52 @@ Main descriptor for defining a React route in the application.
 
 ### Hooks
 
+#### useAlepha()
+
+Main Alepha hook.
+
+It provides access to the Alepha instance within a React component.
+
+With Alepha, you can access the core functionalities of the framework:
+
+- alepha.state() for state management
+- alepha.inject() for dependency injection
+- alepha.emit() for event handling
+etc...
+
+#### useClient()
+
+Hook to get a virtual client for the specified scope.
+
+It's the React-hook version of `$client()`, from `AlephaServerLinks` module.
+
+#### useInject()
+
+Hook to inject a service instance.
+It's a wrapper of `useAlepha().inject(service)` with a memoization.
+
+#### useQueryParams()
+
+Not well tested. Use with caution.
+
+#### useRouter()
+
+Use this hook to access the React Router instance.
+
+You can add a type parameter to specify the type of your application.
+This will allow you to use the router in a typesafe way.
+
+class App {
+  home = $page();
+}
+
+const router = useRouter<App>();
+router.go("home"); // typesafe
+
+#### useRouterEvents()
+
+Subscribe to various router events.
+
 #### useStore()
 
 Hook to access and mutate the Alepha state.