From 9a02778a8954728add2b040b17d218cf9ebd22b9 Mon Sep 17 00:00:00 2001 From: muhammedaltug Date: Tue, 31 May 2022 13:26:51 +0300 Subject: [PATCH 1/2] Documentation for breadcrumb --- docs/en/UI/Angular/Breadcrumb.md | 50 ++++++++++++++++++++++++++++++++ 1 file changed, 50 insertions(+) create mode 100644 docs/en/UI/Angular/Breadcrumb.md diff --git a/docs/en/UI/Angular/Breadcrumb.md b/docs/en/UI/Angular/Breadcrumb.md new file mode 100644 index 0000000000..bdd535daeb --- /dev/null +++ b/docs/en/UI/Angular/Breadcrumb.md @@ -0,0 +1,50 @@ +## Breadcrumb Component + +ABP provides a component that listens to the angular router's `NavigationEnd` +event and creates inputs for `BreadcrumbItemsComponent`.This component is used in +abp components with [`PageComponent`](./Page-Component.md). + +## Breadcrumb Items Component + +`BreadcrumbItemsComponent` is used to display breadcrumb items. It can be useful +when you want to display breadcrumb items in a different way than the default. + +### Usage + +Example for overriding the default template of `PageComponent`: + +```html + + + + + +``` + +```js +import { Component } from "@angular/core"; +import { ABP } from "@abp/ng.core"; + +@Component({ + /* component metadata */ +}) +export class YourComponent { + breadCrumbItems: ABP.Route[] = [ + { + name: "Item 1", + }, + { + name: "Item 2", + path: "/path", + }, + ]; +} +``` + +### Inputs + +- items: Partial[] : Array of ABP.Route objects. Source code of ABP.Route can be found in [github](https://github.com/abpframework/abp/blob/dev/npm/ng-packs/packages/core/src/lib/models/common.ts#L69). + +## See Also + +- [Page Component](./Page-Component.md) From f796f2667e09d71fb89cf45f6f3fc0dd47a86ddf Mon Sep 17 00:00:00 2001 From: Hamza Albreem <94292623+braim23@users.noreply.github.com> Date: Tue, 31 May 2022 14:02:34 +0300 Subject: [PATCH 2/2] quick fix --- docs/en/UI/Angular/Breadcrumb.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/en/UI/Angular/Breadcrumb.md b/docs/en/UI/Angular/Breadcrumb.md index bdd535daeb..58ae826278 100644 --- a/docs/en/UI/Angular/Breadcrumb.md +++ b/docs/en/UI/Angular/Breadcrumb.md @@ -1,8 +1,8 @@ ## Breadcrumb Component ABP provides a component that listens to the angular router's `NavigationEnd` -event and creates inputs for `BreadcrumbItemsComponent`.This component is used in -abp components with [`PageComponent`](./Page-Component.md). +event and creates inputs for `BreadcrumbItemsComponent`. This component is used in +ABP components with [`PageComponent`](./Page-Component.md). ## Breadcrumb Items Component @@ -11,7 +11,7 @@ when you want to display breadcrumb items in a different way than the default. ### Usage -Example for overriding the default template of `PageComponent`: +Example of overriding the default template of `PageComponent`: ```html @@ -43,7 +43,7 @@ export class YourComponent { ### Inputs -- items: Partial[] : Array of ABP.Route objects. Source code of ABP.Route can be found in [github](https://github.com/abpframework/abp/blob/dev/npm/ng-packs/packages/core/src/lib/models/common.ts#L69). +- items: Partial[] : Array of ABP.Route objects. The source code of ABP.Route can be found in [github](https://github.com/abpframework/abp/blob/dev/npm/ng-packs/packages/core/src/lib/models/common.ts#L69). ## See Also