Skip to content

Commit b215c32

Browse files
agneszitteagneszitte
committed
docs: Add missing uid and alt text on the entire doc
1 parent 6b44717 commit b215c32

File tree

246 files changed

+1092
-123
lines changed

Some content is hidden

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

246 files changed

+1092
-123
lines changed

‎doc/ReleaseNotes/LegacyReleaseNotes.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
# Release notes
1+
---
2+
uid: Uno.ReleaseNotes.Legacy
3+
---
4+
5+
# Release notes
26

37
### Features
48

‎doc/articles/Uno-UI-Performance.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
uid: Uno.Development.Performance
3+
---
4+
15
# Uno.UI - Performance
26

37
This article lists a number of performance tips to optimize your Uno Platform application.

‎doc/articles/Uno.UI.Toolkit.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
uid: Uno.Development.Toolkit
3+
---
4+
15
# Uno.UI.Toolkit
26

37
Uno.UI.Toolkit is a set of extension methods or behaviors used to enhance UWP and activate device/OS specific features.

‎doc/articles/android-activities.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
uid: Uno.Development.AndroidActivities
3+
---
4+
15
# Managing activities in Android
26

37
[Activities](https://developer.android.com/reference/android/app/Activity) are an integral element of the Android platform. By default your Uno Platform application runs in a single activity, but you might for example spawn a new activity when a user shares content, or picks an image from their device. This article covers Activity management in Uno.

‎doc/articles/api-differences.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
uid: Uno.Development.ApiDifferences
3+
---
4+
15
# Differences between Uno.UI and UWP/WinUI
26

37
Uno Platform strives to closely replicate the UWP/WinUI API on all platforms and ensure that existing WinUI code is 100% compatible with Uno. This article covers areas where Uno.UI's implementation differs, typically to better integrate with the native platform, or where the capabilities of .NET differ due to inherent limitations of the native platform.
@@ -32,4 +36,4 @@ This is as transparent as possible to the application developer. For example, if
3236

3337
Currently, WebAssembly code in the browser executes on a single thread. This limitation is expected to be lifted in the future, but for now, code that expects additional threads to be available may not function as expected.
3438

35-
[This GitHub issue](https://github.com/unoplatform/uno/issues/2302) tracks support for multi-threading on WebAssembly in Uno Platform.
39+
[This GitHub issue](https://github.com/unoplatform/uno/issues/2302) tracks support for multi-threading on WebAssembly in Uno Platform.

‎doc/articles/best-practices-uno.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
uid: Uno.Development.BestPractices
3+
---
4+
15
# Best practices for developing Uno Platform applications
26

37
This article covers some basic best practices when developing cross-platform applications with Uno Platform.

‎doc/articles/composition.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
uid: Uno.Development.Composition
3+
---
4+
15
# Composition API
26

37
Composition Visuals make up the visual tree structure which all other features of the composition API use and build on.

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

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
uid: Uno.Overview.Philosophy
3+
---
4+
15
# Philosophy of Uno Platform
26

37
This document outlines the philosophy of Uno Platform. It guides the development of past and future major architectural decisions.

‎doc/articles/contributing/build-artifacts.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
uid: Uno.Contributing.Artifacts
3+
---
4+
15
# build artifacts
26

37
- Uno publishes a new [pre-release build to NuGet](https://www.nuget.org/packages/Uno.UI) after every merge to master.

‎doc/articles/contributing/guidelines/breaking-changes.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
uid: Uno.Contributing.BreakingChanges
3+
---
4+
15
# Guidelines for breaking changes
26

37
## Overview

‎doc/articles/contributing/guidelines/code-style.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
uid: Uno.Contributing.CodeStyle
3+
---
4+
15
# Guidelines for Code style
26

37
Uno uses EditorConfig ([here's our configuration](https://github.com/unoplatform/uno/blob/master/.editorconfig)) to maintain consistent coding styles and settings in our codebase, such as indent style, tab width, end of line characters, encoding, and more. Most IDEs should respect the `EditorConfig` settings by default when applying formatting. We typically observe the [Microsoft C# Coding Conventions](https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/inside-a-program/coding-conventions) with one notable exception - Uno uses Tabs. If you install this [Visual Studio plugin](https://marketplace.visualstudio.com/items?itemName=mynkow.FormatdocumentonSave) it will automatically format your contributions upon file save.

‎doc/articles/contributing/guidelines/creating-tests.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
uid: Uno.Contributing.CreatingTests
3+
---
4+
15
# Guidelines for creating tests
26

37
Good test coverage is essential to maintaining Uno stable and free of regressions. Appropriate tests are generally a requirement for bugfix and new feature PRs.

‎doc/articles/contributing/guidelines/implementing-a-new winui-winrt-feature.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
uid: Uno.Contributing.ImplementWinUIWinRTAPI
3+
---
4+
15
## Guidelines for implementing a new WinUI/WinRT API
26

37
Implementing a new WinUI/WinRT API generally requires to:

‎doc/articles/contributing/guidelines/issue-triage.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
uid: Uno.Contributing.IssueTriage
3+
---
4+
15
# Guidelines for issue triage
26

37
## Purpose

‎doc/articles/contributing/guidelines/pull-requests.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
uid: Uno.Contributing.PullRequests
3+
---
4+
15
# Guidelines for pull-requests
26

37
If you don't know what a pull request is read this article: https://help.github.com/articles/using-pull-requests.

‎doc/articles/contributing/guidelines/updating-dependencies.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
uid: Uno.Contributing.UpdatingDependencies
3+
---
4+
15
# Guidelines for updating dependencies
26

37
We use Dependabot to notify the team of any updates to dependencies. Once a week the robot will scan our dependencies and raise a pull-request if a new version is found. If an existing open pull-request is found for a dependency it will be closed and replaced with a new pull-request. The behavior of the robot is [controlled by this configuration file](https://github.com/unoplatform/Uno/blob/master/.dependabot/config.yml).

‎doc/articles/controls/ComboBox.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
uid: Uno.Controls.ComboBox
3+
---
4+
15
# ComboBox in Uno.UI
26

37
The `ComboBox` is designed to select a value in a set of items. For more info about its usage,

‎doc/articles/controls/CommandBar.md

+42-38
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
uid: Uno.Controls.CommandBar
3+
---
4+
15
# CommandBar
26

37
The `CommandBar` in **Uno** is designed to be used the same way you would use the `CommandBar` on **UWP**. In most cases, you should refer to the [official `CommandBar` documentation](https://docs.microsoft.com/en-us/uwp/api/windows.ui.xaml.controls.commandbar).
@@ -17,7 +21,7 @@ The `CommandBar` supports 2 different modes:
1721

1822
This mode replicates **UWP**'s `CommandBar`. It is templatable and supports a template that's almost identical to **UWP**'s default `CommandBar`.
1923

20-
![](assets/commandbar/windows/example.png)
24+
![CommandBar Example - Windows](assets/commandbar/windows/example.png)
2125

2226
#### Usage Example
2327

@@ -34,9 +38,9 @@ This mode replicates **UWP**'s `CommandBar`. It is templatable and supports a te
3438

3539
This mode is the preferred one and is enabled by default. It uses platform-specific controls to ensure a more native user experience.
3640

37-
![](assets/commandbar/android/example.png)
41+
![CommandBar Example - Android](assets/commandbar/android/example.png)
3842

39-
![](assets/commandbar/ios/example.png)
43+
![CommandBar Example - iOS](assets/commandbar/ios/example.png)
4044

4145
| Platform | Native control | Benefits |
4246
|----------|---------------------|-------------------------------------------------------|
@@ -63,9 +67,9 @@ You must use `VisibleBoundsPadding.PaddingMask="Top"` on `CommandBar` to properl
6367

6468
An important difference with this mode is the presence of a back button. Whenever the `CommandBar` is part of a `Page` whose `Frame` has a non-empty back stack, the back button will be displayed.
6569

66-
![](assets/commandbar/android/back.png)
70+
![CommandBar Example - Android - Back button](assets/commandbar/android/back.png)
6771

68-
![](assets/commandbar/ios/back.png)
72+
![CommandBar Example - iOS - Back button](assets/commandbar/ios/back.png)
6973

7074
On **Android**, tapping the back button triggers `SystemNavigationService.BackRequested`. It's the responsibility of the application's navigation controller to eventually call `Frame.GoBack()`.
7175

@@ -96,9 +100,9 @@ On **iOS**, tapping the back button automatically triggers a back navigation on
96100

97101
Gets or sets a brush that describes the background of a control.
98102

99-
![](assets/commandbar/android/background.png)
103+
![CommandBar Example - Android - Background](assets/commandbar/android/background.png)
100104

101-
![](assets/commandbar/ios/background.png)
105+
![CommandBar Example - iOS - Background](assets/commandbar/ios/background.png)
102106

103107
#### Remarks
104108

@@ -115,9 +119,9 @@ The `Content` is processed differently whether it's of type `string` or `Framewo
115119

116120
When `Content` is a `string`, it's displayed using the platform's default font family, font size, font style and text alignment. Only the foreground color can be changed, using `Foreground`.
117121

118-
![](assets/commandbar/android/content-string.png)
122+
![CommandBar Example - Android - When Content is a `string`](assets/commandbar/android/content-string.png)
119123

120-
![](assets/commandbar/ios/content-string.png)
124+
![CommandBar Example - iOS - When Content is a `string`](assets/commandbar/ios/content-string.png)
121125

122126
| Platform | FontFamily | FontSize | HorizontalAlignment |
123127
|----------|---------------|----------|---------------------|
@@ -126,9 +130,9 @@ When `Content` is a `string`, it's displayed using the platform's default font f
126130

127131
When `Content` is a `FrameworkElement`, it's displayed within the available area:
128132

129-
![](assets/commandbar/android/content-frameworkelement.png)
133+
![CommandBar Example - Android - When Content is a `FrameworkElement`](assets/commandbar/android/content-frameworkelement.png)
130134

131-
![](assets/commandbar/ios/content-frameworkelement.png)
135+
![CommandBar Example - iOS - When Content is a `FrameworkElement`](assets/commandbar/ios/content-frameworkelement.png)
132136

133137
| Platform | Available height |
134138
|----------|:----------------:|
@@ -143,9 +147,9 @@ Please note that:
143147

144148
Gets or sets a brush that describes the foreground color.
145149

146-
![](assets/commandbar/android/foreground.png)
150+
![CommandBar Example - Android - Foreground](assets/commandbar/android/foreground.png)
147151

148-
![](assets/commandbar/ios/foreground.png)
152+
![CommandBar Example - iOS - Foreground](assets/commandbar/ios/foreground.png)
149153

150154
#### Remarks
151155

@@ -159,9 +163,9 @@ Gets or sets a brush that describes the foreground color.
159163

160164
Gets the collection of primary command elements for the `CommandBar`.
161165

162-
![](assets/commandbar/android/primarycommands.png)
166+
![CommandBar Example - Android - PrimaryCommands](assets/commandbar/android/primarycommands.png)
163167

164-
![](assets/commandbar/ios/primarycommands.png)
168+
![CommandBar Example - iOS - PrimaryCommands](assets/commandbar/ios/primarycommands.png)
165169

166170
#### Remarks
167171

@@ -172,9 +176,9 @@ Gets the collection of primary command elements for the `CommandBar`.
172176

173177
Gets the collection of secondary command elements for the `CommandBar`.
174178

175-
![](assets/commandbar/android/secondarycommands.png)
179+
![CommandBar Example - Android - SecondaryCommands](assets/commandbar/android/secondarycommands.png)
176180

177-
![](assets/commandbar/android/secondarycommands-popup.png)
181+
![CommandBar Example - iOS - SecondaryCommands](assets/commandbar/android/secondarycommands-popup.png)
178182

179183
#### Remarks
180184

@@ -217,9 +221,9 @@ Extensions to extend the functionality of `CommandBar` can be found in the `Comm
217221

218222
Gets or sets the back button foreground for the `CommandBar`.
219223

220-
![](assets/commandbar/android/backbuttonforeground.png)
224+
![CommandBar Example - Android - BackButtonForeground](assets/commandbar/android/backbuttonforeground.png)
221225

222-
![](assets/commandbar/ios/backbuttonforeground.png)
226+
![CommandBar Example - iOS - BackButtonForeground](assets/commandbar/ios/backbuttonforeground.png)
223227

224228
#### Remarks
225229

@@ -229,9 +233,9 @@ Gets or sets the back button foreground for the `CommandBar`.
229233

230234
Gets or sets the back button icon for the `CommandBar`.
231235

232-
![](assets/commandbar/android/backbuttonicon.png)
236+
![CommandBar Example - Android - BackButtonIcon](assets/commandbar/android/backbuttonicon.png)
233237

234-
![](assets/commandbar/ios/backbuttonicon.png)
238+
![CommandBar Example - iOS - BackButtonIcon](assets/commandbar/ios/backbuttonicon.png)
235239

236240
#### Remarks
237241

@@ -241,7 +245,7 @@ Gets or sets the back button icon for the `CommandBar`.
241245

242246
Gets or sets the back button title for the `CommandBar`.
243247

244-
![](assets/commandbar/ios/backbuttontitle.png)
248+
![CommandBar Example - iOS - BackButtonTitle](assets/commandbar/ios/backbuttontitle.png)
245249

246250
#### Remarks
247251

@@ -259,9 +263,9 @@ To remove the back button title from all pages (and only leave the back arrow),
259263

260264
Gets or sets the elevation of the `UIElement`.
261265

262-
![](assets/commandbar/android/elevation.png)
266+
![CommandBar Example - Android - Elevation](assets/commandbar/android/elevation.png)
263267

264-
![](assets/commandbar/ios/elevation.png)
268+
![CommandBar Example - iOS - Elevation](assets/commandbar/ios/elevation.png)
265269

266270
#### Remarks
267271

@@ -272,9 +276,9 @@ Gets or sets the elevation of the `UIElement`.
272276

273277
Gets or sets the navigation command for the `CommandBar`.
274278

275-
![](assets/commandbar/android/navigationcommand.png)
279+
![CommandBar Example - Android - NavigationCommand](assets/commandbar/android/navigationcommand.png)
276280

277-
![](assets/commandbar/ios/navigationcommand.png)
281+
![CommandBar Example - iOS - NavigationCommand](assets/commandbar/ios/navigationcommand.png)
278282

279283
#### Remarks
280284

@@ -293,7 +297,7 @@ On **Android**, only icons are supported (`AppBarButton.Icon`). This is due to a
293297

294298
Gets or sets the subtitle for the `CommandBar`.
295299

296-
![](assets/commandbar/android/subtitle.png)
300+
![CommandBar Example - Android - Subtitle](assets/commandbar/android/subtitle.png)
297301

298302
#### Remarks
299303

@@ -348,9 +352,9 @@ When `AppBarButton` is used within a native `CommandBar`, its control template i
348352

349353
Gets or sets a brush that describes the foreground color.
350354

351-
![](assets/commandbar/android/appbarbutton-foreground.png)
355+
![CommandBar AppBarButton Example - Android - Foreground](assets/commandbar/android/appbarbutton-foreground.png)
352356

353-
![](assets/commandbar/ios/appbarbutton-foreground.png)
357+
![CommandBar AppBarButton Example - iOS - Foreground](assets/commandbar/ios/appbarbutton-foreground.png)
354358

355359
#### Remarks
356360

@@ -363,9 +367,9 @@ Gets or sets a brush that describes the foreground color.
363367

364368
Gets or sets the content of a `ContentControl`.
365369

366-
![](assets/commandbar/android/appbarbutton-content.png)
370+
![CommandBar AppBarButton Example - Android - Content](assets/commandbar/android/appbarbutton-content.png)
367371

368-
![](assets/commandbar/ios/appbarbutton-content.png)
372+
![CommandBar AppBarButton Example - iOS - Content](assets/commandbar/ios/appbarbutton-content.png)
369373

370374
#### Remarks
371375

@@ -379,9 +383,9 @@ Gets or sets the content of a `ContentControl`.
379383

380384
Gets or sets the graphic content of the app bar button.
381385

382-
![](assets/commandbar/android/appbarbutton-icon.png)
386+
![CommandBar AppBarButton Example - Android - Icon](assets/commandbar/android/appbarbutton-icon.png)
383387

384-
![](assets/commandbar/ios/appbarbutton-icon.png)
388+
![CommandBar AppBarButton Example - iOS - Icon](assets/commandbar/ios/appbarbutton-icon.png)
385389

386390
#### Remarks
387391

@@ -399,9 +403,9 @@ Gets or sets the graphic content of the app bar button.
399403

400404
Gets or sets the text description displayed on the app bar button.
401405

402-
![](assets/commandbar/android/appbarbutton-tooltip.png)
406+
![CommandBar AppBarButton Example - Android - Label](assets/commandbar/android/appbarbutton-tooltip.png)
403407

404-
![](assets/commandbar/android/secondarycommands-popup.png)
408+
![CommandBar AppBarButton Example - iOS - Label](assets/commandbar/android/secondarycommands-popup.png)
405409

406410
#### Remarks
407411

@@ -415,9 +419,9 @@ It is highly recommended to set and localize `Label` on all `AppBarButton`s, if
415419

416420
Gets or sets a value indicating whether the user can interact with the control.
417421

418-
![](assets/commandbar/android/appbarbutton-disabled.png)
422+
![CommandBar AppBarButton Example - Android - Disabled](assets/commandbar/android/appbarbutton-disabled.png)
419423

420-
![](assets/commandbar/ios/appbarbutton-disabled.png)
424+
![CommandBar AppBarButton Example - iOS - Disabled](assets/commandbar/ios/appbarbutton-disabled.png)
421425

422426
#### Remarks
423427

@@ -791,7 +795,7 @@ Gets or sets a value indicating whether the user can interact with the control.
791795
</Grid>
792796
```
793797

794-
![](assets/commandbar/ios/transparent.png)
798+
![CommandBar Example - iOS - Transparent Background](assets/commandbar/ios/transparent.png)
795799

796800
- > What size should my AppBarButton icons be?
797801

0 commit comments

Comments
 (0)