Merge pull request #1128 from japgolly/finish_react_18

Author: japgolly

doc/CONFIG.md

@@ -9,7 +9,7 @@
 * Runtime Settings *(development-mode only)*
   * [Usage](#runtime-settings-usage)
   * [`Reusability.disableGloballyInDev()`](#reusabilitydisablegloballyindev)
-  * [`ReusabilityOverlay.overrideGloballyInDev()`](#reusabilityoverlayoverridegloballyindev)
+  * ~~[`ReusabilityOverlay.overrideGloballyInDev()`](#reusabilityoverlayoverridegloballyindev)~~
   * [Custom `ReusabilityOverride`](#custom-reusabilityoverride)
 
 
@@ -211,6 +211,8 @@ This globally disables `Reusability.shouldComponentUpdate` so that it doesn't no
 
 # `ReusabilityOverlay.overrideGloballyInDev()`
 
+**[ReusabilityOverlay has been deprecated in v3 with no replacement — use React's Profiler instead]**
+
 *Note: Runtime settings only affect development-mode (`fastOptJS`) and must be applied before any components are created.*
 
 This makes calls to `Reusability.shouldComponentUpdate` also display a little UI overlay for you to inspect/debug

doc/PERFORMANCE.md

@@ -179,14 +179,16 @@ If you used it to derive an instance for `case class Person(id: Int, name: Strin
 
 There exist two mixins, out-of-the-box, to help you monitor reusability. Use them instead of `shouldComponentUpdate`.
 
-1. `ReusabilityOverlay.install` - Adds an overlay beside each mounted instance of the component, showing how many updates were prevented and how many were rendered. You can hover over it for some detail, and click it to print more to the JS console. [Live demo](https://japgolly.github.io/scalajs-react/#examples/reusability).
+1. **[Deprecated in v3 with no replacement — use React's Profiler instead]**
+    ~~`ReusabilityOverlay.install` - Adds an overlay beside each mounted instance of the component, showing how many updates were prevented and how many were rendered. You can hover over it for some detail, and click it to print more to the JS console. [Live demo](https://japgolly.github.io/scalajs-react/#examples/reusability).~~
 2. `shouldComponentUpdateAndLog` - Logs each callback evaluation to the console.
 
 Usage:
 ```scala
 // No monitoring
 .configure(Reusability.shouldComponentUpdate)
 
+// DEPRECATED IN V3 WITH NO REPLACEMENT
 // Display stats on screen, clickable for detail
 .configure(ReusabilityOverlay.install)
 

doc/changelog/3.0.0.md

@@ -38,12 +38,17 @@
 - The ability to globally turn React warnings into errors via sbt system properties has been removed.
   It's test case had an error in it — it never worked as intended.
 
+- `TriStateCheckbox` no longer uses `Reusability.shouldComponentUpdate`, therefore
+  the fourth argument to its props is no longer wrapped in `Reusable`.
+
 ### Deprecated
 
 - Anything deprecated by React 18 is now deprecated in Scala
 
 - `.renderBackend` — see https://github.com/japgolly/scalajs-react/pull/1125 for how to replace it
 
+- `ReusabilityOverlay` is now deprecated without replacement. It relied on `ReactDOM.findDOMNode` which has been removed in React 19.
+
 - `ReactTestUtils` is now `LegacyReactTestUtils` and deprecated
 
 ### Upgrades

library/build.sbt

@@ -23,6 +23,7 @@ val ghpagesMacros         = ScalaJsReact.ghpagesMacros
 val root                  = ScalaJsReact.root
 val scalafixRules         = ScalaJsReact.scalafixRules
 val tests                 = ScalaJsReact.tests
+val testsDep              = ScalaJsReact.testsDep
 val testUtilMacros        = ScalaJsReact.testUtilMacros
 val testUtil              = ScalaJsReact.testUtil
 val util                  = ScalaJsReact.util

library/coreGeneric/src/main/scala/japgolly/scalajs/react/ComponentDom.scala

@@ -48,6 +48,7 @@ object ComponentDom {
       case null | ()      => Unmounted
     }
 
+  @deprecated("findDOMNode is deprecated and will be removed in the next major release. Instead, add a ref directly to the element you want to reference.", "3.0.0 / React v18")
   def findDOMNode(a: dom.Element | facade.React.ComponentUntyped): ComponentDom = {
     val b: facade.ReactDOM.DomNode | Null =
       try facade.ReactDOM.findDOMNode(a)

library/coreGeneric/src/main/scala/japgolly/scalajs/react/ReactDOM.scala

@@ -10,6 +10,7 @@ object ReactDOM {
   @inline def version = facade.ReactDOM.version
 
   /** For mounted components, use .getDOMNode */
+  @deprecated("findDOMNode is deprecated and will be removed in the next major release. Instead, add a ref directly to the element you want to reference.", "3.0.0 / React v18")
   def findDOMNode(componentOrElement: dom.Element | facade.React.ComponentUntyped): Option[ComponentDom.Mounted] =
     ComponentDom.findDOMNode(componentOrElement).mounted
 

library/coreGeneric/src/main/scala/japgolly/scalajs/react/Reusability.scala

@@ -509,6 +509,8 @@ object Reusability extends ReusabilityMacros with ScalaVersionSpecificReusabilit
     def currentState  = self.currentState
     def nextProps     = self.nextProps
     def nextState     = self.nextState
+
+    @deprecated("Add a ref directly to the element you want to reference.", "3.0.0")
     def getDOMNode    = self.getDOMNode
 
     val updateProps: Boolean = currentProps ~/~ nextProps

library/coreGeneric/src/main/scala/japgolly/scalajs/react/component/Generic.scala

@@ -135,7 +135,9 @@ object Generic {
              type WithMappedProps[P2]    <: MountedSimple[F, A, P2, S]
     def mapProps[P2](f: P => P2): WithMappedProps[P2]
 
+    @deprecated("Add a ref directly to the element you want to reference.", "3.0.0")
     def getDOMNode: F[ComponentDom]
+
     def props: F[Props]
     def propsChildren: F[PropsChildren]
 

library/coreGeneric/src/main/scala/japgolly/scalajs/react/component/Js.scala

@@ -139,6 +139,8 @@ object Js extends JsBaseComponentTemplate[facade.React.ComponentClassP] {
       override def props                            = raw.props
       override def propsChildren                    = PropsChildren.fromRawProps(raw.props)
       override def state                            = raw.state
+
+      @deprecated("Add a ref directly to the element you want to reference.", "3.0.0")
       override def getDOMNode                       = ComponentDom.findDOMNode(raw)
 
       override def setState[G[_]](state: S, callback: => G[Unit])(implicit G: Dispatch[G]): Unit =

library/coreGeneric/src/main/scala/japgolly/scalajs/react/component/Scala.scala

@@ -81,6 +81,8 @@ object Scala {
       override def props                       = x.props.unbox
       override def propsChildren               = x.propsChildren
       override def state                       = x.state.unbox
+
+      @deprecated("Add a ref directly to the element you want to reference.", "3.0.0")
       override def getDOMNode                  = x.getDOMNode
 
       override def setState[G[_]](newState: S, callback: => G[Unit])(implicit G: Dispatch[G]) =