Package io.github.cdklabs.projen.web

Class ReactComponent.Builder

java.lang.Object

io.github.cdklabs.projen.web.ReactComponent.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<ReactComponent>

Enclosing class:

ReactComponent

@Stability(Experimental)
public static final class ReactComponent.Builder
extends Object
implements software.amazon.jsii.Builder<ReactComponent>

(experimental) A fluent builder for ReactComponent.

Method Summary

Modifier and Type	Method	Description
ReactComponent	build()
static ReactComponent.Builder	create(NodeProject project)
ReactComponent.Builder	rewire(Map<String,? extends Object> rewire)	(experimental) Rewire webpack configuration.
ReactComponent.Builder	typescript(Boolean typescript)	(experimental) Whether to apply options specific for TypeScript React projects.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(Experimental)
public static ReactComponent.Builder create(NodeProject project)

Parameters:

project - This parameter is required.

Returns:

a new instance of ReactComponent.Builder.

rewire

@Stability(Experimental)
public ReactComponent.Builder rewire(Map<String,? extends Object> rewire)

(experimental) Rewire webpack configuration.

Use this property to override webpack configuration properties provided by create-react-app, without needing to eject.

This property will create a config-overrides.js file in your root directory, which will contain the desired rewiring code.

To override the configuration, you can provide simple key value pairs. Keys take the form of js code directives that traverse to the desired property. Values should be JSON serializable objects.

For example, the following config:

 rewire: { "module.unknownContextCritical": false }
 

Will translate to the following config-overrides.js file:

 module.exports = function override(config, env) {
   config.module.unknownContextCritical = false;
 }
 

Default: - No rewired config.

Parameters:

rewire - Rewire webpack configuration. This parameter is required.

Returns:

this

See Also:

https://github.com/timarney/react-app-rewired

typescript

@Stability(Experimental)
public ReactComponent.Builder typescript(Boolean typescript)

(experimental) Whether to apply options specific for TypeScript React projects.

Default: false

Parameters:

typescript - Whether to apply options specific for TypeScript React projects. This parameter is required.

Returns:

this

build

@Stability(Experimental)
public ReactComponent build()

Specified by:

build in interface software.amazon.jsii.Builder<ReactComponent>

Returns:

a newly built instance of ReactComponent.