Merge pull request #40 from abpio/module-docs-angular-ui

Added details for Angular UI to each module document

en/Modules/chat.md

@@ -98,7 +98,6 @@ This module follows the [module development best practices guide](https://docs.a
 
 * @volo/chat (MVC)
 * @volo/abp.ng.chat (Angular)
-* @volo/abp.ng.chat.config (Angular)
 
 ## User interface
 
@@ -197,6 +196,52 @@ See the [connection strings](https://docs.abp.io/en/abp/latest/Connection-String
 * **ChatUserMessages**
 * **ChatConversations**
 
+
+### Angular UI
+
+#### Installation
+
+In order to configure the application to use the `ChatModule`, you first need to import `ChatConfigModule` from `@volo/abp.ng.chat/config` to root module. `ChatConfigModule` has a static `forRoot` method which you should call for a proper configuration.
+
+```js
+// app.module.ts
+import { ChatConfigModule } from '@volo/abp.ng.chat/config';
+
+@NgModule({
+  imports: [
+    // other imports
+    ChatConfigModule.forRoot(),
+    // other imports
+  ],
+  // ...
+})
+export class AppModule {}
+```
+
+The `ChatModule` should be imported and lazy-loaded in your routing module. It has a static `forLazy` method for configuration. It is available for import from `@volo/abp.ng.chat`.
+
+```js
+// app-routing.module.ts
+const routes: Routes = [
+  // other route definitions
+  {
+    path: 'chat',
+    loadChildren: () =>
+      import('@volo/abp.ng.chat').then(m => m.ChatModule.forLazy(/* options here */)),
+  },
+];
+
+@NgModule(/* AppRoutingModule metadata */)
+export class AppRoutingModule {}
+```
+
+#### Services
+
+The `@volo/abp.ng.chat` package exports the following services which cover HTTP requests to counterpart APIs:
+
+**ConversationService** and **ContactService:** covers several methods that performing HTTP calls for `Chat` page.
+
+
 ## Distributed Events
 
 This module defines an event for messaging. It is published when a new message is sent from a user to another user, with an Event Transfer Object type of `ChatMessageEto`. See the [standard distributed events](https://docs.abp.io/en/abp/latest/Distributed-Event-Bus) for more information about distributed events.

en/modules/account.md

@@ -35,7 +35,6 @@ This module follows the [module development best practices guide](https://docs.a
 ### NPM Packages
 
 * @volo/abp.ng.account
-* @volo/abp.ng.account.config
 
 ## User Interface
 
@@ -111,6 +110,66 @@ See the `IAccountSettingNames` class members for all settings defined for this m
 
 See the `AccountPermissions` class members for all permissions defined for this module.
 
+
+### Angular UI
+
+#### Installation
+
+In order to configure the application to use the `AccountModule`, you first need to import `AccountConfigModule` from `@volo/abp.ng.account/config` to root module. `AccountConfigModule` has a static `forRoot` method which you should call for a proper configuration.
+
+```js
+// app.module.ts
+import { AccountConfigModule } from '@volo/abp.ng.account/config';
+
+@NgModule({
+  imports: [
+    // other imports
+    AccountConfigModule.forRoot(),
+    // other imports
+  ],
+  // ...
+})
+export class AppModule {}
+```
+
+The `AccountModule` should be imported and lazy-loaded in your routing module. It has a static `forLazy` method for configuration. Available options are listed below. It is available for import from `@volo/abp.ng.account`.
+
+```js
+// app-routing.module.ts
+const routes: Routes = [
+  // other route definitions
+  {
+    path: 'account',
+    loadChildren: () =>
+      import('@volo/abp.ng.account').then(m => m.AccountModule.forLazy(/* options here */)),
+  },
+];
+
+@NgModule(/* AppRoutingModule metadata */)
+export class AppRoutingModule {}
+```
+
+> If you have generated your project via the startup template, you do not have to do anything, because it already has both `AccountConfigModule` and `AccountModule`.
+
+<h4 id="h-account-module-options">Options</h4>
+
+You can modify the look and behavior of the module pages by passing the following options to `AccountModule.forLazy` static method:
+
+- **redirectUrl:** Default redirect URL after logging in.
+
+#### Services
+
+The `@volo/abp.ng.account` package exports the following services which cover HTTP requests to counterpart APIs:
+
+- **AccountService:** Covers several methods that performing HTTP calls for `Login`, `Register`, `Change Password`, `Forgot Password`, and `Manage Profile` pages.
+
+
+#### AccountModule Replaceable Components
+
+`eAccountComponents` enum provides all replaceable component keys. It is available for import from `@volo/abp.ng.account`.
+
+Please check [Component Replacement document](https://docs.abp.io/en/abp/latest/UI/Angular/Component-Replacement) for details.
+
 ## Distributed Events
 
 This module doesn't define any additional distributed event. See the [standard distributed events](https://docs.abp.io/en/abp/latest/Distributed-Event-Bus).

en/modules/audit-logging.md

@@ -34,7 +34,6 @@ This module follows the [module development best practices guide](https://docs.a
 ### NPM packages
 
 * @volo/abp.ng.audit-logging
-* @volo/abp.ng.audit-logging.config
 
 ## User interface
 
@@ -174,6 +173,70 @@ See the [connection strings](https://docs.abp.io/en/abp/latest/Connection-String
 
 See the `AbpAuditLoggingPermissions` class members for all permissions defined for this module.
 
+
+### Angular UI
+
+#### Installation
+
+In order to configure the application to use the `AuditLoggingModule`, you first need to import `AuditLoggingConfigModule` from `@volo/abp.ng.audit-logging/config` to root module. `AuditLoggingConfigModule` has a static `forRoot` method which you should call for a proper configuration.
+
+```js
+// app.module.ts
+import { AuditLoggingConfigModule } from '@volo/abp.ng.audit-logging/config';
+
+@NgModule({
+  imports: [
+    // other imports
+    AuditLoggingConfigModule.forRoot(),
+    // other imports
+  ],
+  // ...
+})
+export class AppModule {}
+```
+
+The `AuditLoggingModule` should be imported and lazy-loaded in your routing module. It has a static `forLazy` method for configuration. Available options are listed below. It is available for import from `@volo/abp.ng.audit-logging`.
+
+```js
+// app-routing.module.ts
+const routes: Routes = [
+  // other route definitions
+  {
+    path: 'audit-logs',
+    loadChildren: () =>
+      import('@volo/abp.ng.audit-logging').then(m => m.AuditLoggingModule.forLazy(/* options here */)),
+  },
+];
+
+@NgModule(/* AppRoutingModule metadata */)
+export class AppRoutingModule {}
+```
+
+> If you have generated your project via the startup template, you do not have to do anything, because it already has both `AuditLoggingConfigModule` and `AuditLoggingModule`.
+
+<h4 id="h-audit-logging-module-options">Options</h4>
+
+You can modify the look and behavior of the module pages by passing the following options to `AuditLoggingModule.forLazy` static method:
+
+- **entityActionContributors:** Changes grid actions. Please check [Entity Action Extensions for Angular](https://docs.abp.io/en/commercial/latest/ui/angular/entity-action-extensions) for details.
+- **toolbarActionContributors:** Changes page toolbar. Please check [Page Toolbar Extensions for Angular](https://docs.abp.io/en/commercial/latest/ui/angular/page-toolbar-extensions) for details.
+- **entityPropContributors:** Changes table columns. Please check [Data Table Column Extensions for Angular](https://docs.abp.io/en/commercial/latest/ui/angular/data-table-column-extensions) for details.
+
+
+#### Services
+
+The `@volo/abp.ng.audit-logging` package exports the following services which cover HTTP requests to counterpart APIs:
+
+- **AuditLoggingService:** Covers several methods that performing HTTP calls for `Audit Logs` page.
+- **EntityChangeService:** Covers several methods that performing HTTP calls for `Entity Changes` tab in `Audit Logs` page.
+
+
+#### AuditLoggingModule Replaceable Components
+
+`eAuditLoggingComponents` enum provides all replaceable component keys. It is available for import from `@volo/abp.ng.audit-logging`.
+
+Please check [Component Replacement document](https://docs.abp.io/en/abp/latest/UI/Angular/Component-Replacement) for details.
+
 ## Distributed Events
 
 This module doesn't define any additional distributed event. See the [standard distributed events](https://docs.abp.io/en/abp/latest/Distributed-Event-Bus).

en/modules/identity-server.md

@@ -35,7 +35,6 @@ This module follows the [module development best practices guide](https://docs.a
 ### NPM Packages
 
 * @volo/abp.ng.identity-server
-* @volo/abp.ng.identity-server.config
 
 ## User Interface
 
@@ -255,6 +254,71 @@ See the [connection strings](https://docs.abp.io/en/abp/latest/Connection-String
 
 See the `AbpIdentityServerPermissions` class members for all permissions defined for this module.
 
+### Angular UI
+
+#### Installation
+
+In order to configure the application to use the `IdentityServerModule`, you first need to import `IdentityServerConfigModule` from `@volo/abp.ng.identity-server/config` to root module. `IdentityServerConfigModule` has a static `forRoot` method which you should call for a proper configuration.
+
+```js
+// app.module.ts
+import { IdentityServerConfigModule } from '@volo/abp.ng.identity-server/config';
+
+@NgModule({
+  imports: [
+    // other imports
+    IdentityServerConfigModule.forRoot(),
+    // other imports
+  ],
+  // ...
+})
+export class AppModule {}
+```
+
+The `IdentityServerModule` should be imported and lazy-loaded in your routing module. It has a static `forLazy` method for configuration. Available options are listed below. It is available for import from `@volo/abp.ng.identity-server`.
+
+```js
+// app-routing.module.ts
+const routes: Routes = [
+  // other route definitions
+  {
+    path: 'identity-server',
+    loadChildren: () =>
+      import('@volo/abp.ng.identity-server').then(m => m.IdentityServerModule.forLazy(/* options here */)),
+  },
+];
+
+@NgModule(/* AppRoutingModule metadata */)
+export class AppRoutingModule {}
+```
+
+> If you have generated your project via the startup template, you do not have to do anything, because it already has both `IdentityServerConfigModule` and `IdentityServerModule`.
+
+<h4 id="h-identity-server-module-options">Options</h4>
+
+You can modify the look and behavior of the module pages by passing the following options to `IdentityServerModule.forLazy` static method:
+
+- **entityActionContributors:** Changes grid actions. Please check [Entity Action Extensions for Angular](https://docs.abp.io/en/commercial/latest/ui/angular/entity-action-extensions) for details.
+- **toolbarActionContributors:** Changes page toolbar. Please check [Page Toolbar Extensions for Angular](https://docs.abp.io/en/commercial/latest/ui/angular/page-toolbar-extensions) for details.
+- **entityPropContributors:** Changes table columns. Please check [Data Table Column Extensions for Angular](https://docs.abp.io/en/commercial/latest/ui/angular/data-table-column-extensions) for details.
+- **createFormPropContributors:** Changes create form fields. Please check [Dynamic Form Extensions for Angular](https://docs.abp.io/en/commercial/latest/ui/angular/dynamic-form-extensions) for details.
+- **editFormPropContributors:** Changes create form fields. Please check [Dynamic Form Extensions for Angular](https://docs.abp.io/en/commercial/latest/ui/angular/dynamic-form-extensions) for details.
+
+
+#### Services
+
+The `@volo/abp.ng.identity-server` package exports the following services which cover HTTP requests to counterpart APIs:
+
+- **IdentityServerService:** Covers several methods that performing HTTP calls for `Clients`, `Identity Resources`, and `Api Resources` pages.
+
+
+#### IdentityServerModule Replaceable Components
+
+`eIdentityServerComponents` enum provides all replaceable component keys. It is available for import from `@volo/abp.ng.identity-server`.
+
+Please check [Component Replacement document](https://docs.abp.io/en/abp/latest/UI/Angular/Component-Replacement) for details.
+
+
 ## Distributed Events
 
 This module defines events for `Client` aggregate and `ClientCorsOrigin` entity. When a `Client` or  `ClientCorsOrigin` changes, `AllowedCorsOriginsCacheItemInvalidator` invalidates the cache for `AllowedCorsOriginsCacheItem`. See the [standard distributed events](https://docs.abp.io/en/abp/latest/Distributed-Event-Bus) for more information about distributed events.

en/modules/identity.md

@@ -37,7 +37,6 @@ This module follows the [module development best practices guide](https://docs.a
 ### NPM packages
 
 * @volo/abp.ng.identity
-* @volo/abp.ng.identity.config
 
 ## User interface
 
@@ -282,6 +281,73 @@ See the [connection strings](https://docs.abp.io/en/abp/latest/Connection-String
 
 See the `IdentityPermissions` class members for all permissions defined for this module.
 
+### Angular UI
+
+#### Installation
+
+In order to configure the application to use the `IdentityModule`, you first need to import `IdentityConfigModule` from `@volo/abp.ng.identity/config` to root module. `IdentityConfigModule` has a static `forRoot` method which you should call for a proper configuration.
+
+```js
+// app.module.ts
+import { IdentityConfigModule } from '@volo/abp.ng.identity/config';
+
+@NgModule({
+  imports: [
+    // other imports
+    IdentityConfigModule.forRoot(),
+    // other imports
+  ],
+  // ...
+})
+export class AppModule {}
+```
+
+The `IdentityModule` should be imported and lazy-loaded in your routing module. It has a static `forLazy` method for configuration. Available options are listed below. It is available for import from `@volo/abp.ng.identity`.
+
+```js
+// app-routing.module.ts
+const routes: Routes = [
+  // other route definitions
+  {
+    path: 'identity',
+    loadChildren: () =>
+      import('@volo/abp.ng.identity').then(m => m.IdentityModule.forLazy(/* options here */)),
+  },
+];
+
+@NgModule(/* AppRoutingModule metadata */)
+export class AppRoutingModule {}
+```
+
+> If you have generated your project via the startup template, you do not have to do anything, because it already has both `IdentityConfigModule` and `IdentityModule`.
+
+<h4 id="h-identity-module-options">Options</h4>
+
+You can modify the look and behavior of the module pages by passing the following options to `IdentityModule.forLazy` static method:
+
+- **entityActionContributors:** Changes grid actions. Please check [Entity Action Extensions for Angular](https://docs.abp.io/en/commercial/latest/ui/angular/entity-action-extensions) for details.
+- **toolbarActionContributors:** Changes page toolbar. Please check [Page Toolbar Extensions for Angular](https://docs.abp.io/en/commercial/latest/ui/angular/page-toolbar-extensions) for details.
+- **entityPropContributors:** Changes table columns. Please check [Data Table Column Extensions for Angular](https://docs.abp.io/en/commercial/latest/ui/angular/data-table-column-extensions) for details.
+- **createFormPropContributors:** Changes create form fields. Please check [Dynamic Form Extensions for Angular](https://docs.abp.io/en/commercial/latest/ui/angular/dynamic-form-extensions) for details.
+- **editFormPropContributors:** Changes create form fields. Please check [Dynamic Form Extensions for Angular](https://docs.abp.io/en/commercial/latest/ui/angular/dynamic-form-extensions) for details.
+
+
+
+#### Services
+
+The `@volo/abp.ng.identity` package exports the following services which cover HTTP requests to counterpart APIs:
+
+- **IdentityService:** Covers several methods that performing HTTP calls for `Roles`, `Users`, and `Claims` pages.
+- **OrganizationUnitService:** Covers several methods that performing HTTP calls for `Organization Units` page.
+
+
+#### IdentityModule Replaceable Components
+
+`eIdentityComponents` enum provides all replaceable component keys. It is available for import from `@volo/abp.ng.identity`.
+
+Please check [Component Replacement document](https://docs.abp.io/en/abp/latest/UI/Angular/Component-Replacement) for details.
+
+
 ## Distributed Events
 
-This module doesn't define any additional distributed event. See the [standard distributed events](https://docs.abp.io/en/abp/latest/Distributed-Event-Bus).
+This module doesn't define any additional distributed event. See the [standard distributed events](https://docs.abp.io/en/abp/latest/Distributed-Event-Bus).