Docs Update

AathifMahir · May 11, 2024 · 463d6a3 · 463d6a3
1 parent 1d3ce0b
commit 463d6a3
Show file tree

Hide file tree

Showing 11 changed files with 95 additions and 272 deletions.
diff --git a/src/MauiIcons.Cupertino/readme.md b/src/MauiIcons.Cupertino/readme.md
@@ -52,7 +52,9 @@ if you came across this issue dotnet/maui#7503 when using new namespace, Make su
 
 ```
 
-## Breaking Changes from v2
+## Breaking Changes
+
+### Version 1 to 2
 
 `Old (v1)`
 
@@ -70,6 +72,11 @@ xmlns:mi="http://www.aathifmahir.com/dotnet/2022/maui/icons"
 <mi:MauiIcon Icon="{mi:Cupertino Airplane}"/>
 ```
 
+### Version 2 to 3
+
+  - Removal of **TypeArgument** and Built in OnPlatform and OnIdiom Support, Use MauiIcons Integrated [Custom OnPlatform and OnIdioms Feature](#custom-onplatform-and-onidiom-usage)
+  - Removal of **Dotnet 7** Support
+
 ## Built in Control Usage
 
 `Xaml`
@@ -161,29 +168,6 @@ new MauiIcon().Icon(CupertinoIcons.Airplane).OnIdioms(new List<string>{"Desktop"
 new MauiIcon().Icon(CupertinoIcons.AntFill).OnPlatforms(new List<string>{"WinUI", "Android"}).OnIdioms(new List<string>{"Desktop", "Phone"});
 ```
 
-## Maui Built in OnPlatform and OnIdiom Usage
-
-```xml
-<Image>
-    <Image.Source>
-        <OnPlatform x:TypeArguments="ImageSource" Default="{mi:Cupertino Icon=Airplane, TypeArgument={x:Type ImageSource}}">
-            <On Platform="MacCatalyst, WinUI" 
-			Value="{mi:Cupertino Icon=AntFill, IconBackgroundColor=Cyan, TypeArgument={x:Type ImageSource}}"/>
-        </OnPlatform>
-    </Image.Source>
-</Image>
-
-<Image>
-    <Image.Source>
-        <OnIdiom Default="{mi:Cupertino Icon=AntFill, TypeArgument={x:Type ImageSource}}" 
-		Desktop="{mi:Cupertino Icon=Airplane, TypeArgument={x:Type ImageSource}}">
-        </OnIdiom>
-    </Image.Source>
-</Image>
-
-```
-**Disclaimer:**  Only **ImageSource** or **FontImageSource** Supports Maui's Built in OnPlatform or OnIdiom and **TypeArgument** Should be Assigned to Work Optimally, Therefore It's Recommended to use MauiIcons Custom OnPlatform and OnIdioms
-
 # License
 
 **MauiIcons.Cupertino**  

diff --git a/src/MauiIcons.Fluent.Filled/readme.md b/src/MauiIcons.Fluent.Filled/readme.md
@@ -52,24 +52,31 @@ if you came across this issue dotnet/maui#7503 when using new namespace, Make su
 
 ```
 
-## Breaking Changes from v2
+## Breaking Changes
+
+### Version 1 to 2
 
 `Old (v1)`
 
 ```xml
-xmlns:fluentFilled="clr-namespace:MauiIcons.FluentFilled;assembly=MauiIcons.FluentFilled"
+xmlns:cupertino="clr-namespace:MauiIcons.Cupertino;assembly=MauiIcons.Cupertino"
 
-<fluentFilled:MauiIcon Icon="AppFolder48Filled"/>
+<cupertino:MauiIcon Icon="Airplane"/>
 ```
 
 `New (v2)`
 
 ```xml
 xmlns:mi="http://www.aathifmahir.com/dotnet/2022/maui/icons"
 
-<mi:MauiIcon Icon="{mi:FluentFilled AppFolder48Filled}"/>
+<mi:MauiIcon Icon="{mi:Cupertino Airplane}"/>
 ```
 
+### Version 2 to 3
+
+  - Removal of **TypeArgument** and Built in OnPlatform and OnIdiom Support, Use MauiIcons Integrated [Custom OnPlatform and OnIdioms Feature](#custom-onplatform-and-onidiom-usage)
+  - Removal of **Dotnet 7** Support
+
 ### Nuget Package Changes
 
 - **`AathifMahir.Maui.MauiIcons.FluentFilled`** is Depcrecated and Replaced by [`AathifMahir.Maui.MauiIcons.Fluent.Filled`](https://www.nuget.org/packages/AathifMahir.Maui.MauiIcons.Fluent.Filled/)
@@ -165,29 +172,6 @@ new MauiIcon().Icon(FluentFilledIcons.Accessibility48Filled).OnIdioms(new List<s
 new MauiIcon().Icon(FluentFilledIcons.AppFolder48Filled).OnPlatforms(new List<string>{"WinUI", "Android"}).OnIdioms(new List<string>{"Desktop", "Phone"});
 ```
 
-## Maui Built in OnPlatform and OnIdiom Usage
-
-```xml
-<Image>
-    <Image.Source>
-        <OnPlatform x:TypeArguments="ImageSource" Default="{mi:FluentFilled Icon=Accessibility48Filled, TypeArgument={x:Type ImageSource}}">
-            <On Platform="MacCatalyst, WinUI" 
-			Value="{mi:FluentFilled Icon=AppFolder48Filled, IconBackgroundColor=Cyan, TypeArgument={x:Type ImageSource}}"/>
-        </OnPlatform>
-    </Image.Source>
-</Image>
-
-<Image>
-    <Image.Source>
-        <OnIdiom Default="{mi:FluentFilled Icon=AppFolder48Filled, TypeArgument={x:Type ImageSource}}" 
-		Desktop="{mi:FluentFilled Icon=Accessibility48Filled, TypeArgument={x:Type ImageSource}}">
-        </OnIdiom>
-    </Image.Source>
-</Image>
-
-```
-**Disclaimer:**  Only **ImageSource** or **FontImageSource** Supports Maui's Built in OnPlatform or OnIdiom and **TypeArgument** Should be Assigned to Work Optimally, Therefore It's Recommended to use MauiIcons Custom OnPlatform and OnIdioms
-
 # License
 
 **MauiIcons.Fluent.Filled**  

diff --git a/src/MauiIcons.Fluent/readme.md b/src/MauiIcons.Fluent/readme.md
@@ -52,24 +52,32 @@ if you came across this issue dotnet/maui#7503 when using new namespace, Make su
 
 ```
 
-## Breaking Changes from v2
+## Breaking Changes
+
+### Version 1 to 2
 
 `Old (v1)`
 
 ```xml
-xmlns:fluent="clr-namespace:MauiIcons.Fluent;assembly=MauiIcons.Fluent"
+xmlns:cupertino="clr-namespace:MauiIcons.Cupertino;assembly=MauiIcons.Cupertino"
 
-<fluent:MauiIcon Icon="AppFolder48"/>
+<cupertino:MauiIcon Icon="Airplane"/>
 ```
 
 `New (v2)`
 
 ```xml
 xmlns:mi="http://www.aathifmahir.com/dotnet/2022/maui/icons"
 
-<mi:MauiIcon Icon="{mi:Fluent AppFolder48}"/>
+<mi:MauiIcon Icon="{mi:Cupertino Airplane}"/>
 ```
 
+### Version 2 to 3
+
+  - Removal of **TypeArgument** and Built in OnPlatform and OnIdiom Support, Use MauiIcons Integrated [Custom OnPlatform and OnIdioms Feature](#custom-onplatform-and-onidiom-usage)
+  - Removal of **Dotnet 7** Support
+
+
 ## Built in Control Usage
 
 `Xaml`
@@ -161,29 +169,6 @@ new MauiIcon().Icon(FluentIcons.Accessibility48).OnIdioms(new List<string>{"Desk
 new MauiIcon().Icon(FluentIcons.AppFolder48).OnPlatforms(new List<string>{"WinUI", "Android"}).OnIdioms(new List<string>{"Desktop", "Phone"});
 ```
 
-## Maui Built in OnPlatform and OnIdiom Usage
-
-```xml
-<Image>
-    <Image.Source>
-        <OnPlatform x:TypeArguments="ImageSource" Default="{mi:Fluent Icon=Accessibility48, TypeArgument={x:Type ImageSource}}">
-            <On Platform="MacCatalyst, WinUI" 
-			Value="{mi:Fluent Icon=AppFolder48, IconBackgroundColor=Cyan, TypeArgument={x:Type ImageSource}}"/>
-        </OnPlatform>
-    </Image.Source>
-</Image>
-
-<Image>
-    <Image.Source>
-        <OnIdiom Default="{mi:Fluent Icon=AppFolder48, TypeArgument={x:Type ImageSource}}" 
-		Desktop="{mi:Fluent Icon=Accessibility48, TypeArgument={x:Type ImageSource}}">
-        </OnIdiom>
-    </Image.Source>
-</Image>
-
-```
-**Disclaimer:**  Only **ImageSource** or **FontImageSource** Supports Maui's Built in OnPlatform or OnIdiom and **TypeArgument** Should be Assigned to Work Optimally, Therefore It's Recommended to use MauiIcons Custom OnPlatform and OnIdioms
-
 # License
 
 **MauiIcons.Fluent**  

diff --git a/src/MauiIcons.FontAwesome.Brand/readme.md b/src/MauiIcons.FontAwesome.Brand/readme.md
@@ -52,6 +52,13 @@ if you came across this issue dotnet/maui#7503 when using new namespace, Make su
 
 ```
 
+## Breaking Changes
+
+### Version 2 to 3
+
+  - Removal of **TypeArgument** and Built in OnPlatform and OnIdiom Support, Use MauiIcons Integrated [Custom OnPlatform and OnIdioms Feature](#custom-onplatform-and-onidiom-usage)
+  - Removal of **Dotnet 7** Support
+
 ## Built in Control Usage
 
 `Xaml`
@@ -143,29 +150,6 @@ new MauiIcon().Icon(FontAwesomeBrandIcons.Github).OnIdioms(new List<string>{"Des
 new MauiIcon().Icon(FontAwesomeBrandIcons.PenToSquare).OnPlatforms(new List<string>{"WinUI", "Android"}).OnIdioms(new List<string>{"Desktop", "Phone"});
 ```
 
-## Maui Built in OnPlatform and OnIdiom Usage
-
-```xml
-<Image>
-    <Image.Source>
-        <OnPlatform x:TypeArguments="ImageSource" Default="{mi:FontAwesomeBrand Icon=Pinterest, TypeArgument={x:Type ImageSource}}">
-            <On Platform="MacCatalyst, WinUI" 
-			Value="{mi:FontAwesomeBrand Icon=GooglePay, IconBackgroundColor=Cyan, TypeArgument={x:Type ImageSource}}"/>
-        </OnPlatform>
-    </Image.Source>
-</Image>
-
-<Image>
-    <Image.Source>
-        <OnIdiom Default="{mi:FontAwesomeBrand Icon=GooglePay, TypeArgument={x:Type ImageSource}}" 
-		Desktop="{mi:FontAwesomeBrand Icon=Github, TypeArgument={x:Type ImageSource}}">
-        </OnIdiom>
-    </Image.Source>
-</Image>
-
-```
-**Disclaimer:**  Only **ImageSource** or **FontImageSource** Supports Maui's Built in OnPlatform or OnIdiom and **TypeArgument** Should be Assigned to Work Optimally, Therefore It's Recommended to use MauiIcons Custom OnPlatform and OnIdioms
-
 # License
 
 **MauiIcons.FontAwesome.Brand**  

diff --git a/src/MauiIcons.FontAwesome.Solid/readme.md b/src/MauiIcons.FontAwesome.Solid/readme.md
@@ -52,6 +52,13 @@ if you came across this issue dotnet/maui#7503 when using new namespace, Make su
 
 ```
 
+## Breaking Changes
+
+### Version 2 to 3
+
+  - Removal of **TypeArgument** and Built in OnPlatform and OnIdiom Support, Use MauiIcons Integrated [Custom OnPlatform and OnIdioms Feature](#custom-onplatform-and-onidiom-usage)
+  - Removal of **Dotnet 7** Support
+
 ## Built in Control Usage
 
 `Xaml`
@@ -143,29 +150,6 @@ new MauiIcon().Icon(FontAwesomeSolidIcons.Asterisk).OnIdioms(new List<string>{"D
 new MauiIcon().Icon(FontAwesomeSolidIcons.PenToSquare).OnPlatforms(new List<string>{"WinUI", "Android"}).OnIdioms(new List<string>{"Desktop", "Phone"});
 ```
 
-## Maui Built in OnPlatform and OnIdiom Usage
-
-```xml
-<Image>
-    <Image.Source>
-        <OnPlatform x:TypeArguments="ImageSource" Default="{mi:FontAwesomeSolid Icon=GreaterThanEqual, TypeArgument={x:Type ImageSource}}">
-            <On Platform="MacCatalyst, WinUI" 
-			Value="{mi:FontAwesomeSolid Icon=RankingStar, IconBackgroundColor=Cyan, TypeArgument={x:Type ImageSource}}"/>
-        </OnPlatform>
-    </Image.Source>
-</Image>
-
-<Image>
-    <Image.Source>
-        <OnIdiom Default="{mi:FontAwesomeSolid Icon=RankingStar, TypeArgument={x:Type ImageSource}}" 
-		Desktop="{mi:FontAwesomeSolid Icon=Asterisk, TypeArgument={x:Type ImageSource}}">
-        </OnIdiom>
-    </Image.Source>
-</Image>
-
-```
-**Disclaimer:**  Only **ImageSource** or **FontImageSource** Supports Maui's Built in OnPlatform or OnIdiom and **TypeArgument** Should be Assigned to Work Optimally, Therefore It's Recommended to use MauiIcons Custom OnPlatform and OnIdioms
-
 # License
 
 **MauiIcons.FontAwesome.Solid**  

diff --git a/src/MauiIcons.FontAwesome/readme.md b/src/MauiIcons.FontAwesome/readme.md
@@ -52,6 +52,13 @@ if you came across this issue dotnet/maui#7503 when using new namespace, Make su
 
 ```
 
+## Breaking Changes
+
+### Version 2 to 3
+
+  - Removal of **TypeArgument** and Built in OnPlatform and OnIdiom Support, Use MauiIcons Integrated [Custom OnPlatform and OnIdioms Feature](#custom-onplatform-and-onidiom-usage)
+  - Removal of **Dotnet 7** Support
+
 ## Built in Control Usage
 
 `Xaml`
@@ -143,29 +150,6 @@ new MauiIcon().Icon(FontAwesomeIcons.Asterisk).OnIdioms(new List<string>{"Deskto
 new MauiIcon().Icon(FontAwesomeIcons.PenToSquare).OnPlatforms(new List<string>{"WinUI", "Android"}).OnIdioms(new List<string>{"Desktop", "Phone"});
 ```
 
-## Maui Built in OnPlatform and OnIdiom Usage
-
-```xml
-<Image>
-    <Image.Source>
-        <OnPlatform x:TypeArguments="ImageSource" Default="{mi:FontAwesome Icon=GreaterThan, TypeArgument={x:Type ImageSource}}">
-            <On Platform="MacCatalyst, WinUI" 
-			Value="{mi:FontAwesome Icon=Star, IconBackgroundColor=Cyan, TypeArgument={x:Type ImageSource}}"/>
-        </OnPlatform>
-    </Image.Source>
-</Image>
-
-<Image>
-    <Image.Source>
-        <OnIdiom Default="{mi:FontAwesome Icon=Star, TypeArgument={x:Type ImageSource}}" 
-		Desktop="{mi:FontAwesome Icon=Asterisk, TypeArgument={x:Type ImageSource}}">
-        </OnIdiom>
-    </Image.Source>
-</Image>
-
-```
-**Disclaimer:**  Only **ImageSource** or **FontImageSource** Supports Maui's Built in OnPlatform or OnIdiom and **TypeArgument** Should be Assigned to Work Optimally, Therefore It's Recommended to use MauiIcons Custom OnPlatform and OnIdioms
-
 # License
 
 **MauiIcons.FontAwesome**  

diff --git a/src/MauiIcons.Material.Outlined/readme.md b/src/MauiIcons.Material.Outlined/readme.md
@@ -52,6 +52,13 @@ if you came across this issue dotnet/maui#7503 when using new namespace, Make su
 
 ```
 
+## Breaking Changes
+
+### Version 2 to 3
+
+  - Removal of **TypeArgument** and Built in OnPlatform and OnIdiom Support, Use MauiIcons Integrated [Custom OnPlatform and OnIdioms Feature](#custom-onplatform-and-onidiom-usage)
+  - Removal of **Dotnet 7** Support
+
 ## Built in Control Usage
 
 `Xaml`
@@ -143,29 +150,6 @@ new MauiIcon().Icon(MaterialOutlinedIcons.ABC).OnIdioms(new List<string>{"Deskto
 new MauiIcon().Icon(MaterialOutlinedIcons.AddRoad).OnPlatforms(new List<string>{"WinUI", "Android"}).OnIdioms(new List<string>{"Desktop", "Phone"});
 ```
 
-## Maui Built in OnPlatform and OnIdiom Usage
-
-```xml
-<Image>
-    <Image.Source>
-        <OnPlatform x:TypeArguments="ImageSource" Default="{mi:MaterialOutlined Icon=ABC, TypeArgument={x:Type ImageSource}}">
-            <On Platform="MacCatalyst, WinUI" 
-			Value="{mi:MaterialOutlined Icon=AddRoad, IconBackgroundColor=Cyan, TypeArgument={x:Type ImageSource}}"/>
-        </OnPlatform>
-    </Image.Source>
-</Image>
-
-<Image>
-    <Image.Source>
-        <OnIdiom Default="{mi:MaterialOutlined Icon=AddRoad, TypeArgument={x:Type ImageSource}}" 
-		Desktop="{mi:MaterialOutlined Icon=ABC, TypeArgument={x:Type ImageSource}}">
-        </OnIdiom>
-    </Image.Source>
-</Image>
-
-```
-**Disclaimer:**  Only **ImageSource** or **FontImageSource** Supports Maui's Built in OnPlatform or OnIdiom and **TypeArgument** Should be Assigned to Work Optimally, Therefore It's Recommended to use MauiIcons Custom OnPlatform and OnIdioms
-
 # License
 
 **MauiIcons.Material.Outlined**