package react

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

Type Members

  1. final class AsyncCallback[A] extends AnyVal

    Pure asynchronous callback.

    Pure asynchronous callback.

    You can think of this as being similar to using Future - you can use it in for-comprehensions the same way - except AsyncCallback is pure and doesn't need an ExecutionContext.

    When combining instances, it's good to know which methods are sequential and which are parallel (or at least concurrent).

    The following methods are sequential: - >>=() / flatMap() - >>() & <<() - flatTap()

    The following methods are effectively parallel: - *>() & <*() - race() - zip() & zipWith() - AsyncCallback.traverse et al

    In order to actually run this, or get it into a shape in which in can be run, use one of the following: - toCallback <-- most common - asCallbackToFuture - asCallbackToJsPromise - unsafeToFuture() - unsafeToJsPromise()

    A good example is the [Ajax 2 demo](https://japgolly.github.io/scalajs-react/#examples/ajax-2).

    A

    The type of data asynchronously produced on success.

  2. type BackendScope[P, S] = MountedWithRoot[CallbackTo, P, S, P, S]
  3. type Callback = CallbackTo[Unit]
  4. final case class CallbackKleisli[A, B](run: (A) ⇒ CallbackTo[B]) extends AnyVal with Product with Serializable

    A => CallbackTo[B] aka Kleisli[CallbackTo, A, B] aka ReaderT[A, CallbackTo, B].

    A => CallbackTo[B] aka Kleisli[CallbackTo, A, B] aka ReaderT[A, CallbackTo, B].

    Never heard of Kleisli? Basically, a "Kleisli triple" is a function with the shape A => M[B]. In this case, the M is hard-coded to CallbackTo.

    This is hard-coded to CallbackTo for the same reasons as CallbackOption and for the same reasons that CallbackTo exists.

    Since

    1.2.0

  5. final class CallbackOption[A] extends AnyVal

    Callback that can short-circuit along the way when conditions you specify, aren't met.

    Callback that can short-circuit along the way when conditions you specify, aren't met.

    Especially useful for event handlers such as key handlers, drag-and-drop handlers, etc, where you check a condition, perform an effect, check another condition, perform another effect, etc.

    This is meant to be lightweight, and be immediately useful without the typical pain of imports, implicit conversions and extension methods then normally accompany monad transforms in Scala.

    For a more generic (i.e. beyond Option) or comprehensive monad transformer use Scalaz or similar.

  6. final class CallbackTo[A] extends AnyVal

    A function to be executed later, usually by scalajs-react in response to some kind of event.

    A function to be executed later, usually by scalajs-react in response to some kind of event.

    The purpose of this class is to lift effects into the type system, and use the compiler to ensure safety around callbacks (without depending on an external library like Scalaz).

    () => Unit is replaced by Callback. Similarly, ReactEvent => Unit is replaced by ReactEvent => Callback.

    A

    The type of result produced when the callback is invoked.

    Since

    0.10.0

  7. sealed trait Children extends AnyRef

    Describes how a component uses .props.children.

  8. sealed trait ComponentDom extends AnyRef
  9. sealed abstract class CtorType[-P, +U] extends AnyRef
  10. type GenericComponent[P, CT[-p, +u] <: CtorType[p, u], U] = ComponentSimple[P, CT, U]
  11. type JsComponent[P <: Object, S <: Object, CT[-p, +u] <: CtorType[p, u]] = react.component.Js.ComponentWithRoot[P, CT, UnmountedWithRawType[P, S, RawMounted[P, S]], P, CT, UnmountedWithRawType[P, S, RawMounted[P, S]]]
  12. type JsComponentWithFacade[P <: Object, S <: Object, F <: Object, CT[-p, +u] <: CtorType[p, u]] = react.component.Js.ComponentWithRoot[P, CT, UnmountedWithRawType[P, S, RawMounted[P, S] with F], P, CT, UnmountedWithRawType[P, S, RawMounted[P, S] with F]]
  13. type JsFnComponent[P <: Object, CT[-p, +u] <: CtorType[p, u]] = react.component.JsFn.ComponentWithRoot[P, CT, Unmounted[P], P, CT, Unmounted[P]]
  14. type JsForwardRefComponent[P <: Object, R, CT[-p, +u] <: CtorType[p, u]] = ComponentWithRoot[P, R, CT, Unmounted[P, R], P, CT, Unmounted[P, R]]
  15. type Key = |[String, JsNumber]
  16. final class ModStateFn[F[_], S] extends AbstractFunction2[(S) ⇒ Option[S], Callback, F[Unit]] with ModState[F, S]
  17. type ModStateFnImpure[S] = ModStateFn[Id, S]
  18. type ModStateFnPure[S] = ModStateFn[CallbackTo, S]
  19. final class ModStateWithPropsFn[F[_], P, S] extends AbstractFunction2[(S, P) ⇒ Option[S], Callback, F[Unit]] with ModStateWithProps[F, P, S]
  20. type ModStateWithPropsFnImpure[P, S] = ModStateWithPropsFn[Id, P, S]
  21. type ModStateWithPropsFnPure[P, S] = ModStateWithPropsFn[CallbackTo, P, S]
  22. final class PropsChildren extends AnyVal
  23. final type ReactAnimationEvent = SyntheticAnimationEvent[Node]
    Definition Classes
    ReactEventTypes
  24. final type ReactAnimationEventFrom[+N <: Node] = SyntheticAnimationEvent[N]
    Definition Classes
    ReactEventTypes
  25. final type ReactAnimationEventFromHtml = SyntheticAnimationEvent[Element]
    Definition Classes
    ReactEventTypes
  26. final type ReactAnimationEventFromInput = SyntheticAnimationEvent[Input]
    Definition Classes
    ReactEventTypes
  27. final type ReactAnimationEventFromTextArea = SyntheticAnimationEvent[TextArea]
    Definition Classes
    ReactEventTypes
  28. final case class ReactCaughtError(rawError: Any, rawInfo: ErrorInfo) extends Product with Serializable

    The data captured by React when it catches an error for the componentDidCatch event.

    The data captured by React when it catches an error for the componentDidCatch event.

    rawError

    The JS error. Usually a js.Error. If you threw an error using throw js.JavaScriptException("OMG") then is value is just the argument "OMG".

    Since

    1.6.0

  29. final type ReactClipboardEvent = SyntheticClipboardEvent[Node]
    Definition Classes
    ReactEventTypes
  30. final type ReactClipboardEventFrom[+N <: Node] = SyntheticClipboardEvent[N]
    Definition Classes
    ReactEventTypes
  31. final type ReactClipboardEventFromHtml = SyntheticClipboardEvent[Element]
    Definition Classes
    ReactEventTypes
  32. final type ReactClipboardEventFromInput = SyntheticClipboardEvent[Input]
    Definition Classes
    ReactEventTypes
  33. final type ReactClipboardEventFromTextArea = SyntheticClipboardEvent[TextArea]
    Definition Classes
    ReactEventTypes
  34. final type ReactCompositionEvent = SyntheticCompositionEvent[Node]
    Definition Classes
    ReactEventTypes
  35. final type ReactCompositionEventFrom[+N <: Node] = SyntheticCompositionEvent[N]
    Definition Classes
    ReactEventTypes
  36. final type ReactCompositionEventFromHtml = SyntheticCompositionEvent[Element]
    Definition Classes
    ReactEventTypes
  37. final type ReactCompositionEventFromInput = SyntheticCompositionEvent[Input]
    Definition Classes
    ReactEventTypes
  38. final type ReactCompositionEventFromTextArea = SyntheticCompositionEvent[TextArea]
    Definition Classes
    ReactEventTypes
  39. final type ReactDragEvent = SyntheticDragEvent[Node]
    Definition Classes
    ReactEventTypes
  40. final type ReactDragEventFrom[+N <: Node] = SyntheticDragEvent[N]
    Definition Classes
    ReactEventTypes
  41. final type ReactDragEventFromHtml = SyntheticDragEvent[Element]
    Definition Classes
    ReactEventTypes
  42. final type ReactDragEventFromInput = SyntheticDragEvent[Input]
    Definition Classes
    ReactEventTypes
  43. final type ReactDragEventFromTextArea = SyntheticDragEvent[TextArea]
    Definition Classes
    ReactEventTypes
  44. final type ReactEvent = SyntheticEvent[Node]
    Definition Classes
    ReactEventTypes
  45. final type ReactEventFrom[+N <: Node] = SyntheticEvent[N]
    Definition Classes
    ReactEventTypes
  46. final type ReactEventFromHtml = SyntheticEvent[Element]
    Definition Classes
    ReactEventTypes
  47. final type ReactEventFromInput = SyntheticEvent[Input]
    Definition Classes
    ReactEventTypes
  48. final type ReactEventFromTextArea = SyntheticEvent[TextArea]
    Definition Classes
    ReactEventTypes
  49. trait ReactEventTypes extends AnyRef
  50. final class ReactExt_DomEvent extends AnyVal
  51. implicit final class ReactExt_DomNode extends AnyVal

    Extensions to plain old DOM.

    Extensions to plain old DOM.

    Annotations
    @inline()
  52. implicit final class ReactExt_OptionCallback extends AnyVal
    Annotations
    @inline()
  53. final class ReactExt_ReactEvent[E <: ReactEvent] extends AnyVal
  54. final class ReactExt_ReactKeyboardEvent[N <: Node] extends AnyVal
  55. implicit final class ReactExt_ScalaComponent[P, S, B, CT[-p, +u] <: CtorType[p, u]] extends AnyVal
  56. implicit final class ReactExtrasExt_Any[A] extends AnyVal
  57. final type ReactFocusEvent = SyntheticFocusEvent[Node]
    Definition Classes
    ReactEventTypes
  58. final type ReactFocusEventFrom[+N <: Node] = SyntheticFocusEvent[N]
    Definition Classes
    ReactEventTypes
  59. final type ReactFocusEventFromHtml = SyntheticFocusEvent[Element]
    Definition Classes
    ReactEventTypes
  60. final type ReactFocusEventFromInput = SyntheticFocusEvent[Input]
    Definition Classes
    ReactEventTypes
  61. final type ReactFocusEventFromTextArea = SyntheticFocusEvent[TextArea]
    Definition Classes
    ReactEventTypes
  62. final type ReactFormEvent = SyntheticFormEvent[Node]
    Definition Classes
    ReactEventTypes
  63. final type ReactFormEventFrom[+N <: Node] = SyntheticFormEvent[N]
    Definition Classes
    ReactEventTypes
  64. final type ReactFormEventFromHtml = SyntheticFormEvent[Element]
    Definition Classes
    ReactEventTypes
  65. final type ReactFormEventFromInput = SyntheticFormEvent[Input]
    Definition Classes
    ReactEventTypes
  66. final type ReactFormEventFromTextArea = SyntheticFormEvent[TextArea]
    Definition Classes
    ReactEventTypes
  67. final type ReactKeyboardEvent = SyntheticKeyboardEvent[Node]
    Definition Classes
    ReactEventTypes
  68. final type ReactKeyboardEventFrom[+N <: Node] = SyntheticKeyboardEvent[N]
    Definition Classes
    ReactEventTypes
  69. final type ReactKeyboardEventFromHtml = SyntheticKeyboardEvent[Element]
    Definition Classes
    ReactEventTypes
  70. final type ReactKeyboardEventFromInput = SyntheticKeyboardEvent[Input]
    Definition Classes
    ReactEventTypes
  71. final type ReactKeyboardEventFromTextArea = SyntheticKeyboardEvent[TextArea]
    Definition Classes
    ReactEventTypes
  72. final type ReactMouseEvent = SyntheticMouseEvent[Node]
    Definition Classes
    ReactEventTypes
  73. final type ReactMouseEventFrom[+N <: Node] = SyntheticMouseEvent[N]
    Definition Classes
    ReactEventTypes
  74. final type ReactMouseEventFromHtml = SyntheticMouseEvent[Element]
    Definition Classes
    ReactEventTypes
  75. final type ReactMouseEventFromInput = SyntheticMouseEvent[Input]
    Definition Classes
    ReactEventTypes
  76. final type ReactMouseEventFromTextArea = SyntheticMouseEvent[TextArea]
    Definition Classes
    ReactEventTypes
  77. final type ReactPointerEvent = SyntheticPointerEvent[Node]
    Definition Classes
    ReactEventTypes
  78. final type ReactPointerEventFrom[+N <: Node] = SyntheticPointerEvent[N]
    Definition Classes
    ReactEventTypes
  79. final type ReactPointerEventFromHtml = SyntheticPointerEvent[Element]
    Definition Classes
    ReactEventTypes
  80. final type ReactPointerEventFromInput = SyntheticPointerEvent[Input]
    Definition Classes
    ReactEventTypes
  81. final type ReactPointerEventFromTextArea = SyntheticPointerEvent[TextArea]
    Definition Classes
    ReactEventTypes
  82. final type ReactTouchEvent = SyntheticTouchEvent[Node]
    Definition Classes
    ReactEventTypes
  83. final type ReactTouchEventFrom[+N <: Node] = SyntheticTouchEvent[N]
    Definition Classes
    ReactEventTypes
  84. final type ReactTouchEventFromHtml = SyntheticTouchEvent[Element]
    Definition Classes
    ReactEventTypes
  85. final type ReactTouchEventFromInput = SyntheticTouchEvent[Input]
    Definition Classes
    ReactEventTypes
  86. final type ReactTouchEventFromTextArea = SyntheticTouchEvent[TextArea]
    Definition Classes
    ReactEventTypes
  87. final type ReactTransitionEvent = SyntheticTransitionEvent[Node]
    Definition Classes
    ReactEventTypes
  88. final type ReactTransitionEventFrom[+N <: Node] = SyntheticTransitionEvent[N]
    Definition Classes
    ReactEventTypes
  89. final type ReactTransitionEventFromHtml = SyntheticTransitionEvent[Element]
    Definition Classes
    ReactEventTypes
  90. final type ReactTransitionEventFromInput = SyntheticTransitionEvent[Input]
    Definition Classes
    ReactEventTypes
  91. final type ReactTransitionEventFromTextArea = SyntheticTransitionEvent[TextArea]
    Definition Classes
    ReactEventTypes
  92. final type ReactUIEvent = SyntheticUIEvent[Node]
    Definition Classes
    ReactEventTypes
  93. final type ReactUIEventFrom[+N <: Node] = SyntheticUIEvent[N]
    Definition Classes
    ReactEventTypes
  94. final type ReactUIEventFromHtml = SyntheticUIEvent[Element]
    Definition Classes
    ReactEventTypes
  95. final type ReactUIEventFromInput = SyntheticUIEvent[Input]
    Definition Classes
    ReactEventTypes
  96. final type ReactUIEventFromTextArea = SyntheticUIEvent[TextArea]
    Definition Classes
    ReactEventTypes
  97. final type ReactWheelEvent = SyntheticWheelEvent[Node]
    Definition Classes
    ReactEventTypes
  98. final type ReactWheelEventFrom[+N <: Node] = SyntheticWheelEvent[N]
    Definition Classes
    ReactEventTypes
  99. final type ReactWheelEventFromHtml = SyntheticWheelEvent[Element]
    Definition Classes
    ReactEventTypes
  100. final type ReactWheelEventFromInput = SyntheticWheelEvent[Input]
    Definition Classes
    ReactEventTypes
  101. final type ReactWheelEventFromTextArea = SyntheticWheelEvent[TextArea]
    Definition Classes
    ReactEventTypes
  102. final class Reusability[A] extends AnyVal

    Tests whether one instance can be used in place of another.

    Tests whether one instance can be used in place of another. Used mostly to compare properties and state of a component to avoid unnecessary updates.

    If you imagine a class with 8 fields, equality would compare all 8 fields where as this would typically just compare the ID field, the update-date, or the revision number. You might think of this as a very quick version of equality.

    Don't miss Reusability.shouldComponentUpdate which can be applied to a component via ScalaComponent.build#configure.

    Since

    0.9.0

  103. final class Reusable[+A] extends AnyRef

    A value that has been explicitly paired with a (potentially ad-hoc) Reusability instance.

    A value that has been explicitly paired with a (potentially ad-hoc) Reusability instance.

    A

    The type of value.

    Since

    1.0.0

  104. type ScalaComponent[P, S, B, CT[-p, +u] <: CtorType[p, u]] = react.component.Js.ComponentWithRoot[P, CT, Unmounted[P, S, B], Box[P], CT, JsUnmounted[P, S, B]]
  105. type ScalaFnComponent[P, CT[-p, +u] <: CtorType[p, u]] = react.component.JsFn.ComponentWithRoot[P, CT, Unmounted[P], Box[P], CT, Unmounted[Box[P]]]
  106. type ScalaForwardRefComponent[P, R, CT[-p, +u] <: CtorType[p, u]] = ComponentWithRoot[P, R, CT, Unmounted[P, R], Box[P], CT, Unmounted[Box[P], R]]
  107. trait ScalaVersionSpecificReusability extends AnyRef

    Reusability specific to Scala 2.12

  108. final class SetStateFn[F[_], S] extends AbstractFunction2[Option[S], Callback, F[Unit]] with SetState[F, S]
  109. type SetStateFnImpure[S] = SetStateFn[Id, S]
  110. type SetStateFnPure[S] = SetStateFn[CallbackTo, S]
  111. trait StateAccess[F[_], S] extends Write[F, S]

    Base class for something that has read/write state access (under the same effect type).

    Base class for something that has read/write state access (under the same effect type).

    Passing this around (top-level) is fine but do not use it in a generic/library/helper method. In intermediary positions, use StateAccessor instead.

    F

    The type of effect when accessing state.

    S

    State type.

  112. type StateAccessImpure[S] = StateAccess[Id, S]
  113. type StateAccessPure[S] = StateAccess[CallbackTo, S]
  114. trait StateAccessorImplicits extends StateAccessorImplicits1
  115. trait StateAccessorImplicits1 extends StateAccessorImplicits2
  116. trait StateAccessorImplicits2 extends AnyRef
  117. sealed trait UpdateSnapshot extends AnyRef
  118. type ~=>[-A, +B] = Reusable[(A) ⇒ B]

Value Members

  1. val GenericComponent: Generic.type
  2. val JsComponent: Js.type
  3. val JsFnComponent: JsFn.type
  4. val JsForwardRefComponent: JsForwardRef.type
  5. val ScalaComponent: Scala.type
  6. val ScalaFnComponent: ScalaFn.type
  7. val ScalaForwardRefComponent: ScalaForwardRef.type
  8. val preventDefault: (ReactEvent) ⇒ Callback
  9. val preventDefaultAndStopPropagation: (ReactEvent) ⇒ Callback
  10. implicit def scalajsReactRawPropsChildrenToJsUndef(r: react.raw.PropsChildren): UndefOr[react.raw.PropsChildren]
    Annotations
    @inline()
  11. val stopPropagation: (ReactEvent) ⇒ Callback
  12. implicit def toReactExt_DomEvent(e: Event): ReactExt_DomEvent
    Definition Classes
    ReactEventTypes
  13. implicit def toReactExt_ReactEvent[E <: ReactEvent](e: E): ReactExt_ReactEvent[E]
    Definition Classes
    ReactEventTypes
  14. implicit def toReactExt_ReactKeyboardEvent[N <: Node](e: ReactKeyboardEventFrom[N]): ReactExt_ReactKeyboardEvent[N]
    Definition Classes
    ReactEventTypes
  15. object AsyncCallback
  16. object Callback

    A callback with no return value.

    A callback with no return value. Equivalent to () => Unit.

    See also

    CallbackTo

  17. object CallbackKleisli extends Serializable
  18. object CallbackOption
  19. object CallbackTo
  20. object Children
  21. object ComponentDom
  22. object CtorType
  23. object ModStateFn
  24. object ModStateWithPropsFn
  25. object PropsChildren
  26. object React
  27. object ReactDOM
  28. object ReactDOMServer
  29. object ReactMouseEvent
  30. object Ref
  31. object Reusability extends ScalaVersionSpecificReusability
  32. object Reusable
  33. object ScalaJsReactConfig

    Global scalajs-react config.

    Global scalajs-react config.

    It's a little horrible in that we're using global variables *and* you need to configure them in your main method *before* any data/components are loaded that these settings. But it's a decent trade-off in this case.

  34. object SetStateFn
  35. object StateAccess
  36. object StateAccessor extends StateAccessorImplicits

    Type-classes that provide read and/or write access to state.

    Type-classes that provide read and/or write access to state.

    The syntax is a little wonky for technical reasons. For read access, it's typeclass.state(i): F[S]. For write access, it's typeclass(i).setState(...): F[Unit].

  37. object UpdateSnapshot

Inherited from ReactEventTypes

Inherited from AnyRef

Inherited from Any

Ungrouped