Skip to content

Commit b171586

Browse files
jeromelabanjeromelaban
committed
docs: Misc docs updates
1 parent 74a3a6b commit b171586

File tree

110 files changed

+951
-981
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

110 files changed

+951
-981
lines changed

Diff for: ‎README.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,11 @@ For a larger example and features demo:
3333
# Uno Platform Features
3434
* Supported platforms:
3535
* Windows 10 and Windows 11
36-
* Windows 7 (via Skia+WPF)
37-
* iOS, Mac Catalyst and Android (via [Xamarin](https://www.visualstudio.com/xamarin/) and [.NET](https://dotnet.microsoft.com/))
36+
* Windows 7 (via Skia Desktop)
37+
* iOS, MacOS (Catalyst) and Android (via [.NET](https://dotnet.microsoft.com/))
3838
* WebAssembly through the [.NET Runtime WebAssembly SDK](https://github.com/dotnet/runtime/tree/main/src/mono/wasm)
39-
* Linux through Skia (Gtk and FrameBuffer)
39+
* Linux (via Skia Desktop with X11 and FrameBuffer)
40+
* macOS (via Skia Desktop)
4041
* Dev loop:
4142
* Develop on Windows first using Visual Studio
4243
* [XAML Hot Reload](https://blogs.msdn.microsoft.com/visualstudio/2016/04/06/ui-development-made-easier-with-xaml-edit-continue/) for live XAML edition on each keystroke

Diff for: ‎build/cSpell.json

+1
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@
2525
"datacontext",
2626
"datagrid",
2727
"devs",
28+
"dbus",
2829
"Dismissable",
2930
"Docfx",
3031
"ellipsize",

Diff for: ‎doc/articles/Assets/font-ios.png

-19.6 KB
Binary file not shown.

Diff for: ‎doc/articles/Assets/quick-start/live-wizard-01-choose-name.png

-20 KB
Loading

Diff for: ‎doc/articles/Assets/quick-start/live-wizard-02-select-preset.png

-50.7 KB
Loading

Diff for: ‎doc/articles/Assets/quick-start/live-wizard-03-create-app.png

-66 KB
Loading

Diff for: ‎doc/articles/Assets/quick-start/net7-ios-debug.png

-12.1 KB
Binary file not shown.

Diff for: ‎doc/articles/Assets/quick-start/net8-android-debug.png

26 KB
Loading

Diff for: ‎doc/articles/Assets/quick-start/net8-ios-debug.png

21.8 KB
Loading

Diff for: ‎doc/articles/Assets/quick-start/vs-mac-open-project.png

-100 KB
Binary file not shown.

Diff for: ‎doc/articles/Assets/solution-structure.png

362 Bytes
Loading

Diff for: ‎doc/articles/Assets/tutorial01/vsix-new-project-options.png

-11.8 KB
Loading

Diff for: ‎doc/articles/Uno-UI-Performance.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ Here's what to look for:
9393

9494
- Resources
9595
- Avoid using `x:Name` in `ResourceDictionary` as those force early instantiation of the resource
96-
- Use [`Uno.XamlMerge.Task`](https://github.com/unoplatform/uno.xamlmerge.task) to merge all top-level `AppResources.xaml` or `App.xaml` resource dictionaries
96+
- Use [`Uno.XamlMerge.Task`](https://github.com/unoplatform/uno.xamlmerge.task) to merge all top-level `App.xaml` resource dictionaries
9797

9898
## WebAssembly specifics
9999

Diff for: ‎doc/articles/common-issues-vs2022.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ C# Hot Reload is provided by Visual Studio 2022, and there may be occasions wher
1818

1919
If that is the case:
2020

21-
- Make sure that the top left selector in the C# editor is showing the project head being debugged. For instance, if debugging the Skia.Gtk, select the Skia.Gtk project.
21+
- Make sure that the top left selector in the C# editor is showing the project head being debugged. For instance, if debugging with `net8.0-desktop`, select the `net8.0-desktop` project.
2222
- WebAssembly does not support C# hot reload when debugging the application. You can start the app without the debugger instead.
2323
- Try recompiling the application completely (with the `Rebuild` command)
2424

Diff for: ‎doc/articles/common-issues.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ More troubleshooting information is available [in this section](xref:Uno.Feature
2424
## Platforms
2525

2626
- [Common issues on WebAssembly](xref:Uno.UI.CommonIssues.Wasm)
27-
- [Common issues on Skia (Gtk/WPF/Framebuffer)](xref:Uno.UI.CommonIssues.Skia)
27+
- [Common issues on Skia (X11/macOS/Framebuffer/Windows)](xref:Uno.UI.CommonIssues.Skia)
2828
- [Common issues on iOS/mac Catalyst](xref:Uno.UI.CommonIssues.IosCatalyst)
2929

3030
## Next Steps

Diff for: ‎doc/articles/composition.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ _There are a few known issues associated with the used of the compositor thread,
3737

3838
## Brush Anti-aliasing [Skia Backends]
3939

40-
On Skia targets (GTK and WPF), anti-aliasing is disabled by default for brushes, You can request it to be anti-aliased by setting this in your application's constructor:
40+
On Skia Desktop targets (X11, Framebuffer, macOS, and Windows), anti-aliasing is disabled by default for brushes, You can request it to be anti-aliased by setting this in your application's constructor:
4141

4242
```csharp
4343
#if HAS_UNO

Diff for: ‎doc/articles/concepts/overview/philosophy-of-uno.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ This document outlines the philosophy of Uno Platform. It guides the development
1111
We stand on the shoulders of giants, Microsoft's tooling is a treat to work with:
1212

1313
- [Edit and Continue](https://learn.microsoft.com/visualstudio/debugger/edit-and-continue)
14-
- [Live Visual Tree](https://learn.microsoft.com/visualstudio/debugger/inspect-xaml-properties-while-debugging).
14+
- [Live Visual Tree](https://learn.microsoft.com/visualstudio/debugger/inspect-xaml-properties-while-debugging)
1515
- [XAML Hot Reload](https://learn.microsoft.com/visualstudio/debugger/xaml-hot-reload?view=vs-2019)
1616

1717
The promise of the Uno Platform is to enable building your app with those tools and then deploying it to WebAssembly, iOS, Android, macOS, and Linux.

Diff for: ‎doc/articles/concepts/overview/why-uno-platform.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ Uno.Extensions Authentication is a provider-based authentication service that ca
154154

155155
## Skia drawing
156156

157-
The Uno Platform provides access to SkiaSharp as a render canvas for your app, enabling rich support to fine grained drawing primitives. Uno Platform also uses SkiaSharp to render the UI for GTK, WPF, and FrameBuffer apps.
157+
The Uno Platform provides access to SkiaSharp as a render canvas for your app, enabling rich support for fine-grained drawing primitives. Uno Platform also uses SkiaSharp to render the UI for X11, FrameBuffer, macOS, and Windows 7+ apps.
158158

159159
## Animations: Beyond storyboards, access to Lottie and Rive
160160

Diff for: ‎doc/articles/controls/MediaPlayerElement.md

+44-43
Original file line numberDiff line numberDiff line change
@@ -8,20 +8,20 @@ See [Microsoft API reference for MediaPlayerElement](https://learn.microsoft.com
88

99
## Media formats
1010

11-
| Supported Formats | iOS | Android | Wasm | Skia GTK | Remarks |
12-
|----------------------------|:---:|:-------:|:----:|:--------:|------------------------------------------------------------------------------|
13-
| Local/Remote MP3 Support | ✅ | ✅ | ✅ | ✅ | |
14-
| Local/Remote MPEG4 Support | ✅ | ✅ | ✅ | ✅ | |
15-
| HLSv3 Support | ✅ | ✅ | ✅ | ✅ | |
16-
| HLSv4 Support | ✅ | ✅ | ✅ | ✅ | |
17-
| 3GP Support | ✅ | ✅ | ✅ | ✅ | 3GP with AMR Narrow Band (SAMR) audio codec does not work on iOS (See notes) |
18-
| FLV Support | - | ✅ | ✅ | ✅ | |
19-
| MOV Support | ✅ | - | - | - | |
20-
| MKV Support | - | ✅ | ✅ | ✅ | |
21-
| AVI Support | - | ✅ | ✅ | ✅ | |
22-
| OGG Support | - | - | ✅ | ✅ | |
23-
| MPEG-Dash Support | - | - | - | - | |
24-
| Smooth Streaming Support | - | - | - | - | |
11+
| Supported Formats | iOS | Android | Wasm | Skia GTK | Skia Desktop | Remarks |
12+
|----------------------------|:----:|:---------:|:------:|:---------:|:---------:|------------------------------------------------------------------------------|
13+
| Local/Remote MP3 Support | ✅ | ✅ | ✅ | ✅ | ❌ | |
14+
| Local/Remote MPEG4 Support | ✅ | ✅ | ✅ | ✅ | ❌ | |
15+
| HLSv3 Support | ✅ | ✅ | ✅ | ✅ | ❌ | |
16+
| HLSv4 Support | ✅ | ✅ | ✅ | ✅ | ❌ | |
17+
| 3GP Support | ✅ | ✅ | ✅ | ✅ | ❌ |3GP with AMR Narrow Band (SAMR) audio codec does not work on iOS (See notes) |
18+
| FLV Support | - | ✅ | ✅ | ✅ | ❌ | |
19+
| MOV Support | ✅ | - | - | - | ❌ | |
20+
| MKV Support | - | ✅ | ✅ | ✅ | ❌ | |
21+
| AVI Support | - | ✅ | ✅ | ✅ | ❌ | |
22+
| OGG Support | - | - | ✅ | ✅ | ❌ | |
23+
| MPEG-Dash Support | - | - | - | - | ❌ | |
24+
| Smooth Streaming Support | - | - | - | - | ❌ | |
2525

2626
### Notes
2727

@@ -30,35 +30,35 @@ See [Microsoft API reference for MediaPlayerElement](https://learn.microsoft.com
3030

3131
## Features
3232

33-
| Section | Feature | iOS | Android | Wasm | Skia GTK | Remarks |
34-
|--------------------|------------------------------------------------|:---:|:-------:|:----:|:--------:|----------------------------------------------|
35-
| MediaPlayerElement | AutoPlay | ✅ | ✅ | ✅ | ✅ | |
36-
| | Poster image | ✅ | ✅ | ✅ | ✅ | Does not show when playing music |
37-
| | Enable/Disable MediaTransportControls | ✅ | ✅ | ✅ | ✅ | |
38-
| | Stretch | ✅ | ✅ | ✅ | ✅ | Stretch.None behave like Stretch.Fill on iOS |
39-
| | Pause media when headphones unplugged | ✅ | ✅ | - | - | |
40-
| TransportControls | Transport controls custom style | ✅ | ✅ | ✅ | ✅ | |
41-
| | Play/Pause | ✅ | ✅ | ✅ | ✅ | |
42-
| | Stop | ✅ | ✅ | ✅ | ✅ | |
43-
| | Seek | ✅ | ✅ | ✅ | ✅ | |
44-
| | Volume change | ✅ | ✅ | ✅ | ✅ | |
45-
| | Mute | ✅ | ✅ | ✅ | ✅ | |
46-
| | Show elapsed time | ✅ | ✅ | ✅ | ✅ | |
47-
| | Show remaining time | ✅ | ✅ | ✅ | ✅ | |
48-
| | Show/Hide MediaTransportControls automatically | ✅ | ✅ | ✅ | ✅ | |
49-
| | MediaTransportControls compact mode | ✅ | ✅ | ✅ | ✅ | |
50-
| | Show/Hide MediaTransportControls commands | ✅ | ✅ | ✅ | ✅ | |
51-
| | Enable/Disable MediaTransportControls commands | ✅ | ✅ | ✅ | ✅ | |
52-
| | Skip forward | ✅ | ✅ | ✅ | ✅ | |
53-
| | Skip backward | ✅ | ✅ | ✅ | ✅ | |
54-
| | Show buffering progress | ✅ | ✅ | ✅ | ✅ | |
55-
| | Zoom mode | ✅ | ✅ | ✅ | ✅ | |
56-
| | Full-screen mode | ✅ | ✅ | ✅ | ✅ | |
57-
| | Playlists support | ✅ | ✅ | - | - | |
58-
| | Change playback rate | - | - | ✅ | ✅ | |
59-
| | Player controls on locked screen support | - | - | - | - | |
60-
| | Subtitles support | - | - | - | - | |
61-
| | Languages support | - | - | - | - | |
33+
| Section | Feature | iOS | Android | Wasm | Skia GTK | Skia Desktop | Remarks |
34+
|--------------------|------------------------------------------------|:---:|:-------:|:----:|:--------:|:--------:|------------------------------------------------|
35+
| MediaPlayerElement | AutoPlay | ✅ | ✅ | ✅ | ✅ | ❌ | |
36+
| | Poster image | ✅ | ✅ | ✅ | ✅ | ❌ | Does not show when playing music |
37+
| | Enable/Disable MediaTransportControls | ✅ | ✅ | ✅ | ✅ | ❌ | |
38+
| | Stretch | ✅ | ✅ | ✅ | ✅ | ❌ | Stretch.None behave like Stretch.Fill on iOS |
39+
| | Pause media when headphones unplugged | ✅ | ✅ | - | - | ❌ | |
40+
| TransportControls | Transport controls custom style | ✅ | ✅ | ✅ | ✅ | ❌ | |
41+
| | Play/Pause | ✅ | ✅ | ✅ | ✅ | ❌ | |
42+
| | Stop | ✅ | ✅ | ✅ | ✅ | ❌ | |
43+
| | Seek | ✅ | ✅ | ✅ | ✅ | ❌ | |
44+
| | Volume change | ✅ | ✅ | ✅ | ✅ | ❌ | |
45+
| | Mute | ✅ | ✅ | ✅ | ✅ | ❌ | |
46+
| | Show elapsed time | ✅ | ✅ | ✅ | ✅ | ❌ | |
47+
| | Show remaining time | ✅ | ✅ | ✅ | ✅ | ❌ | |
48+
| | Show/Hide MediaTransportControls automatically | ✅ | ✅ | ✅ | ✅ | ❌ | |
49+
| | MediaTransportControls compact mode | ✅ | ✅ | ✅ | ✅ | ❌ | |
50+
| | Show/Hide MediaTransportControls commands | ✅ | ✅ | ✅ | ✅ | ❌ | |
51+
| | Enable/Disable MediaTransportControls commands | ✅ | ✅ | ✅ | ✅ | ❌ | |
52+
| | Skip forward | ✅ | ✅ | ✅ | ✅ | ❌ | |
53+
| | Skip backward | ✅ | ✅ | ✅ | ✅ | ❌ | |
54+
| | Show buffering progress | ✅ | ✅ | ✅ | ✅ | ❌ | |
55+
| | Zoom mode | ✅ | ✅ | ✅ | ✅ | ❌ | |
56+
| | Full-screen mode | ✅ | ✅ | ✅ | ✅ | ❌ | |
57+
| | Playlists support | ✅ | ✅ | - | - | ❌ | |
58+
| | Change playback rate | - | - | ✅ | ✅ | ❌ | |
59+
| | Player controls on locked screen support | - | - | - | - | ❌ | |
60+
| | Subtitles support | - | - | - | - | ❌ | |
61+
| | Languages support | - | - | - | - | ❌ | |
6262

6363
## Requirement
6464

@@ -125,6 +125,7 @@ Running the `MediaPlayerElement` requires adding the [`VideoLAN.LibVLC.Windows`]
125125

126126
## Future improvement
127127

128+
- Support for Skia Desktop `net8.0-desktop`
128129
- React to audio focus changes (pause/stop playback or reduce audio volume)
129130
- Subtitles support
130131
- Languages support

Diff for: ‎doc/articles/controls/map-control-support.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ The current implementation uses the native UIKit Map for iOS and the Google Play
1515
## How to use MapControl in an Uno Platform app
1616

1717
1. Install the [Uno.WinUI.Maps NuGet package](https://www.nuget.org/packages/Uno.WinUI.Maps/) in the Android and/or iOS head projects of your app.
18-
1. Add the `MapResources` resource dictionary to `Application.Resources` in your `AppResources.xaml` or `App.xaml` file:
18+
1. Add the `MapResources` resource dictionary to `Application.Resources` in your `App.xaml` file:
1919

2020
```xml
2121
<Application.Resources>

0 commit comments

Comments
 (0)