Skip to content

Commit

Permalink
README / WHATSNEW updates
Browse files Browse the repository at this point in the history
  • Loading branch information
vnbaaij committed Feb 23, 2023
1 parent 0041b4b commit 5fbf598
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 19 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/).

Expand Down
27 changes: 17 additions & 10 deletions WHATSNEW.md
Original file line number Diff line number Diff line change
@@ -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
<PropertyGroup>
Expand Down Expand Up @@ -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.
-->
<FluentIconSizes>10,12,16,20,24,48</FluentIconSizes>
<FluentIconSizes>10,12,16,20,24,28,32,48</FluentIconSizes>

<!--
Specify (at least) one or more variants from the following options (separated by ','):
Expand Down Expand Up @@ -67,22 +73,23 @@ your own project. Please see the blog post for more information on how to config
Activities,Animals_Nature,Flags,Food_Drink,Objects,People_Body,Smileys_Emotion,Symbols,Travel_Places
Leave out the property to have all groups included.
-->
<FluentEmojiGroups>Activities,Animals_Nature,Flags,Food_Drink,Objects,Smileys_Emotion,Symbols,Travel_Places</FluentEmojiGroups>
<FluentEmojiGroups>Activities,Animals_Nature,Flags,Food_Drink,Objects,People_Body,Smileys_Emotion,Symbols,Travel_Places</FluentEmojiGroups>

<!--
Specify (at least) one or more styles from the following options (separated by ','):
Color,Flat,HighContrast
Leave out the property to have all styles included.
-->
<FluentEmojiStyles>Color</FluentEmojiStyles>
<FluentEmojiStyles>Color,Flat,HighContrast</FluentEmojiStyles>
</PropertyGroup>
```

**New component**:
- `<FluentEmoji>`

**Other changes:**
- All `<FluentInputBase>` 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 `<Input...>`components). All examples have been changed to reflect this. The affected components are:
- All `<FluentInputBase>` 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 `<Input...>` components. All examples in the demo site have been updated to reflect this. The affected components are:
- `<FluentCheckbox>`
- `<FluentNumberField>`
- `<FluentRadioGroup>`
Expand All @@ -91,8 +98,8 @@ your own project. Please see the blog post for more information on how to config
- `<FluentSwitch>`
- `<FluentTextArea>`
- `<FluentTextField>`
- Because of the above change, the `<FluentCheckbox>` and `<FluentSwitch>` no longer have the 'Checked' parameter. Initial state canbe set with the `@bind-Value` construct
- `<FluentSwitch>` has two new parameters to get/set the checked and unchecked message text, called `CheckedMessage` and `UncheckedMessage` respectively.
- Because of the above change, the `<FluentCheckbox>` and `<FluentSwitch>` no longer have the 'Checked' parameter. Initial state can be set by using `@bind-Value`
- `<FluentSwitch>` has two new parameters to get/set the checked and unchecked message text, called `CheckedMessage` and `UncheckedMessage` respectively.
- `<FluentRadioGroup>` 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
Expand Down
23 changes: 15 additions & 8 deletions examples/FluentUI.Demo.Shared/wwwroot/sources/WHATSNEW.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
<PropertyGroup>
Expand Down Expand Up @@ -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.
-->
<FluentIconSizes>10,12,16,20,24,48</FluentIconSizes>
<FluentIconSizes>10,12,16,20,24,28,32,48</FluentIconSizes>

<!--
Specify (at least) one or more variants from the following options (separated by ','):
Expand Down Expand Up @@ -67,22 +73,23 @@ your own project. Please see the blog post for more information on how to config
Activities,Animals_Nature,Flags,Food_Drink,Objects,People_Body,Smileys_Emotion,Symbols,Travel_Places
Leave out the property to have all groups included.
-->
<FluentEmojiGroups>Activities,Animals_Nature,Flags,Food_Drink,Objects,Smileys_Emotion,Symbols,Travel_Places</FluentEmojiGroups>
<FluentEmojiGroups>Activities,Animals_Nature,Flags,Food_Drink,Objects,People_Body,Smileys_Emotion,Symbols,Travel_Places</FluentEmojiGroups>

<!--
Specify (at least) one or more styles from the following options (separated by ','):
Color,Flat,HighContrast
Leave out the property to have all styles included.
-->
<FluentEmojiStyles>Color</FluentEmojiStyles>
<FluentEmojiStyles>Color,Flat,HighContrast</FluentEmojiStyles>
</PropertyGroup>
```

**New component**:
- `<FluentEmoji>`

**Other changes:**
- All `<FluentInputBase>` 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 `<Input...>`components). All examples have been changed to reflect this. The affected components are:
- All `<FluentInputBase>` 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 `<Input...>` components. All examples in the demo site have been updated to reflect this. The affected components are:
- `<FluentCheckbox>`
- `<FluentNumberField>`
- `<FluentRadioGroup>`
Expand All @@ -91,7 +98,7 @@ your own project. Please see the blog post for more information on how to config
- `<FluentSwitch>`
- `<FluentTextArea>`
- `<FluentTextField>`
- Because of the above change, the `<FluentCheckbox>` and `<FluentSwitch>` no longer have the 'Checked' parameter. Initial state canbe set with the `@bind-Value` construct
- Because of the above change, the `<FluentCheckbox>` and `<FluentSwitch>` no longer have the 'Checked' parameter. Initial state can be set by using `@bind-Value`
- `<FluentSwitch>` has two new parameters to get/set the checked and unchecked message text, called `CheckedMessage` and `UncheckedMessage` respectively.
- `<FluentRadioGroup>` component is now generic, so can be bound to other values than just `string`
- Various bug fixes
Expand Down

0 comments on commit 5fbf598

Please sign in to comment.