Skip to content

Latest commit

 

History

History
63 lines (42 loc) · 4.06 KB

README.md

File metadata and controls

63 lines (42 loc) · 4.06 KB
Raw

Microsoft.Fast

License: MIT .NET C# NuGet version

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 monorepo.

Getting Started

To get started using Microsoft.Fast.Components.FluentUI, you will need both the Nuget package and the accompanying Web Component implementations. First, install the Nuget package. If using the .NET CLI, you can run the following command to accomplish that.

dotnet add package Microsoft.Fast.Components.FluentUI

Next, add a script tag to your index or main layout to reference the web components:

<script type="module" src="https://unpkg.com/@fluentui/web-components"></script>

Note: If the script reference is added to a .razor or .cshtml file, you will need to escape the @ with a second @ like so https://unpkg.com/@@fluentui/web-components.

With the dependencies added, you must next enable the Fluent Design System itself by wrapping your HTML with a <FluentDesignSystemProvider> component. A good place to do this is in the App.razor file. Here's an example of what that might look like:

<FluentDesignSystemProvider>
    <Router AppAssembly="@typeof(Program).Assembly" PreferExactMatches="@true">
        <Found Context="routeData">
            <RouteView RouteData="@routeData" />
        </Found>
        <NotFound>
            <p>Sorry, there's nothing at this address.</p>
        </NotFound>
    </Router>
</FluentDesignSystemProvider>

While you can have multiple design system providers, the most common configuration is to have a single provider that wraps your entire application. The code above does exactely that. The component ensures that the default settings for FluentUI are applied (by adding the use-defaults attribute in the output). An example of using an additional design system provider (with extra attributes) can be found in the FluentUIServerSample in the file Webcomponents.razor

Once these steps are completed, you can then begin using the components throughout your Blazor application. Take a look in the examples folder of this repository to see how to use the various components.

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.

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.