Microsoft.Fast.Components.FluentUI 2.0.0-rc-2

Prefix Reserved
.NET 6.0 This package targets .NET 6.0. The package is compatible with this framework or higher.
This is a prerelease version of Microsoft.Fast.Components.FluentUI.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package Microsoft.Fast.Components.FluentUI --version 2.0.0-rc-2                

                    
                

            
NuGet\Install-Package Microsoft.Fast.Components.FluentUI -Version 2.0.0-rc-2
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="Microsoft.Fast.Components.FluentUI" Version="2.0.0-rc-2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add Microsoft.Fast.Components.FluentUI --version 2.0.0-rc-2                

                    
                

            
#r "nuget: Microsoft.Fast.Components.FluentUI, 2.0.0-rc-2"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
// Install Microsoft.Fast.Components.FluentUI as a Cake Addin
#addin nuget:?package=Microsoft.Fast.Components.FluentUI&version=2.0.0-rc-2&prerelease

// Install Microsoft.Fast.Components.FluentUI as a Cake Tool
#tool nuget:?package=Microsoft.Fast.Components.FluentUI&version=2.0.0-rc-2&prerelease

Microsoft.Fast

License: MIT .NET C# Nuget Nuget

Validate PRs Validate Security

Discord Twitter

⭐ We appreciate your star, it helps!

Introduction

The Microsoft.Fast.Components.FluentUI package provides a lightweight set of Blazor component wrappers around Microsoft's official FluentUI Web Components. The FluentUI Web Components are built on FAST and work in every major browser. To get up and running with Microsoft.Fast.Components.FluentUI see the Getting Started section below.

The source for @fluentui/web-components is hosted in the Fluent UI mono-repository. Documentation on the components is available on docs.microsoft.com.

Getting Started

To get started using the Fluent UI Web Components for Blazor, you will first need to install the official Nuget package for Fluent UI. You can use the following command:

dotnet add package Microsoft.Fast.Components.FluentUI

Next, you need to add the web components script. You can either add the script from CDN directly, or you can install it with NPM, whichever you prefer.

To add the script from CDN use the following markup:

<script type="module" src="https://cdn.jsdelivr.net/npm/@fluentui/web-components/dist/web-components.min.js"></script>

The markup above always references the latest release of the components. When deploying to production, you will want to ship with a specific version. Here's an example of the markup for that:

<script type="module" src="https://cdn.jsdelivr.net/npm/@fluentui/web-components@2.0.2/dist/web-components.min.js"></script>

The best place to put the script tag is typically in your index.html (_Layout.cshtml for blazor server project) file in the script section at the bottom of the <body>.

If you wish to leverage NPM instead, run the following command:

npm install --save @fluentui/web-components

You can locate the single file script build in the following location:

node_modules/@fluentui/web-components/dist/web-components.min.js

Copy this to your wwwroot/script folder and reference it with a script tag as described above.

📓 Note

If you are setting up Fluent UI Web Components on a Blazor Server project, you will need to escape the @ character by repeating it in the source link. For more information check out the Razor Pages syntax documentation.

In your Program.cs file you need to add the following:

builder.Services.AddFluentUIComponents();

if you are using Blazor Server, you need to make sure the HttpClient service is added:

builder.Services.AddHttpClient();

Using the FluentUI Web Components

With the package installed and the script configured, you can begin using the Fluent UI Web Components in the same way as any other Blazor component. Just be sure to add the following using statement to your views:

@using Microsoft.Fast.Components.FluentUI

Here's a small example of a FluentCard with a FluentButton that uses the Fluent "Accent" appearance:

@using Microsoft.Fast.Components.FluentUI

<FluentCard>
  <h2>Hello World!</h2>
  <FluentButton Appearance="@Appearance.Accent">Click Me</FluentButton>
</FluentCard>

💡 Tip

You can add @using Microsoft.Fast.Components.FluentUI to the namespace collection in _Imports.razor, so that you can avoid repeating it in every single razor page.

Configuring the Design System

The Fluent UI Web Components are built on FAST's Adaptive UI technology, which enables design customization and personalization, while automatically maintaining accessibility. This is accomplished through setting various "Design Tokens". As of version 1.4 you can use all of the (160) individual Design Tokens, both from code as in a declarative way in your .razor pages. See https://docs.microsoft.com/en-us/fluent-ui/web-components/design-system/design-tokens for more information on how Design Tokens work

Option 1: Using Design Tokens from C# code

Given the following .razor page fragment:

