mirror of https://github.com/abpframework/abp
Halil İbrahim Kalkan
5 years ago
commit
7b031cb30d
@ -1,3 +1,45 @@
|
||||
# ASP.NET Core MVC / Razor Pages: Branding
|
||||
|
||||
TODO
|
||||
## IBrandingProvider
|
||||
|
||||
`IBrandingProvider` is a simple interface that is used to show the application name and logo on the layout.
|
||||
|
||||
The screenshot below shows *MyProject* as the application name:
|
||||
|
||||
|
||||
|
||||
You can implement the `IBrandingProvider` interface or inherit from the `DefaultBrandingProvider` to set the application name:
|
||||
|
||||
````csharp
|
||||
using Volo.Abp.AspNetCore.Mvc.UI.Theme.Shared.Components;
|
||||
using Volo.Abp.DependencyInjection;
|
||||
|
||||
namespace MyProject.Web
|
||||
{
|
||||
[Dependency(ReplaceServices = true)]
|
||||
public class MyProjectBrandingProvider : DefaultBrandingProvider
|
||||
{
|
||||
public override string AppName => "Book Store";
|
||||
}
|
||||
}
|
||||
````
|
||||
|
||||
The result will be like shown below:
|
||||
|
||||
|
||||
|
||||
`IBrandingProvider` has the following properties:
|
||||
|
||||
* `AppName`: The application name.
|
||||
* `LogoUrl`: A URL to show the application logo.
|
||||
* `LogoReverseUrl`: A URL to show the application logo on a reverse color theme (dark, for example).
|
||||
|
||||
> **Tip**: `IBrandingProvider` is used in every page refresh. For a multi-tenant application, you can return a tenant specific application name to customize it per tenant.
|
||||
|
||||
## Overriding the Branding Area
|
||||
|
||||
The [Basic Theme](Basic-Theme.md) doesn't implement the logos. However, you can see the [UI Customization Guide](Customization-User-Interface.md) to learn how you can replace the branding area with a custom view component.
|
||||
|
||||
An example screenshot with an image is used in the branding area:
|
||||
|
||||
|
||||
@ -1,3 +1,91 @@
|
||||
# Dynamic JavaScript HTTP API Proxies
|
||||
# Dynamic JavaScript API Client Proxies
|
||||
|
||||
TODO
|
||||
It is typical to consume your HTTP APIs from your JavaScript code. To do that, you normally deal with low level AJAX calls, like $.ajax, or better [abp.ajax](JavaScript-API/Ajax.md). ABP Framework provides **a better way** to call your HTTP APIs from your JavaScript code: Dynamic JavaScript API Client Proxies!
|
||||
|
||||
## A Quick Example
|
||||
|
||||
Assume that you have an application service defined as shown below:
|
||||
|
||||
````csharp
|
||||
using System;
|
||||
using System.Threading.Tasks;
|
||||
using Volo.Abp.Application.Dtos;
|
||||
using Volo.Abp.Application.Services;
|
||||
|
||||
namespace Acme.BookStore.Authors
|
||||
{
|
||||
public interface IAuthorAppService : IApplicationService
|
||||
{
|
||||
Task<AuthorDto> GetAsync(Guid id);
|
||||
|
||||
Task<PagedResultDto<AuthorDto>> GetListAsync(GetAuthorListDto input);
|
||||
|
||||
Task<AuthorDto> CreateAsync(CreateAuthorDto input);
|
||||
|
||||
Task UpdateAsync(Guid id, UpdateAuthorDto input);
|
||||
|
||||
Task DeleteAsync(Guid id);
|
||||
}
|
||||
}
|
||||
````
|
||||
|
||||
> You can follow the [web application development tutorial](../../Tutorials/Part-1.md) to learn how to create [application services](../../Application-Services.md), expose them as [HTTP APIs](../../API/Auto-API-Controllers.md) and consume from the JavaScript code as a complete example.
|
||||
|
||||
You can call any of the methods just like calling a JavaScript function. The JavaScript function has the identical function **name**, **parameters** and the **return value** with the C# method.
|
||||
|
||||
**Example: Get the authors list**
|
||||
|
||||
````js
|
||||
acme.bookStore.authors.author.getList({
|
||||
maxResultCount: 10
|
||||
}).then(function(result){
|
||||
console.log(result.items);
|
||||
});
|
||||
````
|
||||
|
||||
**Example: Delete an author**
|
||||
|
||||
```js
|
||||
acme.bookStore.authors.author
|
||||
.delete('7245a066-5457-4941-8aa7-3004778775f0') //Get id from somewhere!
|
||||
.then(function() {
|
||||
abp.notify.info('Successfully deleted!');
|
||||
});
|
||||
```
|
||||
|
||||
## AJAX Details
|
||||
|
||||
Dynamic JavaScript client proxy functions use the [abp.ajax](JavaScript-API/Ajax.md) under the hood. So, you have the same benefits like **automatic error handling**. Also, you can fully control the AJAX call by providing the options.
|
||||
|
||||
### The Return Value
|
||||
|
||||
Every function returns a [Deferred object](https://api.jquery.com/category/deferred-object/). That means you can chain with `then` to get the result, `catch` to handle the error, `always` to perform an action once the operation completes (success or failed).
|
||||
|
||||
### AJAX Options
|
||||
|
||||
Every function gets an additional **last parameter** after your own parameters. The last parameter is called as `ajaxParams`. It is an object that overrides the AJAX options.
|
||||
|
||||
**Example: Set `type` and `dataType` AJAX options**
|
||||
|
||||
````js
|
||||
acme.bookStore.authors.author
|
||||
.delete('7245a066-5457-4941-8aa7-3004778775f0', {
|
||||
type: 'POST',
|
||||
dataType: 'xml'
|
||||
})
|
||||
.then(function() {
|
||||
abp.notify.info('Successfully deleted!');
|
||||
});
|
||||
````
|
||||
|
||||
See the [jQuery.ajax](https://api.jquery.com/jQuery.ajax/) documentation for all the available options.
|
||||
|
||||
## Service Proxy Script Endpoint
|
||||
|
||||
The magic is done by the `/Abp/ServiceProxyScript` endpoint defined by the ABP Framework and automatically added to the layout. You can visit this endpoint in your application to see the client proxy function definitions. This script file is automatically generated by the ABP Framework based on the server side method definitions and the related HTTP endpoint details.
|
||||
|
||||
## See Also
|
||||
|
||||
* [Web Application Development Tutorial](../../Tutorials/Part-1.md)
|
||||
* [Auto API Controllers](../../API/Auto-API-Controllers.md)
|
||||
* [Dynamic C# API Client Proxies](../../API/Dynamic-CSharp-API-Clients.md)
|
||||
@ -1,3 +0,0 @@
|
||||
# ABP Datatables.Net Integration for ASP.NET Core UI
|
||||
|
||||
TODO
|
||||
@ -0,0 +1,159 @@
|
||||
# ASP.NET Core MVC / Razor Pages UI
|
||||
|
||||
## Introduction
|
||||
|
||||
ABP Framework provides a convenient and comfortable way of creating web applications using the ASP.NET Core MVC / Razor Pages as the User Interface framework.
|
||||
|
||||
> ABP doesn't offer a new/custom way of UI development. You can continue to use your current skills to create the UI. However, it offers a lot of features to make your development easier and have a more maintainable code base.
|
||||
|
||||
### MVC vs Razor Pages
|
||||
|
||||
ASP.NET Core provides two models for UI development:
|
||||
|
||||
* **[MVC (Model-View-Controller)](https://docs.microsoft.com/en-us/aspnet/core/mvc/)** is the classic way that exists from the version 1.0. This model can be used to create UI pages/components and HTTP APIs.
|
||||
* **[Razor Pages](https://docs.microsoft.com/en-us/aspnet/core/razor-pages/)** was introduced with the ASP.NET Core 2.0 as a new way to create web pages.
|
||||
|
||||
**ABP Framework supports both** of the MVC and the Razor Pages models. However, it is suggested to create the **UI pages with Razor Pages** approach and use the **MVC model to build HTTP APIs**. So, all the pre-build modules, samples and the documentation is based on the Razor Pages for the UI development, while you can always apply the MVC pattern to create your own pages.
|
||||
|
||||
### Modularity
|
||||
|
||||
[Modularity](../../Module-Development-Basics.md) is one of the key goals of the ABP Framework. It is not different for the UI; It is possible to develop modular applications and reusable application modules with isolated and reusable UI pages and components.
|
||||
|
||||
The [application startup template](../../Startup-Templates/Application.md) comes with some application modules pre-installed. These modules have their own UI pages embedded into their own NuGet packages. You don't see their code in your solution, but they work as expected on runtime.
|
||||
|
||||
## Theme System
|
||||
|
||||
ABP Framework provides a complete [Theming](Theming.md) system with the following goals:
|
||||
|
||||
* Reusable [application modules](../../Modules/Index.md) are developed **theme-independent**, so they can work with any UI theme.
|
||||
* UI theme is **decided by the final application**.
|
||||
* The theme is distributed via NuGet/NPM packages, so it is **easily upgradable**.
|
||||
* The final application can **customize** the selected theme.
|
||||
|
||||
### Current Themes
|
||||
|
||||
Currently, two themes are **officially provided**:
|
||||
|
||||
* The [Basic Theme](Basic-Theme.md) is the minimalist theme with the plain Bootstrap style. It is **open source and free**.
|
||||
* The [Lepton Theme](https://commercial.abp.io/themes) is a **commercial** theme developed by the core ABP team and is a part of the [ABP Commercial](https://commercial.abp.io/) license.
|
||||
|
||||
There are also some community-driven themes for the ABP Framework (you can search on the web).
|
||||
|
||||
### Base Libraries
|
||||
|
||||
There are a set of standard JavaScript/CSS libraries that comes pre-installed and supported by all the themes:
|
||||
|
||||
- [Twitter Bootstrap](https://getbootstrap.com/) as the fundamental HTML/CSS framework.
|
||||
- [JQuery](https://jquery.com/) for DOM manipulation.
|
||||
- [DataTables.Net](https://datatables.net/) for data grids.
|
||||
- [JQuery Validation](https://jqueryvalidation.org/) for client side & [unobtrusive](https://github.com/aspnet/jquery-validation-unobtrusive) validation
|
||||
- [FontAwesome](https://fontawesome.com/) as the fundamental CSS font library.
|
||||
- [SweetAlert](https://sweetalert.js.org/) to show fancy alert message and confirmation dialogs.
|
||||
- [Toastr](https://github.com/CodeSeven/toastr) to show toast notifications.
|
||||
- [Lodesh](https://lodash.com/) as a utility library.
|
||||
- [Luxon](https://moment.github.io/luxon/) for date/time operations.
|
||||
- [JQuery Form](https://github.com/jquery-form/form) for AJAX forms.
|
||||
- [bootstrap-datepicker](https://github.com/uxsolutions/bootstrap-datepicker) to show date pickers.
|
||||
- [Select2](https://select2.org/) for better select/combo boxes.
|
||||
- [Timeago](http://timeago.yarp.com/) to show automatically updating fuzzy timestamps.
|
||||
- [malihu-custom-scrollbar-plugin](https://github.com/malihu/malihu-custom-scrollbar-plugin) for custom scrollbars.
|
||||
|
||||
You can use these libraries directly in your applications, without needing to manually import your page.
|
||||
|
||||
### Layouts
|
||||
|
||||
The themes provide the standard layouts. So, you have responsive layouts with the standard features already implemented. The screenshot below has taken from the Application Layout of the [Basic Theme](Basic-Theme.md):
|
||||
|
||||
|
||||
|
||||
See the [Theming](Theming.md) document for more layout options and other details.
|
||||
|
||||
### Layout Parts
|
||||
|
||||
A typical layout consists of multiple parts. The [Theming](Theming.md) system provides [menus](Navigation-Menu.md), [toolbars](Toolbars.md), [layout hooks](Layout-Hooks.md) and more to dynamically control the layout by your application and the modules you are using.
|
||||
|
||||
## Features
|
||||
|
||||
This section highlights some of the features provided by the ABP Framework for the ASP.NET Core MVC / Razor Pages UI.
|
||||
|
||||
### Dynamic JavaScript API Client Proxies
|
||||
|
||||
Dynamic JavaScript API Client Proxy system allows you to consume your server side HTTP APIs from your JavaScript client code, just like calling local functions.
|
||||
|
||||
**Example: Get a list of authors from the server**
|
||||
|
||||
````js
|
||||
acme.bookStore.authors.author.getList({
|
||||
maxResultCount: 10
|
||||
}).then(function(result){
|
||||
console.log(result.items);
|
||||
});
|
||||
````
|
||||
|
||||
`acme.bookStore.authors.author.getList` is an auto-generated function that internally makes an AJAX call to the server.
|
||||
|
||||
See the [Dynamic JavaScript API Client Proxies](Dynamic-JavaScript-Proxies.md) document for more.
|
||||
|
||||
### Bootstrap Tag Helpers
|
||||
|
||||
ABP makes it easier & type safe to write Bootstrap HTML.
|
||||
|
||||
**Example: Render a Bootstrap modal**
|
||||
|
||||
````html
|
||||
<abp-modal>
|
||||
<abp-modal-header title="Modal title" />
|
||||
<abp-modal-body>
|
||||
Woohoo, you're reading this text in a modal!
|
||||
</abp-modal-body>
|
||||
<abp-modal-footer buttons="@(AbpModalButtons.Save|AbpModalButtons.Close)"></abp-modal-footer>
|
||||
</abp-modal>
|
||||
````
|
||||
|
||||
See the [Tag Helpers](Tag-Helpers/Index.md) document for more.
|
||||
|
||||
### Forms & Validation
|
||||
|
||||
ABP provides `abp-dynamic-form` and `abp-input` tag helpers to dramatically simplify to create a fully functional form that automates localization, validation and AJAX submission.
|
||||
|
||||
**Example: Use `abp-dynamic-form` to create a complete form based on a model**
|
||||
|
||||
````html
|
||||
<abp-dynamic-form abp-model="Movie" submit-button="true" />
|
||||
````
|
||||
|
||||
See the [Forms & Validation](Forms-Validation.md) document for details.
|
||||
|
||||
### Bundling & Minification / Client Side Libraries
|
||||
|
||||
ABP provides a flexible and modular Bundling & Minification system to create bundles and minify style/script files on runtime.
|
||||
|
||||
````html
|
||||
<abp-style-bundle>
|
||||
<abp-style src="/libs/bootstrap/css/bootstrap.css" />
|
||||
<abp-style src="/libs/font-awesome/css/font-awesome.css" />
|
||||
<abp-style src="/libs/toastr/toastr.css" />
|
||||
<abp-style src="/styles/my-global-style.css" />
|
||||
</abp-style-bundle>
|
||||
````
|
||||
|
||||
Also, Client Side Package Management system offers a modular and consistent way of managing 3rd-party library dependencies.
|
||||
|
||||
See the [Bundling & Minification](Bundling-Minification.md) and [Client Side Package Management](Client-Side-Package-Management.md) documents.
|
||||
|
||||
### JavaScript APIs
|
||||
|
||||
[JavaScript APIs](JavaScript-API/Index.md) provides a strong abstractions to the server side localization, settings, permissions, features... etc. They also provide a simple way to show messages and **notifications** to the user.
|
||||
|
||||
### Modals, Alerts, Widgets and More
|
||||
|
||||
ABP Framework provides a lot of built-in solutions to common application requirements;
|
||||
|
||||
* [Widget System](Widgets.md) can be used to create reusable widgets & create dashboards.
|
||||
* [Page Alerts](Page-Alerts.md) makes it easy to show alerts to the user.
|
||||
* [Modal Manager](Modals.md) provides a simple way to build and use modals.
|
||||
* [Data Tables](Data-Tables.md) integration makes straightforward to create data grids.
|
||||
|
||||
## Customization
|
||||
|
||||
There are a lot of ways to customize the theme and the UIs of the pre-built modules. You can override components, pages, static resources, bundles and more. See the [User Interface Customization Guide](Customization-User-Interface.md).
|
||||
|
After Width: | Height: | Size: 27 KiB |
|
After Width: | Height: | Size: 33 KiB |
Loading…
Reference in new issue