mirror of https://github.com/abpframework/abp
Merge pull request #12663 from abpframework/issue-12540
Add docs for AbpLoadingDirectivepull/12709/head
commit
01114a9f69
@ -0,0 +1,44 @@
|
||||
# Loading Directive
|
||||
|
||||
|
||||
You may want to block a part of the UI and show a spinner for a while; the `LoadingDirective` directive makes this for you. `LoadingDirective` has been exposed by the `@abp/ng.theme.shared` package.
|
||||
|
||||
|
||||
## Getting Started
|
||||
|
||||
In order to use the `LoadingDirective` in an HTML template, the **`ThemeSharedModule`** should be imported into your module like this:
|
||||
|
||||
```js
|
||||
// ...
|
||||
import { ThemeSharedModule } from '@abp/ng.theme.shared';
|
||||
|
||||
@NgModule({
|
||||
//...
|
||||
imports: [..., ThemeSharedModule],
|
||||
})
|
||||
export class MyFeatureModule {}
|
||||
```
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
The `LoadingDirective` is easy to use. The directive's selector is **`abpLoading`**. By adding the `abpLoading` attribute to an HTML element, you can activate the `LoadingDirectiveective` for the HTML element when the value is true.
|
||||
|
||||
See an example usage:
|
||||
|
||||
```html
|
||||
<div [abpLoading]="true">
|
||||
Lorem ipsum dolor sit, amet consectetur adipisicing elit. Laboriosam commodi quae aspernatur,
|
||||
corporis velit et suscipit id consequuntur amet minima expedita cum reiciendis dolorum
|
||||
cupiditate? Voluptas eaque voluptatum odio deleniti quo vel illum nemo accusamus nulla ratione
|
||||
impedit dolorum expedita necessitatibus fugiat ullam beatae, optio eum cupiditate ducimus
|
||||
architecto.
|
||||
</div>
|
||||
```
|
||||
|
||||
|
||||
The `abpLoading` attribute has been added to the `<div>` element that contains very a long text inside to activate the `LoadingDirective`.
|
||||
|
||||
See the result:
|
||||
|
||||

|
After Width: | Height: | Size: 54 KiB |
Loading…
Reference in new issue