|
2 | 2 |
|
3 | 3 | ## an enterprise-level UI component library based on Bootstrap and Blazor. |
4 | 4 |
|
5 | | -<h4>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>. </h4> |
| 5 | +This project is part of the [.NET Foundation](https://www.dotnetfoundation.org/) and operates under their [Code Of Conduct](https://www.dotnetfoundation.org/code-of-conduct) |
6 | 6 |
|
7 | | -[](https://github.com/dotnetcore/BootstrapBlazor/blob/main/LICENSE) |
| 7 | +[](https://github.com/dotnetcore/BootstrapBlazor/blob/main/LICENSE) |
8 | 8 | [](https://github.com/dotnetcore/BootstrapBlazor/actions?query=workflow%3A%22Build+Project%22+branch%3Amain) |
9 | 9 | [](https://github.com/dotnetcore/BootstrapBlazor) |
10 | 10 | [](https://github.com/dotnetcore/BootstrapBlazor) |
11 | 11 | [](https://codecov.io/gh/dotnetcore/BootstrapBlazor) |
12 | 12 |
|
13 | 13 | --- |
14 | 14 |
|
15 | | -## Features |
16 | | -- Enterprise-class UI designed for web applications. |
17 | | -- A set of high-quality Blazor components out of the box. |
18 | | -- Supports WebAssembly-based client-side and SignalR-based server-side UI event interaction. |
19 | | -- Supports Progressive Web Applications (PWA). |
20 | | -- Build with C#, a multi-paradigm static language for an efficient development experience. |
21 | | -- .NET Standard 2.1 based, with direct reference to the rich .NET ecosystem. |
22 | | -- Supports NET5. (Server-Side, WASM) |
23 | | -- Seamless integration with existing ASP.NET Core MVC and Razor Pages projects. |
24 | | - |
25 | 15 | ## Online Examples |
26 | | -[](https://www.blazor.zone) |
27 | | - |
28 | | -## Installation Guide |
| 16 | +[](https://www.blazor.zone) |
29 | 17 |
|
30 | | -- Install .net core sdk [Official website](https://dotnet.microsoft.com/download?wt.mc_id=DT-MVP-5004174) |
31 | | -- Install Visual Studio latest [Official website](https://visualstudio.microsoft.com/vs/getting-started?wt.mc_id=DT-MVP-5004174) |
| 18 | +## Quick Installation Guide |
32 | 19 |
|
33 | | -```shell |
34 | | -git clone https://github.com/dotnetcore/BootstrapBlazor.git |
35 | | -cd BootstrapBlazor/src/BootstrapBlazor.Server |
36 | | -dotnet run |
| 20 | +### Install Package |
| 21 | +``` |
| 22 | +dotnet add package BootstrapBlazor |
37 | 23 | ``` |
38 | 24 |
|
39 | | -## Create a new project from the dotnet new template |
40 | | - |
41 | | -1. Install the template |
42 | | - |
43 | | -`dotnet new install Bootstrap.Blazor.Templates::*` |
44 | | - |
45 | | -2. Create the Boilerplate project with the template |
46 | | - |
47 | | -`dotnet new bbapp` |
48 | | - |
49 | | -## Install Bootstrap Blazor Project Template |
50 | | - |
51 | | -1. Download Project Template |
52 | | - |
53 | | -Microsoft Market [link](https://marketplace.visualstudio.com/items?itemName=Longbow.BootstrapBlazorUITemplate&wt.mc_id=DT-MVP-5004174) |
54 | | - |
55 | | -2. Double Click **BootstrapBlazor.UITemplate.vsix** |
| 25 | +### Add the following to `_Imports.razor` |
| 26 | +``` |
| 27 | +@using BootstrapBlazor.Components |
| 28 | +``` |
56 | 29 |
|
57 | | -## Import Bootstrap Blazor into an existing project |
| 30 | +### Add the following to the `MainLayout.razor` |
| 31 | +```html |
| 32 | +<BootstrapBlazorRoot> |
| 33 | + @Body |
| 34 | +</BootstrapBlazorRoot> |
| 35 | +``` |
58 | 36 |
|
59 | | -1. Go to the project folder of the application and install the Nuget package reference |
| 37 | +### Add the following to your HTML head section |
| 38 | +it's either **index.html** or **_Layout.cshtml/_Host.cshtml/App.razor** depending on whether you're running WebAssembly or Server |
| 39 | +```html |
| 40 | +<link rel="stylesheet" href="_content/BootstrapBlazor/css/bootstrap.blazor.bundle.min.css" /> |
| 41 | +``` |
60 | 42 |
|
61 | | -`dotnet add package BootstrapBlazor` |
| 43 | +### Add the following script at the end of the body |
| 44 | +```html |
| 45 | +<script src="_content/BootstrapBlazor/js/bootstrap.blazor.bundle.min.js"></script> |
| 46 | +``` |
62 | 47 |
|
63 | | -2. **Add** the `stylesheet` `javascripts` file to your main index file - `Pages/_Host.cshtml (Server)` or `wwwroot/index.html (WebAssembly)` |
| 48 | +### Add the following to the relevant sections of `Program.cs` |
| 49 | +```csharp |
| 50 | +builder.Services.AddBootstrapBlazor(); |
| 51 | +``` |
64 | 52 |
|
65 | | - **HTML** |
| 53 | +## Usage |
| 54 | +```razor |
| 55 | +<Display Value="@_text"></Display> |
| 56 | +<Button Text="Button" OnClick="@ClickButton"></Button> |
| 57 | +
|
| 58 | +@code { |
| 59 | + private string? _text; |
| 60 | + private void ClickButton(MouseEventArgs e) |
| 61 | + { |
| 62 | + _text = DateTime.Now.ToString(); |
| 63 | + } |
| 64 | +} |
| 65 | +``` |
66 | 66 |
|
| 67 | +## Install CLI Template |
| 68 | +1. Install the template |
67 | 69 | ``` |
68 | | -<!DOCTYPE html> |
69 | | -<html lang="en"> |
70 | | -<head> |
71 | | - . . . |
72 | | - <link rel="stylesheet" href="_content/BootstrapBlazor/css/bootstrap.blazor.bundle.min.css"> |
73 | | -</head> |
74 | | -<body> |
75 | | - . . . |
76 | | - <script src="_content/BootstrapBlazor/js/bootstrap.blazor.bundle.min.js"></script> |
77 | | -</body> |
78 | | -</html> |
| 70 | +dotnet new install Bootstrap.Blazor.Templates::* |
79 | 71 | ``` |
80 | 72 |
|
81 | | -3. Open the `Program.cs` file in the and register the `Bootstrap Blazor` service: |
82 | | - |
83 | | - **C#** |
84 | | - |
| 73 | +2. Create the Boilerplate project with the template |
85 | 74 | ``` |
86 | | -builder.Services.AddBootstrapBlazorServices(); |
| 75 | +dotnet new bbapp |
87 | 76 | ``` |
88 | 77 |
|
89 | | -## Visual Studio Integration |
90 | | - |
91 | | -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. |
92 | | - |
93 | | -1. Get the Wizard |
94 | | - |
95 | | -To use the Create New Project Wizard, install the `Bootstrap Blazor` UI for Blazor Visual Studio Extensions. You can get it from the: |
96 | | - |
97 | | -- Visual Studio Marketplace (for Windows) |
98 | | - |
99 | | -2. Start the Wizard |
100 | | - |
101 | | -To start the wizard, use either of the following approaches |
102 | | - |
103 | | -### Using the Project menu: |
104 | | - |
105 | | -- Click File > New > Project. |
106 | | -- Find and click the C# Blazor Application option (you can use the search, or filter by Blazor templates). |
107 | | -- Follow the wizard. |
108 | | - |
109 | 78 | ## Code of conduct |
110 | 79 |
|
111 | 80 | This project has adopted the code of conduct defined by the Contributor Covenant to clarify expected behavior in our community. |
|
0 commit comments