react4j

Class React

java.lang.Object

react4j.React

@JsType(isNative=true,
        namespace="<global>")
public final class React
extends java.lang.Object

Native interface to native runtime for creating component.

Field Summary

Fields

Modifier and Type	Field and Description
static ComponentConstructorFunction	ConcurrentMode The Symbol type for ConcurrentMode.
static ComponentConstructorFunction	Consumer The Symbol type for Consumer.
static ComponentConstructorFunction	Element The Symbol type for Element.
static ComponentConstructorFunction	ForwardRef The Symbol type for ForwardRef.
static ComponentConstructorFunction	Fragment The Symbol type for Fragments.
static ComponentConstructorFunction	Lazy The Symbol type for Lazy.
static ComponentConstructorFunction	Memo The Symbol type for Memo.
static ComponentConstructorFunction	Portal The Symbol type for Portal.
static ComponentConstructorFunction	Profiler The Symbol type for Profiler.
static ComponentConstructorFunction	Provider The Symbol type for Provider.
static ComponentConstructorFunction	StrictMode The Symbol type for StrictMode.
static ComponentConstructorFunction	Suspense The Symbol type for Suspense.

Method Summary

Modifier and Type	Method and Description
static ReactNode	cloneElement(ReactNode element, jsinterop.base.JsPropertyMap<java.lang.Object> props) Clone and return a new ReactElement using element as the starting point.
static <T> Context<T>	createContext(T defaultValue) Creates a context with specified default value.
static ReactElement	createElement(java.lang.String type, jsinterop.base.JsPropertyMap<java.lang.Object> props) Create and return a new ReactElement of the given type with no children.
static ReactElement	createElement(java.lang.String type, jsinterop.base.JsPropertyMap<java.lang.Object> props, elemental2.core.JsArray<ReactNode> children) Create and return a new ReactElement of the given type with specified children.
static ReactElement	createElement(java.lang.String type, jsinterop.base.JsPropertyMap<java.lang.Object> props, ReactNode... children) Create and return a new ReactElement of the given type with specified children.
static ReactElement	createElement(java.lang.String type, java.lang.Object props) Create and return a new ReactElement of the given type with specified children.
static ReactElement	createElement(java.lang.String type, java.lang.Object props, ReactNode... children) Create and return a new ReactElement of the given type with specified children.
static ReactNode	createFragment(java.util.List<? extends ReactNode> children) Create a Fragment with the specified children.
static ReactNode	createFragment(ReactNode... children) Create a Fragment with the specified children.
static ReactNode	createFragment(java.util.stream.Stream<? extends ReactNode> children) Create a Fragment with the specified children.
static ReactNode	createStrictMode(ReactNode... children) Create a StrictMode component with the specified children.
static boolean	isValidElement(ReactNode node) Return true if the specified node is a ReactElement.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

Fragment

@JsProperty(name="Fragment")
public static ComponentConstructorFunction Fragment

The Symbol type for Fragments.

StrictMode

@JsProperty(name="StrictMode")
public static ComponentConstructorFunction StrictMode

The Symbol type for StrictMode.

ConcurrentMode

@JsProperty(name="unstable_ConcurrentMode")
public static ComponentConstructorFunction ConcurrentMode

The Symbol type for ConcurrentMode.

Suspense

@JsProperty(name="Suspense")
public static ComponentConstructorFunction Suspense

The Symbol type for Suspense.

Profiler

@JsProperty(name="unstable_Profiler")
public static ComponentConstructorFunction Profiler

The Symbol type for Profiler.

Portal

@JsProperty(name="Portal")
public static ComponentConstructorFunction Portal

The Symbol type for Portal.

Element

@JsProperty(name="Element")
public static ComponentConstructorFunction Element

The Symbol type for Element.

Provider

@JsProperty(name="Provider")
public static ComponentConstructorFunction Provider

The Symbol type for Provider.

Consumer

@JsProperty(name="Consumer")
public static ComponentConstructorFunction Consumer

The Symbol type for Consumer.

ForwardRef

@JsProperty(name="ForwardRef")
public static ComponentConstructorFunction ForwardRef

The Symbol type for ForwardRef.

Memo

@JsProperty(name="Memo")
public static ComponentConstructorFunction Memo

The Symbol type for Memo.

Lazy

@JsProperty(name="Lazy")
public static ComponentConstructorFunction Lazy

