Trait/Object

japgolly.scalajs.react.feature

Context

Related Docs: object Context | package feature

Permalink

sealed trait Context[A] extends AnyRef

React Context.

See https://reactjs.org/docs/context.html

Self Type
Context[A]
Since

1.3.0 / React 16.3.0

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Context
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. type RawValue = J

    Permalink

    The raw JS type that React sees.

Abstract Value Members

  1. abstract val jsRepr: JsRepr[A]

    Permalink

    Scala values are converted to JS values and back using this.

  2. abstract val raw: raw.React.Context[RawValue]

    Permalink

    The underlying JS React.Context.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. def consume(f: (A) ⇒ VdomNode): VdomElement

    Permalink

    Subscribes to context changes.

    Subscribes to context changes.

    The value argument passed to the function will be equal to the value prop of the closest Provider for this context above in the tree. If there is no Provider for this context above, the value argument will be equal to the defaultValue that was passed to createContext().

    All Consumers that are descendants of a Provider will re-render whenever the Provider’s value prop changes. The propagation from Provider to its descendant Consumers is not subject to the shouldComponentUpdate method, so the Consumer is updated even when an ancestor component bails out of the update.

    Changes are determined by comparing the new and old values using referential equality.

  7. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  11. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  12. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  14. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  15. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  16. def provide(value: A): Provided[A]

    Permalink

    Allows Consumers to subscribe to context changes.

    Allows Consumers to subscribe to context changes. Accepts a value prop to be passed to Consumers that are descendants of this Provider. One Provider can be connected to many Consumers. Providers can be nested to override values deeper within the tree.

    Caveat:

    The React Context API uses Object.is to determine equality (see https://reactjs.org/docs/context.html#caveats). This affects

    scalajs-react will use plain JS values without translation where possible (eg. booleans, ints, strings) in which case, universal equality is used by React (eg. true == true, 123 == 123, "hello" == "hello"). For these types of contexts, feel free to call context.provide(value)(children) the same way you would in React JS.

    Non-JS values (eg. case classes) are boxed into JS objects in which case, React will use referential equality meaning that you need to hold on to and reuse the boxed instance. Seeing as you're not doing the boxing yourself, what you should hold on to and reuse is the result of .provide() before you apply children. For example, instead of:

    class Backend {
      def render(p: Props) =
        context.provide(X(...))(<.div("hello"))
    }

    you should save and reuse the provide result:

    class Backend {
      private val contextX = context.provide(X(...))
    
      def render(p: Props) =
        contextX(<.div("hello"))
    }

    Doing so will keep React happy and avoid needless re-renders.

  17. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  18. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  19. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped