[!NOTE] This component library is pre-release software.
These components are native Blazor UI components that are free to use for any Blazor project. The components also work seamlessly with PureBlazor CMS.
[!NOTE] This documentation is incomplete. We have not documented all components yet.
Please, feel free to ask questions in our Discord server, open an issue, or create a pull request.
Install the PureBlazor.Components
NuGet package to your Client project.
dotnet add package PureBlazor.Components
Register the components and services to your Program.cs
file.
builder.AddPureBlazorComponents();
You'll need to add the ASP.NET Core integration package to your Server project and update your Program.cs
file, in
addition to the Client Project.
dotnet add package PureBlazor.Components.AspNetCore
We have designed PureBlazor's components to be compatible with Tailwind CSS so you can customize with Tailwind or any custom CSS.
In the future, we will offer additional extensibility points to customize the components with C#. We will publish documentation on this as we solidify it further.
Include pureblazor.css
in your App.Razor
file, in the <head>
tag.
<link rel="stylesheet" href="https://github.com/pureblazor/components/blob/main/_content/PureBlazor.Components/pureblazor.css" />
To customize further on top of these default styles with Tailwind CSS, see tailwind.md.
All components have a Styles
parameter that accepts a string
of CSS classes. If you use Tailwind, the classes
will merge with the default styles. The Styles
parameter is parsed and evaluated for conflicts; conflicting styles
passed in here will supersede default classes.
For example, to change the shade of red for the Danger
accent, which is bg-red-900
by default:
<PureButton Accent="Accent.Danger" Styles="bg-red-600">Default button</PureButton>
You can override the default theme in C# by creating a PureStyles
object and passing it to a CascadingValue
.
The PureStyles
object has properties for each component style.
<CascadingValue Value="styles">
<PureButton Accent="Accent.Danger">Default button</PureButton>
</CascadingValue>
@code {
PureStyles styles = new();
}
[!IMPORTANT] Not all components have C# customization available yet.
Headless mode turns the UI components into completely unstyled, fully customizable, and accessible components.
You can enable headless mode by setting the Theme
property to Off
using a CascadingValue
. You may do so for individual
components or wrap your entire application in a CascadingValue
.
<CascadingValue Value="Theme.Off">
<PureButton>Unstyled button</PureButton>
</CascadingValue>
xx
library?