diff --git a/.github/scripts/UpdateNativeApiDocs.ps1 b/.github/scripts/UpdateNativeApiDocs.ps1 new file mode 100644 index 000000000..3de1af771 --- /dev/null +++ b/.github/scripts/UpdateNativeApiDocs.ps1 @@ -0,0 +1,231 @@ +# +# UpdateNativeApiDocs.ps1 is a PowerShell script designed to download the +# API docs from the specified RNW CI build in ADO and integrate them into +# our docs folder, properly tagged with New/Old architecture tags + +param( + [Parameter(Mandatory=$true)] + [int]$BuildId, + [boolean]$Clean = $True +) + +Function Download-BuildArtifact([int]$BuildId, [string] $ArtifactName, [string]$DestPath = $env:TEMP) +{ + Write-Host "Downloading `"$ArtifactName`" from build $BuildId" + [string]$ArtifactUrl = "https://dev.azure.com/ms/8d8e50dd-c5b4-4b44-8668-86558c5aa5b7/_apis/build/builds/$BuildId/artifacts?artifactName=$ArtifactName&api-version=7.1&%24format=zip" + [string]$ArtifactZipFile = Join-Path $DestPath "$ArtifactName.zip" + + Write-Debug "Downloading `"$ArtifactUrl`"" + Invoke-WebRequest $ArtifactUrl -OutFile $ArtifactZipFile + + Write-Debug "Extracting `"$ArtifactZipFile`"" + Expand-Archive -LiteralPath $ArtifactZipFile -DestinationPath $DestPath -Force + + [string]$ExtractedPath = Join-Path $DestPath $ArtifactName + + Write-Debug "Artifact extracted to `"$ExtractedPath`"" + return $ExtractedPath +} + +Function Create-WinRtApiDocWithBadge([string]$SourceDocPath, [string]$DestDocPath, [string]$BadgeMd) +{ + Write-Host "Creating `"$DestDocPath`"" + + # Load content + $Content = (Get-Content $SourceDocPath -Raw) + + # Add Badge + $Content = $Content -replace "---\r\n\r\n", "---`r`n`r`n$($BadgeMd)`r`n`r`n" + + # Clean up spacing + $Content = $Content -replace "(\r\n){3,}", "`r`n`r`n" + + # Fix links + $Content = $Content -replace "https://docs.microsoft.com/uwp/api/Windows.UI.Xaml", "https://learn.microsoft.com/uwp/api/Windows.UI.Xaml" # Workaround for https://github.com/asklar/winmd2md/issues/8 + $Content = $Content -replace "https://docs.microsoft.com/uwp/api/Microsoft.UI", "https://learn.microsoft.com/windows/windows-app-sdk/api/winrt/Microsoft.UI" # Workaround for https://github.com/asklar/winmd2md/issues/7 + $Content = $Content -replace "https://docs.microsoft.com/uwp/api/Microsoft.ReactNative\.(\w+\.)*(\w+)", '$2' # Workaround for https://github.com/asklar/winmd2md/issues/9 + + $Content = $Content.Trim() + + # Write final file + $Content | Out-File -Encoding utf8NoBOM $DestDocPath +} + +Function Get-DocKind([string]$DocPath) { + [string]$Kind = "unknown" + $KindMatches = ((Get-Content $DocPath -Raw) | Select-String -Pattern 'Kind: `(\w+)`').Matches + if (($KindMatches.Length -gt 0) -and ($KindMatches[0].Groups.Length -gt 1)) { + $Kind = $KindMatches[0].Groups[1] + } + return $Kind +} + +Function Merge-WinRtApiDocs([string]$OldArchDocsPath, [string]$NewArchDocsPath, [string]$RepoRoot, [boolean]$Clean) +{ + Write-Host "Merging WinRT API docs" + + [string]$NewAndOldArchBadgeMd = "![Architecture](https://img.shields.io/badge/architecture-new_&_old-green)" + [string]$NewArchOnlyBadgeMd = "![Architecture](https://img.shields.io/badge/architecture-new_only-blue)" + [string]$OldArchOnlyBadgeMd = "![Architecture](https://img.shields.io/badge/architecture-old_only-yellow)" + + $OldArchFiles = Get-ChildItem -Path $OldArchDocsPath -File -Filter *.md + $NewArchFiles = Get-ChildItem -Path $NewArchDocsPath -File -Filter *.md + + $AllFilesSet = New-Object System.Collections.Generic.HashSet[string]; + $($OldArchFiles; $NewArchFiles) | ForEach-Object { $AllFilesSet.Add($_.Name) | Out-Null } + + $AllTypesByKind = @{} + + [string]$OutputDocsPath = Join-Path $RepoRoot "docs/native-api" + + if ($Clean) { + Write-Debug "Cleaning `"$OutputDocsPath`"" + Remove-Item -Path $OutputDocsPath -Recurse -Force + } + New-Item $OutputDocsPath -ItemType "Directory" | Out-Null + + # Find and process docs that are Old Arch Only + Compare-Object $OldArchFiles $NewArchFiles -Property Name | Where-Object { $_.SideIndicator -eq "<=" } | + ForEach-Object { + Write-Debug "Old Arch Only: $($_.Name)" + Create-WinRtApiDocWithBadge -SourceDocPath (Join-Path $OldArchDocsPath $_.Name) -DestDocPath (Join-Path $OutputDocsPath $_.Name) -BadgeMd $OldArchOnlyBadgeMd + if ($AllFilesSet.Remove($_.Name)) { + $Kind = Get-DocKind -DocPath (Join-Path $OutputDocsPath $_.Name) + if ($AllTypesByKind[$Kind] -eq $Null) { $AllTypesByKind[$Kind] = @() } + $AllTypesByKind[$Kind] += $_.Name.Replace("-api-windows.md", "") + } + } + + # Find and process docs that are New Arch Only + Compare-Object $NewArchFiles $OldArchFiles -Property Name | Where-Object { $_.SideIndicator -eq "<=" } | + ForEach-Object { + Write-Debug "New Arch Only: $($_.Name)" + Create-WinRtApiDocWithBadge -SourceDocPath (Join-Path $NewArchDocsPath $_.Name) -DestDocPath (Join-Path $OutputDocsPath $_.Name) -BadgeMd $NewArchOnlyBadgeMd + if ($AllFilesSet.Remove($_.Name)) { + $Kind = Get-DocKind -DocPath (Join-Path $OutputDocsPath $_.Name) + if ($AllTypesByKind[$Kind] -eq $Null) { $AllTypesByKind[$Kind] = @() } + $AllTypesByKind[$Kind] += $_.Name.Replace("-api-windows.md", "") + } + } + + # Process remaining docs are both Old and New Arch + $AllFilesSet | + ForEach-Object { + Write-Debug "Old&New Arch: $_" + $OldContent = (Get-Content (Join-Path $OldArchDocsPath $_) -Raw) + $NewContent = (Get-Content (Join-Path $NewArchDocsPath $_) -Raw) + if ($OldContent -eq $NewContent) + { + Write-Debug "Same Content: $_" + Create-WinRtApiDocWithBadge -SourceDocPath (Join-Path $OldArchDocsPath $_) -DestDocPath (Join-Path $OutputDocsPath $_) -BadgeMd $NewAndOldArchBadgeMd + } + else + { + Write-Debug "Diff Content: $_" + $MergedFilePath = (Join-Path $DownloadPath $_) + + $NewContent = $NewContent -replace "---\r\n\r\n", "---`r`n`r`n# New Architecture`r`n`r`n" + $NewContent = $NewContent -replace "\r\n#", "`r`n##" + + $OldContent = $OldContent -replace "---(.*\r\n){1,}---\r\n\r\n", "`r`n`r`n# Old Architecture`r`n`r`n" + $OldContent = $OldContent -replace "\r\n#", "`r`n##" + + ($NewContent + $OldContent) | Out-File -Encoding utf8NoBOM -NoNewline $MergedFilePath + Create-WinRtApiDocWithBadge -SourceDocPath $MergedFilePath -DestDocPath (Join-Path $OutputDocsPath $_) -BadgeMd $NewAndOldArchBadgeMd + } + $Kind = Get-DocKind -DocPath (Join-Path $OutputDocsPath $_) + if ($AllTypesByKind[$Kind] -eq $Null) { $AllTypesByKind[$Kind] = @() } + $AllTypesByKind[$Kind] += $_.Replace("-api-windows.md", "") + } + + # Clean up links to enum type values (workaround for https://github.com/asklar/winmd2md/issues/10) + (Get-ChildItem -Path $OutputDocsPath -File -Filter *-api-windows.md) | ForEach-Object { + $FilePath = $_ + $FileContent = (Get-Content $FilePath -Raw) + $AllTypesByKind['enum'] | ForEach-Object { + $FileContent = $FileContent -replace "\($_#\w+\)", "($_)" + } + $FileContent | Out-File -Encoding utf8NoBOM -NoNewLine $FilePath + } + + # Recreate index (workaround for https://github.com/asklar/winmd2md/issues/10) + [string]$IndexContent = "" + $IndexContent += "---`r`n" + $IndexContent += "id: Native-API-Reference`r`n" + $IndexContent += "title: Microsoft.ReactNative APIs`r`n" + $IndexContent += "---`r`n" + $IndexContent += "`r`n" + $IndexContent += $NewAndOldArchBadgeMd + "`r`n" + $IndexContent += "`r`n" + + $AllTypesByKind.Keys | Where-Object { $_ -ne 'unknown' } | Sort-Object | ForEach-Object { + $IndexContent += "## $($_.Substring(0,1).ToUpper())$($_.Substring(1))$($_.EndsWith("s") ? "es" : "s")`r`n" + $AllTypesByKind[$_] | Sort-Object | ForEach-Object { + $IndexContent += "- [$_]($_)`r`n" + } + $IndexContent += "`r`n" + } + + $IndexContent = $IndexContent.Trim() + + $IndexPath = (Join-Path $OutputDocsPath "index-api-windows.md") + + Write-Host "Creating `"$IndexPath`"" + $IndexContent | Out-File -Encoding utf8NoBOM $IndexPath + + # Update sidebar + $SidebarsFile = Join-Path $RepoRoot "website/sidebars.json" + $SidebarsJson = Get-Content -Path $SidebarsFile -Raw | ConvertFrom-Json + $NativeApiEntries = @() + + $NativeApiEntries += "native-api/Native-API-Reference" + + $AllTypesByKind.Keys | Where-Object { $_ -ne 'unknown' } | Sort-Object | ForEach-Object { + $KindObject = @{} + $KindObject['type'] = 'subcategory' + $KindObject['label'] = "$($_.Substring(0,1).ToUpper())$($_.Substring(1))$($_.EndsWith("s") ? "es" : "s")" + $KindObject['ids'] = @() + $AllTypesByKind[$_] | Sort-Object | ForEach-Object { + $KindObject['ids'] += "native-api/$_" + } + $NativeApiEntries += $KindObject + } + + $SidebarsJson.apis."Native API (Windows)" = $NativeApiEntries + + Write-Host "Updating `"$SidebarsFile`"" + $SidebarsJson | ConvertTo-Json -Depth 4 | Set-Content -Path $SidebarsFile +} + +[string] $RepoRoot = Resolve-Path "$PSScriptRoot/../.." + +$StartingLocation = Get-Location +Set-Location -Path $RepoRoot + +try +{ + Write-Host "UpdateNativeApiDocs -BuildId $BuildId" + + $DownloadPath = Join-Path $env:TEMP "UpdateNativeApiDocs-$BuildId" + Write-Debug "Downloading artifacts to `"$DownloadPath`"" + if (Test-Path $DownloadPath) + { + Write-Debug "Deleting existing `"$DownloadPath`"" + Remove-Item -Path $DownloadPath -Recurse -Force + } + + Write-Debug "Creating new `"$DownloadPath`"" + New-Item $DownloadPath -ItemType "Directory" | Out-Null + + Write-Debug "Downloading WinRT API docs from $BuildId" + [string]$OldArchDocsPath = Download-BuildArtifact -BuildId $BuildId -ArtifactName "WinRT Api docs - Universal Build X64Debug-1" -DestPath $DownloadPath + [string]$NewArchDocsPath = Download-BuildArtifact -BuildId $BuildId -ArtifactName "WinRT Api docs - Universal Build X64DebugFabric-1" -DestPath $DownloadPath + + Merge-WinRtApiDocs -OldArchDocsPath $OldArchDocsPath -NewArchDocsPath $NewArchDocsPath -RepoRoot $RepoRoot -Clean $Clean +} +finally +{ + Set-Location -Path $StartingLocation +} + +exit 0 diff --git a/docs/customizing-SDK-versions.md b/docs/customizing-SDK-versions.md index 27c2af7c1..25a55009f 100644 --- a/docs/customizing-SDK-versions.md +++ b/docs/customizing-SDK-versions.md @@ -1,5 +1,5 @@ --- -id: customizing-sdk-versions +id: customizing-SDK-versions title: Customizing SDK versions --- diff --git a/docs/native-api/AccessibilityAction-api-windows.md b/docs/native-api/AccessibilityAction-api-windows.md index d01d8dcce..4324975ef 100644 --- a/docs/native-api/AccessibilityAction-api-windows.md +++ b/docs/native-api/AccessibilityAction-api-windows.md @@ -3,6 +3,8 @@ id: AccessibilityAction title: AccessibilityAction --- +![Architecture](https://img.shields.io/badge/architecture-old_only-yellow) + Kind: `struct` ## Fields @@ -12,7 +14,5 @@ Type: `string` ### Name Type: `string` - - ## Referenced by - [`AccessibilityActionEventHandler`](AccessibilityActionEventHandler) diff --git a/docs/native-api/AccessibilityActionEventHandler-api-windows.md b/docs/native-api/AccessibilityActionEventHandler-api-windows.md index 4db79b90e..bac395316 100644 --- a/docs/native-api/AccessibilityActionEventHandler-api-windows.md +++ b/docs/native-api/AccessibilityActionEventHandler-api-windows.md @@ -3,14 +3,12 @@ id: AccessibilityActionEventHandler title: AccessibilityActionEventHandler --- +![Architecture](https://img.shields.io/badge/architecture-old_only-yellow) + Kind: `delegate` ## Invoke void **`Invoke`**([`AccessibilityAction`](AccessibilityAction) action) - - - - ## Referenced by - [`DynamicAutomationProperties`](DynamicAutomationProperties) diff --git a/docs/native-api/AccessibilityInvokeEventHandler-api-windows.md b/docs/native-api/AccessibilityInvokeEventHandler-api-windows.md index f324f52b2..366c0034b 100644 --- a/docs/native-api/AccessibilityInvokeEventHandler-api-windows.md +++ b/docs/native-api/AccessibilityInvokeEventHandler-api-windows.md @@ -3,14 +3,12 @@ id: AccessibilityInvokeEventHandler title: AccessibilityInvokeEventHandler --- +![Architecture](https://img.shields.io/badge/architecture-old_only-yellow) + Kind: `delegate` ## Invoke void **`Invoke`**() - - - - ## Referenced by - [`DynamicAutomationProperties`](DynamicAutomationProperties) diff --git a/docs/native-api/AccessibilityRoles-api-windows.md b/docs/native-api/AccessibilityRoles-api-windows.md index dea64869b..6c7153c2b 100644 --- a/docs/native-api/AccessibilityRoles-api-windows.md +++ b/docs/native-api/AccessibilityRoles-api-windows.md @@ -3,6 +3,8 @@ id: AccessibilityRoles title: AccessibilityRoles --- +![Architecture](https://img.shields.io/badge/architecture-old_only-yellow) + Kind: `enum` | Name | Value | Description | @@ -40,6 +42,5 @@ Kind: `enum` |`Unknown` | 0x1e | | |`CountRoles` | 0x1f | | - ## Referenced by - [`DynamicAutomationProperties`](DynamicAutomationProperties) diff --git a/docs/native-api/AccessibilityStateCheckedValue-api-windows.md b/docs/native-api/AccessibilityStateCheckedValue-api-windows.md index 7202d535c..004c96b61 100644 --- a/docs/native-api/AccessibilityStateCheckedValue-api-windows.md +++ b/docs/native-api/AccessibilityStateCheckedValue-api-windows.md @@ -3,6 +3,8 @@ id: AccessibilityStateCheckedValue title: AccessibilityStateCheckedValue --- +![Architecture](https://img.shields.io/badge/architecture-old_only-yellow) + Kind: `enum` | Name | Value | Description | @@ -11,6 +13,5 @@ Kind: `enum` |`Checked` | 0x1 | | |`Mixed` | 0x2 | | - ## Referenced by - [`DynamicAutomationProperties`](DynamicAutomationProperties) diff --git a/docs/native-api/AccessibilityStates-api-windows.md b/docs/native-api/AccessibilityStates-api-windows.md index de1cf994e..17542a74e 100644 --- a/docs/native-api/AccessibilityStates-api-windows.md +++ b/docs/native-api/AccessibilityStates-api-windows.md @@ -3,6 +3,8 @@ id: AccessibilityStates title: AccessibilityStates --- +![Architecture](https://img.shields.io/badge/architecture-old_only-yellow) + Kind: `enum` | Name | Value | Description | diff --git a/docs/native-api/AccessibilityValue-api-windows.md b/docs/native-api/AccessibilityValue-api-windows.md index 5598cf818..e97cd0f97 100644 --- a/docs/native-api/AccessibilityValue-api-windows.md +++ b/docs/native-api/AccessibilityValue-api-windows.md @@ -3,6 +3,8 @@ id: AccessibilityValue title: AccessibilityValue --- +![Architecture](https://img.shields.io/badge/architecture-old_only-yellow) + Kind: `enum` | Name | Value | Description | diff --git a/docs/native-api/ActivityIndicatorComponentView-api-windows.md b/docs/native-api/ActivityIndicatorComponentView-api-windows.md new file mode 100644 index 000000000..affa75224 --- /dev/null +++ b/docs/native-api/ActivityIndicatorComponentView-api-windows.md @@ -0,0 +1,12 @@ +--- +id: ActivityIndicatorComponentView +title: ActivityIndicatorComponentView +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `class` + +Extends: [`ViewComponentView`](ViewComponentView) + +> **EXPERIMENTAL** diff --git a/docs/native-api/AnimationClass-api-windows.md b/docs/native-api/AnimationClass-api-windows.md new file mode 100644 index 000000000..9dcae6ed8 --- /dev/null +++ b/docs/native-api/AnimationClass-api-windows.md @@ -0,0 +1,19 @@ +--- +id: AnimationClass +title: AnimationClass +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `enum` + +| Name | Value | Description | +|--|--|--| +|`None` | 0x0 | | +|`ScrollBar` | 0x1 | | +|`ScrollBarThumbHorizontal` | 0x2 | | +|`ScrollBarThumbVertical` | 0x3 | | +|`SwitchThumb` | 0x4 | | + +## Referenced by +- [`IVisual`](IVisual) diff --git a/docs/native-api/AriaRole-api-windows.md b/docs/native-api/AriaRole-api-windows.md index b07d39888..745d2f452 100644 --- a/docs/native-api/AriaRole-api-windows.md +++ b/docs/native-api/AriaRole-api-windows.md @@ -3,6 +3,8 @@ id: AriaRole title: AriaRole --- +![Architecture](https://img.shields.io/badge/architecture-old_only-yellow) + Kind: `enum` | Name | Value | Description | @@ -75,6 +77,5 @@ Kind: `enum` |`TreeItem` | 0x41 | | |`CountRoles` | 0x42 | | - ## Referenced by - [`DynamicAutomationProperties`](DynamicAutomationProperties) diff --git a/docs/native-api/BackNavigationHandlerKind-api-windows.md b/docs/native-api/BackNavigationHandlerKind-api-windows.md index 843f468ef..05ade305e 100644 --- a/docs/native-api/BackNavigationHandlerKind-api-windows.md +++ b/docs/native-api/BackNavigationHandlerKind-api-windows.md @@ -3,6 +3,8 @@ id: BackNavigationHandlerKind title: BackNavigationHandlerKind --- +![Architecture](https://img.shields.io/badge/architecture-new_&_old-green) + Kind: `enum` | Name | Value | Description | @@ -10,6 +12,5 @@ Kind: `enum` |`JavaScript` | 0x0 | | |`Native` | 0x1 | | - ## Referenced by - [`QuirkSettings`](QuirkSettings) diff --git a/docs/native-api/BackfaceVisibility-api-windows.md b/docs/native-api/BackfaceVisibility-api-windows.md new file mode 100644 index 000000000..c05c89138 --- /dev/null +++ b/docs/native-api/BackfaceVisibility-api-windows.md @@ -0,0 +1,17 @@ +--- +id: BackfaceVisibility +title: BackfaceVisibility +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `enum` + +| Name | Value | Description | +|--|--|--| +|`Inherit` | 0x0 | | +|`Visible` | 0x1 | | +|`Hidden` | 0x2 | | + +## Referenced by +- [`IVisual`](IVisual) diff --git a/docs/native-api/BorderEffect-api-windows.md b/docs/native-api/BorderEffect-api-windows.md index 7e77fd7df..83a4794f2 100644 --- a/docs/native-api/BorderEffect-api-windows.md +++ b/docs/native-api/BorderEffect-api-windows.md @@ -3,6 +3,8 @@ id: BorderEffect title: BorderEffect --- +![Architecture](https://img.shields.io/badge/architecture-old_only-yellow) + Kind: `class` Implements: [`IGraphicsEffect`](https://docs.microsoft.com/uwp/api/Windows.Graphics.Effects.IGraphicsEffect), [`IGraphicsEffectSource`](https://docs.microsoft.com/uwp/api/Windows.Graphics.Effects.IGraphicsEffectSource) @@ -19,7 +21,3 @@ Implements: [`IGraphicsEffect`](https://docs.microsoft.com/uwp/api/Windows.Graph ### Source [`IGraphicsEffectSource`](https://docs.microsoft.com/uwp/api/Windows.Graphics.Effects.IGraphicsEffectSource) `Source` - - - - diff --git a/docs/native-api/CallFunc-api-windows.md b/docs/native-api/CallFunc-api-windows.md new file mode 100644 index 000000000..8970eb255 --- /dev/null +++ b/docs/native-api/CallFunc-api-windows.md @@ -0,0 +1,16 @@ +--- +id: CallFunc +title: CallFunc +--- + +![Architecture](https://img.shields.io/badge/architecture-new_&_old-green) + +Kind: `delegate` + +Function that acts on a JsiRuntime, provided as the argument to the function. ABI safe version of facebook::react::CallFunc in CallInvoker.h. Most direct usage of this should be avoided by using ReactContext.CallInvoker. + +## Invoke +void **`Invoke`**(Object runtime) + +## Referenced by +- [`CallInvoker`](CallInvoker) diff --git a/docs/native-api/CallInvoker-api-windows.md b/docs/native-api/CallInvoker-api-windows.md new file mode 100644 index 000000000..0f7e8c9ab --- /dev/null +++ b/docs/native-api/CallInvoker-api-windows.md @@ -0,0 +1,20 @@ +--- +id: CallInvoker +title: CallInvoker +--- + +![Architecture](https://img.shields.io/badge/architecture-new_&_old-green) + +Kind: `class` + +CallInvoker used to access the jsi runtime. Most direct usage of this should be avoided by using ReactContext.CallInvoker. + +## Methods +### InvokeAsync +void **`InvokeAsync`**([`CallFunc`](CallFunc) func) + +### InvokeSync +void **`InvokeSync`**([`CallFunc`](CallFunc) func) + +## Referenced by +- [`IReactContext`](IReactContext) diff --git a/docs/native-api/CanvasComposite-api-windows.md b/docs/native-api/CanvasComposite-api-windows.md index 25972ee7b..6b36bb50e 100644 --- a/docs/native-api/CanvasComposite-api-windows.md +++ b/docs/native-api/CanvasComposite-api-windows.md @@ -3,6 +3,8 @@ id: CanvasComposite title: CanvasComposite --- +![Architecture](https://img.shields.io/badge/architecture-old_only-yellow) + Kind: `enum` | Name | Value | Description | @@ -21,6 +23,5 @@ Kind: `enum` |`BoundedCopy` | 0xb | | |`MaskInvert` | 0xc | | - ## Referenced by - [`CompositeStepEffect`](CompositeStepEffect) diff --git a/docs/native-api/CanvasEdgeBehavior-api-windows.md b/docs/native-api/CanvasEdgeBehavior-api-windows.md index 12b0fc60b..247adf565 100644 --- a/docs/native-api/CanvasEdgeBehavior-api-windows.md +++ b/docs/native-api/CanvasEdgeBehavior-api-windows.md @@ -3,6 +3,8 @@ id: CanvasEdgeBehavior title: CanvasEdgeBehavior --- +![Architecture](https://img.shields.io/badge/architecture-old_only-yellow) + Kind: `enum` | Name | Value | Description | @@ -11,6 +13,5 @@ Kind: `enum` |`Wrap` | 0x1 | | |`Mirror` | 0x2 | | - ## Referenced by - [`BorderEffect`](BorderEffect) diff --git a/docs/native-api/CharacterReceivedRoutedEventArgs-api-windows.md b/docs/native-api/CharacterReceivedRoutedEventArgs-api-windows.md new file mode 100644 index 000000000..2b455906d --- /dev/null +++ b/docs/native-api/CharacterReceivedRoutedEventArgs-api-windows.md @@ -0,0 +1,26 @@ +--- +id: CharacterReceivedRoutedEventArgs +title: CharacterReceivedRoutedEventArgs +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `interface` + +Implements: [`RoutedEventArgs`](RoutedEventArgs) + +## Properties +### Handled + bool `Handled` + +### KeyCode +`readonly` int `KeyCode` + +### KeyStatus +`readonly` [`PhysicalKeyStatus`](https://learn.microsoft.com/windows/windows-app-sdk/api/winrt/Microsoft.UI.Input.PhysicalKeyStatus) `KeyStatus` + +### KeyboardSource +`readonly` [`KeyboardSource`](KeyboardSource) `KeyboardSource` + +## Referenced by +- [`ComponentView`](ComponentView) diff --git a/docs/native-api/Color-api-windows.md b/docs/native-api/Color-api-windows.md new file mode 100644 index 000000000..ac3d024b5 --- /dev/null +++ b/docs/native-api/Color-api-windows.md @@ -0,0 +1,49 @@ +--- +id: Color +title: Color +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `class` + +> **EXPERIMENTAL** + +## Methods +### AsBrush +[`CompositionBrush`](https://learn.microsoft.com/windows/windows-app-sdk/api/winrt/Microsoft.UI.Composition.CompositionBrush) **`AsBrush`**([`Theme`](Theme) theme) + +> **EXPERIMENTAL** + +### AsWindowsColor +[`Color`](https://docs.microsoft.com/uwp/api/Windows.UI.Color) **`AsWindowsColor`**([`Theme`](Theme) theme) + +> **EXPERIMENTAL** + +### Black +`static` [`Color`](Color) **`Black`**() + +> **EXPERIMENTAL** + +### Equals +bool **`Equals`**([`Color`](Color) color) + +> **EXPERIMENTAL** + +### ReadValue +`static` [`Color`](Color) **`ReadValue`**([`IJSValueReader`](IJSValueReader) reader) + +> **EXPERIMENTAL** + +### Transparent +`static` [`Color`](Color) **`Transparent`**() + +> **EXPERIMENTAL** + +### WriteValue +`static` void **`WriteValue`**([`IJSValueWriter`](IJSValueWriter) writer, [`Color`](Color) color) + +> **EXPERIMENTAL** + +## Referenced by +- [`ViewProps`](ViewProps) diff --git a/docs/native-api/ColorSourceEffect-api-windows.md b/docs/native-api/ColorSourceEffect-api-windows.md index e6d979c1d..ff692055f 100644 --- a/docs/native-api/ColorSourceEffect-api-windows.md +++ b/docs/native-api/ColorSourceEffect-api-windows.md @@ -3,6 +3,8 @@ id: ColorSourceEffect title: ColorSourceEffect --- +![Architecture](https://img.shields.io/badge/architecture-old_only-yellow) + Kind: `class` Implements: [`IGraphicsEffect`](https://docs.microsoft.com/uwp/api/Windows.Graphics.Effects.IGraphicsEffect), [`IGraphicsEffectSource`](https://docs.microsoft.com/uwp/api/Windows.Graphics.Effects.IGraphicsEffectSource) @@ -13,7 +15,3 @@ Implements: [`IGraphicsEffect`](https://docs.microsoft.com/uwp/api/Windows.Graph ### Name string `Name` - - - - diff --git a/docs/native-api/ComponentIslandComponentViewInitializer-api-windows.md b/docs/native-api/ComponentIslandComponentViewInitializer-api-windows.md new file mode 100644 index 000000000..2b9a92980 --- /dev/null +++ b/docs/native-api/ComponentIslandComponentViewInitializer-api-windows.md @@ -0,0 +1,16 @@ +--- +id: ComponentIslandComponentViewInitializer +title: ComponentIslandComponentViewInitializer +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `delegate` + +> **EXPERIMENTAL** + +## Invoke +void **`Invoke`**([`ContentIslandComponentView`](ContentIslandComponentView) view) + +## Referenced by +- [`IReactCompositionViewComponentBuilder`](IReactCompositionViewComponentBuilder) diff --git a/docs/native-api/ComponentView-api-windows.md b/docs/native-api/ComponentView-api-windows.md new file mode 100644 index 000000000..6b80a5a64 --- /dev/null +++ b/docs/native-api/ComponentView-api-windows.md @@ -0,0 +1,45 @@ +--- +id: ComponentView +title: ComponentView +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `class` + +Extends: [`ComponentView`](ComponentView) + +> **EXPERIMENTAL** + +## Properties +### Compositor +`readonly` [`Compositor`](https://learn.microsoft.com/windows/windows-app-sdk/api/winrt/Microsoft.UI.Composition.Compositor) `Compositor` + +> **EXPERIMENTAL** + +### Root +`readonly` [`RootComponentView`](RootComponentView) `Root` + +> **EXPERIMENTAL** + +### Theme + [`Theme`](Theme) `Theme` + +> **EXPERIMENTAL** + +## Methods +### CapturePointer +bool **`CapturePointer`**([`Pointer`](Pointer) pointer) + +> **EXPERIMENTAL** + +### ReleasePointerCapture +void **`ReleasePointerCapture`**([`Pointer`](Pointer) pointer) + +> **EXPERIMENTAL** + +## Events +### `ThemeChanged` +> **EXPERIMENTAL** + +Type: [`EventHandler`](https://docs.microsoft.com/uwp/api/Windows.Foundation.EventHandler-1) diff --git a/docs/native-api/ComponentViewFeatures-api-windows.md b/docs/native-api/ComponentViewFeatures-api-windows.md new file mode 100644 index 000000000..7fea20d60 --- /dev/null +++ b/docs/native-api/ComponentViewFeatures-api-windows.md @@ -0,0 +1,22 @@ +--- +id: ComponentViewFeatures +title: ComponentViewFeatures +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `enum` + +> **EXPERIMENTAL** + +| Name | Value | Description | +|--|--|--| +|`None` | 0x0 | | +|`NativeBorder` | 0x1 | | +|`ShadowProps` | 0x2 | | +|`Background` | 0x4 | | +|`FocusVisual` | 0x8 | | +|`Default` | 0xf | | + +## Referenced by +- [`IReactCompositionViewComponentBuilder`](IReactCompositionViewComponentBuilder) diff --git a/docs/native-api/ComponentViewInitializer-api-windows.md b/docs/native-api/ComponentViewInitializer-api-windows.md new file mode 100644 index 000000000..37a46f912 --- /dev/null +++ b/docs/native-api/ComponentViewInitializer-api-windows.md @@ -0,0 +1,18 @@ +--- +id: ComponentViewInitializer +title: ComponentViewInitializer +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `delegate` + +> **EXPERIMENTAL** + +Provides a method to initialize an instance of a ComponentView. See [`IReactViewComponentBuilder.SetComponentViewInitializer`](IReactViewComponentBuilder#setcomponentviewinitializer) + +## Invoke +void **`Invoke`**([`ComponentView`](ComponentView) view) + +## Referenced by +- [`IReactViewComponentBuilder`](IReactViewComponentBuilder) diff --git a/docs/native-api/ComponentViewUpdateMask-api-windows.md b/docs/native-api/ComponentViewUpdateMask-api-windows.md new file mode 100644 index 000000000..6ab27f580 --- /dev/null +++ b/docs/native-api/ComponentViewUpdateMask-api-windows.md @@ -0,0 +1,22 @@ +--- +id: ComponentViewUpdateMask +title: ComponentViewUpdateMask +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `enum` + +> **EXPERIMENTAL** + +| Name | Value | Description | +|--|--|--| +|`None` | 0x0 | | +|`Props` | 0x1 | | +|`EventEmitter` | 0x2 | | +|`State` | 0x4 | | +|`LayoutMetrics` | 0x8 | | +|`All` | 0xf | | + +## Referenced by +- [`UpdateFinalizerDelegate`](UpdateFinalizerDelegate) diff --git a/docs/native-api/CompositeStepEffect-api-windows.md b/docs/native-api/CompositeStepEffect-api-windows.md index c7b1b2c54..d5a13d792 100644 --- a/docs/native-api/CompositeStepEffect-api-windows.md +++ b/docs/native-api/CompositeStepEffect-api-windows.md @@ -3,6 +3,8 @@ id: CompositeStepEffect title: CompositeStepEffect --- +![Architecture](https://img.shields.io/badge/architecture-old_only-yellow) + Kind: `class` Implements: [`IGraphicsEffect`](https://docs.microsoft.com/uwp/api/Windows.Graphics.Effects.IGraphicsEffect), [`IGraphicsEffectSource`](https://docs.microsoft.com/uwp/api/Windows.Graphics.Effects.IGraphicsEffectSource) @@ -19,7 +21,3 @@ Implements: [`IGraphicsEffect`](https://docs.microsoft.com/uwp/api/Windows.Graph ### Source [`IGraphicsEffectSource`](https://docs.microsoft.com/uwp/api/Windows.Graphics.Effects.IGraphicsEffectSource) `Source` - - - - diff --git a/docs/native-api/CompositionHwndHost-api-windows.md b/docs/native-api/CompositionHwndHost-api-windows.md new file mode 100644 index 000000000..e63f3a1d4 --- /dev/null +++ b/docs/native-api/CompositionHwndHost-api-windows.md @@ -0,0 +1,47 @@ +--- +id: CompositionHwndHost +title: CompositionHwndHost +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `class` + +> **EXPERIMENTAL** + +An HWND based host of RNW running on windows composition.Provided as an ease of use function - most of the time HWND-less hosting would be preferable.In the long term this is likely to be replaced with a more modern hosting interface. + +## Properties +### ReactViewHost + [`IReactViewHost`](IReactViewHost) `ReactViewHost` + +> **EXPERIMENTAL** + +A ReactViewHost specifies the root UI component and initial properties to render in this RootViewIt must be set to show any React UI elements. + +### UiaProvider +`readonly` Object `UiaProvider` + +> **EXPERIMENTAL** + +## Constructors +### CompositionHwndHost + **`CompositionHwndHost`**() + +## Methods +### Initialize +void **`Initialize`**(uint64_t hwnd) + +> **EXPERIMENTAL** + +### NavigateFocus +[`FocusNavigationResult`](FocusNavigationResult) **`NavigateFocus`**([`FocusNavigationRequest`](FocusNavigationRequest) request) + +> **EXPERIMENTAL** + +Move focus to this [`CompositionHwndHost`](CompositionHwndHost) + +### TranslateMessage +int64_t **`TranslateMessage`**(uint32_t msg, uint64_t wParam, int64_t lParam) + +> **EXPERIMENTAL** diff --git a/docs/native-api/CompositionStretch-api-windows.md b/docs/native-api/CompositionStretch-api-windows.md new file mode 100644 index 000000000..4a516d9ae --- /dev/null +++ b/docs/native-api/CompositionStretch-api-windows.md @@ -0,0 +1,18 @@ +--- +id: CompositionStretch +title: CompositionStretch +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `enum` + +| Name | Value | Description | +|--|--|--| +|`None` | 0x0 | | +|`Fill` | 0x1 | | +|`Uniform` | 0x2 | | +|`UniformToFill` | 0x3 | | + +## Referenced by +- [`IDrawingSurfaceBrush`](IDrawingSurfaceBrush) diff --git a/docs/native-api/CompositionUIService-api-windows.md b/docs/native-api/CompositionUIService-api-windows.md new file mode 100644 index 000000000..0698a0b88 --- /dev/null +++ b/docs/native-api/CompositionUIService-api-windows.md @@ -0,0 +1,34 @@ +--- +id: CompositionUIService +title: CompositionUIService +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `class` + +> **EXPERIMENTAL** + +Provides access to Composition UI-specific functionality. + +## Methods +### ComponentFromReactTag +`static` [`ComponentView`](ComponentView) **`ComponentFromReactTag`**([`IReactContext`](IReactContext) context, int64_t reactTag) + +> **EXPERIMENTAL** + +Gets the ComponentView from a react tag. + +### GetCompositor +`static` [`Compositor`](https://learn.microsoft.com/windows/windows-app-sdk/api/winrt/Microsoft.UI.Composition.Compositor) **`GetCompositor`**([`IReactPropertyBag`](IReactPropertyBag) properties) + +> **EXPERIMENTAL** + +Gets the Compositor used by this ReactNative instance. + +### SetCompositor +`static` void **`SetCompositor`**([`ReactInstanceSettings`](ReactInstanceSettings) settings, [`Compositor`](https://learn.microsoft.com/windows/windows-app-sdk/api/winrt/Microsoft.UI.Composition.Compositor) compositor) + +> **EXPERIMENTAL** + +Configures the react instance to use the provided Compositor. Setting this will opt into using the new architecture diff --git a/docs/native-api/ConstantProviderDelegate-api-windows.md b/docs/native-api/ConstantProviderDelegate-api-windows.md index e572c6f56..cbad78f60 100644 --- a/docs/native-api/ConstantProviderDelegate-api-windows.md +++ b/docs/native-api/ConstantProviderDelegate-api-windows.md @@ -3,18 +3,30 @@ id: ConstantProviderDelegate title: ConstantProviderDelegate --- +![Architecture](https://img.shields.io/badge/architecture-new_&_old-green) + +## New Architecture + Kind: `delegate` A delegate to gather constants for the native module. -## Invoke +### Invoke void **`Invoke`**([`IJSValueWriter`](IJSValueWriter) constantWriter) +### Referenced by +- [`IReactModuleBuilder`](IReactModuleBuilder) +## Old Architecture +Kind: `delegate` +A delegate to gather constants for the native module. + +### Invoke +void **`Invoke`**([`IJSValueWriter`](IJSValueWriter) constantWriter) -## Referenced by +### Referenced by - [`IReactModuleBuilder`](IReactModuleBuilder) - [`IViewManagerWithExportedEventTypeConstants`](IViewManagerWithExportedEventTypeConstants) - [`IViewManagerWithExportedViewConstants`](IViewManagerWithExportedViewConstants) diff --git a/docs/native-api/ContentIslandComponentView-api-windows.md b/docs/native-api/ContentIslandComponentView-api-windows.md new file mode 100644 index 000000000..c0033a48a --- /dev/null +++ b/docs/native-api/ContentIslandComponentView-api-windows.md @@ -0,0 +1,21 @@ +--- +id: ContentIslandComponentView +title: ContentIslandComponentView +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `class` + +Extends: [`ViewComponentView`](ViewComponentView) + +> **EXPERIMENTAL** + +## Methods +### Connect +void **`Connect`**([`ContentIsland`](https://learn.microsoft.com/windows/windows-app-sdk/api/winrt/Microsoft.UI.Content.ContentIsland) contentIsland) + +> **EXPERIMENTAL** + +## Referenced by +- [`ComponentIslandComponentViewInitializer`](ComponentIslandComponentViewInitializer) diff --git a/docs/native-api/CreateInternalVisualDelegate-api-windows.md b/docs/native-api/CreateInternalVisualDelegate-api-windows.md new file mode 100644 index 000000000..36bc59a89 --- /dev/null +++ b/docs/native-api/CreateInternalVisualDelegate-api-windows.md @@ -0,0 +1,16 @@ +--- +id: CreateInternalVisualDelegate +title: CreateInternalVisualDelegate +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `delegate` + +> **EXPERIMENTAL** + +## Invoke +[`IVisual`](IVisual) **`Invoke`**([`ComponentView`](ComponentView) view) + +## Referenced by +- [`IInternalCreateVisual`](IInternalCreateVisual) diff --git a/docs/native-api/CreateVisualDelegate-api-windows.md b/docs/native-api/CreateVisualDelegate-api-windows.md new file mode 100644 index 000000000..c315703d0 --- /dev/null +++ b/docs/native-api/CreateVisualDelegate-api-windows.md @@ -0,0 +1,16 @@ +--- +id: CreateVisualDelegate +title: CreateVisualDelegate +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `delegate` + +> **EXPERIMENTAL** + +## Invoke +[`Visual`](https://learn.microsoft.com/windows/windows-app-sdk/api/winrt/Microsoft.UI.Composition.Visual) **`Invoke`**([`ComponentView`](ComponentView) view) + +## Referenced by +- [`IReactCompositionViewComponentBuilder`](IReactCompositionViewComponentBuilder) diff --git a/docs/native-api/CustomResourceResult-api-windows.md b/docs/native-api/CustomResourceResult-api-windows.md new file mode 100644 index 000000000..3abaa7319 --- /dev/null +++ b/docs/native-api/CustomResourceResult-api-windows.md @@ -0,0 +1,26 @@ +--- +id: CustomResourceResult +title: CustomResourceResult +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `class` + +> **EXPERIMENTAL** + +## Properties +### AlternateResourceId + string `AlternateResourceId` + +> **EXPERIMENTAL** + +The value of this resource should resolve to the value of another ResourceId + +### Resource + Object `Resource` + +> **EXPERIMENTAL** + +## Referenced by +- [`ICustomResourceLoader`](ICustomResourceLoader) diff --git a/docs/native-api/DebuggingOverlayComponentView-api-windows.md b/docs/native-api/DebuggingOverlayComponentView-api-windows.md new file mode 100644 index 000000000..aaef3d512 --- /dev/null +++ b/docs/native-api/DebuggingOverlayComponentView-api-windows.md @@ -0,0 +1,12 @@ +--- +id: DebuggingOverlayComponentView +title: DebuggingOverlayComponentView +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `class` + +Extends: [`ViewComponentView`](ViewComponentView) + +> **EXPERIMENTAL** diff --git a/docs/native-api/DesktopWindowMessage-api-windows.md b/docs/native-api/DesktopWindowMessage-api-windows.md index 7c5e5daf8..badda0637 100644 --- a/docs/native-api/DesktopWindowMessage-api-windows.md +++ b/docs/native-api/DesktopWindowMessage-api-windows.md @@ -3,6 +3,8 @@ id: DesktopWindowMessage title: DesktopWindowMessage --- +![Architecture](https://img.shields.io/badge/architecture-new_&_old-green) + Kind: `struct` Represents a window message. See https://docs.microsoft.com/windows/win32/learnwin32/window-messages @@ -16,4 +18,3 @@ Type: `uint32_t` ### WParam Type: `uint64_t` - diff --git a/docs/native-api/DevMenuControl-api-windows.md b/docs/native-api/DevMenuControl-api-windows.md index a81ab68d7..df88d22e6 100644 --- a/docs/native-api/DevMenuControl-api-windows.md +++ b/docs/native-api/DevMenuControl-api-windows.md @@ -3,64 +3,58 @@ id: DevMenuControl title: DevMenuControl --- -Kind: `class` - -Extends: [`UserControl`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.Controls.UserControl) +![Architecture](https://img.shields.io/badge/architecture-old_only-yellow) +Kind: `class` +Extends: [`UserControl`](https://learn.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` +`readonly` [`Button`](https://learn.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` +`readonly` [`TextBlock`](https://learn.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` +`readonly` [`Button`](https://learn.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` +`readonly` [`Button`](https://learn.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` +`readonly` [`Button`](https://learn.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` +`readonly` [`TextBlock`](https://learn.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` +`readonly` [`TextBlock`](https://learn.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` +`readonly` [`Button`](https://learn.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` +`readonly` [`TextBlock`](https://learn.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` +`readonly` [`Button`](https://learn.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` +`readonly` [`Button`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.Controls.Button) `Reload` ### SamplingProfiler -`readonly` [`Button`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.Controls.Button) `SamplingProfiler` +`readonly` [`Button`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.Controls.Button) `SamplingProfiler` ### SamplingProfilerDescText -`readonly` [`TextBlock`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.Controls.TextBlock) `SamplingProfilerDescText` +`readonly` [`TextBlock`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.Controls.TextBlock) `SamplingProfilerDescText` ### SamplingProfilerIcon -`readonly` [`FontIcon`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.Controls.FontIcon) `SamplingProfilerIcon` +`readonly` [`FontIcon`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.Controls.FontIcon) `SamplingProfilerIcon` ### SamplingProfilerText -`readonly` [`TextBlock`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.Controls.TextBlock) `SamplingProfilerText` - +`readonly` [`TextBlock`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.Controls.TextBlock) `SamplingProfilerText` ## Constructors ### DevMenuControl **`DevMenuControl`**() - - - - - diff --git a/docs/native-api/DynamicAutomationPeer-api-windows.md b/docs/native-api/DynamicAutomationPeer-api-windows.md index c7dde2df4..b1196860e 100644 --- a/docs/native-api/DynamicAutomationPeer-api-windows.md +++ b/docs/native-api/DynamicAutomationPeer-api-windows.md @@ -3,18 +3,20 @@ id: DynamicAutomationPeer title: DynamicAutomationPeer --- +![Architecture](https://img.shields.io/badge/architecture-old_only-yellow) + Kind: `class` -Extends: [`FrameworkElementAutomationPeer`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.Automation.Peers.FrameworkElementAutomationPeer) +Extends: [`FrameworkElementAutomationPeer`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.Automation.Peers.FrameworkElementAutomationPeer) -Implements: [`IInvokeProvider`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.Automation.Provider.IInvokeProvider), [`ISelectionProvider`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.Automation.Provider.ISelectionProvider), [`ISelectionItemProvider`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.Automation.Provider.ISelectionItemProvider), [`IToggleProvider`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.Automation.Provider.IToggleProvider), [`IExpandCollapseProvider`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.Automation.Provider.IExpandCollapseProvider), [`IRangeValueProvider`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.Automation.Provider.IRangeValueProvider) +Implements: [`IInvokeProvider`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.Automation.Provider.IInvokeProvider), [`ISelectionProvider`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.Automation.Provider.ISelectionProvider), [`ISelectionItemProvider`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.Automation.Provider.ISelectionItemProvider), [`IToggleProvider`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.Automation.Provider.IToggleProvider), [`IExpandCollapseProvider`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.Automation.Provider.IExpandCollapseProvider), [`IRangeValueProvider`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.Automation.Provider.IRangeValueProvider) ## Properties ### CanSelectMultiple `readonly` bool `CanSelectMultiple` ### ExpandCollapseState -`readonly` [`ExpandCollapseState`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.Automation.ExpandCollapseState) `ExpandCollapseState` +`readonly` [`ExpandCollapseState`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.Automation.ExpandCollapseState) `ExpandCollapseState` ### IsReadOnly `readonly` bool `IsReadOnly` @@ -35,69 +37,45 @@ Implements: [`IInvokeProvider`](https://docs.microsoft.com/uwp/api/Windows.UI.Xa `readonly` double `Minimum` ### SelectionContainer -`readonly` [`IRawElementProviderSimple`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.Automation.Provider.IRawElementProviderSimple) `SelectionContainer` +`readonly` [`IRawElementProviderSimple`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.Automation.Provider.IRawElementProviderSimple) `SelectionContainer` ### SmallChange `readonly` double `SmallChange` ### ToggleState -`readonly` [`ToggleState`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.Automation.ToggleState) `ToggleState` +`readonly` [`ToggleState`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.Automation.ToggleState) `ToggleState` ### Value `readonly` double `Value` - ## Constructors ### DynamicAutomationPeer - **`DynamicAutomationPeer`**([`FrameworkElement`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.FrameworkElement) owner) - - - + **`DynamicAutomationPeer`**([`FrameworkElement`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.FrameworkElement) owner) ## Methods ### AddToSelection void **`AddToSelection`**() - - ### Collapse void **`Collapse`**() - - ### Expand void **`Expand`**() - - ### GetSelection -[`IRawElementProviderSimple`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.Automation.Provider.IRawElementProviderSimple) **`GetSelection`**() - - +[`IRawElementProviderSimple`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.Automation.Provider.IRawElementProviderSimple) **`GetSelection`**() ### Invoke void **`Invoke`**() - - ### RemoveFromSelection void **`RemoveFromSelection`**() - - ### Select void **`Select`**() - - ### SetValue void **`SetValue`**(double value) - - ### Toggle void **`Toggle`**() - - - - diff --git a/docs/native-api/DynamicAutomationProperties-api-windows.md b/docs/native-api/DynamicAutomationProperties-api-windows.md index d7d896624..cae435fbc 100644 --- a/docs/native-api/DynamicAutomationProperties-api-windows.md +++ b/docs/native-api/DynamicAutomationProperties-api-windows.md @@ -3,194 +3,134 @@ id: DynamicAutomationProperties title: DynamicAutomationProperties --- -Kind: `class` - +![Architecture](https://img.shields.io/badge/architecture-old_only-yellow) +Kind: `class` ## Properties ### AccessibilityActionEventHandlerProperty -`static` `readonly` [`DependencyProperty`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.DependencyProperty) `AccessibilityActionEventHandlerProperty` +`static` `readonly` [`DependencyProperty`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.DependencyProperty) `AccessibilityActionEventHandlerProperty` ### AccessibilityActionsProperty -`static` `readonly` [`DependencyProperty`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.DependencyProperty) `AccessibilityActionsProperty` +`static` `readonly` [`DependencyProperty`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.DependencyProperty) `AccessibilityActionsProperty` ### AccessibilityInvokeEventHandlerProperty -`static` `readonly` [`DependencyProperty`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.DependencyProperty) `AccessibilityInvokeEventHandlerProperty` +`static` `readonly` [`DependencyProperty`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.DependencyProperty) `AccessibilityInvokeEventHandlerProperty` ### AccessibilityRoleProperty -`static` `readonly` [`DependencyProperty`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.DependencyProperty) `AccessibilityRoleProperty` +`static` `readonly` [`DependencyProperty`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.DependencyProperty) `AccessibilityRoleProperty` ### AccessibilityStateBusyProperty -`static` `readonly` [`DependencyProperty`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.DependencyProperty) `AccessibilityStateBusyProperty` +`static` `readonly` [`DependencyProperty`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.DependencyProperty) `AccessibilityStateBusyProperty` ### AccessibilityStateCheckedProperty -`static` `readonly` [`DependencyProperty`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.DependencyProperty) `AccessibilityStateCheckedProperty` +`static` `readonly` [`DependencyProperty`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.DependencyProperty) `AccessibilityStateCheckedProperty` ### AccessibilityStateDisabledProperty -`static` `readonly` [`DependencyProperty`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.DependencyProperty) `AccessibilityStateDisabledProperty` +`static` `readonly` [`DependencyProperty`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.DependencyProperty) `AccessibilityStateDisabledProperty` ### AccessibilityStateExpandedProperty -`static` `readonly` [`DependencyProperty`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.DependencyProperty) `AccessibilityStateExpandedProperty` +`static` `readonly` [`DependencyProperty`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.DependencyProperty) `AccessibilityStateExpandedProperty` ### AccessibilityStateSelectedProperty -`static` `readonly` [`DependencyProperty`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.DependencyProperty) `AccessibilityStateSelectedProperty` +`static` `readonly` [`DependencyProperty`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.DependencyProperty) `AccessibilityStateSelectedProperty` ### AccessibilityValueMaxProperty -`static` `readonly` [`DependencyProperty`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.DependencyProperty) `AccessibilityValueMaxProperty` +`static` `readonly` [`DependencyProperty`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.DependencyProperty) `AccessibilityValueMaxProperty` ### AccessibilityValueMinProperty -`static` `readonly` [`DependencyProperty`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.DependencyProperty) `AccessibilityValueMinProperty` +`static` `readonly` [`DependencyProperty`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.DependencyProperty) `AccessibilityValueMinProperty` ### AccessibilityValueNowProperty -`static` `readonly` [`DependencyProperty`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.DependencyProperty) `AccessibilityValueNowProperty` +`static` `readonly` [`DependencyProperty`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.DependencyProperty) `AccessibilityValueNowProperty` ### AccessibilityValueTextProperty -`static` `readonly` [`DependencyProperty`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.DependencyProperty) `AccessibilityValueTextProperty` +`static` `readonly` [`DependencyProperty`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.DependencyProperty) `AccessibilityValueTextProperty` ### AriaRoleProperty -`static` `readonly` [`DependencyProperty`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.DependencyProperty) `AriaRoleProperty` - - +`static` `readonly` [`DependencyProperty`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.DependencyProperty) `AriaRoleProperty` ## Methods ### GetAccessibilityActionEventHandler -`static` [`AccessibilityActionEventHandler`](AccessibilityActionEventHandler) **`GetAccessibilityActionEventHandler`**([`UIElement`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.UIElement) element) - - +`static` [`AccessibilityActionEventHandler`](AccessibilityActionEventHandler) **`GetAccessibilityActionEventHandler`**([`UIElement`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.UIElement) element) ### GetAccessibilityActions -`static` [`IVector`](https://docs.microsoft.com/uwp/api/Windows.Foundation.Collections.IVector-1)<[`AccessibilityAction`](AccessibilityAction)> **`GetAccessibilityActions`**([`UIElement`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.UIElement) element) - - +`static` [`IVector`](https://docs.microsoft.com/uwp/api/Windows.Foundation.Collections.IVector-1)<[`AccessibilityAction`](AccessibilityAction)> **`GetAccessibilityActions`**([`UIElement`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.UIElement) element) ### GetAccessibilityInvokeEventHandler -`static` [`AccessibilityInvokeEventHandler`](AccessibilityInvokeEventHandler) **`GetAccessibilityInvokeEventHandler`**([`UIElement`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.UIElement) element) - - +`static` [`AccessibilityInvokeEventHandler`](AccessibilityInvokeEventHandler) **`GetAccessibilityInvokeEventHandler`**([`UIElement`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.UIElement) element) ### GetAccessibilityRole -`static` [`AccessibilityRoles`](AccessibilityRoles) **`GetAccessibilityRole`**([`UIElement`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.UIElement) element) - - +`static` [`AccessibilityRoles`](AccessibilityRoles) **`GetAccessibilityRole`**([`UIElement`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.UIElement) element) ### GetAccessibilityStateBusy -`static` bool **`GetAccessibilityStateBusy`**([`UIElement`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.UIElement) element) - - +`static` bool **`GetAccessibilityStateBusy`**([`UIElement`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.UIElement) element) ### GetAccessibilityStateChecked -`static` [`AccessibilityStateCheckedValue`](AccessibilityStateCheckedValue) **`GetAccessibilityStateChecked`**([`UIElement`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.UIElement) element) - - +`static` [`AccessibilityStateCheckedValue`](AccessibilityStateCheckedValue) **`GetAccessibilityStateChecked`**([`UIElement`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.UIElement) element) ### GetAccessibilityStateDisabled -`static` bool **`GetAccessibilityStateDisabled`**([`UIElement`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.UIElement) element) - - +`static` bool **`GetAccessibilityStateDisabled`**([`UIElement`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.UIElement) element) ### GetAccessibilityStateExpanded -`static` bool **`GetAccessibilityStateExpanded`**([`UIElement`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.UIElement) element) - - +`static` bool **`GetAccessibilityStateExpanded`**([`UIElement`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.UIElement) element) ### GetAccessibilityStateSelected -`static` bool **`GetAccessibilityStateSelected`**([`UIElement`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.UIElement) element) - - +`static` bool **`GetAccessibilityStateSelected`**([`UIElement`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.UIElement) element) ### GetAccessibilityValueMax -`static` double **`GetAccessibilityValueMax`**([`UIElement`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.UIElement) element) - - +`static` double **`GetAccessibilityValueMax`**([`UIElement`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.UIElement) element) ### GetAccessibilityValueMin -`static` double **`GetAccessibilityValueMin`**([`UIElement`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.UIElement) element) - - +`static` double **`GetAccessibilityValueMin`**([`UIElement`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.UIElement) element) ### GetAccessibilityValueNow -`static` double **`GetAccessibilityValueNow`**([`UIElement`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.UIElement) element) - - +`static` double **`GetAccessibilityValueNow`**([`UIElement`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.UIElement) element) ### GetAccessibilityValueText -`static` string **`GetAccessibilityValueText`**([`UIElement`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.UIElement) element) - - +`static` string **`GetAccessibilityValueText`**([`UIElement`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.UIElement) element) ### GetAriaRole -`static` [`AriaRole`](AriaRole) **`GetAriaRole`**([`UIElement`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.UIElement) element) - - +`static` [`AriaRole`](AriaRole) **`GetAriaRole`**([`UIElement`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.UIElement) element) ### SetAccessibilityActionEventHandler -`static` void **`SetAccessibilityActionEventHandler`**([`UIElement`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.UIElement) element, [`AccessibilityActionEventHandler`](AccessibilityActionEventHandler) value) - - +`static` void **`SetAccessibilityActionEventHandler`**([`UIElement`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.UIElement) element, [`AccessibilityActionEventHandler`](AccessibilityActionEventHandler) value) ### SetAccessibilityActions -`static` void **`SetAccessibilityActions`**([`UIElement`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.UIElement) element, [`IVector`](https://docs.microsoft.com/uwp/api/Windows.Foundation.Collections.IVector-1)<[`AccessibilityAction`](AccessibilityAction)> value) - - +`static` void **`SetAccessibilityActions`**([`UIElement`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.UIElement) element, [`IVector`](https://docs.microsoft.com/uwp/api/Windows.Foundation.Collections.IVector-1)<[`AccessibilityAction`](AccessibilityAction)> value) ### SetAccessibilityInvokeEventHandler -`static` void **`SetAccessibilityInvokeEventHandler`**([`UIElement`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.UIElement) element, [`AccessibilityInvokeEventHandler`](AccessibilityInvokeEventHandler) value) - - +`static` void **`SetAccessibilityInvokeEventHandler`**([`UIElement`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.UIElement) element, [`AccessibilityInvokeEventHandler`](AccessibilityInvokeEventHandler) value) ### SetAccessibilityRole -`static` void **`SetAccessibilityRole`**([`UIElement`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.UIElement) element, [`AccessibilityRoles`](AccessibilityRoles) value) - - +`static` void **`SetAccessibilityRole`**([`UIElement`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.UIElement) element, [`AccessibilityRoles`](AccessibilityRoles) value) ### SetAccessibilityStateBusy -`static` void **`SetAccessibilityStateBusy`**([`UIElement`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.UIElement) element, bool value) - - +`static` void **`SetAccessibilityStateBusy`**([`UIElement`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.UIElement) element, bool value) ### SetAccessibilityStateChecked -`static` void **`SetAccessibilityStateChecked`**([`UIElement`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.UIElement) element, [`AccessibilityStateCheckedValue`](AccessibilityStateCheckedValue) value) - - +`static` void **`SetAccessibilityStateChecked`**([`UIElement`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.UIElement) element, [`AccessibilityStateCheckedValue`](AccessibilityStateCheckedValue) value) ### SetAccessibilityStateDisabled -`static` void **`SetAccessibilityStateDisabled`**([`UIElement`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.UIElement) element, bool value) - - +`static` void **`SetAccessibilityStateDisabled`**([`UIElement`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.UIElement) element, bool value) ### SetAccessibilityStateExpanded -`static` void **`SetAccessibilityStateExpanded`**([`UIElement`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.UIElement) element, bool value) - - +`static` void **`SetAccessibilityStateExpanded`**([`UIElement`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.UIElement) element, bool value) ### SetAccessibilityStateSelected -`static` void **`SetAccessibilityStateSelected`**([`UIElement`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.UIElement) element, bool value) - - +`static` void **`SetAccessibilityStateSelected`**([`UIElement`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.UIElement) element, bool value) ### SetAccessibilityValueMax -`static` void **`SetAccessibilityValueMax`**([`UIElement`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.UIElement) element, double value) - - +`static` void **`SetAccessibilityValueMax`**([`UIElement`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.UIElement) element, double value) ### SetAccessibilityValueMin -`static` void **`SetAccessibilityValueMin`**([`UIElement`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.UIElement) element, double value) - - +`static` void **`SetAccessibilityValueMin`**([`UIElement`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.UIElement) element, double value) ### SetAccessibilityValueNow -`static` void **`SetAccessibilityValueNow`**([`UIElement`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.UIElement) element, double value) - - +`static` void **`SetAccessibilityValueNow`**([`UIElement`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.UIElement) element, double value) ### SetAccessibilityValueText -`static` void **`SetAccessibilityValueText`**([`UIElement`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.UIElement) element, string value) - - +`static` void **`SetAccessibilityValueText`**([`UIElement`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.UIElement) element, string value) ### SetAriaRole -`static` void **`SetAriaRole`**([`UIElement`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.UIElement) element, [`AriaRole`](AriaRole) value) - - - - +`static` void **`SetAriaRole`**([`UIElement`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.UIElement) element, [`AriaRole`](AriaRole) value) diff --git a/docs/native-api/DynamicValueProvider-api-windows.md b/docs/native-api/DynamicValueProvider-api-windows.md index 72f84edaa..0d3087054 100644 --- a/docs/native-api/DynamicValueProvider-api-windows.md +++ b/docs/native-api/DynamicValueProvider-api-windows.md @@ -3,9 +3,11 @@ id: DynamicValueProvider title: DynamicValueProvider --- +![Architecture](https://img.shields.io/badge/architecture-old_only-yellow) + Kind: `class` -Implements: [`IValueProvider`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.Automation.Provider.IValueProvider) +Implements: [`IValueProvider`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.Automation.Provider.IValueProvider) ## Properties ### IsReadOnly @@ -14,18 +16,10 @@ Implements: [`IValueProvider`](https://docs.microsoft.com/uwp/api/Windows.UI.Xam ### Value `readonly` string `Value` - ## Constructors ### DynamicValueProvider - **`DynamicValueProvider`**([`FrameworkElementAutomationPeer`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.Automation.Peers.FrameworkElementAutomationPeer) peer) - - - + **`DynamicValueProvider`**([`FrameworkElementAutomationPeer`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.Automation.Peers.FrameworkElementAutomationPeer) peer) ## Methods ### SetValue void **`SetValue`**(string value) - - - - diff --git a/docs/native-api/EffectBorderMode-api-windows.md b/docs/native-api/EffectBorderMode-api-windows.md index fcb1fcce8..2a9b1f39f 100644 --- a/docs/native-api/EffectBorderMode-api-windows.md +++ b/docs/native-api/EffectBorderMode-api-windows.md @@ -3,6 +3,8 @@ id: EffectBorderMode title: EffectBorderMode --- +![Architecture](https://img.shields.io/badge/architecture-old_only-yellow) + Kind: `enum` | Name | Value | Description | @@ -10,6 +12,5 @@ Kind: `enum` |`Soft` | 0x0 | | |`Hard` | 0x1 | | - ## Referenced by - [`GaussianBlurEffect`](GaussianBlurEffect) diff --git a/docs/native-api/EffectOptimization-api-windows.md b/docs/native-api/EffectOptimization-api-windows.md index afc15820b..cf06f02a0 100644 --- a/docs/native-api/EffectOptimization-api-windows.md +++ b/docs/native-api/EffectOptimization-api-windows.md @@ -3,6 +3,8 @@ id: EffectOptimization title: EffectOptimization --- +![Architecture](https://img.shields.io/badge/architecture-old_only-yellow) + Kind: `enum` | Name | Value | Description | @@ -11,6 +13,5 @@ Kind: `enum` |`Balanced` | 0x1 | | |`Quality` | 0x2 | | - ## Referenced by - [`GaussianBlurEffect`](GaussianBlurEffect) diff --git a/docs/native-api/EmitEventSetterDelegate-api-windows.md b/docs/native-api/EmitEventSetterDelegate-api-windows.md index b540ee370..750c76af6 100644 --- a/docs/native-api/EmitEventSetterDelegate-api-windows.md +++ b/docs/native-api/EmitEventSetterDelegate-api-windows.md @@ -3,6 +3,8 @@ id: EmitEventSetterDelegate title: EmitEventSetterDelegate --- +![Architecture](https://img.shields.io/badge/architecture-new_&_old-green) + Kind: `delegate` A delegate gets the arguments for an event emit on a EventEmitter. @@ -10,9 +12,5 @@ A delegate gets the arguments for an event emit on a EventEmitter. ## Invoke void **`Invoke`**([`JSValueArgWriter`](JSValueArgWriter) argWriter) - - - - ## Referenced by - [`EventEmitterInitializerDelegate`](EventEmitterInitializerDelegate) diff --git a/docs/native-api/EventEmitter-api-windows.md b/docs/native-api/EventEmitter-api-windows.md new file mode 100644 index 000000000..6aba43184 --- /dev/null +++ b/docs/native-api/EventEmitter-api-windows.md @@ -0,0 +1,20 @@ +--- +id: EventEmitter +title: EventEmitter +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `class` + +> **EXPERIMENTAL** + +## Methods +### DispatchEvent +void **`DispatchEvent`**(string eventName, [`JSValueArgWriter`](JSValueArgWriter) args) + +> **EXPERIMENTAL** + +## Referenced by +- [`ShadowNode`](ShadowNode) +- [`UpdateEventEmitterDelegate`](UpdateEventEmitterDelegate) diff --git a/docs/native-api/EventEmitterInitializerDelegate-api-windows.md b/docs/native-api/EventEmitterInitializerDelegate-api-windows.md index 0b6d67e45..5c3ec121f 100644 --- a/docs/native-api/EventEmitterInitializerDelegate-api-windows.md +++ b/docs/native-api/EventEmitterInitializerDelegate-api-windows.md @@ -3,6 +3,8 @@ id: EventEmitterInitializerDelegate title: EventEmitterInitializerDelegate --- +![Architecture](https://img.shields.io/badge/architecture-new_&_old-green) + Kind: `delegate` A delegate to call a turbo module EventEmitter. @@ -10,9 +12,5 @@ A delegate to call a turbo module EventEmitter. ## Invoke void **`Invoke`**([`EmitEventSetterDelegate`](EmitEventSetterDelegate) emitter) - - - - ## Referenced by - [`IReactModuleBuilder`](IReactModuleBuilder) diff --git a/docs/native-api/FocusManager-api-windows.md b/docs/native-api/FocusManager-api-windows.md new file mode 100644 index 000000000..cbd6dd264 --- /dev/null +++ b/docs/native-api/FocusManager-api-windows.md @@ -0,0 +1,25 @@ +--- +id: FocusManager +title: FocusManager +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `class` + +> **EXPERIMENTAL** + +## Methods +### FindFirstFocusableElement +`static` [`ComponentView`](ComponentView) **`FindFirstFocusableElement`**([`ComponentView`](ComponentView) searchScope) + +> **EXPERIMENTAL** + +Retrieves the first component that can receive focus based on the specified scope. + +### FindLastFocusableElement +`static` [`ComponentView`](ComponentView) **`FindLastFocusableElement`**([`ComponentView`](ComponentView) searchScope) + +> **EXPERIMENTAL** + +Retrieves the last component that can receive focus based on the specified scope. diff --git a/docs/native-api/FocusNavigationDirection-api-windows.md b/docs/native-api/FocusNavigationDirection-api-windows.md new file mode 100644 index 000000000..06d9161b0 --- /dev/null +++ b/docs/native-api/FocusNavigationDirection-api-windows.md @@ -0,0 +1,20 @@ +--- +id: FocusNavigationDirection +title: FocusNavigationDirection +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `enum` + +| Name | Value | Description | +|--|--|--| +|`None` | 0x0 | | +|`Next` | 0x1 | | +|`Previous` | 0x2 | | +|`First` | 0x3 | | +|`Last` | 0x4 | | + +## Referenced by +- [`GettingFocusEventArgs`](GettingFocusEventArgs) +- [`LosingFocusEventArgs`](LosingFocusEventArgs) diff --git a/docs/native-api/FocusNavigationReason-api-windows.md b/docs/native-api/FocusNavigationReason-api-windows.md new file mode 100644 index 000000000..38983a9ac --- /dev/null +++ b/docs/native-api/FocusNavigationReason-api-windows.md @@ -0,0 +1,21 @@ +--- +id: FocusNavigationReason +title: FocusNavigationReason +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `enum` + +> **EXPERIMENTAL** + +sdf + +| Name | Value | Description | +|--|--|--| +|`Restore` | 0x0 | | +|`First` | 0x1 | | +|`Last` | 0x2 | | + +## Referenced by +- [`FocusNavigationRequest`](FocusNavigationRequest) diff --git a/docs/native-api/FocusNavigationRequest-api-windows.md b/docs/native-api/FocusNavigationRequest-api-windows.md new file mode 100644 index 000000000..45bbac971 --- /dev/null +++ b/docs/native-api/FocusNavigationRequest-api-windows.md @@ -0,0 +1,32 @@ +--- +id: FocusNavigationRequest +title: FocusNavigationRequest +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `class` + +> **EXPERIMENTAL** + +Argument type for [`ReactNativeIsland.NavigateFocus`](ReactNativeIsland#navigatefocus). + +## Properties +### Reason + [`FocusNavigationReason`](FocusNavigationReason) `Reason` + +> **EXPERIMENTAL** + +The reason the [`ReactNativeIsland`](ReactNativeIsland) is getting focus. + +## Constructors +### FocusNavigationRequest + **`FocusNavigationRequest`**([`FocusNavigationReason`](FocusNavigationReason) reason) + +> **EXPERIMENTAL** + +Creates new instance of [`FocusNavigationRequest`](FocusNavigationRequest) + +## Referenced by +- [`CompositionHwndHost`](CompositionHwndHost) +- [`ReactNativeIsland`](ReactNativeIsland) diff --git a/docs/native-api/FocusNavigationResult-api-windows.md b/docs/native-api/FocusNavigationResult-api-windows.md new file mode 100644 index 000000000..f85ecdcce --- /dev/null +++ b/docs/native-api/FocusNavigationResult-api-windows.md @@ -0,0 +1,24 @@ +--- +id: FocusNavigationResult +title: FocusNavigationResult +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `class` + +> **EXPERIMENTAL** + +Provides result from a [`ReactNativeIsland.NavigateFocus`](ReactNativeIsland#navigatefocus) method call. + +## Properties +### WasFocusMoved +`readonly` bool `WasFocusMoved` + +> **EXPERIMENTAL** + +Gets a value that indicates whether the focus successfully moved. + +## Referenced by +- [`CompositionHwndHost`](CompositionHwndHost) +- [`ReactNativeIsland`](ReactNativeIsland) diff --git a/docs/native-api/GaussianBlurEffect-api-windows.md b/docs/native-api/GaussianBlurEffect-api-windows.md index 9ce40b665..d2bf8e8ed 100644 --- a/docs/native-api/GaussianBlurEffect-api-windows.md +++ b/docs/native-api/GaussianBlurEffect-api-windows.md @@ -3,6 +3,8 @@ id: GaussianBlurEffect title: GaussianBlurEffect --- +![Architecture](https://img.shields.io/badge/architecture-old_only-yellow) + Kind: `class` Implements: [`IGraphicsEffect`](https://docs.microsoft.com/uwp/api/Windows.Graphics.Effects.IGraphicsEffect), [`IGraphicsEffectSource`](https://docs.microsoft.com/uwp/api/Windows.Graphics.Effects.IGraphicsEffectSource) @@ -22,7 +24,3 @@ Implements: [`IGraphicsEffect`](https://docs.microsoft.com/uwp/api/Windows.Graph ### Source [`IGraphicsEffectSource`](https://docs.microsoft.com/uwp/api/Windows.Graphics.Effects.IGraphicsEffectSource) `Source` - - - - diff --git a/docs/native-api/GettingFocusEventArgs-api-windows.md b/docs/native-api/GettingFocusEventArgs-api-windows.md new file mode 100644 index 000000000..21bce2534 --- /dev/null +++ b/docs/native-api/GettingFocusEventArgs-api-windows.md @@ -0,0 +1,45 @@ +--- +id: GettingFocusEventArgs +title: GettingFocusEventArgs +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `class` + +Implements: [`RoutedEventArgs`](RoutedEventArgs) + +> **EXPERIMENTAL** + +## Properties +### Direction +`readonly` [`FocusNavigationDirection`](FocusNavigationDirection) `Direction` + +> **EXPERIMENTAL** + +### NewFocusedComponent +`readonly` [`ComponentView`](ComponentView) `NewFocusedComponent` + +> **EXPERIMENTAL** + +### OldFocusedComponent +`readonly` [`ComponentView`](ComponentView) `OldFocusedComponent` + +> **EXPERIMENTAL** + +### OriginalSource +`readonly` int `OriginalSource` + +## Methods +### TryCancel +void **`TryCancel`**() + +> **EXPERIMENTAL** + +### TrySetNewFocusedComponent +void **`TrySetNewFocusedComponent`**([`ComponentView`](ComponentView) component) + +> **EXPERIMENTAL** + +## Referenced by +- [`ComponentView`](ComponentView) diff --git a/docs/native-api/HandleCommandArgs-api-windows.md b/docs/native-api/HandleCommandArgs-api-windows.md new file mode 100644 index 000000000..7adda4647 --- /dev/null +++ b/docs/native-api/HandleCommandArgs-api-windows.md @@ -0,0 +1,29 @@ +--- +id: HandleCommandArgs +title: HandleCommandArgs +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `class` + +> **EXPERIMENTAL** + +## Properties +### CommandArgs +`readonly` [`IJSValueReader`](IJSValueReader) `CommandArgs` + +> **EXPERIMENTAL** + +### CommandName +`readonly` string `CommandName` + +> **EXPERIMENTAL** + +### Handled + bool `Handled` + +> **EXPERIMENTAL** + +## Referenced by +- [`HandleCommandDelegate`](HandleCommandDelegate) diff --git a/docs/native-api/HandleCommandDelegate-api-windows.md b/docs/native-api/HandleCommandDelegate-api-windows.md new file mode 100644 index 000000000..f708bbc85 --- /dev/null +++ b/docs/native-api/HandleCommandDelegate-api-windows.md @@ -0,0 +1,16 @@ +--- +id: HandleCommandDelegate +title: HandleCommandDelegate +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `delegate` + +> **EXPERIMENTAL** + +## Invoke +void **`Invoke`**([`ComponentView`](ComponentView) source, [`HandleCommandArgs`](HandleCommandArgs) args) + +## Referenced by +- [`IReactViewComponentBuilder`](IReactViewComponentBuilder) diff --git a/docs/native-api/HttpSettings-api-windows.md b/docs/native-api/HttpSettings-api-windows.md index 92aa192f4..72a6cd5eb 100644 --- a/docs/native-api/HttpSettings-api-windows.md +++ b/docs/native-api/HttpSettings-api-windows.md @@ -3,20 +3,14 @@ id: HttpSettings title: HttpSettings --- -Kind: `class` - +![Architecture](https://img.shields.io/badge/architecture-new_&_old-green) +Kind: `class` Provides settings for Http functionality. - - ## Methods ### SetDefaultUserAgent `static` void **`SetDefaultUserAgent`**([`ReactInstanceSettings`](ReactInstanceSettings) settings, string userAgent) Configures the react instance to use a user-agent header by default on http requests. - - - - diff --git a/docs/native-api/IActivityVisual-api-windows.md b/docs/native-api/IActivityVisual-api-windows.md new file mode 100644 index 000000000..ae7f81935 --- /dev/null +++ b/docs/native-api/IActivityVisual-api-windows.md @@ -0,0 +1,28 @@ +--- +id: IActivityVisual +title: IActivityVisual +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `interface` + +Implements: [`IVisual`](IVisual) + +> **EXPERIMENTAL** + +## Methods +### Brush +void **`Brush`**([`IBrush`](IBrush) brush) + +### Size +void **`Size`**(float value) + +### StartAnimation +void **`StartAnimation`**() + +### StopAnimation +void **`StopAnimation`**() + +## Referenced by +- [`ICompositionContext`](ICompositionContext) diff --git a/docs/native-api/IBrush-api-windows.md b/docs/native-api/IBrush-api-windows.md new file mode 100644 index 000000000..4ddc392a2 --- /dev/null +++ b/docs/native-api/IBrush-api-windows.md @@ -0,0 +1,23 @@ +--- +id: IBrush +title: IBrush +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `interface` + +> **EXPERIMENTAL** + +## Referenced by +- [`IActivityVisual`](IActivityVisual) +- [`ICaretVisual`](ICaretVisual) +- [`ICompositionContext`](ICompositionContext) +- [`IInternalColor`](IInternalColor) +- [`IInternalTheme`](IInternalTheme) +- [`IRoundedRectangleVisual`](IRoundedRectangleVisual) +- [`IScrollVisual`](IScrollVisual) +- [`ISpriteVisual`](ISpriteVisual) +- [`MicrosoftCompositionContextHelper`](MicrosoftCompositionContextHelper) +- [`SystemCompositionContextHelper`](SystemCompositionContextHelper) +- [`UriBrushFactory`](UriBrushFactory) diff --git a/docs/native-api/ICaretVisual-api-windows.md b/docs/native-api/ICaretVisual-api-windows.md new file mode 100644 index 000000000..e1b79d664 --- /dev/null +++ b/docs/native-api/ICaretVisual-api-windows.md @@ -0,0 +1,30 @@ +--- +id: ICaretVisual +title: ICaretVisual +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `interface` + +> **EXPERIMENTAL** + +## Properties +### InnerVisual +`readonly` [`IVisual`](IVisual) `InnerVisual` + +### IsVisible + bool `IsVisible` + +## Methods +### Brush +void **`Brush`**([`IBrush`](IBrush) brush) + +### Position +void **`Position`**([`Vector2`](https://docs.microsoft.com/uwp/api/Windows.Foundation.Numerics.Vector2) position) + +### Size +void **`Size`**([`Vector2`](https://docs.microsoft.com/uwp/api/Windows.Foundation.Numerics.Vector2) size) + +## Referenced by +- [`ICompositionContext`](ICompositionContext) diff --git a/docs/native-api/IComponentProps-api-windows.md b/docs/native-api/IComponentProps-api-windows.md new file mode 100644 index 000000000..8ef4dd908 --- /dev/null +++ b/docs/native-api/IComponentProps-api-windows.md @@ -0,0 +1,23 @@ +--- +id: IComponentProps +title: IComponentProps +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `interface` + +> **EXPERIMENTAL** + +Interface to implement custom view component properties. + +## Methods +### SetProp +void **`SetProp`**(uint32_t hash, string propName, [`IJSValueReader`](IJSValueReader) value) + +This method will be called for each property that comes from JavaScript. It is up to an individual implementation to store the values of properties for access within its UpdateProps. Properties that are part of ViewProps can be accessed from the [`ViewProps`](ViewProps) object, and so do not need to be stored. + +## Referenced by +- [`InitialStateDataFactory`](InitialStateDataFactory) +- [`UpdatePropsDelegate`](UpdatePropsDelegate) +- [`ViewPropsFactory`](ViewPropsFactory) diff --git a/docs/native-api/IComponentState-api-windows.md b/docs/native-api/IComponentState-api-windows.md new file mode 100644 index 000000000..d33eca626 --- /dev/null +++ b/docs/native-api/IComponentState-api-windows.md @@ -0,0 +1,24 @@ +--- +id: IComponentState +title: IComponentState +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `interface` + +> **EXPERIMENTAL** + +## Properties +### Data +`readonly` Object `Data` + +## Methods +### UpdateState +void **`UpdateState`**(Object data) + +### UpdateStateWithMutation +void **`UpdateStateWithMutation`**([`StateUpdateMutation`](StateUpdateMutation) mutation) + +## Referenced by +- [`UpdateStateDelegate`](UpdateStateDelegate) diff --git a/docs/native-api/ICompositionContext-api-windows.md b/docs/native-api/ICompositionContext-api-windows.md new file mode 100644 index 000000000..2ba85a412 --- /dev/null +++ b/docs/native-api/ICompositionContext-api-windows.md @@ -0,0 +1,44 @@ +--- +id: ICompositionContext +title: ICompositionContext +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `interface` + +> **EXPERIMENTAL** + +## Methods +### CreateActivityVisual +[`IActivityVisual`](IActivityVisual) **`CreateActivityVisual`**() + +### CreateCaretVisual +[`ICaretVisual`](ICaretVisual) **`CreateCaretVisual`**() + +### CreateColorBrush +[`IBrush`](IBrush) **`CreateColorBrush`**([`Color`](https://docs.microsoft.com/uwp/api/Windows.UI.Color) color) + +### CreateDrawingSurfaceBrush +[`IDrawingSurfaceBrush`](IDrawingSurfaceBrush) **`CreateDrawingSurfaceBrush`**([`Size`](https://docs.microsoft.com/uwp/api/Windows.Foundation.Size) surfaceSize, [`DirectXPixelFormat`](https://docs.microsoft.com/uwp/api/Windows.Graphics.DirectX.DirectXPixelFormat) pixelFormat, [`DirectXAlphaMode`](https://docs.microsoft.com/uwp/api/Windows.Graphics.DirectX.DirectXAlphaMode) alphaMode) + +### CreateDropShadow +[`IDropShadow`](IDropShadow) **`CreateDropShadow`**() + +### CreateFocusVisual +[`IFocusVisual`](IFocusVisual) **`CreateFocusVisual`**() + +### CreateRoundedRectangleVisual +[`IRoundedRectangleVisual`](IRoundedRectangleVisual) **`CreateRoundedRectangleVisual`**() + +### CreateScrollerVisual +[`IScrollVisual`](IScrollVisual) **`CreateScrollerVisual`**() + +### CreateSpriteVisual +[`ISpriteVisual`](ISpriteVisual) **`CreateSpriteVisual`**() + +## Referenced by +- [`IInternalComponentView`](IInternalComponentView) +- [`MicrosoftCompositionContextHelper`](MicrosoftCompositionContextHelper) +- [`SystemCompositionContextHelper`](SystemCompositionContextHelper) +- [`UriBrushFactory`](UriBrushFactory) diff --git a/docs/native-api/ICustomResourceLoader-api-windows.md b/docs/native-api/ICustomResourceLoader-api-windows.md new file mode 100644 index 000000000..12fd18a5c --- /dev/null +++ b/docs/native-api/ICustomResourceLoader-api-windows.md @@ -0,0 +1,28 @@ +--- +id: ICustomResourceLoader +title: ICustomResourceLoader +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `interface` + +> **EXPERIMENTAL** + +Applications can implement this interface to provide custom values for native platform colors. + +## Methods +### GetResource +void **`GetResource`**(string resourceId, [`ResourceType`](ResourceType) resourceType, [`CustomResourceResult`](CustomResourceResult) result) + +Called when a theme is queried for a specific resource. resourceId will be the name of the platform color. Implementations should return an empty result if the resource is not being overridden. + +## Events +### `ResourcesChanged` +Implementations should raise this event if the platform colors will return new values + +Type: [`EventHandler`](https://docs.microsoft.com/uwp/api/Windows.Foundation.EventHandler-1) + +## Referenced by +- [`ReactNativeIsland`](ReactNativeIsland) +- [`Theme`](Theme) diff --git a/docs/native-api/IDrawingSurfaceBrush-api-windows.md b/docs/native-api/IDrawingSurfaceBrush-api-windows.md new file mode 100644 index 000000000..a10e82fa4 --- /dev/null +++ b/docs/native-api/IDrawingSurfaceBrush-api-windows.md @@ -0,0 +1,27 @@ +--- +id: IDrawingSurfaceBrush +title: IDrawingSurfaceBrush +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `interface` + +Implements: [`IBrush`](IBrush) + +> **EXPERIMENTAL** + +## Methods +### HorizontalAlignmentRatio +void **`HorizontalAlignmentRatio`**(float value) + +### Stretch +void **`Stretch`**([`CompositionStretch`](CompositionStretch) value) + +### VerticalAlignmentRatio +void **`VerticalAlignmentRatio`**(float value) + +## Referenced by +- [`ICompositionContext`](ICompositionContext) +- [`MicrosoftCompositionContextHelper`](MicrosoftCompositionContextHelper) +- [`SystemCompositionContextHelper`](SystemCompositionContextHelper) diff --git a/docs/native-api/IDropShadow-api-windows.md b/docs/native-api/IDropShadow-api-windows.md new file mode 100644 index 000000000..b0837b088 --- /dev/null +++ b/docs/native-api/IDropShadow-api-windows.md @@ -0,0 +1,29 @@ +--- +id: IDropShadow +title: IDropShadow +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `interface` + +> **EXPERIMENTAL** + +## Methods +### BlurRadius +void **`BlurRadius`**(float value) + +### Color +void **`Color`**([`Color`](https://docs.microsoft.com/uwp/api/Windows.UI.Color) value) + +### Offset +void **`Offset`**([`Vector3`](https://docs.microsoft.com/uwp/api/Windows.Foundation.Numerics.Vector3) value) + +### Opacity +void **`Opacity`**(float value) + +## Referenced by +- [`ICompositionContext`](ICompositionContext) +- [`ISpriteVisual`](ISpriteVisual) +- [`MicrosoftCompositionContextHelper`](MicrosoftCompositionContextHelper) +- [`SystemCompositionContextHelper`](SystemCompositionContextHelper) diff --git a/docs/native-api/IFocusVisual-api-windows.md b/docs/native-api/IFocusVisual-api-windows.md new file mode 100644 index 000000000..92a065c99 --- /dev/null +++ b/docs/native-api/IFocusVisual-api-windows.md @@ -0,0 +1,23 @@ +--- +id: IFocusVisual +title: IFocusVisual +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `interface` + +> **EXPERIMENTAL** + +## Properties +### InnerVisual +`readonly` [`IVisual`](IVisual) `InnerVisual` + +### IsFocused + bool `IsFocused` + +### ScaleFactor + float `ScaleFactor` + +## Referenced by +- [`ICompositionContext`](ICompositionContext) diff --git a/docs/native-api/IInternalColor-api-windows.md b/docs/native-api/IInternalColor-api-windows.md new file mode 100644 index 000000000..7e076d4fd --- /dev/null +++ b/docs/native-api/IInternalColor-api-windows.md @@ -0,0 +1,14 @@ +--- +id: IInternalColor +title: IInternalColor +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `interface` + +> **EXPERIMENTAL** + +## Methods +### AsInternalBrush +[`IBrush`](IBrush) **`AsInternalBrush`**([`Theme`](Theme) theme) diff --git a/docs/native-api/IInternalComponentView-api-windows.md b/docs/native-api/IInternalComponentView-api-windows.md new file mode 100644 index 000000000..5d0286f16 --- /dev/null +++ b/docs/native-api/IInternalComponentView-api-windows.md @@ -0,0 +1,14 @@ +--- +id: IInternalComponentView +title: IInternalComponentView +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `interface` + +> **EXPERIMENTAL** + +## Properties +### CompositionContext +`readonly` [`ICompositionContext`](ICompositionContext) `CompositionContext` diff --git a/docs/native-api/IInternalCompositionRootView-api-windows.md b/docs/native-api/IInternalCompositionRootView-api-windows.md new file mode 100644 index 000000000..7f06b2a05 --- /dev/null +++ b/docs/native-api/IInternalCompositionRootView-api-windows.md @@ -0,0 +1,35 @@ +--- +id: IInternalCompositionRootView +title: IInternalCompositionRootView +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `interface` + +> **EXPERIMENTAL** + +Custom ViewComponents need to implement this interface to be able to provide a custom visual using the composition context that allows custom compositors. This is only required for custom components that need to support running in RNW instances with custom compositors. Most custom components can just override CreateVisual on ViewComponentView. This interface will be removed in future versions + +## Properties +### InternalRootVisual + [`IVisual`](IVisual) `InternalRootVisual` + +The RootVisual associated with the ReactNativeIsland (unresolved reference). It must be set to show any React UI elements. + +## Methods +### OnMounted +void **`OnMounted`**() + +### OnUnmounted +void **`OnUnmounted`**() + +### SendMessage +int64_t **`SendMessage`**(uint32_t Msg, uint64_t WParam, int64_t LParam) + +Forward input to the RootView. Only required when not using ContentIslands + +### SetWindow +void **`SetWindow`**(uint64_t hwnd) + +Hosting Window that input is coming from. Only required when not using ContentIslands diff --git a/docs/native-api/IInternalCreateVisual-api-windows.md b/docs/native-api/IInternalCreateVisual-api-windows.md new file mode 100644 index 000000000..47d54ac3c --- /dev/null +++ b/docs/native-api/IInternalCreateVisual-api-windows.md @@ -0,0 +1,16 @@ +--- +id: IInternalCreateVisual +title: IInternalCreateVisual +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `interface` + +> **EXPERIMENTAL** + +Custom ViewComponents need to implement this interface to be able to provide a custom visual using the composition context that allows custom compositors. This is only required for custom components that need to support running in RNW instances with custom compositors. Most custom components can just set CreateVisualHandler on ViewComponentView. This will be removed in a future version + +## Properties +### CreateInternalVisualHandler + [`CreateInternalVisualDelegate`](CreateInternalVisualDelegate) `CreateInternalVisualHandler` diff --git a/docs/native-api/IInternalTheme-api-windows.md b/docs/native-api/IInternalTheme-api-windows.md new file mode 100644 index 000000000..b34e8f1a9 --- /dev/null +++ b/docs/native-api/IInternalTheme-api-windows.md @@ -0,0 +1,14 @@ +--- +id: IInternalTheme +title: IInternalTheme +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `interface` + +> **EXPERIMENTAL** + +## Methods +### InternalPlatformBrush +[`IBrush`](IBrush) **`InternalPlatformBrush`**(string platformColor) diff --git a/docs/native-api/IJSValueReader-api-windows.md b/docs/native-api/IJSValueReader-api-windows.md index ef8671df0..5657df7ad 100644 --- a/docs/native-api/IJSValueReader-api-windows.md +++ b/docs/native-api/IJSValueReader-api-windows.md @@ -3,9 +3,11 @@ id: IJSValueReader title: IJSValueReader --- -Kind: `interface` +![Architecture](https://img.shields.io/badge/architecture-new_&_old-green) +## New Architecture +Kind: `interface` Forward-only reader for JSON-like streams. It is used to read data sent between native modules and the Microsoft.ReactNative library. @@ -18,37 +20,29 @@ See the [`IJSValueWriter`](IJSValueWriter) for the corresponding writer interfac The [`IJSValueReader`](IJSValueReader) and [`IJSValueWriter`](IJSValueWriter) must be rarely used directly. Use them to create functions that serialize a native type or deserialize into a native 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 +### Properties +#### ValueType `readonly` [`JSValueType`](JSValueType) `ValueType` Gets the type of the current value. - - -## Methods -### GetBoolean +### Methods +#### GetBoolean bool **`GetBoolean`**() Gets the current `Boolean` value. - - -### GetDouble +#### GetDouble double **`GetDouble`**() Gets the current `Number` value as a `Double`. - - -### GetInt64 +#### GetInt64 int64_t **`GetInt64`**() Gets the current `Number` value as an `Int64`. - - -### GetNextArrayItem +#### GetNextArrayItem bool **`GetNextArrayItem`**() Advances the iterator within the current array to fetch the next array element. The element can then be obtained by calling one of the Get functions. @@ -60,9 +54,7 @@ Returns **`true`** if the next array item is acquired successfully. Otherwise, i - Use [`GetNextObjectProperty`](#getnextobjectproperty) method to start reading property value of type [`JSValueType`](JSValueType) `Object`. - Use [`GetNextArrayItem`](#getnextarrayitem) method to start reading property value of type [`JSValueType`](JSValueType) `Array - - -### GetNextObjectProperty +#### GetNextObjectProperty bool **`GetNextObjectProperty`**(**out** string propertyName) Advances the iterator within the current object to fetch the next object property. The property value can then be obtained by calling one of the Get functions. @@ -74,19 +66,87 @@ Returns **`true`** if the next property is acquired successfully. In that case t - Use [`GetNextObjectProperty`](#getnextobjectproperty) method to start reading property value of type [`JSValueType`](JSValueType) `Object`. - Use [`GetNextArrayItem`](#getnextarrayitem) method to start reading property value of type [`JSValueType`](JSValueType) `Array - - -### GetString +#### GetString string **`GetString`**() Gets the current `String` value. +### Referenced by +- [`Color`](Color) +- [`HandleCommandArgs`](HandleCommandArgs) +- [`IComponentProps`](IComponentProps) +- [`IRedBoxErrorInfo`](IRedBoxErrorInfo) +- [`ImageSource`](ImageSource) +- [`MethodDelegate`](MethodDelegate) +- [`SyncMethodDelegate`](SyncMethodDelegate) +## Old Architecture +Kind: `interface` +Forward-only reader for JSON-like streams. +It is used to read data sent between native modules and the Microsoft.ReactNative library. +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. For example, if the current value type is `Object`, one must call [`GetNextObjectProperty`](#getnextobjectproperty) to start reading the current object's properties, and if the current type is `Array`, [`GetNextArrayItem`](#getnextarrayitem) must be called to start reading the elements in the array. These functions must be called in a loop until they return false, which signifies that there are no more items within the object or array being traversed. + +See the [`IJSValueWriter`](IJSValueWriter) for the corresponding writer interface. + +The [`IJSValueReader`](IJSValueReader) and [`IJSValueWriter`](IJSValueWriter) must be rarely used directly. Use them to create functions that serialize a native type or deserialize into a native 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`**() + +Advances the iterator within the current array to fetch the next array element. The element can then be obtained by calling one of the Get functions. + +Returns **`true`** if the next array item is acquired successfully. Otherwise, it returns **`false`**, meaning 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`](JSValueType) `Object`. +- Use [`GetNextArrayItem`](#getnextarrayitem) method to start reading property value of type [`JSValueType`](JSValueType) `Array + +#### GetNextObjectProperty +bool **`GetNextObjectProperty`**(**out** string propertyName) + +Advances the iterator within the current object to fetch the next object property. The property value can then be obtained by calling one of the Get functions. + +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`**, meaning 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`](JSValueType) `Object`. +- Use [`GetNextArrayItem`](#getnextarrayitem) method to start reading property value of type [`JSValueType`](JSValueType) `Array + +#### GetString +string **`GetString`**() + +Gets the current `String` value. -## Referenced by +### Referenced by - [`IRedBoxErrorInfo`](IRedBoxErrorInfo) - [`IViewManagerCreateWithProperties`](IViewManagerCreateWithProperties) - [`IViewManagerWithCommands`](IViewManagerWithCommands) diff --git a/docs/native-api/IJSValueWriter-api-windows.md b/docs/native-api/IJSValueWriter-api-windows.md index 39d2de6c4..c0283c6e1 100644 --- a/docs/native-api/IJSValueWriter-api-windows.md +++ b/docs/native-api/IJSValueWriter-api-windows.md @@ -3,9 +3,11 @@ id: IJSValueWriter title: IJSValueWriter --- -Kind: `interface` +![Architecture](https://img.shields.io/badge/architecture-new_&_old-green) +## New Architecture +Kind: `interface` JSON-like stream writer. It is used to write data that is sent between native modules and the Microsoft.ReactNative library. @@ -16,83 +18,130 @@ See the [`IJSValueReader`](IJSValueReader) for the corresponding reader interfac The [`IJSValueReader`](IJSValueReader) and [`IJSValueWriter`](IJSValueWriter) must be rarely used directly. Use them to create functions that serialize a native type or deserialize into a native 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 +### Methods +#### WriteArrayBegin void **`WriteArrayBegin`**() Starts writing an array. - - -### WriteArrayEnd +#### WriteArrayEnd void **`WriteArrayEnd`**() Completes writing an array. - - -### WriteBoolean +#### WriteBoolean void **`WriteBoolean`**(bool value) Writes a `Boolean` value. - - -### WriteDouble +#### WriteDouble void **`WriteDouble`**(double value) Writes a `Number` value from a double. - - -### WriteInt64 +#### WriteInt64 void **`WriteInt64`**(int64_t value) Writes a `Number` value from an integer. - - -### WriteNull +#### WriteNull void **`WriteNull`**() Writes a `Null` value. - - -### WriteObjectBegin +#### WriteObjectBegin void **`WriteObjectBegin`**() Starts writing an `Object`. - - -### WriteObjectEnd +#### WriteObjectEnd void **`WriteObjectEnd`**() Completes writing an object. - - -### WritePropertyName +#### 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 +#### WriteString void **`WriteString`**(string value) Writes a `String` value. +### Referenced by +- [`Color`](Color) +- [`ConstantProviderDelegate`](ConstantProviderDelegate) +- [`JSValueArgWriter`](JSValueArgWriter) +- [`MethodDelegate`](MethodDelegate) +- [`MethodResultCallback`](MethodResultCallback) +- [`SyncMethodDelegate`](SyncMethodDelegate) +## Old Architecture +Kind: `interface` +JSON-like stream writer. +It is used to write data that is sent between native modules and the Microsoft.ReactNative library. + +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 functions that serialize a native type or deserialize into a native 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 +### Referenced by - [`ConstantProviderDelegate`](ConstantProviderDelegate) - [`JSValueArgWriter`](JSValueArgWriter) - [`MethodDelegate`](MethodDelegate) diff --git a/docs/native-api/IJsiByteBuffer-api-windows.md b/docs/native-api/IJsiByteBuffer-api-windows.md index 3c86416ee..34bb311b9 100644 --- a/docs/native-api/IJsiByteBuffer-api-windows.md +++ b/docs/native-api/IJsiByteBuffer-api-windows.md @@ -3,9 +3,9 @@ id: IJsiByteBuffer title: IJsiByteBuffer --- -Kind: `interface` - +![Architecture](https://img.shields.io/badge/architecture-new_&_old-green) +Kind: `interface` > **EXPERIMENTAL** @@ -17,16 +17,9 @@ Note that the JSI is defined only for C++ code. We plan to add the .Net support ### Size `readonly` uint32_t `Size` - - ## Methods ### GetData void **`GetData`**([`JsiByteArrayUser`](JsiByteArrayUser) useBytes) - - - - - ## Referenced by - [`JsiRuntime`](JsiRuntime) diff --git a/docs/native-api/IJsiHostObject-api-windows.md b/docs/native-api/IJsiHostObject-api-windows.md index e174907d4..159fe5342 100644 --- a/docs/native-api/IJsiHostObject-api-windows.md +++ b/docs/native-api/IJsiHostObject-api-windows.md @@ -3,9 +3,9 @@ id: IJsiHostObject title: IJsiHostObject --- -Kind: `interface` - +![Architecture](https://img.shields.io/badge/architecture-new_&_old-green) +Kind: `interface` > **EXPERIMENTAL** @@ -13,26 +13,15 @@ An experimental API. Do not use it directly. It may be removed or changed in a f See the `ExecuteJsi` method in `JsiApiContext.h` of the `Microsoft.ReactNative.Cxx` shared project, or the examples of the JSI-based TurboModules in the `Microsoft.ReactNative.IntegrationTests` project. Note that the JSI is defined only for C++ code. We plan to add the .Net support in future. - - ## 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/docs/native-api/IPointerPointTransform-api-windows.md b/docs/native-api/IPointerPointTransform-api-windows.md new file mode 100644 index 000000000..f7a5f47a5 --- /dev/null +++ b/docs/native-api/IPointerPointTransform-api-windows.md @@ -0,0 +1,19 @@ +--- +id: IPointerPointTransform +title: IPointerPointTransform +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `interface` + +## Properties +### Inverse +`readonly` [`IPointerPointTransform`](IPointerPointTransform) `Inverse` + +## Methods +### TryTransform +bool **`TryTransform`**([`Point`](https://docs.microsoft.com/uwp/api/Windows.Foundation.Point) inPoint, **out** [`Point`](https://docs.microsoft.com/uwp/api/Windows.Foundation.Point) outPoint) + +### TryTransformBounds +bool **`TryTransformBounds`**([`Rect`](https://docs.microsoft.com/uwp/api/Windows.Foundation.Rect) inRect, **out** [`Rect`](https://docs.microsoft.com/uwp/api/Windows.Foundation.Rect) outRect) diff --git a/docs/native-api/IPortalStateData-api-windows.md b/docs/native-api/IPortalStateData-api-windows.md new file mode 100644 index 000000000..fb44c8961 --- /dev/null +++ b/docs/native-api/IPortalStateData-api-windows.md @@ -0,0 +1,19 @@ +--- +id: IPortalStateData +title: IPortalStateData +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `interface` + +> **EXPERIMENTAL** + +StateData type to be used with a PortalComponentView. The LayoutConstraints and PointScaleFactor will be used to layout the content of the Portal + +## Properties +### LayoutConstraints +`readonly` [`LayoutConstraints`](LayoutConstraints) `LayoutConstraints` + +### PointScaleFactor +`readonly` float `PointScaleFactor` diff --git a/docs/native-api/IReactCompositionViewComponentBuilder-api-windows.md b/docs/native-api/IReactCompositionViewComponentBuilder-api-windows.md new file mode 100644 index 000000000..8802a3f75 --- /dev/null +++ b/docs/native-api/IReactCompositionViewComponentBuilder-api-windows.md @@ -0,0 +1,34 @@ +--- +id: IReactCompositionViewComponentBuilder +title: IReactCompositionViewComponentBuilder +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `interface` + +> **EXPERIMENTAL** + +. + +## Methods +### SetContentIslandComponentViewInitializer +void **`SetContentIslandComponentViewInitializer`**([`ComponentIslandComponentViewInitializer`](ComponentIslandComponentViewInitializer) initializer) + +### SetCreateVisualHandler +void **`SetCreateVisualHandler`**([`CreateVisualDelegate`](CreateVisualDelegate) impl) + +### SetPortalComponentViewInitializer +void **`SetPortalComponentViewInitializer`**([`PortalComponentViewInitializer`](PortalComponentViewInitializer) initializer) + +### SetUpdateLayoutMetricsHandler +void **`SetUpdateLayoutMetricsHandler`**([`UpdateLayoutMetricsDelegate`](UpdateLayoutMetricsDelegate) impl) + +### SetViewComponentViewInitializer +void **`SetViewComponentViewInitializer`**([`ViewComponentViewInitializer`](ViewComponentViewInitializer) initializer) + +### SetViewFeatures +void **`SetViewFeatures`**([`ComponentViewFeatures`](ComponentViewFeatures) viewFeatures) + +### SetVisualToMountChildrenIntoHandler +void **`SetVisualToMountChildrenIntoHandler`**([`VisualToMountChildrenIntoDelegate`](VisualToMountChildrenIntoDelegate) impl) diff --git a/docs/native-api/IReactCompositionViewComponentInternalBuilder-api-windows.md b/docs/native-api/IReactCompositionViewComponentInternalBuilder-api-windows.md new file mode 100644 index 000000000..3c0e0c9d4 --- /dev/null +++ b/docs/native-api/IReactCompositionViewComponentInternalBuilder-api-windows.md @@ -0,0 +1,16 @@ +--- +id: IReactCompositionViewComponentInternalBuilder +title: IReactCompositionViewComponentInternalBuilder +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `interface` + +> **EXPERIMENTAL** + +This interface is for use when running react-native-windows using a custom compositor. This interface will be removed in future versions + +## Methods +### SetIVisualToMountChildrenIntoHandler +void **`SetIVisualToMountChildrenIntoHandler`**([`IVisualToMountChildrenIntoDelegate`](IVisualToMountChildrenIntoDelegate) impl) diff --git a/docs/native-api/IReactContext-api-windows.md b/docs/native-api/IReactContext-api-windows.md index 904b5d934..7f4c7f9ff 100644 --- a/docs/native-api/IReactContext-api-windows.md +++ b/docs/native-api/IReactContext-api-windows.md @@ -3,9 +3,11 @@ id: IReactContext title: IReactContext --- -Kind: `interface` +![Architecture](https://img.shields.io/badge/architecture-new_&_old-green) +## New Architecture +Kind: `interface` The `IReactContext` object is a weak pointer to the React instance. It allows native modules and view managers to communicate with the application, and with other native modules and view managers. Since the [`IReactContext`](IReactContext) is a weak pointer to the React instance, some of its functionality becomes unavailable after the React instance is unloaded. When a React instance is reloaded inside of the [`ReactNativeHost`](ReactNativeHost), the previous React instance is unloaded and then a new React instance is created with a new [`IReactContext`](IReactContext). @@ -15,26 +17,34 @@ Since the [`IReactContext`](IReactContext) is a weak pointer to the React instan - Use [`UIDispatcher`](#uidispatcher) to post asynchronous work in the UI thread. - Use [`JSDispatcher`](#jsdispatcher) to post asynchronous work in the JavaScript engine thread. -## Properties -### JSDispatcher +### Properties +#### CallInvoker +`readonly` [`CallInvoker`](CallInvoker) `CallInvoker` + +used to schedule work on the JS runtime. Most direct usage of this should be avoided by using ReactContext.CallInvoker. + +#### JSDispatcher `readonly` [`IReactDispatcher`](IReactDispatcher) `JSDispatcher` +> **Deprecated**: Use [`IReactContext.CallInvoker`](IReactContext#callinvoker) instead + Gets the JavaScript engine thread dispatcher. It is a shortcut for the [`ReactDispatcherHelper.JSDispatcherProperty`](ReactDispatcherHelper#jsdispatcherproperty) from the [`Properties`](#properties-1) property bag. -### JSRuntime +#### JSRuntime `readonly` Object `JSRuntime` Gets the JavaScript runtime for the running React instance. It can be null if Web debugging is used. -**Note: do not use this property directly. It is an experimental property that may be removed or changed in a future version. +**Note: do not use this property directly. It is an experimental property will be removed in a future version. +Deprecated for new Arch: Use [`IReactContext.CallInvoker`](IReactContext#callinvoker) instead. -### LoadingState +#### LoadingState `readonly` [`LoadingState`](LoadingState) `LoadingState` Gets the state of the ReactNative instance. -### Notifications +#### Notifications `readonly` [`IReactNotificationService`](IReactNotificationService) `Notifications` Gets the [`IReactNotificationService`](IReactNotificationService) shared with the [`ReactInstanceSettings.Notifications`](ReactInstanceSettings#notifications). @@ -42,62 +52,142 @@ It can be used to send notifications events between components and the applicati All notification subscriptions added to the [`IReactContext.Notifications`](IReactContext#notifications) are automatically removed after the [`IReactContext`](IReactContext) is destroyed. The notification subscriptions added to the [`ReactInstanceSettings.Notifications`](ReactInstanceSettings#notifications) are kept as long as the [`ReactInstanceSettings`](ReactInstanceSettings) is alive. -### Properties +#### Properties `readonly` [`IReactPropertyBag`](IReactPropertyBag) `Properties` Gets the [`IReactPropertyBag`](IReactPropertyBag) shared with the [`ReactInstanceSettings.Properties`](ReactInstanceSettings#properties-1). It can be used to share values and state between components and the applications. -### SettingsSnapshot +#### SettingsSnapshot `readonly` [`IReactSettingsSnapshot`](IReactSettingsSnapshot) `SettingsSnapshot` Gets the settings snapshot that was used to start the React instance. -### UIDispatcher +#### UIDispatcher `readonly` [`IReactDispatcher`](IReactDispatcher) `UIDispatcher` Gets the UI thread dispatcher. It is a shortcut for the [`ReactDispatcherHelper.UIDispatcherProperty`](ReactDispatcherHelper#uidispatcherproperty) from the [`Properties`](#properties-1) property bag. - - -## Methods -### CallJSFunction +### Methods +#### CallJSFunction void **`CallJSFunction`**(string moduleName, string methodName, [`JSValueArgWriter`](JSValueArgWriter) paramsArgWriter) Calls the JavaScript function named `methodName` of `moduleName` with the `paramsArgWriter`. The `paramsArgWriter` is a [`JSValueArgWriter`](JSValueArgWriter) delegate that receives [`IJSValueWriter`](IJSValueWriter) to serialize the method parameters. +#### EmitJSEvent +void **`EmitJSEvent`**(string eventEmitterName, string eventName, [`JSValueArgWriter`](JSValueArgWriter) paramsArgWriter) +Emits JavaScript module event `eventName` for the `eventEmitterName` with the `paramsArgWriter`. +It is a specialized [`CallJSFunction`](#calljsfunction)` call where the method name is always `emit` and the `eventName` is added to parameters. +The `paramsArgWriter` is a [`JSValueArgWriter`](JSValueArgWriter) delegate that receives [`IJSValueWriter`](IJSValueWriter) to serialize the event parameters. -### DispatchEvent -void **`DispatchEvent`**([`FrameworkElement`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.FrameworkElement) view, string eventName, [`JSValueArgWriter`](JSValueArgWriter) eventDataArgWriter) +### Referenced by +- [`ComponentView`](ComponentView) +- [`IReactViewInstance`](IReactViewInstance) +- [`InitializerDelegate`](InitializerDelegate) +- [`InstanceCreatedEventArgs`](InstanceCreatedEventArgs) +- [`InstanceDestroyedEventArgs`](InstanceDestroyedEventArgs) +- [`InstanceLoadedEventArgs`](InstanceLoadedEventArgs) +- [`JsiInitializerDelegate`](JsiInitializerDelegate) +- [`ReactCoreInjection`](ReactCoreInjection) +- [`ReactNativeHost`](ReactNativeHost) +- [`XamlUIService`](XamlUIService) -> **Deprecated**: Use [`XamlUIService.DispatchEvent`](XamlUIService#dispatchevent) instead +## Old Architecture -Deprecated property. Use [`XamlUIService.DispatchEvent`](XamlUIService#dispatchevent) instead. It will be removed in a future version. +Kind: `interface` + +The `IReactContext` object is a weak pointer to the React instance. It allows native modules and view managers to communicate with the application, and with other native modules and view managers. +Since the [`IReactContext`](IReactContext) is a weak pointer to the React instance, some of its functionality becomes unavailable after the React instance is unloaded. When a React instance is reloaded inside of the [`ReactNativeHost`](ReactNativeHost), the previous React instance is unloaded and then a new React instance is created with a new [`IReactContext`](IReactContext). +- Use the [`Properties`](#properties-1) to share native module's data with other components. +- Use the [`Notifications`](#notifications) to exchange events with other components. +- Use [`CallJSFunction`](#calljsfunction) to call JavaScript functions, and [`EmitJSEvent`](#emitjsevent) to raise JavaScript events. +- Use [`UIDispatcher`](#uidispatcher) to post asynchronous work in the UI thread. +- Use [`JSDispatcher`](#jsdispatcher) to post asynchronous work in the JavaScript engine thread. +### Properties +#### CallInvoker +`readonly` [`CallInvoker`](CallInvoker) `CallInvoker` +used to schedule work on the JS runtime. Most direct usage of this should be avoided by using ReactContext.CallInvoker. -### EmitJSEvent -void **`EmitJSEvent`**(string eventEmitterName, string eventName, [`JSValueArgWriter`](JSValueArgWriter) paramsArgWriter) +#### JSDispatcher +`readonly` [`IReactDispatcher`](IReactDispatcher) `JSDispatcher` -Emits JavaScript module event `eventName` for the `eventEmitterName` with the `paramsArgWriter`. -It is a specialized [`CallJSFunction`](#calljsfunction)` call where the method name is always `emit` and the `eventName` is added to parameters. -The `paramsArgWriter` is a [`JSValueArgWriter`](JSValueArgWriter) delegate that receives [`IJSValueWriter`](IJSValueWriter) to serialize the event parameters. +> **Deprecated**: Use [`IReactContext.CallInvoker`](IReactContext#callinvoker) instead + +Gets the JavaScript engine thread dispatcher. +It is a shortcut for the [`ReactDispatcherHelper.JSDispatcherProperty`](ReactDispatcherHelper#jsdispatcherproperty) from the [`Properties`](#properties-1) property bag. +#### JSRuntime +`readonly` Object `JSRuntime` + +Gets the JavaScript runtime for the running React instance. +It can be null if Web debugging is used. +**Note: do not use this property directly. It is an experimental property will be removed in a future version. +Deprecated for new Arch: Use [`IReactContext.CallInvoker`](IReactContext#callinvoker) instead. +#### LoadingState +`readonly` [`LoadingState`](LoadingState) `LoadingState` +Gets the state of the ReactNative instance. +#### Notifications +`readonly` [`IReactNotificationService`](IReactNotificationService) `Notifications` + +Gets the [`IReactNotificationService`](IReactNotificationService) shared with the [`ReactInstanceSettings.Notifications`](ReactInstanceSettings#notifications). +It can be used to send notifications events between components and the application. +All notification subscriptions added to the [`IReactContext.Notifications`](IReactContext#notifications) are automatically removed after the [`IReactContext`](IReactContext) is destroyed. +The notification subscriptions added to the [`ReactInstanceSettings.Notifications`](ReactInstanceSettings#notifications) are kept as long as the [`ReactInstanceSettings`](ReactInstanceSettings) is alive. + +#### Properties +`readonly` [`IReactPropertyBag`](IReactPropertyBag) `Properties` + +Gets the [`IReactPropertyBag`](IReactPropertyBag) shared with the [`ReactInstanceSettings.Properties`](ReactInstanceSettings#properties-1). +It can be used to share values and state between components and the applications. + +#### SettingsSnapshot +`readonly` [`IReactSettingsSnapshot`](IReactSettingsSnapshot) `SettingsSnapshot` + +Gets the settings snapshot that was used to start the React instance. +#### UIDispatcher +`readonly` [`IReactDispatcher`](IReactDispatcher) `UIDispatcher` + +Gets the UI thread dispatcher. +It is a shortcut for the [`ReactDispatcherHelper.UIDispatcherProperty`](ReactDispatcherHelper#uidispatcherproperty) from the [`Properties`](#properties-1) property bag. + +### Methods +#### CallJSFunction +void **`CallJSFunction`**(string moduleName, string methodName, [`JSValueArgWriter`](JSValueArgWriter) paramsArgWriter) + +Calls the JavaScript function named `methodName` of `moduleName` with the `paramsArgWriter`. +The `paramsArgWriter` is a [`JSValueArgWriter`](JSValueArgWriter) delegate that receives [`IJSValueWriter`](IJSValueWriter) to serialize the method parameters. + +#### DispatchEvent +void **`DispatchEvent`**([`FrameworkElement`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.FrameworkElement) view, string eventName, [`JSValueArgWriter`](JSValueArgWriter) eventDataArgWriter) + +> **Deprecated**: Use [`XamlUIService.DispatchEvent`](XamlUIService#dispatchevent) instead + +Deprecated property. Use [`XamlUIService.DispatchEvent`](XamlUIService#dispatchevent) instead. It will be removed in a future version. + +#### EmitJSEvent +void **`EmitJSEvent`**(string eventEmitterName, string eventName, [`JSValueArgWriter`](JSValueArgWriter) paramsArgWriter) + +Emits JavaScript module event `eventName` for the `eventEmitterName` with the `paramsArgWriter`. +It is a specialized [`CallJSFunction`](#calljsfunction)` call where the method name is always `emit` and the `eventName` is added to parameters. +The `paramsArgWriter` is a [`JSValueArgWriter`](JSValueArgWriter) delegate that receives [`IJSValueWriter`](IJSValueWriter) to serialize the event parameters. -## Referenced by +### Referenced by - [`IReactViewInstance`](IReactViewInstance) - [`IViewManagerWithReactContext`](IViewManagerWithReactContext) - [`InitializerDelegate`](InitializerDelegate) - [`InstanceCreatedEventArgs`](InstanceCreatedEventArgs) - [`InstanceDestroyedEventArgs`](InstanceDestroyedEventArgs) - [`InstanceLoadedEventArgs`](InstanceLoadedEventArgs) +- [`JsiInitializerDelegate`](JsiInitializerDelegate) - [`LayoutService`](LayoutService) - [`ReactCoreInjection`](ReactCoreInjection) - [`ReactNativeHost`](ReactNativeHost) diff --git a/docs/native-api/IReactDispatcher-api-windows.md b/docs/native-api/IReactDispatcher-api-windows.md index d7b449e39..c58cf7b33 100644 --- a/docs/native-api/IReactDispatcher-api-windows.md +++ b/docs/native-api/IReactDispatcher-api-windows.md @@ -3,9 +3,9 @@ id: IReactDispatcher title: IReactDispatcher --- -Kind: `interface` - +![Architecture](https://img.shields.io/badge/architecture-new_&_old-green) +Kind: `interface` `IReactDispatcher` provides the core threading/task management interface for ensuring that the code execution 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. @@ -16,8 +16,6 @@ One primary dispatcher that applications may require is the [`IReactContext.UIDi `true` if the dispatcher uses current thread. - - ## Methods ### Post void **`Post`**([`ReactDispatcherCallback`](ReactDispatcherCallback) callback) @@ -25,11 +23,6 @@ void **`Post`**([`ReactDispatcherCallback`](ReactDispatcherCallback) callback) Posts a task to the dispatcher. The `callback` will be called asynchronously on the thread/queue associated with this dispatcher. - - - - - ## Referenced by - [`IReactContext`](IReactContext) - [`IReactNotificationService`](IReactNotificationService) diff --git a/docs/native-api/IReactModuleBuilder-api-windows.md b/docs/native-api/IReactModuleBuilder-api-windows.md index 832c0f952..351f048dc 100644 --- a/docs/native-api/IReactModuleBuilder-api-windows.md +++ b/docs/native-api/IReactModuleBuilder-api-windows.md @@ -3,30 +3,24 @@ id: IReactModuleBuilder title: IReactModuleBuilder --- -Kind: `interface` - +![Architecture](https://img.shields.io/badge/architecture-new_&_old-green) +Kind: `interface` Builds native module inside of ReactNative code based on the provided meta-data. See [Native Modules](native-modules) for more usage information. - - ## Methods ### AddConstantProvider void **`AddConstantProvider`**([`ConstantProviderDelegate`](ConstantProviderDelegate) constantProvider) Adds a constant provider method to define constants for the native module. See [`ConstantProviderDelegate`](ConstantProviderDelegate). - - ### AddEventEmitter void **`AddEventEmitter`**(string name, [`EventEmitterInitializerDelegate`](EventEmitterInitializerDelegate) emitter) Adds an EventEmitter to the turbo module. See [`EventEmitterInitializerDelegate`](EventEmitterInitializerDelegate). - - ### AddInitializer void **`AddInitializer`**([`InitializerDelegate`](InitializerDelegate) initializer) @@ -34,24 +28,18 @@ Adds an initializer method called on the native module initialization. It provides the native module with the [`IReactContext`](IReactContext) for the running ReactNative instance. See [`InitializerDelegate`](InitializerDelegate). There can be multiple initializer methods which are called in the order they were registered. - +### AddJsiInitializer +void **`AddJsiInitializer`**([`JsiInitializerDelegate`](JsiInitializerDelegate) initializer) ### AddMethod void **`AddMethod`**(string name, [`MethodReturnType`](MethodReturnType) returnType, [`MethodDelegate`](MethodDelegate) method) Adds an asynchronous method to the native module. See [`MethodDelegate`](MethodDelegate). - - ### 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/docs/native-api/IReactNonAbiValue-api-windows.md b/docs/native-api/IReactNonAbiValue-api-windows.md index b3c3258e9..adf177d73 100644 --- a/docs/native-api/IReactNonAbiValue-api-windows.md +++ b/docs/native-api/IReactNonAbiValue-api-windows.md @@ -3,25 +3,18 @@ id: IReactNonAbiValue title: IReactNonAbiValue --- -Kind: `interface` - +![Architecture](https://img.shields.io/badge/architecture-new_&_old-green) +Kind: `interface` The `IReactNonAbiValue` helps wrapping 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`**() Gets a pointer to the stored value. - - - - - ## Referenced by - [`JsiRuntime`](JsiRuntime) diff --git a/docs/native-api/IReactNotificationArgs-api-windows.md b/docs/native-api/IReactNotificationArgs-api-windows.md index cee6c36bc..8a6448295 100644 --- a/docs/native-api/IReactNotificationArgs-api-windows.md +++ b/docs/native-api/IReactNotificationArgs-api-windows.md @@ -3,9 +3,9 @@ id: IReactNotificationArgs title: IReactNotificationArgs --- -Kind: `interface` - +![Architecture](https://img.shields.io/badge/architecture-new_&_old-green) +Kind: `interface` Notification args provided to the notification handler. @@ -20,10 +20,5 @@ The data sent with the notification. It can be any WinRT type. Consider using [` The notification subscription that can be used to unsubscribe in the notification handler. It also has the name and dispatcher associated with the notification. - - - - - ## Referenced by - [`ReactNotificationHandler`](ReactNotificationHandler) diff --git a/docs/native-api/IReactNotificationService-api-windows.md b/docs/native-api/IReactNotificationService-api-windows.md index ca2056a3e..8909463cf 100644 --- a/docs/native-api/IReactNotificationService-api-windows.md +++ b/docs/native-api/IReactNotificationService-api-windows.md @@ -3,15 +3,13 @@ id: IReactNotificationService title: IReactNotificationService --- -Kind: `interface` - +![Architecture](https://img.shields.io/badge/architecture-new_&_old-green) +Kind: `interface` The notification service that can be used to send notifications between different components in an app. Use the [`Subscribe`](#subscribe) method to subscribe to notifications and the [`SendNotification`](#sendnotification) method to send notifications. - - ## Methods ### SendNotification void **`SendNotification`**([`IReactPropertyName`](IReactPropertyName) notificationName, Object sender, Object data) @@ -22,8 +20,6 @@ Sends the notification with `notificationName`. - `data` is the data associated with the notification. It 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) @@ -33,11 +29,6 @@ Subscribes to a notification. - `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) - [`IReactNotificationSubscription`](IReactNotificationSubscription) diff --git a/docs/native-api/IReactNotificationSubscription-api-windows.md b/docs/native-api/IReactNotificationSubscription-api-windows.md index 03152bc5d..072e7b532 100644 --- a/docs/native-api/IReactNotificationSubscription-api-windows.md +++ b/docs/native-api/IReactNotificationSubscription-api-windows.md @@ -3,9 +3,9 @@ id: IReactNotificationSubscription title: IReactNotificationSubscription --- -Kind: `interface` - +![Architecture](https://img.shields.io/badge/architecture-new_&_old-green) +Kind: `interface` A subscription to a [`IReactNotificationService`](IReactNotificationService) notification. The subscription is removed when this object is deleted or the [`Unsubscribe`](#unsubscribe) method is called. @@ -35,8 +35,6 @@ Name of the notification. The notification service for the subscription. It can be null if [`IsSubscribed`](#issubscribed) is true and the notification service was already deleted. - - ## Methods ### Unsubscribe void **`Unsubscribe`**() @@ -44,11 +42,6 @@ void **`Unsubscribe`**() Removes the subscription. Because of the multi-threaded nature of the notifications, the handler can be still called after the [`Unsubscribe`](#unsubscribe) method has been called if the [`IsSubscribed`](#issubscribed) property has already been checked. Consider calling the [`Unsubscribe`](#unsubscribe) method and the handler in the same [`IReactDispatcher`](IReactDispatcher) to ensure that no handler is invoked after the [`Unsubscribe`](#unsubscribe) method call. - - - - - ## Referenced by - [`IReactNotificationArgs`](IReactNotificationArgs) - [`IReactNotificationService`](IReactNotificationService) diff --git a/docs/native-api/IReactPackageBuilder-api-windows.md b/docs/native-api/IReactPackageBuilder-api-windows.md index df95f5c81..d3ef87d5f 100644 --- a/docs/native-api/IReactPackageBuilder-api-windows.md +++ b/docs/native-api/IReactPackageBuilder-api-windows.md @@ -3,39 +3,51 @@ id: IReactPackageBuilder title: IReactPackageBuilder --- -Kind: `interface` +![Architecture](https://img.shields.io/badge/architecture-new_&_old-green) +## New Architecture +Kind: `interface` Builds ReactNative package with the set of native modules and view managers. - - -## Methods -### AddModule +### Methods +#### AddModule void **`AddModule`**(string moduleName, [`ReactModuleProvider`](ReactModuleProvider) moduleProvider) Adds a custom native module. See [`ReactModuleProvider`](ReactModuleProvider). - - -### AddTurboModule +#### AddTurboModule void **`AddTurboModule`**(string moduleName, [`ReactModuleProvider`](ReactModuleProvider) moduleProvider) Adds a custom native module. See [`ReactModuleProvider`](ReactModuleProvider). This will register themodule as a TurboModule unless the application is running using [`ReactInstanceSettings.UseWebDebugger`](ReactInstanceSettings#usewebdebugger),in which case it will revert to a legacy NativeModule. NOTE: TurboModules using JSI directly will not run correctly while using [`ReactInstanceSettings.UseWebDebugger`](ReactInstanceSettings#usewebdebugger) +### Referenced by +- [`IReactPackageProvider`](IReactPackageProvider) +## Old Architecture -### AddViewManager -void **`AddViewManager`**(string viewManagerName, [`ReactViewManagerProvider`](ReactViewManagerProvider) viewManagerProvider) +Kind: `interface` -Adds a custom view manager. See [`ReactViewManagerProvider`](ReactViewManagerProvider). +Builds ReactNative package with the set of native modules and view managers. +### Methods +#### AddModule +void **`AddModule`**(string moduleName, [`ReactModuleProvider`](ReactModuleProvider) moduleProvider) +Adds a custom native module. See [`ReactModuleProvider`](ReactModuleProvider). +#### AddTurboModule +void **`AddTurboModule`**(string moduleName, [`ReactModuleProvider`](ReactModuleProvider) moduleProvider) +Adds a custom native module. See [`ReactModuleProvider`](ReactModuleProvider). This will register themodule as a TurboModule unless the application is running using [`ReactInstanceSettings.UseWebDebugger`](ReactInstanceSettings#usewebdebugger),in which case it will revert to a legacy NativeModule. +NOTE: TurboModules using JSI directly will not run correctly while using [`ReactInstanceSettings.UseWebDebugger`](ReactInstanceSettings#usewebdebugger) + +#### AddViewManager +void **`AddViewManager`**(string viewManagerName, [`ReactViewManagerProvider`](ReactViewManagerProvider) viewManagerProvider) +Adds a custom view manager. See [`ReactViewManagerProvider`](ReactViewManagerProvider). -## Referenced by +### Referenced by - [`IReactPackageProvider`](IReactPackageProvider) diff --git a/docs/native-api/IReactPackageBuilderFabric-api-windows.md b/docs/native-api/IReactPackageBuilderFabric-api-windows.md new file mode 100644 index 000000000..d0376e419 --- /dev/null +++ b/docs/native-api/IReactPackageBuilderFabric-api-windows.md @@ -0,0 +1,23 @@ +--- +id: IReactPackageBuilderFabric +title: IReactPackageBuilderFabric +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `interface` + +> **EXPERIMENTAL** + +Provides ability to register custom ViewComponents when running fabric. + +## Methods +### AddUriImageProvider +void **`AddUriImageProvider`**([`IUriImageProvider`](IUriImageProvider) provider) + +Ability to load images using custom Uri protocol handlers. + +### AddViewComponent +void **`AddViewComponent`**(string componentName, [`ReactViewComponentProvider`](ReactViewComponentProvider) componentProvider) + +Registers a custom native view component. diff --git a/docs/native-api/IReactPackageProvider-api-windows.md b/docs/native-api/IReactPackageProvider-api-windows.md index 33eafaab3..f67c8c9c3 100644 --- a/docs/native-api/IReactPackageProvider-api-windows.md +++ b/docs/native-api/IReactPackageProvider-api-windows.md @@ -3,21 +3,15 @@ id: IReactPackageProvider title: IReactPackageProvider --- -Kind: `interface` - +![Architecture](https://img.shields.io/badge/architecture-new_&_old-green) +Kind: `interface` Implement this interface to provide custom native modules and view managers. - - ## Methods ### CreatePackage void **`CreatePackage`**([`IReactPackageBuilder`](IReactPackageBuilder) packageBuilder) Creates a new package with help of the [`IReactPackageBuilder`](IReactPackageBuilder). Use the [`IReactPackageBuilder`](IReactPackageBuilder) to register custom native modules and view managers. - - - - diff --git a/docs/native-api/IReactPropertyBag-api-windows.md b/docs/native-api/IReactPropertyBag-api-windows.md index 9f09e78c5..bb1efe052 100644 --- a/docs/native-api/IReactPropertyBag-api-windows.md +++ b/docs/native-api/IReactPropertyBag-api-windows.md @@ -3,31 +3,25 @@ id: IReactPropertyBag title: IReactPropertyBag --- -Kind: `interface` - +![Architecture](https://img.shields.io/badge/architecture-new_&_old-green) +Kind: `interface` `IReactPropertyBag` provides a thread-safe property storage. Properties are identified by an instance of [`IReactPropertyName`](IReactPropertyName). It is expected that there will be no direct use of this interface. Ideally, all usage should happen through strongly-typed accessors. - - ## Methods ### CopyFrom void **`CopyFrom`**([`IReactPropertyBag`](IReactPropertyBag) other) Copies the properties from another property bag - - ### Get Object **`Get`**([`IReactPropertyName`](IReactPropertyName) name) Gets value of the `name` property. It returns null if the property does not exist. - - ### GetOrCreate Object **`GetOrCreate`**([`IReactPropertyName`](IReactPropertyName) name, [`ReactCreatePropertyValue`](ReactCreatePropertyValue) createValue) @@ -35,8 +29,6 @@ Gets or creates value of the `name` property. If the property exists, then the method returns its value. If the property does not exist, then 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 `createValue` result is not used when another thread sets the property value before the created value is stored. - - ### Set Object **`Set`**([`IReactPropertyName`](IReactPropertyName) name, Object value) @@ -44,11 +36,6 @@ Sets property `name` to `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) - [`ReactCoreInjection`](ReactCoreInjection) diff --git a/docs/native-api/IReactPropertyName-api-windows.md b/docs/native-api/IReactPropertyName-api-windows.md index 28aaa2e8a..90557380f 100644 --- a/docs/native-api/IReactPropertyName-api-windows.md +++ b/docs/native-api/IReactPropertyName-api-windows.md @@ -3,9 +3,9 @@ id: IReactPropertyName title: IReactPropertyName --- -Kind: `interface` - +![Architecture](https://img.shields.io/badge/architecture-new_&_old-green) +Kind: `interface` A name for a [`IReactPropertyBag`](IReactPropertyBag) property. Use [`ReactPropertyBagHelper.GetName`](ReactPropertyBagHelper#getname) to get atomic property name for a string in a [`IReactPropertyNamespace`](IReactPropertyNamespace). @@ -22,11 +22,6 @@ Gets String representation of the [`IReactPropertyName`](IReactPropertyName). Gets the [`IReactPropertyNamespace`](IReactPropertyNamespace) where the property name is defined. - - - - - ## Referenced by - [`IReactNotificationService`](IReactNotificationService) - [`IReactNotificationSubscription`](IReactNotificationSubscription) diff --git a/docs/native-api/IReactPropertyNamespace-api-windows.md b/docs/native-api/IReactPropertyNamespace-api-windows.md index 3df861290..bd546b182 100644 --- a/docs/native-api/IReactPropertyNamespace-api-windows.md +++ b/docs/native-api/IReactPropertyNamespace-api-windows.md @@ -3,9 +3,9 @@ id: IReactPropertyNamespace title: IReactPropertyNamespace --- -Kind: `interface` - +![Architecture](https://img.shields.io/badge/architecture-new_&_old-green) +Kind: `interface` A namespace for a [`IReactPropertyBag`](IReactPropertyBag) property name. Use [`ReactPropertyBagHelper.GetNamespace`](ReactPropertyBagHelper#getnamespace) to get atomic property namespace for a string. @@ -16,11 +16,6 @@ Use [`ReactPropertyBagHelper.GetNamespace`](ReactPropertyBagHelper#getnamespace) Gets String representation of the [`IReactPropertyNamespace`](IReactPropertyNamespace). - - - - - ## Referenced by - [`IReactPropertyName`](IReactPropertyName) - [`ReactPropertyBagHelper`](ReactPropertyBagHelper) diff --git a/docs/native-api/IReactSettingsSnapshot-api-windows.md b/docs/native-api/IReactSettingsSnapshot-api-windows.md index 83c15a4a9..0d6497409 100644 --- a/docs/native-api/IReactSettingsSnapshot-api-windows.md +++ b/docs/native-api/IReactSettingsSnapshot-api-windows.md @@ -3,9 +3,9 @@ id: IReactSettingsSnapshot title: IReactSettingsSnapshot --- -Kind: `interface` - +![Architecture](https://img.shields.io/badge/architecture-new_&_old-green) +Kind: `interface` An immutable snapshot of the [`ReactInstanceSettings`](ReactInstanceSettings) used to create the current React instance. @@ -98,10 +98,5 @@ Controls whether the instance JavaScript runs in a remote environment such as wi 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. - - - - - ## Referenced by - [`IReactContext`](IReactContext) diff --git a/docs/native-api/IReactViewComponentBuilder-api-windows.md b/docs/native-api/IReactViewComponentBuilder-api-windows.md new file mode 100644 index 000000000..fc9410cd5 --- /dev/null +++ b/docs/native-api/IReactViewComponentBuilder-api-windows.md @@ -0,0 +1,58 @@ +--- +id: IReactViewComponentBuilder +title: IReactViewComponentBuilder +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `interface` + +> **EXPERIMENTAL** + +## Methods +### SetComponentViewInitializer +void **`SetComponentViewInitializer`**([`ComponentViewInitializer`](ComponentViewInitializer) initializer) + +### SetCreateProps +void **`SetCreateProps`**([`ViewPropsFactory`](ViewPropsFactory) impl) + +Create an implementation of your custom Props type that will be passed to your components Composition.ICompositionViewComponent.UpdateProps method. + +### SetCreateShadowNode +void **`SetCreateShadowNode`**([`ViewShadowNodeFactory`](ViewShadowNodeFactory) impl) + +### SetCustomCommandHandler +void **`SetCustomCommandHandler`**([`HandleCommandDelegate`](HandleCommandDelegate) impl) + +### SetFinalizeUpdateHandler +void **`SetFinalizeUpdateHandler`**([`UpdateFinalizerDelegate`](UpdateFinalizerDelegate) impl) + +### SetInitialStateDataFactory +void **`SetInitialStateDataFactory`**([`InitialStateDataFactory`](InitialStateDataFactory) impl) + +### SetLayoutHandler +void **`SetLayoutHandler`**([`LayoutHandler`](LayoutHandler) impl) + +### SetMeasureContentHandler +void **`SetMeasureContentHandler`**([`MeasureContentHandler`](MeasureContentHandler) impl) + +### SetMountChildComponentViewHandler +void **`SetMountChildComponentViewHandler`**([`MountChildComponentViewDelegate`](MountChildComponentViewDelegate) impl) + +### SetShadowNodeCloner +void **`SetShadowNodeCloner`**([`ViewShadowNodeCloner`](ViewShadowNodeCloner) impl) + +### SetUnmountChildComponentViewHandler +void **`SetUnmountChildComponentViewHandler`**([`UnmountChildComponentViewDelegate`](UnmountChildComponentViewDelegate) impl) + +### SetUpdateEventEmitterHandler +void **`SetUpdateEventEmitterHandler`**([`UpdateEventEmitterDelegate`](UpdateEventEmitterDelegate) impl) + +### SetUpdatePropsHandler +void **`SetUpdatePropsHandler`**([`UpdatePropsDelegate`](UpdatePropsDelegate) impl) + +### SetUpdateStateHandler +void **`SetUpdateStateHandler`**([`UpdateStateDelegate`](UpdateStateDelegate) impl) + +## Referenced by +- [`ReactViewComponentProvider`](ReactViewComponentProvider) diff --git a/docs/native-api/IReactViewHost-api-windows.md b/docs/native-api/IReactViewHost-api-windows.md index cb98c3a5e..bfe024174 100644 --- a/docs/native-api/IReactViewHost-api-windows.md +++ b/docs/native-api/IReactViewHost-api-windows.md @@ -3,60 +3,92 @@ id: IReactViewHost title: IReactViewHost --- -Kind: `interface` +![Architecture](https://img.shields.io/badge/architecture-new_&_old-green) +## New Architecture +Kind: `interface` > **EXPERIMENTAL** Used to implement a non-XAML platform ReactRootView. -## Properties -### ReactNativeHost +### Properties +#### ReactNativeHost `readonly` [`ReactNativeHost`](ReactNativeHost) `ReactNativeHost` The ReactNativeHost associated with this ReactViewHost. - - -## Methods -### AttachViewInstance +### Methods +#### AttachViewInstance [`IAsyncAction`](https://docs.microsoft.com/uwp/api/Windows.Foundation.IAsyncAction) **`AttachViewInstance`**([`IReactViewInstance`](IReactViewInstance) operation) Attaches IReactViewInstance to the IReactViewHost. - - -### DetachViewInstance +#### DetachViewInstance [`IAsyncAction`](https://docs.microsoft.com/uwp/api/Windows.Foundation.IAsyncAction) **`DetachViewInstance`**() Detaches IReactViewInstance from the IReactViewHost. - - -### ReloadViewInstance +#### ReloadViewInstance [`IAsyncAction`](https://docs.microsoft.com/uwp/api/Windows.Foundation.IAsyncAction) **`ReloadViewInstance`**() Reloads the IReactViewInstance if it is attached. - - -### ReloadViewInstanceWithOptions +#### ReloadViewInstanceWithOptions [`IAsyncAction`](https://docs.microsoft.com/uwp/api/Windows.Foundation.IAsyncAction) **`ReloadViewInstanceWithOptions`**([`ReactViewOptions`](ReactViewOptions) operation) Reloads IReactViewInstance if it is attached with a new set of options. - - -### UnloadViewInstance +#### UnloadViewInstance [`IAsyncAction`](https://docs.microsoft.com/uwp/api/Windows.Foundation.IAsyncAction) **`UnloadViewInstance`**() Unloads the attached IReactViewInstance. +### Referenced by +- [`CompositionHwndHost`](CompositionHwndHost) +- [`ReactCoreInjection`](ReactCoreInjection) +- [`ReactNativeIsland`](ReactNativeIsland) + +## Old Architecture + +Kind: `interface` + +> **EXPERIMENTAL** + +Used to implement a non-XAML platform ReactRootView. + +### Properties +#### ReactNativeHost +`readonly` [`ReactNativeHost`](ReactNativeHost) `ReactNativeHost` + +The ReactNativeHost associated with this ReactViewHost. + +### Methods +#### AttachViewInstance +[`IAsyncAction`](https://docs.microsoft.com/uwp/api/Windows.Foundation.IAsyncAction) **`AttachViewInstance`**([`IReactViewInstance`](IReactViewInstance) operation) + +Attaches IReactViewInstance to the IReactViewHost. + +#### DetachViewInstance +[`IAsyncAction`](https://docs.microsoft.com/uwp/api/Windows.Foundation.IAsyncAction) **`DetachViewInstance`**() + +Detaches IReactViewInstance from the IReactViewHost. + +#### ReloadViewInstance +[`IAsyncAction`](https://docs.microsoft.com/uwp/api/Windows.Foundation.IAsyncAction) **`ReloadViewInstance`**() + +Reloads the IReactViewInstance if it is attached. +#### ReloadViewInstanceWithOptions +[`IAsyncAction`](https://docs.microsoft.com/uwp/api/Windows.Foundation.IAsyncAction) **`ReloadViewInstanceWithOptions`**([`ReactViewOptions`](ReactViewOptions) operation) +Reloads IReactViewInstance if it is attached with a new set of options. +#### UnloadViewInstance +[`IAsyncAction`](https://docs.microsoft.com/uwp/api/Windows.Foundation.IAsyncAction) **`UnloadViewInstance`**() +Unloads the attached IReactViewInstance. -## Referenced by +### Referenced by - [`ReactCoreInjection`](ReactCoreInjection) diff --git a/docs/native-api/IReactViewInstance-api-windows.md b/docs/native-api/IReactViewInstance-api-windows.md index 0c9e3498a..3c837d781 100644 --- a/docs/native-api/IReactViewInstance-api-windows.md +++ b/docs/native-api/IReactViewInstance-api-windows.md @@ -3,40 +3,29 @@ id: IReactViewInstance title: IReactViewInstance --- -Kind: `interface` - +![Architecture](https://img.shields.io/badge/architecture-new_&_old-green) +Kind: `interface` > **EXPERIMENTAL** Used to implement a non-XAML platform ReactRootView. - - ## Methods ### InitRootView void **`InitRootView`**([`IReactContext`](IReactContext) context, [`ReactViewOptions`](ReactViewOptions) viewOptions) Initialize ReactRootView with the reactInstance and view-specific settings - - ### UninitRootView void **`UninitRootView`**() Uninitialize ReactRootView and destroy UI tree - - ### UpdateRootView void **`UpdateRootView`**() Update ReactRootView with changes in ReactInstance - - - - - ## Referenced by - [`IReactViewHost`](IReactViewHost) diff --git a/docs/native-api/IRedBoxErrorFrameInfo-api-windows.md b/docs/native-api/IRedBoxErrorFrameInfo-api-windows.md index c36d3f4d9..4665199a8 100644 --- a/docs/native-api/IRedBoxErrorFrameInfo-api-windows.md +++ b/docs/native-api/IRedBoxErrorFrameInfo-api-windows.md @@ -3,9 +3,9 @@ id: IRedBoxErrorFrameInfo title: IRedBoxErrorFrameInfo --- -Kind: `interface` - +![Architecture](https://img.shields.io/badge/architecture-new_&_old-green) +Kind: `interface` This object represents a single frame within the call stack of an error. @@ -34,7 +34,3 @@ The line number within the file. `readonly` string `Method` The method name of this frame. - - - - diff --git a/docs/native-api/IRedBoxErrorInfo-api-windows.md b/docs/native-api/IRedBoxErrorInfo-api-windows.md index fe0c0bc5e..e5a89e26d 100644 --- a/docs/native-api/IRedBoxErrorInfo-api-windows.md +++ b/docs/native-api/IRedBoxErrorInfo-api-windows.md @@ -3,9 +3,9 @@ id: IRedBoxErrorInfo title: IRedBoxErrorInfo --- -Kind: `interface` - +![Architecture](https://img.shields.io/badge/architecture-new_&_old-green) +Kind: `interface` This object provides information about the error. For JavaScript errors, a call stack is also provided. @@ -45,10 +45,5 @@ An identifier for this error. If the message was adjusted for formatting, or otherwise processed, this contains the message before those modifications. - - - - - ## Referenced by - [`IRedBoxHandler`](IRedBoxHandler) diff --git a/docs/native-api/IRedBoxHandler-api-windows.md b/docs/native-api/IRedBoxHandler-api-windows.md index 712dd5407..9b78f0a39 100644 --- a/docs/native-api/IRedBoxHandler-api-windows.md +++ b/docs/native-api/IRedBoxHandler-api-windows.md @@ -3,9 +3,9 @@ id: IRedBoxHandler title: IRedBoxHandler --- -Kind: `interface` - +![Architecture](https://img.shields.io/badge/architecture-new_&_old-green) +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. @@ -63,7 +63,6 @@ class MyRedBoxHandler : IRedBoxHandler private IRedBoxHandler innerHandler; } - RegisterMyRedBoxHandler() { Host.InstanceSettings.RedBoxHandler = new MyRedBoxHandler(RedBoxHelper.CreateDefaultHandler(Host)); @@ -77,31 +76,20 @@ RegisterMyRedBoxHandler() 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/docs/native-api/IRoundedRectangleVisual-api-windows.md b/docs/native-api/IRoundedRectangleVisual-api-windows.md new file mode 100644 index 000000000..75acc591e --- /dev/null +++ b/docs/native-api/IRoundedRectangleVisual-api-windows.md @@ -0,0 +1,28 @@ +--- +id: IRoundedRectangleVisual +title: IRoundedRectangleVisual +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `interface` + +Implements: [`IVisual`](IVisual) + +> **EXPERIMENTAL** + +## Methods +### Brush +void **`Brush`**([`IBrush`](IBrush) brush) + +### CornerRadius +void **`CornerRadius`**([`Vector2`](https://docs.microsoft.com/uwp/api/Windows.Foundation.Numerics.Vector2) value) + +### StrokeBrush +void **`StrokeBrush`**([`IBrush`](IBrush) brush) + +### StrokeThickness +void **`StrokeThickness`**(float value) + +## Referenced by +- [`ICompositionContext`](ICompositionContext) diff --git a/docs/native-api/IScrollPositionChangedArgs-api-windows.md b/docs/native-api/IScrollPositionChangedArgs-api-windows.md new file mode 100644 index 000000000..6330abdd5 --- /dev/null +++ b/docs/native-api/IScrollPositionChangedArgs-api-windows.md @@ -0,0 +1,17 @@ +--- +id: IScrollPositionChangedArgs +title: IScrollPositionChangedArgs +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `interface` + +> **EXPERIMENTAL** + +## Properties +### Position +`readonly` [`Vector2`](https://docs.microsoft.com/uwp/api/Windows.Foundation.Numerics.Vector2) `Position` + +## Referenced by +- [`IScrollVisual`](IScrollVisual) diff --git a/docs/native-api/IScrollVisual-api-windows.md b/docs/native-api/IScrollVisual-api-windows.md new file mode 100644 index 000000000..a33f2b3d3 --- /dev/null +++ b/docs/native-api/IScrollVisual-api-windows.md @@ -0,0 +1,58 @@ +--- +id: IScrollVisual +title: IScrollVisual +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `interface` + +Implements: [`IVisual`](IVisual) + +> **EXPERIMENTAL** + +## Properties +### Horizontal + bool `Horizontal` + +### ScrollPosition +`readonly` [`Vector3`](https://docs.microsoft.com/uwp/api/Windows.Foundation.Numerics.Vector3) `ScrollPosition` + +## Methods +### Brush +void **`Brush`**([`IBrush`](IBrush) brush) + +### ContentSize +void **`ContentSize`**([`Vector2`](https://docs.microsoft.com/uwp/api/Windows.Foundation.Numerics.Vector2) size) + +### OnPointerPressed +void **`OnPointerPressed`**([`PointerRoutedEventArgs`](PointerRoutedEventArgs) args) + +### ScrollBy +void **`ScrollBy`**([`Vector3`](https://docs.microsoft.com/uwp/api/Windows.Foundation.Numerics.Vector3) offset, bool animate) + +### ScrollEnabled +void **`ScrollEnabled`**(bool isScrollEnabled) + +### SetDecelerationRate +void **`SetDecelerationRate`**([`Vector3`](https://docs.microsoft.com/uwp/api/Windows.Foundation.Numerics.Vector3) decelerationRate) + +### SetMaximumZoomScale +void **`SetMaximumZoomScale`**(float maximumZoomScale) + +### SetMinimumZoomScale +void **`SetMinimumZoomScale`**(float minimumZoomScale) + +### TryUpdatePosition +void **`TryUpdatePosition`**([`Vector3`](https://docs.microsoft.com/uwp/api/Windows.Foundation.Numerics.Vector3) position, bool animate) + +## Events +### `ScrollBeginDrag` +Type: [`EventHandler`](https://docs.microsoft.com/uwp/api/Windows.Foundation.EventHandler-1)<[`IScrollPositionChangedArgs`](IScrollPositionChangedArgs)> +### `ScrollEndDrag` +Type: [`EventHandler`](https://docs.microsoft.com/uwp/api/Windows.Foundation.EventHandler-1)<[`IScrollPositionChangedArgs`](IScrollPositionChangedArgs)> +### `ScrollPositionChanged` +Type: [`EventHandler`](https://docs.microsoft.com/uwp/api/Windows.Foundation.EventHandler-1)<[`IScrollPositionChangedArgs`](IScrollPositionChangedArgs)> + +## Referenced by +- [`ICompositionContext`](ICompositionContext) diff --git a/docs/native-api/ISpriteVisual-api-windows.md b/docs/native-api/ISpriteVisual-api-windows.md new file mode 100644 index 000000000..8586ee4f4 --- /dev/null +++ b/docs/native-api/ISpriteVisual-api-windows.md @@ -0,0 +1,22 @@ +--- +id: ISpriteVisual +title: ISpriteVisual +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `interface` + +Implements: [`IVisual`](IVisual) + +> **EXPERIMENTAL** + +## Methods +### Brush +void **`Brush`**([`IBrush`](IBrush) brush) + +### Shadow +void **`Shadow`**([`IDropShadow`](IDropShadow) shadow) + +## Referenced by +- [`ICompositionContext`](ICompositionContext) diff --git a/docs/native-api/ITimer-api-windows.md b/docs/native-api/ITimer-api-windows.md index 93d5dd1c4..acb7c5e4e 100644 --- a/docs/native-api/ITimer-api-windows.md +++ b/docs/native-api/ITimer-api-windows.md @@ -3,32 +3,24 @@ id: ITimer title: ITimer --- -Kind: `interface` - +![Architecture](https://img.shields.io/badge/architecture-new_&_old-green) +Kind: `interface` ## Properties ### Interval [`TimeSpan`](https://docs.microsoft.com/uwp/api/Windows.Foundation.TimeSpan) `Interval` - - ## Methods ### Start void **`Start`**() - - ### Stop void **`Stop`**() - - - ## Events ### `Tick` -Type: Object - +Type: [`EventHandler`](https://docs.microsoft.com/uwp/api/Windows.Foundation.EventHandler-1) ## Referenced by - [`Timer`](Timer) diff --git a/docs/native-api/IUriImageProvider-api-windows.md b/docs/native-api/IUriImageProvider-api-windows.md new file mode 100644 index 000000000..5e4dfcbe2 --- /dev/null +++ b/docs/native-api/IUriImageProvider-api-windows.md @@ -0,0 +1,24 @@ +--- +id: IUriImageProvider +title: IUriImageProvider +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `interface` + +> **EXPERIMENTAL** + +This allows applications to provide their own image caching / storage pipelines. Or to generate images on the fly based on uri. + +## Methods +### CanLoadImageUri +bool **`CanLoadImageUri`**([`IReactContext`](IReactContext) context, [`Uri`](https://docs.microsoft.com/uwp/api/Windows.Foundation.Uri) uri) + +This should return true if this provider will provide an image for the provided uri. + +### GetImageResponseAsync +[`IAsyncOperation`](https://docs.microsoft.com/uwp/api/Windows.Foundation.IAsyncOperation-1)<[`ImageResponse`](ImageResponse)> **`GetImageResponseAsync`**([`IReactContext`](IReactContext) operation, [`ImageSource`](ImageSource) context) + +## Referenced by +- [`IReactPackageBuilderFabric`](IReactPackageBuilderFabric) diff --git a/docs/native-api/IViewManager-api-windows.md b/docs/native-api/IViewManager-api-windows.md index ec773658a..88556d48d 100644 --- a/docs/native-api/IViewManager-api-windows.md +++ b/docs/native-api/IViewManager-api-windows.md @@ -3,9 +3,9 @@ id: IViewManager title: IViewManager --- -Kind: `interface` - +![Architecture](https://img.shields.io/badge/architecture-old_only-yellow) +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.** @@ -14,16 +14,9 @@ See the documentation of [Native UI Components](view-managers) for information o ### Name `readonly` string `Name` - - ## Methods ### CreateView -[`FrameworkElement`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.FrameworkElement) **`CreateView`**() - - - - - +[`FrameworkElement`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.FrameworkElement) **`CreateView`**() ## Referenced by - [`ReactViewManagerProvider`](ReactViewManagerProvider) diff --git a/docs/native-api/IViewManagerCreateWithProperties-api-windows.md b/docs/native-api/IViewManagerCreateWithProperties-api-windows.md index 2e4e5c6b9..f99dcaf57 100644 --- a/docs/native-api/IViewManagerCreateWithProperties-api-windows.md +++ b/docs/native-api/IViewManagerCreateWithProperties-api-windows.md @@ -3,18 +3,12 @@ id: IViewManagerCreateWithProperties title: IViewManagerCreateWithProperties --- -Kind: `interface` - +![Architecture](https://img.shields.io/badge/architecture-old_only-yellow) +Kind: `interface` Enables a view manager to create views whose behavior depend on the the property values passed to the view manager at creation time. For example, a view manager could choose to create different types of UI elements based on the properties passed in. - - ## Methods ### CreateViewWithProperties Object **`CreateViewWithProperties`**([`IJSValueReader`](IJSValueReader) propertyMapReader) - - - - diff --git a/docs/native-api/IViewManagerRequiresNativeLayout-api-windows.md b/docs/native-api/IViewManagerRequiresNativeLayout-api-windows.md index e359f6209..a99a29057 100644 --- a/docs/native-api/IViewManagerRequiresNativeLayout-api-windows.md +++ b/docs/native-api/IViewManagerRequiresNativeLayout-api-windows.md @@ -3,16 +3,12 @@ id: IViewManagerRequiresNativeLayout title: IViewManagerRequiresNativeLayout --- -Kind: `interface` - +![Architecture](https://img.shields.io/badge/architecture-old_only-yellow) +Kind: `interface` Enables a view manager to be responsible for its own layout and sizing. ## Properties ### RequiresNativeLayout `readonly` bool `RequiresNativeLayout` - - - - diff --git a/docs/native-api/IViewManagerWithChildren-api-windows.md b/docs/native-api/IViewManagerWithChildren-api-windows.md index b4a193f0a..b553e1e57 100644 --- a/docs/native-api/IViewManagerWithChildren-api-windows.md +++ b/docs/native-api/IViewManagerWithChildren-api-windows.md @@ -3,31 +3,19 @@ id: IViewManagerWithChildren title: IViewManagerWithChildren --- -Kind: `interface` - - - +![Architecture](https://img.shields.io/badge/architecture-old_only-yellow) +Kind: `interface` ## Methods ### AddView -void **`AddView`**([`FrameworkElement`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.FrameworkElement) parent, [`UIElement`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.UIElement) child, int64_t index) - - +void **`AddView`**([`FrameworkElement`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.FrameworkElement) parent, [`UIElement`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.UIElement) child, int64_t index) ### RemoveAllChildren -void **`RemoveAllChildren`**([`FrameworkElement`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.FrameworkElement) parent) - - +void **`RemoveAllChildren`**([`FrameworkElement`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.FrameworkElement) parent) ### RemoveChildAt -void **`RemoveChildAt`**([`FrameworkElement`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.FrameworkElement) parent, int64_t index) - - +void **`RemoveChildAt`**([`FrameworkElement`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.FrameworkElement) parent, int64_t index) ### ReplaceChild -void **`ReplaceChild`**([`FrameworkElement`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.FrameworkElement) parent, [`UIElement`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.UIElement) oldChild, [`UIElement`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.UIElement) newChild) - - - - +void **`ReplaceChild`**([`FrameworkElement`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.FrameworkElement) parent, [`UIElement`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.UIElement) oldChild, [`UIElement`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.UIElement) newChild) diff --git a/docs/native-api/IViewManagerWithCommands-api-windows.md b/docs/native-api/IViewManagerWithCommands-api-windows.md index 61b1c8771..c66867d87 100644 --- a/docs/native-api/IViewManagerWithCommands-api-windows.md +++ b/docs/native-api/IViewManagerWithCommands-api-windows.md @@ -3,20 +3,14 @@ id: IViewManagerWithCommands title: IViewManagerWithCommands --- -Kind: `interface` - +![Architecture](https://img.shields.io/badge/architecture-old_only-yellow) +Kind: `interface` ## Properties ### Commands `readonly` [`IVectorView`](https://docs.microsoft.com/uwp/api/Windows.Foundation.Collections.IVectorView-1) `Commands` - - ## Methods ### DispatchCommand -void **`DispatchCommand`**([`FrameworkElement`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.FrameworkElement) view, string commandId, [`IJSValueReader`](IJSValueReader) commandArgsReader) - - - - +void **`DispatchCommand`**([`FrameworkElement`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.FrameworkElement) view, string commandId, [`IJSValueReader`](IJSValueReader) commandArgsReader) diff --git a/docs/native-api/IViewManagerWithDropViewInstance-api-windows.md b/docs/native-api/IViewManagerWithDropViewInstance-api-windows.md index 5a1956cc3..fec8fdd47 100644 --- a/docs/native-api/IViewManagerWithDropViewInstance-api-windows.md +++ b/docs/native-api/IViewManagerWithDropViewInstance-api-windows.md @@ -3,20 +3,14 @@ id: IViewManagerWithDropViewInstance title: IViewManagerWithDropViewInstance --- -Kind: `interface` - +![Architecture](https://img.shields.io/badge/architecture-old_only-yellow) +Kind: `interface` Enables view managers to track when views are removed from the shadow tree. - - ## Methods ### OnDropViewInstance -void **`OnDropViewInstance`**([`FrameworkElement`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.FrameworkElement) view) - -Invoked when React has removed the view from its shadow tree. Note this method call is distinct from the XAML Unloaded event, which is asynchronously triggered from when the removal of the view from the UI tree happens. - - - +void **`OnDropViewInstance`**([`FrameworkElement`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.FrameworkElement) view) +Invoked when React has removed the view from its shadow tree. Note this method call is distinct from the XAML Unloaded event, which is asynchronously triggered from when the removal of the view from the UI tree happens. diff --git a/docs/native-api/IViewManagerWithExportedEventTypeConstants-api-windows.md b/docs/native-api/IViewManagerWithExportedEventTypeConstants-api-windows.md index ce3c13b59..760d0e70f 100644 --- a/docs/native-api/IViewManagerWithExportedEventTypeConstants-api-windows.md +++ b/docs/native-api/IViewManagerWithExportedEventTypeConstants-api-windows.md @@ -3,9 +3,9 @@ id: IViewManagerWithExportedEventTypeConstants title: IViewManagerWithExportedEventTypeConstants --- -Kind: `interface` - +![Architecture](https://img.shields.io/badge/architecture-old_only-yellow) +Kind: `interface` ## Properties ### ExportedCustomBubblingEventTypeConstants @@ -13,7 +13,3 @@ Kind: `interface` ### ExportedCustomDirectEventTypeConstants `readonly` [`ConstantProviderDelegate`](ConstantProviderDelegate) `ExportedCustomDirectEventTypeConstants` - - - - diff --git a/docs/native-api/IViewManagerWithExportedViewConstants-api-windows.md b/docs/native-api/IViewManagerWithExportedViewConstants-api-windows.md index 7d1ba89e3..cf1bcd67f 100644 --- a/docs/native-api/IViewManagerWithExportedViewConstants-api-windows.md +++ b/docs/native-api/IViewManagerWithExportedViewConstants-api-windows.md @@ -3,14 +3,10 @@ id: IViewManagerWithExportedViewConstants title: IViewManagerWithExportedViewConstants --- -Kind: `interface` - +![Architecture](https://img.shields.io/badge/architecture-old_only-yellow) +Kind: `interface` ## Properties ### ExportedViewConstants `readonly` [`ConstantProviderDelegate`](ConstantProviderDelegate) `ExportedViewConstants` - - - - diff --git a/docs/native-api/IViewManagerWithNativeProperties-api-windows.md b/docs/native-api/IViewManagerWithNativeProperties-api-windows.md index 3df81cff4..dfb61e71a 100644 --- a/docs/native-api/IViewManagerWithNativeProperties-api-windows.md +++ b/docs/native-api/IViewManagerWithNativeProperties-api-windows.md @@ -3,20 +3,14 @@ id: IViewManagerWithNativeProperties title: IViewManagerWithNativeProperties --- -Kind: `interface` - +![Architecture](https://img.shields.io/badge/architecture-old_only-yellow) +Kind: `interface` ## Properties ### NativeProps `readonly` [`IMapView`](https://docs.microsoft.com/uwp/api/Windows.Foundation.Collections.IMapView-2) `NativeProps` - - ## Methods ### UpdateProperties -void **`UpdateProperties`**([`FrameworkElement`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.FrameworkElement) view, [`IJSValueReader`](IJSValueReader) propertyMapReader) - - - - +void **`UpdateProperties`**([`FrameworkElement`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.FrameworkElement) view, [`IJSValueReader`](IJSValueReader) propertyMapReader) diff --git a/docs/native-api/IViewManagerWithOnLayout-api-windows.md b/docs/native-api/IViewManagerWithOnLayout-api-windows.md index 1c41a72d1..4559ae3f8 100644 --- a/docs/native-api/IViewManagerWithOnLayout-api-windows.md +++ b/docs/native-api/IViewManagerWithOnLayout-api-windows.md @@ -3,20 +3,14 @@ id: IViewManagerWithOnLayout title: IViewManagerWithOnLayout --- -Kind: `interface` - +![Architecture](https://img.shields.io/badge/architecture-old_only-yellow) +Kind: `interface` Enables view managers to receive callback when Yoga layout props are applied. - - ## Methods ### OnLayout -void **`OnLayout`**([`FrameworkElement`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.FrameworkElement) view, float left, float top, float width, float height) +void **`OnLayout`**([`FrameworkElement`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.FrameworkElement) view, float left, float top, float width, float height) Invoked just before `onLayout` event is emitted for a view. Note: this callback is invoked any time the Yoga node returns true from YGNodeHasNewLayout. React Native Windows suppresses `onLayout` events when the final layout has not changed, so this method may be called without a corresponding `onLayout` event in JavaScript. - - - - diff --git a/docs/native-api/IViewManagerWithPointerEvents-api-windows.md b/docs/native-api/IViewManagerWithPointerEvents-api-windows.md index 9d533873e..3941a9939 100644 --- a/docs/native-api/IViewManagerWithPointerEvents-api-windows.md +++ b/docs/native-api/IViewManagerWithPointerEvents-api-windows.md @@ -3,22 +3,16 @@ id: IViewManagerWithPointerEvents title: IViewManagerWithPointerEvents --- -Kind: `interface` - +![Architecture](https://img.shields.io/badge/architecture-old_only-yellow) +Kind: `interface` > **EXPERIMENTAL** Experimental interface enabling view managers to release pointer capture from the React root view and start handling pointer events itself. - - ## Methods ### OnPointerEvent void **`OnPointerEvent`**(Object view, [`ReactPointerEventArgs`](ReactPointerEventArgs) args) -When pointer events are received on the React root view, the top-level pointer event handler invokes this callback for each React view ancestor of the [`RoutedEventArgs.OriginalSource`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.RoutedEventArgs.OriginalSource) element with a view manager that implements [`IViewManagerWithPointerEvents`](IViewManagerWithPointerEvents) to allow the view manager to modify handling for the pointer event. This can be used to refine the target view. E.g., setting the [`ReactPointerEventArgs.Target`](ReactPointerEventArgs#target) property to null will force the React root view to choose one of the view's ancestors as the hit target. Alternatively, the view manager may also set the [`ReactPointerEventArgs.Target`](ReactPointerEventArgs#target) to any descendent of provided view to enable hit testing on views that do not derive from [`UIElement`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.UIElement). - - - - +When pointer events are received on the React root view, the top-level pointer event handler invokes this callback for each React view ancestor of the [`RoutedEventArgs.OriginalSource`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.RoutedEventArgs.OriginalSource) element with a view manager that implements [`IViewManagerWithPointerEvents`](IViewManagerWithPointerEvents) to allow the view manager to modify handling for the pointer event. This can be used to refine the target view. E.g., setting the [`ReactPointerEventArgs.Target`](ReactPointerEventArgs#target) property to null will force the React root view to choose one of the view's ancestors as the hit target. Alternatively, the view manager may also set the [`ReactPointerEventArgs.Target`](ReactPointerEventArgs#target) to any descendent of provided view to enable hit testing on views that do not derive from [`UIElement`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.UIElement). diff --git a/docs/native-api/IViewManagerWithReactContext-api-windows.md b/docs/native-api/IViewManagerWithReactContext-api-windows.md index 7a19a92d9..984d2b9b6 100644 --- a/docs/native-api/IViewManagerWithReactContext-api-windows.md +++ b/docs/native-api/IViewManagerWithReactContext-api-windows.md @@ -3,14 +3,10 @@ id: IViewManagerWithReactContext title: IViewManagerWithReactContext --- -Kind: `interface` - +![Architecture](https://img.shields.io/badge/architecture-old_only-yellow) +Kind: `interface` ## Properties ### ReactContext [`IReactContext`](IReactContext) `ReactContext` - - - - diff --git a/docs/native-api/IVisual-api-windows.md b/docs/native-api/IVisual-api-windows.md new file mode 100644 index 000000000..91853c13a --- /dev/null +++ b/docs/native-api/IVisual-api-windows.md @@ -0,0 +1,72 @@ +--- +id: IVisual +title: IVisual +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `interface` + +Implemented by: +- [`IActivityVisual`](IActivityVisual) +- [`IRoundedRectangleVisual`](IRoundedRectangleVisual) +- [`IScrollVisual`](IScrollVisual) +- [`ISpriteVisual`](ISpriteVisual) + +> **EXPERIMENTAL** + +## Properties +### BackfaceVisibility + [`BackfaceVisibility`](BackfaceVisibility) `BackfaceVisibility` + +### Comment + string `Comment` + +## Methods +### AnimationClass +void **`AnimationClass`**([`AnimationClass`](AnimationClass) value) + +### GetAt +[`IVisual`](IVisual) **`GetAt`**(uint32_t index) + +### InsertAt +void **`InsertAt`**([`IVisual`](IVisual) visual, int index) + +### IsVisible +void **`IsVisible`**(bool isVisible) + +### Offset +void **`Offset`**([`Vector3`](https://docs.microsoft.com/uwp/api/Windows.Foundation.Numerics.Vector3) offset) + +### Offset +void **`Offset`**([`Vector3`](https://docs.microsoft.com/uwp/api/Windows.Foundation.Numerics.Vector3) offset, [`Vector3`](https://docs.microsoft.com/uwp/api/Windows.Foundation.Numerics.Vector3) relativeAdjustment) + +### Opacity +void **`Opacity`**(float opacity) + +### RelativeSizeWithOffset +void **`RelativeSizeWithOffset`**([`Vector2`](https://docs.microsoft.com/uwp/api/Windows.Foundation.Numerics.Vector2) size, [`Vector2`](https://docs.microsoft.com/uwp/api/Windows.Foundation.Numerics.Vector2) relativeSizeAdjustment) + +### Remove +void **`Remove`**([`IVisual`](IVisual) visual) + +### RotationAngle +void **`RotationAngle`**(float angle) + +### Scale +void **`Scale`**([`Vector3`](https://docs.microsoft.com/uwp/api/Windows.Foundation.Numerics.Vector3) scale) + +### Size +void **`Size`**([`Vector2`](https://docs.microsoft.com/uwp/api/Windows.Foundation.Numerics.Vector2) size) + +### TransformMatrix +void **`TransformMatrix`**([`Matrix4x4`](https://docs.microsoft.com/uwp/api/Windows.Foundation.Numerics.Matrix4x4) transform) + +## Referenced by +- [`CreateInternalVisualDelegate`](CreateInternalVisualDelegate) +- [`ICaretVisual`](ICaretVisual) +- [`IFocusVisual`](IFocusVisual) +- [`IInternalCompositionRootView`](IInternalCompositionRootView) +- [`IVisualToMountChildrenIntoDelegate`](IVisualToMountChildrenIntoDelegate) +- [`MicrosoftCompositionContextHelper`](MicrosoftCompositionContextHelper) +- [`SystemCompositionContextHelper`](SystemCompositionContextHelper) diff --git a/docs/native-api/IVisualToMountChildrenIntoDelegate-api-windows.md b/docs/native-api/IVisualToMountChildrenIntoDelegate-api-windows.md new file mode 100644 index 000000000..aad2fc958 --- /dev/null +++ b/docs/native-api/IVisualToMountChildrenIntoDelegate-api-windows.md @@ -0,0 +1,18 @@ +--- +id: IVisualToMountChildrenIntoDelegate +title: IVisualToMountChildrenIntoDelegate +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `delegate` + +> **EXPERIMENTAL** + +This type will be removed in future versions + +## Invoke +[`IVisual`](IVisual) **`Invoke`**([`ComponentView`](ComponentView) view) + +## Referenced by +- [`IReactCompositionViewComponentInternalBuilder`](IReactCompositionViewComponentInternalBuilder) diff --git a/docs/native-api/ImageComponentView-api-windows.md b/docs/native-api/ImageComponentView-api-windows.md new file mode 100644 index 000000000..78569e6bf --- /dev/null +++ b/docs/native-api/ImageComponentView-api-windows.md @@ -0,0 +1,18 @@ +--- +id: ImageComponentView +title: ImageComponentView +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `class` + +Extends: [`ViewComponentView`](ViewComponentView) + +> **EXPERIMENTAL** + +## Properties +### ViewProps +`readonly` [`ImageProps`](ImageProps) `ViewProps` + +> **EXPERIMENTAL** diff --git a/docs/native-api/ImageFailedResponse-api-windows.md b/docs/native-api/ImageFailedResponse-api-windows.md new file mode 100644 index 000000000..489a1fd3f --- /dev/null +++ b/docs/native-api/ImageFailedResponse-api-windows.md @@ -0,0 +1,25 @@ +--- +id: ImageFailedResponse +title: ImageFailedResponse +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `class` + +Extends: [`ImageResponse`](ImageResponse) + +> **EXPERIMENTAL** + +Use this as a return value from [`IUriImageProvider.GetImageResponseAsync`](IUriImageProvider#getimageresponseasync) to provide information about why the image load failed. + +## Constructors +### ImageFailedResponse + **`ImageFailedResponse`**(string errorMessage) + +> **EXPERIMENTAL** + +### ImageFailedResponse + **`ImageFailedResponse`**(string errorMessage, [`HttpStatusCode`](https://docs.microsoft.com/uwp/api/Windows.Web.Http.HttpStatusCode) responseCode, [`HttpResponseHeaderCollection`](https://docs.microsoft.com/uwp/api/Windows.Web.Http.Headers.HttpResponseHeaderCollection) responseHeaders) + +> **EXPERIMENTAL** diff --git a/docs/native-api/ImageProps-api-windows.md b/docs/native-api/ImageProps-api-windows.md new file mode 100644 index 000000000..3f52c88a7 --- /dev/null +++ b/docs/native-api/ImageProps-api-windows.md @@ -0,0 +1,18 @@ +--- +id: ImageProps +title: ImageProps +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `class` + +Extends: [`ViewProps`](ViewProps) + +> **EXPERIMENTAL** + +## Properties +### Sources +`readonly` [`IVectorView`](https://docs.microsoft.com/uwp/api/Windows.Foundation.Collections.IVectorView-1)<[`ImageSource`](ImageSource)> `Sources` + +> **EXPERIMENTAL** diff --git a/docs/native-api/ImageResponse-api-windows.md b/docs/native-api/ImageResponse-api-windows.md new file mode 100644 index 000000000..84c2ee25e --- /dev/null +++ b/docs/native-api/ImageResponse-api-windows.md @@ -0,0 +1,10 @@ +--- +id: ImageResponse +title: ImageResponse +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `class` + +> **EXPERIMENTAL** diff --git a/docs/native-api/ImageSource-api-windows.md b/docs/native-api/ImageSource-api-windows.md new file mode 100644 index 000000000..8838dd45c --- /dev/null +++ b/docs/native-api/ImageSource-api-windows.md @@ -0,0 +1,31 @@ +--- +id: ImageSource +title: ImageSource +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `class` + +> **EXPERIMENTAL** + +Provides information about an image source requested by the application. + +## Properties +### Scale +`readonly` float `Scale` + +> **EXPERIMENTAL** + +### Size +`readonly` [`Size`](https://docs.microsoft.com/uwp/api/Windows.Foundation.Size) `Size` + +> **EXPERIMENTAL** + +### Uri +`readonly` [`Uri`](https://docs.microsoft.com/uwp/api/Windows.Foundation.Uri) `Uri` + +> **EXPERIMENTAL** + +## Referenced by +- [`IUriImageProvider`](IUriImageProvider) diff --git a/docs/native-api/ImageSourceType-api-windows.md b/docs/native-api/ImageSourceType-api-windows.md new file mode 100644 index 000000000..16d9ffd7f --- /dev/null +++ b/docs/native-api/ImageSourceType-api-windows.md @@ -0,0 +1,19 @@ +--- +id: ImageSourceType +title: ImageSourceType +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `enum` + +> **EXPERIMENTAL** + +| Name | Value | Description | +|--|--|--| +|`Invalid` | 0x0 | | +|`Remote` | 0x1 | | +|`Local` | 0x2 | | + +## Referenced by +- [`ImageSource`](ImageSource) diff --git a/docs/native-api/InitialStateDataFactory-api-windows.md b/docs/native-api/InitialStateDataFactory-api-windows.md new file mode 100644 index 000000000..2700b49ba --- /dev/null +++ b/docs/native-api/InitialStateDataFactory-api-windows.md @@ -0,0 +1,16 @@ +--- +id: InitialStateDataFactory +title: InitialStateDataFactory +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `delegate` + +> **EXPERIMENTAL** + +## Invoke +Object **`Invoke`**([`IComponentProps`](IComponentProps) props) + +## Referenced by +- [`IReactViewComponentBuilder`](IReactViewComponentBuilder) diff --git a/docs/native-api/InitializerDelegate-api-windows.md b/docs/native-api/InitializerDelegate-api-windows.md index 60e439a69..c6b90fe45 100644 --- a/docs/native-api/InitializerDelegate-api-windows.md +++ b/docs/native-api/InitializerDelegate-api-windows.md @@ -3,6 +3,8 @@ id: InitializerDelegate title: InitializerDelegate --- +![Architecture](https://img.shields.io/badge/architecture-new_&_old-green) + Kind: `delegate` A delegate that sets `reactContext` for a module. @@ -12,9 +14,5 @@ Experimental code uses it to initialize TurboModule `CallInvoker`. ## Invoke void **`Invoke`**([`IReactContext`](IReactContext) reactContext) - - - - ## Referenced by - [`IReactModuleBuilder`](IReactModuleBuilder) diff --git a/docs/native-api/InstanceCreatedEventArgs-api-windows.md b/docs/native-api/InstanceCreatedEventArgs-api-windows.md index da1d8ec3f..3bf584dae 100644 --- a/docs/native-api/InstanceCreatedEventArgs-api-windows.md +++ b/docs/native-api/InstanceCreatedEventArgs-api-windows.md @@ -3,9 +3,9 @@ id: InstanceCreatedEventArgs title: InstanceCreatedEventArgs --- -Kind: `class` - +![Architecture](https://img.shields.io/badge/architecture-new_&_old-green) +Kind: `class` The arguments for the [`ReactInstanceSettings.InstanceCreated`](ReactInstanceSettings#instancecreated) event. @@ -15,10 +15,10 @@ The arguments for the [`ReactInstanceSettings.InstanceCreated`](ReactInstanceSet Gets the [`IReactContext`](IReactContext) for the React instance that was just created. +### RuntimeHandle +`readonly` Object `RuntimeHandle` - - - +Provides access to the jsi::Runtime for synchronous access using GetOrCreateContextRuntime ## Referenced by - [`ReactInstanceSettings`](ReactInstanceSettings) diff --git a/docs/native-api/InstanceDestroyedEventArgs-api-windows.md b/docs/native-api/InstanceDestroyedEventArgs-api-windows.md index 72d87a115..cc179a500 100644 --- a/docs/native-api/InstanceDestroyedEventArgs-api-windows.md +++ b/docs/native-api/InstanceDestroyedEventArgs-api-windows.md @@ -3,9 +3,9 @@ id: InstanceDestroyedEventArgs title: InstanceDestroyedEventArgs --- -Kind: `class` - +![Architecture](https://img.shields.io/badge/architecture-new_&_old-green) +Kind: `class` The arguments for the [`ReactInstanceSettings.InstanceDestroyed`](ReactInstanceSettings#instancedestroyed) event. @@ -15,10 +15,5 @@ The arguments for the [`ReactInstanceSettings.InstanceDestroyed`](ReactInstanceS Gets the [`IReactContext`](IReactContext) for the React instance that just destroyed. - - - - - ## Referenced by - [`ReactInstanceSettings`](ReactInstanceSettings) diff --git a/docs/native-api/InstanceLoadedEventArgs-api-windows.md b/docs/native-api/InstanceLoadedEventArgs-api-windows.md index db7dc153e..9985f670b 100644 --- a/docs/native-api/InstanceLoadedEventArgs-api-windows.md +++ b/docs/native-api/InstanceLoadedEventArgs-api-windows.md @@ -3,9 +3,9 @@ id: InstanceLoadedEventArgs title: InstanceLoadedEventArgs --- -Kind: `class` - +![Architecture](https://img.shields.io/badge/architecture-new_&_old-green) +Kind: `class` The arguments for the [`ReactInstanceSettings.InstanceLoaded`](ReactInstanceSettings#instanceloaded) event. @@ -20,10 +20,10 @@ Gets the [`IReactContext`](IReactContext) for the React instance that finished l Returns `true` if the JavaScript bundle failed to load. +### RuntimeHandle +`readonly` Object `RuntimeHandle` - - - +Provides access to the jsi::Runtime for synchronous access using GetOrCreateContextRuntime ## Referenced by - [`ReactInstanceSettings`](ReactInstanceSettings) diff --git a/docs/native-api/JSIEngine-api-windows.md b/docs/native-api/JSIEngine-api-windows.md index fb3a4a052..dbfd15f53 100644 --- a/docs/native-api/JSIEngine-api-windows.md +++ b/docs/native-api/JSIEngine-api-windows.md @@ -3,6 +3,8 @@ id: JSIEngine title: JSIEngine --- +![Architecture](https://img.shields.io/badge/architecture-new_&_old-green) + Kind: `enum` A JavaScript engine type that can be set for a React instance in [`ReactInstanceSettings.JSIEngineOverride`](ReactInstanceSettings#jsiengineoverride) @@ -13,6 +15,5 @@ A JavaScript engine type that can be set for a React instance in [`ReactInstance |`Hermes` | 0x1 | | |`V8` | 0x2 | | - ## Referenced by - [`ReactInstanceSettings`](ReactInstanceSettings) diff --git a/docs/native-api/JSValueArgWriter-api-windows.md b/docs/native-api/JSValueArgWriter-api-windows.md index 47d3c778f..dd2f57c9c 100644 --- a/docs/native-api/JSValueArgWriter-api-windows.md +++ b/docs/native-api/JSValueArgWriter-api-windows.md @@ -3,19 +3,36 @@ id: JSValueArgWriter title: JSValueArgWriter --- +![Architecture](https://img.shields.io/badge/architecture-new_&_old-green) + +## New Architecture + Kind: `delegate` The `JSValueArgWriter` delegate is used to pass values to ABI API. In a function that implements the delegate use the provided `writer` to stream custom values. -## Invoke +### Invoke void **`Invoke`**([`IJSValueWriter`](IJSValueWriter) writer) +### Referenced by +- [`EmitEventSetterDelegate`](EmitEventSetterDelegate) +- [`EventEmitter`](EventEmitter) +- [`IReactContext`](IReactContext) +- [`ReactNativeIsland`](ReactNativeIsland) +- [`ReactViewOptions`](ReactViewOptions) + +## Old Architecture +Kind: `delegate` +The `JSValueArgWriter` delegate is used to pass values 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 +### Referenced by - [`EmitEventSetterDelegate`](EmitEventSetterDelegate) - [`IReactContext`](IReactContext) - [`ReactRootView`](ReactRootView) diff --git a/docs/native-api/JSValueType-api-windows.md b/docs/native-api/JSValueType-api-windows.md index 2166356e8..6e6705def 100644 --- a/docs/native-api/JSValueType-api-windows.md +++ b/docs/native-api/JSValueType-api-windows.md @@ -3,6 +3,8 @@ id: JSValueType title: JSValueType --- +![Architecture](https://img.shields.io/badge/architecture-new_&_old-green) + Kind: `enum` Type of value read by [`IJSValueReader`](IJSValueReader). @@ -17,6 +19,5 @@ Type of value read by [`IJSValueReader`](IJSValueReader). |`Int64` | 0x5 | | |`Double` | 0x6 | | - ## Referenced by - [`IJSValueReader`](IJSValueReader) diff --git a/docs/native-api/JsiBigIntRef-api-windows.md b/docs/native-api/JsiBigIntRef-api-windows.md index fd28e1972..cfbd3e7cb 100644 --- a/docs/native-api/JsiBigIntRef-api-windows.md +++ b/docs/native-api/JsiBigIntRef-api-windows.md @@ -3,6 +3,8 @@ id: JsiBigIntRef title: JsiBigIntRef --- +![Architecture](https://img.shields.io/badge/architecture-new_&_old-green) + Kind: `struct` > **EXPERIMENTAL** @@ -15,7 +17,5 @@ Note that the JSI is defined only for C++ code. We plan to add the .Net support ### Data Type: `uint64_t` - - ## Referenced by - [`JsiRuntime`](JsiRuntime) diff --git a/docs/native-api/JsiByteArrayUser-api-windows.md b/docs/native-api/JsiByteArrayUser-api-windows.md index 545b5f8cc..b958ff9e7 100644 --- a/docs/native-api/JsiByteArrayUser-api-windows.md +++ b/docs/native-api/JsiByteArrayUser-api-windows.md @@ -3,6 +3,8 @@ id: JsiByteArrayUser title: JsiByteArrayUser --- +![Architecture](https://img.shields.io/badge/architecture-new_&_old-green) + Kind: `delegate` > **EXPERIMENTAL** @@ -14,10 +16,6 @@ Note that the JSI is defined only for C++ code. We plan to add the .Net support ## Invoke void **`Invoke`**(uint8_t bytes) - - - - ## Referenced by - [`IJsiByteBuffer`](IJsiByteBuffer) - [`JsiRuntime`](JsiRuntime) diff --git a/docs/native-api/JsiError-api-windows.md b/docs/native-api/JsiError-api-windows.md index 987030793..9c24634a9 100644 --- a/docs/native-api/JsiError-api-windows.md +++ b/docs/native-api/JsiError-api-windows.md @@ -3,9 +3,9 @@ id: JsiError title: JsiError --- -Kind: `class` - +![Architecture](https://img.shields.io/badge/architecture-new_&_old-green) +Kind: `class` > **EXPERIMENTAL** @@ -39,10 +39,5 @@ Note that the JSI is defined only for C++ code. We plan to add the .Net support > **EXPERIMENTAL** - - - - - ## Referenced by - [`JsiRuntime`](JsiRuntime) diff --git a/docs/native-api/JsiErrorType-api-windows.md b/docs/native-api/JsiErrorType-api-windows.md index e876f0363..fc3eaad57 100644 --- a/docs/native-api/JsiErrorType-api-windows.md +++ b/docs/native-api/JsiErrorType-api-windows.md @@ -3,6 +3,8 @@ id: JsiErrorType title: JsiErrorType --- +![Architecture](https://img.shields.io/badge/architecture-new_&_old-green) + Kind: `enum` > **EXPERIMENTAL** @@ -16,7 +18,6 @@ Note that the JSI is defined only for C++ code. We plan to add the .Net support |`JSError` | 0x0 | | |`NativeException` | 0x1 | | - ## Referenced by - [`JsiError`](JsiError) - [`JsiRuntime`](JsiRuntime) diff --git a/docs/native-api/JsiHostFunction-api-windows.md b/docs/native-api/JsiHostFunction-api-windows.md index 551008f57..fe1f7683c 100644 --- a/docs/native-api/JsiHostFunction-api-windows.md +++ b/docs/native-api/JsiHostFunction-api-windows.md @@ -3,6 +3,8 @@ id: JsiHostFunction title: JsiHostFunction --- +![Architecture](https://img.shields.io/badge/architecture-new_&_old-green) + Kind: `delegate` > **EXPERIMENTAL** @@ -14,9 +16,5 @@ Note that the JSI is defined only for C++ code. We plan to add the .Net support ## Invoke [`JsiValueRef`](JsiValueRef) **`Invoke`**([`JsiRuntime`](JsiRuntime) runtime, [`JsiValueRef`](JsiValueRef) thisArg, [`JsiValueRef`](JsiValueRef) args) - - - - ## Referenced by - [`JsiRuntime`](JsiRuntime) diff --git a/docs/native-api/JsiInitializerDelegate-api-windows.md b/docs/native-api/JsiInitializerDelegate-api-windows.md new file mode 100644 index 000000000..f5a784ce4 --- /dev/null +++ b/docs/native-api/JsiInitializerDelegate-api-windows.md @@ -0,0 +1,18 @@ +--- +id: JsiInitializerDelegate +title: JsiInitializerDelegate +--- + +![Architecture](https://img.shields.io/badge/architecture-new_&_old-green) + +Kind: `delegate` + +A delegate that sets `reactContext` for a module. +We use it for a stand-alone initialize method, strongly typed JS events and functions. +Experimental code uses it to initialize TurboModule `CallInvoker`. + +## Invoke +void **`Invoke`**([`IReactContext`](IReactContext) reactContext, Object runtimeHandle) + +## Referenced by +- [`IReactModuleBuilder`](IReactModuleBuilder) diff --git a/docs/native-api/JsiObjectRef-api-windows.md b/docs/native-api/JsiObjectRef-api-windows.md index 43142f6ad..bf6fa1285 100644 --- a/docs/native-api/JsiObjectRef-api-windows.md +++ b/docs/native-api/JsiObjectRef-api-windows.md @@ -3,6 +3,8 @@ id: JsiObjectRef title: JsiObjectRef --- +![Architecture](https://img.shields.io/badge/architecture-new_&_old-green) + Kind: `struct` > **EXPERIMENTAL** @@ -15,7 +17,5 @@ Note that the JSI is defined only for C++ code. We plan to add the .Net support ### Data Type: `uint64_t` - - ## Referenced by - [`JsiRuntime`](JsiRuntime) diff --git a/docs/native-api/JsiPreparedJavaScript-api-windows.md b/docs/native-api/JsiPreparedJavaScript-api-windows.md index 6d1bedca5..d95c4971f 100644 --- a/docs/native-api/JsiPreparedJavaScript-api-windows.md +++ b/docs/native-api/JsiPreparedJavaScript-api-windows.md @@ -3,9 +3,9 @@ id: JsiPreparedJavaScript title: JsiPreparedJavaScript --- -Kind: `class` - +![Architecture](https://img.shields.io/badge/architecture-new_&_old-green) +Kind: `class` > **EXPERIMENTAL** @@ -13,10 +13,5 @@ An experimental API. Do not use it directly. It may be removed or changed in a f See the `ExecuteJsi` method in `JsiApiContext.h` of the `Microsoft.ReactNative.Cxx` shared project, or the examples of the JSI-based TurboModules in the `Microsoft.ReactNative.IntegrationTests` project. Note that the JSI is defined only for C++ code. We plan to add the .Net support in future. - - - - - ## Referenced by - [`JsiRuntime`](JsiRuntime) diff --git a/docs/native-api/JsiPropertyIdRef-api-windows.md b/docs/native-api/JsiPropertyIdRef-api-windows.md index 28c99fcc9..054b2e24a 100644 --- a/docs/native-api/JsiPropertyIdRef-api-windows.md +++ b/docs/native-api/JsiPropertyIdRef-api-windows.md @@ -3,6 +3,8 @@ id: JsiPropertyIdRef title: JsiPropertyIdRef --- +![Architecture](https://img.shields.io/badge/architecture-new_&_old-green) + Kind: `struct` > **EXPERIMENTAL** @@ -15,8 +17,6 @@ Note that the JSI is defined only for C++ code. We plan to add the .Net support ### Data Type: `uint64_t` - - ## Referenced by - [`IJsiHostObject`](IJsiHostObject) - [`JsiRuntime`](JsiRuntime) diff --git a/docs/native-api/JsiRuntime-api-windows.md b/docs/native-api/JsiRuntime-api-windows.md index a18025d79..ba383251b 100644 --- a/docs/native-api/JsiRuntime-api-windows.md +++ b/docs/native-api/JsiRuntime-api-windows.md @@ -3,9 +3,9 @@ id: JsiRuntime title: JsiRuntime --- -Kind: `class` - +![Architecture](https://img.shields.io/badge/architecture-new_&_old-green) +Kind: `class` > **EXPERIMENTAL** @@ -29,537 +29,387 @@ Note that the JSI is defined only for C++ code. We plan to add the .Net support > **EXPERIMENTAL** - - ## Methods ### BigIntStrictEquals bool **`BigIntStrictEquals`**([`JsiBigIntRef`](JsiBigIntRef) left, [`JsiBigIntRef`](JsiBigIntRef) right) > **EXPERIMENTAL** - - ### BigintIsInt64 bool **`BigintIsInt64`**([`JsiBigIntRef`](JsiBigIntRef) bigInt) > **EXPERIMENTAL** - - ### BigintIsUint64 bool **`BigintIsUint64`**([`JsiBigIntRef`](JsiBigIntRef) bigInt) > **EXPERIMENTAL** - - ### BigintToString [`JsiStringRef`](JsiStringRef) **`BigintToString`**([`JsiBigIntRef`](JsiBigIntRef) bigInt, int val) > **EXPERIMENTAL** - - ### Call [`JsiValueRef`](JsiValueRef) **`Call`**([`JsiObjectRef`](JsiObjectRef) func, [`JsiValueRef`](JsiValueRef) thisArg, [`JsiValueRef`](JsiValueRef) args) > **EXPERIMENTAL** - - ### CallAsConstructor [`JsiValueRef`](JsiValueRef) **`CallAsConstructor`**([`JsiObjectRef`](JsiObjectRef) func, [`JsiValueRef`](JsiValueRef) args) > **EXPERIMENTAL** - - ### CloneBigInt [`JsiBigIntRef`](JsiBigIntRef) **`CloneBigInt`**([`JsiBigIntRef`](JsiBigIntRef) bigInt) > **EXPERIMENTAL** - - ### CloneObject [`JsiObjectRef`](JsiObjectRef) **`CloneObject`**([`JsiObjectRef`](JsiObjectRef) obj) > **EXPERIMENTAL** - - ### ClonePropertyId [`JsiPropertyIdRef`](JsiPropertyIdRef) **`ClonePropertyId`**([`JsiPropertyIdRef`](JsiPropertyIdRef) propertyId) > **EXPERIMENTAL** - - ### CloneString [`JsiStringRef`](JsiStringRef) **`CloneString`**([`JsiStringRef`](JsiStringRef) str) > **EXPERIMENTAL** - - ### CloneSymbol [`JsiSymbolRef`](JsiSymbolRef) **`CloneSymbol`**([`JsiSymbolRef`](JsiSymbolRef) symbol) > **EXPERIMENTAL** - - ### CreateArray [`JsiObjectRef`](JsiObjectRef) **`CreateArray`**(uint32_t size) > **EXPERIMENTAL** - - ### CreateArrayBuffer [`JsiObjectRef`](JsiObjectRef) **`CreateArrayBuffer`**([`JsiObjectRef`](JsiObjectRef) buffer) > **EXPERIMENTAL** - - ### CreateBigIntFromInt64 [`JsiBigIntRef`](JsiBigIntRef) **`CreateBigIntFromInt64`**(int64_t val) > **EXPERIMENTAL** - - ### CreateBigIntFromUint64 [`JsiBigIntRef`](JsiBigIntRef) **`CreateBigIntFromUint64`**(uint64_t val) > **EXPERIMENTAL** - - ### CreateFunctionFromHostFunction [`JsiObjectRef`](JsiObjectRef) **`CreateFunctionFromHostFunction`**([`JsiPropertyIdRef`](JsiPropertyIdRef) funcName, uint32_t paramCount, [`JsiHostFunction`](JsiHostFunction) hostFunc) > **EXPERIMENTAL** - - ### CreateObject [`JsiObjectRef`](JsiObjectRef) **`CreateObject`**() > **EXPERIMENTAL** - - ### CreateObjectWithHostObject [`JsiObjectRef`](JsiObjectRef) **`CreateObjectWithHostObject`**([`IJsiHostObject`](IJsiHostObject) hostObject) > **EXPERIMENTAL** - - ### CreatePropertyId [`JsiPropertyIdRef`](JsiPropertyIdRef) **`CreatePropertyId`**(string name) > **EXPERIMENTAL** - - ### CreatePropertyIdFromAscii [`JsiPropertyIdRef`](JsiPropertyIdRef) **`CreatePropertyIdFromAscii`**(uint8_t ascii) > **EXPERIMENTAL** - - ### CreatePropertyIdFromString [`JsiPropertyIdRef`](JsiPropertyIdRef) **`CreatePropertyIdFromString`**([`JsiStringRef`](JsiStringRef) str) > **EXPERIMENTAL** - - ### CreatePropertyIdFromSymbol [`JsiPropertyIdRef`](JsiPropertyIdRef) **`CreatePropertyIdFromSymbol`**([`JsiSymbolRef`](JsiSymbolRef) sym) > **EXPERIMENTAL** - - ### CreatePropertyIdFromUtf8 [`JsiPropertyIdRef`](JsiPropertyIdRef) **`CreatePropertyIdFromUtf8`**(uint8_t utf8) > **EXPERIMENTAL** - - ### CreateString [`JsiStringRef`](JsiStringRef) **`CreateString`**(string value) > **EXPERIMENTAL** - - ### CreateStringFromAscii [`JsiStringRef`](JsiStringRef) **`CreateStringFromAscii`**(uint8_t ascii) > **EXPERIMENTAL** - - ### CreateStringFromUtf8 [`JsiStringRef`](JsiStringRef) **`CreateStringFromUtf8`**(uint8_t utf8) > **EXPERIMENTAL** - - ### CreateValueFromJson [`JsiValueRef`](JsiValueRef) **`CreateValueFromJson`**(string json) > **EXPERIMENTAL** - - ### CreateValueFromJsonUtf8 [`JsiValueRef`](JsiValueRef) **`CreateValueFromJsonUtf8`**(uint8_t json) > **EXPERIMENTAL** - - ### CreateWeakObject [`JsiWeakObjectRef`](JsiWeakObjectRef) **`CreateWeakObject`**([`JsiObjectRef`](JsiObjectRef) obj) > **EXPERIMENTAL** - - ### DrainMicrotasks bool **`DrainMicrotasks`**(int maxMicrotasksHint) > **EXPERIMENTAL** - - ### EvaluateJavaScript [`JsiValueRef`](JsiValueRef) **`EvaluateJavaScript`**([`IJsiByteBuffer`](IJsiByteBuffer) buffer, string sourceUrl) > **EXPERIMENTAL** - - ### EvaluatePreparedJavaScript [`JsiValueRef`](JsiValueRef) **`EvaluatePreparedJavaScript`**([`JsiPreparedJavaScript`](JsiPreparedJavaScript) js) > **EXPERIMENTAL** - - ### GetAndClearError [`JsiError`](JsiError) **`GetAndClearError`**() > **EXPERIMENTAL** - - ### GetArrayBufferData void **`GetArrayBufferData`**([`JsiObjectRef`](JsiObjectRef) arrayBuffer, [`JsiByteArrayUser`](JsiByteArrayUser) useArrayBytes) > **EXPERIMENTAL** - - ### GetArrayBufferSize uint32_t **`GetArrayBufferSize`**([`JsiObjectRef`](JsiObjectRef) arrayBuffer) > **EXPERIMENTAL** - - ### GetArraySize uint32_t **`GetArraySize`**([`JsiObjectRef`](JsiObjectRef) arr) > **EXPERIMENTAL** - - ### GetHostFunction [`JsiHostFunction`](JsiHostFunction) **`GetHostFunction`**([`JsiObjectRef`](JsiObjectRef) func) > **EXPERIMENTAL** - - ### GetHostObject [`IJsiHostObject`](IJsiHostObject) **`GetHostObject`**([`JsiObjectRef`](JsiObjectRef) obj) > **EXPERIMENTAL** - - ### GetNativeState [`IReactNonAbiValue`](IReactNonAbiValue) **`GetNativeState`**([`JsiObjectRef`](JsiObjectRef) obj) > **EXPERIMENTAL** - - ### GetProperty [`JsiValueRef`](JsiValueRef) **`GetProperty`**([`JsiObjectRef`](JsiObjectRef) obj, [`JsiPropertyIdRef`](JsiPropertyIdRef) propertyId) > **EXPERIMENTAL** - - ### GetPropertyIdArray [`JsiObjectRef`](JsiObjectRef) **`GetPropertyIdArray`**([`JsiObjectRef`](JsiObjectRef) obj) > **EXPERIMENTAL** - - ### GetValueAtIndex [`JsiValueRef`](JsiValueRef) **`GetValueAtIndex`**([`JsiObjectRef`](JsiObjectRef) arr, uint32_t index) > **EXPERIMENTAL** - - ### HasNativeState bool **`HasNativeState`**([`JsiObjectRef`](JsiObjectRef) obj) > **EXPERIMENTAL** - - ### HasProperty bool **`HasProperty`**([`JsiObjectRef`](JsiObjectRef) obj, [`JsiPropertyIdRef`](JsiPropertyIdRef) propertyId) > **EXPERIMENTAL** - - ### InstanceOf bool **`InstanceOf`**([`JsiObjectRef`](JsiObjectRef) obj, [`JsiObjectRef`](JsiObjectRef) constructor) > **EXPERIMENTAL** - - ### IsArray bool **`IsArray`**([`JsiObjectRef`](JsiObjectRef) obj) > **EXPERIMENTAL** - - ### IsArrayBuffer bool **`IsArrayBuffer`**([`JsiObjectRef`](JsiObjectRef) obj) > **EXPERIMENTAL** - - ### IsFunction bool **`IsFunction`**([`JsiObjectRef`](JsiObjectRef) obj) > **EXPERIMENTAL** - - ### IsHostFunction bool **`IsHostFunction`**([`JsiObjectRef`](JsiObjectRef) obj) > **EXPERIMENTAL** - - ### IsHostObject bool **`IsHostObject`**([`JsiObjectRef`](JsiObjectRef) obj) > **EXPERIMENTAL** - - ### LockWeakObject [`JsiValueRef`](JsiValueRef) **`LockWeakObject`**([`JsiWeakObjectRef`](JsiWeakObjectRef) weakObject) > **EXPERIMENTAL** - - ### MakeChakraRuntime `static` [`JsiRuntime`](JsiRuntime) **`MakeChakraRuntime`**() > **EXPERIMENTAL** - - ### ObjectStrictEquals bool **`ObjectStrictEquals`**([`JsiObjectRef`](JsiObjectRef) left, [`JsiObjectRef`](JsiObjectRef) right) > **EXPERIMENTAL** - - ### PopScope void **`PopScope`**([`JsiScopeState`](JsiScopeState) scopeState) > **EXPERIMENTAL** - - ### PrepareJavaScript [`JsiPreparedJavaScript`](JsiPreparedJavaScript) **`PrepareJavaScript`**([`IJsiByteBuffer`](IJsiByteBuffer) buffer, string sourceUrl) > **EXPERIMENTAL** - - ### PropertyIdEquals bool **`PropertyIdEquals`**([`JsiPropertyIdRef`](JsiPropertyIdRef) left, [`JsiPropertyIdRef`](JsiPropertyIdRef) right) > **EXPERIMENTAL** - - ### PropertyIdToString string **`PropertyIdToString`**([`JsiPropertyIdRef`](JsiPropertyIdRef) propertyId) > **EXPERIMENTAL** - - ### PropertyIdToUtf8 void **`PropertyIdToUtf8`**([`JsiPropertyIdRef`](JsiPropertyIdRef) propertyId, [`JsiByteArrayUser`](JsiByteArrayUser) useUtf8String) > **EXPERIMENTAL** - - ### PushScope [`JsiScopeState`](JsiScopeState) **`PushScope`**() > **EXPERIMENTAL** +### QueueMicrotask +void **`QueueMicrotask`**([`JsiObjectRef`](JsiObjectRef) callback) +> **EXPERIMENTAL** ### ReleaseBigInt void **`ReleaseBigInt`**([`JsiBigIntRef`](JsiBigIntRef) bigInt) > **EXPERIMENTAL** - - ### ReleaseObject void **`ReleaseObject`**([`JsiObjectRef`](JsiObjectRef) obj) > **EXPERIMENTAL** - - ### ReleasePropertyId void **`ReleasePropertyId`**([`JsiPropertyIdRef`](JsiPropertyIdRef) propertyId) > **EXPERIMENTAL** - - ### ReleaseString void **`ReleaseString`**([`JsiStringRef`](JsiStringRef) str) > **EXPERIMENTAL** - - ### ReleaseSymbol void **`ReleaseSymbol`**([`JsiSymbolRef`](JsiSymbolRef) symbol) > **EXPERIMENTAL** - - ### SetError void **`SetError`**([`JsiErrorType`](JsiErrorType) errorType, string errorDetails, [`JsiValueRef`](JsiValueRef) value) > **EXPERIMENTAL** - - ### SetNativeState void **`SetNativeState`**([`JsiObjectRef`](JsiObjectRef) obj, [`IReactNonAbiValue`](IReactNonAbiValue) state) > **EXPERIMENTAL** - - ### SetProperty void **`SetProperty`**([`JsiObjectRef`](JsiObjectRef) obj, [`JsiPropertyIdRef`](JsiPropertyIdRef) propertyId, [`JsiValueRef`](JsiValueRef) value) > **EXPERIMENTAL** - - ### SetValueAtIndex void **`SetValueAtIndex`**([`JsiObjectRef`](JsiObjectRef) arr, uint32_t index, [`JsiValueRef`](JsiValueRef) value) > **EXPERIMENTAL** - - ### StringStrictEquals bool **`StringStrictEquals`**([`JsiStringRef`](JsiStringRef) left, [`JsiStringRef`](JsiStringRef) right) > **EXPERIMENTAL** - - ### StringToString string **`StringToString`**([`JsiStringRef`](JsiStringRef) str) > **EXPERIMENTAL** - - ### StringToUtf8 void **`StringToUtf8`**([`JsiStringRef`](JsiStringRef) str, [`JsiByteArrayUser`](JsiByteArrayUser) useUtf8String) > **EXPERIMENTAL** - - ### SymbolStrictEquals bool **`SymbolStrictEquals`**([`JsiSymbolRef`](JsiSymbolRef) left, [`JsiSymbolRef`](JsiSymbolRef) right) > **EXPERIMENTAL** - - ### SymbolToString string **`SymbolToString`**([`JsiSymbolRef`](JsiSymbolRef) symbol) > **EXPERIMENTAL** - - ### SymbolToUtf8 void **`SymbolToUtf8`**([`JsiSymbolRef`](JsiSymbolRef) symbol, [`JsiByteArrayUser`](JsiByteArrayUser) useUtf8String) > **EXPERIMENTAL** - - ### Truncate uint64_t **`Truncate`**([`JsiBigIntRef`](JsiBigIntRef) bigInt) > **EXPERIMENTAL** - - - - - ## Referenced by - [`IJsiHostObject`](IJsiHostObject) - [`JsiHostFunction`](JsiHostFunction) diff --git a/docs/native-api/JsiScopeState-api-windows.md b/docs/native-api/JsiScopeState-api-windows.md index 34ae749b4..9cec40606 100644 --- a/docs/native-api/JsiScopeState-api-windows.md +++ b/docs/native-api/JsiScopeState-api-windows.md @@ -3,6 +3,8 @@ id: JsiScopeState title: JsiScopeState --- +![Architecture](https://img.shields.io/badge/architecture-new_&_old-green) + Kind: `struct` > **EXPERIMENTAL** @@ -15,7 +17,5 @@ Note that the JSI is defined only for C++ code. We plan to add the .Net support ### Data Type: `uint64_t` - - ## Referenced by - [`JsiRuntime`](JsiRuntime) diff --git a/docs/native-api/JsiStringRef-api-windows.md b/docs/native-api/JsiStringRef-api-windows.md index ed92e59f9..2835d9f0c 100644 --- a/docs/native-api/JsiStringRef-api-windows.md +++ b/docs/native-api/JsiStringRef-api-windows.md @@ -3,6 +3,8 @@ id: JsiStringRef title: JsiStringRef --- +![Architecture](https://img.shields.io/badge/architecture-new_&_old-green) + Kind: `struct` > **EXPERIMENTAL** @@ -15,7 +17,5 @@ Note that the JSI is defined only for C++ code. We plan to add the .Net support ### Data Type: `uint64_t` - - ## Referenced by - [`JsiRuntime`](JsiRuntime) diff --git a/docs/native-api/JsiSymbolRef-api-windows.md b/docs/native-api/JsiSymbolRef-api-windows.md index c175d8884..551bdd073 100644 --- a/docs/native-api/JsiSymbolRef-api-windows.md +++ b/docs/native-api/JsiSymbolRef-api-windows.md @@ -3,6 +3,8 @@ id: JsiSymbolRef title: JsiSymbolRef --- +![Architecture](https://img.shields.io/badge/architecture-new_&_old-green) + Kind: `struct` > **EXPERIMENTAL** @@ -15,7 +17,5 @@ Note that the JSI is defined only for C++ code. We plan to add the .Net support ### Data Type: `uint64_t` - - ## Referenced by - [`JsiRuntime`](JsiRuntime) diff --git a/docs/native-api/JsiValueKind-api-windows.md b/docs/native-api/JsiValueKind-api-windows.md index 202fb9b83..216c04c29 100644 --- a/docs/native-api/JsiValueKind-api-windows.md +++ b/docs/native-api/JsiValueKind-api-windows.md @@ -3,6 +3,8 @@ id: JsiValueKind title: JsiValueKind --- +![Architecture](https://img.shields.io/badge/architecture-new_&_old-green) + Kind: `enum` > **EXPERIMENTAL** @@ -22,6 +24,5 @@ Note that the JSI is defined only for C++ code. We plan to add the .Net support |`String` | 0x6 | | |`Object` | 0x7 | | - ## Referenced by - [`JsiValueRef`](JsiValueRef) diff --git a/docs/native-api/JsiValueRef-api-windows.md b/docs/native-api/JsiValueRef-api-windows.md index 579bb2eaf..6a9ec1cf1 100644 --- a/docs/native-api/JsiValueRef-api-windows.md +++ b/docs/native-api/JsiValueRef-api-windows.md @@ -3,6 +3,8 @@ id: JsiValueRef title: JsiValueRef --- +![Architecture](https://img.shields.io/badge/architecture-new_&_old-green) + Kind: `struct` > **EXPERIMENTAL** @@ -18,8 +20,6 @@ Type: `uint64_t` ### Kind Type: [`JsiValueKind`](JsiValueKind) - - ## Referenced by - [`IJsiHostObject`](IJsiHostObject) - [`JsiError`](JsiError) diff --git a/docs/native-api/JsiWeakObjectRef-api-windows.md b/docs/native-api/JsiWeakObjectRef-api-windows.md index 5fff6a270..dbc5af663 100644 --- a/docs/native-api/JsiWeakObjectRef-api-windows.md +++ b/docs/native-api/JsiWeakObjectRef-api-windows.md @@ -3,6 +3,8 @@ id: JsiWeakObjectRef title: JsiWeakObjectRef --- +![Architecture](https://img.shields.io/badge/architecture-new_&_old-green) + Kind: `struct` > **EXPERIMENTAL** @@ -15,7 +17,5 @@ Note that the JSI is defined only for C++ code. We plan to add the .Net support ### Data Type: `uint64_t` - - ## Referenced by - [`JsiRuntime`](JsiRuntime) diff --git a/docs/native-api/KeyRoutedEventArgs-api-windows.md b/docs/native-api/KeyRoutedEventArgs-api-windows.md new file mode 100644 index 000000000..3a82a37f7 --- /dev/null +++ b/docs/native-api/KeyRoutedEventArgs-api-windows.md @@ -0,0 +1,32 @@ +--- +id: KeyRoutedEventArgs +title: KeyRoutedEventArgs +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `interface` + +Implements: [`RoutedEventArgs`](RoutedEventArgs) + +## Properties +### DeviceId +`readonly` string `DeviceId` + +### Handled + bool `Handled` + +### Key +`readonly` [`VirtualKey`](https://docs.microsoft.com/uwp/api/Windows.System.VirtualKey) `Key` + +### KeyStatus +`readonly` [`PhysicalKeyStatus`](https://learn.microsoft.com/windows/windows-app-sdk/api/winrt/Microsoft.UI.Input.PhysicalKeyStatus) `KeyStatus` + +### KeyboardSource +`readonly` [`KeyboardSource`](KeyboardSource) `KeyboardSource` + +### OriginalKey +`readonly` [`VirtualKey`](https://docs.microsoft.com/uwp/api/Windows.System.VirtualKey) `OriginalKey` + +## Referenced by +- [`ComponentView`](ComponentView) diff --git a/docs/native-api/KeyboardSource-api-windows.md b/docs/native-api/KeyboardSource-api-windows.md new file mode 100644 index 000000000..8d48343de --- /dev/null +++ b/docs/native-api/KeyboardSource-api-windows.md @@ -0,0 +1,16 @@ +--- +id: KeyboardSource +title: KeyboardSource +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `interface` + +## Methods +### GetKeyState +[`VirtualKeyStates`](https://learn.microsoft.com/windows/windows-app-sdk/api/winrt/Microsoft.UI.Input.VirtualKeyStates) **`GetKeyState`**([`VirtualKey`](https://docs.microsoft.com/uwp/api/Windows.System.VirtualKey) key) + +## Referenced by +- [`CharacterReceivedRoutedEventArgs`](CharacterReceivedRoutedEventArgs) +- [`KeyRoutedEventArgs`](KeyRoutedEventArgs) diff --git a/docs/native-api/LayoutConstraints-api-windows.md b/docs/native-api/LayoutConstraints-api-windows.md new file mode 100644 index 000000000..8cbedbb4b --- /dev/null +++ b/docs/native-api/LayoutConstraints-api-windows.md @@ -0,0 +1,24 @@ +--- +id: LayoutConstraints +title: LayoutConstraints +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `struct` + +> **EXPERIMENTAL** + +## Fields +### LayoutDirection +Type: [`LayoutDirection`](LayoutDirection) + +### MaximumSize +Type: [`Size`](https://docs.microsoft.com/uwp/api/Windows.Foundation.Size) + +### MinimumSize +Type: [`Size`](https://docs.microsoft.com/uwp/api/Windows.Foundation.Size) + +## Referenced by +- [`MeasureContentHandler`](MeasureContentHandler) +- [`ReactNativeIsland`](ReactNativeIsland) diff --git a/docs/native-api/LayoutContext-api-windows.md b/docs/native-api/LayoutContext-api-windows.md new file mode 100644 index 000000000..53c81fb5a --- /dev/null +++ b/docs/native-api/LayoutContext-api-windows.md @@ -0,0 +1,36 @@ +--- +id: LayoutContext +title: LayoutContext +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `class` + +> **EXPERIMENTAL** + +## Properties +### FontSizeMultiplier + float `FontSizeMultiplier` + +> **EXPERIMENTAL** + +### PointScaleFactor + float `PointScaleFactor` + +> **EXPERIMENTAL** + +### SwapLeftAndRightInRTL + bool `SwapLeftAndRightInRTL` + +> **EXPERIMENTAL** + +### ViewportOffset + [`Point`](https://docs.microsoft.com/uwp/api/Windows.Foundation.Point) `ViewportOffset` + +> **EXPERIMENTAL** + +## Referenced by +- [`LayoutHandler`](LayoutHandler) +- [`MeasureContentHandler`](MeasureContentHandler) +- [`YogaLayoutableShadowNode`](YogaLayoutableShadowNode) diff --git a/docs/native-api/LayoutDirection-api-windows.md b/docs/native-api/LayoutDirection-api-windows.md new file mode 100644 index 000000000..9a73d740c --- /dev/null +++ b/docs/native-api/LayoutDirection-api-windows.md @@ -0,0 +1,19 @@ +--- +id: LayoutDirection +title: LayoutDirection +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `enum` + +> **EXPERIMENTAL** + +| Name | Value | Description | +|--|--|--| +|`Undefined` | 0x0 | | +|`LeftToRight` | 0x1 | | +|`RightToLeft` | 0x2 | | + +## Referenced by +- [`LayoutConstraints`](LayoutConstraints) diff --git a/docs/native-api/LayoutHandler-api-windows.md b/docs/native-api/LayoutHandler-api-windows.md new file mode 100644 index 000000000..79a312aed --- /dev/null +++ b/docs/native-api/LayoutHandler-api-windows.md @@ -0,0 +1,16 @@ +--- +id: LayoutHandler +title: LayoutHandler +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `delegate` + +> **EXPERIMENTAL** + +## Invoke +void **`Invoke`**([`ShadowNode`](ShadowNode) shadowNode, [`LayoutContext`](LayoutContext) layoutContext) + +## Referenced by +- [`IReactViewComponentBuilder`](IReactViewComponentBuilder) diff --git a/docs/native-api/LayoutMetrics-api-windows.md b/docs/native-api/LayoutMetrics-api-windows.md new file mode 100644 index 000000000..cd46af1e6 --- /dev/null +++ b/docs/native-api/LayoutMetrics-api-windows.md @@ -0,0 +1,21 @@ +--- +id: LayoutMetrics +title: LayoutMetrics +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `struct` + +> **EXPERIMENTAL** + +## Fields +### Frame +Type: [`Rect`](https://docs.microsoft.com/uwp/api/Windows.Foundation.Rect) + +### PointScaleFactor +Type: `float` + +## Referenced by +- [`ComponentView`](ComponentView) +- [`LayoutMetricsChangedArgs`](LayoutMetricsChangedArgs) diff --git a/docs/native-api/LayoutMetricsChangedArgs-api-windows.md b/docs/native-api/LayoutMetricsChangedArgs-api-windows.md new file mode 100644 index 000000000..04e174389 --- /dev/null +++ b/docs/native-api/LayoutMetricsChangedArgs-api-windows.md @@ -0,0 +1,24 @@ +--- +id: LayoutMetricsChangedArgs +title: LayoutMetricsChangedArgs +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `class` + +> **EXPERIMENTAL** + +## Properties +### NewLayoutMetrics +`readonly` [`LayoutMetrics`](LayoutMetrics) `NewLayoutMetrics` + +> **EXPERIMENTAL** + +### OldLayoutMetrics +`readonly` [`LayoutMetrics`](LayoutMetrics) `OldLayoutMetrics` + +> **EXPERIMENTAL** + +## Referenced by +- [`ComponentView`](ComponentView) diff --git a/docs/native-api/LayoutService-api-windows.md b/docs/native-api/LayoutService-api-windows.md index 259f8f08d..238e1ea4e 100644 --- a/docs/native-api/LayoutService-api-windows.md +++ b/docs/native-api/LayoutService-api-windows.md @@ -3,9 +3,9 @@ id: LayoutService title: LayoutService --- -Kind: `class` - +![Architecture](https://img.shields.io/badge/architecture-old_only-yellow) +Kind: `class` Provides access to Yoga layout functionality. @@ -15,35 +15,23 @@ Provides access to Yoga layout functionality. Determines whether the UIManager is currently processing a batch of node updates.This is useful for optimizing layout and ensuring that applying layout to a particular node will not cause tearing in the rendered UI. - - ## Methods ### ApplyLayout void **`ApplyLayout`**(int64_t reactTag, float width, float height) Recursively applies layout from the given React node with the supplied size constraints. This method will trigger a Yoga layout operation on the given node and its descendants and apply the layout results to these nodes. - - ### ApplyLayoutForAllNodes void **`ApplyLayoutForAllNodes`**() Recursively applies layout to all root nodes. This method will trigger a Yoga layout operation on roots attached to the React instance and apply the layout results to all descendant nodes. - - ### FromContext `static` [`LayoutService`](LayoutService) **`FromContext`**([`IReactContext`](IReactContext) context) Use this method to get access to the [`LayoutService`](LayoutService) associated with the [`IReactContext`](IReactContext). - - ### MarkDirty void **`MarkDirty`**(int64_t reactTag) Mark a particular React node as dirty for Yoga layout. - - - - diff --git a/docs/native-api/LoadingState-api-windows.md b/docs/native-api/LoadingState-api-windows.md index ab01d7f8d..0ec069710 100644 --- a/docs/native-api/LoadingState-api-windows.md +++ b/docs/native-api/LoadingState-api-windows.md @@ -3,6 +3,8 @@ id: LoadingState title: LoadingState --- +![Architecture](https://img.shields.io/badge/architecture-new_&_old-green) + Kind: `enum` Used to represent the state of the React Native JavaScript instance @@ -14,6 +16,5 @@ Used to represent the state of the React Native JavaScript instance |`HasError` | 0x2 | The instance has hit an error. Calls to run JavaScript functions will not be run.| |`Unloaded` | 0x3 | The instance has successfully unloaded. Calls to run JavaScript functions will not be run.| - ## Referenced by - [`IReactContext`](IReactContext) diff --git a/docs/native-api/LogHandler-api-windows.md b/docs/native-api/LogHandler-api-windows.md index 4973c92e3..e23708182 100644 --- a/docs/native-api/LogHandler-api-windows.md +++ b/docs/native-api/LogHandler-api-windows.md @@ -3,6 +3,8 @@ id: LogHandler title: LogHandler --- +![Architecture](https://img.shields.io/badge/architecture-new_&_old-green) + Kind: `delegate` delegate to represent a logging function. @@ -10,9 +12,5 @@ delegate to represent a logging function. ## Invoke void **`Invoke`**([`LogLevel`](LogLevel) level, string message) - - - - ## Referenced by - [`ReactInstanceSettings`](ReactInstanceSettings) diff --git a/docs/native-api/LogLevel-api-windows.md b/docs/native-api/LogLevel-api-windows.md index cd19b7f48..523517356 100644 --- a/docs/native-api/LogLevel-api-windows.md +++ b/docs/native-api/LogLevel-api-windows.md @@ -3,6 +3,8 @@ id: LogLevel title: LogLevel --- +![Architecture](https://img.shields.io/badge/architecture-new_&_old-green) + Kind: `enum` Used in [`LogHandler`](LogHandler) to represent different LogLevels @@ -15,6 +17,5 @@ Used in [`LogHandler`](LogHandler) to represent different LogLevels |`Error` | 0x3 | | |`Fatal` | 0x4 | | - ## Referenced by - [`LogHandler`](LogHandler) diff --git a/docs/native-api/LosingFocusEventArgs-api-windows.md b/docs/native-api/LosingFocusEventArgs-api-windows.md new file mode 100644 index 000000000..7be661274 --- /dev/null +++ b/docs/native-api/LosingFocusEventArgs-api-windows.md @@ -0,0 +1,45 @@ +--- +id: LosingFocusEventArgs +title: LosingFocusEventArgs +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `class` + +Implements: [`RoutedEventArgs`](RoutedEventArgs) + +> **EXPERIMENTAL** + +## Properties +### Direction +`readonly` [`FocusNavigationDirection`](FocusNavigationDirection) `Direction` + +> **EXPERIMENTAL** + +### NewFocusedComponent +`readonly` [`ComponentView`](ComponentView) `NewFocusedComponent` + +> **EXPERIMENTAL** + +### OldFocusedComponent +`readonly` [`ComponentView`](ComponentView) `OldFocusedComponent` + +> **EXPERIMENTAL** + +### OriginalSource +`readonly` int `OriginalSource` + +## Methods +### TryCancel +void **`TryCancel`**() + +> **EXPERIMENTAL** + +### TrySetNewFocusedComponent +void **`TrySetNewFocusedComponent`**([`ComponentView`](ComponentView) component) + +> **EXPERIMENTAL** + +## Referenced by +- [`ComponentView`](ComponentView) diff --git a/docs/native-api/MeasureContentHandler-api-windows.md b/docs/native-api/MeasureContentHandler-api-windows.md new file mode 100644 index 000000000..4c60f2610 --- /dev/null +++ b/docs/native-api/MeasureContentHandler-api-windows.md @@ -0,0 +1,16 @@ +--- +id: MeasureContentHandler +title: MeasureContentHandler +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `delegate` + +> **EXPERIMENTAL** + +## Invoke +[`Size`](https://docs.microsoft.com/uwp/api/Windows.Foundation.Size) **`Invoke`**([`ShadowNode`](ShadowNode) shadowNode, [`LayoutContext`](LayoutContext) layoutContext, [`LayoutConstraints`](LayoutConstraints) layoutConstraints) + +## Referenced by +- [`IReactViewComponentBuilder`](IReactViewComponentBuilder) diff --git a/docs/native-api/MethodDelegate-api-windows.md b/docs/native-api/MethodDelegate-api-windows.md index d7be72c9d..3d66bf5f1 100644 --- a/docs/native-api/MethodDelegate-api-windows.md +++ b/docs/native-api/MethodDelegate-api-windows.md @@ -3,6 +3,8 @@ id: MethodDelegate title: MethodDelegate --- +![Architecture](https://img.shields.io/badge/architecture-new_&_old-green) + Kind: `delegate` A delegate to call native asynchronous method. @@ -10,9 +12,5 @@ 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/docs/native-api/MethodResultCallback-api-windows.md b/docs/native-api/MethodResultCallback-api-windows.md index c03d62907..ea0547a14 100644 --- a/docs/native-api/MethodResultCallback-api-windows.md +++ b/docs/native-api/MethodResultCallback-api-windows.md @@ -3,6 +3,8 @@ id: MethodResultCallback title: MethodResultCallback --- +![Architecture](https://img.shields.io/badge/architecture-new_&_old-green) + Kind: `delegate` A callback to call JS code with results. @@ -10,9 +12,5 @@ A callback to call JS code with results. ## Invoke void **`Invoke`**([`IJSValueWriter`](IJSValueWriter) outputWriter) - - - - ## Referenced by - [`MethodDelegate`](MethodDelegate) diff --git a/docs/native-api/MethodReturnType-api-windows.md b/docs/native-api/MethodReturnType-api-windows.md index 801b6d571..5183b01b6 100644 --- a/docs/native-api/MethodReturnType-api-windows.md +++ b/docs/native-api/MethodReturnType-api-windows.md @@ -3,6 +3,8 @@ id: MethodReturnType title: MethodReturnType --- +![Architecture](https://img.shields.io/badge/architecture-new_&_old-green) + Kind: `enum` Native method return type. @@ -14,6 +16,5 @@ Native method return type. |`TwoCallbacks` | 0x2 | | |`Promise` | 0x3 | | - ## Referenced by - [`IReactModuleBuilder`](IReactModuleBuilder) diff --git a/docs/native-api/MicrosoftCompositionContextHelper-api-windows.md b/docs/native-api/MicrosoftCompositionContextHelper-api-windows.md new file mode 100644 index 000000000..1ae23c014 --- /dev/null +++ b/docs/native-api/MicrosoftCompositionContextHelper-api-windows.md @@ -0,0 +1,52 @@ +--- +id: MicrosoftCompositionContextHelper +title: MicrosoftCompositionContextHelper +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `class` + +> **EXPERIMENTAL** + +A helper static class to create a [`ICompositionContext`](ICompositionContext) based on Microsoft.Composition Visuals. Generally it should not be required to call this directly. Instead you should call CompositionUIService.SetCompositor (unresolved reference). This is not for general consumption and is expected to be removed in a future release. + +## Methods +### CreateContext +`static` [`ICompositionContext`](ICompositionContext) **`CreateContext`**([`Compositor`](https://learn.microsoft.com/windows/windows-app-sdk/api/winrt/Microsoft.UI.Composition.Compositor) compositor) + +> **EXPERIMENTAL** + +Creates a [`ICompositionContext`](ICompositionContext) from a Compositor + +### CreateVisual +`static` [`IVisual`](IVisual) **`CreateVisual`**([`Visual`](https://learn.microsoft.com/windows/windows-app-sdk/api/winrt/Microsoft.UI.Composition.Visual) visual) + +> **EXPERIMENTAL** + +Creates a [`IVisual`](IVisual) from a Visual + +### InnerBrush +`static` [`CompositionBrush`](https://learn.microsoft.com/windows/windows-app-sdk/api/winrt/Microsoft.UI.Composition.CompositionBrush) **`InnerBrush`**([`IBrush`](IBrush) brush) + +> **EXPERIMENTAL** + +### InnerCompositor +`static` [`Compositor`](https://learn.microsoft.com/windows/windows-app-sdk/api/winrt/Microsoft.UI.Composition.Compositor) **`InnerCompositor`**([`ICompositionContext`](ICompositionContext) context) + +> **EXPERIMENTAL** + +### InnerDropShadow +`static` [`DropShadow`](https://learn.microsoft.com/windows/windows-app-sdk/api/winrt/Microsoft.UI.Composition.DropShadow) **`InnerDropShadow`**([`IDropShadow`](IDropShadow) shadow) + +> **EXPERIMENTAL** + +### InnerSurface +`static` [`ICompositionSurface`](https://learn.microsoft.com/windows/windows-app-sdk/api/winrt/Microsoft.UI.Composition.ICompositionSurface) **`InnerSurface`**([`IDrawingSurfaceBrush`](IDrawingSurfaceBrush) surface) + +> **EXPERIMENTAL** + +### InnerVisual +`static` [`Visual`](https://learn.microsoft.com/windows/windows-app-sdk/api/winrt/Microsoft.UI.Composition.Visual) **`InnerVisual`**([`IVisual`](IVisual) visual) + +> **EXPERIMENTAL** diff --git a/docs/native-api/MountChildComponentViewArgs-api-windows.md b/docs/native-api/MountChildComponentViewArgs-api-windows.md new file mode 100644 index 000000000..31d056094 --- /dev/null +++ b/docs/native-api/MountChildComponentViewArgs-api-windows.md @@ -0,0 +1,24 @@ +--- +id: MountChildComponentViewArgs +title: MountChildComponentViewArgs +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `class` + +> **EXPERIMENTAL** + +## Properties +### Child +`readonly` [`ComponentView`](ComponentView) `Child` + +> **EXPERIMENTAL** + +### Index +`readonly` uint32_t `Index` + +> **EXPERIMENTAL** + +## Referenced by +- [`MountChildComponentViewDelegate`](MountChildComponentViewDelegate) diff --git a/docs/native-api/MountChildComponentViewDelegate-api-windows.md b/docs/native-api/MountChildComponentViewDelegate-api-windows.md new file mode 100644 index 000000000..322f9a78f --- /dev/null +++ b/docs/native-api/MountChildComponentViewDelegate-api-windows.md @@ -0,0 +1,16 @@ +--- +id: MountChildComponentViewDelegate +title: MountChildComponentViewDelegate +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `delegate` + +> **EXPERIMENTAL** + +## Invoke +void **`Invoke`**([`ComponentView`](ComponentView) source, [`MountChildComponentViewArgs`](MountChildComponentViewArgs) args) + +## Referenced by +- [`IReactViewComponentBuilder`](IReactViewComponentBuilder) diff --git a/docs/native-api/ParagraphComponentView-api-windows.md b/docs/native-api/ParagraphComponentView-api-windows.md new file mode 100644 index 000000000..6e303bf24 --- /dev/null +++ b/docs/native-api/ParagraphComponentView-api-windows.md @@ -0,0 +1,12 @@ +--- +id: ParagraphComponentView +title: ParagraphComponentView +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `class` + +Extends: [`ViewComponentView`](ViewComponentView) + +> **EXPERIMENTAL** diff --git a/docs/native-api/Pointer-api-windows.md b/docs/native-api/Pointer-api-windows.md new file mode 100644 index 000000000..776febf74 --- /dev/null +++ b/docs/native-api/Pointer-api-windows.md @@ -0,0 +1,19 @@ +--- +id: Pointer +title: Pointer +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `class` + +## Properties +### PointerDeviceType +`readonly` [`PointerDeviceType`](PointerDeviceType) `PointerDeviceType` + +### PointerId +`readonly` uint32_t `PointerId` + +## Referenced by +- [`ComponentView`](ComponentView) +- [`PointerRoutedEventArgs`](PointerRoutedEventArgs) diff --git a/docs/native-api/PointerDeviceType-api-windows.md b/docs/native-api/PointerDeviceType-api-windows.md new file mode 100644 index 000000000..53fda929d --- /dev/null +++ b/docs/native-api/PointerDeviceType-api-windows.md @@ -0,0 +1,19 @@ +--- +id: PointerDeviceType +title: PointerDeviceType +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `enum` + +| Name | Value | Description | +|--|--|--| +|`Touch` | 0x0 | | +|`Pen` | 0x1 | | +|`Mouse` | 0x2 | | +|`Touchpad` | 0x3 | | + +## Referenced by +- [`Pointer`](Pointer) +- [`PointerPoint`](PointerPoint) diff --git a/docs/native-api/PointerEventKind-api-windows.md b/docs/native-api/PointerEventKind-api-windows.md index 148a8ab29..6179c5c64 100644 --- a/docs/native-api/PointerEventKind-api-windows.md +++ b/docs/native-api/PointerEventKind-api-windows.md @@ -3,6 +3,8 @@ id: PointerEventKind title: PointerEventKind --- +![Architecture](https://img.shields.io/badge/architecture-old_only-yellow) + Kind: `enum` > **EXPERIMENTAL** @@ -10,12 +12,11 @@ Kind: `enum` | Name | Value | Description | |--|--|--| |`None` | 0x0 | Default pointer event kind that corresponding to events that should be ignored by the React root view pointer event handler.| -|`Start` | 0x1 | Pointer event kind corresponding to @Windows.UI.Xaml.UIElement.PointerPressedEvent on the React root view.| -|`End` | 0x2 | Pointer event kind corresponding to @Windows.UI.Xaml.UIElement.PointerReleasedEvent on the React root view.| -|`Move` | 0x3 | Pointer event kind corresponding to @Windows.UI.Xaml.UIElement.PointerMovedEvent on the React root view.| -|`Cancel` | 0x4 | Pointer event kind corresponding to @Windows.UI.Xaml.UIElement.PointerCanceledEvent on the React root view.| -|`CaptureLost` | 0x5 | Pointer event kind corresponding to @Windows.UI.Xaml.UIElement.PointerCaptureLostEvent on the React root view.| - +|`Start` | 0x1 | Pointer event kind corresponding to [`UIElement.PointerPressedEvent`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.UIElement.PointerPressedEvent) on the React root view.| +|`End` | 0x2 | Pointer event kind corresponding to [`UIElement.PointerReleasedEvent`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.UIElement.PointerReleasedEvent) on the React root view.| +|`Move` | 0x3 | Pointer event kind corresponding to [`UIElement.PointerMovedEvent`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.UIElement.PointerMovedEvent) on the React root view.| +|`Cancel` | 0x4 | Pointer event kind corresponding to [`UIElement.PointerCanceledEvent`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.UIElement.PointerCanceledEvent) on the React root view.| +|`CaptureLost` | 0x5 | Pointer event kind corresponding to [`UIElement.PointerCaptureLostEvent`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.UIElement.PointerCaptureLostEvent) on the React root view.| ## Referenced by - [`ReactPointerEventArgs`](ReactPointerEventArgs) diff --git a/docs/native-api/PointerPoint-api-windows.md b/docs/native-api/PointerPoint-api-windows.md new file mode 100644 index 000000000..751f29d2d --- /dev/null +++ b/docs/native-api/PointerPoint-api-windows.md @@ -0,0 +1,40 @@ +--- +id: PointerPoint +title: PointerPoint +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `class` + +## Properties +### FrameId +`readonly` uint32_t `FrameId` + +### Inner +`readonly` [`PointerPoint`](https://learn.microsoft.com/windows/windows-app-sdk/api/winrt/Microsoft.UI.Input.PointerPoint) `Inner` + +### IsInContact +`readonly` bool `IsInContact` + +### PointerDeviceType +`readonly` [`PointerDeviceType`](PointerDeviceType) `PointerDeviceType` + +### PointerId +`readonly` uint32_t `PointerId` + +### Position +`readonly` [`Point`](https://docs.microsoft.com/uwp/api/Windows.Foundation.Point) `Position` + +### Properties +`readonly` [`PointerPointProperties`](PointerPointProperties) `Properties` + +### Timestamp +`readonly` uint64_t `Timestamp` + +## Methods +### GetOffsetPoint +[`PointerPoint`](PointerPoint) **`GetOffsetPoint`**([`Point`](https://docs.microsoft.com/uwp/api/Windows.Foundation.Point) offset) + +## Referenced by +- [`PointerRoutedEventArgs`](PointerRoutedEventArgs) diff --git a/docs/native-api/PointerPointProperties-api-windows.md b/docs/native-api/PointerPointProperties-api-windows.md new file mode 100644 index 000000000..270aa6ace --- /dev/null +++ b/docs/native-api/PointerPointProperties-api-windows.md @@ -0,0 +1,75 @@ +--- +id: PointerPointProperties +title: PointerPointProperties +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `class` + +## Properties +### ContactRect +`readonly` [`Rect`](https://docs.microsoft.com/uwp/api/Windows.Foundation.Rect) `ContactRect` + +### IsBarrelButtonPressed +`readonly` bool `IsBarrelButtonPressed` + +### IsCanceled +`readonly` bool `IsCanceled` + +### IsEraser +`readonly` bool `IsEraser` + +### IsHorizontalMouseWheel +`readonly` bool `IsHorizontalMouseWheel` + +### IsInRange +`readonly` bool `IsInRange` + +### IsInverted +`readonly` bool `IsInverted` + +### IsLeftButtonPressed +`readonly` bool `IsLeftButtonPressed` + +### IsMiddleButtonPressed +`readonly` bool `IsMiddleButtonPressed` + +### IsPrimary +`readonly` bool `IsPrimary` + +### IsRightButtonPressed +`readonly` bool `IsRightButtonPressed` + +### IsXButton1Pressed +`readonly` bool `IsXButton1Pressed` + +### IsXButton2Pressed +`readonly` bool `IsXButton2Pressed` + +### MouseWheelDelta +`readonly` int `MouseWheelDelta` + +### Orientation +`readonly` float `Orientation` + +### PointerUpdateKind +`readonly` [`PointerUpdateKind`](PointerUpdateKind) `PointerUpdateKind` + +### Pressure +`readonly` float `Pressure` + +### TouchConfidence +`readonly` bool `TouchConfidence` + +### Twist +`readonly` float `Twist` + +### XTilt +`readonly` float `XTilt` + +### YTilt +`readonly` float `YTilt` + +## Referenced by +- [`PointerPoint`](PointerPoint) diff --git a/docs/native-api/PointerRoutedEventArgs-api-windows.md b/docs/native-api/PointerRoutedEventArgs-api-windows.md new file mode 100644 index 000000000..f8d082f12 --- /dev/null +++ b/docs/native-api/PointerRoutedEventArgs-api-windows.md @@ -0,0 +1,31 @@ +--- +id: PointerRoutedEventArgs +title: PointerRoutedEventArgs +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `class` + +Implements: [`RoutedEventArgs`](RoutedEventArgs) + +## Properties +### Handled + bool `Handled` + +### KeyModifiers +`readonly` [`VirtualKeyModifiers`](https://docs.microsoft.com/uwp/api/Windows.System.VirtualKeyModifiers) `KeyModifiers` + +### OriginalSource +`readonly` int `OriginalSource` + +### Pointer +`readonly` [`Pointer`](Pointer) `Pointer` + +## Methods +### GetCurrentPoint +[`PointerPoint`](PointerPoint) **`GetCurrentPoint`**(int tag) + +## Referenced by +- [`ComponentView`](ComponentView) +- [`IScrollVisual`](IScrollVisual) diff --git a/docs/native-api/PointerUpdateKind-api-windows.md b/docs/native-api/PointerUpdateKind-api-windows.md new file mode 100644 index 000000000..540e60766 --- /dev/null +++ b/docs/native-api/PointerUpdateKind-api-windows.md @@ -0,0 +1,25 @@ +--- +id: PointerUpdateKind +title: PointerUpdateKind +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `enum` + +| Name | Value | Description | +|--|--|--| +|`Other` | 0x0 | | +|`LeftButtonPressed` | 0x1 | | +|`LeftButtonReleased` | 0x2 | | +|`RightButtonPressed` | 0x3 | | +|`RightButtonReleased` | 0x4 | | +|`MiddleButtonPressed` | 0x5 | | +|`MiddleButtonReleased` | 0x6 | | +|`XButton1Pressed` | 0x7 | | +|`XButton1Released` | 0x8 | | +|`XButton2Pressed` | 0x9 | | +|`XButton2Released` | 0xa | | + +## Referenced by +- [`PointerPointProperties`](PointerPointProperties) diff --git a/docs/native-api/PortalComponentView-api-windows.md b/docs/native-api/PortalComponentView-api-windows.md new file mode 100644 index 000000000..2706d42c1 --- /dev/null +++ b/docs/native-api/PortalComponentView-api-windows.md @@ -0,0 +1,25 @@ +--- +id: PortalComponentView +title: PortalComponentView +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `class` + +Extends: [`ComponentView`](ComponentView) + +> **EXPERIMENTAL** + +Used to implement UI that is hosted outside the main UI tree, such as modal. + +## Properties +### ContentRoot +`readonly` [`RootComponentView`](RootComponentView) `ContentRoot` + +> **EXPERIMENTAL** + +## Referenced by +- [`PortalComponentViewInitializer`](PortalComponentViewInitializer) +- [`ReactNativeIsland`](ReactNativeIsland) +- [`RootComponentView`](RootComponentView) diff --git a/docs/native-api/PortalComponentViewInitializer-api-windows.md b/docs/native-api/PortalComponentViewInitializer-api-windows.md new file mode 100644 index 000000000..7142143de --- /dev/null +++ b/docs/native-api/PortalComponentViewInitializer-api-windows.md @@ -0,0 +1,16 @@ +--- +id: PortalComponentViewInitializer +title: PortalComponentViewInitializer +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `delegate` + +> **EXPERIMENTAL** + +## Invoke +void **`Invoke`**([`PortalComponentView`](PortalComponentView) view) + +## Referenced by +- [`IReactCompositionViewComponentBuilder`](IReactCompositionViewComponentBuilder) diff --git a/docs/native-api/QuirkSettings-api-windows.md b/docs/native-api/QuirkSettings-api-windows.md index 31d2ec6de..03376acd3 100644 --- a/docs/native-api/QuirkSettings-api-windows.md +++ b/docs/native-api/QuirkSettings-api-windows.md @@ -3,16 +3,14 @@ id: QuirkSettings title: QuirkSettings --- -Kind: `class` - +![Architecture](https://img.shields.io/badge/architecture-new_&_old-green) +Kind: `class` > **EXPERIMENTAL** This can be used to add settings that allow react-native-windows behavior to be maintained across version updates to facilitate upgrades. Settings in this class are likely to be removed in future releases, so apps should try to update their code to not rely on these settings. - - ## Methods ### SetAcceptSelfSigned `static` void **`SetAcceptSelfSigned`**([`ReactInstanceSettings`](ReactInstanceSettings) settings, bool value) @@ -21,8 +19,6 @@ This can be used to add settings that allow react-native-windows behavior to be Runtime setting allowing Networking (HTTP, WebSocket) connections to skip certificate validation. - - ### SetBackHandlerKind `static` void **`SetBackHandlerKind`**([`ReactInstanceSettings`](ReactInstanceSettings) settings, [`BackNavigationHandlerKind`](BackNavigationHandlerKind) kind) @@ -30,8 +26,6 @@ Runtime setting allowing Networking (HTTP, WebSocket) connections to skip certif By default `react-native-windows` will handle various back events and forward them to JavaScript. Setting this to [`BackNavigationHandlerKind.Native`](BackNavigationHandlerKind) prevents `react-native-windows` from handling these events, including forwarding to JavaScript. This will allow applications to handle back navigation in native code, but will prevent the `BackHandler` native module from receiving events. - - ### SetMapWindowDeactivatedToAppStateInactive `static` void **`SetMapWindowDeactivatedToAppStateInactive`**([`ReactInstanceSettings`](ReactInstanceSettings) settings, bool value) @@ -41,8 +35,6 @@ By default `react-native-windows` will handle various back events and forward th By default `react-native-windows` will only track `active` and `background` `AppState`. Setting this to true enables `react-native-windows` to also track `inactive` `AppState` which [maps closely to iOS.](https://reactnative.dev/docs/appstate)`inactive` tracks the [Window.Activated Event](https://docs.microsoft.com/uwp/api/windows.ui.core.corewindow.activated) when the window is deactivated. - - ### SetMatchAndroidAndIOSStretchBehavior `static` void **`SetMatchAndroidAndIOSStretchBehavior`**([`ReactInstanceSettings`](ReactInstanceSettings) settings, bool value) @@ -53,8 +45,6 @@ By default `react-native-windows` will only track `active` and `background` `App Older versions of react-native-windows did not use [Yoga](https://github.com/facebook/yoga)'s legacy stretch behavior. This meant that react-native-windows would layout views slightly differently that in iOS and Android. Set this setting to false to maintain the behavior from react-native-windows <= 0.62. - - ### SetSuppressWindowFocusOnViewFocus `static` void **`SetSuppressWindowFocusOnViewFocus`**([`ReactInstanceSettings`](ReactInstanceSettings) settings, bool value) @@ -62,8 +52,6 @@ Set this setting to false to maintain the behavior from react-native-windows <= When running multiple windows from a single UI thread, focusing a native view causes the parent window of that view to get focus as well. Set this setting to true to prevent focus of a blurred window when a view in that window is programmatically focused. - - ### SetUseRuntimeScheduler `static` void **`SetUseRuntimeScheduler`**([`ReactInstanceSettings`](ReactInstanceSettings) settings, bool value) @@ -71,8 +59,6 @@ When running multiple windows from a single UI thread, focusing a native view ca By default `react-native-windows` will use the new RuntimeScheduler.Setting this to false will revert the behavior to previous scheduling logic. - - ### SetUseWebFlexBasisBehavior `static` void **`SetUseWebFlexBasisBehavior`**([`ReactInstanceSettings`](ReactInstanceSettings) settings, bool value) @@ -81,7 +67,3 @@ By default `react-native-windows` will use the new RuntimeScheduler.Setting this **Default value**: `false` There is a chance that cached flex basis values can cause text truncation in some re-layout scenarios. Enabling [Yoga](https://github.com/facebook/yoga)'s experimental web flex basis behavior fixes this issue, however using it may result in performance regressions due to additional layout passes. - - - - diff --git a/docs/native-api/ReactApplication-api-windows.md b/docs/native-api/ReactApplication-api-windows.md index 80cc5d350..c6bf6ede7 100644 --- a/docs/native-api/ReactApplication-api-windows.md +++ b/docs/native-api/ReactApplication-api-windows.md @@ -3,11 +3,11 @@ id: ReactApplication title: ReactApplication --- -Kind: `class` - -Extends: [`Application`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.Application) +![Architecture](https://img.shields.io/badge/architecture-old_only-yellow) +Kind: `class` +Extends: [`Application`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.Application) The `ReactApplication` is a base application class for use in applications that are entirely written in React Native. When the app launches, the `ReactApplication` will load the React instance. Use [`ReactInstanceSettings`](ReactInstanceSettings) and [`ReactNativeHost`](ReactNativeHost) properties to customize React instance in your application's constructor. @@ -44,14 +44,8 @@ Provides access to the list of `IReactPackageProvider`'s that the instance will Controls whether the developer experience features such as the developer menu and `RedBox` are enabled. See [`ReactInstanceSettings.UseDeveloperSupport`](ReactInstanceSettings#usedevelopersupport). - ## Constructors ### ReactApplication **`ReactApplication`**() Creates a new instance of [`ReactApplication`](ReactApplication) - - - - - diff --git a/docs/native-api/ReactCoreInjection-api-windows.md b/docs/native-api/ReactCoreInjection-api-windows.md index b110ffa90..20c2133cc 100644 --- a/docs/native-api/ReactCoreInjection-api-windows.md +++ b/docs/native-api/ReactCoreInjection-api-windows.md @@ -3,16 +3,14 @@ id: ReactCoreInjection title: ReactCoreInjection --- -Kind: `class` - +![Architecture](https://img.shields.io/badge/architecture-new_&_old-green) +Kind: `class` > **EXPERIMENTAL** Used to inject platform specific implementations to create react-native targets targeting non-XAML platforms. - - ## Methods ### GetTopLevelWindowId `static` uint64_t **`GetTopLevelWindowId`**([`IReactPropertyBag`](IReactPropertyBag) properties) @@ -21,8 +19,6 @@ Used to inject platform specific implementations to create react-native targets Gets the window handle HWND (as an UInt64) for the active top level application window. - - ### MakeViewHost `static` [`IReactViewHost`](IReactViewHost) **`MakeViewHost`**([`ReactNativeHost`](ReactNativeHost) host, [`ReactViewOptions`](ReactViewOptions) viewOptions) @@ -30,8 +26,6 @@ Gets the window handle HWND (as an UInt64) for the active top level application Custom ReactViewInstances use this to create a host to connect to. - - ### PostToUIBatchingQueue `static` void **`PostToUIBatchingQueue`**([`IReactContext`](IReactContext) context, [`ReactDispatcherCallback`](ReactDispatcherCallback) callback) @@ -39,8 +33,6 @@ Custom ReactViewInstances use this to create a host to connect to. Post something to the main UI dispatcher using the batching queue - - ### SetPlatformNameOverride `static` void **`SetPlatformNameOverride`**([`IReactPropertyBag`](IReactPropertyBag) properties, string platformName) @@ -48,8 +40,6 @@ Post something to the main UI dispatcher using the batching queue Override platform name. This will change the platform used when requesting bundles from metro. Default: \"windows\" - - ### SetTimerFactory `static` void **`SetTimerFactory`**([`IReactPropertyBag`](IReactPropertyBag) properties, [`TimerFactory`](TimerFactory) timerFactory) @@ -57,8 +47,6 @@ Override platform name. This will change the platform used when requesting bundl Sets a factory method for creating custom timers, in environments where system dispatch timers should not be used. - - ### SetTopLevelWindowId `static` void **`SetTopLevelWindowId`**([`IReactPropertyBag`](IReactPropertyBag) properties, uint64_t windowId) @@ -66,15 +54,9 @@ Sets a factory method for creating custom timers, in environments where system d Sets the window handle HWND (as an UInt64) for the active top level application window.This must be manually provided to the [`ReactInstanceSettings`](ReactInstanceSettings) object when using ReactNativeWindowswithout XAML for certain APIs work correctly. - - ### SetUIBatchCompleteCallback `static` void **`SetUIBatchCompleteCallback`**([`IReactPropertyBag`](IReactPropertyBag) properties, [`UIBatchCompleteCallback`](UIBatchCompleteCallback) xamlRoot) > **EXPERIMENTAL** -Sets the Callback to call when a UI batch is completed. - - - - +Sets the Callback to call when a UI batch is completed. diff --git a/docs/native-api/ReactCreatePropertyValue-api-windows.md b/docs/native-api/ReactCreatePropertyValue-api-windows.md index d4df18b0d..a365bfc9b 100644 --- a/docs/native-api/ReactCreatePropertyValue-api-windows.md +++ b/docs/native-api/ReactCreatePropertyValue-api-windows.md @@ -3,6 +3,8 @@ id: ReactCreatePropertyValue title: ReactCreatePropertyValue --- +![Architecture](https://img.shields.io/badge/architecture-new_&_old-green) + Kind: `delegate` This delegate is used to create a [`IReactPropertyBag`](IReactPropertyBag) property value on-demand. @@ -10,9 +12,5 @@ This delegate is used to create a [`IReactPropertyBag`](IReactPropertyBag) prope ## Invoke Object **`Invoke`**() - - - - ## Referenced by - [`IReactPropertyBag`](IReactPropertyBag) diff --git a/docs/native-api/ReactDispatcherCallback-api-windows.md b/docs/native-api/ReactDispatcherCallback-api-windows.md index 3dd658e7a..3e71c11bf 100644 --- a/docs/native-api/ReactDispatcherCallback-api-windows.md +++ b/docs/native-api/ReactDispatcherCallback-api-windows.md @@ -3,6 +3,8 @@ id: ReactDispatcherCallback title: ReactDispatcherCallback --- +![Architecture](https://img.shields.io/badge/architecture-new_&_old-green) + Kind: `delegate` The delegate is used to create property value on-demand. @@ -10,10 +12,6 @@ The delegate is used to create property value on-demand. ## Invoke void **`Invoke`**() - - - - ## Referenced by - [`IReactDispatcher`](IReactDispatcher) - [`ReactCoreInjection`](ReactCoreInjection) diff --git a/docs/native-api/ReactDispatcherHelper-api-windows.md b/docs/native-api/ReactDispatcherHelper-api-windows.md index c3c5c9d66..1c7f55a17 100644 --- a/docs/native-api/ReactDispatcherHelper-api-windows.md +++ b/docs/native-api/ReactDispatcherHelper-api-windows.md @@ -3,9 +3,9 @@ id: ReactDispatcherHelper title: ReactDispatcherHelper --- -Kind: `class` - +![Architecture](https://img.shields.io/badge/architecture-new_&_old-green) +Kind: `class` Helper methods for the [`IReactDispatcher`](IReactDispatcher) implementation. @@ -25,6 +25,8 @@ This notification name is to be used with IReactNotificationService. ### JSDispatcherProperty `static` `readonly` [`IReactPropertyName`](IReactPropertyName) `JSDispatcherProperty` +> **Deprecated**: Use [`IReactContext.CallInvoker`](IReactContext#callinvoker) instead + Gets name of the `JSDispatcher` property for the [`IReactPropertyBag`](IReactPropertyBag). Generally you can use [`IReactContext.JSDispatcher`](IReactContext#jsdispatcher) to get the value of this property for a specific React instance. @@ -46,14 +48,8 @@ Generally you can use [`IReactContext.UIDispatcher`](IReactContext#uidispatcher) Gets or creates a [`IReactDispatcher`](IReactDispatcher) for the current UI thread. This can be used with [`ReactInstanceSettings.UIDispatcher`](ReactInstanceSettings#uidispatcher) to launch a React instance from a non-UI thread. This API must be called from a UI thread. It will return null if called from a non-UI thread. - - ## Methods ### CreateSerialDispatcher `static` [`IReactDispatcher`](IReactDispatcher) **`CreateSerialDispatcher`**() Creates a new serial dispatcher that uses thread pool to run tasks. - - - - diff --git a/docs/native-api/ReactInstanceSettings-api-windows.md b/docs/native-api/ReactInstanceSettings-api-windows.md index d3dd4c41c..d26c848a7 100644 --- a/docs/native-api/ReactInstanceSettings-api-windows.md +++ b/docs/native-api/ReactInstanceSettings-api-windows.md @@ -3,19 +3,21 @@ id: ReactInstanceSettings title: ReactInstanceSettings --- -Kind: `class` +![Architecture](https://img.shields.io/badge/architecture-new_&_old-green) +## New Architecture +Kind: `class` Provides settings to create a React instance. -## Properties -### BundleAppId +### Properties +#### BundleAppId string `BundleAppId` The name of the app passed to the packager server via the 'app' query parameter. This is useful when bundling multiple applications from the same packager instance. If no value is set, the parameter will not be passed. -### BundleRootPath +#### BundleRootPath string `BundleRootPath` **Default value**: `ms-appx:///Bundle/` @@ -29,39 +31,38 @@ Examples: - `resource://moduleName` - locates the bundle as an embedded RCDATA resource in moduleName. Specify the resource ID in [`JavaScriptBundleFile`](#javascriptbundlefile). - `resource://` - locates the bundle as an embedded RCDATA resource in the running process's module. Specify the resource ID in [`JavaScriptBundleFile`](#javascriptbundlefile). - -### ByteCodeFileUri +#### 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). **Note that currently the byte code generation is not implemented for UWP applications.** -### DebugBundlePath +#### 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) is used. -### DebuggerBreakOnNextLine +#### DebuggerBreakOnNextLine bool `DebuggerBreakOnNextLine` For direct debugging, controls 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. As a workaround you could add the `debugger` keyword in the beginning of the bundle.*** -### DebuggerPort +#### DebuggerPort uint16_t `DebuggerPort` **Default value**: `9229` When [`UseDirectDebugger`](#usedirectdebugger) is enabled, this controls the port that the JavaScript engine debugger will run on. -### DebuggerRuntimeName +#### DebuggerRuntimeName string `DebuggerRuntimeName` Name to associate with the JavaScript runtime when debugging. This name will show up in the list of JavaScript runtimes to attach to in edge://inspect or other debuggers -### EnableByteCodeCaching +#### EnableByteCodeCaching bool `EnableByteCodeCaching` **Default value**: `false` @@ -71,28 +72,28 @@ Subsequent runs of the application should be faster as the JavaScript will be lo [`ByteCodeFileUri`](#bytecodefileuri) must be set to a location the application has write access to in order for the bytecode to be successfully cached. **Note that currently the byte code generation is not implemented for UWP applications.** -### EnableDefaultCrashHandler +#### EnableDefaultCrashHandler bool `EnableDefaultCrashHandler` **Default value**: `false` Enables the default unhandled exception handler that logs additional information into a text file for [Windows Error Reporting](https://docs.microsoft.com/windows/win32/wer/windows-error-reporting). -### EnableDeveloperMenu +#### EnableDeveloperMenu bool `EnableDeveloperMenu` > **Deprecated**: This property has been replaced by [`UseDeveloperSupport`](#usedevelopersupport). In version 0.63 both properties will do the same thing. It will be removed in a future version. This controls whether various developer experience features are available for this instance. In particular the developer menu, and the default `RedBox` experience. -### EnableJITCompilation +#### EnableJITCompilation bool `EnableJITCompilation` **Default value**: `true` Flag controlling whether the JavaScript engine uses JIT compilation. -### JSIEngineOverride +#### JSIEngineOverride [`JSIEngine`](JSIEngine) `JSIEngineOverride` **Default value**: `JSIEngine.Chakra` @@ -100,7 +101,7 @@ Flag controlling whether the JavaScript engine uses JIT compilation. The [`JSIEngine`](JSIEngine) override to be used with the React instance. In order for the override to work, Microsoft.ReactNative must be compiled with support of that engine. This override will be ignored when [`UseWebDebugger`](#usewebdebugger) is set to true, since the browser must use its own engine to debug correctly. -### JavaScriptBundleFile +#### JavaScriptBundleFile string `JavaScriptBundleFile` **Default value**: `index.windows` @@ -108,78 +109,78 @@ In order for the override to work, Microsoft.ReactNative must be compiled with s The name of the JavaScript bundle file to load. This should be a relative path from [`BundleRootPath`](#bundlerootpath). The `.bundle` extension will be appended to the end, when looking for the bundle file. If using an embedded RCDATA resource, this identifies the resource ID that stores the bundle. See [`BundleRootPath`](#bundlerootpath). -### NativeLogger +#### NativeLogger [`LogHandler`](LogHandler) `NativeLogger` Function that will be hooked into the JavaScript instance as global.nativeLoggingHook. This allows native hooks for JavaScript's console implementation. If this is not set then logs will print output to the native debug output in debug builds, and no-op in release builds. -### Notifications +#### Notifications `readonly` [`IReactNotificationService`](IReactNotificationService) `Notifications` Gets a [`IReactNotificationService`](IReactNotificationService) to send notifications between components and the application. Use [`IReactContext.Notifications`](IReactContext#notifications) to access this [`IReactNotificationService`](IReactNotificationService) from native components or view managers. -### PackageProviders +#### PackageProviders `readonly` [`IVector`](https://docs.microsoft.com/uwp/api/Windows.Foundation.Collections.IVector-1)<[`IReactPackageProvider`](IReactPackageProvider)> `PackageProviders` Gets a list of [`IReactPackageProvider`](IReactPackageProvider). Add an implementation of [`IReactPackageProvider`](IReactPackageProvider) to this list to define additional native modules and custom view managers to be included in the React instance. Auto-linking automatically adds [`IReactPackageProvider`](IReactPackageProvider) to the application's [`PackageProviders`](#packageproviders). -### Properties +#### Properties `readonly` [`IReactPropertyBag`](IReactPropertyBag) `Properties` Gets a [`IReactPropertyBag`](IReactPropertyBag) to share values between components and the application. Use [`IReactContext.Properties`](IReactContext#properties-1) to access this [`IReactPropertyBag`](IReactPropertyBag) from native components and view managers. -### RedBoxHandler +#### RedBoxHandler [`IRedBoxHandler`](IRedBoxHandler) `RedBoxHandler` Provides an extension point to allow custom error handling within the react instance. See [`IRedBoxHandler`](IRedBoxHandler) for more information. -### RequestDevBundle +#### RequestDevBundle bool `RequestDevBundle` When querying the bundle server for a bundle, should it request the dev bundle or release bundle. -### RequestInlineSourceMap +#### RequestInlineSourceMap bool `RequestInlineSourceMap` **Default value**: `true` When using [`UseFastRefresh`](#usefastrefresh), [`UseLiveReload`](#uselivereload), or [`UseWebDebugger`](#usewebdebugger) this controls whether the bundler should include inline source maps.If set, the bundler will include the source maps inline (this will improve debugging experience, but for very large bundles it could have a significant performance hit) -### SourceBundleHost +#### SourceBundleHost string `SourceBundleHost` **Default value**: `localhost` When using [`UseFastRefresh`](#usefastrefresh), [`UseLiveReload`](#uselivereload), or [`UseWebDebugger`](#usewebdebugger) this is the server hostname that will be used to load the bundle from. -### SourceBundlePort +#### SourceBundlePort uint16_t `SourceBundlePort` **Default value**: `8081` When using [`UseFastRefresh`](#usefastrefresh), [`UseLiveReload`](#uselivereload), or [`UseWebDebugger`](#usewebdebugger) this is the server port that will be used to load the bundle from. -### UIDispatcher +#### 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 +#### UseDeveloperSupport bool `UseDeveloperSupport` This controls whether various developer experience features are available for this instance. In particular, it enables the developer menu, the default `RedBox` and `LogBox` experience. -### UseDirectDebugger +#### UseDirectDebugger bool `UseDirectDebugger` Enables debugging in the JavaScript engine (if supported). For Chakra this enables debugging of the JS runtime directly within the app using Visual Studio -> Attach to process (Script) -### UseFastRefresh +#### UseFastRefresh bool `UseFastRefresh` Controls whether the instance triggers the hot module reload logic when it first loads the instance. @@ -187,7 +188,7 @@ Most edits should be visible within a second or two without the instance having Non-compatible changes still cause full reloads. See [Fast Refresh](https://reactnative.dev/docs/fast-refresh) for more information on Fast Refresh. -### UseLiveReload +#### UseLiveReload bool `UseLiveReload` > **Deprecated**: For general use this has been replaced by [`UseFastRefresh`](#usefastrefresh). @@ -195,8 +196,7 @@ See [Fast Refresh](https://reactnative.dev/docs/fast-refresh) for more informati Enables live reload to load the source bundle from the React Native packager. When the file is saved, the packager will trigger reloading. - -### UseWebDebugger +#### UseWebDebugger bool `UseWebDebugger` > **Deprecated**: Debugging should be done using DirectDebugging rather than WebDebugger. Web debugging changes the app behavior and will be removed in a future version. @@ -205,25 +205,294 @@ Controls whether the instance JavaScript runs in a remote environment such as wi 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` +The InstanceCreated (unresolved reference) event is triggered right after the React Native instance is created. + +It is triggered on the JSDispatcher thread before any other JSDispatcher work items. +No JavaScript code is loaded in the JavaScript engine yet. +The [`InstanceCreatedEventArgs.Context`](InstanceCreatedEventArgs#context) property on the event arguments provides access to the instance context. + +Note that the InstanceCreated (unresolved reference) event is triggered in response to the 'InstanceCreated' notification raised in the 'ReactNative.InstanceSettings' namespace. Consider using Notifications (unresolved reference) to handle the notification in a dispatcher different from the JSDispatcher. + +Type: [`EventHandler`](https://docs.microsoft.com/uwp/api/Windows.Foundation.EventHandler-1)<[`InstanceCreatedEventArgs`](InstanceCreatedEventArgs)> +#### `InstanceDestroyed` +The InstanceDestroyed (unresolved reference) event is triggered when React Native instance is destroyed. + +It is triggered on the JSDispatcher thread as the last work item before it shuts down. +No new JSDispatcher work can be executed after that. +The [`InstanceDestroyedEventArgs.Context`](InstanceDestroyedEventArgs#context) property on the event arguments provides access to the instance context. + +Note that the InstanceDestroyed (unresolved reference) event is triggered in response to the 'InstanceDestroyed' notification raised in the 'ReactNative.InstanceSettings' namespace. Consider using Notifications (unresolved reference) to handle the notification in a dispatcher different from the JSDispatcher. + +Type: [`EventHandler`](https://docs.microsoft.com/uwp/api/Windows.Foundation.EventHandler-1)<[`InstanceDestroyedEventArgs`](InstanceDestroyedEventArgs)> +#### `InstanceLoaded` +The InstanceLoaded (unresolved reference) event is triggered when React Native instance has finished loading the JavaScript bundle. + +It is triggered on the JSDispatcher thread. +If there were errors, then the [`InstanceLoadedEventArgs.Failed`](InstanceLoadedEventArgs#failed) property on the event arguments will be true. +The error types include: + +* JavaScript syntax errors. +* Global JavaScript exceptions thrown. + +The [`InstanceLoadedEventArgs.Context`](InstanceLoadedEventArgs#context) property on the event arguments provides access to the instance context. + +Note that the InstanceLoaded (unresolved reference) event is triggered in response to the 'InstanceLoaded' notification raised in the 'ReactNative.InstanceSettings' namespace. Consider using Notifications (unresolved reference) to handle the notification in a dispatcher different from the JSDispatcher. + +Type: [`EventHandler`](https://docs.microsoft.com/uwp/api/Windows.Foundation.EventHandler-1)<[`InstanceLoadedEventArgs`](InstanceLoadedEventArgs)> + +### Referenced by +- [`HttpSettings`](HttpSettings) +- [`QuirkSettings`](QuirkSettings) +- [`ReactNativeHost`](ReactNativeHost) + +## Old Architecture + +Kind: `class` + +Provides settings to create a React instance. + +### Properties +#### BundleAppId + string `BundleAppId` + +The name of the app passed to the packager server via the 'app' query parameter. This is useful when bundling multiple applications from the same packager instance. If no value is set, the parameter will not be passed. + +#### BundleRootPath + string `BundleRootPath` + +**Default value**: `ms-appx:///Bundle/` + +Base path used for the location of the bundle. +This can be an `ms-appx://` or `ms-appdata://` URI (if the app is UWP or packaged using MSIX), a filesystem path, or a URI pointing at an embedded resource. +Examples: + +- `ms-appx:///Bundle` - locates the bundle in the MSIX package. See [URI schemes](https://docs.microsoft.com/windows/uwp/app-resources/uri-schemes) for other UWP/MSIX valid URI formats. +- `C:\\foo\\bar` - locates the bundle in the local filesystem. Note [UWP app file access permissions](https://docs.microsoft.com/windows/uwp/files/file-access-permissions). +- `resource://moduleName` - locates the bundle as an embedded RCDATA resource in moduleName. Specify the resource ID in [`JavaScriptBundleFile`](#javascriptbundlefile). +- `resource://` - locates the bundle as an embedded RCDATA resource in the running process's module. Specify the resource ID in [`JavaScriptBundleFile`](#javascriptbundlefile). + +#### 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). +**Note that currently the byte code generation is not implemented for UWP applications.** + +#### 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) is used. + +#### DebuggerBreakOnNextLine + bool `DebuggerBreakOnNextLine` + +For direct debugging, controls 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. As a workaround you could add the `debugger` keyword in the beginning of the bundle.*** + +#### DebuggerPort + uint16_t `DebuggerPort` + +**Default value**: `9229` + +When [`UseDirectDebugger`](#usedirectdebugger) is enabled, this controls the port that the JavaScript engine debugger will run on. + +#### DebuggerRuntimeName + string `DebuggerRuntimeName` + +Name to associate with the JavaScript runtime when debugging. +This name will show up in the list of JavaScript runtimes to attach to in edge://inspect or other debuggers + +#### 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. +**Note that currently the byte code generation is not implemented for UWP applications.** + +#### EnableDefaultCrashHandler + bool `EnableDefaultCrashHandler` + +**Default value**: `false` + +Enables the default unhandled exception handler that logs additional information into a text file for [Windows Error Reporting](https://docs.microsoft.com/windows/win32/wer/windows-error-reporting). + +#### EnableDeveloperMenu + bool `EnableDeveloperMenu` + +> **Deprecated**: This property has been replaced by [`UseDeveloperSupport`](#usedevelopersupport). In version 0.63 both properties will do the same thing. It will be removed in a future version. + +This controls whether various developer experience features are available for this instance. In particular the developer menu, and the default `RedBox` experience. + +#### EnableJITCompilation + bool `EnableJITCompilation` + +**Default value**: `true` + +Flag controlling whether the JavaScript engine uses JIT compilation. + +#### JSIEngineOverride + [`JSIEngine`](JSIEngine) `JSIEngineOverride` + +**Default value**: `JSIEngine.Chakra` + +The [`JSIEngine`](JSIEngine) override to be used with the React instance. +In order for the override to work, Microsoft.ReactNative must be compiled with support of that engine. This override will be ignored when [`UseWebDebugger`](#usewebdebugger) is set to true, since the browser must use its own engine to debug correctly. + +#### 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). The `.bundle` extension will be appended to the end, when looking for the bundle file. +If using an embedded RCDATA resource, this identifies the resource ID that stores the bundle. See [`BundleRootPath`](#bundlerootpath). + +#### NativeLogger + [`LogHandler`](LogHandler) `NativeLogger` + +Function that will be hooked into the JavaScript instance as global.nativeLoggingHook. This allows native hooks for JavaScript's console implementation. If this is not set then logs will print output to the native debug output in debug builds, and no-op in release builds. + +#### Notifications +`readonly` [`IReactNotificationService`](IReactNotificationService) `Notifications` + +Gets a [`IReactNotificationService`](IReactNotificationService) to send notifications between components and the application. +Use [`IReactContext.Notifications`](IReactContext#notifications) to access this [`IReactNotificationService`](IReactNotificationService) from native components or view managers. + +#### PackageProviders +`readonly` [`IVector`](https://docs.microsoft.com/uwp/api/Windows.Foundation.Collections.IVector-1)<[`IReactPackageProvider`](IReactPackageProvider)> `PackageProviders` + +Gets a list of [`IReactPackageProvider`](IReactPackageProvider). +Add an implementation of [`IReactPackageProvider`](IReactPackageProvider) to this list to define additional native modules and custom view managers to be included in the React instance. +Auto-linking automatically adds [`IReactPackageProvider`](IReactPackageProvider) to the application's [`PackageProviders`](#packageproviders). + +#### Properties +`readonly` [`IReactPropertyBag`](IReactPropertyBag) `Properties` + +Gets a [`IReactPropertyBag`](IReactPropertyBag) to share values between components and the application. +Use [`IReactContext.Properties`](IReactContext#properties-1) to access this [`IReactPropertyBag`](IReactPropertyBag) from native components and view managers. + +#### RedBoxHandler + [`IRedBoxHandler`](IRedBoxHandler) `RedBoxHandler` + +Provides an extension point to allow custom error handling within the react instance. See [`IRedBoxHandler`](IRedBoxHandler) for more information. + +#### RequestDevBundle + bool `RequestDevBundle` + +When querying the bundle server for a bundle, should it request the dev bundle or release bundle. + +#### RequestInlineSourceMap + bool `RequestInlineSourceMap` + +**Default value**: `true` + +When using [`UseFastRefresh`](#usefastrefresh), [`UseLiveReload`](#uselivereload), or [`UseWebDebugger`](#usewebdebugger) this controls whether the bundler should include inline source maps.If set, the bundler will include the source maps inline (this will improve debugging experience, but for very large bundles it could have a significant performance hit) + +#### SourceBundleHost + string `SourceBundleHost` + +**Default value**: `localhost` + +When using [`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 [`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, it enables the developer menu, the default `RedBox` and `LogBox` experience. + +#### UseDirectDebugger + bool `UseDirectDebugger` + +Enables debugging in the JavaScript engine (if supported). +For Chakra this enables debugging of the JS runtime directly within the app using Visual Studio -> Attach to process (Script) + +#### UseFastRefresh + bool `UseFastRefresh` + +Controls whether the instance triggers 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. + +#### UseLiveReload + bool `UseLiveReload` + +> **Deprecated**: For general use this has been replaced by [`UseFastRefresh`](#usefastrefresh). + +Enables live reload to load the source bundle from the React Native packager. +When the file is saved, the packager will trigger reloading. + +#### UseWebDebugger + bool `UseWebDebugger` -## Constructors -### ReactInstanceSettings +> **Deprecated**: Debugging should be done using DirectDebugging rather than WebDebugger. Web debugging changes the app behavior and will be removed in a future version. + +Controls whether the instance JavaScript runs 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` +The InstanceCreated (unresolved reference) event is triggered right after the React Native instance is created. + +It is triggered on the JSDispatcher thread before any other JSDispatcher work items. +No JavaScript code is loaded in the JavaScript engine yet. +The [`InstanceCreatedEventArgs.Context`](InstanceCreatedEventArgs#context) property on the event arguments provides access to the instance context. + +Note that the InstanceCreated (unresolved reference) event is triggered in response to the 'InstanceCreated' notification raised in the 'ReactNative.InstanceSettings' namespace. Consider using Notifications (unresolved reference) to handle the notification in a dispatcher different from the JSDispatcher. + +Type: [`EventHandler`](https://docs.microsoft.com/uwp/api/Windows.Foundation.EventHandler-1)<[`InstanceCreatedEventArgs`](InstanceCreatedEventArgs)> +#### `InstanceDestroyed` +The InstanceDestroyed (unresolved reference) event is triggered when React Native instance is destroyed. + +It is triggered on the JSDispatcher thread as the last work item before it shuts down. +No new JSDispatcher work can be executed after that. +The [`InstanceDestroyedEventArgs.Context`](InstanceDestroyedEventArgs#context) property on the event arguments provides access to the instance context. + +Note that the InstanceDestroyed (unresolved reference) event is triggered in response to the 'InstanceDestroyed' notification raised in the 'ReactNative.InstanceSettings' namespace. Consider using Notifications (unresolved reference) to handle the notification in a dispatcher different from the JSDispatcher. + +Type: [`EventHandler`](https://docs.microsoft.com/uwp/api/Windows.Foundation.EventHandler-1)<[`InstanceDestroyedEventArgs`](InstanceDestroyedEventArgs)> +#### `InstanceLoaded` +The InstanceLoaded (unresolved reference) event is triggered when React Native instance has finished loading the JavaScript bundle. +It is triggered on the JSDispatcher thread. +If there were errors, then the [`InstanceLoadedEventArgs.Failed`](InstanceLoadedEventArgs#failed) property on the event arguments will be true. +The error types include: +* JavaScript syntax errors. +* Global JavaScript exceptions thrown. +The [`InstanceLoadedEventArgs.Context`](InstanceLoadedEventArgs#context) property on the event arguments provides access to the instance context. -## Events -### `InstanceCreated` -Type: [`InstanceCreatedEventArgs`](InstanceCreatedEventArgs) -### `InstanceDestroyed` -Type: [`InstanceDestroyedEventArgs`](InstanceDestroyedEventArgs) -### `InstanceLoaded` -Type: [`InstanceLoadedEventArgs`](InstanceLoadedEventArgs) +Note that the InstanceLoaded (unresolved reference) event is triggered in response to the 'InstanceLoaded' notification raised in the 'ReactNative.InstanceSettings' namespace. Consider using Notifications (unresolved reference) to handle the notification in a dispatcher different from the JSDispatcher. +Type: [`EventHandler`](https://docs.microsoft.com/uwp/api/Windows.Foundation.EventHandler-1)<[`InstanceLoadedEventArgs`](InstanceLoadedEventArgs)> -## Referenced by +### Referenced by - [`HttpSettings`](HttpSettings) - [`QuirkSettings`](QuirkSettings) - [`ReactApplication`](ReactApplication) diff --git a/docs/native-api/ReactModuleProvider-api-windows.md b/docs/native-api/ReactModuleProvider-api-windows.md index 8641cd52d..461ed6776 100644 --- a/docs/native-api/ReactModuleProvider-api-windows.md +++ b/docs/native-api/ReactModuleProvider-api-windows.md @@ -3,6 +3,8 @@ id: ReactModuleProvider title: ReactModuleProvider --- +![Architecture](https://img.shields.io/badge/architecture-new_&_old-green) + Kind: `delegate` Provides information about a custom native module. See [`IReactModuleBuilder`](IReactModuleBuilder). @@ -10,9 +12,5 @@ Provides information about a custom native module. See [`IReactModuleBuilder`](I ## Invoke Object **`Invoke`**([`IReactModuleBuilder`](IReactModuleBuilder) moduleBuilder) - - - - ## Referenced by - [`IReactPackageBuilder`](IReactPackageBuilder) diff --git a/docs/native-api/ReactNativeAppBuilder-api-windows.md b/docs/native-api/ReactNativeAppBuilder-api-windows.md new file mode 100644 index 000000000..14bfc44d0 --- /dev/null +++ b/docs/native-api/ReactNativeAppBuilder-api-windows.md @@ -0,0 +1,27 @@ +--- +id: ReactNativeAppBuilder +title: ReactNativeAppBuilder +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `class` + +> **EXPERIMENTAL** + +ReactNativeAppBuilder builds a ReactNativeWin32App with the base WinAppSDK infrastructure. + +## Constructors +### ReactNativeAppBuilder + **`ReactNativeAppBuilder`**() + +## Methods +### Build +[`ReactNativeWin32App`](ReactNativeWin32App) **`Build`**() + +> **EXPERIMENTAL** + +### SetAppWindow +[`ReactNativeAppBuilder`](ReactNativeAppBuilder) **`SetAppWindow`**([`AppWindow`](https://learn.microsoft.com/windows/windows-app-sdk/api/winrt/Microsoft.UI.Windowing.AppWindow) appWindow) + +> **EXPERIMENTAL** diff --git a/docs/native-api/ReactNativeHost-api-windows.md b/docs/native-api/ReactNativeHost-api-windows.md index 4032417a0..c5e640c70 100644 --- a/docs/native-api/ReactNativeHost-api-windows.md +++ b/docs/native-api/ReactNativeHost-api-windows.md @@ -3,49 +3,43 @@ id: ReactNativeHost title: ReactNativeHost --- -Kind: `class` +![Architecture](https://img.shields.io/badge/architecture-new_&_old-green) +## New Architecture +Kind: `class` This is the main entry-point to create a React instance. The `ReactNativeHost` object exists to configure the instance using [`ReactInstanceSettings`](ReactInstanceSettings) before it is loaded, as well as enabling control of when to load the instance. Use [`ReactInstanceSettings`](ReactInstanceSettings) events to observe instance creation, loading, and destruction. -## Properties -### InstanceSettings +### Properties +#### InstanceSettings [`ReactInstanceSettings`](ReactInstanceSettings) `InstanceSettings` Provides access to this host's [`ReactInstanceSettings`](ReactInstanceSettings) to configure the react instance. -### PackageProviders +#### PackageProviders `readonly` [`IVector`](https://docs.microsoft.com/uwp/api/Windows.Foundation.Collections.IVector-1)<[`IReactPackageProvider`](IReactPackageProvider)> `PackageProviders` Provides access to the list of [`IReactPackageProvider`](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 +### Constructors +#### ReactNativeHost **`ReactNativeHost`**() - - - -## Methods -### FromContext +### Methods +#### FromContext `static` [`ReactNativeHost`](ReactNativeHost) **`FromContext`**([`IReactContext`](IReactContext) reactContext) Returns the [`ReactNativeHost`](ReactNativeHost) instance associated with the given [`IReactContext`](IReactContext). - - -### LoadInstance +#### LoadInstance [`IAsyncAction`](https://docs.microsoft.com/uwp/api/Windows.Foundation.IAsyncAction) **`LoadInstance`**() Loads a new React instance. It is an alias for [`ReloadInstance`](#reloadinstance) method. - - -### ReloadInstance +#### ReloadInstance [`IAsyncAction`](https://docs.microsoft.com/uwp/api/Windows.Foundation.IAsyncAction) **`ReloadInstance`**() Unloads the current React instance and loads a new one. @@ -55,21 +49,71 @@ The React instance lifecycle can be observed with the following events:- The [`R - The [`ReactInstanceSettings.InstanceLoaded`](ReactInstanceSettings#instanceloaded) event is raised when the React instance completed loading the JavaScript bundle. - The [`ReactInstanceSettings.InstanceDestroyed`](ReactInstanceSettings#instancedestroyed) event is raised when the React instance is destroyed. - - -### UnloadInstance +#### UnloadInstance [`IAsyncAction`](https://docs.microsoft.com/uwp/api/Windows.Foundation.IAsyncAction) **`UnloadInstance`**() Unloads current React instance. After the React instance is unloaded, all the React resources including the JavaScript engine environment are cleaned up. The React instance destruction can be observed with the [`ReactInstanceSettings.InstanceDestroyed`](ReactInstanceSettings#instancedestroyed) event. +### Referenced by +- [`IReactViewHost`](IReactViewHost) +- [`ReactCoreInjection`](ReactCoreInjection) +- [`ReactNativeWin32App`](ReactNativeWin32App) +- [`RedBoxHelper`](RedBoxHelper) + +## Old Architecture +Kind: `class` +This is the main entry-point to create a React instance. +The `ReactNativeHost` object exists to configure the instance using [`ReactInstanceSettings`](ReactInstanceSettings) before it is loaded, as well as enabling control of when to load the instance. +Use [`ReactInstanceSettings`](ReactInstanceSettings) events to observe instance creation, loading, and destruction. +### Properties +#### InstanceSettings + [`ReactInstanceSettings`](ReactInstanceSettings) `InstanceSettings` + +Provides access to 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`](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) + +Returns the [`ReactNativeHost`](ReactNativeHost) instance associated with the given [`IReactContext`](IReactContext). + +#### LoadInstance +[`IAsyncAction`](https://docs.microsoft.com/uwp/api/Windows.Foundation.IAsyncAction) **`LoadInstance`**() + +Loads a new React instance. It is an alias for [`ReloadInstance`](#reloadinstance) method. + +#### ReloadInstance +[`IAsyncAction`](https://docs.microsoft.com/uwp/api/Windows.Foundation.IAsyncAction) **`ReloadInstance`**() + +Unloads the current React instance and loads a new one. +The React instance loading creates an instance of the JavaScript engine, and launches the provided JavaScript code bundle. +If a React instance is already running in this host, then [`ReloadInstance`](#reloadinstance) shuts down the already the running React instance, and loads a new React instance. +The React instance lifecycle can be observed with the following events:- The [`ReactInstanceSettings.InstanceCreated`](ReactInstanceSettings#instancecreated) event is raised when the React instance is just created. +- The [`ReactInstanceSettings.InstanceLoaded`](ReactInstanceSettings#instanceloaded) event is raised when the React instance completed loading the JavaScript bundle. +- The [`ReactInstanceSettings.InstanceDestroyed`](ReactInstanceSettings#instancedestroyed) event is raised when the React instance is destroyed. + +#### UnloadInstance +[`IAsyncAction`](https://docs.microsoft.com/uwp/api/Windows.Foundation.IAsyncAction) **`UnloadInstance`**() + +Unloads current React instance. +After the React instance is unloaded, all the React resources including the JavaScript engine environment are cleaned up. +The React instance destruction can be observed with the [`ReactInstanceSettings.InstanceDestroyed`](ReactInstanceSettings#instancedestroyed) event. -## Referenced by +### Referenced by - [`IReactViewHost`](IReactViewHost) - [`ReactApplication`](ReactApplication) - [`ReactCoreInjection`](ReactCoreInjection) diff --git a/docs/native-api/ReactNativeIsland-api-windows.md b/docs/native-api/ReactNativeIsland-api-windows.md new file mode 100644 index 000000000..f271ae0c7 --- /dev/null +++ b/docs/native-api/ReactNativeIsland-api-windows.md @@ -0,0 +1,118 @@ +--- +id: ReactNativeIsland +title: ReactNativeIsland +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `class` + +> **EXPERIMENTAL** + +A windows composition component that hosts React Native UI elements. + +## Properties +### FontSizeMultiplier +`readonly` float `FontSizeMultiplier` + +> **EXPERIMENTAL** + +### Island +`readonly` [`ContentIsland`](https://learn.microsoft.com/windows/windows-app-sdk/api/winrt/Microsoft.UI.Content.ContentIsland) `Island` + +> **EXPERIMENTAL** + +### ReactViewHost + [`IReactViewHost`](IReactViewHost) `ReactViewHost` + +> **EXPERIMENTAL** + +A ReactViewHost specifies the root UI component and initial properties to render in this RootViewIt must be set to show any React UI elements. + +### Resources + [`ICustomResourceLoader`](ICustomResourceLoader) `Resources` + +> **EXPERIMENTAL** + +Provides resources used for Platform colors within this RootView + +### RootTag +`readonly` int64_t `RootTag` + +> **EXPERIMENTAL** + +### RootVisual +`readonly` [`Visual`](https://learn.microsoft.com/windows/windows-app-sdk/api/winrt/Microsoft.UI.Composition.Visual) `RootVisual` + +> **EXPERIMENTAL** + +The RootVisual associated with the [`ReactNativeIsland`](ReactNativeIsland). It must be set to show any React UI elements. + +### ScaleFactor + float `ScaleFactor` + +> **EXPERIMENTAL** + +ScaleFactor for this windows (DPI/96) + +### Size +`readonly` [`Size`](https://docs.microsoft.com/uwp/api/Windows.Foundation.Size) `Size` + +> **EXPERIMENTAL** + +### Theme +`readonly` [`Theme`](Theme) `Theme` + +> **EXPERIMENTAL** + +## Constructors +### ReactNativeIsland + **`ReactNativeIsland`**([`Compositor`](https://learn.microsoft.com/windows/windows-app-sdk/api/winrt/Microsoft.UI.Composition.Compositor) compositor) + +> **EXPERIMENTAL** + +### ReactNativeIsland + **`ReactNativeIsland`**() + +## Methods +### Arrange +void **`Arrange`**([`LayoutConstraints`](LayoutConstraints) layoutConstraints, [`Point`](https://docs.microsoft.com/uwp/api/Windows.Foundation.Point) viewportOffset) + +> **EXPERIMENTAL** + +### CreatePortal +`static` [`ReactNativeIsland`](ReactNativeIsland) **`CreatePortal`**([`PortalComponentView`](PortalComponentView) portal) + +> **EXPERIMENTAL** + +Used to create react portals, such as a native modal component. + +### GetUiaProvider +Object **`GetUiaProvider`**() + +> **EXPERIMENTAL** + +### Measure +[`Size`](https://docs.microsoft.com/uwp/api/Windows.Foundation.Size) **`Measure`**([`LayoutConstraints`](LayoutConstraints) layoutConstraints, [`Point`](https://docs.microsoft.com/uwp/api/Windows.Foundation.Point) viewportOffset) + +> **EXPERIMENTAL** + +### NavigateFocus +[`FocusNavigationResult`](FocusNavigationResult) **`NavigateFocus`**([`FocusNavigationRequest`](FocusNavigationRequest) request) + +> **EXPERIMENTAL** + +Move focus to this [`ReactNativeIsland`](ReactNativeIsland) + +### SetProperties +void **`SetProperties`**([`JSValueArgWriter`](JSValueArgWriter) props) + +> **EXPERIMENTAL** + +Initial props should be set on ReactViewHost. This is used to update props after the initial props are set + +## Events +### `SizeChanged` +> **EXPERIMENTAL** + +Type: [`EventHandler`](https://docs.microsoft.com/uwp/api/Windows.Foundation.EventHandler-1)<[`RootViewSizeChangedEventArgs`](RootViewSizeChangedEventArgs)> diff --git a/docs/native-api/ReactNativeWin32App-api-windows.md b/docs/native-api/ReactNativeWin32App-api-windows.md new file mode 100644 index 000000000..7bc1b31fa --- /dev/null +++ b/docs/native-api/ReactNativeWin32App-api-windows.md @@ -0,0 +1,37 @@ +--- +id: ReactNativeWin32App +title: ReactNativeWin32App +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `class` + +> **EXPERIMENTAL** + +ReactNativeWin32App sets up the infrastructure for the default experience of a ReactNative application filling a WinAppSDK window. + +## Properties +### AppWindow +`readonly` [`AppWindow`](https://learn.microsoft.com/windows/windows-app-sdk/api/winrt/Microsoft.UI.Windowing.AppWindow) `AppWindow` + +> **EXPERIMENTAL** + +### ReactNativeHost +`readonly` [`ReactNativeHost`](ReactNativeHost) `ReactNativeHost` + +> **EXPERIMENTAL** + +### ReactViewOptions +`readonly` [`ReactViewOptions`](ReactViewOptions) `ReactViewOptions` + +> **EXPERIMENTAL** + +## Methods +### Start +void **`Start`**() + +> **EXPERIMENTAL** + +## Referenced by +- [`ReactNativeAppBuilder`](ReactNativeAppBuilder) diff --git a/docs/native-api/ReactNotificationHandler-api-windows.md b/docs/native-api/ReactNotificationHandler-api-windows.md index a839a7073..51dd7131c 100644 --- a/docs/native-api/ReactNotificationHandler-api-windows.md +++ b/docs/native-api/ReactNotificationHandler-api-windows.md @@ -3,6 +3,8 @@ id: ReactNotificationHandler title: ReactNotificationHandler --- +![Architecture](https://img.shields.io/badge/architecture-new_&_old-green) + Kind: `delegate` Delegate to handle notifications. @@ -12,9 +14,5 @@ Delegate to handle notifications. ## Invoke void **`Invoke`**(Object sender, [`IReactNotificationArgs`](IReactNotificationArgs) args) - - - - ## Referenced by - [`IReactNotificationService`](IReactNotificationService) diff --git a/docs/native-api/ReactNotificationServiceHelper-api-windows.md b/docs/native-api/ReactNotificationServiceHelper-api-windows.md index bf1245cf2..452342243 100644 --- a/docs/native-api/ReactNotificationServiceHelper-api-windows.md +++ b/docs/native-api/ReactNotificationServiceHelper-api-windows.md @@ -3,20 +3,14 @@ id: ReactNotificationServiceHelper title: ReactNotificationServiceHelper --- -Kind: `class` - +![Architecture](https://img.shields.io/badge/architecture-new_&_old-green) +Kind: `class` Helper methods for the [`IReactNotificationService`](IReactNotificationService) implementation. - - ## Methods ### CreateNotificationService `static` [`IReactNotificationService`](IReactNotificationService) **`CreateNotificationService`**() Creates a new instance of [`IReactNotificationService`](IReactNotificationService) - - - - diff --git a/docs/native-api/ReactPointerEventArgs-api-windows.md b/docs/native-api/ReactPointerEventArgs-api-windows.md index c0efaf5e9..b7b56ffb9 100644 --- a/docs/native-api/ReactPointerEventArgs-api-windows.md +++ b/docs/native-api/ReactPointerEventArgs-api-windows.md @@ -3,9 +3,9 @@ id: ReactPointerEventArgs title: ReactPointerEventArgs --- -Kind: `class` - +![Architecture](https://img.shields.io/badge/architecture-old_only-yellow) +Kind: `class` > **EXPERIMENTAL** @@ -20,7 +20,7 @@ Event arguments wrapper for [`IViewManagerWithPointerEvents`](IViewManagerWithPo Gets or sets a flag that allows the ReactRootView to handle pointer events even when it does not capture the pointer. This is particularly useful for view managers that seek to capture the pointer to handle move events for a gesture (e.g., dragging), but conditionally may allow the ReactRootView to emit events (e.g., if the [`PointerEventKind.End`](PointerEventKind) event is received before a drag threshold is hit. ### Args -`readonly` [`PointerRoutedEventArgs`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.Input.PointerRoutedEventArgs) `Args` +`readonly` [`PointerRoutedEventArgs`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.Input.PointerRoutedEventArgs) `Args` > **EXPERIMENTAL** @@ -40,10 +40,5 @@ Gets or sets the pointer event kind. The only valid override is [`PointerEventKi Gets or sets the React target for the pointer event. - - - - - ## Referenced by - [`IViewManagerWithPointerEvents`](IViewManagerWithPointerEvents) diff --git a/docs/native-api/ReactPropertyBagHelper-api-windows.md b/docs/native-api/ReactPropertyBagHelper-api-windows.md index 01ff14072..3a4a00b90 100644 --- a/docs/native-api/ReactPropertyBagHelper-api-windows.md +++ b/docs/native-api/ReactPropertyBagHelper-api-windows.md @@ -3,9 +3,9 @@ id: ReactPropertyBagHelper title: ReactPropertyBagHelper --- -Kind: `class` - +![Architecture](https://img.shields.io/badge/architecture-new_&_old-green) +Kind: `class` Helper methods for the property bag implementation. @@ -17,30 +17,20 @@ Helper methods for the property bag implementation. Deprecated. Do not use. It will be removed in a future version. - - ## Methods ### CreatePropertyBag `static` [`IReactPropertyBag`](IReactPropertyBag) **`CreatePropertyBag`**() Creates new instance of [`IReactPropertyBag`](IReactPropertyBag) - - ### GetName `static` [`IReactPropertyName`](IReactPropertyName) **`GetName`**([`IReactPropertyNamespace`](IReactPropertyNamespace) ns, string localName) Gets atomic [`IReactPropertyName`](IReactPropertyName) for the namespace `ns` and the `localName`. **Note that passing `null` as `ns` is reserved for local values since 0.65. In previous versions it was the same as passing [`GlobalNamespace`](#globalnamespace).** - - ### GetNamespace `static` [`IReactPropertyNamespace`](IReactPropertyNamespace) **`GetNamespace`**(string namespaceName) Gets an atomic [`IReactPropertyNamespace`](IReactPropertyNamespace) for a provided `namespaceName`. Consider using module name as the namespace for module-specific properties. - - - - diff --git a/docs/native-api/ReactRootView-api-windows.md b/docs/native-api/ReactRootView-api-windows.md index 49a2ff59d..ad14ac434 100644 --- a/docs/native-api/ReactRootView-api-windows.md +++ b/docs/native-api/ReactRootView-api-windows.md @@ -3,11 +3,11 @@ id: ReactRootView title: ReactRootView --- -Kind: `class` - -Extends: [`Grid`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.Controls.Grid) +![Architecture](https://img.shields.io/badge/architecture-old_only-yellow) +Kind: `class` +Extends: [`Grid`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.Controls.Grid) A XAML component that hosts React Native UI elements. @@ -34,24 +34,15 @@ XAML's default projection in 3D is orthographic (all lines are parallel) However The [`ReactNativeHost`](ReactNativeHost) associated with the [`ReactRootView`](ReactRootView). It must be set to show any React UI elements. - ## Constructors ### ReactRootView **`ReactRootView`**() - - - ## Methods ### ReloadView void **`ReloadView`**() Reloads the current [`ReactRootView`](ReactRootView) UI components. - - - - - ## Referenced by - [`XamlUIService`](XamlUIService) diff --git a/docs/native-api/ReactViewComponentProvider-api-windows.md b/docs/native-api/ReactViewComponentProvider-api-windows.md new file mode 100644 index 000000000..c8b2ac9f3 --- /dev/null +++ b/docs/native-api/ReactViewComponentProvider-api-windows.md @@ -0,0 +1,18 @@ +--- +id: ReactViewComponentProvider +title: ReactViewComponentProvider +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `delegate` + +> **EXPERIMENTAL** + +Provides information about a custom view component. See [`IReactPackageBuilderFabric.AddViewComponent`](IReactPackageBuilderFabric#addviewcomponent) + +## Invoke +void **`Invoke`**([`IReactViewComponentBuilder`](IReactViewComponentBuilder) viewComponentBuilder) + +## Referenced by +- [`IReactPackageBuilderFabric`](IReactPackageBuilderFabric) diff --git a/docs/native-api/ReactViewManagerProvider-api-windows.md b/docs/native-api/ReactViewManagerProvider-api-windows.md index 240ab674d..95c12756c 100644 --- a/docs/native-api/ReactViewManagerProvider-api-windows.md +++ b/docs/native-api/ReactViewManagerProvider-api-windows.md @@ -3,6 +3,8 @@ id: ReactViewManagerProvider title: ReactViewManagerProvider --- +![Architecture](https://img.shields.io/badge/architecture-old_only-yellow) + Kind: `delegate` Provides information about a custom view manager. See [`IViewManager`](IViewManager). @@ -10,9 +12,5 @@ Provides information about a custom view manager. See [`IViewManager`](IViewMana ## Invoke [`IViewManager`](IViewManager) **`Invoke`**() - - - - ## Referenced by - [`IReactPackageBuilder`](IReactPackageBuilder) diff --git a/docs/native-api/ReactViewOptions-api-windows.md b/docs/native-api/ReactViewOptions-api-windows.md index 6be77595b..943006bdf 100644 --- a/docs/native-api/ReactViewOptions-api-windows.md +++ b/docs/native-api/ReactViewOptions-api-windows.md @@ -3,41 +3,69 @@ id: ReactViewOptions title: ReactViewOptions --- -Kind: `class` +![Architecture](https://img.shields.io/badge/architecture-new_&_old-green) +## New Architecture +Kind: `class` > **EXPERIMENTAL** Settings per each IReactViewHost associated with an IReactHost instance. -## Properties -### ComponentName +### Properties +#### ComponentName string `ComponentName` > **EXPERIMENTAL** Name of a component registered in JavaScript via AppRegistry.registerComponent('ModuleName', () => ModuleName); -### InitialProps +#### InitialProps [`JSValueArgWriter`](JSValueArgWriter) `InitialProps` > **EXPERIMENTAL** Set of initial component properties. It is a JSON string. - -## Constructors -### ReactViewOptions +### Constructors +#### ReactViewOptions **`ReactViewOptions`**() +### Referenced by +- [`IReactViewHost`](IReactViewHost) +- [`IReactViewInstance`](IReactViewInstance) +- [`ReactCoreInjection`](ReactCoreInjection) +- [`ReactNativeWin32App`](ReactNativeWin32App) + +## Old Architecture + +Kind: `class` + +> **EXPERIMENTAL** + +Settings per each IReactViewHost associated with an IReactHost instance. +### Properties +#### ComponentName + string `ComponentName` +> **EXPERIMENTAL** +Name of a component registered in JavaScript via AppRegistry.registerComponent('ModuleName', () => ModuleName); +#### InitialProps + [`JSValueArgWriter`](JSValueArgWriter) `InitialProps` +> **EXPERIMENTAL** + +Set of initial component properties. It is a JSON string. + +### Constructors +#### ReactViewOptions + **`ReactViewOptions`**() -## Referenced by +### Referenced by - [`IReactViewHost`](IReactViewHost) - [`IReactViewInstance`](IReactViewInstance) - [`ReactCoreInjection`](ReactCoreInjection) diff --git a/docs/native-api/RedBoxErrorType-api-windows.md b/docs/native-api/RedBoxErrorType-api-windows.md index 6a18fd0a5..478b4d5a1 100644 --- a/docs/native-api/RedBoxErrorType-api-windows.md +++ b/docs/native-api/RedBoxErrorType-api-windows.md @@ -3,6 +3,8 @@ id: RedBoxErrorType title: RedBoxErrorType --- +![Architecture](https://img.shields.io/badge/architecture-new_&_old-green) + Kind: `enum` The error type shown in the RedBox. @@ -13,6 +15,5 @@ The error type shown in the RedBox. |`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/docs/native-api/RedBoxHelper-api-windows.md b/docs/native-api/RedBoxHelper-api-windows.md index afca7fef8..9ef22d8f3 100644 --- a/docs/native-api/RedBoxHelper-api-windows.md +++ b/docs/native-api/RedBoxHelper-api-windows.md @@ -3,20 +3,14 @@ id: RedBoxHelper title: RedBoxHelper --- -Kind: `class` - +![Architecture](https://img.shields.io/badge/architecture-new_&_old-green) +Kind: `class` A helper static class for [`IRedBoxHandler`](IRedBoxHandler). - - ## 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/docs/native-api/ResourceType-api-windows.md b/docs/native-api/ResourceType-api-windows.md new file mode 100644 index 000000000..e5b794638 --- /dev/null +++ b/docs/native-api/ResourceType-api-windows.md @@ -0,0 +1,17 @@ +--- +id: ResourceType +title: ResourceType +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `enum` + +> **EXPERIMENTAL** + +| Name | Value | Description | +|--|--|--| +|`Color` | 0x0 | Resource type for a [`Color`](https://docs.microsoft.com/uwp/api/Windows.UI.Color)| + +## Referenced by +- [`ICustomResourceLoader`](ICustomResourceLoader) diff --git a/docs/native-api/RootComponentView-api-windows.md b/docs/native-api/RootComponentView-api-windows.md new file mode 100644 index 000000000..c6a58cef1 --- /dev/null +++ b/docs/native-api/RootComponentView-api-windows.md @@ -0,0 +1,35 @@ +--- +id: RootComponentView +title: RootComponentView +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `class` + +Extends: [`ViewComponentView`](ViewComponentView) + +> **EXPERIMENTAL** + +## Properties +### Portal +`readonly` [`PortalComponentView`](PortalComponentView) `Portal` + +> **EXPERIMENTAL** + +Is non-null if this RootComponentView is the content of a portal + +### ReactNativeIsland +`readonly` [`ReactNativeIsland`](ReactNativeIsland) `ReactNativeIsland` + +> **EXPERIMENTAL** + +## Methods +### GetFocusedComponent +[`ComponentView`](ComponentView) **`GetFocusedComponent`**() + +> **EXPERIMENTAL** + +## Referenced by +- [`ComponentView`](ComponentView) +- [`PortalComponentView`](PortalComponentView) diff --git a/docs/native-api/RootViewSizeChangedEventArgs-api-windows.md b/docs/native-api/RootViewSizeChangedEventArgs-api-windows.md new file mode 100644 index 000000000..2d4d0ee1c --- /dev/null +++ b/docs/native-api/RootViewSizeChangedEventArgs-api-windows.md @@ -0,0 +1,19 @@ +--- +id: RootViewSizeChangedEventArgs +title: RootViewSizeChangedEventArgs +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `class` + +> **EXPERIMENTAL** + +## Properties +### Size +`readonly` [`Size`](https://docs.microsoft.com/uwp/api/Windows.Foundation.Size) `Size` + +> **EXPERIMENTAL** + +## Referenced by +- [`ReactNativeIsland`](ReactNativeIsland) diff --git a/docs/native-api/RoutedEventArgs-api-windows.md b/docs/native-api/RoutedEventArgs-api-windows.md new file mode 100644 index 000000000..c86d7f8cc --- /dev/null +++ b/docs/native-api/RoutedEventArgs-api-windows.md @@ -0,0 +1,22 @@ +--- +id: RoutedEventArgs +title: RoutedEventArgs +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `interface` + +Implemented by: +- [`GettingFocusEventArgs`](GettingFocusEventArgs) +- [`LosingFocusEventArgs`](LosingFocusEventArgs) +- [`PointerRoutedEventArgs`](PointerRoutedEventArgs) +- [`CharacterReceivedRoutedEventArgs`](CharacterReceivedRoutedEventArgs) +- [`KeyRoutedEventArgs`](KeyRoutedEventArgs) + +## Properties +### OriginalSource +`readonly` int `OriginalSource` + +## Referenced by +- [`ComponentView`](ComponentView) diff --git a/docs/native-api/ScrollViewComponentView-api-windows.md b/docs/native-api/ScrollViewComponentView-api-windows.md new file mode 100644 index 000000000..40cfa3249 --- /dev/null +++ b/docs/native-api/ScrollViewComponentView-api-windows.md @@ -0,0 +1,12 @@ +--- +id: ScrollViewComponentView +title: ScrollViewComponentView +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `class` + +Extends: [`ViewComponentView`](ViewComponentView) + +> **EXPERIMENTAL** diff --git a/docs/native-api/ShadowNode-api-windows.md b/docs/native-api/ShadowNode-api-windows.md new file mode 100644 index 000000000..b4502511b --- /dev/null +++ b/docs/native-api/ShadowNode-api-windows.md @@ -0,0 +1,38 @@ +--- +id: ShadowNode +title: ShadowNode +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `class` + +> **EXPERIMENTAL** + +## Properties +### EventEmitter +`readonly` [`EventEmitter`](EventEmitter) `EventEmitter` + +> **EXPERIMENTAL** + +### StateData + Object `StateData` + +> **EXPERIMENTAL** + +### Tag + Object `Tag` + +> **EXPERIMENTAL** + +## Methods +### EnsureUnsealed +void **`EnsureUnsealed`**() + +> **EXPERIMENTAL** + +## Referenced by +- [`LayoutHandler`](LayoutHandler) +- [`MeasureContentHandler`](MeasureContentHandler) +- [`ViewShadowNodeCloner`](ViewShadowNodeCloner) +- [`ViewShadowNodeFactory`](ViewShadowNodeFactory) diff --git a/docs/native-api/StateUpdateMutation-api-windows.md b/docs/native-api/StateUpdateMutation-api-windows.md new file mode 100644 index 000000000..cb891bdba --- /dev/null +++ b/docs/native-api/StateUpdateMutation-api-windows.md @@ -0,0 +1,16 @@ +--- +id: StateUpdateMutation +title: StateUpdateMutation +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `delegate` + +> **EXPERIMENTAL** + +## Invoke +Object **`Invoke`**(Object props) + +## Referenced by +- [`IComponentState`](IComponentState) diff --git a/docs/native-api/StreamImageResponse-api-windows.md b/docs/native-api/StreamImageResponse-api-windows.md new file mode 100644 index 000000000..ae15fc98e --- /dev/null +++ b/docs/native-api/StreamImageResponse-api-windows.md @@ -0,0 +1,20 @@ +--- +id: StreamImageResponse +title: StreamImageResponse +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `class` + +Extends: [`ImageResponse`](ImageResponse) + +> **EXPERIMENTAL** + +## Constructors +### StreamImageResponse + **`StreamImageResponse`**([`IRandomAccessStream`](https://docs.microsoft.com/uwp/api/Windows.Storage.Streams.IRandomAccessStream) stream) + +> **EXPERIMENTAL** + +Takes a stream of an image file that can be decoded by Windows Imaging Component - https://learn.microsoft.com/en-us/windows/win32/api/_wic/ diff --git a/docs/native-api/SwitchComponentView-api-windows.md b/docs/native-api/SwitchComponentView-api-windows.md new file mode 100644 index 000000000..aafbfb6fe --- /dev/null +++ b/docs/native-api/SwitchComponentView-api-windows.md @@ -0,0 +1,12 @@ +--- +id: SwitchComponentView +title: SwitchComponentView +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `class` + +Extends: [`ViewComponentView`](ViewComponentView) + +> **EXPERIMENTAL** diff --git a/docs/native-api/SyncMethodDelegate-api-windows.md b/docs/native-api/SyncMethodDelegate-api-windows.md index 6b70bab2c..2095ac296 100644 --- a/docs/native-api/SyncMethodDelegate-api-windows.md +++ b/docs/native-api/SyncMethodDelegate-api-windows.md @@ -3,6 +3,8 @@ id: SyncMethodDelegate title: SyncMethodDelegate --- +![Architecture](https://img.shields.io/badge/architecture-new_&_old-green) + Kind: `delegate` A delegate to call native synchronous method. @@ -10,9 +12,5 @@ A delegate to call native synchronous method. ## Invoke void **`Invoke`**([`IJSValueReader`](IJSValueReader) inputReader, [`IJSValueWriter`](IJSValueWriter) outputWriter) - - - - ## Referenced by - [`IReactModuleBuilder`](IReactModuleBuilder) diff --git a/docs/native-api/SystemCompositionContextHelper-api-windows.md b/docs/native-api/SystemCompositionContextHelper-api-windows.md new file mode 100644 index 000000000..3f345ce92 --- /dev/null +++ b/docs/native-api/SystemCompositionContextHelper-api-windows.md @@ -0,0 +1,52 @@ +--- +id: SystemCompositionContextHelper +title: SystemCompositionContextHelper +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `class` + +> **EXPERIMENTAL** + +A helper static class to create a [`ICompositionContext`](ICompositionContext) based on Windows.Composition Visuals. This is not for general consumption and is expected to be removed in a future release. + +## Methods +### CreateContext +`static` [`ICompositionContext`](ICompositionContext) **`CreateContext`**([`Compositor`](https://docs.microsoft.com/uwp/api/Windows.UI.Composition.Compositor) compositor) + +> **EXPERIMENTAL** + +Creates a [`ICompositionContext`](ICompositionContext) from a Compositor + +### CreateVisual +`static` [`IVisual`](IVisual) **`CreateVisual`**([`Visual`](https://docs.microsoft.com/uwp/api/Windows.UI.Composition.Visual) visual) + +> **EXPERIMENTAL** + +Creates a [`IVisual`](IVisual) from a Visual + +### InnerBrush +`static` [`CompositionBrush`](https://docs.microsoft.com/uwp/api/Windows.UI.Composition.CompositionBrush) **`InnerBrush`**([`IBrush`](IBrush) brush) + +> **EXPERIMENTAL** + +### InnerCompositor +`static` [`Compositor`](https://docs.microsoft.com/uwp/api/Windows.UI.Composition.Compositor) **`InnerCompositor`**([`ICompositionContext`](ICompositionContext) context) + +> **EXPERIMENTAL** + +### InnerDropShadow +`static` [`DropShadow`](https://docs.microsoft.com/uwp/api/Windows.UI.Composition.DropShadow) **`InnerDropShadow`**([`IDropShadow`](IDropShadow) shadow) + +> **EXPERIMENTAL** + +### InnerSurface +`static` [`ICompositionSurface`](https://docs.microsoft.com/uwp/api/Windows.UI.Composition.ICompositionSurface) **`InnerSurface`**([`IDrawingSurfaceBrush`](IDrawingSurfaceBrush) surface) + +> **EXPERIMENTAL** + +### InnerVisual +`static` [`Visual`](https://docs.microsoft.com/uwp/api/Windows.UI.Composition.Visual) **`InnerVisual`**([`IVisual`](IVisual) visual) + +> **EXPERIMENTAL** diff --git a/docs/native-api/Theme-api-windows.md b/docs/native-api/Theme-api-windows.md new file mode 100644 index 000000000..20f0a4d69 --- /dev/null +++ b/docs/native-api/Theme-api-windows.md @@ -0,0 +1,56 @@ +--- +id: Theme +title: Theme +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `class` + +> **EXPERIMENTAL** + +## Properties +### IsEmpty +`readonly` bool `IsEmpty` + +> **EXPERIMENTAL** + +An empty theme is used when the final theme is not yet known. It will generally return transparent colors. + +## Constructors +### Theme + **`Theme`**([`IReactContext`](IReactContext) reactContext, [`ICustomResourceLoader`](ICustomResourceLoader) resourceLoader) + +> **EXPERIMENTAL** + +## Methods +### GetDefaultTheme +`static` [`Theme`](Theme) **`GetDefaultTheme`**([`IReactContext`](IReactContext) context) + +> **EXPERIMENTAL** + +### PlatformBrush +[`CompositionBrush`](https://learn.microsoft.com/windows/windows-app-sdk/api/winrt/Microsoft.UI.Composition.CompositionBrush) **`PlatformBrush`**(string platformColor) + +> **EXPERIMENTAL** + +### SetDefaultResources +`static` void **`SetDefaultResources`**([`ReactInstanceSettings`](ReactInstanceSettings) settings, [`ICustomResourceLoader`](ICustomResourceLoader) theme) + +> **EXPERIMENTAL** + +### TryGetPlatformColor +bool **`TryGetPlatformColor`**(string platformColor, **out** [`Color`](https://docs.microsoft.com/uwp/api/Windows.UI.Color) color) + +> **EXPERIMENTAL** + +## Events +### `ThemeChanged` +> **EXPERIMENTAL** + +Type: [`EventHandler`](https://docs.microsoft.com/uwp/api/Windows.Foundation.EventHandler-1) + +## Referenced by +- [`Color`](Color) +- [`ComponentView`](ComponentView) +- [`ReactNativeIsland`](ReactNativeIsland) diff --git a/docs/native-api/Timer-api-windows.md b/docs/native-api/Timer-api-windows.md index bff1d2633..1e8f6320f 100644 --- a/docs/native-api/Timer-api-windows.md +++ b/docs/native-api/Timer-api-windows.md @@ -3,20 +3,14 @@ id: Timer title: Timer --- -Kind: `class` - +![Architecture](https://img.shields.io/badge/architecture-new_&_old-green) +Kind: `class` Used to create timers. - - ## Methods ### Create `static` [`ITimer`](ITimer) **`Create`**([`IReactPropertyBag`](IReactPropertyBag) properties) Creates a UI timer. Must be called on the UI thread. Using this rather than System/Windows.DispatcherQueue.CreateTimer works when applications have provided custom Timer implementations using [`ReactCoreInjection.SetTimerFactory`](ReactCoreInjection#settimerfactory) - - - - diff --git a/docs/native-api/TimerFactory-api-windows.md b/docs/native-api/TimerFactory-api-windows.md index f1c806ce1..2acfb27a9 100644 --- a/docs/native-api/TimerFactory-api-windows.md +++ b/docs/native-api/TimerFactory-api-windows.md @@ -3,6 +3,8 @@ id: TimerFactory title: TimerFactory --- +![Architecture](https://img.shields.io/badge/architecture-new_&_old-green) + Kind: `delegate` > **EXPERIMENTAL** @@ -10,9 +12,5 @@ Kind: `delegate` ## Invoke [`ITimer`](ITimer) **`Invoke`**() - - - - ## Referenced by - [`ReactCoreInjection`](ReactCoreInjection) diff --git a/docs/native-api/UIBatchCompleteCallback-api-windows.md b/docs/native-api/UIBatchCompleteCallback-api-windows.md index 5d7275c02..a2bc03117 100644 --- a/docs/native-api/UIBatchCompleteCallback-api-windows.md +++ b/docs/native-api/UIBatchCompleteCallback-api-windows.md @@ -3,6 +3,8 @@ id: UIBatchCompleteCallback title: UIBatchCompleteCallback --- +![Architecture](https://img.shields.io/badge/architecture-new_&_old-green) + Kind: `delegate` > **EXPERIMENTAL** @@ -12,9 +14,5 @@ The delegate is called when a UI batch is completed. ## Invoke void **`Invoke`**([`IReactPropertyBag`](IReactPropertyBag) properties) - - - - ## Referenced by - [`ReactCoreInjection`](ReactCoreInjection) diff --git a/docs/native-api/UnimplementedNativeViewComponentView-api-windows.md b/docs/native-api/UnimplementedNativeViewComponentView-api-windows.md new file mode 100644 index 000000000..9813c9a24 --- /dev/null +++ b/docs/native-api/UnimplementedNativeViewComponentView-api-windows.md @@ -0,0 +1,12 @@ +--- +id: UnimplementedNativeViewComponentView +title: UnimplementedNativeViewComponentView +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `class` + +Extends: [`ViewComponentView`](ViewComponentView) + +> **EXPERIMENTAL** diff --git a/docs/native-api/UnmountChildComponentViewArgs-api-windows.md b/docs/native-api/UnmountChildComponentViewArgs-api-windows.md new file mode 100644 index 000000000..6ae5e5bc6 --- /dev/null +++ b/docs/native-api/UnmountChildComponentViewArgs-api-windows.md @@ -0,0 +1,24 @@ +--- +id: UnmountChildComponentViewArgs +title: UnmountChildComponentViewArgs +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `class` + +> **EXPERIMENTAL** + +## Properties +### Child +`readonly` [`ComponentView`](ComponentView) `Child` + +> **EXPERIMENTAL** + +### Index +`readonly` uint32_t `Index` + +> **EXPERIMENTAL** + +## Referenced by +- [`UnmountChildComponentViewDelegate`](UnmountChildComponentViewDelegate) diff --git a/docs/native-api/UnmountChildComponentViewDelegate-api-windows.md b/docs/native-api/UnmountChildComponentViewDelegate-api-windows.md new file mode 100644 index 000000000..c8dfabd2f --- /dev/null +++ b/docs/native-api/UnmountChildComponentViewDelegate-api-windows.md @@ -0,0 +1,16 @@ +--- +id: UnmountChildComponentViewDelegate +title: UnmountChildComponentViewDelegate +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `delegate` + +> **EXPERIMENTAL** + +## Invoke +void **`Invoke`**([`ComponentView`](ComponentView) source, [`UnmountChildComponentViewArgs`](UnmountChildComponentViewArgs) args) + +## Referenced by +- [`IReactViewComponentBuilder`](IReactViewComponentBuilder) diff --git a/docs/native-api/UpdateEventEmitterDelegate-api-windows.md b/docs/native-api/UpdateEventEmitterDelegate-api-windows.md new file mode 100644 index 000000000..7aa0b88b1 --- /dev/null +++ b/docs/native-api/UpdateEventEmitterDelegate-api-windows.md @@ -0,0 +1,16 @@ +--- +id: UpdateEventEmitterDelegate +title: UpdateEventEmitterDelegate +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `delegate` + +> **EXPERIMENTAL** + +## Invoke +void **`Invoke`**([`ComponentView`](ComponentView) source, [`EventEmitter`](EventEmitter) eventEmitter) + +## Referenced by +- [`IReactViewComponentBuilder`](IReactViewComponentBuilder) diff --git a/docs/native-api/UpdateFinalizerDelegate-api-windows.md b/docs/native-api/UpdateFinalizerDelegate-api-windows.md new file mode 100644 index 000000000..ebd26a775 --- /dev/null +++ b/docs/native-api/UpdateFinalizerDelegate-api-windows.md @@ -0,0 +1,16 @@ +--- +id: UpdateFinalizerDelegate +title: UpdateFinalizerDelegate +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `delegate` + +> **EXPERIMENTAL** + +## Invoke +void **`Invoke`**([`ComponentView`](ComponentView) source, [`ComponentViewUpdateMask`](ComponentViewUpdateMask) updateMask) + +## Referenced by +- [`IReactViewComponentBuilder`](IReactViewComponentBuilder) diff --git a/docs/native-api/UpdateLayoutMetricsDelegate-api-windows.md b/docs/native-api/UpdateLayoutMetricsDelegate-api-windows.md new file mode 100644 index 000000000..1190bcbe6 --- /dev/null +++ b/docs/native-api/UpdateLayoutMetricsDelegate-api-windows.md @@ -0,0 +1,16 @@ +--- +id: UpdateLayoutMetricsDelegate +title: UpdateLayoutMetricsDelegate +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `delegate` + +> **EXPERIMENTAL** + +## Invoke +void **`Invoke`**([`ComponentView`](ComponentView) source, [`LayoutMetrics`](LayoutMetrics) newLayoutMetrics, [`LayoutMetrics`](LayoutMetrics) oldLayoutMetrics) + +## Referenced by +- [`IReactCompositionViewComponentBuilder`](IReactCompositionViewComponentBuilder) diff --git a/docs/native-api/UpdatePropsDelegate-api-windows.md b/docs/native-api/UpdatePropsDelegate-api-windows.md new file mode 100644 index 000000000..71616b39a --- /dev/null +++ b/docs/native-api/UpdatePropsDelegate-api-windows.md @@ -0,0 +1,16 @@ +--- +id: UpdatePropsDelegate +title: UpdatePropsDelegate +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `delegate` + +> **EXPERIMENTAL** + +## Invoke +void **`Invoke`**([`ComponentView`](ComponentView) source, [`IComponentProps`](IComponentProps) newProps, [`IComponentProps`](IComponentProps) oldProps) + +## Referenced by +- [`IReactViewComponentBuilder`](IReactViewComponentBuilder) diff --git a/docs/native-api/UpdateStateDelegate-api-windows.md b/docs/native-api/UpdateStateDelegate-api-windows.md new file mode 100644 index 000000000..34e483634 --- /dev/null +++ b/docs/native-api/UpdateStateDelegate-api-windows.md @@ -0,0 +1,16 @@ +--- +id: UpdateStateDelegate +title: UpdateStateDelegate +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `delegate` + +> **EXPERIMENTAL** + +## Invoke +void **`Invoke`**([`ComponentView`](ComponentView) source, [`IComponentState`](IComponentState) newState) + +## Referenced by +- [`IReactViewComponentBuilder`](IReactViewComponentBuilder) diff --git a/docs/native-api/UriBrushFactory-api-windows.md b/docs/native-api/UriBrushFactory-api-windows.md new file mode 100644 index 000000000..5d28f804a --- /dev/null +++ b/docs/native-api/UriBrushFactory-api-windows.md @@ -0,0 +1,16 @@ +--- +id: UriBrushFactory +title: UriBrushFactory +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `delegate` + +> **EXPERIMENTAL** + +## Invoke +[`IBrush`](IBrush) **`Invoke`**([`IReactContext`](IReactContext) reactContext, [`ICompositionContext`](ICompositionContext) compositionContext) + +## Referenced by +- [`UriBrushFactoryImageResponse`](UriBrushFactoryImageResponse) diff --git a/docs/native-api/UriBrushFactoryImageResponse-api-windows.md b/docs/native-api/UriBrushFactoryImageResponse-api-windows.md new file mode 100644 index 000000000..70bb80d90 --- /dev/null +++ b/docs/native-api/UriBrushFactoryImageResponse-api-windows.md @@ -0,0 +1,20 @@ +--- +id: UriBrushFactoryImageResponse +title: UriBrushFactoryImageResponse +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `class` + +Extends: [`ImageResponse`](ImageResponse) + +> **EXPERIMENTAL** + +This allows applications to provide their own image rendering pipeline. Or to generate graphics on the fly based on uri. + +## Constructors +### UriBrushFactoryImageResponse + **`UriBrushFactoryImageResponse`**([`UriBrushFactory`](UriBrushFactory) factory) + +> **EXPERIMENTAL** diff --git a/docs/native-api/ViewComponentView-api-windows.md b/docs/native-api/ViewComponentView-api-windows.md new file mode 100644 index 000000000..83046da90 --- /dev/null +++ b/docs/native-api/ViewComponentView-api-windows.md @@ -0,0 +1,21 @@ +--- +id: ViewComponentView +title: ViewComponentView +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `class` + +Extends: [`ComponentView`](ComponentView) + +> **EXPERIMENTAL** + +## Properties +### ViewProps +`readonly` [`ViewProps`](ViewProps) `ViewProps` + +> **EXPERIMENTAL** + +## Referenced by +- [`ViewComponentViewInitializer`](ViewComponentViewInitializer) diff --git a/docs/native-api/ViewComponentViewInitializer-api-windows.md b/docs/native-api/ViewComponentViewInitializer-api-windows.md new file mode 100644 index 000000000..d288333b7 --- /dev/null +++ b/docs/native-api/ViewComponentViewInitializer-api-windows.md @@ -0,0 +1,16 @@ +--- +id: ViewComponentViewInitializer +title: ViewComponentViewInitializer +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `delegate` + +> **EXPERIMENTAL** + +## Invoke +void **`Invoke`**([`ViewComponentView`](ViewComponentView) view) + +## Referenced by +- [`IReactCompositionViewComponentBuilder`](IReactCompositionViewComponentBuilder) diff --git a/docs/native-api/ViewControl-api-windows.md b/docs/native-api/ViewControl-api-windows.md index 502a12a17..94115f47a 100644 --- a/docs/native-api/ViewControl-api-windows.md +++ b/docs/native-api/ViewControl-api-windows.md @@ -3,24 +3,16 @@ id: ViewControl title: ViewControl --- -Kind: `class` - -Extends: [`ContentControl`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.Controls.ContentControl) - +![Architecture](https://img.shields.io/badge/architecture-old_only-yellow) +Kind: `class` +Extends: [`ContentControl`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.Controls.ContentControl) ## Constructors ### ViewControl **`ViewControl`**() - - - ## Methods ### GetPanel -[`Panel`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.Controls.Panel) **`GetPanel`**() - - - - +[`Panel`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.Controls.Panel) **`GetPanel`**() diff --git a/docs/native-api/ViewManagerPropertyType-api-windows.md b/docs/native-api/ViewManagerPropertyType-api-windows.md index 3c5698933..8d67ab8a8 100644 --- a/docs/native-api/ViewManagerPropertyType-api-windows.md +++ b/docs/native-api/ViewManagerPropertyType-api-windows.md @@ -3,6 +3,8 @@ id: ViewManagerPropertyType title: ViewManagerPropertyType --- +![Architecture](https://img.shields.io/badge/architecture-old_only-yellow) + Kind: `enum` | Name | Value | Description | diff --git a/docs/native-api/ViewPanel-api-windows.md b/docs/native-api/ViewPanel-api-windows.md index f988a3da4..2db0a48da 100644 --- a/docs/native-api/ViewPanel-api-windows.md +++ b/docs/native-api/ViewPanel-api-windows.md @@ -3,76 +3,56 @@ id: ViewPanel title: ViewPanel --- -Kind: `class` - -Extends: [`Grid`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.Controls.Grid) +![Architecture](https://img.shields.io/badge/architecture-old_only-yellow) +Kind: `class` +Extends: [`Grid`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.Controls.Grid) ## Properties ### BorderBrushProperty -`static` `readonly` [`DependencyProperty`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.DependencyProperty) `BorderBrushProperty` +`static` `readonly` [`DependencyProperty`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.DependencyProperty) `BorderBrushProperty` ### BorderThicknessProperty -`static` `readonly` [`DependencyProperty`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.DependencyProperty) `BorderThicknessProperty` +`static` `readonly` [`DependencyProperty`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.DependencyProperty) `BorderThicknessProperty` ### CornerRadiusProperty -`static` `readonly` [`DependencyProperty`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.DependencyProperty) `CornerRadiusProperty` +`static` `readonly` [`DependencyProperty`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.DependencyProperty) `CornerRadiusProperty` ### LeftProperty -`static` `readonly` [`DependencyProperty`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.DependencyProperty) `LeftProperty` +`static` `readonly` [`DependencyProperty`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.DependencyProperty) `LeftProperty` ### TopProperty -`static` `readonly` [`DependencyProperty`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.DependencyProperty) `TopProperty` +`static` `readonly` [`DependencyProperty`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.DependencyProperty) `TopProperty` ### ViewBackground - [`Brush`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.Media.Brush) `ViewBackground` + [`Brush`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.Media.Brush) `ViewBackground` ### ViewBackgroundProperty -`static` `readonly` [`DependencyProperty`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.DependencyProperty) `ViewBackgroundProperty` - +`static` `readonly` [`DependencyProperty`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.DependencyProperty) `ViewBackgroundProperty` ## Constructors ### ViewPanel **`ViewPanel`**() - - - ## Methods ### Clear void **`Clear`**() - - ### GetLeft -`static` double **`GetLeft`**([`UIElement`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.UIElement) element) - - +`static` double **`GetLeft`**([`UIElement`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.UIElement) element) ### GetTop -`static` double **`GetTop`**([`UIElement`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.UIElement) element) - - +`static` double **`GetTop`**([`UIElement`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.UIElement) element) ### InsertAt -void **`InsertAt`**(uint32_t index, [`UIElement`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.UIElement) value) - - +void **`InsertAt`**(uint32_t index, [`UIElement`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.UIElement) value) ### RemoveAt void **`RemoveAt`**(uint32_t index) - - ### SetLeft -`static` void **`SetLeft`**([`UIElement`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.UIElement) element, double value) - - +`static` void **`SetLeft`**([`UIElement`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.UIElement) element, double value) ### SetTop -`static` void **`SetTop`**([`UIElement`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.UIElement) element, double value) - - - - +`static` void **`SetTop`**([`UIElement`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.UIElement) element, double value) diff --git a/docs/native-api/ViewProps-api-windows.md b/docs/native-api/ViewProps-api-windows.md new file mode 100644 index 000000000..e4ab883cc --- /dev/null +++ b/docs/native-api/ViewProps-api-windows.md @@ -0,0 +1,36 @@ +--- +id: ViewProps +title: ViewProps +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `class` + +> **EXPERIMENTAL** + +Provides access to the properties on standard ViewProps. + +## Properties +### AccessibilityLabel +`readonly` string `AccessibilityLabel` + +> **EXPERIMENTAL** + +### BackgroundColor +`readonly` [`Color`](Color) `BackgroundColor` + +> **EXPERIMENTAL** + +### Opacity +`readonly` float `Opacity` + +> **EXPERIMENTAL** + +### TestId +`readonly` string `TestId` + +> **EXPERIMENTAL** + +## Referenced by +- [`ViewPropsFactory`](ViewPropsFactory) diff --git a/docs/native-api/ViewPropsFactory-api-windows.md b/docs/native-api/ViewPropsFactory-api-windows.md new file mode 100644 index 000000000..7536b488d --- /dev/null +++ b/docs/native-api/ViewPropsFactory-api-windows.md @@ -0,0 +1,18 @@ +--- +id: ViewPropsFactory +title: ViewPropsFactory +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `delegate` + +> **EXPERIMENTAL** + +A delegate that creates a [`IComponentProps`](IComponentProps) object for an instance of [`ViewProps`](ViewProps). See [`IReactViewComponentBuilder.SetCreateProps`](IReactViewComponentBuilder#setcreateprops) + +## Invoke +[`IComponentProps`](IComponentProps) **`Invoke`**([`ViewProps`](ViewProps) props, [`IComponentProps`](IComponentProps) cloneFrom) + +## Referenced by +- [`IReactViewComponentBuilder`](IReactViewComponentBuilder) diff --git a/docs/native-api/ViewShadowNodeCloner-api-windows.md b/docs/native-api/ViewShadowNodeCloner-api-windows.md new file mode 100644 index 000000000..432843061 --- /dev/null +++ b/docs/native-api/ViewShadowNodeCloner-api-windows.md @@ -0,0 +1,16 @@ +--- +id: ViewShadowNodeCloner +title: ViewShadowNodeCloner +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `delegate` + +> **EXPERIMENTAL** + +## Invoke +void **`Invoke`**([`ShadowNode`](ShadowNode) shadowNode, [`ShadowNode`](ShadowNode) sourceShadowNode) + +## Referenced by +- [`IReactViewComponentBuilder`](IReactViewComponentBuilder) diff --git a/docs/native-api/ViewShadowNodeFactory-api-windows.md b/docs/native-api/ViewShadowNodeFactory-api-windows.md new file mode 100644 index 000000000..aef46b880 --- /dev/null +++ b/docs/native-api/ViewShadowNodeFactory-api-windows.md @@ -0,0 +1,16 @@ +--- +id: ViewShadowNodeFactory +title: ViewShadowNodeFactory +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `delegate` + +> **EXPERIMENTAL** + +## Invoke +void **`Invoke`**([`ShadowNode`](ShadowNode) shadowNode) + +## Referenced by +- [`IReactViewComponentBuilder`](IReactViewComponentBuilder) diff --git a/docs/native-api/VisualToMountChildrenIntoDelegate-api-windows.md b/docs/native-api/VisualToMountChildrenIntoDelegate-api-windows.md new file mode 100644 index 000000000..721091e7c --- /dev/null +++ b/docs/native-api/VisualToMountChildrenIntoDelegate-api-windows.md @@ -0,0 +1,16 @@ +--- +id: VisualToMountChildrenIntoDelegate +title: VisualToMountChildrenIntoDelegate +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `delegate` + +> **EXPERIMENTAL** + +## Invoke +[`Visual`](https://learn.microsoft.com/windows/windows-app-sdk/api/winrt/Microsoft.UI.Composition.Visual) **`Invoke`**([`ComponentView`](ComponentView) view) + +## Referenced by +- [`IReactCompositionViewComponentBuilder`](IReactCompositionViewComponentBuilder) diff --git a/docs/native-api/WindowsModalHostComponentView-api-windows.md b/docs/native-api/WindowsModalHostComponentView-api-windows.md new file mode 100644 index 000000000..113fc87d2 --- /dev/null +++ b/docs/native-api/WindowsModalHostComponentView-api-windows.md @@ -0,0 +1,12 @@ +--- +id: WindowsModalHostComponentView +title: WindowsModalHostComponentView +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `class` + +Extends: [`ViewComponentView`](ViewComponentView) + +> **EXPERIMENTAL** diff --git a/docs/native-api/WindowsTextInputComponentView-api-windows.md b/docs/native-api/WindowsTextInputComponentView-api-windows.md new file mode 100644 index 000000000..7a5b2befd --- /dev/null +++ b/docs/native-api/WindowsTextInputComponentView-api-windows.md @@ -0,0 +1,12 @@ +--- +id: WindowsTextInputComponentView +title: WindowsTextInputComponentView +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `class` + +Extends: [`ViewComponentView`](ViewComponentView) + +> **EXPERIMENTAL** diff --git a/docs/native-api/XamlHelper-api-windows.md b/docs/native-api/XamlHelper-api-windows.md index 27d1a610f..7d5614eb1 100644 --- a/docs/native-api/XamlHelper-api-windows.md +++ b/docs/native-api/XamlHelper-api-windows.md @@ -3,47 +3,35 @@ id: XamlHelper title: XamlHelper --- -Kind: `class` - +![Architecture](https://img.shields.io/badge/architecture-old_only-yellow) +Kind: `class` XAML helper methods to implement custom view managers. ## Properties ### ReactTagProperty -`static` `readonly` [`DependencyProperty`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.DependencyProperty) `ReactTagProperty` +`static` `readonly` [`DependencyProperty`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.DependencyProperty) `ReactTagProperty` Returns the attached property where the react tag is stored on a XAML Dependency Object. - - ## Methods ### BrushFrom -`static` [`Brush`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.Media.Brush) **`BrushFrom`**([`JSValueArgWriter`](JSValueArgWriter) valueProvider) +`static` [`Brush`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.Media.Brush) **`BrushFrom`**([`JSValueArgWriter`](JSValueArgWriter) valueProvider) Returns a Brush from [`JSValueArgWriter`](JSValueArgWriter). - - ### ColorFrom `static` [`Color`](https://docs.microsoft.com/uwp/api/Windows.UI.Color) **`ColorFrom`**([`JSValueArgWriter`](JSValueArgWriter) valueProvider) Returns a Color from [`JSValueArgWriter`](JSValueArgWriter). - - ### GetReactTag -`static` int64_t **`GetReactTag`**([`DependencyObject`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.DependencyObject) dependencyObject) +`static` int64_t **`GetReactTag`**([`DependencyObject`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.DependencyObject) dependencyObject) Gets the react tag from a backing XAML element. - - ### SetReactTag -`static` void **`SetReactTag`**([`DependencyObject`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.DependencyObject) dependencyObject, int64_t tag) +`static` void **`SetReactTag`**([`DependencyObject`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.DependencyObject) dependencyObject, int64_t tag) Sets the react tag for a XAML element. - - - - diff --git a/docs/native-api/XamlMetaDataProvider-api-windows.md b/docs/native-api/XamlMetaDataProvider-api-windows.md index 92eaa4da4..8f48b3b57 100644 --- a/docs/native-api/XamlMetaDataProvider-api-windows.md +++ b/docs/native-api/XamlMetaDataProvider-api-windows.md @@ -3,32 +3,22 @@ id: XamlMetaDataProvider title: XamlMetaDataProvider --- -Kind: `class` +![Architecture](https://img.shields.io/badge/architecture-old_only-yellow) -Implements: [`IXamlMetadataProvider`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.Markup.IXamlMetadataProvider) +Kind: `class` +Implements: [`IXamlMetadataProvider`](https://learn.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) - - +[`IXamlType`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.Markup.IXamlType) **`GetXamlType`**([`TypeName`](https://learn.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) - - +[`IXamlType`](https://learn.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`**() - - - - +[`XmlnsDefinition`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.Markup.XmlnsDefinition) **`GetXmlnsDefinitions`**() diff --git a/docs/native-api/XamlUIService-api-windows.md b/docs/native-api/XamlUIService-api-windows.md index 2b97c4f4a..cd6480af0 100644 --- a/docs/native-api/XamlUIService-api-windows.md +++ b/docs/native-api/XamlUIService-api-windows.md @@ -3,86 +3,109 @@ id: XamlUIService title: XamlUIService --- -Kind: `class` +![Architecture](https://img.shields.io/badge/architecture-new_&_old-green) +## New Architecture +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 +#### FromContext +`static` [`XamlUIService`](XamlUIService) **`FromContext`**([`IReactContext`](IReactContext) context) +Use this method to get access to the [`XamlUIService`](XamlUIService) associated with the [`IReactContext`](IReactContext). -## Methods -### DispatchEvent -void **`DispatchEvent`**([`FrameworkElement`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.FrameworkElement) view, string eventName, [`JSValueArgWriter`](JSValueArgWriter) eventDataArgWriter) - -Dispatches an event to a JS component. +#### GetAccessibleRoot +`static` [`FrameworkElement`](https://learn.microsoft.com/windows/windows-app-sdk/api/winrt/Microsoft.UI.Xaml.FrameworkElement) **`GetAccessibleRoot`**([`IReactPropertyBag`](IReactPropertyBag) properties) +Retrieves the default [`FrameworkElement`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.FrameworkElement) that will be used for the app for accessibility purposes (e.g. to announce). +#### GetIslandWindowHandle +`static` uint64_t **`GetIslandWindowHandle`**([`IReactPropertyBag`](IReactPropertyBag) properties) -### ElementFromReactTag -[`DependencyObject`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.DependencyObject) **`ElementFromReactTag`**(int64_t reactTag) +Gets the window handle HWND (as an UInt64) used as the XAML Island window for the current React instance. -Gets the backing XAML element from a react tag. +#### GetXamlRoot +`static` [`XamlRoot`](https://learn.microsoft.com/windows/windows-app-sdk/api/winrt/Microsoft.UI.Xaml.XamlRoot) **`GetXamlRoot`**([`IReactPropertyBag`](IReactPropertyBag) properties) +Retrieves the default [`XamlRoot`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.XamlRoot) for the app. +#### SetAccessibleRoot +`static` void **`SetAccessibleRoot`**([`IReactPropertyBag`](IReactPropertyBag) properties, [`FrameworkElement`](https://learn.microsoft.com/windows/windows-app-sdk/api/winrt/Microsoft.UI.Xaml.FrameworkElement) accessibleRoot) -### FromContext -`static` [`XamlUIService`](XamlUIService) **`FromContext`**([`IReactContext`](IReactContext) context) +Sets the [`FrameworkElement`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.FrameworkElement) that will act as the default accessible element for the app. The element must be able to create an automation peer (see [`FrameworkElementAutomationPeer`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.Automation.Peers.FrameworkElementAutomationPeer)), or have the Landmark type property set (see [`AutomationProperties.LandmarkTypeProperty`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.Automation.AutomationProperties.LandmarkTypeProperty)). +This must be manually provided to the [`ReactInstanceSettings`](ReactInstanceSettings) when using XAML Islands to have access to functionality related to accessibility. -Use this method to get access to the [`XamlUIService`](XamlUIService) associated with the [`IReactContext`](IReactContext). +#### SetIslandWindowHandle +`static` void **`SetIslandWindowHandle`**([`IReactPropertyBag`](IReactPropertyBag) properties, uint64_t windowHandle) +Sets the windowHandle HWND (as an UInt64) to be the XAML Island window for the current React instance. +Pass the value returned by IDesktopWindowXamlSourceNative get_WindowHandle. +#### SetXamlRoot +`static` void **`SetXamlRoot`**([`IReactPropertyBag`](IReactPropertyBag) properties, [`XamlRoot`](https://learn.microsoft.com/windows/windows-app-sdk/api/winrt/Microsoft.UI.Xaml.XamlRoot) xamlRoot) -### GetAccessibleRoot -`static` [`FrameworkElement`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.FrameworkElement) **`GetAccessibleRoot`**([`IReactPropertyBag`](IReactPropertyBag) properties) +Sets the [`XamlRoot`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.XamlRoot) element for the app. This must be manually provided to the [`ReactInstanceSettings`](ReactInstanceSettings) object when using XAML Islands so that certain APIs work correctly. +For more information, see [Host WinRT XAML Controls in desktop apps (XAML Islands)](https://docs.microsoft.com/windows/apps/desktop/modernize/xaml-islands). -Retrieves the default [`FrameworkElement`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.FrameworkElement) that will be used for the app for accessibility purposes (e.g. to announce). +## Old Architecture +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. -### GetIslandWindowHandle -`static` uint64_t **`GetIslandWindowHandle`**([`IReactPropertyBag`](IReactPropertyBag) properties) +### Methods +#### DispatchEvent +void **`DispatchEvent`**([`FrameworkElement`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.FrameworkElement) view, string eventName, [`JSValueArgWriter`](JSValueArgWriter) eventDataArgWriter) -Gets the window handle HWND (as an UInt64) used as the XAML Island window for the current React instance. +Dispatches an event to a JS component. +#### ElementFromReactTag +[`DependencyObject`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.DependencyObject) **`ElementFromReactTag`**(int64_t reactTag) +Gets the backing XAML element from a react tag. -### GetReactRootView -[`ReactRootView`](ReactRootView) **`GetReactRootView`**([`FrameworkElement`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.FrameworkElement) view) +#### FromContext +`static` [`XamlUIService`](XamlUIService) **`FromContext`**([`IReactContext`](IReactContext) context) -Gets the [`ReactRootView`](ReactRootView) view for a given element. +Use this method to get access to the [`XamlUIService`](XamlUIService) associated with the [`IReactContext`](IReactContext). +#### GetAccessibleRoot +`static` [`FrameworkElement`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.FrameworkElement) **`GetAccessibleRoot`**([`IReactPropertyBag`](IReactPropertyBag) properties) +Retrieves the default [`FrameworkElement`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.FrameworkElement) that will be used for the app for accessibility purposes (e.g. to announce). -### GetXamlRoot -`static` [`XamlRoot`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.XamlRoot) **`GetXamlRoot`**([`IReactPropertyBag`](IReactPropertyBag) properties) +#### GetIslandWindowHandle +`static` uint64_t **`GetIslandWindowHandle`**([`IReactPropertyBag`](IReactPropertyBag) properties) -Retrieves the default [`XamlRoot`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.XamlRoot) for the app. +Gets the window handle HWND (as an UInt64) used as the XAML Island window for the current React instance. +#### GetReactRootView +[`ReactRootView`](ReactRootView) **`GetReactRootView`**([`FrameworkElement`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.FrameworkElement) view) +Gets the [`ReactRootView`](ReactRootView) view for a given element. -### SetAccessibleRoot -`static` void **`SetAccessibleRoot`**([`IReactPropertyBag`](IReactPropertyBag) properties, [`FrameworkElement`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.FrameworkElement) accessibleRoot) +#### GetXamlRoot +`static` [`XamlRoot`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.XamlRoot) **`GetXamlRoot`**([`IReactPropertyBag`](IReactPropertyBag) properties) -Sets the [`FrameworkElement`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.FrameworkElement) that will act as the default accessible element for the app. The element must be able to create an automation peer (see [`FrameworkElementAutomationPeer`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.Automation.Peers.FrameworkElementAutomationPeer)), or have the Landmark type property set (see [`AutomationProperties.LandmarkTypeProperty`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.Automation.AutomationProperties.LandmarkTypeProperty)). -This must be manually provided to the [`ReactInstanceSettings`](ReactInstanceSettings) when using XAML Islands to have access to functionality related to accessibility. +Retrieves the default [`XamlRoot`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.XamlRoot) for the app. +#### SetAccessibleRoot +`static` void **`SetAccessibleRoot`**([`IReactPropertyBag`](IReactPropertyBag) properties, [`FrameworkElement`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.FrameworkElement) accessibleRoot) +Sets the [`FrameworkElement`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.FrameworkElement) that will act as the default accessible element for the app. The element must be able to create an automation peer (see [`FrameworkElementAutomationPeer`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.Automation.Peers.FrameworkElementAutomationPeer)), or have the Landmark type property set (see [`AutomationProperties.LandmarkTypeProperty`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.Automation.AutomationProperties.LandmarkTypeProperty)). +This must be manually provided to the [`ReactInstanceSettings`](ReactInstanceSettings) when using XAML Islands to have access to functionality related to accessibility. -### SetIslandWindowHandle +#### SetIslandWindowHandle `static` void **`SetIslandWindowHandle`**([`IReactPropertyBag`](IReactPropertyBag) properties, uint64_t windowHandle) Sets the windowHandle HWND (as an UInt64) to be the XAML Island window for the current React instance. Pass the value returned by IDesktopWindowXamlSourceNative get_WindowHandle. +#### SetXamlRoot +`static` void **`SetXamlRoot`**([`IReactPropertyBag`](IReactPropertyBag) properties, [`XamlRoot`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.XamlRoot) xamlRoot) - -### SetXamlRoot -`static` void **`SetXamlRoot`**([`IReactPropertyBag`](IReactPropertyBag) properties, [`XamlRoot`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.XamlRoot) xamlRoot) - -Sets the [`XamlRoot`](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.XamlRoot) element for the app. This must be manually provided to the [`ReactInstanceSettings`](ReactInstanceSettings) object when using XAML Islands so that certain APIs work correctly. +Sets the [`XamlRoot`](https://learn.microsoft.com/uwp/api/Windows.UI.Xaml.XamlRoot) element for the app. This must be manually provided to the [`ReactInstanceSettings`](ReactInstanceSettings) object when using XAML Islands so that certain APIs work correctly. For more information, see [Host WinRT XAML Controls in desktop apps (XAML Islands)](https://docs.microsoft.com/windows/apps/desktop/modernize/xaml-islands). - - - - diff --git a/docs/native-api/YogaLayoutableShadowNode-api-windows.md b/docs/native-api/YogaLayoutableShadowNode-api-windows.md new file mode 100644 index 000000000..f9933ecc9 --- /dev/null +++ b/docs/native-api/YogaLayoutableShadowNode-api-windows.md @@ -0,0 +1,18 @@ +--- +id: YogaLayoutableShadowNode +title: YogaLayoutableShadowNode +--- + +![Architecture](https://img.shields.io/badge/architecture-new_only-blue) + +Kind: `class` + +Extends: [`ShadowNode`](ShadowNode) + +> **EXPERIMENTAL** + +## Methods +### Layout +void **`Layout`**([`LayoutContext`](LayoutContext) layoutContext) + +> **EXPERIMENTAL** diff --git a/docs/native-api/index-api-windows.md b/docs/native-api/index-api-windows.md index c3760474e..9c930cc1c 100644 --- a/docs/native-api/index-api-windows.md +++ b/docs/native-api/index-api-windows.md @@ -1,131 +1,257 @@ --- id: Native-API-Reference -title: namespace Microsoft.ReactNative -sidebar_label: Full reference - +title: Microsoft.ReactNative APIs --- +![Architecture](https://img.shields.io/badge/architecture-new_&_old-green) + +## Classes +- [ActivityIndicatorComponentView](ActivityIndicatorComponentView) +- [BorderEffect](BorderEffect) +- [CallInvoker](CallInvoker) +- [Color](Color) +- [ColorSourceEffect](ColorSourceEffect) +- [ComponentView](ComponentView) +- [CompositeStepEffect](CompositeStepEffect) +- [CompositionHwndHost](CompositionHwndHost) +- [CompositionUIService](CompositionUIService) +- [ContentIslandComponentView](ContentIslandComponentView) +- [CustomResourceResult](CustomResourceResult) +- [DebuggingOverlayComponentView](DebuggingOverlayComponentView) +- [DevMenuControl](DevMenuControl) +- [DynamicAutomationPeer](DynamicAutomationPeer) +- [DynamicAutomationProperties](DynamicAutomationProperties) +- [DynamicValueProvider](DynamicValueProvider) +- [EventEmitter](EventEmitter) +- [FocusManager](FocusManager) +- [FocusNavigationRequest](FocusNavigationRequest) +- [FocusNavigationResult](FocusNavigationResult) +- [GaussianBlurEffect](GaussianBlurEffect) +- [GettingFocusEventArgs](GettingFocusEventArgs) +- [HandleCommandArgs](HandleCommandArgs) +- [HttpSettings](HttpSettings) +- [ImageComponentView](ImageComponentView) +- [ImageFailedResponse](ImageFailedResponse) +- [ImageProps](ImageProps) +- [ImageResponse](ImageResponse) +- [ImageSource](ImageSource) +- [InstanceCreatedEventArgs](InstanceCreatedEventArgs) +- [InstanceDestroyedEventArgs](InstanceDestroyedEventArgs) +- [InstanceLoadedEventArgs](InstanceLoadedEventArgs) +- [JsiError](JsiError) +- [JsiPreparedJavaScript](JsiPreparedJavaScript) +- [JsiRuntime](JsiRuntime) +- [LayoutContext](LayoutContext) +- [LayoutMetricsChangedArgs](LayoutMetricsChangedArgs) +- [LayoutService](LayoutService) +- [LosingFocusEventArgs](LosingFocusEventArgs) +- [MicrosoftCompositionContextHelper](MicrosoftCompositionContextHelper) +- [MountChildComponentViewArgs](MountChildComponentViewArgs) +- [ParagraphComponentView](ParagraphComponentView) +- [Pointer](Pointer) +- [PointerPoint](PointerPoint) +- [PointerPointProperties](PointerPointProperties) +- [PointerRoutedEventArgs](PointerRoutedEventArgs) +- [PortalComponentView](PortalComponentView) +- [QuirkSettings](QuirkSettings) +- [ReactApplication](ReactApplication) +- [ReactCoreInjection](ReactCoreInjection) +- [ReactDispatcherHelper](ReactDispatcherHelper) +- [ReactInstanceSettings](ReactInstanceSettings) +- [ReactNativeAppBuilder](ReactNativeAppBuilder) +- [ReactNativeHost](ReactNativeHost) +- [ReactNativeIsland](ReactNativeIsland) +- [ReactNativeWin32App](ReactNativeWin32App) +- [ReactNotificationServiceHelper](ReactNotificationServiceHelper) +- [ReactPointerEventArgs](ReactPointerEventArgs) +- [ReactPropertyBagHelper](ReactPropertyBagHelper) +- [ReactRootView](ReactRootView) +- [ReactViewOptions](ReactViewOptions) +- [RedBoxHelper](RedBoxHelper) +- [RootComponentView](RootComponentView) +- [RootViewSizeChangedEventArgs](RootViewSizeChangedEventArgs) +- [ScrollViewComponentView](ScrollViewComponentView) +- [ShadowNode](ShadowNode) +- [StreamImageResponse](StreamImageResponse) +- [SwitchComponentView](SwitchComponentView) +- [SystemCompositionContextHelper](SystemCompositionContextHelper) +- [Theme](Theme) +- [Timer](Timer) +- [UnimplementedNativeViewComponentView](UnimplementedNativeViewComponentView) +- [UnmountChildComponentViewArgs](UnmountChildComponentViewArgs) +- [UriBrushFactoryImageResponse](UriBrushFactoryImageResponse) +- [ViewComponentView](ViewComponentView) +- [ViewControl](ViewControl) +- [ViewPanel](ViewPanel) +- [ViewProps](ViewProps) +- [WindowsModalHostComponentView](WindowsModalHostComponentView) +- [WindowsTextInputComponentView](WindowsTextInputComponentView) +- [XamlHelper](XamlHelper) +- [XamlMetaDataProvider](XamlMetaDataProvider) +- [XamlUIService](XamlUIService) +- [YogaLayoutableShadowNode](YogaLayoutableShadowNode) + +## Delegates +- [AccessibilityActionEventHandler](AccessibilityActionEventHandler) +- [AccessibilityInvokeEventHandler](AccessibilityInvokeEventHandler) +- [CallFunc](CallFunc) +- [ComponentIslandComponentViewInitializer](ComponentIslandComponentViewInitializer) +- [ComponentViewInitializer](ComponentViewInitializer) +- [ConstantProviderDelegate](ConstantProviderDelegate) +- [CreateInternalVisualDelegate](CreateInternalVisualDelegate) +- [CreateVisualDelegate](CreateVisualDelegate) +- [EmitEventSetterDelegate](EmitEventSetterDelegate) +- [EventEmitterInitializerDelegate](EventEmitterInitializerDelegate) +- [HandleCommandDelegate](HandleCommandDelegate) +- [InitializerDelegate](InitializerDelegate) +- [InitialStateDataFactory](InitialStateDataFactory) +- [IVisualToMountChildrenIntoDelegate](IVisualToMountChildrenIntoDelegate) +- [JsiByteArrayUser](JsiByteArrayUser) +- [JsiHostFunction](JsiHostFunction) +- [JsiInitializerDelegate](JsiInitializerDelegate) +- [JSValueArgWriter](JSValueArgWriter) +- [LayoutHandler](LayoutHandler) +- [LogHandler](LogHandler) +- [MeasureContentHandler](MeasureContentHandler) +- [MethodDelegate](MethodDelegate) +- [MethodResultCallback](MethodResultCallback) +- [MountChildComponentViewDelegate](MountChildComponentViewDelegate) +- [PortalComponentViewInitializer](PortalComponentViewInitializer) +- [ReactCreatePropertyValue](ReactCreatePropertyValue) +- [ReactDispatcherCallback](ReactDispatcherCallback) +- [ReactModuleProvider](ReactModuleProvider) +- [ReactNotificationHandler](ReactNotificationHandler) +- [ReactViewComponentProvider](ReactViewComponentProvider) +- [ReactViewManagerProvider](ReactViewManagerProvider) +- [StateUpdateMutation](StateUpdateMutation) +- [SyncMethodDelegate](SyncMethodDelegate) +- [TimerFactory](TimerFactory) +- [UIBatchCompleteCallback](UIBatchCompleteCallback) +- [UnmountChildComponentViewDelegate](UnmountChildComponentViewDelegate) +- [UpdateEventEmitterDelegate](UpdateEventEmitterDelegate) +- [UpdateFinalizerDelegate](UpdateFinalizerDelegate) +- [UpdateLayoutMetricsDelegate](UpdateLayoutMetricsDelegate) +- [UpdatePropsDelegate](UpdatePropsDelegate) +- [UpdateStateDelegate](UpdateStateDelegate) +- [UriBrushFactory](UriBrushFactory) +- [ViewComponentViewInitializer](ViewComponentViewInitializer) +- [ViewPropsFactory](ViewPropsFactory) +- [ViewShadowNodeCloner](ViewShadowNodeCloner) +- [ViewShadowNodeFactory](ViewShadowNodeFactory) +- [VisualToMountChildrenIntoDelegate](VisualToMountChildrenIntoDelegate) + ## Enums -- [`AccessibilityRoles`](AccessibilityRoles) -- [`AccessibilityStateCheckedValue`](AccessibilityStateCheckedValue) -- [`AccessibilityStates`](AccessibilityStates) -- [`AccessibilityValue`](AccessibilityValue) -- [`AriaRole`](AriaRole) -- [`BackNavigationHandlerKind`](BackNavigationHandlerKind) -- [`CanvasComposite`](CanvasComposite) -- [`CanvasEdgeBehavior`](CanvasEdgeBehavior) -- [`EffectBorderMode`](EffectBorderMode) -- [`EffectOptimization`](EffectOptimization) -- [`JSIEngine`](JSIEngine) -- [`JSValueType`](JSValueType) -- [`JsiErrorType`](JsiErrorType) -- [`JsiValueKind`](JsiValueKind) -- [`LoadingState`](LoadingState) -- [`LogLevel`](LogLevel) -- [`MethodReturnType`](MethodReturnType) -- [`PointerEventKind`](PointerEventKind) -- [`RedBoxErrorType`](RedBoxErrorType) -- [`ViewManagerPropertyType`](ViewManagerPropertyType) +- [AccessibilityRoles](AccessibilityRoles) +- [AccessibilityStateCheckedValue](AccessibilityStateCheckedValue) +- [AccessibilityStates](AccessibilityStates) +- [AccessibilityValue](AccessibilityValue) +- [AnimationClass](AnimationClass) +- [AriaRole](AriaRole) +- [BackfaceVisibility](BackfaceVisibility) +- [BackNavigationHandlerKind](BackNavigationHandlerKind) +- [CanvasComposite](CanvasComposite) +- [CanvasEdgeBehavior](CanvasEdgeBehavior) +- [ComponentViewFeatures](ComponentViewFeatures) +- [ComponentViewUpdateMask](ComponentViewUpdateMask) +- [CompositionStretch](CompositionStretch) +- [EffectBorderMode](EffectBorderMode) +- [EffectOptimization](EffectOptimization) +- [FocusNavigationDirection](FocusNavigationDirection) +- [FocusNavigationReason](FocusNavigationReason) +- [ImageSourceType](ImageSourceType) +- [JSIEngine](JSIEngine) +- [JsiErrorType](JsiErrorType) +- [JsiValueKind](JsiValueKind) +- [JSValueType](JSValueType) +- [LayoutDirection](LayoutDirection) +- [LoadingState](LoadingState) +- [LogLevel](LogLevel) +- [MethodReturnType](MethodReturnType) +- [PointerDeviceType](PointerDeviceType) +- [PointerEventKind](PointerEventKind) +- [PointerUpdateKind](PointerUpdateKind) +- [RedBoxErrorType](RedBoxErrorType) +- [ResourceType](ResourceType) +- [ViewManagerPropertyType](ViewManagerPropertyType) + ## Interfaces -- [`IJSValueReader`](IJSValueReader) -- [`IJSValueWriter`](IJSValueWriter) -- [`IJsiByteBuffer`](IJsiByteBuffer) -- [`IJsiHostObject`](IJsiHostObject) -- [`IReactContext`](IReactContext) -- [`IReactDispatcher`](IReactDispatcher) -- [`IReactModuleBuilder`](IReactModuleBuilder) -- [`IReactNonAbiValue`](IReactNonAbiValue) -- [`IReactNotificationArgs`](IReactNotificationArgs) -- [`IReactNotificationService`](IReactNotificationService) -- [`IReactNotificationSubscription`](IReactNotificationSubscription) -- [`IReactPackageBuilder`](IReactPackageBuilder) -- [`IReactPackageProvider`](IReactPackageProvider) -- [`IReactPropertyBag`](IReactPropertyBag) -- [`IReactPropertyName`](IReactPropertyName) -- [`IReactPropertyNamespace`](IReactPropertyNamespace) -- [`IReactSettingsSnapshot`](IReactSettingsSnapshot) -- [`IReactViewHost`](IReactViewHost) -- [`IReactViewInstance`](IReactViewInstance) -- [`IRedBoxErrorFrameInfo`](IRedBoxErrorFrameInfo) -- [`IRedBoxErrorInfo`](IRedBoxErrorInfo) -- [`IRedBoxHandler`](IRedBoxHandler) -- [`ITimer`](ITimer) -- [`IViewManager`](IViewManager) -- [`IViewManagerCreateWithProperties`](IViewManagerCreateWithProperties) -- [`IViewManagerRequiresNativeLayout`](IViewManagerRequiresNativeLayout) -- [`IViewManagerWithChildren`](IViewManagerWithChildren) -- [`IViewManagerWithCommands`](IViewManagerWithCommands) -- [`IViewManagerWithDropViewInstance`](IViewManagerWithDropViewInstance) -- [`IViewManagerWithExportedEventTypeConstants`](IViewManagerWithExportedEventTypeConstants) -- [`IViewManagerWithExportedViewConstants`](IViewManagerWithExportedViewConstants) -- [`IViewManagerWithNativeProperties`](IViewManagerWithNativeProperties) -- [`IViewManagerWithOnLayout`](IViewManagerWithOnLayout) -- [`IViewManagerWithPointerEvents`](IViewManagerWithPointerEvents) -- [`IViewManagerWithReactContext`](IViewManagerWithReactContext) +- [CharacterReceivedRoutedEventArgs](CharacterReceivedRoutedEventArgs) +- [IActivityVisual](IActivityVisual) +- [IBrush](IBrush) +- [ICaretVisual](ICaretVisual) +- [IComponentProps](IComponentProps) +- [IComponentState](IComponentState) +- [ICompositionContext](ICompositionContext) +- [ICustomResourceLoader](ICustomResourceLoader) +- [IDrawingSurfaceBrush](IDrawingSurfaceBrush) +- [IDropShadow](IDropShadow) +- [IFocusVisual](IFocusVisual) +- [IInternalColor](IInternalColor) +- [IInternalComponentView](IInternalComponentView) +- [IInternalCompositionRootView](IInternalCompositionRootView) +- [IInternalCreateVisual](IInternalCreateVisual) +- [IInternalTheme](IInternalTheme) +- [IJsiByteBuffer](IJsiByteBuffer) +- [IJsiHostObject](IJsiHostObject) +- [IJSValueReader](IJSValueReader) +- [IJSValueWriter](IJSValueWriter) +- [IPointerPointTransform](IPointerPointTransform) +- [IPortalStateData](IPortalStateData) +- [IReactCompositionViewComponentBuilder](IReactCompositionViewComponentBuilder) +- [IReactCompositionViewComponentInternalBuilder](IReactCompositionViewComponentInternalBuilder) +- [IReactContext](IReactContext) +- [IReactDispatcher](IReactDispatcher) +- [IReactModuleBuilder](IReactModuleBuilder) +- [IReactNonAbiValue](IReactNonAbiValue) +- [IReactNotificationArgs](IReactNotificationArgs) +- [IReactNotificationService](IReactNotificationService) +- [IReactNotificationSubscription](IReactNotificationSubscription) +- [IReactPackageBuilder](IReactPackageBuilder) +- [IReactPackageBuilderFabric](IReactPackageBuilderFabric) +- [IReactPackageProvider](IReactPackageProvider) +- [IReactPropertyBag](IReactPropertyBag) +- [IReactPropertyName](IReactPropertyName) +- [IReactPropertyNamespace](IReactPropertyNamespace) +- [IReactSettingsSnapshot](IReactSettingsSnapshot) +- [IReactViewComponentBuilder](IReactViewComponentBuilder) +- [IReactViewHost](IReactViewHost) +- [IReactViewInstance](IReactViewInstance) +- [IRedBoxErrorFrameInfo](IRedBoxErrorFrameInfo) +- [IRedBoxErrorInfo](IRedBoxErrorInfo) +- [IRedBoxHandler](IRedBoxHandler) +- [IRoundedRectangleVisual](IRoundedRectangleVisual) +- [IScrollPositionChangedArgs](IScrollPositionChangedArgs) +- [IScrollVisual](IScrollVisual) +- [ISpriteVisual](ISpriteVisual) +- [ITimer](ITimer) +- [IUriImageProvider](IUriImageProvider) +- [IViewManager](IViewManager) +- [IViewManagerCreateWithProperties](IViewManagerCreateWithProperties) +- [IViewManagerRequiresNativeLayout](IViewManagerRequiresNativeLayout) +- [IViewManagerWithChildren](IViewManagerWithChildren) +- [IViewManagerWithCommands](IViewManagerWithCommands) +- [IViewManagerWithDropViewInstance](IViewManagerWithDropViewInstance) +- [IViewManagerWithExportedEventTypeConstants](IViewManagerWithExportedEventTypeConstants) +- [IViewManagerWithExportedViewConstants](IViewManagerWithExportedViewConstants) +- [IViewManagerWithNativeProperties](IViewManagerWithNativeProperties) +- [IViewManagerWithOnLayout](IViewManagerWithOnLayout) +- [IViewManagerWithPointerEvents](IViewManagerWithPointerEvents) +- [IViewManagerWithReactContext](IViewManagerWithReactContext) +- [IVisual](IVisual) +- [KeyboardSource](KeyboardSource) +- [KeyRoutedEventArgs](KeyRoutedEventArgs) +- [RoutedEventArgs](RoutedEventArgs) + ## Structs -- [`AccessibilityAction`](AccessibilityAction) -- [`DesktopWindowMessage`](DesktopWindowMessage) -- [`JsiBigIntRef`](JsiBigIntRef) -- [`JsiObjectRef`](JsiObjectRef) -- [`JsiPropertyIdRef`](JsiPropertyIdRef) -- [`JsiScopeState`](JsiScopeState) -- [`JsiStringRef`](JsiStringRef) -- [`JsiSymbolRef`](JsiSymbolRef) -- [`JsiValueRef`](JsiValueRef) -- [`JsiWeakObjectRef`](JsiWeakObjectRef) -## Classes -- [`BorderEffect`](BorderEffect) -- [`ColorSourceEffect`](ColorSourceEffect) -- [`CompositeStepEffect`](CompositeStepEffect) -- [`DevMenuControl`](DevMenuControl) -- [`DynamicAutomationPeer`](DynamicAutomationPeer) -- [`DynamicAutomationProperties`](DynamicAutomationProperties) -- [`DynamicValueProvider`](DynamicValueProvider) -- [`GaussianBlurEffect`](GaussianBlurEffect) -- [`HttpSettings`](HttpSettings) -- [`InstanceCreatedEventArgs`](InstanceCreatedEventArgs) -- [`InstanceDestroyedEventArgs`](InstanceDestroyedEventArgs) -- [`InstanceLoadedEventArgs`](InstanceLoadedEventArgs) -- [`JsiError`](JsiError) -- [`JsiPreparedJavaScript`](JsiPreparedJavaScript) -- [`JsiRuntime`](JsiRuntime) -- [`LayoutService`](LayoutService) -- [`QuirkSettings`](QuirkSettings) -- [`ReactApplication`](ReactApplication) -- [`ReactCoreInjection`](ReactCoreInjection) -- [`ReactDispatcherHelper`](ReactDispatcherHelper) -- [`ReactInstanceSettings`](ReactInstanceSettings) -- [`ReactNativeHost`](ReactNativeHost) -- [`ReactNotificationServiceHelper`](ReactNotificationServiceHelper) -- [`ReactPointerEventArgs`](ReactPointerEventArgs) -- [`ReactPropertyBagHelper`](ReactPropertyBagHelper) -- [`ReactRootView`](ReactRootView) -- [`ReactViewOptions`](ReactViewOptions) -- [`RedBoxHelper`](RedBoxHelper) -- [`Timer`](Timer) -- [`ViewControl`](ViewControl) -- [`ViewPanel`](ViewPanel) -- [`XamlHelper`](XamlHelper) -- [`XamlMetaDataProvider`](XamlMetaDataProvider) -- [`XamlUIService`](XamlUIService) -## Delegates -- [`AccessibilityActionEventHandler`](AccessibilityActionEventHandler) -- [`AccessibilityInvokeEventHandler`](AccessibilityInvokeEventHandler) -- [`ConstantProviderDelegate`](ConstantProviderDelegate) -- [`EmitEventSetterDelegate`](EmitEventSetterDelegate) -- [`EventEmitterInitializerDelegate`](EventEmitterInitializerDelegate) -- [`InitializerDelegate`](InitializerDelegate) -- [`JSValueArgWriter`](JSValueArgWriter) -- [`JsiByteArrayUser`](JsiByteArrayUser) -- [`JsiHostFunction`](JsiHostFunction) -- [`LogHandler`](LogHandler) -- [`MethodDelegate`](MethodDelegate) -- [`MethodResultCallback`](MethodResultCallback) -- [`ReactCreatePropertyValue`](ReactCreatePropertyValue) -- [`ReactDispatcherCallback`](ReactDispatcherCallback) -- [`ReactModuleProvider`](ReactModuleProvider) -- [`ReactNotificationHandler`](ReactNotificationHandler) -- [`ReactViewManagerProvider`](ReactViewManagerProvider) -- [`SyncMethodDelegate`](SyncMethodDelegate) -- [`TimerFactory`](TimerFactory) -- [`UIBatchCompleteCallback`](UIBatchCompleteCallback) +- [AccessibilityAction](AccessibilityAction) +- [DesktopWindowMessage](DesktopWindowMessage) +- [JsiBigIntRef](JsiBigIntRef) +- [JsiObjectRef](JsiObjectRef) +- [JsiPropertyIdRef](JsiPropertyIdRef) +- [JsiScopeState](JsiScopeState) +- [JsiStringRef](JsiStringRef) +- [JsiSymbolRef](JsiSymbolRef) +- [JsiValueRef](JsiValueRef) +- [JsiWeakObjectRef](JsiWeakObjectRef) +- [LayoutConstraints](LayoutConstraints) +- [LayoutMetrics](LayoutMetrics) diff --git a/docs/win10-compat.md b/docs/win10-compat.md index 7a4778646..70eb88824 100644 --- a/docs/win10-compat.md +++ b/docs/win10-compat.md @@ -19,7 +19,7 @@ The following table captures the default versions of Windows that a React Native | 0.75 | **Windows 11 2022 Update**
Version 22H2 ; Build 10.0.22621.0 | **Windows 10 October 2018 Update**
Version 1809 ; Build 10.0.17763.0 | | 0.72 - 0.74 | **Windows 10 May 2020 Update**
Version 2004 ; Build 10.0.19041.0 | **Windows 10 October 2018 Update**
Version 1809 ; Build 10.0.17763.0 | -> **Note:** To override the default SDK versions, see [Customizing SDK versions](customizing-sdk-versions). +> **Note:** To override the default SDK versions, see [Customizing SDK versions](customizing-SDK-versions.md). ## Backwards Compatibility diff --git a/website/.unbroken_exclusions b/website/.unbroken_exclusions index 10bda9b49..489e3a8f4 100644 --- a/website/.unbroken_exclusions +++ b/website/.unbroken_exclusions @@ -75,6 +75,7 @@ File not found getting-started.md while parsing versioned_docs/version-0.76/view File not found init-windows-cli.md while parsing versioned_docs/version-0.76/view-managers.md File not found native-modules-setup.md while parsing versioned_docs/version-0.76/view-managers.md File not found native-modules.md while parsing versioned_docs/version-0.76/view-managers.md +File not found customizing-SDK-versions.md while parsing versioned_docs/version-0.76/win10-compat.md File not found run-windows-cli.md while parsing versioned_docs/version-0.75/autolink-windows-cli.md File not found run-windows-cli.md while parsing versioned_docs/version-0.75/debugging-javascript.md File not found getting-started.md while parsing versioned_docs/version-0.75/getting-started.md @@ -110,6 +111,7 @@ File not found getting-started.md while parsing versioned_docs/version-0.75/view File not found native-modules.md while parsing versioned_docs/version-0.75/view-managers.md File not found native-modules-setup.md while parsing versioned_docs/version-0.75/view-managers.md File not found IViewManagerCreateWithProperties-api-windows.md while parsing versioned_docs/version-0.75/view-managers.md +File not found customizing-SDK-versions.md while parsing versioned_docs/version-0.75/win10-compat.md File not found getting-started.md while parsing versioned_docs/version-0.74/getting-started.md File not found native-modules.md while parsing versioned_docs/version-0.74/getting-started.md File not found rnw-dependencies.md while parsing versioned_docs/version-0.74/getting-started.md @@ -153,6 +155,7 @@ File not found view-managers.md while parsing versioned_docs/version-0.72/native File not found native-code-language-choice.md while parsing versioned_docs/version-0.72/native-modules.md File not found flyout-component-windows.md while parsing versioned_docs/version-0.72/popup-component-windows.md File not found win10-compat.md while parsing versioned_docs/version-0.72/rnw-dependencies.md +File not found customizing-SDK-versions.md while parsing versioned_docs/version-0.72/win10-compat.md File not found IReactPackageProvider-api-windows.md while parsing versioned_docs/version-0.71/coreapp.md File not found ReactInstanceSettings-api-windows.md while parsing versioned_docs/version-0.71/coreapp.md File not found native-modules.md while parsing versioned_docs/version-0.71/getting-started.md @@ -208,6 +211,7 @@ File not found native-modules-csharp-codegen.md while parsing versioned_docs/ver File not found nuget-update.md while parsing versioned_docs/version-0.68/nuget.md File not found supported-community-modules.md while parsing versioned_docs/version-0.68/nuget.md File not found win10-compat.md while parsing versioned_docs/version-0.68/rnw-dependencies.md +File not found customizing-SDK-versions.md while parsing versioned_docs/version-0.68/win10-compat.md File not found hermes.md while parsing versioned_docs/version-0.67/customizing-SDK-versions.md File not found rnw-dependencies.md while parsing versioned_docs/version-0.67/getting-started.md File not found native-modules.md while parsing versioned_docs/version-0.67/getting-started.md diff --git a/website/fix-unbroken.js b/website/fix-unbroken.js index ef0a13a0f..b1b1002fa 100644 --- a/website/fix-unbroken.js +++ b/website/fix-unbroken.js @@ -34,7 +34,6 @@ const addFileToVersionedDocs = (file, version) => { if (!versionedDocs.hasOwnProperty(version)) { versionedDocs[version] = []; } - const versionDir = `versioned_docs/version-${version}`; versionedDocs[version].push(file); }; diff --git a/website/sidebars.json b/website/sidebars.json index 63b17f70d..ee2ed5ec8 100644 --- a/website/sidebars.json +++ b/website/sidebars.json @@ -66,7 +66,7 @@ "native-modules-async", "native-modules-jsvalue", "native-modules-csharp-codegen", - "customizing-sdk-versions", + "customizing-SDK-versions", "managing-cpp-deps" ] } @@ -85,22 +85,278 @@ "iviewwindowsprops-api" ], "Native API (Windows)": [ - "native-api/IJSValueReader", - "native-api/IJSValueWriter", - "native-api/IReactContext", - "native-api/IReactDispatcher", - "native-api/IReactModuleBuilder", - "native-api/IReactNonAbiValue", - "native-api/IReactPackageBuilder", - "native-api/IReactPackageProvider", - "native-api/IReactPropertyBag", - "native-api/IRedBoxHandler", - "native-api/IViewManager", - "native-api/ReactApplication", - "native-api/ReactInstanceSettings", - "native-api/ReactNativeHost", - "native-api/XamlUIService", - "native-api/Native-API-Reference" + "native-api/Native-API-Reference", + { + "type": "subcategory", + "ids": [ + "native-api/ActivityIndicatorComponentView", + "native-api/BorderEffect", + "native-api/CallInvoker", + "native-api/Color", + "native-api/ColorSourceEffect", + "native-api/ComponentView", + "native-api/CompositeStepEffect", + "native-api/CompositionHwndHost", + "native-api/CompositionUIService", + "native-api/ContentIslandComponentView", + "native-api/CustomResourceResult", + "native-api/DebuggingOverlayComponentView", + "native-api/DevMenuControl", + "native-api/DynamicAutomationPeer", + "native-api/DynamicAutomationProperties", + "native-api/DynamicValueProvider", + "native-api/EventEmitter", + "native-api/FocusManager", + "native-api/FocusNavigationRequest", + "native-api/FocusNavigationResult", + "native-api/GaussianBlurEffect", + "native-api/GettingFocusEventArgs", + "native-api/HandleCommandArgs", + "native-api/HttpSettings", + "native-api/ImageComponentView", + "native-api/ImageFailedResponse", + "native-api/ImageProps", + "native-api/ImageResponse", + "native-api/ImageSource", + "native-api/InstanceCreatedEventArgs", + "native-api/InstanceDestroyedEventArgs", + "native-api/InstanceLoadedEventArgs", + "native-api/JsiError", + "native-api/JsiPreparedJavaScript", + "native-api/JsiRuntime", + "native-api/LayoutContext", + "native-api/LayoutMetricsChangedArgs", + "native-api/LayoutService", + "native-api/LosingFocusEventArgs", + "native-api/MicrosoftCompositionContextHelper", + "native-api/MountChildComponentViewArgs", + "native-api/ParagraphComponentView", + "native-api/Pointer", + "native-api/PointerPoint", + "native-api/PointerPointProperties", + "native-api/PointerRoutedEventArgs", + "native-api/PortalComponentView", + "native-api/QuirkSettings", + "native-api/ReactApplication", + "native-api/ReactCoreInjection", + "native-api/ReactDispatcherHelper", + "native-api/ReactInstanceSettings", + "native-api/ReactNativeAppBuilder", + "native-api/ReactNativeHost", + "native-api/ReactNativeIsland", + "native-api/ReactNativeWin32App", + "native-api/ReactNotificationServiceHelper", + "native-api/ReactPointerEventArgs", + "native-api/ReactPropertyBagHelper", + "native-api/ReactRootView", + "native-api/ReactViewOptions", + "native-api/RedBoxHelper", + "native-api/RootComponentView", + "native-api/RootViewSizeChangedEventArgs", + "native-api/ScrollViewComponentView", + "native-api/ShadowNode", + "native-api/StreamImageResponse", + "native-api/SwitchComponentView", + "native-api/SystemCompositionContextHelper", + "native-api/Theme", + "native-api/Timer", + "native-api/UnimplementedNativeViewComponentView", + "native-api/UnmountChildComponentViewArgs", + "native-api/UriBrushFactoryImageResponse", + "native-api/ViewComponentView", + "native-api/ViewControl", + "native-api/ViewPanel", + "native-api/ViewProps", + "native-api/WindowsModalHostComponentView", + "native-api/WindowsTextInputComponentView", + "native-api/XamlHelper", + "native-api/XamlMetaDataProvider", + "native-api/XamlUIService", + "native-api/YogaLayoutableShadowNode" + ], + "label": "Classes" + }, + { + "type": "subcategory", + "ids": [ + "native-api/AccessibilityActionEventHandler", + "native-api/AccessibilityInvokeEventHandler", + "native-api/CallFunc", + "native-api/ComponentIslandComponentViewInitializer", + "native-api/ComponentViewInitializer", + "native-api/ConstantProviderDelegate", + "native-api/CreateInternalVisualDelegate", + "native-api/CreateVisualDelegate", + "native-api/EmitEventSetterDelegate", + "native-api/EventEmitterInitializerDelegate", + "native-api/HandleCommandDelegate", + "native-api/InitializerDelegate", + "native-api/InitialStateDataFactory", + "native-api/IVisualToMountChildrenIntoDelegate", + "native-api/JsiByteArrayUser", + "native-api/JsiHostFunction", + "native-api/JsiInitializerDelegate", + "native-api/JSValueArgWriter", + "native-api/LayoutHandler", + "native-api/LogHandler", + "native-api/MeasureContentHandler", + "native-api/MethodDelegate", + "native-api/MethodResultCallback", + "native-api/MountChildComponentViewDelegate", + "native-api/PortalComponentViewInitializer", + "native-api/ReactCreatePropertyValue", + "native-api/ReactDispatcherCallback", + "native-api/ReactModuleProvider", + "native-api/ReactNotificationHandler", + "native-api/ReactViewComponentProvider", + "native-api/ReactViewManagerProvider", + "native-api/StateUpdateMutation", + "native-api/SyncMethodDelegate", + "native-api/TimerFactory", + "native-api/UIBatchCompleteCallback", + "native-api/UnmountChildComponentViewDelegate", + "native-api/UpdateEventEmitterDelegate", + "native-api/UpdateFinalizerDelegate", + "native-api/UpdateLayoutMetricsDelegate", + "native-api/UpdatePropsDelegate", + "native-api/UpdateStateDelegate", + "native-api/UriBrushFactory", + "native-api/ViewComponentViewInitializer", + "native-api/ViewPropsFactory", + "native-api/ViewShadowNodeCloner", + "native-api/ViewShadowNodeFactory", + "native-api/VisualToMountChildrenIntoDelegate" + ], + "label": "Delegates" + }, + { + "type": "subcategory", + "ids": [ + "native-api/AccessibilityRoles", + "native-api/AccessibilityStateCheckedValue", + "native-api/AccessibilityStates", + "native-api/AccessibilityValue", + "native-api/AnimationClass", + "native-api/AriaRole", + "native-api/BackfaceVisibility", + "native-api/BackNavigationHandlerKind", + "native-api/CanvasComposite", + "native-api/CanvasEdgeBehavior", + "native-api/ComponentViewFeatures", + "native-api/ComponentViewUpdateMask", + "native-api/CompositionStretch", + "native-api/EffectBorderMode", + "native-api/EffectOptimization", + "native-api/FocusNavigationDirection", + "native-api/FocusNavigationReason", + "native-api/ImageSourceType", + "native-api/JSIEngine", + "native-api/JsiErrorType", + "native-api/JsiValueKind", + "native-api/JSValueType", + "native-api/LayoutDirection", + "native-api/LoadingState", + "native-api/LogLevel", + "native-api/MethodReturnType", + "native-api/PointerDeviceType", + "native-api/PointerEventKind", + "native-api/PointerUpdateKind", + "native-api/RedBoxErrorType", + "native-api/ResourceType", + "native-api/ViewManagerPropertyType" + ], + "label": "Enums" + }, + { + "type": "subcategory", + "ids": [ + "native-api/CharacterReceivedRoutedEventArgs", + "native-api/IActivityVisual", + "native-api/IBrush", + "native-api/ICaretVisual", + "native-api/IComponentProps", + "native-api/IComponentState", + "native-api/ICompositionContext", + "native-api/ICustomResourceLoader", + "native-api/IDrawingSurfaceBrush", + "native-api/IDropShadow", + "native-api/IFocusVisual", + "native-api/IInternalColor", + "native-api/IInternalComponentView", + "native-api/IInternalCompositionRootView", + "native-api/IInternalCreateVisual", + "native-api/IInternalTheme", + "native-api/IJsiByteBuffer", + "native-api/IJsiHostObject", + "native-api/IJSValueReader", + "native-api/IJSValueWriter", + "native-api/IPointerPointTransform", + "native-api/IPortalStateData", + "native-api/IReactCompositionViewComponentBuilder", + "native-api/IReactCompositionViewComponentInternalBuilder", + "native-api/IReactContext", + "native-api/IReactDispatcher", + "native-api/IReactModuleBuilder", + "native-api/IReactNonAbiValue", + "native-api/IReactNotificationArgs", + "native-api/IReactNotificationService", + "native-api/IReactNotificationSubscription", + "native-api/IReactPackageBuilder", + "native-api/IReactPackageBuilderFabric", + "native-api/IReactPackageProvider", + "native-api/IReactPropertyBag", + "native-api/IReactPropertyName", + "native-api/IReactPropertyNamespace", + "native-api/IReactSettingsSnapshot", + "native-api/IReactViewComponentBuilder", + "native-api/IReactViewHost", + "native-api/IReactViewInstance", + "native-api/IRedBoxErrorFrameInfo", + "native-api/IRedBoxErrorInfo", + "native-api/IRedBoxHandler", + "native-api/IRoundedRectangleVisual", + "native-api/IScrollPositionChangedArgs", + "native-api/IScrollVisual", + "native-api/ISpriteVisual", + "native-api/ITimer", + "native-api/IUriImageProvider", + "native-api/IViewManager", + "native-api/IViewManagerCreateWithProperties", + "native-api/IViewManagerRequiresNativeLayout", + "native-api/IViewManagerWithChildren", + "native-api/IViewManagerWithCommands", + "native-api/IViewManagerWithDropViewInstance", + "native-api/IViewManagerWithExportedEventTypeConstants", + "native-api/IViewManagerWithExportedViewConstants", + "native-api/IViewManagerWithNativeProperties", + "native-api/IViewManagerWithOnLayout", + "native-api/IViewManagerWithPointerEvents", + "native-api/IViewManagerWithReactContext", + "native-api/IVisual", + "native-api/KeyboardSource", + "native-api/KeyRoutedEventArgs", + "native-api/RoutedEventArgs" + ], + "label": "Interfaces" + }, + { + "type": "subcategory", + "ids": [ + "native-api/AccessibilityAction", + "native-api/DesktopWindowMessage", + "native-api/JsiBigIntRef", + "native-api/JsiObjectRef", + "native-api/JsiPropertyIdRef", + "native-api/JsiScopeState", + "native-api/JsiStringRef", + "native-api/JsiSymbolRef", + "native-api/JsiValueRef", + "native-api/JsiWeakObjectRef", + "native-api/LayoutConstraints", + "native-api/LayoutMetrics" + ], + "label": "Structs" + } ] } } diff --git a/website/versioned_docs/version-0.64/customizing-SDK-versions.md b/website/versioned_docs/version-0.64/customizing-SDK-versions.md index f3ebee905..56c828be9 100644 --- a/website/versioned_docs/version-0.64/customizing-SDK-versions.md +++ b/website/versioned_docs/version-0.64/customizing-SDK-versions.md @@ -1,7 +1,7 @@ --- -id: version-0.64-customizing-sdk-versions +id: version-0.64-customizing-SDK-versions title: Customizing SDK versions -original_id: customizing-sdk-versions +original_id: customizing-SDK-versions --- In React Native for Windows 0.64.3, we have made it easier for an app to customize which versions of the Windows SDK and WinUI 2.x to use. diff --git a/website/versioned_docs/version-0.65/customizing-SDK-versions.md b/website/versioned_docs/version-0.65/customizing-SDK-versions.md index 56ebf3df5..ec4a28275 100644 --- a/website/versioned_docs/version-0.65/customizing-SDK-versions.md +++ b/website/versioned_docs/version-0.65/customizing-SDK-versions.md @@ -1,7 +1,7 @@ --- -id: version-0.65-customizing-sdk-versions +id: version-0.65-customizing-SDK-versions title: Customizing SDK versions -original_id: customizing-sdk-versions +original_id: customizing-SDK-versions --- It is easy for an app to customize which versions of the Windows SDK and WinUI 2.x to use. diff --git a/website/versioned_docs/version-0.67/customizing-SDK-versions.md b/website/versioned_docs/version-0.67/customizing-SDK-versions.md index 67cb2b0b3..d6265f861 100644 --- a/website/versioned_docs/version-0.67/customizing-SDK-versions.md +++ b/website/versioned_docs/version-0.67/customizing-SDK-versions.md @@ -1,7 +1,7 @@ --- -id: version-0.67-customizing-sdk-versions +id: version-0.67-customizing-SDK-versions title: Customizing SDK versions -original_id: customizing-sdk-versions +original_id: customizing-SDK-versions --- It is easy for an app to customize which versions of the Windows SDK and WinUI 2.x to use. diff --git a/website/versioned_docs/version-0.67/native-api/index-api-windows.md b/website/versioned_docs/version-0.67/native-api/index-api-windows.md index 0d4c6b185..2af208a7f 100644 --- a/website/versioned_docs/version-0.67/native-api/index-api-windows.md +++ b/website/versioned_docs/version-0.67/native-api/index-api-windows.md @@ -3,7 +3,6 @@ id: version-0.67-Native-API-Reference title: namespace Microsoft.ReactNative sidebar_label: Full reference original_id: Native-API-Reference - --- ## Enums diff --git a/website/versioned_docs/version-0.68/native-api/index-api-windows.md b/website/versioned_docs/version-0.68/native-api/index-api-windows.md index 8be30758c..e5022e607 100644 --- a/website/versioned_docs/version-0.68/native-api/index-api-windows.md +++ b/website/versioned_docs/version-0.68/native-api/index-api-windows.md @@ -2,7 +2,6 @@ id: version-0.68-Native-API-Reference title: namespace Microsoft.ReactNative sidebar_label: Full reference -: original_id: Native-API-Reference --- diff --git a/website/versioned_docs/version-0.68/win10-compat.md b/website/versioned_docs/version-0.68/win10-compat.md index 93c0a73e4..c7ebdf750 100644 --- a/website/versioned_docs/version-0.68/win10-compat.md +++ b/website/versioned_docs/version-0.68/win10-compat.md @@ -15,7 +15,7 @@ The following table captures the default versions of Windows that a React Native | 0.68 - 0.71 | **Windows 10 May 2020 Update**
Version 2004 ; Build 10.0.19041.0 | **Windows 10 Fall Creators Update**
Version 1709 ; Build 10.0.16299.91 | | 0.66 - 0.67 | **Windows 10 May 2020 Update**
Version 2004 ; Build 10.0.19041.0 | **Windows 10 Creators Update**
Version 1703 ; Build 10.0.15063.468 | -> **Note:** To override the default SDK versions, see [Customizing SDK versions](customizing-sdk-versions). +> **Note:** To override the default SDK versions, see [Customizing SDK versions](customizing-SDK-versions.md). ## Backwards Compatibility diff --git a/website/versioned_docs/version-0.69/native-api/index-api-windows.md b/website/versioned_docs/version-0.69/native-api/index-api-windows.md index 27728d551..72184b6f1 100644 --- a/website/versioned_docs/version-0.69/native-api/index-api-windows.md +++ b/website/versioned_docs/version-0.69/native-api/index-api-windows.md @@ -2,7 +2,6 @@ id: version-0.69-Native-API-Reference title: namespace Microsoft.ReactNative sidebar_label: Full reference -: original_id: Native-API-Reference --- diff --git a/website/versioned_docs/version-0.70/native-api/index-api-windows.md b/website/versioned_docs/version-0.70/native-api/index-api-windows.md index 189157007..f94a01396 100644 --- a/website/versioned_docs/version-0.70/native-api/index-api-windows.md +++ b/website/versioned_docs/version-0.70/native-api/index-api-windows.md @@ -2,7 +2,6 @@ id: version-0.70-Native-API-Reference title: namespace Microsoft.ReactNative sidebar_label: Full reference -: original_id: Native-API-Reference --- diff --git a/website/versioned_docs/version-0.71/native-api/index-api-windows.md b/website/versioned_docs/version-0.71/native-api/index-api-windows.md index 28054216d..dcfd0c1c5 100644 --- a/website/versioned_docs/version-0.71/native-api/index-api-windows.md +++ b/website/versioned_docs/version-0.71/native-api/index-api-windows.md @@ -2,7 +2,6 @@ id: version-0.71-Native-API-Reference title: namespace Microsoft.ReactNative sidebar_label: Full reference -: original_id: Native-API-Reference --- diff --git a/website/versioned_docs/version-0.72/win10-compat.md b/website/versioned_docs/version-0.72/win10-compat.md index 0ed6cfe84..7675262bb 100644 --- a/website/versioned_docs/version-0.72/win10-compat.md +++ b/website/versioned_docs/version-0.72/win10-compat.md @@ -16,7 +16,7 @@ The following table captures the default versions of Windows that a React Native | 0.68 - 0.71 | **Windows 10 May 2020 Update**
Version 2004 ; Build 10.0.19041.0 | **Windows 10 Fall Creators Update**
Version 1709 ; Build 10.0.16299.91 | | 0.66 - 0.67 | **Windows 10 May 2020 Update**
Version 2004 ; Build 10.0.19041.0 | **Windows 10 Creators Update**
Version 1703 ; Build 10.0.15063.468 | -> **Note:** To override the default SDK versions, see [Customizing SDK versions](customizing-sdk-versions). +> **Note:** To override the default SDK versions, see [Customizing SDK versions](customizing-SDK-versions.md). ## Backwards Compatibility diff --git a/website/versioned_docs/version-0.73/native-api/index-api-windows.md b/website/versioned_docs/version-0.73/native-api/index-api-windows.md index ff1f69faa..e8f895414 100644 --- a/website/versioned_docs/version-0.73/native-api/index-api-windows.md +++ b/website/versioned_docs/version-0.73/native-api/index-api-windows.md @@ -2,7 +2,6 @@ id: version-0.73-Native-API-Reference title: namespace Microsoft.ReactNative sidebar_label: Full reference -: original_id: Native-API-Reference --- diff --git a/website/versioned_docs/version-0.74/native-api/index-api-windows.md b/website/versioned_docs/version-0.74/native-api/index-api-windows.md index 7e73ca436..c1803600d 100644 --- a/website/versioned_docs/version-0.74/native-api/index-api-windows.md +++ b/website/versioned_docs/version-0.74/native-api/index-api-windows.md @@ -2,7 +2,6 @@ id: version-0.74-Native-API-Reference title: namespace Microsoft.ReactNative sidebar_label: Full reference -: original_id: Native-API-Reference --- diff --git a/website/versioned_docs/version-0.75/native-api/index-api-windows.md b/website/versioned_docs/version-0.75/native-api/index-api-windows.md index afa7c5e64..85f1c2b9f 100644 --- a/website/versioned_docs/version-0.75/native-api/index-api-windows.md +++ b/website/versioned_docs/version-0.75/native-api/index-api-windows.md @@ -2,7 +2,6 @@ id: version-0.75-Native-API-Reference title: namespace Microsoft.ReactNative sidebar_label: Full reference -: original_id: Native-API-Reference --- diff --git a/website/versioned_docs/version-0.75/win10-compat.md b/website/versioned_docs/version-0.75/win10-compat.md index c270c1d61..31be1b17e 100644 --- a/website/versioned_docs/version-0.75/win10-compat.md +++ b/website/versioned_docs/version-0.75/win10-compat.md @@ -16,7 +16,7 @@ The following table captures the default versions of Windows that a React Native | 0.72 - 0.74 | **Windows 10 May 2020 Update**
Version 2004 ; Build 10.0.19041.0 | **Windows 10 October 2018 Update**
Version 1809 ; Build 10.0.17763.0 | | 0.68 - 0.71 | **Windows 10 May 2020 Update**
Version 2004 ; Build 10.0.19041.0 | **Windows 10 Fall Creators Update**
Version 1709 ; Build 10.0.16299.91 | -> **Note:** To override the default SDK versions, see [Customizing SDK versions](customizing-sdk-versions). +> **Note:** To override the default SDK versions, see [Customizing SDK versions](customizing-SDK-versions.md). ## Backwards Compatibility diff --git a/website/versioned_docs/version-0.76/native-api/index-api-windows.md b/website/versioned_docs/version-0.76/native-api/index-api-windows.md index 73dfc0220..aeb802520 100644 --- a/website/versioned_docs/version-0.76/native-api/index-api-windows.md +++ b/website/versioned_docs/version-0.76/native-api/index-api-windows.md @@ -2,7 +2,6 @@ id: version-0.76-Native-API-Reference title: namespace Microsoft.ReactNative sidebar_label: Full reference -: original_id: Native-API-Reference --- diff --git a/website/versioned_docs/version-0.76/win10-compat.md b/website/versioned_docs/version-0.76/win10-compat.md index 036b5c606..45174a48e 100644 --- a/website/versioned_docs/version-0.76/win10-compat.md +++ b/website/versioned_docs/version-0.76/win10-compat.md @@ -18,7 +18,7 @@ The following table captures the default versions of Windows that a React Native | 0.75 | **Windows 11 2022 Update**
Version 22H2 ; Build 10.0.22621.0 | **Windows 10 October 2018 Update**
Version 1809 ; Build 10.0.17763.0 | | 0.72 - 0.74 | **Windows 10 May 2020 Update**
Version 2004 ; Build 10.0.19041.0 | **Windows 10 October 2018 Update**
Version 1809 ; Build 10.0.17763.0 | -> **Note:** To override the default SDK versions, see [Customizing SDK versions](customizing-sdk-versions). +> **Note:** To override the default SDK versions, see [Customizing SDK versions](customizing-SDK-versions.md). ## Backwards Compatibility diff --git a/website/versioned_sidebars/version-0.64-sidebars.json b/website/versioned_sidebars/version-0.64-sidebars.json index 041ab0672..84a44074b 100644 --- a/website/versioned_sidebars/version-0.64-sidebars.json +++ b/website/versioned_sidebars/version-0.64-sidebars.json @@ -26,7 +26,7 @@ "version-0.64-native-modules-jsvalue", "version-0.64-native-modules-csharp-codegen", "version-0.64-win10-vm", - "customizing-sdk-versions" + "customizing-SDK-versions" ], "The Basics (MacOS)": [ "version-0.64-rnm-getting-started", diff --git a/website/versioned_sidebars/version-0.65-sidebars.json b/website/versioned_sidebars/version-0.65-sidebars.json index ec7b29788..779611b52 100644 --- a/website/versioned_sidebars/version-0.65-sidebars.json +++ b/website/versioned_sidebars/version-0.65-sidebars.json @@ -27,7 +27,7 @@ "version-0.65-native-modules-jsvalue", "version-0.65-native-modules-csharp-codegen", "version-0.65-win10-vm", - "version-0.65-customizing-sdk-versions" + "version-0.65-customizing-SDK-versions" ], "The Basics (MacOS)": [ "version-0.65-rnm-getting-started", diff --git a/website/versioned_sidebars/version-0.67-sidebars.json b/website/versioned_sidebars/version-0.67-sidebars.json index 66a324938..2e55b4b91 100644 --- a/website/versioned_sidebars/version-0.67-sidebars.json +++ b/website/versioned_sidebars/version-0.67-sidebars.json @@ -30,7 +30,7 @@ "version-0.67-native-modules-jsvalue", "version-0.67-native-modules-csharp-codegen", "version-0.67-win10-vm", - "version-0.67-customizing-sdk-versions" + "version-0.67-customizing-SDK-versions" ], "The Basics (MacOS)": [ "version-0.67-rnm-getting-started", diff --git a/website/versioned_sidebars/version-0.68-sidebars.json b/website/versioned_sidebars/version-0.68-sidebars.json index 4ea1e2063..c3a4a2027 100644 --- a/website/versioned_sidebars/version-0.68-sidebars.json +++ b/website/versioned_sidebars/version-0.68-sidebars.json @@ -30,7 +30,7 @@ "version-0.68-native-modules-jsvalue", "version-0.68-native-modules-csharp-codegen", "version-0.68-win10-vm", - "version-0.68-customizing-sdk-versions", + "version-0.68-customizing-SDK-versions", "version-0.68-managing-cpp-deps" ], "The Basics (MacOS)": [ diff --git a/website/versioned_sidebars/version-0.70-sidebars.json b/website/versioned_sidebars/version-0.70-sidebars.json index bbd99edc1..a16119490 100644 --- a/website/versioned_sidebars/version-0.70-sidebars.json +++ b/website/versioned_sidebars/version-0.70-sidebars.json @@ -30,7 +30,7 @@ "version-0.70-native-modules-jsvalue", "version-0.70-native-modules-csharp-codegen", "version-0.70-win10-vm", - "version-0.70-customizing-sdk-versions", + "version-0.70-customizing-SDK-versions", "version-0.70-managing-cpp-deps" ], "The Basics (MacOS)": [ diff --git a/website/versioned_sidebars/version-0.71-sidebars.json b/website/versioned_sidebars/version-0.71-sidebars.json index 481a33948..0e47348a3 100644 --- a/website/versioned_sidebars/version-0.71-sidebars.json +++ b/website/versioned_sidebars/version-0.71-sidebars.json @@ -31,7 +31,7 @@ "version-0.71-native-modules-jsvalue", "version-0.71-native-modules-csharp-codegen", "version-0.71-win10-vm", - "version-0.71-customizing-sdk-versions", + "version-0.71-customizing-SDK-versions", "version-0.71-managing-cpp-deps" ], "The Basics (MacOS)": [ diff --git a/website/versioned_sidebars/version-0.73-sidebars.json b/website/versioned_sidebars/version-0.73-sidebars.json index 2a8218240..80a6b7998 100644 --- a/website/versioned_sidebars/version-0.73-sidebars.json +++ b/website/versioned_sidebars/version-0.73-sidebars.json @@ -31,7 +31,7 @@ "version-0.73-native-modules-jsvalue", "version-0.73-native-modules-csharp-codegen", "version-0.73-win10-vm", - "version-0.73-customizing-sdk-versions", + "version-0.73-customizing-SDK-versions", "version-0.73-managing-cpp-deps" ], "The Basics (MacOS)": [ diff --git a/website/versioned_sidebars/version-0.74-sidebars.json b/website/versioned_sidebars/version-0.74-sidebars.json index 9dafc4660..e4393d2bc 100644 --- a/website/versioned_sidebars/version-0.74-sidebars.json +++ b/website/versioned_sidebars/version-0.74-sidebars.json @@ -31,7 +31,7 @@ "version-0.74-native-modules-jsvalue", "version-0.74-native-modules-csharp-codegen", "version-0.74-win10-vm", - "version-0.74-customizing-sdk-versions", + "version-0.74-customizing-SDK-versions", "version-0.74-managing-cpp-deps" ], "The Basics (MacOS)": [ diff --git a/website/versioned_sidebars/version-0.75-sidebars.json b/website/versioned_sidebars/version-0.75-sidebars.json index d2bfca24f..9a1e83b93 100644 --- a/website/versioned_sidebars/version-0.75-sidebars.json +++ b/website/versioned_sidebars/version-0.75-sidebars.json @@ -37,7 +37,7 @@ "version-0.75-native-modules-jsvalue", "version-0.75-native-modules-csharp-codegen", "version-0.75-win10-vm", - "version-0.75-customizing-sdk-versions", + "version-0.75-customizing-SDK-versions", "version-0.75-managing-cpp-deps" ], "The Basics (MacOS)": [ diff --git a/website/versioned_sidebars/version-0.76-sidebars.json b/website/versioned_sidebars/version-0.76-sidebars.json index 9825ceb0c..021ec202c 100644 --- a/website/versioned_sidebars/version-0.76-sidebars.json +++ b/website/versioned_sidebars/version-0.76-sidebars.json @@ -37,7 +37,7 @@ "version-0.76-native-modules-jsvalue", "version-0.76-native-modules-csharp-codegen", "version-0.76-win10-vm", - "version-0.76-customizing-sdk-versions", + "version-0.76-customizing-SDK-versions", "version-0.76-managing-cpp-deps" ], "The Basics (MacOS)": [ diff --git a/website/versioned_sidebars/version-0.77-sidebars.json b/website/versioned_sidebars/version-0.77-sidebars.json index 546e5e6f5..d574dc817 100644 --- a/website/versioned_sidebars/version-0.77-sidebars.json +++ b/website/versioned_sidebars/version-0.77-sidebars.json @@ -37,7 +37,7 @@ "version-0.77-native-modules-jsvalue", "version-0.77-native-modules-csharp-codegen", "version-0.77-win10-vm", - "version-0.77-customizing-sdk-versions", + "version-0.77-customizing-SDK-versions", "version-0.77-managing-cpp-deps" ], "The Basics (MacOS)": [ diff --git a/website/versioned_sidebars/version-0.78-sidebars.json b/website/versioned_sidebars/version-0.78-sidebars.json index bbf9214c1..093737696 100644 --- a/website/versioned_sidebars/version-0.78-sidebars.json +++ b/website/versioned_sidebars/version-0.78-sidebars.json @@ -37,7 +37,7 @@ "version-0.78-native-modules-jsvalue", "version-0.78-native-modules-csharp-codegen", "version-0.78-win10-vm", - "version-0.78-customizing-sdk-versions", + "version-0.78-customizing-SDK-versions", "version-0.78-managing-cpp-deps" ], "The Basics (MacOS)": [