mirror of https://github.com/abpframework/abp
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
148 lines
5.7 KiB
148 lines
5.7 KiB
# Blazor UI: Basic Theme
|
|
|
|
````json
|
|
//[doc-params]
|
|
{
|
|
"UI": ["Blazor", "BlazorServer"]
|
|
}
|
|
````
|
|
|
|
The Basic Theme is a theme implementation for the Blazor UI. It is a minimalist theme that doesn't add any styling on top of the plain [Bootstrap](https://getbootstrap.com/). You can take the Basic Theme as the **base theme** and build your own theme or styling on top of it. See the *Customization* section.
|
|
|
|
> If you are looking for a professional, enterprise ready theme, you can check the [Lepton Theme](https://commercial.abp.io/themes), which is a part of the [ABP Commercial](https://commercial.abp.io/).
|
|
|
|
> See the [Theming document](Theming.md) to learn about themes.
|
|
|
|
## Installation
|
|
|
|
If you need to manually this theme, follow the steps below:
|
|
|
|
{{if UI == "Blazor"}}
|
|
|
|
* Install the [Volo.Abp.AspNetCore.Components.WebAssembly.BasicTheme](https://www.nuget.org/packages/Volo.Abp.AspNetCore.Components.WebAssembly.BasicTheme) NuGet package to your web project.
|
|
* Add `AbpAspNetCoreComponentsWebAssemblyBasicThemeModule` into the `[DependsOn(...)]` attribute for your [module class](../../Module-Development-Basics.md) in the your Blazor UI project.
|
|
* Use `Volo.Abp.AspNetCore.Components.WebAssembly.BasicTheme.Themes.Basic.App` as the root component of your application in the `ConfigureServices` method of your module:
|
|
|
|
```csharp
|
|
var builder = context.Services.GetSingletonInstance<WebAssemblyHostBuilder>();
|
|
builder.RootComponents.Add<App>("#ApplicationContainer");
|
|
```
|
|
`#ApplicationContainer` is a selector (like `<div id="ApplicationContainer">Loading...</div>`) in the `index.html`.
|
|
|
|
* Execute `abp bundle` command under blazor project once.
|
|
|
|
{{end}}
|
|
|
|
{{if UI == "BlazorServer"}}
|
|
|
|
* Make sure [AspNetCore Basic Theme](../AspNetCore/Basic-Theme.md) installation steps are completed.
|
|
|
|
* Install the [Volo.Abp.AspNetCore.Components.Server.BasicTheme](https://www.nuget.org/packages/Volo.Abp.AspNetCore.Components.Server.BasicTheme) NuGet package to your web project.
|
|
|
|
* Add `AbpAspNetCoreComponentsServerBasicThemeModule` into the `[DependsOn(...)]` attribute for your [module class](../../Module-Development-Basics.md) in the your Blazor UI project.
|
|
|
|
* Perform following changes in `Pages/_Host.cshtml` file
|
|
* Add usings at the top of the page.
|
|
```html
|
|
@using Volo.Abp.AspNetCore.Components.Server.BasicTheme.Bundling
|
|
@using Volo.Abp.AspNetCore.Components.Web.BasicTheme.Themes.Basic
|
|
```
|
|
* Add Basic theme style bundles between `<head>` tags.
|
|
```html
|
|
<abp-style-bundle name="@BlazorBasicThemeBundles.Styles.Global" />
|
|
```
|
|
* Add `App` component of Basic Theme in the body section of page.
|
|
```html
|
|
<component type="typeof(App)" render-mode="Server" />
|
|
```
|
|
|
|
{{end}}
|
|
|
|
## The Layout
|
|
|
|
|
|
|
|
Application Layout implements the following parts, in addition to the common parts mentioned above;
|
|
|
|
* [Branding](Branding.md) Area
|
|
* Main [Menu](Navigation-Menu.md)
|
|
* Main [Toolbar](Toolbars.md) with Language Selection & User Menu
|
|
* [Page Alerts](Page-Alerts.md)
|
|
|
|
## Customization
|
|
|
|
You have two options two customize this theme:
|
|
|
|
### Overriding Styles / Components
|
|
|
|
In this approach, you continue to use the theme as NuGet and NPM packages and customize the parts you need to. There are several ways to customize it;
|
|
|
|
#### Override the Styles
|
|
|
|
You can simply override the styles in the Global Styles file of your application.
|
|
|
|
#### Override the Components
|
|
|
|
See the [Customization / Overriding Components](Customization-Overriding-Components.md) to learn how you can replace components, customize and extend the user interface.
|
|
|
|
### Overriding the Menu Item
|
|
Basic theme supports overriding a single menu item with a custom component. You can create a custom component and call `UseComponent` extension method of Basic Theme in the **MenuContributor**.
|
|
|
|
```csharp
|
|
using Volo.Abp.AspNetCore.Components.Web.BasicTheme.Navigation;
|
|
|
|
//...
|
|
|
|
context.Menu.Items.Add(
|
|
new ApplicationMenuItem("Custom.1", "My Custom Menu", "#")
|
|
.UseComponent(typeof(MyMenuItemComponent)));
|
|
```
|
|
|
|
```html
|
|
<li class="nav-item">
|
|
<a href="#" class="nav-link">
|
|
My Custom Menu
|
|
</a>
|
|
</li>
|
|
```
|
|
|
|
### Copy & Customize
|
|
|
|
You can run the following [ABP CLI](../../CLI.md) command in **Blazor{{if UI == "Blazor"}}WebAssembly{{else}} Server{{end}}** project directory to copy the source code to your solution:
|
|
|
|
{{if UI == "Blazor"}}
|
|
|
|
`abp add-package Volo.Abp.AspNetCore.Components.WebAssembly.BasicTheme --with-source-code --add-to-solution-file`
|
|
|
|
Then, navigate to downloaded `Volo.Abp.AspNetCore.Components.WebAssembly.BasicTheme` project directory and run:
|
|
|
|
`abp add-package Volo.Abp.AspNetCore.Components.Web.BasicTheme --with-source-code --add-to-solution-file`
|
|
|
|
{{end}}
|
|
|
|
{{if UI == "BlazorServer"}}
|
|
|
|
`abp add-package Volo.Abp.AspNetCore.Components.Server.BasicTheme --with-source-code --add-to-solution-file`
|
|
|
|
Then, navigate to downloaded `Volo.Abp.AspNetCore.Components.Server.BasicTheme` project directory and run:
|
|
|
|
`abp add-package Volo.Abp.AspNetCore.Components.Web.BasicTheme --with-source-code --add-to-solution-file`
|
|
|
|
{{end}}
|
|
|
|
----
|
|
|
|
Or, you can download the source code of the Basic Theme, manually copy the project content into your solution, re-arrange the package/module dependencies (see the Installation section above to understand how it was installed to the project) and freely customize the theme based on your application requirements.
|
|
|
|
{{if UI == "Blazor"}}
|
|
- [Basic Theme Source Code](https://github.com/abpframework/abp/blob/dev/modules/basic-theme/src/Volo.Abp.AspNetCore.Components.WebAssembly.BasicTheme)
|
|
{{end}}
|
|
|
|
{{if UI == "BlazorServer"}}
|
|
- [Basic Theme Source Code](https://github.com/abpframework/abp/blob/dev/modules/basic-theme/src/Volo.Abp.AspNetCore.Components.Server.BasicTheme)
|
|
{{end}}
|
|
|
|
## See Also
|
|
|
|
* [Theming](Theming.md)
|