<FluentButton @ref="ref1" Appearance="Appearance.Filled">A button</FluentButton>
<FluentButton @ref="ref2" Appearance="Appearance.Filled">Another button</FluentButton>
<FluentButton @ref="ref3" Appearance="Appearance.Filled">And one more</FluentButton>
<FluentButton @ref="ref4" Appearance="Appearance.Filled" @onclick=OnClick>Last button</FluentButton>

You can use Design Tokens to manipulate the styles from C# code as follows:

[Inject]
private BaseLayerLuminance BaseLayerLuminance { get; set; } = default!;

[Inject]
private AccentBaseColor AccentBaseColor { get; set; } = default!;

[Inject]
private BodyFont BodyFont { get; set; } = default!;

[Inject]
private StrokeWidth StrokeWidth { get; set; } = default!;

[Inject]
private ControlCornerRadius ControlCornerRadius { get; set; } = default!;

private FluentButton? ref1;
private FluentButton? ref2;
private FluentButton? ref3;
private FluentButton? ref4;

protected override async Task OnAfterRenderAsync(bool firstRender)
{
	if (firstRender)
	{
		//Set to dark mode
		await BaseLayerLuminance.SetValueFor(ref1!.Element, (float)0.15);

		//Set to Excel color
		await AccentBaseColor.SetValueFor(ref2!.Element, "#185ABD".ToSwatch());

		//Set the font
		await BodyFont.SetValueFor(ref3!.Element, "Comic Sans MS");

		//Set 'border' width for ref4
		await StrokeWidth.SetValueFor(ref4!.Element, 7);
		//And change conrner radius as well
		await ControlCornerRadius.SetValueFor(ref4!.Element, 15);

		StateHasChanged();
	}

}

public async Task OnClick()
{
	//Remove the wide border
	await StrokeWidth.DeleteValueFor(ref4!.Element);
}

As can be seen in the code above (with the ref4.Element), it is posible to apply multiple tokens to the same component.

For Design Tokens that work with a color value, you must call the ToSwatch() extension method on a string value or use one of the Swatch constructors. This makes sure the color is using a format that Design Tokens can handle. A Swatch has a lot of commonality with the System.Drawing.Color struct. Instead of the values of the components being between 0 and 255, in a Swatch they are expressed as a value between 0 and 1.

📓 Note

The Design Tokens are manipulated through JavaScript interop working with an ElementReference. There is no JavaScript element until after the component is rendered. This means you can only work with the Design Tokens from code after the component has been rendered in OnAfterRenderAsync and not in any earlier lifecycle methods.

Option 2: Using Design Tokens as components

The Design Tokens can also be used as components in a .razor page directely. It looks like this:

<BaseLayerLuminance Value="(float?)0.15">
	<FluentCard BackReference="@context">
		<div class="contents">
			Dark
			<FluentButton Appearance="Appearance.Accent">Accent</FluentButton>
			<FluentButton Appearance="Appearance.Stealth">Stealth</FluentButton>
			<FluentButton Appearance="Appearance.Outline">Outline</FluentButton>
			<FluentButton Appearance="Appearance.Lightweight">Lightweight</FluentButton>
		</div>
	</FluentCard>
</BaseLayerLuminance>

To make this work, a link needs to be created between the Design Token component and its child components. This is done with the BackReference="@context" construct.

📓 Note

Only one Design Token component at a time can be used this way. If you need to set more tokens, use the code approach as described in Option 1 above.

Option 3: Using the <FluentDesignSystemProvider>

The third way to customize the design in Blazor is to wrap the entire block you want to manipulate in a <FluentDesignSystemProvider>. This special element has a number of properties you can set to configure a subset of the tokens. Not all tokens are available/supported and we recommend this to only be used as a fall-back mechanism. The preferred mehod of working with the desgn tokens is to manipulate them from code as described in option 1.

Here's an example of changing the "accent base color" and switching the system into dark mode (in the file app.razor):

<FluentDesignSystemProvider AccentBaseColor="#464EB8" BaseLayerLuminance="0">
	<Router AppAssembly="@typeof(App).Assembly">
		<Found Context="routeData">
			<RouteView RouteData="@routeData" DefaultLayout="@typeof(MainLayout)" />
		</Found>
		<NotFound>
			<PageTitle>Not found</PageTitle>
			<LayoutView Layout="@typeof(MainLayout)">
				<p role="alert">Sorry, there's nothing at this address.</p>
			</LayoutView>
		</NotFound>
	</Router>
</FluentDesignSystemProvider>

📓 Note

FluentDesignSystemProvider token attributes can be changed on-the-fly like any other Blazor component attribute.

