Skip to content
This repository has been archived by the owner on Apr 21, 2024. It is now read-only.

bloodyowl/rescript-react-compat

Repository files navigation

rescript-react-compat

An alternative upgrade path for ReasonReact

Installation

$ yarn add rescript-react-compat

or

$ npm install --save rescript-react-compat

Then add rescript-react-compat to your bsconfig.json bs-dependencies field.

ReactCompat.useRecordApi

Enables you to wrap your existing ReasonReact.statelessComponent and ReasonReact.reducerComponent through a React hook.

[@react.component]
let make = () => {
  ReactCompat.useRecordApi({
    ...ReactCompat.component,
    render: _ =>
      <div> "Helloworld!"->ReasonReact.string </div>
  })
}

Upgrade path

Stateless components

For implementation files (.re)

-let component = ReasonReact.statelessComponent("MyComponent");

+[@react.component]
- let make = _ => {
+ let make = () => {
+  ReactCompat.useRecordApi(
     {
-      ...component,
+      ...ReactCompat.component,
       render: _ =>
         <div> "Helloworld!"->ReasonReact.string </div>
     }
+  )
 }

For interface files (.rei)

+[@react.component]
- let make = 'a =>
+ let make = unit =>
-  ReasonReact.component(
-    ReasonReact.stateless,
-    ReasonReact.noRetainedProps,
-    ReasonReact.actionless
-  );
+  React.element;

Reducer components

For implementation files (.re)

 type action = | Tick;

 type state = {count: int};

-let component = ReasonReact.reducerComponent("MyComponent");

+[@react.component]
- let make = _ => {
+ let make = () => {
+  ReactCompat.useRecordApi(
     {
-      ...component,
+      ...ReactCompat.component,
       /* some lifecycle */
       render: _ =>
         <div> "Helloworld!"->ReasonReact.string </div>
     }
+  )
 }

You'll also need to rename:

  • ReasonReact.Update -> Update
  • ReasonReact.UpdateWithSideEffects -> UpdateWithSideEffects
  • ReasonReact.SideEffects -> SideEffects
  • ReasonReact.NoUpdate -> NoUpdate

For interface files (.rei)

-type state;

-type action;

+[@react.component]
- let make = 'a =>
+ let make = unit =>
-  ReasonReact.component(
-    state,
-    ReasonReact.noRetainedProps,
-    action
-  );
+  React.element;

Acknowledgments

Thnks @rickyvetter for the original idea and help through the process

Sponsor this project

 

Packages

No packages published