docs: Adding csharp markup code examples #1309
Open
+323
−190
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dansiegel
reviewed
Dec 18, 2023
kazo0
reviewed
Dec 21, 2023
| @@ -4,31 +4,61 @@ uid: Uno.Themes.Material.Extensions | |||
|
|
|||
| # Material Control Extensions | |||
|
|
|||
| > [!NOTE] | |||
| > Uno Material also has support for C# Markup through a [Uno.Material.WinUI.Markup](https://www.nuget.org/packages/Uno.Material.WinUI.Markup) NuGet Package. To get started with Uno Material in your C# Markup application, add the `Uno.Material.WinUI.Markup` NuGet package to your **App Code Library** project and your platform heads. | |||
There was a problem hiding this comment.
We can link back to the Getting Started section that mentions C# Markup with an xref here
There was a problem hiding this comment.
Huum, I removed the Using C# Markup section from that page, since all the C# Markup code is now integrated in the tabs with the Xaml ones, and added a similar note to that page instead:
Uno.Themes/doc/material-getting-started.md
Lines 37 to 38 in 931cbd5
Do you think it's better to bring back that section?
Youssef1313
reviewed
Jan 18, 2024
| </um:ControlExtensions.Icon> | ||
| </ComboBox> | ||
| ``` | ||
| # [**XAML**](#tab/xaml) |
There was a problem hiding this comment.
Suggested change
| # [**XAML**](#tab/xaml) | |
| ### [**XAML**](#tab/xaml) | |
Youssef1313
reviewed
Jan 18, 2024
| </ComboBox> | ||
| ``` | ||
|
|
||
| # [**C#**](#tab/csharp) |
There was a problem hiding this comment.
Suggested change
| # [**C#**](#tab/csharp) | |
| ### [**C#**](#tab/csharp) | |
Youssef1313
reviewed
Jan 18, 2024
| .Symbol(Symbol.SolidStar) | ||
| ) | ||
| ``` | ||
| *** |
Youssef1313
reviewed
Jan 18, 2024
| </um:ControlExtensions.Icon> | ||
| </ComboBox> | ||
| ``` | ||
| # [**XAML**](#tab/xaml) |
There was a problem hiding this comment.
Suggested change
| # [**XAML**](#tab/xaml) | |
| ### [**XAML**](#tab/xaml) | |
Youssef1313
reviewed
Jan 18, 2024
| </um:ControlExtensions.Icon> | ||
| </ComboBox> | ||
| ``` | ||
| # [**C#**](#tab/csharp) |
There was a problem hiding this comment.
Suggested change
| # [**C#**](#tab/csharp) | |
| ### [**C#**](#tab/csharp) | |
Youssef1313
reviewed
Jan 18, 2024
| new SymbolIcon() | ||
| .Symbol(Symbol.SolidStar) | ||
| ) | ||
| ``` |
Youssef1313
reviewed
Jan 18, 2024
| @@ -37,17 +67,36 @@ It's control specific and for now, you can only use it with the ToggleButton con | |||
|
|
|||
| ### Alternate Content on ToggleButton | |||
|
|
|||
| # [**XAML**](#tab/xaml) | |||
There was a problem hiding this comment.
Suggested change
| # [**XAML**](#tab/xaml) | |
| #### [**XAML**](#tab/xaml) | |
Youssef1313
reviewed
Jan 18, 2024
| <!-- This is the alternate content - which is when the control state is CHECKED --> | ||
| <um:ControlExtensions.AlternateContent> | ||
| <PathIcon Data="{StaticResource Icon_more_vertical}" /> | ||
| </um:ControlExtensions.AlternateContent> | ||
| </ToggleButton> | ||
| ``` | ||
| # [**C#**](#tab/csharp) |
There was a problem hiding this comment.
Suggested change
| # [**C#**](#tab/csharp) | |
| #### [**C#**](#tab/csharp) | |
Youssef1313
reviewed
Jan 18, 2024
| new PathIcon() | ||
| .Data(StaticResource.Get<Geometry>("Icon_more_vertical")) | ||
| ) | ||
| ``` |
Youssef1313
reviewed
Jan 18, 2024
| @@ -97,6 +146,7 @@ Within the `ControlTemplate` of the `ElevatedButtonStyle`, instead of performing | |||
|
|
|||
| Applying the surface tint for elevated controls is optional and must be explicitly enabled through the use of the `IsTintEnabled` attached property. Below is an example of how an elevated control may appear with or without a surface tint: | |||
|
|
|||
| # [**XAML**](#tab/xaml) | |||
There was a problem hiding this comment.
Suggested change
| # [**XAML**](#tab/xaml) | |
| ### [**XAML**](#tab/xaml) | |
Youssef1313
reviewed
Jan 18, 2024
| @@ -120,11 +170,44 @@ Applying the surface tint for elevated controls is optional and must be explicit | |||
| </StackPanel> | |||
| ``` | |||
|
|
|||
| The above XAML will produce the following result: | |||
| # [**C#**](#tab/csharp) | |||
There was a problem hiding this comment.
Suggested change
| # [**C#**](#tab/csharp) | |
| ### [**C#**](#tab/csharp) | |
Youssef1313
reviewed
Jan 18, 2024
| .ControlExtensions(elevation: 5) | ||
| .Style(Theme.Button.Styles.Elevated) | ||
| ) | ||
| ``` |
Youssef1313
reviewed
Jan 18, 2024
| @@ -34,24 +34,41 @@ Initialization of the Uno.Material resources is handled by the specialized `Mate | |||
| | ColorOverrideSource | string | (Optional) Gets or sets a Uniform Resource Identifier that provides the source location of a ResourceDictionary containing overrides for the default Uno.Material Color resources | | |||
| | FontOverrideSource | string | (Optional) Gets or sets a Uniform Resource Identifier that provides the source location of a ResourceDictionary containing overrides for the default Uno.Material font resources | | |||
|
|
|||
| > [!NOTE] | |||
| > Uno Material also has support for C# Markup through a [Uno.Material.WinUI.Markup](https://www.nuget.org/packages/Uno.Material.WinUI.Markup) NuGet Package. To get started with Uno Material in your C# Markup application, add the `Uno.Material.WinUI.Markup` NuGet package to your **App Code Library** project and your platform heads. | |||
|
|
|||
Youssef1313
reviewed
Jan 18, 2024
| 3. Install the [`Uno.Material.WinUI`](https://www.nuget.org/packages/Uno.Material.WinUI) for XAML or [`Uno.Material.WinUI.Markup`](https://www.nuget.org/packages/Uno.Material.WinUI.Markup) for C# Markup. | ||
| 4. Add the following Material resources to `AppResources`: | ||
|
|
||
| # [**XAML**](#tab/xaml) |
There was a problem hiding this comment.
Suggested change
| # [**XAML**](#tab/xaml) | |
| ##### [**XAML**](#tab/xaml) | |
Youssef1313
reviewed
Jan 18, 2024
| </ResourceDictionary.MergedDictionaries> | ||
| </ResourceDictionary> | ||
| ``` | ||
| # [**C#**](#tab/csharp) |
There was a problem hiding this comment.
Suggested change
| # [**C#**](#tab/csharp) | |
| ##### [**C#**](#tab/csharp) | |
Youssef1313
reviewed
Jan 18, 2024
| new MaterialTheme())); | ||
| } | ||
| } | ||
| ``` |
Youssef1313
reviewed
Jan 18, 2024
| ColorOverrideSource="ms-appx:///PROJECT_NAME/Styles/Application/MaterialColorsOverride.xaml" /> | ||
| ``` | ||
|
|
||
| # [**XAML**](#tab/xaml) |
There was a problem hiding this comment.
Suggested change
| # [**XAML**](#tab/xaml) | |
| #### [**XAML**](#tab/xaml) | |
Youssef1313
reviewed
Jan 18, 2024
| </ResourceDictionary.ThemeDictionaries> | ||
| </ResourceDictionary> | ||
| ``` | ||
| # [**C#**](#tab/csharp) |
There was a problem hiding this comment.
Suggested change
| # [**C#**](#tab/csharp) | |
| #### [**C#**](#tab/csharp) | |
Youssef1313
reviewed
Jan 18, 2024
| ); | ||
| } | ||
| } | ||
| ``` |
Youssef1313
reviewed
Jan 18, 2024
| } | ||
| } | ||
| ``` | ||
| *** |
Youssef1313
reviewed
Jan 18, 2024
| ``` | ||
| *** | ||
| 4. In `AppResources` file, update `MaterialTheme` with the override from the previous steps: | ||
| # [**XAML**](#tab/xaml) |
There was a problem hiding this comment.
Suggested change
| # [**XAML**](#tab/xaml) | |
| ##### [**XAML**](#tab/xaml) | |
Youssef1313
reviewed
Jan 18, 2024
| <MaterialTheme xmlns="using:Uno.Material" | ||
| ColorOverrideSource="ms-appx:///PROJECT_NAME/Styles/Application/MaterialColorsOverride.xaml" /> | ||
| ``` | ||
| # [**C#**](#tab/csharp) |
There was a problem hiding this comment.
Suggested change
| # [**C#**](#tab/csharp) | |
| ##### [**C#**](#tab/csharp) | |
Youssef1313
reviewed
Jan 18, 2024
| new MaterialTheme() | ||
| .ColorOverrideDictionary(new Styles.ColorPaletteOverride()))); | ||
| ``` | ||
| *** |
Youssef1313
reviewed
Jan 18, 2024
| 3. Save the new override file within the **App Code Library**, for example, under `Styles/Application`. | ||
| 4. Assuming the font file has been placed in the **App Code Library** within, for example, a directory such as `Assets/Fonts/MyCustomFont.ttf`, your override file would look like the following: | ||
| # [**XAML**](#tab/xaml) |
There was a problem hiding this comment.
Suggested change
| # [**XAML**](#tab/xaml) | |
| #### [**XAML**](#tab/xaml) | |
Youssef1313
reviewed
Jan 18, 2024
| <FontFamily x:Key="MaterialRegularFontFamily">ms-appx:///PROJECT_NAME/Assets/Fonts/MyCustomFont-Regular.ttfMyCustomFont</FontFamily> | ||
| </ResourceDictionary> | ||
| ``` | ||
| # [**C#**](#tab/csharp) |
There was a problem hiding this comment.
Suggested change
| # [**C#**](#tab/csharp) | |
| #### [**C#**](#tab/csharp) | |
Youssef1313
reviewed
Jan 18, 2024
| .Add<FontFamily>("MaterialRegularFontFamily", "ms-appx:///PROJECT_NAME/Assets/Fonts/MyCustomFont-Regular.ttfMyCustomFont")); | ||
| } | ||
| } | ||
| ``` |
Youssef1313
reviewed
Jan 18, 2024
| //optional | ||
| new Styles.MaterialFontsOverride())); | ||
| 5. In `AppResources` file, update `MaterialTheme` with the override from the previous steps: | ||
| # [**XAML**](#tab/xaml) |
There was a problem hiding this comment.
Suggested change
| # [**XAML**](#tab/xaml) | |
| #### [**XAML**](#tab/xaml) | |
Youssef1313
reviewed
Jan 18, 2024
| <MaterialTheme xmlns="using:Uno.Material" | ||
| FontOverrideSource="ms-appx:///PROJECT_NAME/Styles/Application/MaterialFontsOverride.xaml" /> | ||
| ``` | ||
| # [**C#**](#tab/csharp) |
There was a problem hiding this comment.
Suggested change
| # [**C#**](#tab/csharp) | |
| #### [**C#**](#tab/csharp) |
Youssef1313
reviewed
Jan 18, 2024
| ``` | ||
| *** |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
GitHub Issue: #1302
PR Type
What kind of change does this PR introduce?
Description
PR Checklist
Please check if your PR fulfills the following requirements:
Other information
Internal Issue (If applicable):