trait all extends react17 with react18 with extra
- Alphabetic
- By Inheritance
- all
- extra
- react18
- react17
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def useCallback[A](callback: A)(implicit isCallbackArg: UseCallbackArg[A]): HookResult[Reusable[A]]
Returns a memoized callback.
Returns a memoized callback.
Pass an inline callback and dependencies. useCallback will return a memoized version of the callback that only changes if one of the dependencies has changed. This is useful when passing callbacks to optimized child components that rely on reference equality to prevent unnecessary renders.
- Definition Classes
- react17
- Annotations
- @inline()
- See also
https://reactjs.org/docs/hooks-reference.html#usecallback
- final def useCallbackWithDeps[D, A](deps: => D)(callback: (D) => A)(implicit arg0: Reusability[D], isCallbackArg: UseCallbackArg[A]): HookResult[Reusable[A]]
Returns a memoized callback.
Returns a memoized callback.
Pass an inline callback and dependencies. useCallback will return a memoized version of the callback that only changes if one of the dependencies has changed. This is useful when passing callbacks to optimized child components that rely on reference equality to prevent unnecessary renders.
- Definition Classes
- react17
- Annotations
- @inline()
- See also
https://reactjs.org/docs/hooks-reference.html#usecallback
- final def useContext[A](ctx: Context[A]): HookResult[A]
Accepts a context object and returns the current context value for that context.
Accepts a context object and returns the current context value for that context. The current context value is determined by the value prop of the nearest
<MyContext.Provider>
above the calling component in the tree.When the nearest
<MyContext.Provider>
above the component updates, this Hook will trigger a rerender with the latest context value passed to thatMyContext
provider. Even if an ancestor usesReact.memo
orshouldComponentUpdate
, a rerender will still happen starting at the component itself usinguseContext
.A component calling
useContext
will always re-render when the context value changes. If re-rendering the component is expensive, you can optimize it by using memoization.useContext(MyContext)
only lets you read the context and subscribe to its changes. You still need a<MyContext.Provider>
above in the tree to provide the value for this context.- Definition Classes
- react17
- Annotations
- @inline()
- See also
https://reactjs.org/docs/hooks-reference.html#usecontext
- final def useDebugValue(desc: => Any): HookResult[Unit]
Used to display a label for custom hooks in React DevTools.
Used to display a label for custom hooks in React DevTools.
- Definition Classes
- react17
- Annotations
- @inline()
- See also
https://reactjs.org/docs/hooks-reference.html#usedebugvalue
- final def useDeferredValue[A](value: A): HookResult[A]
Lets you defer updating a part of the UI.
Lets you defer updating a part of the UI.
- Definition Classes
- react18
- Annotations
- @inline()
- See also
- final def useEffect[A](effect: A)(implicit isEffectArg: UseEffectArg[A]): HookResult[Unit]
The callback passed to useEffect will run after the render is committed to the screen.
The callback passed to useEffect will run after the render is committed to the screen. Think of effects as an escape hatch from React’s purely functional world into the imperative world.
By default, effects run after every completed render. If you'd only like to execute the effect when your component is mounted, then use useEffectOnMount. If you'd only like to execute the effect when certain values have changed, then use useEffectWithDeps.
- Definition Classes
- react17
- Annotations
- @inline()
- See also
https://reactjs.org/docs/hooks-reference.html#useeffect
- final def useEffectOnMount[A](effect: A)(implicit isEffectArg: UseEffectArg[A]): HookResult[Unit]
The callback passed to useEffect will run after the render is committed to the screen.
The callback passed to useEffect will run after the render is committed to the screen. Think of effects as an escape hatch from React’s purely functional world into the imperative world.
This will only execute the effect when your component is mounted.
- Definition Classes
- react17
- Annotations
- @inline()
- See also
https://reactjs.org/docs/hooks-reference.html#useeffect
- final def useEffectWithDeps[D, A](deps: => D)(effect: (D) => A)(implicit arg0: Reusability[D], isEffectArg: UseEffectArg[A]): HookResult[Unit]
The callback passed to useEffect will run after the render is committed to the screen.
The callback passed to useEffect will run after the render is committed to the screen. Think of effects as an escape hatch from React’s purely functional world into the imperative world.
This will only execute the effect when values in the first argument change.
- Definition Classes
- react17
- Annotations
- @inline()
- See also
https://reactjs.org/docs/hooks-reference.html#useeffect
- final val useForceUpdate: HookResult[Reusable[Sync[Unit]]]
Provides a Callback that when invoked forces a re-render of your component.
Provides a Callback that when invoked forces a re-render of your component.
- Definition Classes
- extra
- Annotations
- @inline()
- final def useId: HookResult[String]
Generates unique IDs that can be passed to accessibility attributes.
Generates unique IDs that can be passed to accessibility attributes.
- Definition Classes
- react18
- Annotations
- @inline()
- See also
https://react.dev/reference/react/useId
- final def useInsertionEffect[A](effect: A)(implicit isEffectArg: UseEffectArg[A]): HookResult[Unit]
The signature is identical to useEffect, but it fires synchronously after all DOM mutations, but before any layout Effects fire.
The signature is identical to useEffect, but it fires synchronously after all DOM mutations, but before any layout Effects fire. Use this to insert styles before any Effects fire that may need to read layout. Updates scheduled inside useLayoutEffect will be flushed synchronously, before the browser has a chance to paint.
Prefer the standard useEffect when possible to avoid blocking visual updates.
If you'd only like to execute the effect when your component is mounted, then use useInsertionEffectOnMount. If you'd only like to execute the effect when certain values have changed, then use useInsertionEffectWithDeps.
- Definition Classes
- react18
- Annotations
- @inline()
- See also
https://react.dev/reference/react/useInsertionEffect#useInsertionEffect
- final def useInsertionEffectOnMount[A](effect: A)(implicit isEffectArg: UseEffectArg[A]): HookResult[Unit]
The signature is identical to useEffect, but it fires synchronously after all DOM mutations, but before any layout Effects fire.
The signature is identical to useEffect, but it fires synchronously after all DOM mutations, but before any layout Effects fire. Use this to insert styles before any Effects fire that may need to read layout. Updates scheduled inside useLayoutEffect will be flushed synchronously, before the browser has a chance to paint.
Prefer the standard useEffect when possible to avoid blocking visual updates.
This will only execute the effect when your component is mounted.
- Definition Classes
- react18
- Annotations
- @inline()
- See also
https://react.dev/reference/react/useInsertionEffect#useInsertionEffect
- final def useInsertionEffectWithDeps[D, A](deps: => D)(effect: (D) => A)(implicit arg0: Reusability[D], isEffectArg: UseEffectArg[A]): HookResult[Unit]
The signature is identical to useEffect, but it fires synchronously after all DOM mutations, but before any layout Effects fire.
The signature is identical to useEffect, but it fires synchronously after all DOM mutations, but before any layout Effects fire. Use this to insert styles before any Effects fire that may need to read layout. Updates scheduled inside useLayoutEffect will be flushed synchronously, before the browser has a chance to paint.
Prefer the standard useEffect when possible to avoid blocking visual updates.
This will only execute the effect when values in the first argument change.
- Definition Classes
- react18
- Annotations
- @inline()
- See also
https://react.dev/reference/react/useInsertionEffect#useInsertionEffect
- final def useLayoutEffect[A](effect: A)(implicit isEffectArg: UseEffectArg[A]): HookResult[Unit]
The signature is identical to useEffect, but it fires synchronously after all DOM mutations.
The signature is identical to useEffect, but it fires synchronously after all DOM mutations. Use this to read layout from the DOM and synchronously re-render. Updates scheduled inside useLayoutEffect will be flushed synchronously, before the browser has a chance to paint.
Prefer the standard useEffect when possible to avoid blocking visual updates.
If you'd only like to execute the effect when your component is mounted, then use useLayoutEffectOnMount. If you'd only like to execute the effect when certain values have changed, then use useLayoutEffectWithDeps.
- Definition Classes
- react17
- Annotations
- @inline()
- See also
https://reactjs.org/docs/hooks-reference.html#useLayoutEffect
- final def useLayoutEffectOnMount[A](effect: A)(implicit isEffectArg: UseEffectArg[A]): HookResult[Unit]
The signature is identical to useEffect, but it fires synchronously after all DOM mutations.
The signature is identical to useEffect, but it fires synchronously after all DOM mutations. Use this to read layout from the DOM and synchronously re-render. Updates scheduled inside useLayoutEffect will be flushed synchronously, before the browser has a chance to paint.
Prefer the standard useEffect when possible to avoid blocking visual updates.
This will only execute the effect when your component is mounted.
- Definition Classes
- react17
- Annotations
- @inline()
- See also
https://reactjs.org/docs/hooks-reference.html#useLayoutEffect
- final def useLayoutEffectWithDeps[D, A](deps: => D)(effect: (D) => A)(implicit arg0: Reusability[D], isEffectArg: UseEffectArg[A]): HookResult[Unit]
The signature is identical to useEffect, but it fires synchronously after all DOM mutations.
The signature is identical to useEffect, but it fires synchronously after all DOM mutations. Use this to read layout from the DOM and synchronously re-render. Updates scheduled inside useLayoutEffect will be flushed synchronously, before the browser has a chance to paint.
Prefer the standard useEffect when possible to avoid blocking visual updates.
This will only execute the effect when values in the first argument change.
- Definition Classes
- react17
- Annotations
- @inline()
- See also
https://reactjs.org/docs/hooks-reference.html#useLayoutEffect
- final def useMemo[D, A](deps: => D)(create: (D) => A)(implicit arg0: Reusability[D]): HookResult[Reusable[A]]
Returns a memoized value.
Returns a memoized value.
Pass a “create” function and any dependencies. useMemo will only recompute the memoized value when one of the dependencies has changed. This optimization helps to avoid expensive calculations on every render.
Remember that the function passed to useMemo runs during rendering. Don’t do anything there that you wouldn’t normally do while rendering. For example, side effects belong in useEffect, not useMemo.
- Definition Classes
- react17
- Annotations
- @inline()
- See also
https://reactjs.org/docs/hooks-reference.html#usememo
- final def useReducer[S, A](reducer: (S, A) => S, initialState: => S): HookResult[UseReducer[S, A]]
An alternative to useState.
An alternative to useState. Accepts a reducer of type
(state, action) => newState
, and returns the current state paired with a dispatch method. (If you’re familiar with Redux, you already know how this works.)useReducer is usually preferable to useState when you have complex state logic that involves multiple sub-values or when the next state depends on the previous one. useReducer also lets you optimize performance for components that trigger deep updates because you can pass dispatch down instead of callbacks.
- Definition Classes
- react17
- Annotations
- @inline()
- See also
https://reactjs.org/docs/hooks-reference.html#usereducer
- final def useRef[A](initialValue: => A): HookResult[UseRef[A]]
Create a mutable ref that will persist for the full lifetime of the component.
Create a mutable ref that will persist for the full lifetime of the component.
- Definition Classes
- react17
- Annotations
- @inline()
- final val useRefToAnyVdom: HookResult[ToAnyVdom]
Create a mutable ref that will persist for the full lifetime of the component.
Create a mutable ref that will persist for the full lifetime of the component.
- Definition Classes
- extra
- Annotations
- @inline()
- final def useRefToJsComponent[F[_], A[_], P1, S1, CT1[-p, +u] <: CtorType[p, u], R <: RawMounted[P0, S0], P0 <: Object, S0 <: Object, CT0[-p, +u] <: CtorType[p, u]](a: WithJsComponentArg[F, A, P1, S1, CT1, R, P0, S0]): HookResult[WithJsComponent[F, A, P1, S1, CT1, R, P0, S0]]
Create a mutable ref that will persist for the full lifetime of the component.
Create a mutable ref that will persist for the full lifetime of the component.
- Definition Classes
- extra
- Annotations
- @inline()
- final def useRefToJsComponent[P <: Object, S <: Object]: HookResult[ToJsComponent[P, S, RawMounted[P, S]]]
Create a mutable ref that will persist for the full lifetime of the component.
Create a mutable ref that will persist for the full lifetime of the component.
- Definition Classes
- extra
- Annotations
- @inline()
- final def useRefToJsComponentWithMountedFacade[P <: Object, S <: Object, F <: Object]: HookResult[ToJsComponent[P, S, RawMounted[P, S] with F]]
Create a mutable ref that will persist for the full lifetime of the component.
Create a mutable ref that will persist for the full lifetime of the component.
- Definition Classes
- extra
- Annotations
- @inline()
- final def useRefToScalaComponent[P, S, B, CT[-p, +u] <: CtorType[p, u]](c: Component[P, S, B, CT]): HookResult[WithScalaComponent[P, S, B, CT]]
Create a mutable ref that will persist for the full lifetime of the component.
Create a mutable ref that will persist for the full lifetime of the component.
- Definition Classes
- extra
- Annotations
- @inline()
- final def useRefToScalaComponent[P, S, B]: HookResult[ToScalaComponent[P, S, B]]
Create a mutable ref that will persist for the full lifetime of the component.
Create a mutable ref that will persist for the full lifetime of the component.
- Definition Classes
- extra
- Annotations
- @inline()
- final def useRefToVdom[N <: TopNode](implicit arg0: ClassTag[N]): HookResult[ToVdom[N]]
Create a mutable ref that will persist for the full lifetime of the component.
Create a mutable ref that will persist for the full lifetime of the component.
- Definition Classes
- extra
- Annotations
- @inline()
- final def useReused[D](deps: => D)(implicit arg0: Reusability[D]): HookResult[(D, Int)]
Given a reusable value, returns the original value that is being reused whenver reusability applies, together with a revisition a number that increments only when the value isn't reused.
Given a reusable value, returns the original value that is being reused whenver reusability applies, together with a revisition a number that increments only when the value isn't reused.
Useful for using
Reusability
logic in facades to JS hooks that accept dependencies: you can pass the revision as a dependency to the JS hook.- Definition Classes
- extra
- Annotations
- @inline()
- final def useState[A](initial: => A): HookResult[UseState[A]]
Returns a stateful value, and a function to update it.
Returns a stateful value, and a function to update it.
During the initial render, the returned state is the same as the value passed as the first argument (initialState).
During subsequent re-renders, the first value returned by useState will always be the most recent state after applying updates.
- Definition Classes
- react17
- Annotations
- @inline()
- final def useStateWithReuse[S](initialState: => S)(implicit arg0: ClassTag[S], arg1: Reusability[S]): HookResult[UseStateWithReuse[S]]
Returns a stateful value, and a function to update it.
Returns a stateful value, and a function to update it.
During the initial render, the returned state is the same as the value passed as the first argument (initialState).
During subsequent re-renders, the first value returned by useState will always be the most recent state after applying updates.
- Definition Classes
- extra
- Annotations
- @inline()
- final def useSyncExternalStore[F[_], A](subscribe: (F[Unit]) => F[F[Unit]], getSnapshot: F[A], getServerSnapshot: UndefOr[F[A]] = js.undefined)(implicit F: Sync[F]): HookResult[A]
Lets you subscribe to an external store.
Lets you subscribe to an external store.
- Definition Classes
- react18
- Annotations
- @inline()
- See also
- final def useTransition: HookResult[UseTransition]
Allows components to avoid undesirable loading states by waiting for content to load before transitioning to the next screen.
Allows components to avoid undesirable loading states by waiting for content to load before transitioning to the next screen. It also allows components to defer slower, data fetching updates until subsequent renders so that more crucial updates can be rendered immediately.
**If some state update causes a component to suspend, that state update should be wrapped in a transition.**
- Definition Classes
- react18
- Annotations
- @inline()
- See also
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()