diff --git a/website/.unbroken_exclusions b/website/.unbroken_exclusions index 126956ca8..1140483ba 100644 --- a/website/.unbroken_exclusions +++ b/website/.unbroken_exclusions @@ -2,8 +2,123 @@ !blog/2019-* !blog/2020-* !versioned_docs/version-0.63/*-api-windows*.md +!versioned_docs/version-0.64/*-api-windows*.md + +# See Issue 410 +File not found IReactContext while parsing versioned_docs/version-0.64/native-modules-advanced.md +File not found ReactNativeHost while parsing versioned_docs/version-0.64/native-modules-advanced.md #fix-unbroken.js auto-generated do not edit this line or below +File not found rnw-dependencies.md while parsing versioned_docs/version-0.64/building-rnw.md +File not found rnw-dependencies.md while parsing versioned_docs/version-0.64/building-rnw.md +File not found rnw-dependencies.md while parsing versioned_docs/version-0.64/building-rnw.md +File not found rnw-dependencies.md while parsing versioned_docs/version-0.64/building-rnw.md +File not found native-modules.md while parsing versioned_docs/version-0.64/getting-started.md +File not found rnw-dependencies.md while parsing versioned_docs/version-0.64/getting-started.md +File not found native-modules.md while parsing versioned_docs/version-0.64/getting-started.md +File not found rnw-dependencies.md while parsing versioned_docs/version-0.64/getting-started.md +File not found native-modules.md while parsing versioned_docs/version-0.64/getting-started.md +File not found rnw-dependencies.md while parsing versioned_docs/version-0.64/getting-started.md +File not found native-modules.md while parsing versioned_docs/version-0.64/getting-started.md +File not found rnw-dependencies.md while parsing versioned_docs/version-0.64/getting-started.md +File not found getting-started.md while parsing versioned_docs/version-0.64/hermes.md +File not found rnm-getting-started.md while parsing versioned_docs/version-0.64/hermes.md +File not found getting-started.md while parsing versioned_docs/version-0.64/hermes.md +File not found rnm-getting-started.md while parsing versioned_docs/version-0.64/hermes.md +File not found getting-started.md while parsing versioned_docs/version-0.64/hermes.md +File not found rnm-getting-started.md while parsing versioned_docs/version-0.64/hermes.md +File not found getting-started.md while parsing versioned_docs/version-0.64/hermes.md +File not found ikeyboardprops-api-windows.md while parsing versioned_docs/version-0.64/iviewwindowsprops-api-windows.md +File not found ikeyboardprops-api-windows.md while parsing versioned_docs/version-0.64/iviewwindowsprops-api-windows.md +File not found native-modules.md while parsing versioned_docs/version-0.64/native-modules-advanced.md +File not found native-modules.md while parsing versioned_docs/version-0.64/native-modules-advanced.md +File not found native-modules.md while parsing versioned_docs/version-0.64/native-modules-advanced.md +File not found native-modules.md while parsing versioned_docs/version-0.64/native-modules-advanced.md +File not found config.md while parsing versioned_docs/version-0.64/native-modules-autolinking.md +File not found native-modules-marshalling-data.md while parsing versioned_docs/version-0.64/native-modules-jsvalue.md +File not found assets/data-marshaling-flow.png while parsing versioned_docs/version-0.64/native-modules-marshalling-data.md +File not found assets/rn-windows-app-layout-with-native-modules.png while parsing versioned_docs/version-0.64/native-modules-marshalling-data.md +File not found assets/rn-windows-app-layout.png while parsing versioned_docs/version-0.64/native-modules-marshalling-data.md +File not found native-modules-jsvalue.md while parsing versioned_docs/version-0.64/native-modules-marshalling-data.md +File not found native-modules.md while parsing versioned_docs/version-0.64/native-modules-marshalling-data.md +File not found native-modules-advanced.md while parsing versioned_docs/version-0.64/native-modules-marshalling-data.md +File not found native-modules.md while parsing versioned_docs/version-0.64/native-modules-marshalling-data.md +File not found native-modules-jsvalue.md while parsing versioned_docs/version-0.64/native-modules-marshalling-data.md +File not found native-modules.md while parsing versioned_docs/version-0.64/native-modules-marshalling-data.md +File not found native-modules-advanced.md while parsing versioned_docs/version-0.64/native-modules-marshalling-data.md +File not found native-modules.md while parsing versioned_docs/version-0.64/native-modules-marshalling-data.md +File not found getting-started.md while parsing versioned_docs/version-0.64/native-modules-setup.md +File not found native-modules-autolinking.md while parsing versioned_docs/version-0.64/native-modules-setup.md +File not found native-modules.md while parsing versioned_docs/version-0.64/native-modules-setup.md +File not found rnw-dependencies.md while parsing versioned_docs/version-0.64/native-modules-setup.md +File not found view-managers.md while parsing versioned_docs/version-0.64/native-modules-setup.md +File not found getting-started.md while parsing versioned_docs/version-0.64/native-modules-setup.md +File not found native-modules.md while parsing versioned_docs/version-0.64/native-modules-setup.md +File not found rnw-dependencies.md while parsing versioned_docs/version-0.64/native-modules-setup.md +File not found view-managers.md while parsing versioned_docs/version-0.64/native-modules-setup.md +File not found getting-started.md while parsing versioned_docs/version-0.64/native-modules-setup.md +File not found native-modules.md while parsing versioned_docs/version-0.64/native-modules-setup.md +File not found rnw-dependencies.md while parsing versioned_docs/version-0.64/native-modules-setup.md +File not found view-managers.md while parsing versioned_docs/version-0.64/native-modules-setup.md +File not found getting-started.md while parsing versioned_docs/version-0.64/native-modules-setup.md +File not found native-modules-using.md while parsing versioned_docs/version-0.64/native-modules-setup.md +File not found native-modules.md while parsing versioned_docs/version-0.64/native-modules-setup.md +File not found rnw-dependencies.md while parsing versioned_docs/version-0.64/native-modules-setup.md +File not found testing.md while parsing versioned_docs/version-0.64/native-modules-setup.md +File not found view-managers.md while parsing versioned_docs/version-0.64/native-modules-setup.md +File not found native-modules-async.md while parsing versioned_docs/version-0.64/native-modules.md +File not found native-modules-jsvalue.md while parsing versioned_docs/version-0.64/native-modules.md +File not found native-modules-setup.md while parsing versioned_docs/version-0.64/native-modules.md +File not found view-managers.md while parsing versioned_docs/version-0.64/native-modules.md +File not found native-code-language-choice.md while parsing versioned_docs/version-0.64/native-modules.md +File not found native-modules-advanced.md while parsing versioned_docs/version-0.64/native-modules.md +File not found native-modules-async.md while parsing versioned_docs/version-0.64/native-modules.md +File not found native-modules-setup.md while parsing versioned_docs/version-0.64/native-modules.md +File not found view-managers.md while parsing versioned_docs/version-0.64/native-modules.md +File not found native-modules-async.md while parsing versioned_docs/version-0.64/native-modules.md +File not found native-modules-jsvalue.md while parsing versioned_docs/version-0.64/native-modules.md +File not found native-modules-setup.md while parsing versioned_docs/version-0.64/native-modules.md +File not found view-managers.md while parsing versioned_docs/version-0.64/native-modules.md +File not found native-modules-advanced.md while parsing versioned_docs/version-0.64/native-modules.md +File not found native-modules-setup.md while parsing versioned_docs/version-0.64/native-modules.md +File not found view-managers.md while parsing versioned_docs/version-0.64/native-modules.md +File not found assets/nuget-update-cpp-project.png while parsing versioned_docs/version-0.64/nuget-update.md +File not found assets/nuget-update-cs-project.png while parsing versioned_docs/version-0.64/nuget-update.md +File not found assets/nuget-update-packages-manager-installed-tab.png while parsing versioned_docs/version-0.64/nuget-update.md +File not found assets/nuget-update-select-package.png while parsing versioned_docs/version-0.64/nuget-update.md +File not found nuget.md while parsing versioned_docs/version-0.64/nuget-update.md +File not found native-modules-csharp-codegen.md while parsing versioned_docs/version-0.64/nuget.md +File not found nuget-update.md while parsing versioned_docs/version-0.64/nuget.md +File not found winui3.md while parsing versioned_docs/version-0.64/nuget.md +File not found supported-community-modules.md while parsing versioned_docs/version-0.64/nuget.md +File not found winui3.md while parsing versioned_docs/version-0.64/nuget.md +File not found flyout-component-windows.md while parsing versioned_docs/version-0.64/popup-component-windows.md +File not found flyout-component-windows.md while parsing versioned_docs/version-0.64/popup-component-windows.md +File not found win10-compat.md while parsing versioned_docs/version-0.64/rnw-dependencies.md +File not found win10-compat.md while parsing versioned_docs/version-0.64/rnw-dependencies.md +File not found win10-compat.md while parsing versioned_docs/version-0.64/rnw-dependencies.md +File not found win10-compat.md while parsing versioned_docs/version-0.64/rnw-dependencies.md +File not found getting-started.md while parsing versioned_docs/version-0.64/view-managers.md +File not found native-modules-setup.md while parsing versioned_docs/version-0.64/view-managers.md +File not found native-modules.md while parsing versioned_docs/version-0.64/view-managers.md +File not found getting-started.md while parsing versioned_docs/version-0.64/view-managers.md +File not found native-modules-setup.md while parsing versioned_docs/version-0.64/view-managers.md +File not found native-modules.md while parsing versioned_docs/version-0.64/view-managers.md +File not found getting-started.md while parsing versioned_docs/version-0.64/view-managers.md +File not found native-modules-setup.md while parsing versioned_docs/version-0.64/view-managers.md +File not found native-modules.md while parsing versioned_docs/version-0.64/view-managers.md +File not found getting-started.md while parsing versioned_docs/version-0.64/view-managers.md +File not found native-modules-setup.md while parsing versioned_docs/version-0.64/view-managers.md +File not found native-modules.md while parsing versioned_docs/version-0.64/view-managers.md +File not found winui3.md while parsing versioned_docs/version-0.64/win10-compat.md +File not found winui3.md while parsing versioned_docs/version-0.64/win10-compat.md +File not found assets/powershell-start-menu.png while parsing versioned_docs/version-0.64/win10-vm.md +File not found rnw-dependencies.md while parsing versioned_docs/version-0.64/win10-vm.md +File not found rnw-dependencies.md while parsing versioned_docs/version-0.64/win10-vm.md +File not found rnw-dependencies.md while parsing versioned_docs/version-0.64/win10-vm.md +File not found rnw-dependencies.md while parsing versioned_docs/version-0.64/win10-vm.md +File not found assets/reveal-surface-animation.gif while parsing versioned_docs/version-0.64/windowsbrush-and-theme.md +File not found assets/rnw-acrylic-surface.png while parsing versioned_docs/version-0.64/windowsbrush-and-theme.md File not found native-modules.md while parsing versioned_docs/version-0.63/getting-started.md File not found rnw-dependencies.md while parsing versioned_docs/version-0.63/getting-started.md File not found native-modules.md while parsing versioned_docs/version-0.63/getting-started.md diff --git a/website/versioned_docs/version-0.64/ConstantProviderDelegate-api-windows.md b/website/versioned_docs/version-0.64/ConstantProviderDelegate-api-windows.md new file mode 100644 index 000000000..addc6b4a9 --- /dev/null +++ b/website/versioned_docs/version-0.64/ConstantProviderDelegate-api-windows.md @@ -0,0 +1,21 @@ +--- +id: version-0.64-ConstantProviderDelegate +title: ConstantProviderDelegate +original_id: ConstantProviderDelegate +--- + +Kind: `delegate` + +A delegate to gather constants from native modules. + +## Invoke +void **`Invoke`**([`IJSValueWriter`](IJSValueWriter) constantWriter) + + + + + +## Referenced by +- [`IReactModuleBuilder`](IReactModuleBuilder) +- [`IViewManagerWithExportedEventTypeConstants`](IViewManagerWithExportedEventTypeConstants) +- [`IViewManagerWithExportedViewConstants`](IViewManagerWithExportedViewConstants) diff --git a/website/versioned_docs/version-0.64/DevMenuControl-api-windows.md b/website/versioned_docs/version-0.64/DevMenuControl-api-windows.md new file mode 100644 index 000000000..d81302fea --- /dev/null +++ b/website/versioned_docs/version-0.64/DevMenuControl-api-windows.md @@ -0,0 +1,64 @@ +--- +id: version-0.64-DevMenuControl +title: DevMenuControl +original_id: DevMenuControl +--- + +Kind: `class` + +Extends: [`UserControl`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.Controls.UserControl) + + + +## Properties +### BreakOnNextLine +`readonly` [`Button`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.Controls.Button) `BreakOnNextLine` + +### BreakOnNextLineText +`readonly` [`TextBlock`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.Controls.TextBlock) `BreakOnNextLineText` + +### Cancel +`readonly` [`Button`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.Controls.Button) `Cancel` + +### ConfigBundler +`readonly` [`Button`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.Controls.Button) `ConfigBundler` + +### DirectDebug +`readonly` [`Button`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.Controls.Button) `DirectDebug` + +### DirectDebugDesc +`readonly` [`TextBlock`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.Controls.TextBlock) `DirectDebugDesc` + +### DirectDebugText +`readonly` [`TextBlock`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.Controls.TextBlock) `DirectDebugText` + +### FastRefresh +`readonly` [`Button`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.Controls.Button) `FastRefresh` + +### FastRefreshText +`readonly` [`TextBlock`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.Controls.TextBlock) `FastRefreshText` + +### Inspector +`readonly` [`Button`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.Controls.Button) `Inspector` + +### Reload +`readonly` [`Button`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.Controls.Button) `Reload` + +### RemoteDebug +`readonly` [`Button`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.Controls.Button) `RemoteDebug` + +### RemoteDebugDesc +`readonly` [`TextBlock`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.Controls.TextBlock) `RemoteDebugDesc` + +### RemoteDebugText +`readonly` [`TextBlock`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.Controls.TextBlock) `RemoteDebugText` + + +## Constructors +### DevMenuControl + **`DevMenuControl`**() + + + + + diff --git a/website/versioned_docs/version-0.64/IJSValueReader-api-windows.md b/website/versioned_docs/version-0.64/IJSValueReader-api-windows.md new file mode 100644 index 000000000..1eef0366a --- /dev/null +++ b/website/versioned_docs/version-0.64/IJSValueReader-api-windows.md @@ -0,0 +1,72 @@ +--- +id: version-0.64-IJSValueReader +title: IJSValueReader +original_id: IJSValueReader +--- + +Kind: `interface` + + + +Forward-only reader for JSON-like streams.
It is used to read data sent between native modules and the Microsoft.ReactNative.dll.

The JSON-like streams are data structures that satisfy the [JSON specification](https://tools.ietf.org/html/rfc8259). The data structure may have objects with name-value pairs and arrays of items. Property values or array items can be of type `Null`, `Object`, `Array`, `String`, `Boolean`, or `Number`. The `IJSValueReader` treats the `Number` type as `Int64` or `Double`. See [`JSValueType`](JSValueType).

When `IJSValueReader` reads data it must walk the whole tree without skipping any items. It means that if the current value type is `Object`, then we must call [`GetNextObjectProperty`](#getnextobjectproperty) to start reading its properties, and if the current type is `Array`, then we must call [`GetNextArrayItem`](#getnextarrayitem) to start reading its items.

See the [`IJSValueWriter`](IJSValueWriter) for the corresponding writer interface.

The [`IJSValueReader`](IJSValueReader) and [`IJSValueWriter`](IJSValueWriter) must be rarely used directly. Use them to create serializer and deserializer functions for a type. The rest of application code must use these functions to serialize/deserialize values. The `Microsoft.ReactNative.Cxx` and `Microsoft.ReactNative.Managed` projects offer serializer/deserializer functions for many standard types. Use them directly or to define serializer/deserializer functions for your types. + +## Properties +### ValueType +`readonly` [`JSValueType`](JSValueType) `ValueType` + +Gets the type of the current value. + + + +## Methods +### GetBoolean +bool **`GetBoolean`**() + +Gets the current `Boolean` value. + + + +### GetDouble +double **`GetDouble`**() + +Gets the current `Number` value as a `Double`. + + + +### GetInt64 +int64_t **`GetInt64`**() + +Gets the current `Number` value as an `Int64`. + + + +### GetNextArrayItem +bool **`GetNextArrayItem`**() + +Gets the next array item and makes its value to be the current value.

It returns **`true`** if the next array item is acquired successfully. Otherwise, it returns **`false`**, and it means that reading of the JSON-like array is completed.

**Note**
- Use [`ValueType`](#valuetype) to get the type of the array item and other GetXXX methods to read it.
- Use [`GetNextObjectProperty`](#getnextobjectproperty) method to start reading property value of type`JSValueType::Object`.
- Use [`GetNextArrayItem`](#getnextarrayitem) method to start reading property value of type`JSValueType::Array` + + + +### GetNextObjectProperty +bool **`GetNextObjectProperty`**(**out** string propertyName) + +Gets the next object property and makes its value to be the current value.

It returns **`true`** if the next property is acquired successfully. In that case the `propertyName` is set to the name of the property. Otherwise, it returns **`false`**, that means that reading of the JSON-like object is completed.

**Note**
- Use [`ValueType`](#valuetype) to get the type of the property value and other GetXXX methods to read it.
- Use [`GetNextObjectProperty`](#getnextobjectproperty) method to start reading property value of type`JSValueType::Object`.
- Use [`GetNextArrayItem`](#getnextarrayitem) method to start reading property value of type`JSValueType::Array` + + + +### GetString +string **`GetString`**() + +Gets the current `String` value. + + + + + + +## Referenced by +- [`IRedBoxErrorInfo`](IRedBoxErrorInfo) +- [`IViewManagerWithCommands`](IViewManagerWithCommands) +- [`IViewManagerWithNativeProperties`](IViewManagerWithNativeProperties) +- [`MethodDelegate`](MethodDelegate) +- [`SyncMethodDelegate`](SyncMethodDelegate) diff --git a/website/versioned_docs/version-0.64/IJSValueWriter-api-windows.md b/website/versioned_docs/version-0.64/IJSValueWriter-api-windows.md new file mode 100644 index 000000000..9c96a4071 --- /dev/null +++ b/website/versioned_docs/version-0.64/IJSValueWriter-api-windows.md @@ -0,0 +1,94 @@ +--- +id: version-0.64-IJSValueWriter +title: IJSValueWriter +original_id: IJSValueWriter +--- + +Kind: `interface` + + + +JSON-like stream writer.
It is used to write data that is sent between native modules and the Microsoft.ReactNative.dll.

The JSON-like streams are data structures that satisfy the [JSON specification](https://tools.ietf.org/html/rfc8259). The data structure may have objects with name-value pairs and arrays of items. Property values or array items can be of type `Null`, `Object`, `Array`, `String`, `Boolean`, or `Number`. The `IJSValueWriter` treats the `Number` type as `Int64` or `Double`. See [`JSValueType`](JSValueType).

See the [`IJSValueReader`](IJSValueReader) for the corresponding reader interface.

The [`IJSValueReader`](IJSValueReader) and [`IJSValueWriter`](IJSValueWriter) must be rarely used directly. Use them to create serializer and deserializer functions for a type. The rest of application code must use these functions to serialize/deserialize values. The `Microsoft.ReactNative.Cxx` and `Microsoft.ReactNative.Managed` projects offer serializer/deserializer functions for many standard types. Use them directly or to define serializer/deserializer functions for your types. + + + +## Methods +### WriteArrayBegin +void **`WriteArrayBegin`**() + +Starts writing an array. + + + +### WriteArrayEnd +void **`WriteArrayEnd`**() + +Completes writing an array. + + + +### WriteBoolean +void **`WriteBoolean`**(bool value) + +Writes a `Boolean` value. + + + +### WriteDouble +void **`WriteDouble`**(double value) + +Writes a `Number` value from a double. + + + +### WriteInt64 +void **`WriteInt64`**(int64_t value) + +Writes a `Number` value from an integer. + + + +### WriteNull +void **`WriteNull`**() + +Writes a `Null` value. + + + +### WriteObjectBegin +void **`WriteObjectBegin`**() + +Starts writing an `Object`. + + + +### WriteObjectEnd +void **`WriteObjectEnd`**() + +Completes writing an object. + + + +### WritePropertyName +void **`WritePropertyName`**(string name) + +Writes a property name within an object. This call should then be followed by writing the value of that property. + + + +### WriteString +void **`WriteString`**(string value) + +Writes a `String` value + + + + + + +## Referenced by +- [`ConstantProviderDelegate`](ConstantProviderDelegate) +- [`JSValueArgWriter`](JSValueArgWriter) +- [`MethodDelegate`](MethodDelegate) +- [`MethodResultCallback`](MethodResultCallback) +- [`SyncMethodDelegate`](SyncMethodDelegate) diff --git a/website/versioned_docs/version-0.64/IJsiByteBuffer-api-windows.md b/website/versioned_docs/version-0.64/IJsiByteBuffer-api-windows.md new file mode 100644 index 000000000..63518fea9 --- /dev/null +++ b/website/versioned_docs/version-0.64/IJsiByteBuffer-api-windows.md @@ -0,0 +1,27 @@ +--- +id: version-0.64-IJsiByteBuffer +title: IJsiByteBuffer +original_id: IJsiByteBuffer +--- + +Kind: `interface` + + + +## Properties +### Size +`readonly` uint32_t `Size` + + + +## Methods +### GetData +void **`GetData`**([`JsiByteArrayUser`](JsiByteArrayUser) useBytes) + + + + + + +## Referenced by +- [`JsiRuntime`](JsiRuntime) diff --git a/website/versioned_docs/version-0.64/IJsiHostObject-api-windows.md b/website/versioned_docs/version-0.64/IJsiHostObject-api-windows.md new file mode 100644 index 000000000..046425f58 --- /dev/null +++ b/website/versioned_docs/version-0.64/IJsiHostObject-api-windows.md @@ -0,0 +1,35 @@ +--- +id: version-0.64-IJsiHostObject +title: IJsiHostObject +original_id: IJsiHostObject +--- + +Kind: `interface` + + + +> **EXPERIMENTAL** + + + +## Methods +### GetProperty +[`JsiValueRef`](JsiValueRef) **`GetProperty`**([`JsiRuntime`](JsiRuntime) runtime, [`JsiPropertyIdRef`](JsiPropertyIdRef) propertyId) + + + +### GetPropertyIds +[`IVector`](https://docs.microsoft.com/uwp/api/Windows.Foundation.Collections.IVector-1)<[`JsiPropertyIdRef`](JsiPropertyIdRef)> **`GetPropertyIds`**([`JsiRuntime`](JsiRuntime) runtime) + + + +### SetProperty +void **`SetProperty`**([`JsiRuntime`](JsiRuntime) runtime, [`JsiPropertyIdRef`](JsiPropertyIdRef) propertyId, [`JsiValueRef`](JsiValueRef) value) + + + + + + +## Referenced by +- [`JsiRuntime`](JsiRuntime) diff --git a/website/versioned_docs/version-0.64/IReactContext-api-windows.md b/website/versioned_docs/version-0.64/IReactContext-api-windows.md new file mode 100644 index 000000000..314dd0a6e --- /dev/null +++ b/website/versioned_docs/version-0.64/IReactContext-api-windows.md @@ -0,0 +1,103 @@ +--- +id: version-0.64-IReactContext +title: IReactContext +original_id: IReactContext +--- + +Kind: `interface` + + + +The `IReactContext` object is given to native modules to communicate with other native modules, views, application, and the React Native instance.
It has the same lifetime as the React instance. When the React instance is reloaded or unloaded, the `IReactContext` is destroyed.
- Use the Properties to share native module's data with other components.
- Use the Notifications to exchange events with other components.
- Use [`CallJSFunction`](#calljsfunction) to call JavaScript functions, and [`EmitJSEvent`](#emitjsevent) to raise JavaScript events. + +## Properties +### BundleRootPath +`readonly` string `BundleRootPath` + +### DebugBundlePath +`readonly` string `DebugBundlePath` + +### DebuggerBreakOnNextLine +`readonly` bool `DebuggerBreakOnNextLine` + +### DebuggerPort +`readonly` uint16_t `DebuggerPort` + +### JSDispatcher +`readonly` [`IReactDispatcher`](IReactDispatcher) `JSDispatcher` + +Get `ReactDispatcherHelper::JSDispatcherProperty` from the Properties property bag. + +### JavaScriptBundleFile +`readonly` string `JavaScriptBundleFile` + +### JsiRuntime +`readonly` [`JsiRuntime`](JsiRuntime) `JsiRuntime` + +Get the JSI runtime for the running React instance. It can be null if Web debugging is used. + +### Notifications +`readonly` [`IReactNotificationService`](IReactNotificationService) `Notifications` + +Notifications shared with the [`ReactInstanceSettings.Notifications`](ReactInstanceSettings#notifications). They can be used to exchange events between components.
All subscriptions added to the `IReactContext.Notifications` are automatically removed after the `IReactContext` is destroyed.
The subscriptions added to the `ReactInstanceSettings.Notifications` are kept as long as `ReactInstanceSettings` is alive. + +### Properties +`readonly` [`IReactPropertyBag`](IReactPropertyBag) `Properties` + +Properties shared with the [`ReactInstanceSettings.Properties`](ReactInstanceSettings#properties-1). It can be used to share values and state between components. + +### SourceBundleHost +`readonly` string `SourceBundleHost` + +### SourceBundlePort +`readonly` uint16_t `SourceBundlePort` + +### UIDispatcher +`readonly` [`IReactDispatcher`](IReactDispatcher) `UIDispatcher` + +Get `ReactDispatcherHelper::UIDispatcherProperty` from the Properties property bag. + +### UseDirectDebugger +`readonly` bool `UseDirectDebugger` + +### UseFastRefresh +`readonly` bool `UseFastRefresh` + +### UseWebDebugger +`readonly` bool `UseWebDebugger` + + + +## Methods +### CallJSFunction +void **`CallJSFunction`**(string moduleName, string methodName, [`JSValueArgWriter`](JSValueArgWriter) paramsArgWriter) + +Call the JavaScript function named `methodName` of `moduleName`. + + + +### DispatchEvent +void **`DispatchEvent`**([`FrameworkElement`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.FrameworkElement) view, string eventName, [`JSValueArgWriter`](JSValueArgWriter) eventDataArgWriter) + +> **Deprecated**: Use [`XamlUIService.DispatchEvent`](XamlUIService#dispatchevent) instead + + + +### EmitJSEvent +void **`EmitJSEvent`**(string eventEmitterName, string eventName, [`JSValueArgWriter`](JSValueArgWriter) paramsArgWriter) + +Call JavaScript module event. It is a specialized `CallJSFunction` call where method name is always 'emit'. + + + + + + +## Referenced by +- [`IViewManagerWithReactContext`](IViewManagerWithReactContext) +- [`InitializerDelegate`](InitializerDelegate) +- [`InstanceCreatedEventArgs`](InstanceCreatedEventArgs) +- [`InstanceDestroyedEventArgs`](InstanceDestroyedEventArgs) +- [`InstanceLoadedEventArgs`](InstanceLoadedEventArgs) +- [`ReactNativeHost`](ReactNativeHost) +- [`XamlUIService`](XamlUIService) diff --git a/website/versioned_docs/version-0.64/IReactDispatcher-api-windows.md b/website/versioned_docs/version-0.64/IReactDispatcher-api-windows.md new file mode 100644 index 000000000..9993a1c1e --- /dev/null +++ b/website/versioned_docs/version-0.64/IReactDispatcher-api-windows.md @@ -0,0 +1,37 @@ +--- +id: version-0.64-IReactDispatcher +title: IReactDispatcher +original_id: IReactDispatcher +--- + +Kind: `interface` + + + +`IReactDispatcher` provides the core threading/task management interface for ensuring code happens in the right order on the right thread. One primary dispatcher that applications may require is the [`IReactContext.UIDispatcher`](IReactContext#uidispatcher) which provides native modules access to the UI thread associated with this react instance. Another one is the [`IReactContext.JSDispatcher`](IReactContext#jsdispatcher) which allows apps to post tasks to the JS engine thread. + +## Properties +### HasThreadAccess +`readonly` bool `HasThreadAccess` + +`true` if the dispatcher uses current thread. + + + +## Methods +### Post +void **`Post`**([`ReactDispatcherCallback`](ReactDispatcherCallback) callback) + +Post a task to the dispatcher. This callback will be called asynchronously on the thread/queue associated with this dispatcher. + + + + + + +## Referenced by +- [`IReactContext`](IReactContext) +- [`IReactNotificationService`](IReactNotificationService) +- [`IReactNotificationSubscription`](IReactNotificationSubscription) +- [`ReactDispatcherHelper`](ReactDispatcherHelper) +- [`ReactInstanceSettings`](ReactInstanceSettings) diff --git a/website/versioned_docs/version-0.64/IReactModuleBuilder-api-windows.md b/website/versioned_docs/version-0.64/IReactModuleBuilder-api-windows.md new file mode 100644 index 000000000..96bf1e97c --- /dev/null +++ b/website/versioned_docs/version-0.64/IReactModuleBuilder-api-windows.md @@ -0,0 +1,46 @@ +--- +id: version-0.64-IReactModuleBuilder +title: IReactModuleBuilder +original_id: IReactModuleBuilder +--- + +Kind: `interface` + + + +Builds native modules inside of React native code based on the provided meta-data. See [Native Modules](native-modules) for more usage information. + + + +## Methods +### AddConstantProvider +void **`AddConstantProvider`**([`ConstantProviderDelegate`](ConstantProviderDelegate) constantProvider) + +The JavaScript values written by the [`ConstantProviderDelegate`](ConstantProviderDelegate) will be available as constants on the native module is JavaScript. + + + +### AddInitializer +void **`AddInitializer`**([`InitializerDelegate`](InitializerDelegate) initializer) + +An initializer is a method that will be called when the react instance starts. It provides the native module with the [`IReactContext`](IReactContext) for the running instance. See [`InitializerDelegate`](InitializerDelegate). + + + +### AddMethod +void **`AddMethod`**(string name, [`MethodReturnType`](MethodReturnType) returnType, [`MethodDelegate`](MethodDelegate) method) + + + +### AddSyncMethod +void **`AddSyncMethod`**(string name, [`SyncMethodDelegate`](SyncMethodDelegate) method) + +Adds a synchronous method to the native module. See [`SyncMethodDelegate`](SyncMethodDelegate). + + + + + + +## Referenced by +- [`ReactModuleProvider`](ReactModuleProvider) diff --git a/website/versioned_docs/version-0.64/IReactNonAbiValue-api-windows.md b/website/versioned_docs/version-0.64/IReactNonAbiValue-api-windows.md new file mode 100644 index 000000000..4de7eaabc --- /dev/null +++ b/website/versioned_docs/version-0.64/IReactNonAbiValue-api-windows.md @@ -0,0 +1,23 @@ +--- +id: version-0.64-IReactNonAbiValue +title: IReactNonAbiValue +original_id: IReactNonAbiValue +--- + +Kind: `interface` + + + +`IReactNonAbiValue` helps wrap a non-ABI-safe C++ value into an `IInspectable` object. Use it to handle native module lifetime. It also can be used to store values in the [`IReactPropertyBag`](IReactPropertyBag) that do not need to go through the EXE/DLL boundary. + + + +## Methods +### GetPtr +int64_t **`GetPtr`**() + +Get a pointer to the stored value. + + + + diff --git a/website/versioned_docs/version-0.64/IReactNotificationService-api-windows.md b/website/versioned_docs/version-0.64/IReactNotificationService-api-windows.md new file mode 100644 index 000000000..d1d18e51f --- /dev/null +++ b/website/versioned_docs/version-0.64/IReactNotificationService-api-windows.md @@ -0,0 +1,36 @@ +--- +id: version-0.64-IReactNotificationService +title: IReactNotificationService +original_id: IReactNotificationService +--- + +Kind: `interface` + + + +The notification service is used to subscribe to notifications and to send notifications + + + +## Methods +### SendNotification +void **`SendNotification`**([`IReactPropertyName`](IReactPropertyName) notificationName, Object sender, Object data) + +Send the notification with `notificationName`. The sender is the object that sends notification and can be null. The `data` is the data associated with the notification and can be null. Consider using [`IReactPropertyBag`](IReactPropertyBag) for sending semi-structured data. It can be created using the [`ReactPropertyBagHelper.CreatePropertyBag`](ReactPropertyBagHelper#createpropertybag) method. + + + +### Subscribe +[`IReactNotificationSubscription`](IReactNotificationSubscription) **`Subscribe`**([`IReactPropertyName`](IReactPropertyName) notificationName, [`IReactDispatcher`](IReactDispatcher) dispatcher, [`ReactNotificationHandler`](ReactNotificationHandler) handler) + +Subscribe to a notification. The `notificationName` is a non-null property name and can belong to a specific namespace.
The dispatcher is used to call notification handlers. If it is null, then the handler is called synchronously. The handler is a delegate that can be implemented as a lambda to handle notifications. The method returns a [`IReactNotificationSubscription`](IReactNotificationSubscription) that must be kept alive while the subscription is active. The subscription is removed when the [`IReactNotificationSubscription`](IReactNotificationSubscription) is destroyed. + + + + + + +## Referenced by +- [`IReactContext`](IReactContext) +- [`ReactInstanceSettings`](ReactInstanceSettings) +- [`ReactNotificationServiceHelper`](ReactNotificationServiceHelper) diff --git a/website/versioned_docs/version-0.64/IReactNotificationSubscription-api-windows.md b/website/versioned_docs/version-0.64/IReactNotificationSubscription-api-windows.md new file mode 100644 index 000000000..c6d38f673 --- /dev/null +++ b/website/versioned_docs/version-0.64/IReactNotificationSubscription-api-windows.md @@ -0,0 +1,44 @@ +--- +id: version-0.64-IReactNotificationSubscription +title: IReactNotificationSubscription +original_id: IReactNotificationSubscription +--- + +Kind: `interface` + + + +A subscription to a notification. The subscription is removed when this object is deleted or the [`Unsubscribe`](#unsubscribe) method is called. + +## Properties +### Dispatcher +`readonly` [`IReactDispatcher`](IReactDispatcher) `Dispatcher` + +The [`IReactDispatcher`](IReactDispatcher) provided when the notification subscription created. All notifications will be handled using this dispatcher. + +### IsSubscribed +`readonly` bool `IsSubscribed` + +True if the subscription is still active. This property is checked before notification handler is invoked. + +### NotificationName +`readonly` [`IReactPropertyName`](IReactPropertyName) `NotificationName` + +Name of the notification. + + + +## Methods +### Unsubscribe +void **`Unsubscribe`**() + +Remove the subscription. Because of the multi-threaded nature of the notifications, the handler can be still called after the Unsubscribe method called if the [`IsSubscribed`](#issubscribed) property is already checked. Consider calling the Unsubscribe method and the handler in the same [`IReactDispatcher`](IReactDispatcher) to ensure that no handler is invoked after the Unsubscribe method call. + + + + + + +## Referenced by +- [`IReactNotificationArgs`](IReactNotificationArgs) +- [`IReactNotificationService`](IReactNotificationService) diff --git a/website/versioned_docs/version-0.64/IReactPackageBuilder-api-windows.md b/website/versioned_docs/version-0.64/IReactPackageBuilder-api-windows.md new file mode 100644 index 000000000..c17100fed --- /dev/null +++ b/website/versioned_docs/version-0.64/IReactPackageBuilder-api-windows.md @@ -0,0 +1,34 @@ +--- +id: version-0.64-IReactPackageBuilder +title: IReactPackageBuilder +original_id: IReactPackageBuilder +--- + +Kind: `interface` + + + +A `ReactPackageBuilder` provides the react instance with all the native modules and view managers that will be available in the React instance. + + + +## Methods +### AddModule +void **`AddModule`**(string moduleName, [`ReactModuleProvider`](ReactModuleProvider) moduleProvider) + +Adds a custom native module. See [`ReactModuleProvider`](ReactModuleProvider). + + + +### AddViewManager +void **`AddViewManager`**(string viewManagerName, [`ReactViewManagerProvider`](ReactViewManagerProvider) viewManagerProvider) + +Adds a custom native module. See [`ReactViewManagerProvider`](ReactViewManagerProvider). + + + + + + +## Referenced by +- [`IReactPackageProvider`](IReactPackageProvider) diff --git a/website/versioned_docs/version-0.64/IReactPackageProvider-api-windows.md b/website/versioned_docs/version-0.64/IReactPackageProvider-api-windows.md new file mode 100644 index 000000000..5ea92f1d9 --- /dev/null +++ b/website/versioned_docs/version-0.64/IReactPackageProvider-api-windows.md @@ -0,0 +1,23 @@ +--- +id: version-0.64-IReactPackageProvider +title: IReactPackageProvider +original_id: IReactPackageProvider +--- + +Kind: `interface` + + + +This interface is to be implemented by package creators. + + + +## Methods +### CreatePackage +void **`CreatePackage`**([`IReactPackageBuilder`](IReactPackageBuilder) packageBuilder) + +Provides a [`IReactPackageBuilder`](IReactPackageBuilder) which the app or package will use to register custom native modules and view managers. + + + + diff --git a/website/versioned_docs/version-0.64/IReactPropertyBag-api-windows.md b/website/versioned_docs/version-0.64/IReactPropertyBag-api-windows.md new file mode 100644 index 000000000..cbd73b532 --- /dev/null +++ b/website/versioned_docs/version-0.64/IReactPropertyBag-api-windows.md @@ -0,0 +1,44 @@ +--- +id: version-0.64-IReactPropertyBag +title: IReactPropertyBag +original_id: IReactPropertyBag +--- + +Kind: `interface` + + + +`IReactPropertyBag` provides a thread-safe property storage. Properties are identified by an instance of `IReactPropertyName`. It is expected that there will be no direct use of this interface. Ideally, all usage should happen through strongly-typed accessors. + + + +## Methods +### Get +Object **`Get`**([`IReactPropertyName`](IReactPropertyName) name) + +Get a property's value. It returns null if the property does not exist. + + + +### GetOrCreate +Object **`GetOrCreate`**([`IReactPropertyName`](IReactPropertyName) name, [`ReactCreatePropertyValue`](ReactCreatePropertyValue) createValue) + +Get a property's value. If the property does not exist, this method creates it by calling the `createValue` delegate. The function may return null if the `createValue` returns null when called.The `createValue` is called outside of any locks. It is possible that its result is not used in case another thread sets the property value before the created value is applied. + + + +### Set +Object **`Set`**([`IReactPropertyName`](IReactPropertyName) name, Object value) + +Set a property's value. It returns the previously-stored property value. It returns null if the property did not exist. If the new value is null, then the property is removed. + + + + + + +## Referenced by +- [`IReactContext`](IReactContext) +- [`ReactInstanceSettings`](ReactInstanceSettings) +- [`ReactPropertyBagHelper`](ReactPropertyBagHelper) +- [`XamlUIService`](XamlUIService) diff --git a/website/versioned_docs/version-0.64/IRedBoxErrorFrameInfo-api-windows.md b/website/versioned_docs/version-0.64/IRedBoxErrorFrameInfo-api-windows.md new file mode 100644 index 000000000..af0dc9f8d --- /dev/null +++ b/website/versioned_docs/version-0.64/IRedBoxErrorFrameInfo-api-windows.md @@ -0,0 +1,41 @@ +--- +id: version-0.64-IRedBoxErrorFrameInfo +title: IRedBoxErrorFrameInfo +original_id: IRedBoxErrorFrameInfo +--- + +Kind: `interface` + + + +This object represents a single frame within the call stack of an error. + +## Properties +### Collapse +`readonly` bool `Collapse` + +True if this frame is part of the internals of `react-native`, that is likely not useful for the developer to see. + +### Column +`readonly` uint32_t `Column` + +The column within the line + +### File +`readonly` string `File` + +The file location of this frame + +### Line +`readonly` uint32_t `Line` + +The line number within the file + +### Method +`readonly` string `Method` + +The method name of this frame + + + + diff --git a/website/versioned_docs/version-0.64/IRedBoxErrorInfo-api-windows.md b/website/versioned_docs/version-0.64/IRedBoxErrorInfo-api-windows.md new file mode 100644 index 000000000..950a6e65c --- /dev/null +++ b/website/versioned_docs/version-0.64/IRedBoxErrorInfo-api-windows.md @@ -0,0 +1,55 @@ +--- +id: version-0.64-IRedBoxErrorInfo +title: IRedBoxErrorInfo +original_id: IRedBoxErrorInfo +--- + +Kind: `interface` + + + +This object provides information about the error. For JavaScript errors, a call stack is also provided. + +## Properties +### Callstack +`readonly` [`IVectorView`](https://docs.microsoft.com/uwp/api/Windows.Foundation.Collections.IVectorView-1)<[`IRedBoxErrorFrameInfo`](IRedBoxErrorFrameInfo)> `Callstack` + +For JavaScript errors, this will contain the call stack of where the error occurred. + +### ComponentStack +`readonly` string `ComponentStack` + +This will contain the component stack where the error occurred, which can help identify the component that is producing the error + +### ExtraData +`readonly` [`IJSValueReader`](IJSValueReader) `ExtraData` + +Provides access to extra data attached to the error. Adding additional data to the errors is not yet part of the stable API. + +### Id +`readonly` uint32_t `Id` + +This Id can be used in [`IRedBoxHandler.UpdateError`](IRedBoxHandler#updateerror) to identify which error is being updated. For native errors, this is currently always `0`, and [`IRedBoxHandler.UpdateError`](IRedBoxHandler#updateerror) will never be called. + +### Message +`readonly` string `Message` + +The error message. + +### Name +`readonly` string `Name` + +An identifier for this error. + +### OriginalMessage +`readonly` string `OriginalMessage` + +If the message was adjusted for formatting, or otherwise processed, this contains the message before those modifications + + + + + + +## Referenced by +- [`IRedBoxHandler`](IRedBoxHandler) diff --git a/website/versioned_docs/version-0.64/IRedBoxHandler-api-windows.md b/website/versioned_docs/version-0.64/IRedBoxHandler-api-windows.md new file mode 100644 index 000000000..c9376fe81 --- /dev/null +++ b/website/versioned_docs/version-0.64/IRedBoxHandler-api-windows.md @@ -0,0 +1,105 @@ +--- +id: version-0.64-IRedBoxHandler +title: IRedBoxHandler +original_id: IRedBoxHandler +--- + +Kind: `interface` + + + +`IRedBoxHandler` provides an extension point to allow custom error handling within the React instance. This can be useful if you have an existing error reporting system that you want React errors to be reported to. The default implementation of `RedBoxHandler` shows an error messages in a error screen that covers the whole application window. + +-- Insert Screenshot here -- + +If you want to maintain the existing `RedBox` behaviors, and also report errors to your own reporting system, your implementation can call into the default `RedBoxHandler`, which can be obtained by calling : + +```csharp +RedBoxHelper::CreateDefaultHandler(Host); +``` + +Sample settings up a `RedBoxHandler` that reports errors to an external system, and displays the default `RedBox` experience within the application: + +```csharp + +class MyRedBoxHandler : IRedBoxHandler +{ + MyRedBoxHandler(IRedBoxHandler defaultHandler) { + innerHandler = defaultHandler; + } + + public void ShowNewError(IRedBoxErrorInfo info, RedBoxErrorType type) { + // Dont report non-fatal errors (optional) + if (type != RedBoxErrorType.JavaScriptSoft) + ReportErrorToMyErrorReportingSystem(info, type); + + // Display errors in app if the instance is running with DevSupportEnabled + if (innerHandler.IsDevSupportEnabled) + innerHandler.ShowNewError(info, type); + } + + public bool IsDevSupportEnabled { + get; + } + { + // The default handler will return true if the instance has DevSupport turned on + // But if you want to record error information in released versions of your app + // Then you should return true here, so that all errors get reported. + return true; + } + + public void UpdateError(IRedBoxErrorInfo info) { + if (innerHandler.IsDevSupportEnabled) + innerHandler.UpdateError(info); + } + + public void DismissRedBox() { + if (innerHandler.IsDevSupportEnabled) + innerHandler.DismissRedBox(); + } + + private IRedBoxHandler innerHandler; +} + + +RegisterMyRedBoxHandler() +{ + Host.InstanceSettings.RedBoxHandler = new MyRedBoxHandler(RedBoxHelper.CreateDefaultHandler(Host)); +} + +``` + +## Properties +### IsDevSupportEnabled +`readonly` bool `IsDevSupportEnabled` + +This property will control if errors should be reported to the handler. If this returns false, [`ShowNewError`](#shownewerror) and [`UpdateError`](#updateerror) will not be called. + + + +## Methods +### DismissRedBox +void **`DismissRedBox`**() + + + +### ShowNewError +void **`ShowNewError`**([`IRedBoxErrorInfo`](IRedBoxErrorInfo) info, [`RedBoxErrorType`](RedBoxErrorType) type) + +This method is called when an error is initially hit. + + + +### UpdateError +void **`UpdateError`**([`IRedBoxErrorInfo`](IRedBoxErrorInfo) info) + +This method is called when updated information about an error has been resolved. For JavaScript errors, this is called if source map information was able to be resolved to provide a more useful call stack. + + + + + + +## Referenced by +- [`ReactInstanceSettings`](ReactInstanceSettings) +- [`RedBoxHelper`](RedBoxHelper) diff --git a/website/versioned_docs/version-0.64/IViewManager-api-windows.md b/website/versioned_docs/version-0.64/IViewManager-api-windows.md new file mode 100644 index 000000000..aa5cda367 --- /dev/null +++ b/website/versioned_docs/version-0.64/IViewManager-api-windows.md @@ -0,0 +1,29 @@ +--- +id: version-0.64-IViewManager +title: IViewManager +original_id: IViewManager +--- + +Kind: `interface` + + + +See the documentation of [Native UI Components](view-managers) for information on how to author a view manager.
>**This documentation and the underlying platform code is a work in progress.** + +## Properties +### Name +`readonly` string `Name` + + + +## Methods +### CreateView +[`FrameworkElement`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.FrameworkElement) **`CreateView`**() + + + + + + +## Referenced by +- [`ReactViewManagerProvider`](ReactViewManagerProvider) diff --git a/website/versioned_docs/version-0.64/InitializerDelegate-api-windows.md b/website/versioned_docs/version-0.64/InitializerDelegate-api-windows.md new file mode 100644 index 000000000..e2792985f --- /dev/null +++ b/website/versioned_docs/version-0.64/InitializerDelegate-api-windows.md @@ -0,0 +1,19 @@ +--- +id: version-0.64-InitializerDelegate +title: InitializerDelegate +original_id: InitializerDelegate +--- + +Kind: `delegate` + +A delegate that will set `reactContext` for a module. We use it for a stand-alone initialize method, strongly typed JS events and functions. + +## Invoke +void **`Invoke`**([`IReactContext`](IReactContext) reactContext) + + + + + +## Referenced by +- [`IReactModuleBuilder`](IReactModuleBuilder) diff --git a/website/versioned_docs/version-0.64/InstanceCreatedEventArgs-api-windows.md b/website/versioned_docs/version-0.64/InstanceCreatedEventArgs-api-windows.md new file mode 100644 index 000000000..613b3a856 --- /dev/null +++ b/website/versioned_docs/version-0.64/InstanceCreatedEventArgs-api-windows.md @@ -0,0 +1,21 @@ +--- +id: version-0.64-InstanceCreatedEventArgs +title: InstanceCreatedEventArgs +original_id: InstanceCreatedEventArgs +--- + +Kind: `class` + + + +## Properties +### Context +`readonly` [`IReactContext`](IReactContext) `Context` + + + + + + +## Referenced by +- [`ReactInstanceSettings`](ReactInstanceSettings) diff --git a/website/versioned_docs/version-0.64/InstanceDestroyedEventArgs-api-windows.md b/website/versioned_docs/version-0.64/InstanceDestroyedEventArgs-api-windows.md new file mode 100644 index 000000000..73c4f91d4 --- /dev/null +++ b/website/versioned_docs/version-0.64/InstanceDestroyedEventArgs-api-windows.md @@ -0,0 +1,21 @@ +--- +id: version-0.64-InstanceDestroyedEventArgs +title: InstanceDestroyedEventArgs +original_id: InstanceDestroyedEventArgs +--- + +Kind: `class` + + + +## Properties +### Context +`readonly` [`IReactContext`](IReactContext) `Context` + + + + + + +## Referenced by +- [`ReactInstanceSettings`](ReactInstanceSettings) diff --git a/website/versioned_docs/version-0.64/InstanceLoadedEventArgs-api-windows.md b/website/versioned_docs/version-0.64/InstanceLoadedEventArgs-api-windows.md new file mode 100644 index 000000000..64d36e71f --- /dev/null +++ b/website/versioned_docs/version-0.64/InstanceLoadedEventArgs-api-windows.md @@ -0,0 +1,24 @@ +--- +id: version-0.64-InstanceLoadedEventArgs +title: InstanceLoadedEventArgs +original_id: InstanceLoadedEventArgs +--- + +Kind: `class` + + + +## Properties +### Context +`readonly` [`IReactContext`](IReactContext) `Context` + +### Failed +`readonly` bool `Failed` + + + + + + +## Referenced by +- [`ReactInstanceSettings`](ReactInstanceSettings) diff --git a/website/versioned_docs/version-0.64/JSValueArgWriter-api-windows.md b/website/versioned_docs/version-0.64/JSValueArgWriter-api-windows.md new file mode 100644 index 000000000..578f508e8 --- /dev/null +++ b/website/versioned_docs/version-0.64/JSValueArgWriter-api-windows.md @@ -0,0 +1,22 @@ +--- +id: version-0.64-JSValueArgWriter +title: JSValueArgWriter +original_id: JSValueArgWriter +--- + +Kind: `delegate` + +The `JSValueArgWriter` delegate is used to pass arbitrary value to ABI API.
In a function that implements the delegate use the provided writer to stream custom values. + +## Invoke +void **`Invoke`**([`IJSValueWriter`](IJSValueWriter) writer) + + + + + +## Referenced by +- [`IReactContext`](IReactContext) +- [`ReactRootView`](ReactRootView) +- [`XamlHelper`](XamlHelper) +- [`XamlUIService`](XamlUIService) diff --git a/website/versioned_docs/version-0.64/JSValueType-api-windows.md b/website/versioned_docs/version-0.64/JSValueType-api-windows.md new file mode 100644 index 000000000..6db7b8b89 --- /dev/null +++ b/website/versioned_docs/version-0.64/JSValueType-api-windows.md @@ -0,0 +1,23 @@ +--- +id: version-0.64-JSValueType +title: JSValueType +original_id: JSValueType +--- + +Kind: `enum` + +Type of value read by [`IJSValueReader`](IJSValueReader). + +| Name | Value | Description | +|--|--|--| +|`Null` | 0x0 | | +|`Object` | 0x1 | | +|`Array` | 0x2 | | +|`String` | 0x3 | | +|`Boolean` | 0x4 | | +|`Int64` | 0x5 | | +|`Double` | 0x6 | | + + +## Referenced by +- [`IJSValueReader`](IJSValueReader) diff --git a/website/versioned_docs/version-0.64/JsiByteArrayUser-api-windows.md b/website/versioned_docs/version-0.64/JsiByteArrayUser-api-windows.md new file mode 100644 index 000000000..9d7fadd2b --- /dev/null +++ b/website/versioned_docs/version-0.64/JsiByteArrayUser-api-windows.md @@ -0,0 +1,18 @@ +--- +id: version-0.64-JsiByteArrayUser +title: JsiByteArrayUser +original_id: JsiByteArrayUser +--- + +Kind: `delegate` + +## Invoke +void **`Invoke`**(uint8_t bytes) + + + + + +## Referenced by +- [`IJsiByteBuffer`](IJsiByteBuffer) +- [`JsiRuntime`](JsiRuntime) diff --git a/website/versioned_docs/version-0.64/JsiError-api-windows.md b/website/versioned_docs/version-0.64/JsiError-api-windows.md new file mode 100644 index 000000000..250a97ae8 --- /dev/null +++ b/website/versioned_docs/version-0.64/JsiError-api-windows.md @@ -0,0 +1,33 @@ +--- +id: version-0.64-JsiError +title: JsiError +original_id: JsiError +--- + +Kind: `class` + + + +## Properties +### ErrorDetails +`readonly` string `ErrorDetails` + +### ErrorType +`readonly` [`JsiErrorType`](JsiErrorType) `ErrorType` + +### Message +`readonly` string `Message` + +### Stack +`readonly` string `Stack` + +### Value +`readonly` [`JsiValueRef`](JsiValueRef) `Value` + + + + + + +## Referenced by +- [`JsiRuntime`](JsiRuntime) diff --git a/website/versioned_docs/version-0.64/JsiErrorType-api-windows.md b/website/versioned_docs/version-0.64/JsiErrorType-api-windows.md new file mode 100644 index 000000000..1aa3a9cc5 --- /dev/null +++ b/website/versioned_docs/version-0.64/JsiErrorType-api-windows.md @@ -0,0 +1,17 @@ +--- +id: version-0.64-JsiErrorType +title: JsiErrorType +original_id: JsiErrorType +--- + +Kind: `enum` + +| Name | Value | Description | +|--|--|--| +|`JSError` | 0x0 | | +|`NativeException` | 0x1 | | + + +## Referenced by +- [`JsiError`](JsiError) +- [`JsiRuntime`](JsiRuntime) diff --git a/website/versioned_docs/version-0.64/JsiHostFunction-api-windows.md b/website/versioned_docs/version-0.64/JsiHostFunction-api-windows.md new file mode 100644 index 000000000..96d1557fb --- /dev/null +++ b/website/versioned_docs/version-0.64/JsiHostFunction-api-windows.md @@ -0,0 +1,19 @@ +--- +id: version-0.64-JsiHostFunction +title: JsiHostFunction +original_id: JsiHostFunction +--- + +Kind: `delegate` + +> **EXPERIMENTAL** + +## Invoke +[`JsiValueRef`](JsiValueRef) **`Invoke`**([`JsiRuntime`](JsiRuntime) runtime, [`JsiValueRef`](JsiValueRef) thisArg, [`JsiValueRef`](JsiValueRef) args) + + + + + +## Referenced by +- [`JsiRuntime`](JsiRuntime) diff --git a/website/versioned_docs/version-0.64/JsiObjectRef-api-windows.md b/website/versioned_docs/version-0.64/JsiObjectRef-api-windows.md new file mode 100644 index 000000000..9af5a831c --- /dev/null +++ b/website/versioned_docs/version-0.64/JsiObjectRef-api-windows.md @@ -0,0 +1,16 @@ +--- +id: version-0.64-JsiObjectRef +title: JsiObjectRef +original_id: JsiObjectRef +--- + +Kind: `struct` + +## Fields +### Data +Type: `uint64_t` + + + +## Referenced by +- [`JsiRuntime`](JsiRuntime) diff --git a/website/versioned_docs/version-0.64/JsiPreparedJavaScript-api-windows.md b/website/versioned_docs/version-0.64/JsiPreparedJavaScript-api-windows.md new file mode 100644 index 000000000..38647ae0a --- /dev/null +++ b/website/versioned_docs/version-0.64/JsiPreparedJavaScript-api-windows.md @@ -0,0 +1,17 @@ +--- +id: version-0.64-JsiPreparedJavaScript +title: JsiPreparedJavaScript +original_id: JsiPreparedJavaScript +--- + +Kind: `class` + + + + + + + + +## Referenced by +- [`JsiRuntime`](JsiRuntime) diff --git a/website/versioned_docs/version-0.64/JsiPropertyIdRef-api-windows.md b/website/versioned_docs/version-0.64/JsiPropertyIdRef-api-windows.md new file mode 100644 index 000000000..0ba7f33d4 --- /dev/null +++ b/website/versioned_docs/version-0.64/JsiPropertyIdRef-api-windows.md @@ -0,0 +1,17 @@ +--- +id: version-0.64-JsiPropertyIdRef +title: JsiPropertyIdRef +original_id: JsiPropertyIdRef +--- + +Kind: `struct` + +## Fields +### Data +Type: `uint64_t` + + + +## Referenced by +- [`IJsiHostObject`](IJsiHostObject) +- [`JsiRuntime`](JsiRuntime) diff --git a/website/versioned_docs/version-0.64/JsiRuntime-api-windows.md b/website/versioned_docs/version-0.64/JsiRuntime-api-windows.md new file mode 100644 index 000000000..8cdfbc6a4 --- /dev/null +++ b/website/versioned_docs/version-0.64/JsiRuntime-api-windows.md @@ -0,0 +1,332 @@ +--- +id: version-0.64-JsiRuntime +title: JsiRuntime +original_id: JsiRuntime +--- + +Kind: `class` + + + +> **EXPERIMENTAL** + +## Properties +### Description +`readonly` string `Description` + +### Global +`readonly` [`JsiObjectRef`](JsiObjectRef) `Global` + +### IsInspectable +`readonly` bool `IsInspectable` + + + +## Methods +### Call +[`JsiValueRef`](JsiValueRef) **`Call`**([`JsiObjectRef`](JsiObjectRef) func, [`JsiValueRef`](JsiValueRef) thisArg, [`JsiValueRef`](JsiValueRef) args) + + + +### CallAsConstructor +[`JsiValueRef`](JsiValueRef) **`CallAsConstructor`**([`JsiObjectRef`](JsiObjectRef) func, [`JsiValueRef`](JsiValueRef) args) + + + +### CloneObject +[`JsiObjectRef`](JsiObjectRef) **`CloneObject`**([`JsiObjectRef`](JsiObjectRef) obj) + + + +### ClonePropertyId +[`JsiPropertyIdRef`](JsiPropertyIdRef) **`ClonePropertyId`**([`JsiPropertyIdRef`](JsiPropertyIdRef) propertyId) + + + +### CloneString +[`JsiStringRef`](JsiStringRef) **`CloneString`**([`JsiStringRef`](JsiStringRef) str) + + + +### CloneSymbol +[`JsiSymbolRef`](JsiSymbolRef) **`CloneSymbol`**([`JsiSymbolRef`](JsiSymbolRef) symbol) + + + +### CreateArray +[`JsiObjectRef`](JsiObjectRef) **`CreateArray`**(uint32_t size) + + + +### CreateFunctionFromHostFunction +[`JsiObjectRef`](JsiObjectRef) **`CreateFunctionFromHostFunction`**([`JsiPropertyIdRef`](JsiPropertyIdRef) funcName, uint32_t paramCount, [`JsiHostFunction`](JsiHostFunction) hostFunc) + + + +### CreateObject +[`JsiObjectRef`](JsiObjectRef) **`CreateObject`**() + + + +### CreateObjectWithHostObject +[`JsiObjectRef`](JsiObjectRef) **`CreateObjectWithHostObject`**([`IJsiHostObject`](IJsiHostObject) hostObject) + + + +### CreatePropertyId +[`JsiPropertyIdRef`](JsiPropertyIdRef) **`CreatePropertyId`**(string name) + + + +### CreatePropertyIdFromAscii +[`JsiPropertyIdRef`](JsiPropertyIdRef) **`CreatePropertyIdFromAscii`**(uint8_t ascii) + + + +### CreatePropertyIdFromString +[`JsiPropertyIdRef`](JsiPropertyIdRef) **`CreatePropertyIdFromString`**([`JsiStringRef`](JsiStringRef) str) + + + +### CreatePropertyIdFromUtf8 +[`JsiPropertyIdRef`](JsiPropertyIdRef) **`CreatePropertyIdFromUtf8`**(uint8_t utf8) + + + +### CreateString +[`JsiStringRef`](JsiStringRef) **`CreateString`**(string value) + + + +### CreateStringFromAscii +[`JsiStringRef`](JsiStringRef) **`CreateStringFromAscii`**(uint8_t ascii) + + + +### CreateStringFromUtf8 +[`JsiStringRef`](JsiStringRef) **`CreateStringFromUtf8`**(uint8_t utf8) + + + +### CreateValueFromJson +[`JsiValueRef`](JsiValueRef) **`CreateValueFromJson`**(string json) + + + +### CreateValueFromJsonUtf8 +[`JsiValueRef`](JsiValueRef) **`CreateValueFromJsonUtf8`**(uint8_t json) + + + +### CreateWeakObject +[`JsiWeakObjectRef`](JsiWeakObjectRef) **`CreateWeakObject`**([`JsiObjectRef`](JsiObjectRef) obj) + + + +### EvaluateJavaScript +[`JsiValueRef`](JsiValueRef) **`EvaluateJavaScript`**([`IJsiByteBuffer`](IJsiByteBuffer) buffer, string sourceUrl) + + + +### EvaluatePreparedJavaScript +[`JsiValueRef`](JsiValueRef) **`EvaluatePreparedJavaScript`**([`JsiPreparedJavaScript`](JsiPreparedJavaScript) js) + + + +### GetAndClearError +[`JsiError`](JsiError) **`GetAndClearError`**() + + + +### GetArrayBufferData +void **`GetArrayBufferData`**([`JsiObjectRef`](JsiObjectRef) arrayBuffer, [`JsiByteArrayUser`](JsiByteArrayUser) useArrayBytes) + + + +### GetArrayBufferSize +uint32_t **`GetArrayBufferSize`**([`JsiObjectRef`](JsiObjectRef) arrayBuffer) + + + +### GetArraySize +uint32_t **`GetArraySize`**([`JsiObjectRef`](JsiObjectRef) arr) + + + +### GetHostFunction +[`JsiHostFunction`](JsiHostFunction) **`GetHostFunction`**([`JsiObjectRef`](JsiObjectRef) func) + + + +### GetHostObject +[`IJsiHostObject`](IJsiHostObject) **`GetHostObject`**([`JsiObjectRef`](JsiObjectRef) obj) + + + +### GetProperty +[`JsiValueRef`](JsiValueRef) **`GetProperty`**([`JsiObjectRef`](JsiObjectRef) obj, [`JsiPropertyIdRef`](JsiPropertyIdRef) propertyId) + + + +### GetPropertyIdArray +[`JsiObjectRef`](JsiObjectRef) **`GetPropertyIdArray`**([`JsiObjectRef`](JsiObjectRef) obj) + + + +### GetValueAtIndex +[`JsiValueRef`](JsiValueRef) **`GetValueAtIndex`**([`JsiObjectRef`](JsiObjectRef) arr, uint32_t index) + + + +### HasProperty +bool **`HasProperty`**([`JsiObjectRef`](JsiObjectRef) obj, [`JsiPropertyIdRef`](JsiPropertyIdRef) propertyId) + + + +### InstanceOf +bool **`InstanceOf`**([`JsiObjectRef`](JsiObjectRef) obj, [`JsiObjectRef`](JsiObjectRef) constructor) + + + +### IsArray +bool **`IsArray`**([`JsiObjectRef`](JsiObjectRef) obj) + + + +### IsArrayBuffer +bool **`IsArrayBuffer`**([`JsiObjectRef`](JsiObjectRef) obj) + + + +### IsFunction +bool **`IsFunction`**([`JsiObjectRef`](JsiObjectRef) obj) + + + +### IsHostFunction +bool **`IsHostFunction`**([`JsiObjectRef`](JsiObjectRef) obj) + + + +### IsHostObject +bool **`IsHostObject`**([`JsiObjectRef`](JsiObjectRef) obj) + + + +### LockWeakObject +[`JsiValueRef`](JsiValueRef) **`LockWeakObject`**([`JsiWeakObjectRef`](JsiWeakObjectRef) weakObject) + + + +### MakeChakraRuntime +`static` [`JsiRuntime`](JsiRuntime) **`MakeChakraRuntime`**() + + + +### ObjectStrictEquals +bool **`ObjectStrictEquals`**([`JsiObjectRef`](JsiObjectRef) left, [`JsiObjectRef`](JsiObjectRef) right) + + + +### PopScope +void **`PopScope`**([`JsiScopeState`](JsiScopeState) scopeState) + + + +### PrepareJavaScript +[`JsiPreparedJavaScript`](JsiPreparedJavaScript) **`PrepareJavaScript`**([`IJsiByteBuffer`](IJsiByteBuffer) buffer, string sourceUrl) + + + +### PropertyIdEquals +bool **`PropertyIdEquals`**([`JsiPropertyIdRef`](JsiPropertyIdRef) left, [`JsiPropertyIdRef`](JsiPropertyIdRef) right) + + + +### PropertyIdToString +string **`PropertyIdToString`**([`JsiPropertyIdRef`](JsiPropertyIdRef) propertyId) + + + +### PropertyIdToUtf8 +void **`PropertyIdToUtf8`**([`JsiPropertyIdRef`](JsiPropertyIdRef) propertyId, [`JsiByteArrayUser`](JsiByteArrayUser) useUtf8String) + + + +### PushScope +[`JsiScopeState`](JsiScopeState) **`PushScope`**() + + + +### ReleaseObject +void **`ReleaseObject`**([`JsiObjectRef`](JsiObjectRef) obj) + + + +### ReleasePropertyId +void **`ReleasePropertyId`**([`JsiPropertyIdRef`](JsiPropertyIdRef) propertyId) + + + +### ReleaseString +void **`ReleaseString`**([`JsiStringRef`](JsiStringRef) str) + + + +### ReleaseSymbol +void **`ReleaseSymbol`**([`JsiSymbolRef`](JsiSymbolRef) symbol) + + + +### SetError +void **`SetError`**([`JsiErrorType`](JsiErrorType) errorType, string errorDetails, [`JsiValueRef`](JsiValueRef) value) + + + +### SetProperty +void **`SetProperty`**([`JsiObjectRef`](JsiObjectRef) obj, [`JsiPropertyIdRef`](JsiPropertyIdRef) propertyId, [`JsiValueRef`](JsiValueRef) value) + + + +### SetValueAtIndex +void **`SetValueAtIndex`**([`JsiObjectRef`](JsiObjectRef) arr, uint32_t index, [`JsiValueRef`](JsiValueRef) value) + + + +### StringStrictEquals +bool **`StringStrictEquals`**([`JsiStringRef`](JsiStringRef) left, [`JsiStringRef`](JsiStringRef) right) + + + +### StringToString +string **`StringToString`**([`JsiStringRef`](JsiStringRef) str) + + + +### StringToUtf8 +void **`StringToUtf8`**([`JsiStringRef`](JsiStringRef) str, [`JsiByteArrayUser`](JsiByteArrayUser) useUtf8String) + + + +### SymbolStrictEquals +bool **`SymbolStrictEquals`**([`JsiSymbolRef`](JsiSymbolRef) left, [`JsiSymbolRef`](JsiSymbolRef) right) + + + +### SymbolToString +string **`SymbolToString`**([`JsiSymbolRef`](JsiSymbolRef) symbol) + + + +### SymbolToUtf8 +void **`SymbolToUtf8`**([`JsiSymbolRef`](JsiSymbolRef) symbol, [`JsiByteArrayUser`](JsiByteArrayUser) useUtf8String) + + + + + + +## Referenced by +- [`IJsiHostObject`](IJsiHostObject) +- [`IReactContext`](IReactContext) +- [`JsiHostFunction`](JsiHostFunction) diff --git a/website/versioned_docs/version-0.64/JsiScopeState-api-windows.md b/website/versioned_docs/version-0.64/JsiScopeState-api-windows.md new file mode 100644 index 000000000..fcc4d734f --- /dev/null +++ b/website/versioned_docs/version-0.64/JsiScopeState-api-windows.md @@ -0,0 +1,16 @@ +--- +id: version-0.64-JsiScopeState +title: JsiScopeState +original_id: JsiScopeState +--- + +Kind: `struct` + +## Fields +### Data +Type: `uint64_t` + + + +## Referenced by +- [`JsiRuntime`](JsiRuntime) diff --git a/website/versioned_docs/version-0.64/JsiStringRef-api-windows.md b/website/versioned_docs/version-0.64/JsiStringRef-api-windows.md new file mode 100644 index 000000000..abf66c0ac --- /dev/null +++ b/website/versioned_docs/version-0.64/JsiStringRef-api-windows.md @@ -0,0 +1,16 @@ +--- +id: version-0.64-JsiStringRef +title: JsiStringRef +original_id: JsiStringRef +--- + +Kind: `struct` + +## Fields +### Data +Type: `uint64_t` + + + +## Referenced by +- [`JsiRuntime`](JsiRuntime) diff --git a/website/versioned_docs/version-0.64/JsiSymbolRef-api-windows.md b/website/versioned_docs/version-0.64/JsiSymbolRef-api-windows.md new file mode 100644 index 000000000..dca3a5dfc --- /dev/null +++ b/website/versioned_docs/version-0.64/JsiSymbolRef-api-windows.md @@ -0,0 +1,16 @@ +--- +id: version-0.64-JsiSymbolRef +title: JsiSymbolRef +original_id: JsiSymbolRef +--- + +Kind: `struct` + +## Fields +### Data +Type: `uint64_t` + + + +## Referenced by +- [`JsiRuntime`](JsiRuntime) diff --git a/website/versioned_docs/version-0.64/JsiValueKind-api-windows.md b/website/versioned_docs/version-0.64/JsiValueKind-api-windows.md new file mode 100644 index 000000000..ba333c82a --- /dev/null +++ b/website/versioned_docs/version-0.64/JsiValueKind-api-windows.md @@ -0,0 +1,21 @@ +--- +id: version-0.64-JsiValueKind +title: JsiValueKind +original_id: JsiValueKind +--- + +Kind: `enum` + +| Name | Value | Description | +|--|--|--| +|`Undefined` | 0x0 | | +|`Null` | 0x1 | | +|`Boolean` | 0x2 | | +|`Number` | 0x3 | | +|`Symbol` | 0x4 | | +|`String` | 0x5 | | +|`Object` | 0x6 | | + + +## Referenced by +- [`JsiValueRef`](JsiValueRef) diff --git a/website/versioned_docs/version-0.64/JsiValueRef-api-windows.md b/website/versioned_docs/version-0.64/JsiValueRef-api-windows.md new file mode 100644 index 000000000..eef01c914 --- /dev/null +++ b/website/versioned_docs/version-0.64/JsiValueRef-api-windows.md @@ -0,0 +1,22 @@ +--- +id: version-0.64-JsiValueRef +title: JsiValueRef +original_id: JsiValueRef +--- + +Kind: `struct` + +## Fields +### Data +Type: `uint64_t` + +### Kind +Type: [`JsiValueKind`](JsiValueKind) + + + +## Referenced by +- [`IJsiHostObject`](IJsiHostObject) +- [`JsiError`](JsiError) +- [`JsiHostFunction`](JsiHostFunction) +- [`JsiRuntime`](JsiRuntime) diff --git a/website/versioned_docs/version-0.64/JsiWeakObjectRef-api-windows.md b/website/versioned_docs/version-0.64/JsiWeakObjectRef-api-windows.md new file mode 100644 index 000000000..de9c7d41e --- /dev/null +++ b/website/versioned_docs/version-0.64/JsiWeakObjectRef-api-windows.md @@ -0,0 +1,16 @@ +--- +id: version-0.64-JsiWeakObjectRef +title: JsiWeakObjectRef +original_id: JsiWeakObjectRef +--- + +Kind: `struct` + +## Fields +### Data +Type: `uint64_t` + + + +## Referenced by +- [`JsiRuntime`](JsiRuntime) diff --git a/website/versioned_docs/version-0.64/MethodDelegate-api-windows.md b/website/versioned_docs/version-0.64/MethodDelegate-api-windows.md new file mode 100644 index 000000000..ddeef9035 --- /dev/null +++ b/website/versioned_docs/version-0.64/MethodDelegate-api-windows.md @@ -0,0 +1,19 @@ +--- +id: version-0.64-MethodDelegate +title: MethodDelegate +original_id: MethodDelegate +--- + +Kind: `delegate` + +A delegate to call native asynchronous method. + +## Invoke +void **`Invoke`**([`IJSValueReader`](IJSValueReader) inputReader, [`IJSValueWriter`](IJSValueWriter) outputWriter, [`MethodResultCallback`](MethodResultCallback) resolve, [`MethodResultCallback`](MethodResultCallback) reject) + + + + + +## Referenced by +- [`IReactModuleBuilder`](IReactModuleBuilder) diff --git a/website/versioned_docs/version-0.64/MethodResultCallback-api-windows.md b/website/versioned_docs/version-0.64/MethodResultCallback-api-windows.md new file mode 100644 index 000000000..c4bbb0508 --- /dev/null +++ b/website/versioned_docs/version-0.64/MethodResultCallback-api-windows.md @@ -0,0 +1,19 @@ +--- +id: version-0.64-MethodResultCallback +title: MethodResultCallback +original_id: MethodResultCallback +--- + +Kind: `delegate` + +A callback to call JS code with results. + +## Invoke +void **`Invoke`**([`IJSValueWriter`](IJSValueWriter) outputWriter) + + + + + +## Referenced by +- [`MethodDelegate`](MethodDelegate) diff --git a/website/versioned_docs/version-0.64/QuirkSettings-api-windows.md b/website/versioned_docs/version-0.64/QuirkSettings-api-windows.md new file mode 100644 index 000000000..309bdcb7d --- /dev/null +++ b/website/versioned_docs/version-0.64/QuirkSettings-api-windows.md @@ -0,0 +1,35 @@ +--- +id: version-0.64-QuirkSettings +title: QuirkSettings +original_id: QuirkSettings +--- + +Kind: `class` + + + + +## Constructors +### QuirkSettings + **`QuirkSettings`**() + + + + +## Methods +### SetAcceptSelfSigned +`static` void **`SetAcceptSelfSigned`**([`ReactInstanceSettings`](ReactInstanceSettings) settings, bool value) + + + +### SetMatchAndroidAndIOSStretchBehavior +`static` void **`SetMatchAndroidAndIOSStretchBehavior`**([`ReactInstanceSettings`](ReactInstanceSettings) settings, bool value) + + + +### SetUseLegacyWebSocketModule +`static` void **`SetUseLegacyWebSocketModule`**([`ReactInstanceSettings`](ReactInstanceSettings) settings, bool value) + + + + diff --git a/website/versioned_docs/version-0.64/ReactApplication-api-windows.md b/website/versioned_docs/version-0.64/ReactApplication-api-windows.md new file mode 100644 index 000000000..12144c1da --- /dev/null +++ b/website/versioned_docs/version-0.64/ReactApplication-api-windows.md @@ -0,0 +1,56 @@ +--- +id: version-0.64-ReactApplication +title: ReactApplication +original_id: ReactApplication +--- + +Kind: `class` + +Extends: [`Application`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.Application) + + + +`ReactApplication` provides a base application class for use in applications that are entirely written in React Native. `ReactApplication` will load the React instance on launch of your app for you and provide accessors to your application's [`ReactInstanceSettings`](ReactInstanceSettings) and [`ReactNativeHost`](ReactNativeHost) to customize your React instance. + +## Properties +### Host +`readonly` [`ReactNativeHost`](ReactNativeHost) `Host` + +Access to the [`ReactNativeHost`](ReactNativeHost) of your application. + +### InstanceSettings + [`ReactInstanceSettings`](ReactInstanceSettings) `InstanceSettings` + +Provides access to your application's [`ReactInstanceSettings`](ReactInstanceSettings). Generally, changes to these settings will not take effect if the React instance is already loaded, unless the React instance is reloaded, so most settings should be set in your applications constructor. + +### JavaScriptBundleFile + string `JavaScriptBundleFile` + +See [`ReactInstanceSettings.JavaScriptBundleFile`](ReactInstanceSettings#javascriptbundlefile). + +### JavaScriptMainModuleName + string `JavaScriptMainModuleName` + +> **Deprecated**: Use [`JavaScriptBundleFile`](#javascriptbundlefile) instead + +See [`ReactInstanceSettings.JavaScriptMainModuleName`](ReactInstanceSettings#javascriptmainmodulename). + +### PackageProviders +`readonly` [`IVector`](https://docs.microsoft.com/uwp/api/Windows.Foundation.Collections.IVector-1)<[`IReactPackageProvider`](IReactPackageProvider)> `PackageProviders` + +Provides access to the list of `IReactPackageProvider`'s that the instance will use to provide native modules to the application. This can be used to register additional package providers, such as package providers from community modules. See [`ReactNativeHost`](ReactNativeHost) for more information. + +### UseDeveloperSupport + bool `UseDeveloperSupport` + +Should the developer experience features such as the developer menu and `RedBox` be enabled. See [`ReactInstanceSettings.UseDeveloperSupport`](ReactInstanceSettings#usedevelopersupport). + + +## Constructors +### ReactApplication + **`ReactApplication`**() + + + + + diff --git a/website/versioned_docs/version-0.64/ReactCreatePropertyValue-api-windows.md b/website/versioned_docs/version-0.64/ReactCreatePropertyValue-api-windows.md new file mode 100644 index 000000000..7585ff034 --- /dev/null +++ b/website/versioned_docs/version-0.64/ReactCreatePropertyValue-api-windows.md @@ -0,0 +1,19 @@ +--- +id: version-0.64-ReactCreatePropertyValue +title: ReactCreatePropertyValue +original_id: ReactCreatePropertyValue +--- + +Kind: `delegate` + +This delegate is used to create a property value on-demand. + +## Invoke +Object **`Invoke`**() + + + + + +## Referenced by +- [`IReactPropertyBag`](IReactPropertyBag) diff --git a/website/versioned_docs/version-0.64/ReactDispatcherCallback-api-windows.md b/website/versioned_docs/version-0.64/ReactDispatcherCallback-api-windows.md new file mode 100644 index 000000000..3b3dd0167 --- /dev/null +++ b/website/versioned_docs/version-0.64/ReactDispatcherCallback-api-windows.md @@ -0,0 +1,19 @@ +--- +id: version-0.64-ReactDispatcherCallback +title: ReactDispatcherCallback +original_id: ReactDispatcherCallback +--- + +Kind: `delegate` + +The delegate is used to create property value on-demand. + +## Invoke +void **`Invoke`**() + + + + + +## Referenced by +- [`IReactDispatcher`](IReactDispatcher) diff --git a/website/versioned_docs/version-0.64/ReactInstanceSettings-api-windows.md b/website/versioned_docs/version-0.64/ReactInstanceSettings-api-windows.md new file mode 100644 index 000000000..9600cad91 --- /dev/null +++ b/website/versioned_docs/version-0.64/ReactInstanceSettings-api-windows.md @@ -0,0 +1,180 @@ +--- +id: version-0.64-ReactInstanceSettings +title: ReactInstanceSettings +original_id: ReactInstanceSettings +--- + +Kind: `class` + + + +Provides configuration of the react instance. + +## Properties +### BundleRootPath + string `BundleRootPath` + +**Default value**: `ms-appx:///Bundle/` + +Base path used for the location of the bundle. + +### ByteCodeFileUri + string `ByteCodeFileUri` + +Set this to a location the application has write access to in order for bytecode to be successfully cached. See [`EnableByteCodeCaching`](#enablebytecodecaching). + +### DebugBundlePath + string `DebugBundlePath` + +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`](#javascriptbundlefile) or [`JavaScriptMainModuleName`](#javascriptmainmodulename) is used. + +### DebugHost + string `DebugHost` + +> **Deprecated**: This has been replaced with [`SourceBundleHost`](#sourcebundlehost) and [`SourceBundlePort`](#sourcebundleport) and will be removed in a future version. + +**Default value**: `localhost:8081` + +When using a [`UseFastRefresh`](#usefastrefresh), [`UseLiveReload`](#uselivereload) or [`UseWebDebugger`](#usewebdebugger) this is the server that will be used to load the bundle from. + +### DebuggerBreakOnNextLine + bool `DebuggerBreakOnNextLine` + +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*** + +### DebuggerPort + uint16_t `DebuggerPort` + +**Default value**: `9229` + +When [`UseDirectDebugger`](#usedirectdebugger) is enabled, this controls the port that the JavaScript engine debugger will run on. + +### EnableByteCodeCaching + bool `EnableByteCodeCaching` + +**Default value**: `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`](#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` + +> **Deprecated**: This property has been replaced by [`UseDeveloperSupport`](#usedevelopersupport). In version 0.63 both properties will do the same thing. + +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. + +### EnableJITCompilation + bool `EnableJITCompilation` + +**Default value**: `true` + +Flag controlling whether the JavaScript engine uses JIT compilation. + +### JSIEngineOverride + [`JSIEngine`](JSIEngine) `JSIEngineOverride` + +### JavaScriptBundleFile + string `JavaScriptBundleFile` + +**Default value**: `index.windows` + +The name of the JavaScript bundle file to load. This should be a relative path from [`BundleRootPath`](#bundlerootpath). `.bundle` will be appended to the end, when looking for the bundle file. + +### JavaScriptMainModuleName + string `JavaScriptMainModuleName` + +> **Deprecated**: use JavaScriptBundleFile instead + +Name of the JavaScript bundle file. If [`JavaScriptBundleFile`](#javascriptbundlefile) is specified it is used instead. + +### Notifications +`readonly` [`IReactNotificationService`](IReactNotificationService) `Notifications` + +Provides access to the `IReactNotificationService`, which allows easy communication between custom native modules or view managers. + +### PackageProviders +`readonly` [`IVector`](https://docs.microsoft.com/uwp/api/Windows.Foundation.Collections.IVector-1)<[`IReactPackageProvider`](IReactPackageProvider)> `PackageProviders` + +Provides a list of additional native modules and custom view managers that should be included in the instance. + +### Properties +`readonly` [`IReactPropertyBag`](IReactPropertyBag) `Properties` + +Properties are shared with [`IReactContext.Properties`](IReactContext#properties-1). It can be used to configure and share values and state between components. + +### RedBoxHandler + [`IRedBoxHandler`](IRedBoxHandler) `RedBoxHandler` + +Provides an extension point to allow custom error handling within the react instance. See [`IRedBoxHandler`](IRedBoxHandler) for more information. + +### SourceBundleHost + string `SourceBundleHost` + +**Default value**: `localhost` + +When using a [`UseFastRefresh`](#usefastrefresh), [`UseLiveReload`](#uselivereload) or [`UseWebDebugger`](#usewebdebugger) this is the server hostname that will be used to load the bundle from. + +### SourceBundlePort + uint16_t `SourceBundlePort` + +**Default value**: `8081` + +When using a [`UseFastRefresh`](#usefastrefresh), [`UseLiveReload`](#uselivereload) or [`UseWebDebugger`](#usewebdebugger) this is the server port that will be used to load the bundle from. + +### UIDispatcher + [`IReactDispatcher`](IReactDispatcher) `UIDispatcher` + +Control the main UI dispatcher to be used by the React instance. If the [`ReactInstanceSettings`](ReactInstanceSettings) object is initially created on a UI thread, then this will default to that thread. The value provided here will be available to native modules and view managers using [`IReactContext.UIDispatcher`](IReactContext#uidispatcher) + +### UseDeveloperSupport + bool `UseDeveloperSupport` + +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. + +### UseDirectDebugger + bool `UseDirectDebugger` + +Enables debugging in the JavaScript engine (if supported).
For Chakra this enables you to debug the JS runtime directly within your app using Visual Studio -> Attach to process (Script) + +### UseFastRefresh + bool `UseFastRefresh` + +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](https://reactnative.dev/docs/fast-refresh) for more information on Fast Refresh. + +### UseJsi + bool `UseJsi` + +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.** + +### UseLiveReload + bool `UseLiveReload` + +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`](#usefastrefresh).** + +### UseWebDebugger + bool `UseWebDebugger` + +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. + + +## Constructors +### ReactInstanceSettings + **`ReactInstanceSettings`**() + + + + + +## Events +### `InstanceCreated` +Type: [`InstanceCreatedEventArgs`](InstanceCreatedEventArgs) +### `InstanceDestroyed` +Type: [`InstanceDestroyedEventArgs`](InstanceDestroyedEventArgs) +### `InstanceLoaded` +Type: [`InstanceLoadedEventArgs`](InstanceLoadedEventArgs) + + +## Referenced by +- [`QuirkSettings`](QuirkSettings) +- [`ReactApplication`](ReactApplication) +- [`ReactNativeHost`](ReactNativeHost) diff --git a/website/versioned_docs/version-0.64/ReactModuleProvider-api-windows.md b/website/versioned_docs/version-0.64/ReactModuleProvider-api-windows.md new file mode 100644 index 000000000..1ae574a56 --- /dev/null +++ b/website/versioned_docs/version-0.64/ReactModuleProvider-api-windows.md @@ -0,0 +1,20 @@ +--- +id: version-0.64-ReactModuleProvider +title: ReactModuleProvider +original_id: ReactModuleProvider +--- + +Kind: `delegate` + +Provides information about a custom native module. See [`IReactModuleBuilder`](IReactModuleBuilder). + +## Invoke +Object **`Invoke`**([`IReactModuleBuilder`](IReactModuleBuilder) moduleBuilder) + + + + + +## Referenced by +- [`IReactPackageBuilder`](IReactPackageBuilder) +- [`IReactPackageBuilderExperimental`](IReactPackageBuilderExperimental) diff --git a/website/versioned_docs/version-0.64/ReactNativeHost-api-windows.md b/website/versioned_docs/version-0.64/ReactNativeHost-api-windows.md new file mode 100644 index 000000000..4dee5113a --- /dev/null +++ b/website/versioned_docs/version-0.64/ReactNativeHost-api-windows.md @@ -0,0 +1,61 @@ +--- +id: version-0.64-ReactNativeHost +title: ReactNativeHost +original_id: ReactNativeHost +--- + +Kind: `class` + + + +This is the main entry-point to create a react-native instance. The `ReactNativeHost` object exists to configure the instance using [`ReactInstanceSettings`](ReactInstanceSettings) before its loaded, as well as enabling control of when to load the instance.
_In the future more lifecycle events will be added to this object to provide better information on when an instance is loaded and unloaded._ + +## Properties +### InstanceSettings + [`ReactInstanceSettings`](ReactInstanceSettings) `InstanceSettings` + +Provides access to your this host's [`ReactInstanceSettings`](ReactInstanceSettings) to configure the react instance. + +### PackageProviders +`readonly` [`IVector`](https://docs.microsoft.com/uwp/api/Windows.Foundation.Collections.IVector-1)<[`IReactPackageProvider`](IReactPackageProvider)> `PackageProviders` + +Provides access to the list of `IReactPackageProvider`'s that the react instance will use to provide native modules to the application. This can be used to register additional package providers, such as package providers from community modules or other shared libraries + + +## Constructors +### ReactNativeHost + **`ReactNativeHost`**() + + + + +## Methods +### FromContext +`static` [`ReactNativeHost`](ReactNativeHost) **`FromContext`**([`IReactContext`](IReactContext) reactContext) + + + +### LoadInstance +[`IAsyncAction`](https://docs.microsoft.com/uwp/api/Windows.Foundation.IAsyncAction) **`LoadInstance`**() + + + +### ReloadInstance +[`IAsyncAction`](https://docs.microsoft.com/uwp/api/Windows.Foundation.IAsyncAction) **`ReloadInstance`**() + +This is used to load the instance, which will create an instance of the JS engine and launch your JavaScript code. If an instance of this host is already running, this will shutdown the already running instance, and load a new instance. + + + +### UnloadInstance +[`IAsyncAction`](https://docs.microsoft.com/uwp/api/Windows.Foundation.IAsyncAction) **`UnloadInstance`**() + + + + + + +## Referenced by +- [`ReactApplication`](ReactApplication) +- [`ReactRootView`](ReactRootView) +- [`RedBoxHelper`](RedBoxHelper) diff --git a/website/versioned_docs/version-0.64/ReactNotificationServiceHelper-api-windows.md b/website/versioned_docs/version-0.64/ReactNotificationServiceHelper-api-windows.md new file mode 100644 index 000000000..e1f644afb --- /dev/null +++ b/website/versioned_docs/version-0.64/ReactNotificationServiceHelper-api-windows.md @@ -0,0 +1,23 @@ +--- +id: version-0.64-ReactNotificationServiceHelper +title: ReactNotificationServiceHelper +original_id: ReactNotificationServiceHelper +--- + +Kind: `class` + + + +Helper methods for the notification service implementation. + + + +## Methods +### CreateNotificationService +`static` [`IReactNotificationService`](IReactNotificationService) **`CreateNotificationService`**() + +Create new instance of IReactNotificationService + + + + diff --git a/website/versioned_docs/version-0.64/ReactRootView-api-windows.md b/website/versioned_docs/version-0.64/ReactRootView-api-windows.md new file mode 100644 index 000000000..e7f6d0c24 --- /dev/null +++ b/website/versioned_docs/version-0.64/ReactRootView-api-windows.md @@ -0,0 +1,40 @@ +--- +id: version-0.64-ReactRootView +title: ReactRootView +original_id: ReactRootView +--- + +Kind: `class` + +Extends: [`Grid`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.Controls.Grid) + + + +## Properties +### ComponentName + string `ComponentName` + +### InitialProps + [`JSValueArgWriter`](JSValueArgWriter) `InitialProps` + +### IsPerspectiveEnabled + bool `IsPerspectiveEnabled` + +### ReactNativeHost + [`ReactNativeHost`](ReactNativeHost) `ReactNativeHost` + + +## Constructors +### ReactRootView + **`ReactRootView`**() + + + + +## Methods +### ReloadView +void **`ReloadView`**() + + + + diff --git a/website/versioned_docs/version-0.64/ReactViewManagerProvider-api-windows.md b/website/versioned_docs/version-0.64/ReactViewManagerProvider-api-windows.md new file mode 100644 index 000000000..506a081aa --- /dev/null +++ b/website/versioned_docs/version-0.64/ReactViewManagerProvider-api-windows.md @@ -0,0 +1,19 @@ +--- +id: version-0.64-ReactViewManagerProvider +title: ReactViewManagerProvider +original_id: ReactViewManagerProvider +--- + +Kind: `delegate` + +Provides information about a custom view manager. See [`IViewManager`](IViewManager). + +## Invoke +[`IViewManager`](IViewManager) **`Invoke`**() + + + + + +## Referenced by +- [`IReactPackageBuilder`](IReactPackageBuilder) diff --git a/website/versioned_docs/version-0.64/RedBoxErrorType-api-windows.md b/website/versioned_docs/version-0.64/RedBoxErrorType-api-windows.md new file mode 100644 index 000000000..773aac42d --- /dev/null +++ b/website/versioned_docs/version-0.64/RedBoxErrorType-api-windows.md @@ -0,0 +1,17 @@ +--- +id: version-0.64-RedBoxErrorType +title: RedBoxErrorType +original_id: RedBoxErrorType +--- + +Kind: `enum` + +| Name | Value | Description | +|--|--|--| +|`JavaScriptFatal` | 0x0 | A JS Exception was thrown and not caught or otherwise fatal error| +|`JavaScriptSoft` | 0x1 | An error coming from JS that isn't fatal, such as `console.error`| +|`Native` | 0x2 | An error happened in native code| + + +## Referenced by +- [`IRedBoxHandler`](IRedBoxHandler) diff --git a/website/versioned_docs/version-0.64/RedBoxHelper-api-windows.md b/website/versioned_docs/version-0.64/RedBoxHelper-api-windows.md new file mode 100644 index 000000000..0fe7fc29a --- /dev/null +++ b/website/versioned_docs/version-0.64/RedBoxHelper-api-windows.md @@ -0,0 +1,27 @@ +--- +id: version-0.64-RedBoxHelper +title: RedBoxHelper +original_id: RedBoxHelper +--- + +Kind: `class` + + + + +## Constructors +### RedBoxHelper + **`RedBoxHelper`**() + + + + +## Methods +### CreateDefaultHandler +`static` [`IRedBoxHandler`](IRedBoxHandler) **`CreateDefaultHandler`**([`ReactNativeHost`](ReactNativeHost) host) + +This provides access to the default [`IRedBoxHandler`](IRedBoxHandler). This can be used to display the default `RedBox` as part of a custom `RedBoxHandler` implementation. + + + + diff --git a/website/versioned_docs/version-0.64/SyncMethodDelegate-api-windows.md b/website/versioned_docs/version-0.64/SyncMethodDelegate-api-windows.md new file mode 100644 index 000000000..d8d074172 --- /dev/null +++ b/website/versioned_docs/version-0.64/SyncMethodDelegate-api-windows.md @@ -0,0 +1,19 @@ +--- +id: version-0.64-SyncMethodDelegate +title: SyncMethodDelegate +original_id: SyncMethodDelegate +--- + +Kind: `delegate` + +A delegate to call native synchronous method. + +## Invoke +void **`Invoke`**([`IJSValueReader`](IJSValueReader) inputReader, [`IJSValueWriter`](IJSValueWriter) outputWriter) + + + + + +## Referenced by +- [`IReactModuleBuilder`](IReactModuleBuilder) diff --git a/website/versioned_docs/version-0.64/XamlMetaDataProvider-api-windows.md b/website/versioned_docs/version-0.64/XamlMetaDataProvider-api-windows.md new file mode 100644 index 000000000..42bd75058 --- /dev/null +++ b/website/versioned_docs/version-0.64/XamlMetaDataProvider-api-windows.md @@ -0,0 +1,35 @@ +--- +id: version-0.64-XamlMetaDataProvider +title: XamlMetaDataProvider +original_id: XamlMetaDataProvider +--- + +Kind: `class` + +Implements: [`IXamlMetadataProvider`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.Markup.IXamlMetadataProvider) + + +## Constructors +### XamlMetaDataProvider + **`XamlMetaDataProvider`**() + + + + +## Methods +### GetXamlType +[`IXamlType`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.Markup.IXamlType) **`GetXamlType`**([`TypeName`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.Interop.TypeName) type) + + + +### GetXamlType +[`IXamlType`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.Markup.IXamlType) **`GetXamlType`**(string fullName) + + + +### GetXmlnsDefinitions +[`XmlnsDefinition`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.Markup.XmlnsDefinition) **`GetXmlnsDefinitions`**() + + + + diff --git a/website/versioned_docs/version-0.64/XamlUIService-api-windows.md b/website/versioned_docs/version-0.64/XamlUIService-api-windows.md new file mode 100644 index 000000000..58187b432 --- /dev/null +++ b/website/versioned_docs/version-0.64/XamlUIService-api-windows.md @@ -0,0 +1,47 @@ +--- +id: version-0.64-XamlUIService +title: XamlUIService +original_id: XamlUIService +--- + +Kind: `class` + + + +Provides access to XAML UI-specific functionality. It provides access to APIs to get a XAML element from a react tag, and to dispatch events to JS components. + + + +## Methods +### DispatchEvent +void **`DispatchEvent`**([`FrameworkElement`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.FrameworkElement) view, string eventName, [`JSValueArgWriter`](JSValueArgWriter) eventDataArgWriter) + +Dispatch an event to a JS component. + + + +### ElementFromReactTag +[`DependencyObject`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.DependencyObject) **`ElementFromReactTag`**(int64_t reactTag) + +Get the backing XAML element from a react tag. + + + +### FromContext +`static` [`XamlUIService`](XamlUIService) **`FromContext`**([`IReactContext`](IReactContext) context) + +Use this method to gain access to the `XamlUIService` from a `ReactContext`. + + + +### GetXamlRoot +`static` [`XamlRoot`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.XamlRoot) **`GetXamlRoot`**([`IReactPropertyBag`](IReactPropertyBag) properties) + + + +### SetXamlRoot +`static` void **`SetXamlRoot`**([`IReactPropertyBag`](IReactPropertyBag) properties, [`XamlRoot`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.XamlRoot) xamlRoot) + + + + diff --git a/website/versioned_docs/version-0.64/apptheme-api-windows.md b/website/versioned_docs/version-0.64/apptheme-api-windows.md new file mode 100644 index 000000000..53818ae49 --- /dev/null +++ b/website/versioned_docs/version-0.64/apptheme-api-windows.md @@ -0,0 +1,84 @@ +--- +id: version-0.64-apptheme-api +title: AppTheme +original_id: apptheme-api +--- + +> This API name is deprecated. Use react-native's [``Appearance``](https://reactnative.dev/docs/appearance) API instead. + +`AppTheme` allows you to detect Windows app theme changes - dark, light or high contrast - as well as which theme the app is in and the theme colors being used when in high contrast mode. + +``` +import { AppTheme } from 'react-native-windows' + +const App = class App extends React.Component { + state = { + currentTheme: AppTheme.currentTheme + } + + componentDidMount() { + AppTheme.addListener("appThemeChanged", this.onAppThemeChanged); + } + + componentWillUnmount() { + AppTheme.removeListener("appThemeChanged", this.onAppThemeChanged); + } + + onAppThemeChanged = (event) => { + const currentTheme = AppTheme.currentTheme; + this.setState({currentTheme}); + }; + + render() { + return ( +