Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
developerMicaelRoche authored Mar 2, 2022
1 parent 3bdc1f9 commit 701772d
Showing 1 changed file with 79 additions and 14 deletions.
93 changes: 79 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,28 +4,38 @@

<h2>Features</h2>
<h3>Implementations</h3>
<p>
🌟 <b><a href="#FontAwesome">FontAwesome</a></b><br>
Source: <a href="https://github.com/matthewrdev/fa2cs">matthewrdev fa2cs</a> <i>(adapted version)</i> and Font Awesome Cheat Sheet <i>(Feb 2022)</i><br>
Details: includes <code>FontAwesomeRegular.cs</code>, <code>FontAwesomeSolid.cs</code>, and <code>FontAwesomeBrands.cs</code>
</p>
<table>
<thead>
<tr>
<th colspan="2">🌟 <b><a href="#FontAwesome">FontAwesome</a></b></th>
</tr>
</thead>
<tbody>
<tr>
<td>Source</td>
<td><a href="https://github.com/matthewrdev/fa2cs">matthewrdev/<b>fa2cs</b></a> <i>(adapted version)</i><br>Font Awesome Cheat Sheet <i>(Feb 2022)</i></td>
</tr>
<tr>
<td>Details</td>
<td>
Uses <code>FontAwesomeRegular.cs</code>, <code>FontAwesomeSolid.cs</code>, and <code>FontAwesomeBrands.cs</code> to retrieve the FontAwesome glyph from <code>"FARegular"</code>, <code>"FASolid"</code>, or <code>"FABrands"</code>
</td>
</tr>
</tbody>
</table>

<h3>Controls and Renderers</h3>

<table>
<thead>
<tr>
<th></th>
<th>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#StandardEntry">StandardEntry</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</th>
<th>&nbsp;&nbsp;&nbsp;<a href="#CustomSearchBar">CustomSearchBar</a>&nbsp;&nbsp;&nbsp;</th>
<th>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#CustomLabel">CustomLabel</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</th>
<th><a href="#StandardCollectionView">StandardCollectionView</a></th>
<th colspan="2"><a href="#StandardEntry">StandardEntry</a></th>
</tr>
</thead>
<tbody>
<tr>
<td>Source</td>
<td><sup><a href="https://github.com/jesulink2514/XamBooksApp/tree/feature/feat-entry">jesulink2514 XamlBooksApp</a></sup></td>
<td><sup><a href="https://github.com/jesulink2514/XamBooksApp/tree/feature/feat-entry">jesulink2514 XamlBooksApp</a> <i>(adapted version)</i></sup></td>
<td></td><td></td>
<td><a href="https://github.com/jesulink2514/XamBooksApp/tree/feature/feat-entry">jesulink2514/<b>XamlBooksApp</b></a></td>
</tr>
<tr>
<td>Details</td>
Expand All @@ -35,16 +45,59 @@
<i>Color</i> <b>BorderColor</b><br>
<i>Thickness</i> <b>Padding</b>
</td>
</tr>
</tbody>
</table>

<table>
<thead>
<tr>
<th colspan="2"><a href="#CustomSearchBar">CustomSearchBar</a></th>
</tr>
</thead>
<tbody>
<tr>
<td>Source</td>
<td><a href="https://github.com/jesulink2514/XamBooksApp/tree/feature/feat-entry">jesulink2514/<b>XamlBooksApp</b></a></td>
</tr>
<tr>
<td>Details</td>
<td>
<i>int</i> <b>CornerRadius</b><br>
<i>int</i> <b>BorderThickness</b><br>
<i>Color</i> <b>BorderColor</b><br>
<i>Color</i> <b>IconColor</b>
</td>
</tr>
</tbody>
</table>

<table>
<thead>
<tr>
<th colspan="2"><a href="#CustomLabel">CustomLabel</a></th>
</tr>
</thead>
<tbody>
<tr>
<td>Details</td>
<td>
<i>int</i> <b>MinimumFontSize</b><br>
<i>int</i> <b>MaximumFontSize</b>
</td>
</tr>
</tbody>
</table>

<table>
<thead>
<tr>
<th colspan="2"><a href="#StandardCollectionView">StandardCollectionView</a></th>
</tr>
</thead>
<tbody>
<tr>
<td>Details</td>
<td>
<i>Icon</i> <b>ScrollToItem</b><br>
Replace <u>Icon</u> with your object, I haven't attempted changing Icon to Object
Expand All @@ -56,7 +109,13 @@
<h2>Usage</h2>
<h3 id="FontAwesome">FontAwesome</h3>

<b>Tab Icon</b>
First and foremost, add the namespace to the root node:

```
xmlns:fa="clr-namespace:FontAwesome"
```

<b>ShellContent Icon</b>

```
<ShellContent Title="About" ContentTemplate="{DataTemplate local:AboutPage}">
Expand All @@ -76,6 +135,12 @@
</Image>
```

<b>Label</b>

```
<Label FontFamily="FARegular" Text="{x:Static fa:FontAwesomeRegular.AddressBook}" />
```

<h3 id="StandardEntry">StandardEntry</h3>
<h3 id="CustomSearchBar">CustomSearchBar</h3>
<h3 id="CustomLabel">CustomLabel</h3>
Expand Down

0 comments on commit 701772d

Please sign in to comment.