docs: Update readme
This commit is contained in:
Родитель
be8332ad4d
Коммит
a315f490d1
53
README.md
53
README.md
|
@ -1,8 +1,12 @@
|
|||
# Uno Fluent UI Assets Open Source Font
|
||||
# Uno.Fonts
|
||||
|
||||
An icon font for the [Fluent design system](https://www.microsoft.com/design/fluent). Uno FluentUI Assets is intended to be a drop-in replacement for Microsoft's Segoe MDL2 Assets font for use with [Uno Platform](https://platform.uno), WinUI and UWP apps.
|
||||
Repository for NuGet packages that can be added to install fonts for any new or existing Uno application. Uno.Fonts currently offers the following fonts as NuGet packages:
|
||||
|
||||
# Icon fonts
|
||||
# Uno Fluent UI Assets Font
|
||||
|
||||
An open source icon font for the [Fluent design system](https://www.microsoft.com/design/fluent). Uno FluentUI Assets is intended to be a drop-in replacement for Microsoft's Segoe MDL2 Assets font for use with [Uno Platform](https://platform.uno), WinUI and UWP apps.
|
||||
|
||||
## Icon fonts
|
||||
|
||||
This repository includes two icon fonts:
|
||||
|
||||
|
@ -11,14 +15,8 @@ This repository includes two icon fonts:
|
|||
|
||||
Both fonts use the same font family name and file names to make it possible to easily swap them in place.
|
||||
|
||||
# Updating existing application
|
||||
## Icon sources
|
||||
|
||||
If you have an existing Uno Platform application using older version of the font and want to update to the latest, two steps are needed:
|
||||
|
||||
1. Find all files with the name `uno-fluentui-assets.ttf` and replace them with the same file from the updated icon font.
|
||||
2. Inside of the WebAssembly project find `Fonts.css` file and replace it with the one provided by updated icon font.
|
||||
|
||||
# Icon sources
|
||||
Some icons are unique to the font, the other ones come from multiple sources:
|
||||
|
||||
Fluent UI System Icons
|
||||
|
@ -30,7 +28,7 @@ https://github.com/icons8/line-awesome
|
|||
Winjs symbols
|
||||
https://github.com/winjs/winjs/tree/master/src/fonts
|
||||
|
||||
# Editing the font file
|
||||
## Editing the font file
|
||||
|
||||
Here are some steps to update the font to add missing icons:
|
||||
|
||||
|
@ -43,3 +41,36 @@ Here are some steps to update the font to add missing icons:
|
|||
- For ttf, use TrueType not TrueType(Symbols) for more info you can go here https://fontforge.org/docs/ui/dialogs/generate.html.
|
||||
- There is no need to save the FontForge format since you can open a font from any of the supported format (You can use this to test if the font as been correctly modified).
|
||||
- You can ignore the `.g2n` file
|
||||
|
||||
# Google Roboto Font
|
||||
|
||||
The recommended, [open source](https://github.com/googlefonts/roboto), font family for Google's visual language [Material Design](https://m3.material.io/). Uno.Fonts.Roboto comes pre-packaged within the [Uno Material](https://github.com/unoplatform/Uno.Themes) and [Uno Material Toolkit](https://github.com/unoplatform/uno.toolkit.ui) libraries.
|
||||
|
||||
# Usage Guidelines
|
||||
|
||||
## Installing fonts for new applications
|
||||
|
||||
Simply install the desired Uno.Fonts NuGet package into your Uno project's shared class library. You will then be able to reference the font files from your XAML, like so:
|
||||
|
||||
```xml
|
||||
|
||||
<FontFamily x:Key="MyRobotoLightFontFamily">ms-appx:///Uno.Fonts.Roboto/Fonts/Roboto-Light.ttf</FontFamily>
|
||||
|
||||
```
|
||||
|
||||
> **NOTE**: If you are using the older versions of the Uno solution templates (with the `.shproj` file) then you will need to install the font NuGet package into each platform's `.csproj`
|
||||
|
||||
## Updating existing applications
|
||||
|
||||
If you have an existing Uno Platform application using an older version of the font and want to update to the latest, the following steps are needed:
|
||||
|
||||
### For Uno.Fonts.Fluent
|
||||
|
||||
1. Find all files with the name `uno-fluentui-assets.ttf` and replace them with the same file from the updated icon font.
|
||||
2. Inside of the WebAssembly project find the `Fonts.css` file and replace it with the one provided by updated icon font.
|
||||
|
||||
### For Uno.Fonts.Roboto
|
||||
|
||||
1. Remove all existing Roboto font files from the application (including those under the Assets/ folder for either your shared project or for each specific platform head)
|
||||
2. Remove references to the font file from `info.plist` if you are targetting iOS/macOS/Catalyst
|
||||
3. Inside of the WebAssembly project find the `Fonts.css` file and remove any references to the Roboto font, such as `@font-face { font-family: 'Roboto'; ... }`.
|
||||
|
|
|
@ -1,53 +0,0 @@
|
|||
/**
|
||||
When adding fonts here, make sure to add them using a base64 data uri, otherwise
|
||||
fonts loading are delayed, and text may get displayed incorrectly.
|
||||
*/
|
||||
|
||||
@font-face {
|
||||
font-family: 'Roboto';
|
||||
src: url(Roboto-Light.ttf) format('truetype');
|
||||
font-weight: 300;
|
||||
}
|
||||
|
||||
@font-face {
|
||||
font-family: 'Roboto';
|
||||
src: url(Roboto-Regular.ttf) format('truetype');
|
||||
font-weight: 400;
|
||||
}
|
||||
|
||||
@font-face {
|
||||
font-family: 'Roboto';
|
||||
src: url(Roboto-Medium.ttf) format('truetype');
|
||||
font-weight: 500;
|
||||
}
|
||||
|
||||
/* Workaround for uno issue https://github.com/unoplatform/uno/issues/693 */
|
||||
body::after {
|
||||
font-family: 'Roboto';
|
||||
background: transparent;
|
||||
content: "";
|
||||
opacity: 0;
|
||||
font-weight: 300;
|
||||
pointer-events: none;
|
||||
position: absolute;
|
||||
}
|
||||
|
||||
#uno-body::before {
|
||||
font-family: 'Roboto';
|
||||
background: transparent;
|
||||
content: "";
|
||||
opacity: 0;
|
||||
font-weight: 400;
|
||||
pointer-events: none;
|
||||
position: absolute;
|
||||
}
|
||||
|
||||
#uno-body::after {
|
||||
font-family: 'Roboto';
|
||||
background: transparent;
|
||||
content: "";
|
||||
opacity: 0;
|
||||
font-weight: 500;
|
||||
pointer-events: none;
|
||||
position: absolute;
|
||||
}
|
Двоичные данные
webfonts/Roboto/Roboto-Light.ttf
Двоичные данные
webfonts/Roboto/Roboto-Light.ttf
Двоичный файл не отображается.
Двоичные данные
webfonts/Roboto/Roboto-Medium.ttf
Двоичные данные
webfonts/Roboto/Roboto-Medium.ttf
Двоичный файл не отображается.
Двоичные данные
webfonts/Roboto/Roboto-Regular.ttf
Двоичные данные
webfonts/Roboto/Roboto-Regular.ttf
Двоичный файл не отображается.
Загрузка…
Ссылка в новой задаче