Skip to content

docs: Windows platform - #201

Open
triniwiz wants to merge 1 commit into
mainfrom
chore/windows
Open

triniwiz wants to merge 1 commit into
mainfrom
chore/windows

Conversation

@triniwiz

Copy link
Copy Markdown
Member

Adds documentation for the experimental Windows platform (WinUI 3 / Windows App SDK). The Windows content goes next to the existing Android and iOS content, and every Windows page and section is marked experimental.

New pages

  • Developing for Windows (guide/windows/): requirements, adding the platform, running, platform-specific code (.windows.ts, __WINDOWS__, <windows>, .ns-windows), native API access, plugins and known limitations.
  • Windows Marshalling: WinRT ↔ JS type mapping, structs, date/time, collections, out parameters, events with NSWinRT.asDelegate, async with NSWinRT.toPromise, .NET and Win32.
  • Adding Windows native code: App_Resources/Windows/app.csproj, NuGet packages, your own C#, C++/WinRT components, Win32 DLLs, plugin native folders.
  • Extending WinRT classes and implementing interfaces
  • Publishing to the Microsoft Store: signed MSIX for sideloading, and .msixupload for Partner Center.

Updated pages

  • Setup: a Windows column in the setup matrix and a "Windows desktop" setup guide (.NET 10 SDK, Developer Mode, ns doctor windows).
  • Workflow: running, CLI basics and debugging (ns debug windows, inspector port 43000, --debug-brk/--start, console and crash logs, Visual Studio).
  • Configuration: the windows.* section of the config reference, App_Resources/Windows (manifest, logos, display name and splash properties, DPI awareness), and __WINDOWS__ / --env.windows in the Vite and webpack references.
  • Concepts: metadata, multithreading, typings (ns typings windows), styling, platform-file splitting and troubleshooting.
  • UI: the WinUI 3 native component on every UI component page.
  • Navigation: the sidebar.

Depends on

  • NativeScript/nativescript-cli feat/windows: the debug URL on port 43000, the doctor checks, and the --no-auto-guid fix.
  • feat: start the inspector for ns debug windows on port 43000 windows#19: inspector start and --debug-brk.
  • The App_Resources page links to shared-mobile/App_Resources/Windows in nativescript-app-templates main. That folder is still on the templates repo's feat/windows branch.

Checked with prettier and textlint; every internal link and anchor these pages add resolves.

Covers setup, running, debugging, publishing to the Microsoft Store, App_Resources/Windows, the windows config block, marshalling, native code, subclassing and the WinUI 3 native component of each UI element.
@coderabbitai

coderabbitai Bot commented Sep 30, 2026

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Advanced

Run ID: 67a36003-60f6-45d6-9aa6-5ba41de2eeba

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying nativescript-docs-latest with  Cloudflare Pages  Cloudflare Pages

Latest commit: 2866022
Status: ✅  Deploy successful!
Preview URL: https://74274ff3.nativescript-docs-beta.pages.dev
Branch Preview URL: https://chore-windows.nativescript-docs-beta.pages.dev

View logs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant