ReactInstanceSettings
Provides configuration of the react instance.
Reference
Properties
PackageProviders
IVector<IReactPackageProvider> PackageProviders { get; }
Provides a list of additional NativeModules and custom ViewManagers that should be included in the instance.
Properties
IReactPropertyBag Properties { get; }
Properties are shared with IReactContext.Properties. It can be used to configure and share values and state between components.
Notifications
IReactNotificationService Notifications { get; }
Provides access to the IReactNotificationService, which allows easy communication between custom NativeModules or ViewManagers.
UseDeveloperSupport
bool UseDeveloperSupport { get; set; }
This controls whether various developer experience features are available for this instance. In particular the developer menu, the default RedBox and LogBox experience and loading UI during bundle load.
JavaScriptBundleFile
string JavaScriptBundleFile { get; set; }
The name of the JavaScript bundle file to load. This defaults to index.windows. This should be a relative path from BundleRootPath. .bundle will be appended to the end, when looking for the bundle file.
JavaScriptMainModuleName
string JavaScriptMainModuleName { get; set; }
Name of the JavaScript bundle file. If JavaScriptBundleFile is specified it is used instead.
UseWebDebugger
bool UseWebDebugger { get; set; }
Should the instance run in a remote environment such as within a browser. By default, this is using a browser navigated to http://localhost:8081/debugger-ui served by Metro/Haul. Debugging will start as soon as the react native instance is loaded.
UseFastRefresh
bool UseFastRefresh { get; set; }
Should the instance trigger the hot module reload logic when it first loads the instance. Most edits should be visible within a second or two without the instance having to reload. Non-compatible changes still cause full reloads. See Fast Refresh for more information on Fast Refresh.
UseLiveReload
bool UseLiveReload { get; set; }
Enable live reload to load the source bundle from the React Native packager. When the file is saved, the packager will trigger reloading. For general use this has been replaced by UseFastRefresh.
UseDirectDebugger
bool UseDirectDebugger { get; set; }
Enables debugging in the JavaScript engine (if supported).
For Chakra this enables you to debug the JS runtime directly within your app using VisualStudio -> Attach to process (Script)
DebuggerBreakOnNextLine
bool DebuggerBreakOnNextLine { get; set; }
For direct debugging, whether to break on the next line of JavaScript that is executed. This can help debug issues hit early in the JavaScript bundle load.
Note: this is not supported with the Chakra JS engine which is the currently used JavaScript engine
UseJsi
bool UseJsi { get; set; }
This controls if the JavaScript bridge should use the newer JSI runtime or use the legacy executor. The JSI runtime is used by default, and the legacy executor will be removed in a future release. It is not recommended to change this setting.
EnableJITCompilation
bool EnableJITCompilation { get; set; }
default: true
Flag controlling whether the JavaScript engine uses JIT compilation.
EnableByteCodeCaching
bool EnableByteCodeCaching { get; set; }
default: false
For JS engines that support bytecode generation, this controls if bytecode should be generated when a JavaScript bundle is first loaded. Subsequent runs of the application should be faster as the JavaScript will be loaded from bytecode instead of the raw JavaScript. ByteCodeFileUri must be set to a location the application has write access to in order for the bytecode to be successfully cached.
EnableDeveloperMenu
bool EnableDeveloperMenu { get; set; }
This controls whether various developer experience features are available for this instance. In particular the developer menu, the default RedBox experience and the loading UI during bundle load.
This property will be removed in a future version of react-native-windows
This property has been replaced by UseDeveloperSupport. In the 0.63 both properties will do the same thing.
ByteCodeFileUri
string ByteCodeFileUri { get; set; }
Set this to a location the application has write access to in order for bytecode to be successfully cached. See EnableByteCodeCaching.
SourceBundleHost
string SourceBundleHost { get; set; }
default: localhost
When using a UseFastRefresh, UseLiveReload or UseWebDebugger this is the server hostname that will be used to load the bundle from.
SourceBundlePort
ushort SourceBundlePort { get; set; }
default: 8081
When using a UseFastRefresh, UseLiveReload or UseWebDebugger this is the server port that will be used to load the bundle from.
DebugHost
string DebugHost { get; set; }
default: localhost:8081
When using a UseFastRefresh, UseLiveReload or UseWebDebugger this is the server that will be used to load the bundle from.
This has been replaced with SourceBundleHost and SourceBundlePort and will be removed in a future version.
DebugBundlePath
string DebugBundlePath { get; set; }
When loading from a bundle server (such as metro), this is the path that will be requested from the server. If this is not provided the value of JavaScriptBundleFile or JavaScriptMainModuleName is used.
BundleRootPath
string BundleRootPath { get; set; }
Base path used for the location of the bundle. If not specified then ms-appx:///Bundle/ will be used as the base path.
DebuggerPort
ushort DebuggerPort { get; set; }
default: 9229
When UseDirectDebugger is enabled, this controls the port that the JavaScript engine debugger will run on.
RedBoxHandler
IRedBoxHandler RedBoxHandler { get; set; }
Provides an extension point to allow custom error handling within the react instance. See IRedBoxHandler for more information.
UIDispatcher
IReactDispatcher UIDispatcher { get; set; }
Control the main UIDispatcher to be used by the React Instance. If the ReactSettingsInstance object is initially created on a UI thread, then this will default to that thread. The value provided here will be available to NativeModules and ViewManagers using IReactContext.UIDispatcher