mirror of
https://gitee.com/LongbowEnterprise/BootstrapBlazor.git
synced 2024-11-29 18:49:08 +08:00
185 lines
8.8 KiB
Markdown
185 lines
8.8 KiB
Markdown
<h1 align="center">Bootstrap Blazor Component</h1>
|
|
|
|
<div align="center">
|
|
<h2>Bootstrap Blazor is an enterprise-level UI component library based on Bootstrap and Blazor.</h2>
|
|
|
|
[](https://github.com/dotnetcore/BootstrapBlazor/blob/main/LICENSE)
|
|
[](https://www.nuget.org/packages/BootstrapBlazor/)
|
|
[](https://www.nuget.org/packages/BootstrapBlazor/)
|
|
[](https://github.com/dotnetcore/BootstrapBlazor)
|
|
[](https://github.com/dotnetcore/BootstrapBlazor)
|
|
[](https://github.com/dotnetcore/BootstrapBlazor/actions?query=workflow%3A%22Build+Project%22+branch%3Amain)
|
|
[](https://codecov.io/gh/dotnetcore/BootstrapBlazor)
|
|
</div>
|
|
|
|
English | <a href="README.zh-CN.md">中文</a>
|
|
|
|
---
|
|
## .NET Foundation
|
|
[<img align="right" src="https://github.com/dotnet-foundation/swag/blob/main/logo/dotnetfoundation_v4.png?raw=true" width="68px" />](https://www.dotnetfoundation.org/)
|
|
<p>This project is part of the <a href="https://www.dotnetfoundation.org/">.NET Foundation</a> and operates under their <a href="https://www.dotnetfoundation.org/code-of-conduct">code of conduct</a>. </p>
|
|
|
|
## Features
|
|
- Enterprise-class UI designed for web applications.
|
|
- A set of high-quality Blazor components out of the box.
|
|
- Supports WebAssembly-based client-side and SignalR-based server-side UI event interaction.
|
|
- Supports Progressive Web Applications (PWA).
|
|
- Build with C#, a multi-paradigm static language for an efficient development experience.
|
|
- .NET Standard 2.1 based, with direct reference to the rich .NET ecosystem.
|
|
- Supports NET5. (Server-Side, WASM)
|
|
- Seamless integration with existing ASP.NET Core MVC and Razor Pages projects.
|
|
|
|
## Online Examples
|
|
[](https://www.blazor.zone)
|
|
[](https://argozhang.github.io)
|
|
|
|
## Installation Guide
|
|
|
|
- Install .net core sdk [Offical website](https://dotnet.microsoft.com/download)
|
|
- Install Visual Studio 2022 lastest [Offical website](https://visualstudio.microsoft.com/vs/getting-started/)
|
|
|
|
## Create a new project from the dotnet new template
|
|
|
|
1. Install the template
|
|
|
|
`dotnet new install Bootstrap.Blazor.Templates::*`
|
|
|
|
2. Create the Boilerplate project with the template
|
|
|
|
`dotnet new bbapp`
|
|
|
|
## Install Bootstrap Blazor Project Template
|
|
|
|
1. Download Project Template
|
|
|
|
Microsoft Market [link](https://marketplace.visualstudio.com/items?itemName=Longbow.BootstrapBlazorUITemplate)
|
|
|
|
2. Double Click **BootstrapBlazor.UITemplate.vsix**
|
|
|
|
## Import Bootstrap Blazor into an existing project
|
|
|
|
1. Go to the project folder of the application and install the Nuget package reference
|
|
|
|
`dotnet add package BootstrapBlazor`
|
|
|
|
2. **Add** the `stylesheet` `javascripts` file to your main index file - `Pages/_Host.cshtml (Server)` or `wwwroot/index.html (WebAssembly)`
|
|
|
|
**HTML**
|
|
|
|
```HTML
|
|
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
. . .
|
|
<link rel="stylesheet" href="_content/BootstrapBlazor/css/bootstrap.blazor.bundle.min.css">
|
|
</head>
|
|
<body>
|
|
. . .
|
|
<script src="_framework/blazor.server.js"></script>
|
|
<script src="_content/BootstrapBlazor/js/bootstrap.blazor.bundle.min.js"></script>
|
|
</body>
|
|
</html>
|
|
```
|
|
|
|
3. Open the `~/Startup.cs` file in the and register the `Bootstrap Blazor` service:
|
|
|
|
**C#**
|
|
|
|
```csharp
|
|
namespace BootstrapBlazorAppName
|
|
{
|
|
public class Startup
|
|
{
|
|
public void ConfigureServices(IServiceCollection services)
|
|
{
|
|
//more code may be present here
|
|
services.AddBootstrapBlazor();
|
|
}
|
|
|
|
//more code may be present here
|
|
}
|
|
}
|
|
```
|
|
|
|
## Visual Studio Integration
|
|
|
|
To create a new `Bootstrap Blazor` UI for Blazor application, use the Create New Project Wizard. The wizard detects all installed versions of `Bootstrap Blazor` for Blazor and lists them in the Version combobox—this enables you to start your project with the desired version. You can also get the latest version to make sure you are up to date.
|
|
|
|
1. Get the Wizard
|
|
|
|
To use the Create New Project Wizard, install the `Bootstrap Blazor` UI for Blazor Visual Studio Extensions. You can get it from the:
|
|
|
|
- Visual Studio Marketplace (for Windows)
|
|
|
|
2. Start the Wizard
|
|
|
|
To start the wizard, use either of the following approaches
|
|
|
|
### Using the Project menu:
|
|
|
|
- Click File > New > Project.
|
|
- Find and click the C# Blazor Application option (you can use the search, or filter by Blazor templates).
|
|
- Follow the wizard.
|
|
|
|
## Supported browsers
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### Mobile devices
|
|
|
|
|
|
|
|
|
|
|
|
| | **Chrome** | **Firefox** | **Safari** | **Android Browser & WebView** | **Microsoft Edge** |
|
|
| ------- | --------- | --------- | ------ | ------------------------- | -------------- |
|
|
| **iOS** | Supported | Supported | Supported | N/A | Supported |
|
|
| **Android** | Supported | Supported | N/A | Android v5.0+ supported | Supported |
|
|
| **Windows 10 Mobile** | N/A | N/A | N/A | N/A | Supported |
|
|
|
|
### Desktop browsers
|
|
|
|
|
|
|
|
|
|
|
|
| | Chrome | Firefox | Internet Explorer | Microsoft Edge | Opera | Safari |
|
|
| ------- | --------- | --------- | ----------------- | -------------- | --------- | ------------- |
|
|
| Mac | Supported | Supported | N/A | N/A | Supported | Supported |
|
|
| Linux | Supported | Supported | N/A | N/A | N/A | N/A |
|
|
| Windows | Supported | Supported | Supported, IE11+ | Supported | Supported | Not supported |
|
|
|
|
## Screenshots
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Contribution
|
|
|
|
1. Fork
|
|
2. Create Feat_xxx branch
|
|
3. Commit
|
|
4. Create Pull Request
|
|
|
|
## Code of Conduct
|
|
|
|
This project has adopted the code of conduct defined by the Contributor Covenant to clarify expected behavior in our community.
|
|
For more information see the [.NET Foundation Code of Conduct](https://dotnetfoundation.org/code-of-conduct).
|
|
|
|
## Donate
|
|
|
|
If this project is helpful to you, please scan the QR code below for a cup of coffee.
|
|
|
|
<img src="https://raw.githubusercontent.com/ArgoZhang/Images/master/Donate/BarCode%402x.png" width="382px;" />
|