unoplatform/uno

[Docs] Mapping (Xamarin.Essentials)/.NET MAUI Platform APIs to WinRT APIs

Open

#16,665 opened on May 9, 2024

View on GitHub
 (3 comments) (0 reactions) (0 assignees)C# (9,789 stars) (837 forks)batch import
difficulty/starter 🚀good first issuekind/documentation

Description

Description

The .NET MAUI documentation currently includes information on Platform APIs, which were formerly known as Essentials. https://learn.microsoft.com/en-us/dotnet/maui/platform-integration/?view=net-maui-8.0 To aid developers transitioning from (Xamarin.Essentials)/.NET MAUI Platform APIs to WinRT APIs, a comprehensive guide is essential. This guide should detail the API mappings, supported platforms, and necessary setup, and include practical usage examples.

Proposed content for this guide

  1. API Mapping Guide

    • Develop a detailed correspondence table or list mapping each (Xamarin.Essentials)/.NET MAUI Platform APIs to the WinRT APIs counterpart.
    • Highlight differences in API functionality or any limitations.

  2. Platform Support

    • Document the supported platforms for each of those.
    • Note any platforms that are no longer supported or have known issues as needed.

  3. Setup Instructions

    • Provide detailed setup instructions for each platform to assist developers in transitioning their projects.

  4. Usage Examples

    • Include samples & code examples showing how to utilize WinRT APIs to replace (Xamarin.Essentials)/.NET MAUI Platform functionalities.
    • Focus on common use cases previously handled by (Xamarin.Essentials)/.NET MAUI Platform functionalities.

cc @dansiegel, @jeromelaban

Contributor guide

Tech stack
csharp
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
3-5 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
C# knowledgeXamarin.Essentials/.NET MAUI APIsWinRT APIsUno Platform basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Start by reviewing the existing .NET MAUI platform integration documentation at https://learn.microsoft.com/en us/dotnet/maui/platform integration/?view=net maui 8.0. Identify each API and research its WinRT counterpart, noting any differences in functionality or limitations. Consult the tagged maintainers (@dansiegel, @jeromelaban) for clarification on specific mappings. Then create a detailed correspondence table, setup instructions, and usage examples. No open PRs or assignees exist, so this is available for contribution.