csharp

Native Module C# Sample - React Native for Windows

See ../README.md for details of this sample.

See ../cppwinrt/ for a C++/WinRT version of this sample.

Note: Don't build your own projects directly out of this sample. When you publish a native module (as source), you'll want to create a new project with the correct metadata. This will also make sure that you're using unique identifiers in your project files to avoid conflicts with other native modules.

Setup

See ../README.md#Setup.

Run

See ../README.md#Run.

Upgrade

To upgrade this sample to the latest version of RNW:

1. Open a command prompt and navigate to this folder.
2. Delete the windows folder:

   rd /s /q windows

3. Upgrade dev dependencies to the versions of react and react-native needed by react-native-windows@latest:
   1. Option A: Use the UpgradeSmokeTest.ps1 helper script (Recommended on Windows Powershell):

      ..\..\..\.github\scripts\UpgradeSmokeTest.ps1 latest

   2. Option B: Update the package.json by hand:
      1. Look up the version of react required by react-native-windows@latest:

         npm info react-native-windows@latest devDependencies.react

      2. Upgrade react to that version:

         yarn upgrade react@VERSIONFROMLASTSTEP

      3. Look up the version of react-native required by react-native-windows@latest:

         npm info react-native-windows@latest devDependencies.react-native

      4. Upgrade react-native to that version:

         yarn upgrade react-native@VERSIONFROMLASTSTEP

      5. Upgrade react-native-windows to the latest version:

         yarn upgrade react-native-windows@latest

4. Re-run the RNW CLI:

   npx @react-native-community/cli@latest init-windows --template old/uwp-cs-lib --overwrite

5. Restore these original native files (representing the native module samples):

   git restore windows\NativeModuleSample\AsyncMethodExamples.cs
   git restore windows\NativeModuleSample\DataMarshallingExamples.cs
   git restore windows\NativeModuleSample\FancyMath.cs
   

6. Remove these new native files:

   del windows\NativeModuleSample\ReactNativeModule.cs
   

7. Referring to a diff of the modified files, make the following updates:
   1. For windows\NativeModuleSample\NativeModuleSample.csproj:
      1. Restore the <Compile> entries for the files restored in Step 5:

         + <Compile Include="AsyncMethodExamples.cs" />
         + <Compile Include="DataMarshallingExamples.cs" />
         + <Compile Include="FancyMath.cs" />

      2. Remove the <Compile> entries for the files removed in Step 6:

         - <Compile Include="ReactNativeModule.cs" />

      3. Check if the <ProjectGuid> property at the top of the file has been updated. If so, take note of the new Guid (for later) and restore the original Guid.
   2. For windows\NativeModuleSample\NativeModulesSample.sln:
      1. If the project guid was changed in Step 7.1.3 above, you'll want to restore the original Guid here too. The easiest way to do this is to just do a find-replace on the new Guid with the (uppercased) old one.
   3. For ReactPackageProvider.cs:
      1. Restore the copyright notice at the top of the file:

         + // Copyright (c) Microsoft Corporation. All rights reserved.
         + // Licensed under the MIT License.
         + 

8. Verify the updated sample builds:

   npx @react-native-community/cli@latest run-windows --no-deploy --no-launch --no-packager --no-autolink --proj "NativeModuleSample\NativeModuleSample.csproj"
   

9. Update the main readme with the new major version at the top.