From 5fbf598224d9d1124ae158e79ffc2bacd11d42e1 Mon Sep 17 00:00:00 2001 From: Vincent Baaij Date: Thu, 23 Feb 2023 16:34:23 +0100 Subject: [PATCH] README / WHATSNEW updates --- README.md | 2 +- WHATSNEW.md | 27 ++++++++++++------- .../wwwroot/sources/WHATSNEW.md | 23 ++++++++++------ 3 files changed, 33 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index d4a528aaa7..befcae82a9 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ ## Introduction -The `Microsoft.Fast.Components.FluentUI` package provides a set of [Blazor](https://blazor.net) component wrappers around Microsoft's official FluentUI Web Components. The FluentUI Web Components are built on [FAST](https://www.fast.design/) and work in every major browser. To get up and running with `Microsoft.Fast.Components.FluentUI` see the Getting Started section below. +The `Microsoft.Fast.Components.FluentUI` package provides a set of [Blazor](https://blazor.net) component wrappers around Microsoft's official FluentUI Web Components. The FluentUI Web Components are built on [FAST](https://www.fast.design/) and work in every major browser. To get up and running with the library, see the 'Getting Started' section below. The source for the library is hosted in the [Fast Blazor](https://github.com/microsoft/fast-blazor) repository at GitHub. Documentation on the components is available at the [demo site](https://aka.ms/fluentui-blazor) and at [docs.microsoft.com](https://docs.microsoft.com/en-us/fluent-ui/web-components/). diff --git a/WHATSNEW.md b/WHATSNEW.md index 077d0fe3c4..2203b380c5 100644 --- a/WHATSNEW.md +++ b/WHATSNEW.md @@ -1,12 +1,18 @@ -# V2.1 +## V2.1 A more detailed description of all the changes and everything new can be found in [this blog post](https://baaijte.net/blog/whats-new-in-the-microsoft-fluent-ui-library-for-blazor-version-21/) **Important change:** -When not specifying any settings in the project file with regards to usage of icons and/or emoji (see below), **NO** assets will be published to the output folder. This means that the icons and/or emoji will not be available. -This is a change from how it worked in earlier versions where all (icon) assets would always get published. The properties which can be used in the project file are below. You can use this block as a starting point in -your own project. Please see the blog post for more information on how to configure these settings. +**If you are currently *not using* icons and are not planning on using icons and/or moji in your application moving forward, +you do not have to make any changes to your project. If you *are* currently using icons, please read on.** + +With earlier versions of the library, all (then only icon) assets would always get published. Starting with this version, when not specifying settings +in the project file with regards to usage of icons and/or emoji (see below) **NO** assets will be published to the output folder. +This means that no icons and/or emoji will be available for rendering (with exception of the icons that are used by the library itself). + +The (annotated) `PropertyGroup` below can be used as a starting point in your own project. Copying this as-is will result in all icon and emoji assets being published. +See the blog post for more information. ```xml @@ -34,7 +40,7 @@ your own project. Please see the blog post for more information on how to config 10,12,16,20,24,28,32,48 Leave out the property to have all sizes included. --> - 10,12,16,20,24,48 + 10,12,16,20,24,28,32,48 - Activities,Animals_Nature,Flags,Food_Drink,Objects,Smileys_Emotion,Symbols,Travel_Places + Activities,Animals_Nature,Flags,Food_Drink,Objects,People_Body,Smileys_Emotion,Symbols,Travel_Places - Color + Color,Flat,HighContrast ``` @@ -82,7 +88,8 @@ your own project. Please see the blog post for more information on how to config - `` **Other changes:** -- All `` derived components now need to use `@bind-Value` or `ValueExpression`. This means an input derived component needs to be bound now. This follows the way of working that is in place with the built-in Blazor ``components). All examples have been changed to reflect this. The affected components are: +- All `` derived components now need to use `@bind-Value` or `ValueExpression`. This means an input derived component needs to be bound now. + This is in-line with how it works with the built-in Blazor `` components. All examples in the demo site have been updated to reflect this. The affected components are: - `` - `` - `` @@ -91,8 +98,8 @@ your own project. Please see the blog post for more information on how to config - `` - `` - `` -- Because of the above change, the `` and `` no longer have the 'Checked' parameter. Initial state canbe set with the `@bind-Value` construct -- `` has two new parameters to get/set the checked and unchecked message text, called `CheckedMessage` and `UncheckedMessage` respectively. +- Because of the above change, the `` and `` no longer have the 'Checked' parameter. Initial state can be set by using `@bind-Value` +- `` has two new parameters to get/set the checked and unchecked message text, called `CheckedMessage` and `UncheckedMessage` respectively. - `` component is now generic, so can be bound to other values than just `string` - Various bug fixes - Updated Fluent UI System Icons to release 1.1.194 diff --git a/examples/FluentUI.Demo.Shared/wwwroot/sources/WHATSNEW.md b/examples/FluentUI.Demo.Shared/wwwroot/sources/WHATSNEW.md index 68ce63f0ed..2203b380c5 100644 --- a/examples/FluentUI.Demo.Shared/wwwroot/sources/WHATSNEW.md +++ b/examples/FluentUI.Demo.Shared/wwwroot/sources/WHATSNEW.md @@ -4,9 +4,15 @@ A more detailed description of all the changes and everything new can be found i **Important change:** -When not specifying any settings in the project file with regards to usage of icons and/or emoji (see below), **NO** assets will be published to the output folder. This means that icons and/or emoji will not be available for rendering. -This is a change from how it worked in earlier versions where all (then only icon) assets would always get published. The properties which can be used in the project file are below. You can use this block as a starting point in -your own project. Please see the blog post for more information on how to configure these settings. +**If you are currently *not using* icons and are not planning on using icons and/or moji in your application moving forward, +you do not have to make any changes to your project. If you *are* currently using icons, please read on.** + +With earlier versions of the library, all (then only icon) assets would always get published. Starting with this version, when not specifying settings +in the project file with regards to usage of icons and/or emoji (see below) **NO** assets will be published to the output folder. +This means that no icons and/or emoji will be available for rendering (with exception of the icons that are used by the library itself). + +The (annotated) `PropertyGroup` below can be used as a starting point in your own project. Copying this as-is will result in all icon and emoji assets being published. +See the blog post for more information. ```xml @@ -34,7 +40,7 @@ your own project. Please see the blog post for more information on how to config 10,12,16,20,24,28,32,48 Leave out the property to have all sizes included. --> - 10,12,16,20,24,48 + 10,12,16,20,24,28,32,48 - Activities,Animals_Nature,Flags,Food_Drink,Objects,Smileys_Emotion,Symbols,Travel_Places + Activities,Animals_Nature,Flags,Food_Drink,Objects,People_Body,Smileys_Emotion,Symbols,Travel_Places - Color + Color,Flat,HighContrast ``` @@ -82,7 +88,8 @@ your own project. Please see the blog post for more information on how to config - `` **Other changes:** -- All `` derived components now need to use `@bind-Value` or `ValueExpression`. This means an input derived component needs to be bound now. This follows the way of working that is in place with the built-in Blazor ``components). All examples have been changed to reflect this. The affected components are: +- All `` derived components now need to use `@bind-Value` or `ValueExpression`. This means an input derived component needs to be bound now. + This is in-line with how it works with the built-in Blazor `` components. All examples in the demo site have been updated to reflect this. The affected components are: - `` - `` - `` @@ -91,7 +98,7 @@ your own project. Please see the blog post for more information on how to config - `` - `` - `` -- Because of the above change, the `` and `` no longer have the 'Checked' parameter. Initial state canbe set with the `@bind-Value` construct +- Because of the above change, the `` and `` no longer have the 'Checked' parameter. Initial state can be set by using `@bind-Value` - `` has two new parameters to get/set the checked and unchecked message text, called `CheckedMessage` and `UncheckedMessage` respectively. - `` component is now generic, so can be bound to other values than just `string` - Various bug fixes