From 827e62f8c592e60ca36db34ec5443e858becd1f5 Mon Sep 17 00:00:00 2001 From: mehmet-erim Date: Fri, 10 Jul 2020 06:03:12 +0300 Subject: [PATCH 01/12] docs: add doc for identity module Angular UI details https://github.com/volosoft/volo/issues/2384 --- en/modules/identity.md | 87 +++++++++++++++++++++++++++++++++++++++++- 1 file changed, 86 insertions(+), 1 deletion(-) diff --git a/en/modules/identity.md b/en/modules/identity.md index b10d081a..1009a98a 100644 --- a/en/modules/identity.md +++ b/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,92 @@ 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 + +#### Modules + +##### IdentityModule +The module to import and lazy-load 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`. + +Implementation: + +```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 {} +``` + +Identity is pre-installed in the startup template. No need to manually define the route above. + +###### IdentityModule Configuration +You need to import `IdentityConfigModule` from `@volo/abp.ng.identity/config` to root module (usually called `AppModule`) and include it in imports NgModule metadata. `IdentityConfigModule` has a static `forRoot` method which you should call for a proper configuration. + +Implementation: +```js +// app.module.ts +import { IdentityConfigModule } from '@volo/abp.ng.identity/config'; + +@NgModule({ + imports: [ + // other imports + IdentityConfigModule.forRoot(), + // other imports + ], + // ... +}) +export class AppModule {} +``` + +Identity is pre-installed in the startup template. No need to manually import the `IdentityConfigModule` to `AppModule`. + + + +###### IdentityModule Options + +- **IDENTITY_ENTITY_PROP_CONTRIBUTORS:** If you like to add or modify columns in `Roles`, `Users`, or `Claims` pages, you should use this token to pass your contributors to `IdentityModule.forLazy`. Please check [Data Table Column Extensions for Angular](https://docs.abp.io/en/commercial/latest/ui/angular/data-table-column-extensions) for details. +- **IDENTITY_ENTITY_ACTION_CONTRIBUTORS:** If you like to add or modify grid actions in `Roles`, `Users`, or `Claims` pages, you should use this token to pass your contributors to `IdentityModule.forLazy`. Please check [Entity Action Extensions for Angular](https://docs.abp.io/en/commercial/latest/ui/angular/entity-action-extensions) for details. +- **IDENTITY_TOOLBAR_ACTION_CONTRIBUTORS:** If you like to add or modify page toolbar in `Roles`, `Users`, or `Claims`, you should use this token to pass your contributors to `IdentityModule.forLazy`. Please check [Page Toolbar Extensions for Angular](https://docs.abp.io/en/commercial/latest/ui/angular/page-toolbar-extensions) for details. +- **IDENTITY_CREATE_FORM_PROP_CONTRIBUTORS:** If you like to add or modify create form in `Roles`, `Users`, or `Claims` pages, you should use this token to pass your contributors to `IdentityModule.forLazy`. Please check [Dynamic Form Extensions for Angular](https://docs.abp.io/en/commercial/latest/ui/angular/dynamic-form-extensions) for details. +- **IDENTITY_EDIT_FORM_PROP_CONTRIBUTORS:** If you like to add or modify edit form in `Roles`, `Users`, or `Claims` pages, you should use this token to pass your contributors to `IdentityModule.forLazy`. Please check [Dynamic Form Extensions for Angular](https://docs.abp.io/en/commercial/latest/ui/angular/dynamic-form-extensions) for details. + +###### IdentityModule Services + +- **IdentityService:** Covers essential methods that making API calls for `Roles`, `Users`, and `Claims` pages. +- **OrganizationUnitService:** Covers essential methods that making API calls for `Organization Units` page. + +The services above are available for import from `@volo/abp.ng.identity`. + +###### IdentityModule Types + +* **IdentityConfigOptions:** The type of IdentityModule options +* **Identity:** A namespace that covers essential interfaces for `Roles`, `Users`, and `Claims` pages. +* **OrganizationUnitWithDetailsDto:** A class that corresponds [OrganizationUnitWithDetailsDto](https://docs.abp.io/api-docs/commercial/3.0/api/Volo.Abp.Identity.OrganizationUnitWithDetailsDto.html) in backend +* **OrganizationUnitCreateOrUpdateDtoBase:** A class that corresponds [OrganizationUnitCreateOrUpdateDtoBase](https://docs.abp.io/api-docs/commercial/3.0/api/Volo.Abp.Identity.OrganizationUnitCreateOrUpdateDtoBase.html) in backend +* **OrganizationUnitCreateDto:** A class that corresponds [OrganizationUnitCreateDto](https://docs.abp.io/api-docs/commercial/3.0/api/Volo.Abp.Identity.OrganizationUnitCreateDto.html) in backend +* **OrganizationUnitUpdateDto:** A class that corresponds [OrganizationUnitUpdateDto](https://docs.abp.io/api-docs/commercial/3.0/api/Volo.Abp.Identity.OrganizationUnitUpdateDto.html) in backend +* **OrganizationUnitMoveInput:** A class that corresponds [OrganizationUnitMoveInput](https://docs.abp.io/api-docs/commercial/3.0/api/Volo.Abp.Identity.OrganizationUnitMoveInput.html) in backend +* **OrganizationUnitRoleInput:** A class that corresponds [OrganizationUnitRoleInput](https://docs.abp.io/api-docs/commercial/3.0/api/Volo.Abp.Identity.OrganizationUnitRoleInput.html) in backend +* **GetOrganizationUnitInput:** A class that corresponds [GetOrganizationUnitInput](https://docs.abp.io/api-docs/commercial/3.0/api/Volo.Abp.Identity.GetOrganizationUnitInput.html) in backend +* **OrganizationUnitUserInput:** A class that corresponds [OrganizationUnitUserInput](https://docs.abp.io/api-docs/commercial/3.0/api/Volo.Abp.Identity.OrganizationUnitUserInput.html) in backend + +The types above are available for import from `@volo/abp.ng.identity`. + +###### 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). \ No newline at end of file From f4d854b4ca07b361dff479a84ae55b216360e8e0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Levent=20Arman=20=C3=96zak?= Date: Fri, 10 Jul 2020 09:49:20 +0300 Subject: [PATCH 02/12] docs: change wording for usage of modules --- en/modules/identity.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/en/modules/identity.md b/en/modules/identity.md index 1009a98a..6faf06cb 100644 --- a/en/modules/identity.md +++ b/en/modules/identity.md @@ -288,7 +288,7 @@ See the `IdentityPermissions` class members for all permissions defined for this ##### IdentityModule The module to import and lazy-load 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`. -Implementation: +Usage: ```js // app-routing.module.ts @@ -310,7 +310,7 @@ Identity is pre-installed in the startup template. No need to manually define th ###### IdentityModule Configuration You need to import `IdentityConfigModule` from `@volo/abp.ng.identity/config` to root module (usually called `AppModule`) and include it in imports NgModule metadata. `IdentityConfigModule` has a static `forRoot` method which you should call for a proper configuration. -Implementation: +Usage: ```js // app.module.ts import { IdentityConfigModule } from '@volo/abp.ng.identity/config'; @@ -369,4 +369,4 @@ Please check [Component Replacement document](https://docs.abp.io/en/abp/latest/ ## 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). \ No newline at end of file +This module doesn't define any additional distributed event. See the [standard distributed events](https://docs.abp.io/en/abp/latest/Distributed-Event-Bus). From 237ac104d9a03442158739035b09dd3ec2bd8b06 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Levent=20Arman=20=C3=96zak?= Date: Fri, 10 Jul 2020 10:34:05 +0300 Subject: [PATCH 03/12] docs: update identity module in application modules --- en/modules/identity.md | 70 +++++++++++++++++++++--------------------- 1 file changed, 35 insertions(+), 35 deletions(-) diff --git a/en/modules/identity.md b/en/modules/identity.md index 6faf06cb..78159ff0 100644 --- a/en/modules/identity.md +++ b/en/modules/identity.md @@ -286,9 +286,27 @@ See the `IdentityPermissions` class members for all permissions defined for this #### Modules ##### IdentityModule -The module to import and lazy-load 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`. -Usage: +###### Installation + +In order to configure the applcation 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 @@ -305,49 +323,33 @@ const routes: Routes = [ export class AppRoutingModule {} ``` -Identity is pre-installed in the startup template. No need to manually define the route above. - -###### IdentityModule Configuration -You need to import `IdentityConfigModule` from `@volo/abp.ng.identity/config` to root module (usually called `AppModule`) and include it in imports NgModule metadata. `IdentityConfigModule` has a static `forRoot` method which you should call for a proper configuration. +> 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`. -Usage: -```js -// app.module.ts -import { IdentityConfigModule } from '@volo/abp.ng.identity/config'; +
Options
-@NgModule({ - imports: [ - // other imports - IdentityConfigModule.forRoot(), - // other imports - ], - // ... -}) -export class AppModule {} -``` +You can modify the look and behavior of the module pages by passing the following options to `IdentityModule.forLazy` static method: -Identity is pre-installed in the startup template. No need to manually import the `IdentityConfigModule` to `AppModule`. +- **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. -###### IdentityModule Options +###### Services -- **IDENTITY_ENTITY_PROP_CONTRIBUTORS:** If you like to add or modify columns in `Roles`, `Users`, or `Claims` pages, you should use this token to pass your contributors to `IdentityModule.forLazy`. Please check [Data Table Column Extensions for Angular](https://docs.abp.io/en/commercial/latest/ui/angular/data-table-column-extensions) for details. -- **IDENTITY_ENTITY_ACTION_CONTRIBUTORS:** If you like to add or modify grid actions in `Roles`, `Users`, or `Claims` pages, you should use this token to pass your contributors to `IdentityModule.forLazy`. Please check [Entity Action Extensions for Angular](https://docs.abp.io/en/commercial/latest/ui/angular/entity-action-extensions) for details. -- **IDENTITY_TOOLBAR_ACTION_CONTRIBUTORS:** If you like to add or modify page toolbar in `Roles`, `Users`, or `Claims`, you should use this token to pass your contributors to `IdentityModule.forLazy`. Please check [Page Toolbar Extensions for Angular](https://docs.abp.io/en/commercial/latest/ui/angular/page-toolbar-extensions) for details. -- **IDENTITY_CREATE_FORM_PROP_CONTRIBUTORS:** If you like to add or modify create form in `Roles`, `Users`, or `Claims` pages, you should use this token to pass your contributors to `IdentityModule.forLazy`. Please check [Dynamic Form Extensions for Angular](https://docs.abp.io/en/commercial/latest/ui/angular/dynamic-form-extensions) for details. -- **IDENTITY_EDIT_FORM_PROP_CONTRIBUTORS:** If you like to add or modify edit form in `Roles`, `Users`, or `Claims` pages, you should use this token to pass your contributors to `IdentityModule.forLazy`. Please check [Dynamic Form Extensions for Angular](https://docs.abp.io/en/commercial/latest/ui/angular/dynamic-form-extensions) for details. +The `@volo/abp.ng.identity` package exports the following services which cover HTTP requests to counterpart APIs: -###### IdentityModule Services +- **IdentityService:** Covers `Roles`, `Users`, and `Claims` pages. +- **OrganizationUnitService:** Covers `Organization Units` page. -- **IdentityService:** Covers essential methods that making API calls for `Roles`, `Users`, and `Claims` pages. -- **OrganizationUnitService:** Covers essential methods that making API calls for `Organization Units` page. -The services above are available for import from `@volo/abp.ng.identity`. +###### Types -###### IdentityModule Types +The `@volo/abp.ng.identity` package exports the following types: -* **IdentityConfigOptions:** The type of IdentityModule options +* **IdentityConfigOptions:** The type for `IdentityModule.forLazy` options [described above](#h-identity-module-options). * **Identity:** A namespace that covers essential interfaces for `Roles`, `Users`, and `Claims` pages. * **OrganizationUnitWithDetailsDto:** A class that corresponds [OrganizationUnitWithDetailsDto](https://docs.abp.io/api-docs/commercial/3.0/api/Volo.Abp.Identity.OrganizationUnitWithDetailsDto.html) in backend * **OrganizationUnitCreateOrUpdateDtoBase:** A class that corresponds [OrganizationUnitCreateOrUpdateDtoBase](https://docs.abp.io/api-docs/commercial/3.0/api/Volo.Abp.Identity.OrganizationUnitCreateOrUpdateDtoBase.html) in backend @@ -358,8 +360,6 @@ The services above are available for import from `@volo/abp.ng.identity`. * **GetOrganizationUnitInput:** A class that corresponds [GetOrganizationUnitInput](https://docs.abp.io/api-docs/commercial/3.0/api/Volo.Abp.Identity.GetOrganizationUnitInput.html) in backend * **OrganizationUnitUserInput:** A class that corresponds [OrganizationUnitUserInput](https://docs.abp.io/api-docs/commercial/3.0/api/Volo.Abp.Identity.OrganizationUnitUserInput.html) in backend -The types above are available for import from `@volo/abp.ng.identity`. - ###### IdentityModule Replaceable Components `eIdentityComponents` enum provides all replaceable component keys. It is available for import from `@volo/abp.ng.identity`. From 3f2cada549dd2a01bf99fae131c7cac3b8600510 Mon Sep 17 00:00:00 2001 From: mehmet-erim Date: Mon, 13 Jul 2020 14:31:52 +0300 Subject: [PATCH 04/12] docs: update identity.md --- en/modules/identity.md | 27 ++++----------------------- 1 file changed, 4 insertions(+), 23 deletions(-) diff --git a/en/modules/identity.md b/en/modules/identity.md index 78159ff0..5d259ed7 100644 --- a/en/modules/identity.md +++ b/en/modules/identity.md @@ -283,11 +283,7 @@ See the `IdentityPermissions` class members for all permissions defined for this ### Angular UI -#### Modules - -##### IdentityModule - -###### Installation +#### Installation In order to configure the applcation 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. @@ -325,7 +321,7 @@ 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`. -
Options
+

Options

You can modify the look and behavior of the module pages by passing the following options to `IdentityModule.forLazy` static method: @@ -337,7 +333,7 @@ You can modify the look and behavior of the module pages by passing the followin -###### Services +#### Services The `@volo/abp.ng.identity` package exports the following services which cover HTTP requests to counterpart APIs: @@ -345,22 +341,7 @@ The `@volo/abp.ng.identity` package exports the following services which cover H - **OrganizationUnitService:** Covers `Organization Units` page. -###### Types - -The `@volo/abp.ng.identity` package exports the following types: - -* **IdentityConfigOptions:** The type for `IdentityModule.forLazy` options [described above](#h-identity-module-options). -* **Identity:** A namespace that covers essential interfaces for `Roles`, `Users`, and `Claims` pages. -* **OrganizationUnitWithDetailsDto:** A class that corresponds [OrganizationUnitWithDetailsDto](https://docs.abp.io/api-docs/commercial/3.0/api/Volo.Abp.Identity.OrganizationUnitWithDetailsDto.html) in backend -* **OrganizationUnitCreateOrUpdateDtoBase:** A class that corresponds [OrganizationUnitCreateOrUpdateDtoBase](https://docs.abp.io/api-docs/commercial/3.0/api/Volo.Abp.Identity.OrganizationUnitCreateOrUpdateDtoBase.html) in backend -* **OrganizationUnitCreateDto:** A class that corresponds [OrganizationUnitCreateDto](https://docs.abp.io/api-docs/commercial/3.0/api/Volo.Abp.Identity.OrganizationUnitCreateDto.html) in backend -* **OrganizationUnitUpdateDto:** A class that corresponds [OrganizationUnitUpdateDto](https://docs.abp.io/api-docs/commercial/3.0/api/Volo.Abp.Identity.OrganizationUnitUpdateDto.html) in backend -* **OrganizationUnitMoveInput:** A class that corresponds [OrganizationUnitMoveInput](https://docs.abp.io/api-docs/commercial/3.0/api/Volo.Abp.Identity.OrganizationUnitMoveInput.html) in backend -* **OrganizationUnitRoleInput:** A class that corresponds [OrganizationUnitRoleInput](https://docs.abp.io/api-docs/commercial/3.0/api/Volo.Abp.Identity.OrganizationUnitRoleInput.html) in backend -* **GetOrganizationUnitInput:** A class that corresponds [GetOrganizationUnitInput](https://docs.abp.io/api-docs/commercial/3.0/api/Volo.Abp.Identity.GetOrganizationUnitInput.html) in backend -* **OrganizationUnitUserInput:** A class that corresponds [OrganizationUnitUserInput](https://docs.abp.io/api-docs/commercial/3.0/api/Volo.Abp.Identity.OrganizationUnitUserInput.html) in backend - -###### IdentityModule Replaceable Components +#### IdentityModule Replaceable Components `eIdentityComponents` enum provides all replaceable component keys. It is available for import from `@volo/abp.ng.identity`. From 108032b4b64a078f27635ede522333491bf896c0 Mon Sep 17 00:00:00 2001 From: mehmet-erim Date: Wed, 15 Jul 2020 17:25:59 +0300 Subject: [PATCH 05/12] docs: add angular ui explanations to text-template-management.md --- en/modules/text-template-management.md | 66 +++++++++++++++++++++++++- 1 file changed, 65 insertions(+), 1 deletion(-) diff --git a/en/modules/text-template-management.md b/en/modules/text-template-management.md index 8a07073e..4130b241 100644 --- a/en/modules/text-template-management.md +++ b/en/modules/text-template-management.md @@ -29,7 +29,6 @@ This module follows the [module development best practices guide](https://docs.a ### NPM Packages * @volo/abp.ng.text-template-management -* @volo/abp.ng.text-template-management.config ## User Interface @@ -136,6 +135,71 @@ See the [connection strings](https://docs.abp.io/en/abp/latest/Connection-String See the `TextTemplateManagementPermissions` class members for all permissions defined for this module. + +### Angular UI + +#### Installation + +In order to configure the application to use the `TextTemplateManagementModule`, you first need to import `TextTemplateManagementConfigModule` from `@volo/abp.ng.text-template-management/config` to root module. `TextTemplateManagementConfigModule` has a static `forRoot` method which you should call for a proper configuration. + +```js +// app.module.ts +import { TextTemplateManagementConfigModule } from '@volo/abp.ng.text-template-management/config'; + +@NgModule({ + imports: [ + // other imports + TextTemplateManagementConfigModule.forRoot(), + // other imports + ], + // ... +}) +export class AppModule {} +``` + +The `TextTemplateManagementModule` 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.text-template-management`. + +```js +// app-routing.module.ts +const routes: Routes = [ + // other route definitions + { + path: 'text-template-management', + loadChildren: () => + import('@volo/abp.ng.text-template-management').then(m => m.TextTemplateManagementModule.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 `TextTemplateManagementConfigModule` and `TextTemplateManagementModule`. + +

Options

+ +You can modify the look and behavior of the module pages by passing the following options to `TextTemplateManagementModule.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.text-template-management` package exports the following services which cover HTTP requests to counterpart APIs: + +- **TemplateDefinitionService:** Covers several methods that performing HTTP calls for `Text templates` page. +- **TemplateContentService:** Covers several methods that performing HTTP calls for `Create update template content` page. + + +#### TextTemplateManagementModule Replaceable Components + +`eTextTemplateManagementComponents` enum provides all replaceable component keys. It is available for import from `@volo/abp.ng.text-template-management`. + +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). From 6f4b5e1138df5866a3354f74b75f3009342c9957 Mon Sep 17 00:00:00 2001 From: mehmet-erim Date: Wed, 15 Jul 2020 17:26:18 +0300 Subject: [PATCH 06/12] docs: add angular ui explanations to saas.md and fix a mistake --- en/modules/saas.md | 72 ++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 69 insertions(+), 3 deletions(-) diff --git a/en/modules/saas.md b/en/modules/saas.md index ffa3082c..adc45da1 100644 --- a/en/modules/saas.md +++ b/en/modules/saas.md @@ -7,11 +7,11 @@ This module implements the User and Role system of an application; * Set **connection string** of tenants. * Set **features** of editions. -See [the module description page](https://commercial.abp.io/modules/Volo.Identity.Pro) for an overview of the module features. +See [the module description page](https://commercial.abp.io/modules/Volo.Saas) for an overview of the module features. ## How to install -Identity is pre-installed in [the startup templates](../Startup-Templates/Index). So, no need to manually install it. +Saas is pre-installed in [the startup templates](../Startup-Templates/Index). So, no need to manually install it. ## Packages @@ -37,7 +37,6 @@ This module follows the [module development best practices guide](https://docs.a ### NPM packages * @volo/abp.ng.saas -* @volo/abp.ng.saas.config ## User interface @@ -174,6 +173,73 @@ See the [connection strings](https://docs.abp.io/en/abp/latest/Connection-String See the `SaasHostPermissions` class members for all permissions defined for this module. + +### Angular UI + +#### Installation + +In order to configure the application to use the `SaasModule`, you first need to import `SaasConfigModule` from `@volo/abp.ng.saas/config` to root module. `SaasConfigModule` has a static `forRoot` method which you should call for a proper configuration. + +```js +// app.module.ts +import { SaasConfigModule } from '@volo/abp.ng.saas/config'; + +@NgModule({ + imports: [ + // other imports + SaasConfigModule.forRoot(), + // other imports + ], + // ... +}) +export class AppModule {} +``` + +The `SaasModule` 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.saas`. + +```js +// app-routing.module.ts +const routes: Routes = [ + // other route definitions + { + path: 'saas', + loadChildren: () => + import('@volo/abp.ng.saas').then(m => m.SaasModule.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 `SaasConfigModule` and `SaasModule`. + +

Options

+ +You can modify the look and behavior of the module pages by passing the following options to `SaasModule.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.saas` package exports the following services which cover HTTP requests to counterpart APIs: + +- **SaasService:** Covers several methods that performing HTTP calls for `Tenants` and `Editions` pages. + + +#### SaasModule Replaceable Components + +`eSaasComponents` enum provides all replaceable component keys. It is available for import from `@volo/abp.ng.saas`. + +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). \ No newline at end of file From d9cc309781dd9ecbd173c8a968dbbba82d7aa4a1 Mon Sep 17 00:00:00 2001 From: mehmet-erim Date: Wed, 15 Jul 2020 17:26:25 +0300 Subject: [PATCH 07/12] docs: add angular ui explanations to language-management.md --- en/modules/language-management.md | 67 ++++++++++++++++++++++++++++++- 1 file changed, 66 insertions(+), 1 deletion(-) diff --git a/en/modules/language-management.md b/en/modules/language-management.md index 077d5c05..ebd6a233 100644 --- a/en/modules/language-management.md +++ b/en/modules/language-management.md @@ -32,7 +32,6 @@ This module follows the [module development best practices guide](https://docs.a ### NPM Packages * @volo/abp.ng.language-management -* @volo/abp.ng.language-management.config ## User Interface @@ -146,6 +145,72 @@ See the [connection strings](https://docs.abp.io/en/abp/latest/Connection-String See the `LanguageManagementPermissions` class members for all permissions defined for this module. + +### Angular UI + +#### Installation + +In order to configure the application to use the `LanguageManagementModule`, you first need to import `LanguageManagementConfigModule` from `@volo/abp.ng.language-management/config` to root module. `LanguageManagementConfigModule` has a static `forRoot` method which you should call for a proper configuration. + +```js +// app.module.ts +import { LanguageManagementConfigModule } from '@volo/abp.ng.language-management/config'; + +@NgModule({ + imports: [ + // other imports + LanguageManagementConfigModule.forRoot(), + // other imports + ], + // ... +}) +export class AppModule {} +``` + +The `LanguageManagementModule` 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.language-management`. + +```js +// app-routing.module.ts +const routes: Routes = [ + // other route definitions + { + path: 'language-management', + loadChildren: () => + import('@volo/abp.ng.language-management').then(m => m.LanguageManagementModule.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 `LanguageManagementConfigModule` and `LanguageManagementModule`. + +

Options

+ +You can modify the look and behavior of the module pages by passing the following options to `LanguageManagementModule.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.language-management` package exports the following services which cover HTTP requests to counterpart APIs: + +- **LanguageManagementService:** Covers several methods that performing HTTP calls for `Languages` and `Language Texts` pages. + + +#### LanguageManagementModule Replaceable Components + +`eLanguageManagementComponents` enum provides all replaceable component keys. It is available for import from `@volo/abp.ng.language-management`. + +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). \ No newline at end of file From 13b2aaebe1a7dabae3b05328f078a87958749e4e Mon Sep 17 00:00:00 2001 From: mehmet-erim Date: Wed, 15 Jul 2020 17:26:41 +0300 Subject: [PATCH 08/12] docs: update identity.md --- en/modules/identity.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/en/modules/identity.md b/en/modules/identity.md index 5d259ed7..89be6c31 100644 --- a/en/modules/identity.md +++ b/en/modules/identity.md @@ -285,7 +285,7 @@ See the `IdentityPermissions` class members for all permissions defined for this #### Installation -In order to configure the applcation 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. +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 @@ -337,8 +337,8 @@ You can modify the look and behavior of the module pages by passing the followin The `@volo/abp.ng.identity` package exports the following services which cover HTTP requests to counterpart APIs: -- **IdentityService:** Covers `Roles`, `Users`, and `Claims` pages. -- **OrganizationUnitService:** Covers `Organization Units` page. +- **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 From bd73e429296f9fec6139a0ae49d0f8f3b7d8c961 Mon Sep 17 00:00:00 2001 From: mehmet-erim Date: Wed, 15 Jul 2020 17:26:51 +0300 Subject: [PATCH 09/12] docs: add angular ui explanations to identity-server.md --- en/modules/identity-server.md | 66 ++++++++++++++++++++++++++++++++++- 1 file changed, 65 insertions(+), 1 deletion(-) diff --git a/en/modules/identity-server.md b/en/modules/identity-server.md index 03d0d90c..fb862a6a 100644 --- a/en/modules/identity-server.md +++ b/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`. + +

Options

+ +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. \ No newline at end of file From 695b375edc67831a5e40135cd8b2221417b28604 Mon Sep 17 00:00:00 2001 From: mehmet-erim Date: Wed, 15 Jul 2020 17:26:57 +0300 Subject: [PATCH 10/12] docs: add angular ui explanations to chat.md --- en/Modules/chat.md | 47 +++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 46 insertions(+), 1 deletion(-) diff --git a/en/Modules/chat.md b/en/Modules/chat.md index c94f12ed..1816cb27 100644 --- a/en/Modules/chat.md +++ b/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. \ No newline at end of file From d8d5e4fb1ec27eb6fb839d221a34f93152833e20 Mon Sep 17 00:00:00 2001 From: mehmet-erim Date: Wed, 15 Jul 2020 17:27:21 +0300 Subject: [PATCH 11/12] docs: add angular ui explanations to audit-logging.md --- en/modules/audit-logging.md | 65 ++++++++++++++++++++++++++++++++++++- 1 file changed, 64 insertions(+), 1 deletion(-) diff --git a/en/modules/audit-logging.md b/en/modules/audit-logging.md index 15a77c16..d703c94e 100644 --- a/en/modules/audit-logging.md +++ b/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`. + +

Options

+ +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). \ No newline at end of file From e22d8683b7219bafaf8c525cd85cf865ef213d4d Mon Sep 17 00:00:00 2001 From: mehmet-erim Date: Wed, 15 Jul 2020 17:27:37 +0300 Subject: [PATCH 12/12] docs: add angular ui explanations to account.md --- en/modules/account.md | 61 ++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 60 insertions(+), 1 deletion(-) diff --git a/en/modules/account.md b/en/modules/account.md index cc5a40a8..e27920f4 100644 --- a/en/modules/account.md +++ b/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`. + +

Options

+ +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). \ No newline at end of file