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.

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 ReactNode	createElement(ComponentConstructorFunction type) Create a ReactElement for the specified React component with no props or children.
static ReactNode	createElement(ComponentConstructorFunction type, jsinterop.base.JsPropertyMap<java.lang.Object> props) Create a ReactElement for the specified React component with no children.
static ReactNode	createElement(ComponentConstructorFunction type, jsinterop.base.JsPropertyMap<java.lang.Object> props, elemental2.core.JsArray<ReactNode> children) Create a ReactElement for the specified React component.
static ReactNode	createElement(ComponentConstructorFunction type, jsinterop.base.JsPropertyMap<java.lang.Object> props, ReactNode... children) Create a ReactElement for the specified React component.
static ReactNode	createElement(ComponentConstructorFunction type, jsinterop.base.JsPropertyMap<java.lang.Object> props, ReactNode child) Create a ReactElement for the specified React component.
static ReactNode	createElement(java.lang.String type, java.lang.Object props) Create and return a new ReactElement of the given type.
static ReactNode	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(elemental2.core.JsArray<ReactNode> children) Create a Fragment with the 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

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
public static ReactNode createElement(@Nonnull
                                                 ComponentConstructorFunction type)

Create a ReactElement for the specified React component with no props or children.

Parameters:

type - the constructor function for the native React component.

Returns:

a new ReactElement.

createElement

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

Create a ReactElement for the specified React component with no children.

Parameters:

type - the constructor function for the native React component.

props - the props to pass to the component.

Returns:

a new ReactElement.

createElement

public static ReactNode createElement(@Nonnull
                                      ComponentConstructorFunction type,
                                      @Nullable
                                      jsinterop.base.JsPropertyMap<java.lang.Object> props,
                                      @Nullable
                                      ReactNode child)

Create a ReactElement for the specified React component.

Parameters:

type - the constructor function for the native React component.

props - the props to pass to the component.

child - the child of the react component.

Returns:

a new ReactElement.

createElement

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

Create a ReactElement for the specified React component.

Parameters:

type - the constructor function for the native React component.

props - the props to pass to the component.

children - the children of the react component.

Returns:

a new ReactElement.

createElement

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

Create a ReactElement for the specified React component.

Parameters:

type - the constructor function for the native React component.

props - the props to pass to the component.

children - the children of the react component.

Returns:

a new ReactElement.

createElement

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

Create and return a new ReactElement of the given type.

Parameters:

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

props - The props to pass to the element.

Returns:

the created ReactNode

createElement

@Nonnull
 @JsMethod
public static ReactNode 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 DOMElement

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
                                                  elemental2.core.JsArray<ReactNode> children)

Create a Fragment with the specified children.

Parameters:

children - the child nodes.

Returns:

a new React.Fragment object.

See Also:

createElement(ComponentConstructorFunction, JsPropertyMap, ReactNode...)

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.

See Also:

createElement(ComponentConstructorFunction, JsPropertyMap, ReactNode...)

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.

See Also:

createElement(ComponentConstructorFunction, JsPropertyMap, ReactNode...)

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