Skip to content

Commit 0fdf33a

Browse files
authored
Update & fix links in TechnicalGuide.md (#284)
This commit fixes links from `/asklar/react-native-xaml` to the current repo URL - `/microsoft/react-native-xaml` ###### Microsoft Reviewers: [Open in CodeFlow](https://microsoft.github.io/open-pr/?codeflow=https://github.com/microsoft/react-native-xaml/pull/284)
1 parent 34d71b6 commit 0fdf33a

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,15 @@
33
A React Native Windows view manager that allows directly using the [Windows XAML](https://docs.microsoft.com/windows/uwp/xaml-platform/xaml-overview) framework.
44

55
## Cheat sheet
6-
To see examples of the syntax and available controls, check out the [Usage guide](https://github.com/asklar/react-native-xaml/tree/main/USAGE.md).
6+
To see examples of the syntax and available controls, check out the [Usage guide](https://github.com/microsoft/react-native-xaml/tree/main/USAGE.md).
77

88
## Main advantages
99
- Allows developers writing [react-native-windows](https://microsoft.github.io/react-native-windows/) apps (React Native apps targeting Windows 10) to quickly get started, if they are familiar with XAML.
1010
- Developers are not limited by the set of controls present today in RNW and community modules that support Windows.
1111
- Best of all, this solution is available *today*!
1212
- The set of types/properties/events are the XAML ones, however JS libraries can wrap those to expose the Windows control in a platform-agnostic way (e.g. as a way to implement a cross-plat control for Windows).
1313

14-
react-native-xaml works by leveraging metadata for XAML properties, types and events. This metadata is automatically generated ([code-gen](https://github.com/asklar/react-native-xaml/tree/main/package/Codegen)) from the Windows SDK.
14+
react-native-xaml works by leveraging metadata for XAML properties, types and events. This metadata is automatically generated ([code-gen](https://github.com/microsoft/react-native-xaml/tree/main/package/Codegen)) from the Windows SDK.
1515
This means we can have a full projection of all of XAML – or any WinRT components written by app devs, that export a [UserControl](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.Controls.UserControl) – without manual intervention.
1616

1717
## Technical details
@@ -22,5 +22,5 @@ Pull Requests are welcome. See [Contribution Guide](CONTRIBUTING.md) for details
2222

2323
## Demo
2424

25-
![react-native-xaml demo](https://raw.githubusercontent.com/asklar/react-native-xaml/main/example/rnx.gif)
25+
![react-native-xaml demo](https://raw.githubusercontent.com/microsoft/react-native-xaml/main/example/rnx.gif)
2626

TechnicalGuide.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -20,18 +20,18 @@ This metadata will then be consumed by the ReactNativeXaml project which is the
2020
- Maps JS type names to constructors of XAML objects. These are used by the RN props to specify how to create a given XAML type from JS.
2121
- Maps JS property names to a list of XAML types that have those properties, as well as what JS type the property is, and information about how to set those properties.
2222
- Maps JS event names to attachment handlers. When a new XAML object is created from react-native-xaml, the library will figure out which events to create event handlers from based on this metadata.
23-
- Maps enum value names to functions that can parse the strings and give back the enum value themselves. This might go away with https://github.com/asklar/react-native-xaml/issues/19.
23+
- Maps enum value names to functions that can parse the strings and give back the enum value themselves. This might go away with https://github.com/microsoft/react-native-xaml/issues/19.
2424

2525
CodeGen will generate metadata for XAML properties if all these conditions are true:
2626
- They are instance properties (non-static), public, and have a setter
2727
- They are a simple type (int, bool, double, string, Color/Brush/SolidColorBrush, Thickness, or an enum), or of type IInspectable (Object).
2828
- They are backed by a DependencyProperty on the type
29-
- Their name does not conflict with an existing ViewProps JS property (e.g. Style, Width, Height, Padding): https://github.com/asklar/react-native-xaml/issues/6
30-
- Support for attached properties is not yet implemented: https://github.com/asklar/react-native-xaml/issues/31
29+
- Their name does not conflict with an existing ViewProps JS property (e.g. Style, Width, Height, Padding): https://github.com/microsoft/react-native-xaml/issues/6
30+
- Support for attached properties is not yet implemented: https://github.com/microsoft/react-native-xaml/issues/31
3131

3232
Properties like Content that are of type IInspectable are mapped to JS object. You can specify a boxed string by passing an object with a string field: `{string: "my string value"}`.
3333

34-
Events are created as long as their names don't conflict with existing registrations (e.g. onKeyUp/onKeyDown is already taken by the RNW framework so those events are not registered by react-native-xaml): https://github.com/asklar/react-native-xaml/issues/32
34+
Events are created as long as their names don't conflict with existing registrations (e.g. onKeyUp/onKeyDown is already taken by the RNW framework so those events are not registered by react-native-xaml): https://github.com/microsoft/react-native-xaml/issues/32
3535

3636
By default, CodeGen will only look for the Windows 10 SDK (10.0.19041.0, version 2004). You can install it from Visual Studio's installer or [here](https://developer.microsoft.com/windows/downloads/windows-10-sdk/).
3737
It is also possible to pass any number of custom WinMD files representing Windows Runtime components. Any UserControls that are defined in those projects will be added to the metadata tables as well as the 19041 SDK XAML types.
@@ -105,4 +105,4 @@ cd node_modules\react-native-xaml
105105
yarn build
106106
```
107107

108-
See the diff to enable the sample UserControl example here: https://github.com/asklar/react-native-xaml/pull/35
108+
See the diff to enable the sample UserControl example here: https://github.com/microsoft/react-native-xaml/pull/35

0 commit comments

Comments
 (0)