Colors for integration with specific Microsoft products

If you are attempting to configure the components for integration into a specific Microsoft product, the following table provides AccentBaseColor values you can use:

Product AccentBaseColor
Office #D83B01
Word #185ABD
Excel #107C41
PowerPoint #C43E1C
Teams #6264A7
OneNote #7719AA
SharePoint #03787C
Stream #BC1948

For a list of all available token attributes, see here. More examples for other components can be found in the examples folder of this repository.

Web components / Blazor components mapping, implementation status and remarks

Web component Blazor component Status Remarks
<fluent-accordion> <FluentAccordion> ✔️ -
<fluent-accordion-item> <FluentAccordionItem> ✔️ -
<fluent-anchor> <FluentAnchor> ✔️ -
<fluent-anchored-region> <FluentAnchoredRegion> ✔️ -
<fluent-badge> <FluentBadge> ✔️ -
<fluent-breadcrumb> <FluentBreadcrumb> ✔️ -
<fluent-breadcrumb-item> <FluentBreadcrumbItem> ✔️ -
<fluent-button> <FluentButton> ✔️ -
<fluent-card> <FluentCard> ✔️ -
<fluent-checkbox> <FluentCheckbox> ✔️ -
<fluent-combobox> <FluentCombobox> ✔️ -
<fluent-data-grid> <FluentDataGrid> ✔️ -
<fluent-data-grid-cell> <FluentDataGridCell> ✔️ -
<fluent-data-grid-row> <FluentDataGridRow> ✔️ -
<fluent-design-system-provider> <FluentDesignSystemProvider> ✔️ -
<fluent-dialog> <FluentDialog> ✔️ -
<fluent-divider> <FluentDivider> ✔️ -
<fluent-flipper> <FluentFlipper> ✔️ -
<fluent-horizontal-scroll> <FluentHorizontalScroll> ✔️ -
No web component <FluentIcon> ✔️ -
<fluent-listbox> <FluentListbox> ✔️ -
<fluent-menu> <FluentMenu> ✔️ -
<fluent-menu-item> <FluentMenuItem> ✔️ -
<fluent-number-field> <FluentNumberField> ✔️ -
<fluent-option> <FluentOption> ✔️ -
<fluent-progress> <FluentProgress> ✔️ -
<fluent-progress-ring> <FluentProgressRing> ✔️ -
<fluent-radio> <FluentRadio> ✔️ -
<fluent-radio-group> <FluentRadioGroup> ✔️ -
<fluent-select> <FluentSelect> ✔️ -
<fluent-skeleton> <FluentSkeleton> ✔️ -
<fluent-slider> <FluentSlider> ✔️ -
<fluent-slider-label> <FluentSliderLabel> ✔️ -
<fluent-switch> <FluentSwitch> ✔️ -
<fluent-tabs> <FluentTabs> ✔️ -
<fluent-tab> <FluentTab> ✔️ -
<fluent-tab-panel> <FluentTabPanel> ✔️ -
<fluent-text-area> <FluentTextArea> ✔️ -
<fluent-text-field> <FluentTextField> ✔️ -
<fluent-toolbar> <FluentToolbar> ✔️ -
<fluent-tooltip> <FluentTooltip> ✔️ -
<fluent-tree-view> <FluentTreeView> ✔️ -
<fluent-tree-item> <FluentTreeItem> ✔️ -

Joining the Community

Looking to get answers to questions or engage with us in realtime? Our community is most active on Discord. Submit requests and issues on GitHub, or join us by contributing on some good first issues via GitHub.

If you don't find a component you're looking for, it's best to create the issue in our FAST repo here and limit issues on this repo to bugs in the Blazor component wrappers or Blazor-specific features.

We look forward to building an amazing open source community with you!

Contact

  • Join the community and chat with us in real-time on Discord.
  • Submit requests and issues on GitHub.
  • Contribute by helping out on some of our recommended first issues on GitHub.
Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (8)

Showing the top 5 NuGet packages that depend on Microsoft.Fast.Components.FluentUI:

Package Downloads
FenixAlliance.ACL.Dependencies

Application Component for the Alliance Business Suite.
Microsoft.Fast.Components.FluentUI.Icons

A set of icons wrapping Microsoft’s official Fluent UI Icon library.
Microsoft.Fast.Components.FluentUI.Emojis

A Blazor wrapper library for the official Microsoft Fluent UI Emoji set.
Microsoft.Fast.Components.FluentUI.DataGrid.EntityFrameworkAdapter