The Symbol type for Lazy.

Method Detail

isValidElement

public static boolean isValidElement(@Nonnull
                                     ReactNode node)

Return true if the specified node is a ReactElement.

Parameters:

node - the node to test.

Returns:

true if the specified node is a ReactElement.

createElement

@JsOverlay
 @Nonnull
public static ReactElement createElement(@Nonnull
                                                              java.lang.String type,
                                                              @Nullable
                                                              java.lang.Object props)

Create and return a new ReactElement of the given type with specified children.

Parameters:

type - A HTML tag name (eg. 'div', 'span', etc)

props - The props to pass to the element.

Returns:

the created ReactElement

createElement

@JsOverlay
 @Nonnull
public static ReactElement createElement(@Nonnull
                                                              java.lang.String type,
                                                              @Nullable
                                                              jsinterop.base.JsPropertyMap<java.lang.Object> props)

Create and return a new ReactElement of the given type with no children.

Parameters:

type - A HTML tag name (eg. 'div', 'span', etc)

props - The props to pass to the element.

Returns:

the created ReactElement

createElement

@JsOverlay
 @Nonnull
public static ReactElement createElement(@Nonnull
                                                              java.lang.String type,
                                                              @Nullable
                                                              java.lang.Object props,
                                                              @Nullable
                                                              ReactNode... children)

Create and return a new ReactElement of the given type with specified children.

Parameters:

type - A HTML tag name (eg. 'div', 'span', etc)

props - The props to pass to the element.

children - The child elements.

Returns:

the created ReactElement

createElement

@JsOverlay
 @Nonnull
public static ReactElement createElement(@Nonnull
                                                              java.lang.String type,
                                                              @Nullable
                                                              jsinterop.base.JsPropertyMap<java.lang.Object> props,
                                                              @Nullable
                                                              ReactNode... children)

Create and return a new ReactElement of the given type with specified children.

Parameters:

type - A HTML tag name (eg. 'div', 'span', etc)

props - The props to pass to the element.

children - The child elements.

Returns:

the created ReactElement

createElement

@JsOverlay
 @Nonnull
public static ReactElement createElement(@Nonnull
                                                              java.lang.String type,
                                                              @Nullable
                                                              jsinterop.base.JsPropertyMap<java.lang.Object> props,
                                                              @Nullable
                                                              elemental2.core.JsArray<ReactNode> children)

Create and return a new ReactElement of the given type with specified children.

Parameters:

type - A HTML tag name (eg. 'div', 'span', etc)

props - The props to pass to the element.

children - The child elements.

Returns:

the created ReactElement

createStrictMode

@JsOverlay
public static ReactNode createStrictMode(@Nonnull
                                                    ReactNode... children)

Create a StrictMode component with the specified children.

Parameters:

children - the child nodes.

Returns:

a new React.Fragment object.

createFragment

@JsOverlay
public static ReactNode createFragment(@Nonnull
                                                  ReactNode... children)

Create a Fragment with the specified children.

Parameters:

children - the child nodes.

Returns:

a new React.Fragment object.

createFragment

@JsOverlay
public static ReactNode createFragment(@Nonnull
                                                  java.util.List<? extends ReactNode> children)

Create a Fragment with the specified children.

Parameters:

children - the child nodes.

Returns:

a new React.Fragment object.

createFragment

@JsOverlay
public static ReactNode createFragment(@Nonnull
                                                  java.util.stream.Stream<? extends ReactNode> children)

Create a Fragment with the specified children.

Parameters:

children - the child nodes.

Returns:

a new React.Fragment object.

createContext

@Nonnull
public static <T> Context<T> createContext(T defaultValue)

Creates a context with specified default value.

Type Parameters:

T - the type of the context.

Parameters:

defaultValue - the default value.

Returns:

the context.

cloneElement

@JsOverlay
public static ReactNode cloneElement(@Nonnull
                                                ReactNode element,
                                                @Nullable
                                                jsinterop.base.JsPropertyMap<java.lang.Object> props)

Clone and return a new ReactElement using element as the starting point. The resulting element will have the original element's props with the new props merged in shallowly. New children will replace existing children. Unlike React.addons.cloneWithProps, key and ref from the original element will be preserved. There is no special behavior for merging any props (unlike cloneWithProps).

Parameters:

element - the element to clone

props - the props to merge

Returns:

the cloned element