API.md

Back to README.md

@openmrs/esm-breadcrumbs

Table of contents

Interfaces

• BreadcrumbRegistration
• BreadcrumbSettings

Breadcrumb Functions

• filterBreadcrumbs
• getBreadcrumbs
• getBreadcrumbsFor
• registerBreadcrumb
• registerBreadcrumbs

Breadcrumb Functions

filterBreadcrumbs

▸ filterBreadcrumbs(list, path): BreadcrumbRegistration[]

Parameters

Name	Type
list	BreadcrumbRegistration[]
path	string

Returns

BreadcrumbRegistration[]

Defined in

filter.ts:49

---

getBreadcrumbs

▸ getBreadcrumbs(): BreadcrumbRegistration[]

Returns

BreadcrumbRegistration[]

Defined in

db.ts:50

---

getBreadcrumbsFor

▸ getBreadcrumbsFor(path): BreadcrumbRegistration[]

Parameters

Name	Type
path	string

Returns

BreadcrumbRegistration[]

Defined in

filter.ts:78

---

registerBreadcrumb

▸ registerBreadcrumb(breadcrumb): void

Parameters

Name	Type
breadcrumb	BreadcrumbSettings

Returns

void

Defined in

db.ts:26

---

registerBreadcrumbs

▸ registerBreadcrumbs(breadcrumbs): void

Parameters

Name	Type
breadcrumbs	BreadcrumbSettings[]

Returns

void

Defined in

db.ts:35