@rxap/layout 19.0.1-dev.11 → 19.0.1-dev.13

package/docs/markdown/classes/ExternalAppsService.md

@@ -0,0 +1,251 @@
+[**@rxap/layout**](../README.md)
+
+***
+
+[@rxap/layout](../globals.md) / ExternalAppsService
+
+# Class: ExternalAppsService
+
+Defined in: [external-apps.service.ts:22](https://gitlab.com/rxap/packages/-/blob/5c9d13911b2e801186e53ea55b76b15441bb2700/packages/angular/layout/src/lib/external-apps.service.ts#L22)
+
+## Constructors
+
+### new ExternalAppsService()
+
+> **new ExternalAppsService**(): [`ExternalAppsService`](ExternalAppsService.md)
+
+#### Returns
+
+[`ExternalAppsService`](ExternalAppsService.md)
+
+## Properties
+
+### activeAppList
+
+> `readonly` **activeAppList**: `WritableSignal`\<`AppsNavigationConfig`[]\>
+
+Defined in: [external-apps.service.ts:34](https://gitlab.com/rxap/packages/-/blob/5c9d13911b2e801186e53ea55b76b15441bb2700/packages/angular/layout/src/lib/external-apps.service.ts#L34)
+
+The list of active apps that is processed by the getAppList method
+
+***
+
+### appFilterList
+
+> `protected` `readonly` **appFilterList**: `MethodWithParameters`\<`AppsNavigationConfig`[], `AppsNavigationConfig`[]\>[]
+
+Defined in: [external-apps.service.ts:24](https://gitlab.com/rxap/packages/-/blob/5c9d13911b2e801186e53ea55b76b15441bb2700/packages/angular/layout/src/lib/external-apps.service.ts#L24)
+
+***
+
+### apps
+
+> `protected` `readonly` **apps**: `AppsNavigationConfig`[]
+
+Defined in: [external-apps.service.ts:28](https://gitlab.com/rxap/packages/-/blob/5c9d13911b2e801186e53ea55b76b15441bb2700/packages/angular/layout/src/lib/external-apps.service.ts#L28)
+
+***
+
+### config
+
+> `protected` `readonly` **config**: `ConfigService`\<`any`\>
+
+Defined in: [external-apps.service.ts:25](https://gitlab.com/rxap/packages/-/blob/5c9d13911b2e801186e53ea55b76b15441bb2700/packages/angular/layout/src/lib/external-apps.service.ts#L25)
+
+***
+
+### environment
+
+> `protected` `readonly` **environment**: `Environment`
+
+Defined in: [external-apps.service.ts:27](https://gitlab.com/rxap/packages/-/blob/5c9d13911b2e801186e53ea55b76b15441bb2700/packages/angular/layout/src/lib/external-apps.service.ts#L27)
+
+***
+
+### externalApps
+
+> `protected` `readonly` **externalApps**: `AppsNavigationConfig`[]
+
+Defined in: [external-apps.service.ts:29](https://gitlab.com/rxap/packages/-/blob/5c9d13911b2e801186e53ea55b76b15441bb2700/packages/angular/layout/src/lib/external-apps.service.ts#L29)
+
+***
+
+### localeId
+
+> `protected` `readonly` **localeId**: `string`
+
+Defined in: [external-apps.service.ts:26](https://gitlab.com/rxap/packages/-/blob/5c9d13911b2e801186e53ea55b76b15441bb2700/packages/angular/layout/src/lib/external-apps.service.ts#L26)
+
+## Methods
+
+### getApp()
+
+> **getApp**(`appId`): `null` \| `AppsNavigationConfig`
+
+Defined in: [external-apps.service.ts:40](https://gitlab.com/rxap/packages/-/blob/5c9d13911b2e801186e53ea55b76b15441bb2700/packages/angular/layout/src/lib/external-apps.service.ts#L40)
+
+#### Parameters
+
+##### appId
+
+`string`
+
+#### Returns
+
+`null` \| `AppsNavigationConfig`
+
+***
+
+### getAppList()
+
+> **getAppList**(): `Promise`\<`AppsNavigationConfig`[]\>
+
+Defined in: [external-apps.service.ts:100](https://gitlab.com/rxap/packages/-/blob/5c9d13911b2e801186e53ea55b76b15441bb2700/packages/angular/layout/src/lib/external-apps.service.ts#L100)
+
+#### Returns
+
+`Promise`\<`AppsNavigationConfig`[]\>
+
+***
+
+### getAppRouterLink()
+
+> **getAppRouterLink**(`appId`, `path`): `null` \| `string`[]
+
+Defined in: [external-apps.service.ts:63](https://gitlab.com/rxap/packages/-/blob/5c9d13911b2e801186e53ea55b76b15441bb2700/packages/angular/layout/src/lib/external-apps.service.ts#L63)
+
+#### Parameters
+
+##### appId
+
+`string`
+
+##### path
+
+`string`
+
+#### Returns
+
+`null` \| `string`[]
+
+***
+
+### getAppRouterLinkOrThrow()
+
+> **getAppRouterLinkOrThrow**(`appId`, `path`): `string`[]
+
+Defined in: [external-apps.service.ts:82](https://gitlab.com/rxap/packages/-/blob/5c9d13911b2e801186e53ea55b76b15441bb2700/packages/angular/layout/src/lib/external-apps.service.ts#L82)
+
+#### Parameters
+
+##### appId
+
+`string`
+
+##### path
+
+`string`
+
+#### Returns
+
+`string`[]
+
+***
+
+### getAppUrl()
+
+> **getAppUrl**(`appId`, `path`, `infix`): `null` \| `string`
+
+Defined in: [external-apps.service.ts:51](https://gitlab.com/rxap/packages/-/blob/5c9d13911b2e801186e53ea55b76b15441bb2700/packages/angular/layout/src/lib/external-apps.service.ts#L51)
+
+#### Parameters
+
+##### appId
+
+`string`
+
+##### path
+
+`string`
+
+##### infix
+
+`null` | `string`
+
+#### Returns
+
+`null` \| `string`
+
+***
+
+### getAppUrlOrThrow()
+
+> **getAppUrlOrThrow**(`appId`, `path`): `string`
+
+Defined in: [external-apps.service.ts:74](https://gitlab.com/rxap/packages/-/blob/5c9d13911b2e801186e53ea55b76b15441bb2700/packages/angular/layout/src/lib/external-apps.service.ts#L74)
+
+#### Parameters
+
+##### appId
+
+`string`
+
+##### path
+
+`string`
+
+#### Returns
+
+`string`
+
+***
+
+### getPathPrefix()
+
+> `protected` **getPathPrefix**(): `string`
+
+Defined in: [external-apps.service.ts:122](https://gitlab.com/rxap/packages/-/blob/5c9d13911b2e801186e53ea55b76b15441bb2700/packages/angular/layout/src/lib/external-apps.service.ts#L122)
+
+#### Returns
+
+`string`
+
+***
+
+### hasApp()
+
+> **hasApp**(`appId`): `boolean`
+
+Defined in: [external-apps.service.ts:36](https://gitlab.com/rxap/packages/-/blob/5c9d13911b2e801186e53ea55b76b15441bb2700/packages/angular/layout/src/lib/external-apps.service.ts#L36)
+
+#### Parameters
+
+##### appId
+
+`string`
+
+#### Returns
+
+`boolean`
+
+***
+
+### navigate()
+
+> **navigate**(`appId`, `path`): `void`
+
+Defined in: [external-apps.service.ts:90](https://gitlab.com/rxap/packages/-/blob/5c9d13911b2e801186e53ea55b76b15441bb2700/packages/angular/layout/src/lib/external-apps.service.ts#L90)
+
+#### Parameters
+
+##### appId
+
+`string`
+
+##### path
+
+`string`
+
+#### Returns
+
+`void`

package/docs/markdown/classes/FooterComponent.md

@@ -0,0 +1,35 @@
+[**@rxap/layout**](../README.md)
+
+***
+
+[@rxap/layout](../globals.md) / FooterComponent
+
+# Class: FooterComponent
+
+Defined in: [footer/footer.component.ts:18](https://gitlab.com/rxap/packages/-/blob/5c9d13911b2e801186e53ea55b76b15441bb2700/packages/angular/layout/src/lib/footer/footer.component.ts#L18)
+
+## Constructors
+
+### new FooterComponent()
+
+> **new FooterComponent**(): [`FooterComponent`](FooterComponent.md)
+
+#### Returns
+
+[`FooterComponent`](FooterComponent.md)
+
+## Properties
+
+### hasPortals
+
+> `readonly` **hasPortals**: `Signal`\<`boolean`\>
+
+Defined in: [footer/footer.component.ts:23](https://gitlab.com/rxap/packages/-/blob/5c9d13911b2e801186e53ea55b76b15441bb2700/packages/angular/layout/src/lib/footer/footer.component.ts#L23)
+
+***
+
+### portals
+
+> `readonly` **portals**: `Signal`\<`Portal`\<`unknown`\>[]\>
+
+Defined in: [footer/footer.component.ts:22](https://gitlab.com/rxap/packages/-/blob/5c9d13911b2e801186e53ea55b76b15441bb2700/packages/angular/layout/src/lib/footer/footer.component.ts#L22)

package/docs/markdown/classes/FooterDirective.md

@@ -0,0 +1,65 @@
+[**@rxap/layout**](../README.md)
+
+***
+
+[@rxap/layout](../globals.md) / FooterDirective
+
+# Class: FooterDirective
+
+Defined in: [footer/footer.directive.ts:16](https://gitlab.com/rxap/packages/-/blob/5c9d13911b2e801186e53ea55b76b15441bb2700/packages/angular/layout/src/lib/footer/footer.directive.ts#L16)
+
+## Implements
+
+- `OnInit`
+- `OnDestroy`
+
+## Constructors
+
+### new FooterDirective()
+
+> **new FooterDirective**(): [`FooterDirective`](FooterDirective.md)
+
+#### Returns
+
+[`FooterDirective`](FooterDirective.md)
+
+## Methods
+
+### ngOnDestroy()
+
+> **ngOnDestroy**(): `void`
+
+Defined in: [footer/footer.directive.ts:31](https://gitlab.com/rxap/packages/-/blob/5c9d13911b2e801186e53ea55b76b15441bb2700/packages/angular/layout/src/lib/footer/footer.directive.ts#L31)
+
+A callback method that performs custom clean-up, invoked immediately
+before a directive, pipe, or service instance is destroyed.
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+`OnDestroy.ngOnDestroy`
+
+***
+
+### ngOnInit()
+
+> **ngOnInit**(): `void`
+
+Defined in: [footer/footer.directive.ts:23](https://gitlab.com/rxap/packages/-/blob/5c9d13911b2e801186e53ea55b76b15441bb2700/packages/angular/layout/src/lib/footer/footer.directive.ts#L23)
+
+A callback method that is invoked immediately after the
+default change detector has checked the directive's
+data-bound properties for the first time,
+and before any of the view or content children have been checked.
+It is invoked only once when the directive is instantiated.
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+`OnInit.ngOnInit`

package/docs/markdown/classes/FooterService.md

@@ -0,0 +1,87 @@
+[**@rxap/layout**](../README.md)
+
+***
+
+[@rxap/layout](../globals.md) / FooterService
+
+# Class: FooterService
+
+Defined in: [footer.service.ts:16](https://gitlab.com/rxap/packages/-/blob/5c9d13911b2e801186e53ea55b76b15441bb2700/packages/angular/layout/src/lib/footer.service.ts#L16)
+
+## Constructors
+
+### new FooterService()
+
+> **new FooterService**(): [`FooterService`](FooterService.md)
+
+#### Returns
+
+[`FooterService`](FooterService.md)
+
+## Properties
+
+### portalCount
+
+> `readonly` **portalCount**: `Signal`\<`number`\>
+
+Defined in: [footer.service.ts:31](https://gitlab.com/rxap/packages/-/blob/5c9d13911b2e801186e53ea55b76b15441bb2700/packages/angular/layout/src/lib/footer.service.ts#L31)
+
+Computes the count of portals.
+
+#### Returns
+
+The count of portals.
+
+***
+
+### portals
+
+> `readonly` **portals**: `WritableSignal`\<`Portal`\<`unknown`\>[]\>
+
+Defined in: [footer.service.ts:23](https://gitlab.com/rxap/packages/-/blob/5c9d13911b2e801186e53ea55b76b15441bb2700/packages/angular/layout/src/lib/footer.service.ts#L23)
+
+Represents an array of `Portal` objects with unknown type.
+
+## Methods
+
+### pushPortal()
+
+> **pushPortal**(`portal`): `void`
+
+Defined in: [footer.service.ts:40](https://gitlab.com/rxap/packages/-/blob/5c9d13911b2e801186e53ea55b76b15441bb2700/packages/angular/layout/src/lib/footer.service.ts#L40)
+
+Adds a portal to the list of portals.
+
+#### Parameters
+
+##### portal
+
+`Portal`\<`unknown`\>
+
+The portal to be added.
+
+#### Returns
+
+`void`
+
+***
+
+### removePortal()
+
+> **removePortal**(`portal`): `void`
+
+Defined in: [footer.service.ts:56](https://gitlab.com/rxap/packages/-/blob/5c9d13911b2e801186e53ea55b76b15441bb2700/packages/angular/layout/src/lib/footer.service.ts#L56)
+
+Removes a portal from the list of portals.
+
+#### Parameters
+
+##### portal
+
+`Portal`\<`unknown`\>
+
+The portal to be removed.
+
+#### Returns
+
+`void`

package/docs/markdown/classes/HeaderComponent.md

@@ -0,0 +1,43 @@
+[**@rxap/layout**](../README.md)
+
+***
+
+[@rxap/layout](../globals.md) / HeaderComponent
+
+# Class: HeaderComponent
+
+Defined in: [header/header.component.ts:27](https://gitlab.com/rxap/packages/-/blob/5c9d13911b2e801186e53ea55b76b15441bb2700/packages/angular/layout/src/lib/header/header.component.ts#L27)
+
+## Constructors
+
+### new HeaderComponent()
+
+> **new HeaderComponent**(): [`HeaderComponent`](HeaderComponent.md)
+
+#### Returns
+
+[`HeaderComponent`](HeaderComponent.md)
+
+## Properties
+
+### color
+
+> `readonly` **color**: `InputSignal`\<`ThemePalette`\>
+
+Defined in: [header/header.component.ts:29](https://gitlab.com/rxap/packages/-/blob/5c9d13911b2e801186e53ea55b76b15441bb2700/packages/angular/layout/src/lib/header/header.component.ts#L29)
+
+***
+
+### hasPortals
+
+> `readonly` **hasPortals**: `Signal`\<`boolean`\>
+
+Defined in: [header/header.component.ts:34](https://gitlab.com/rxap/packages/-/blob/5c9d13911b2e801186e53ea55b76b15441bb2700/packages/angular/layout/src/lib/header/header.component.ts#L34)
+
+***
+
+### portals
+
+> `readonly` **portals**: `Signal`\<`Portal`\<`unknown`\>[]\>
+
+Defined in: [header/header.component.ts:33](https://gitlab.com/rxap/packages/-/blob/5c9d13911b2e801186e53ea55b76b15441bb2700/packages/angular/layout/src/lib/header/header.component.ts#L33)

package/docs/markdown/classes/HeaderDirective.md

@@ -0,0 +1,65 @@
+[**@rxap/layout**](../README.md)
+
+***
+
+[@rxap/layout](../globals.md) / HeaderDirective
+
+# Class: HeaderDirective
+
+Defined in: [header/header.directive.ts:16](https://gitlab.com/rxap/packages/-/blob/5c9d13911b2e801186e53ea55b76b15441bb2700/packages/angular/layout/src/lib/header/header.directive.ts#L16)
+
+## Implements
+
+- `OnInit`
+- `OnDestroy`
+
+## Constructors
+
+### new HeaderDirective()
+
+> **new HeaderDirective**(): [`HeaderDirective`](HeaderDirective.md)
+
+#### Returns
+
+[`HeaderDirective`](HeaderDirective.md)
+
+## Methods
+
+### ngOnDestroy()
+
+> **ngOnDestroy**(): `void`
+
+Defined in: [header/header.directive.ts:31](https://gitlab.com/rxap/packages/-/blob/5c9d13911b2e801186e53ea55b76b15441bb2700/packages/angular/layout/src/lib/header/header.directive.ts#L31)
+
+A callback method that performs custom clean-up, invoked immediately
+before a directive, pipe, or service instance is destroyed.
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+`OnDestroy.ngOnDestroy`
+
+***
+
+### ngOnInit()
+
+> **ngOnInit**(): `void`
+
+Defined in: [header/header.directive.ts:23](https://gitlab.com/rxap/packages/-/blob/5c9d13911b2e801186e53ea55b76b15441bb2700/packages/angular/layout/src/lib/header/header.directive.ts#L23)
+
+A callback method that is invoked immediately after the
+default change detector has checked the directive's
+data-bound properties for the first time,
+and before any of the view or content children have been checked.
+It is invoked only once when the directive is instantiated.
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+`OnInit.ngOnInit`

package/docs/markdown/classes/HeaderService.md

@@ -0,0 +1,87 @@
+[**@rxap/layout**](../README.md)
+
+***
+
+[@rxap/layout](../globals.md) / HeaderService
+
+# Class: HeaderService
+
+Defined in: [header.service.ts:16](https://gitlab.com/rxap/packages/-/blob/5c9d13911b2e801186e53ea55b76b15441bb2700/packages/angular/layout/src/lib/header.service.ts#L16)
+
+## Constructors
+
+### new HeaderService()
+
+> **new HeaderService**(): [`HeaderService`](HeaderService.md)
+
+#### Returns
+
+[`HeaderService`](HeaderService.md)
+
+## Properties
+
+### portalCount
+
+> `readonly` **portalCount**: `Signal`\<`number`\>
+
+Defined in: [header.service.ts:33](https://gitlab.com/rxap/packages/-/blob/5c9d13911b2e801186e53ea55b76b15441bb2700/packages/angular/layout/src/lib/header.service.ts#L33)
+
+Computes the count of portals.
+
+#### Returns
+
+The count of portals.
+
+***
+
+### portals
+
+> `readonly` **portals**: `WritableSignal`\<`Portal`\<`unknown`\>[]\>
+
+Defined in: [header.service.ts:25](https://gitlab.com/rxap/packages/-/blob/5c9d13911b2e801186e53ea55b76b15441bb2700/packages/angular/layout/src/lib/header.service.ts#L25)
+
+Represents an array of `Portal` objects with unknown type.
+
+## Methods
+
+### pushPortal()
+
+> **pushPortal**(`portal`): `void`
+
+Defined in: [header.service.ts:43](https://gitlab.com/rxap/packages/-/blob/5c9d13911b2e801186e53ea55b76b15441bb2700/packages/angular/layout/src/lib/header.service.ts#L43)
+
+Adds a portal to the list of portals.
+
+#### Parameters
+
+##### portal
+
+`Portal`\<`unknown`\>
+
+The portal to be added.
+
+#### Returns
+
+`void`
+
+***
+
+### removePortal()
+
+> **removePortal**(`portal`): `void`
+
+Defined in: [header.service.ts:59](https://gitlab.com/rxap/packages/-/blob/5c9d13911b2e801186e53ea55b76b15441bb2700/packages/angular/layout/src/lib/header.service.ts#L59)
+
+Removes a portal from the list of portals.
+
+#### Parameters
+
+##### portal
+
+`Portal`\<`unknown`\>
+
+The portal to be removed.
+
+#### Returns
+
+`void`

package/docs/markdown/classes/LayoutComponent.md

@@ -0,0 +1,43 @@
+[**@rxap/layout**](../README.md)
+
+***
+
+[@rxap/layout](../globals.md) / LayoutComponent
+
+# Class: LayoutComponent
+
+Defined in: [layout/layout.component.ts:59](https://gitlab.com/rxap/packages/-/blob/5c9d13911b2e801186e53ea55b76b15441bb2700/packages/angular/layout/src/lib/layout/layout.component.ts#L59)
+
+## Constructors
+
+### new LayoutComponent()
+
+> **new LayoutComponent**(): [`LayoutComponent`](LayoutComponent.md)
+
+#### Returns
+
+[`LayoutComponent`](LayoutComponent.md)
+
+## Properties
+
+### logoHeight
+
+> `readonly` **logoHeight**: `Signal`\<`number`\>
+
+Defined in: [layout/layout.component.ts:64](https://gitlab.com/rxap/packages/-/blob/5c9d13911b2e801186e53ea55b76b15441bb2700/packages/angular/layout/src/lib/layout/layout.component.ts#L64)
+
+***
+
+### logoSrc
+
+> `readonly` **logoSrc**: `Signal`\<`string`\>
+
+Defined in: [layout/layout.component.ts:62](https://gitlab.com/rxap/packages/-/blob/5c9d13911b2e801186e53ea55b76b15441bb2700/packages/angular/layout/src/lib/layout/layout.component.ts#L62)
+
+***
+
+### logoWidth
+
+> `readonly` **logoWidth**: `Signal`\<`number`\>
+
+Defined in: [layout/layout.component.ts:63](https://gitlab.com/rxap/packages/-/blob/5c9d13911b2e801186e53ea55b76b15441bb2700/packages/angular/layout/src/lib/layout/layout.component.ts#L63)