Skip to content

Commit

Permalink
Finialized 1.0.9
Browse files Browse the repository at this point in the history
  • Loading branch information
AndreasReitberger committed Jan 29, 2023
1 parent 7d84942 commit d5127b0
Show file tree
Hide file tree
Showing 2 changed files with 55 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@

<ItemGroup>
<None Include="..\..\README.md" Pack="true" PackagePath="\" />
<None Include="readme.txt" Pack="true" PackagePath="." />
</ItemGroup>

<ItemGroup>
Expand Down
54 changes: 54 additions & 0 deletions src/SharedMauiXamlStylesLibrary/readme.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# Getting started
Open the `MauiProgramm.cs` file and add `InitializeSharedMauiStyles()`

```csharp
public static MauiApp CreateMauiApp()
{
MauiAppBuilder builder = MauiApp.CreateBuilder();
builder
.UseMauiApp<App>()
.UseMauiCommunityToolkit()
.ConfigureFonts(fonts =>
{
// Your custom used fonts
fonts.AddFont("OpenSans-Regular.ttf", "OpenSansRegular");
})
// Initializes the library
.InitializeSharedMauiStyles(); // <== Add this line
}

For further instructions or issues, please visit the project page on github.
https://github.com/AndreasReitberger/SharedMauiXamlStyles

# Important update notice
Since 1.0.9, we changed the location for the `FontIconKeys`.
In order to use the library, you need to migrate to use the new `FontIconKeys` instead.

Please follow the guide below.

# Migration Guide

https://github.com/AndreasReitberger/SharedMauiXamlStyles/wiki/Use-Icons-in-XAML-content#reference-icons

# Icons reference

In each XAML content, where you want to use the icons, please reference following namespace.

```xaml
xmlns:icons="clr-namespace:AndreasReitberger.Shared.FontIcons;assembly=SharedMauiXamlStylesLibrary"
```xaml

If you already have used our style library, please replace all StaticResource as followd.

```xaml
<!-- Replace -->
{StaticResource MaterialDesign_{IconName}}
<!-- with -->
{x:Static icons:MaterialIcons.{IconName}}
```

# Available fonts

* MaterialDesign: {x:Static icons:MaterialIcons.{IconName}}
* FluentIcon: {x:Static icons:FluentIcons.{IconName}}
* Syncfusion: {x:Static icons:SyncfusionIcons.{IconName}}

0 comments on commit d5127b0

Please sign in to comment.