An adapter for using the Fluent UI Blazor DataGrid with Entity Framework.
SobaFw.Client

Package Description

GitHub repositories (3)

Showing the top 3 popular GitHub repositories that depend on Microsoft.Fast.Components.FluentUI:

Repository Stars
testcontainers/testcontainers-dotnet
A library to support tests with throwaway instances of Docker containers for all compatible .NET Standard versions.
microsoft/hack-together-teams
HackTogether: The Microsoft Teams Global Hack | Register, Hack, Win 👇
guitarrapc/SkiaSharp.QrCode
Qr Code Generator with Skia. (no System.Drawing)
Version Downloads Last updated
3.7.8 11,872 7/1/2024
3.7.7 222 6/30/2024
3.7.5 452 6/27/2024
3.7.4 677 6/24/2024
3.7.3 148 6/24/2024
3.7.2 2,098 6/13/2024
3.7.1 2,488 5/19/2024
3.7.1-preview.24138.3 87 5/17/2024
3.7.0 2,232 4/30/2024
3.6.2 1,761 4/23/2024
3.6.1 2,740 4/11/2024
3.6.0 6,916 3/7/2024
3.5.5 8,555 2/6/2024
3.5.4 7,136 1/31/2024
3.5.3 3,007 1/23/2024
3.5.2 2,441 1/19/2024
3.5.1 2,766 1/17/2024
3.5.0 50,140 12/14/2023
3.4.1 7,827 11/30/2023
3.4.0 3,160 11/28/2023
3.3.0 11,350 11/2/2023
3.2.2 10,542 10/24/2023
3.2.1 546 10/23/2023
3.2.0 13,909 10/9/2023
3.1.1 8,230 9/27/2023
3.1.0 2,379 9/22/2023
3.0.1 9,919 9/4/2023
3.0.0 10,767 8/28/2023
3.0.0-RC.1 2,518 7/17/2023
3.0.0-preview.5 546 7/4/2023
3.0.0-preview.4.230627.1 512 6/27/2023
3.0.0-preview.3 748 4/30/2023
3.0.0-preview.2 439 4/19/2023
2.4.3 18,430 8/25/2023
2.4.2 4,157 8/14/2023
2.4.1 22,271 7/14/2023
2.4.0 1,939 7/11/2023
2.3.6 47,143 6/8/2023
2.3.5 1,852 6/2/2023
2.3.4 1,555 5/30/2023
2.3.3 3,035 5/24/2023
2.3.1 892 5/19/2023
2.3.0 1,907 5/9/2023
2.2.1 5,290 5/1/2023
2.2.0 2,977 4/20/2023
2.2.0-preview.2 294 4/5/2023
2.1.4 12,988 3/21/2023
2.1.3 4,131 3/14/2023
2.1.2 2,497 3/10/2023
2.1.1 13,238 2/24/2023
2.1.0 1,921 2/23/2023
2.1.0-rc-4 1,604 2/21/2023
2.1.0-rc-3 2,870 2/15/2023
2.1.0-rc-2 2,388 2/10/2023
2.1.0-beta-1 3,726 1/24/2023
2.0.5 11,843 2/12/2023
2.0.4 1,787 2/6/2023
2.0.3 2,881 1/31/2023
2.0.2 9,735 1/25/2023
2.0.1 5,707 1/10/2023
2.0.0 2,965 1/6/2023
2.0.0-rc-2 1,871 12/21/2022
2.0.0-rc-1 1,372 11/30/2022
1.6.1 2,398 1/31/2023
1.6.0 17,741 11/8/2022
1.5.3 60,246 9/12/2022
1.5.2 23,732 9/6/2022
1.5.1 25,266 8/19/2022
1.5.0 63,737 7/18/2022
1.4.4 133,968 6/10/2022
1.4.3 1,900 6/7/2022
1.4.2 102,151 6/2/2022
1.4.1 232,463 5/11/2022
1.4.0 3,346 4/26/2022
1.3.1 2,035 4/25/2022
1.3.0 2,312 4/18/2022
1.2.1 2,119 4/12/2022
1.2.0 3,686 3/23/2022
1.1.0 25,765 12/3/2021
1.0.0 10,489 11/9/2021
0.5.0 411 10/29/2021
0.4.0 5,891 10/7/2021
0.3.0 4,068 8/5/2021
0.2.0 8,079 5/24/2021
0.1.0 1,551 5/6/2021
0.0.4 1,445 5/5/2021
0.0.3 1,445 5/5/2021
0.0.2 1,734 5/5/2021