You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+19-26Lines changed: 19 additions & 26 deletions
Original file line number
Diff line number
Diff line change
@@ -10,13 +10,13 @@
10
10
11
11
:star: We appreciate your star, it helps!
12
12
13
-
**This package is for use in .NET 8 Blazor projects. If you are using .NET 6 or 7, please use the v3 version of the package which is named`Microsoft.Fast.Components.FluentUI`**
13
+
This package is for use in .NET 8 and 9 Blazor projects. If you are using **now unsupported**.NET 6 or 7, please use the v3 version of the packages (names starting with`Microsoft.Fast.Components.FluentUI`)
14
14
15
15
## Introduction
16
16
17
-
The `Microsoft.FluentUI.AspNetCore.Components` package provides a set of [Blazor](https://blazor.net) components which are used to build applications that have a Fluent design (i.e. have the look and feel of modern Microsoft applications).
17
+
The `Microsoft.FluentUI.AspNetCore` family of packages provides a set of [Blazor](https://blazor.net) components, tools and utilities which are used to build applications that have a Fluent design (i.e. have the look and feel of modern Microsoft applications).
18
18
19
-
Some of the components in the library are wrappers around Microsoft's official Fluent UI Web Components. Others are components that leverage the Fluent Design System or make it easier to work with Fluent UI. To get up and running with the library, see the **Getting Started** section below.
19
+
Some of the components in the library are wrappers around Microsoft's official Fluent UI Web Components. Others are components that leverage the Fluent Design System or make it easier to work with Fluent. To get up and running with the library, see the **Getting Started** section below.
20
20
21
21
The source for the library is hosted in the [fluentui-blazor](https://github.com/microsoft/fluentui-blazor) repository at GitHub. Documentation on the components is available at the [demo site](https://www.fluentui-blazor.net).
22
22
@@ -43,10 +43,14 @@ If you want to create a new standalone WebAssembly project, you can use the foll
43
43
dotnet new fluentblazorwasm --name MyApplication
44
44
```
45
45
46
-
When using Visual Studio, you can also use the **New Project** dialog to create a new project. The templates will be available under the **Blazor** category.
- Fluent .NET MAUI Blazor Hybrid and Web App (fluentmaui-blazor-web)
49
+
50
+
When using Visual Studio, you can also use the **New Project** dialog to create a new project. The templates can be found by typine **Fluent** in the search field.
47
51
48
52
### Manual Install
49
-
To start using the **Fluent UI Blazor components** from scratch, you first need to install the main [Nuget package](https://www.nuget.org/packages/Microsoft.FluentUI.AspNetCore.Components/) in the project you want to use the library and its components.
53
+
To start using the Fluent UI Blazor library from scratch, you first need to install the main [NuGet package](https://www.nuget.org/packages/Microsoft.FluentUI.AspNetCore.Components/) in the project you want to use the library and its components.
50
54
You can use the NuGet package manager in your IDE or use the following command when using a CLI:
51
55
52
56
```shell
@@ -109,14 +113,14 @@ These providers are used by associated services to display Toasts, Dialog boxes,
109
113
<FluentMessageBarProvider />
110
114
<FluentMenuProvider />
111
115
```
112
-
> **note:** You can remove providers that are not used in your application.
116
+
> **note:** You can remove providers which you are using in your application.
113
117
114
118
## Working with Icons and Emoji
115
-
We have additional packages available that include the complete **Fluent UI System icons** and **Fluent UI Emoji** collections.
119
+
We have additional packages available that include the complete Fluent UI System icons and Fluent UI Emoji collections.
116
120
Please refer to the [Icons and Emoji](https://www.fluentui-blazor.net/IconsAndEmoji) page for more information.
117
121
118
122
## Usage
119
-
With the package installed, you can begin using the **Fluent UI Blazor components** in the same way as any other Blazor component.
123
+
With the package installed, you can begin using the Fluent UI Blazor components in the same way as any other Blazor component.
120
124
121
125
### Add Imports
122
126
@@ -137,7 +141,7 @@ This is literally all you need in your views to use Fluent UI Blazor components.
137
141
```
138
142
139
143
## Configuring the Design System
140
-
The **Fluent UI Blazor** components are built on FAST's (Adaptive UI) technology, which enables design customization and personalization, while automatically
144
+
The Fluent UI Blazor components are built on FAST's (Adaptive UI) technology, which enables design customization and personalization, while automatically
141
145
maintaining accessibility. This is accomplished through setting various "design tokens". The library exposes all design tokens, which you can use both from code as in a declarative way in your `.razor` pages. The different ways of working with design tokens are described in the [design tokens](https://www.fluentui-blazor.net/DesignTokens) page.
142
146
143
147
## Blazor Hybrid
@@ -146,7 +150,7 @@ You can use this library in **Blazor Hybrid** (MAUI/WPF/Windows Forms) projects.
146
150
### Temporary workaround for MAUI/WPF/Windows Forms issues
147
151
148
152
> [!NOTE]
149
-
> The workaround below only applies to .NET 8 (and below). As of .NET 9 this workaround is no longer needed. If you have this workaround in place for .NET 9 your Blazor Hybrid project **will not load**.
153
+
> The workaround below only applies to .NET 8. As of .NET 9 this workaround is no longer needed. If you have this workaround in place for .NET 9 your Blazor Hybrid project **will not load**.
150
154
151
155
Currently when using the WebView to run Blazor (so all Hybrid variants) the web-components script is not imported automatically (see [#404](https://github.com/microsoft/fluentui-blazor/issues/404)).
152
156
There is also an issue with loading the custom event handlers that are being configured by the web-components script. Until these are fixed on the WebView side, there is a workaround available, namely to intercept `'_framework/blazor.modules.json'` and provide proper JS initializers file (created by build). The needed `initializersLoader.webview.js` has been added to the library and needs to be included with a script tag **before** the `_framework/blazor.webview.js` script tag:
@@ -161,20 +165,9 @@ initializersLoader replaces standard `fetch` function with one which provides th
161
165
162
166
For more information regarding the bug, see issue [15234](https://github.com/dotnet/maui/issues/15234) in the MAUI repo.
163
167
164
-
## Use the DataGrid component with EF Core
165
-
If you want to use the `<FluentDataGrid>` with data provided through EF Core, you need to install an additional package so the grid knows how to resolve queries asynchronously for efficiency.
## Use the DataGrid component with EF Core or OData Client
169
+
If you want to use the `<FluentDataGrid>` with data provided through EF Core or an OData Client, you need to install an additional package so the grid knows how to resolve queries asynchronously for efficiency.
170
+
Please see the [DataGrid](https://www.fluentui-blazor.net/DataGrid) page for more information.
178
171
179
172
180
173
## Additional resources
@@ -200,13 +193,13 @@ Made with [contrib.rocks](https://contrib.rocks).
200
193
201
194
## Joining the Community
202
195
203
-
Looking to get answers to questions or engage with us in real-time? Our community is active on[Gitter](https://app.gitter.im/#/room/#fluentui-blazor:gitter.im) and[Discord](https://discord.gg/FcSNfg4). Submit requests
196
+
Looking to get answers to questions or engage with us in real-time? Our community is active on [Discord](https://discord.gg/FcSNfg4). Submit requests
204
197
and issues on [GitHub](https://github.com/microsoft/fluentui-blazor/issues/new/choose), or join us by contributing on [some good first issues via GitHub](https://github.com/microsoft/fluentui-blazor/labels/community:good-first-issue).
205
198
206
199
We look forward to building an amazing open source community with you!
207
200
208
201
## Contact
209
202
210
-
* Join the DotNetEvolution server and chat with us in real-time on [Discord](https://discord.gg/M5cBTfp6J2). You can also find us on [Gitter](https://app.gitter.im/#/room/#fluentui-blazor:gitter.im).
203
+
* Join the DotNetEvolution server and chat with us in real-time on [Discord](https://discord.gg/M5cBTfp6J2).
211
204
* Submit requests and issues (only) on [GitHub](https://github.com/microsoft/fluentui-blazor/issues/new/choose).
212
205
* Contribute by helping out on some of our recommended first issues on [GitHub](https://github.com/microsoft/fluentui-blazor/labels/community:good-first-issue).
0 commit comments