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

package/docs/markdown/README.md

@@ -1,304 +0,0 @@
-**@rxap/layout**
-
-***
-
-# @rxap/layout
-
-[![npm version](https://img.shields.io/npm/v/@rxap/layout?style=flat-square)](https://www.npmjs.com/package/@rxap/layout)
-[![commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=flat-square)](https://commitizen.github.io/cz-cli/)
-[![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
-![Libraries.io dependency status for latest release, scoped npm package](https://img.shields.io/librariesio/release/npm/@rxap/layout)
-![npm](https://img.shields.io/npm/dm/@rxap/layout)
-![NPM](https://img.shields.io/npm/l/@rxap/layout)
-
-- [Installation](#installation)
-- [Get started](#get-started)
-- [Generators](#generators)
-
-# Installation
-
-**Add the package to your workspace:**
-```bash
-yarn add @rxap/layout
-```
-**Install peer dependencies:**
-```bash
-yarn add @angular/animations@^19.1.3 @angular/cdk@^19.1.1 @angular/common@^19.1.3 @angular/core@^19.1.3 @angular/material@^19.1.1 @angular/router@^19.1.3 @rxap/browser-utilities@^1.1.10-dev.4 @rxap/config@^19.0.1-dev.4 @rxap/data-source@^19.0.1-dev.4 @rxap/environment@^19.0.1-dev.4 @rxap/material-directives@^19.0.1-dev.4 @rxap/ngx-pub-sub@^19.0.1-dev.4 @rxap/ngx-theme@^19.0.1-dev.4 @rxap/pattern@^1.1.11-dev.4 @rxap/utilities@^16.4.2-dev.4 rxjs@^7.8.1 
-```
-**Execute the init generator:**
-```bash
-yarn nx g @rxap/layout:init
-```
-# Get started
-
-## Layout
-
-Create a new file `layout.routes.ts` in the `app` folder. This file will contain all child routes that should be loaded within the layout component.
-
-```typescript
-import { LayoutComponent, provideLayout } from '@rxap/layout';
-
-const ROUTES: Route[] = [
-  {
-    path: '',
-    component: LayoutComponent,
-    children: [ ],
-    providers: [ provideLayout() ],
-  },
-];
-```
-
-Import the layout routes into the `app.routes.ts` file.
-
-```typescript
-export const appRoutes: Route[] = [
-  {
-    path: '',
-    loadChildren: () => import('./layout.routes'),
-  },
-  {
-    path: '**',
-    redirectTo: '',
-  },
-];
-```
-
-## Navigation
-
-Create a new file `app.navigation.ts` in the `app` folder. This file will contain the navigation items that should be displayed in the layout component.
-
-```typescript
-export const APP_NAVIGATION: () => NavigationWithInserts = () => [];
-```
-
-Provide the app navigation in the layout routes:
-
-```typescript
-import {
-  LayoutComponent,
-  ProvideNavigationConfig,
-  withNavigationService,
-} from '@rxap/layout';
-import { APP_NAVIGATION } from './app.navigation';
-
-const ROUTES: Route[] = [
-  {
-    path: '',
-    component: LayoutComponent,
-    children: [ ],
-    providers: [
-      provideLayout(
-        withNavigationConfig(APP_NAVIGATION),
-      ),
-    ],
-  },
-];
-```
-
-### Navigation Item
-
-A navigation item represents a single item in the navigation sidebar. Each item has the required properties `label` and `routerLink`. The `label` property is the text that should be displayed in the sidebar. The `routerLink` property is the path that should be navigated to when the item is clicked.
-
-```typescript
-const item: NavigationItem = {
-  label: 'Home',
-  routerLink: '/',
-};
-```
-
-With the `children` property, a navigation item can have child items. The child items are displayed in a dropdown menu when the parent item is clicked.
-
-```typescript
-const item: NavigationItem = {
-  label: 'Home',
-  routerLink: '/',
-  children: [
-    {
-      label: 'Child',
-      routerLink: '/child',
-    },
-  ],
-};
-```
-
-#### Icon Property
-
-With the `icon` property, the item can be assigned an icon. The icon is displayed to the left of the label. If the navigation sidebar is collapsed, only the icon is displayed.
-
-```typescript
-const item: NavigationItem = {
-  label: 'Home',
-  routerLink: '/',
-  icon: { icon: 'home' },
-};
-```
-
-#### Status Property
-
-With the `status` property, a injectable token, class or function can be assigned to the item. The object must have the method `isVisible` which returns a boolean. If the method returns `false`, the item is not displayed in the navigation sidebar.
-
-```typescript
-@Injectable()
-class SetNavStatus {
-  isVisible(item: NavigationItem): boolean {
-    return false;
-  }
-}
-
-const item: NavigationItem = {
-  label: 'Home',
-  routerLink: '/',
-  status: SetNavStatus,
-};
-```
-
-### Navigation Divider Item
-
-A navigation divider item is a horizontal line that separates navigation items. It is used to group items in the navigation sidebar. It is required to set the property `divider` to `true`. With the optional property `title`, a title can be defined that is displayed below the divider.
-
-```typescript
-const item: NavigationDividerItem = {
-  divider: true,
-  title: 'Group',
-};
-```
-
-### Navigation Insert Item (WIP)
-
-A navigation insert item is a placeholder for a navigation item that should be inserted into the navigation sidebar. 
-The item is used to define where a dynamic navigation should be inserted. The `insert` property is the key that is used 
-identify the insert item. The `insert` property is required.
-
-```typescript
-const item: NavigationInsertItem = {
-  insert: 'insert-key',
-};
-```
-
-## Header
-
-The header is composed of the components from left to right: AppsButtonComponent, SettingsButtonComponent and UserProfileIconComponent.
-
-### Apps Button
-
-The apps buttons allow for a navigation between different applications. To configure the apps button, the config path 
-`navigation.apps` must be set with an array of object with the property `title` and ether `routerLink` or `href`. If the
-property `href` is set, the link is opened in a new tab. If the property `routerLink` the router is used to navigate.
-
-```json
-{
-  "navigation": {
-    "apps": [
-      {
-        "title": "App 1",
-        "routerLink": ["/", "app1"]
-      },
-      {
-        "title": "App 2",
-        "href": "https://app2.com"
-      }
-    ]
-  }
-}
-```
-
-> If the application is in production mode, the current `localId` is appended to the url defined in the `href` property.
-
-### Settings Button Customization (WIP)
-
-It is possible to add custom items to the settings menu. This custom item can be a component or a configuration object.
-
-> 
-
-#### Configuration Object
-
-The action function is called when the item is clicked. It is possible to use the `inject` function to inject services.
-
-```typescript
-import {
-  LayoutComponent,
-  ProvideNavigationConfig,
-  withNavigationService,
-} from '@rxap/layout';
-import { APP_NAVIGATION } from './app.navigation';
-
-const ROUTES: Route[] = [
-  {
-    path: '',
-    component: LayoutComponent,
-    children: [ ],
-    providers: [
-      provideLayout(
-        withNavigationConfig(APP_NAVIGATION),
-        withSettingsMenuItems(
-          {
-            label: 'Custom Item',
-            icon: { icon: 'home' },
-            action: () => inject(MatDialog).open(MyCustomDialogComponent),
-          }
-        )
-      ),
-    ],
-  },
-];
-```
-
-#### Component
-
-If a component is provided ensure the component template uses the `mat-menu-item` component:
-
-```angular17html
-<button mat-menu-item>My Custom Item</button>
-```
-
-```typescript
-import {
-  LayoutComponent,
-  ProvideNavigationConfig,
-  withNavigationService,
-} from '@rxap/layout';
-import { APP_NAVIGATION } from './app.navigation';
-
-const ROUTES: Route[] = [
-  {
-    path: '',
-    component: LayoutComponent,
-    children: [ ],
-    providers: [
-      provideLayout(
-        withNavigationConfig(APP_NAVIGATION),
-        withSettingsMenuItems(
-          MyCustomMenuItemComponent
-        )
-      ),
-    ],
-  },
-];
-```
-
-### User Profile (WIP)
-
-...
-
-## Dynamic Footer
-
-With the directive `rxapFooter` it is possible to define a dynamic footer. When the directive is used on a `<ng-template>` in a component,
-that is rendered in the layout component, the template is rendered in the footer of the layout component.
-
-```angular17html
-<mat-card>
-  ...
-</mat-card>
-<ng-template rxapFooter>
-  <button mat-button>A button in the layout footer</button>
-</ng-template>
-```
-
-# Generators
-
-## init
-> Initialize the package in the workspace
-
-```bash
-yarn nx g @rxap/layout:init
-```

package/docs/markdown/classes/AppsButtonComponent.md

@@ -1,83 +0,0 @@
-[**@rxap/layout**](../README.md)
-
-***
-
-[@rxap/layout](../globals.md) / AppsButtonComponent
-
-# Class: AppsButtonComponent
-
-Defined in: [default-header/apps-button/apps-button.component.ts:35](https://gitlab.com/rxap/packages/-/blob/5c9d13911b2e801186e53ea55b76b15441bb2700/packages/angular/layout/src/lib/default-header/apps-button/apps-button.component.ts#L35)
-
-## Implements
-
-- `OnInit`
-
-## Constructors
-
-### new AppsButtonComponent()
-
-> **new AppsButtonComponent**(): [`AppsButtonComponent`](AppsButtonComponent.md)
-
-#### Returns
-
-[`AppsButtonComponent`](AppsButtonComponent.md)
-
-## Properties
-
-### appList
-
-> `readonly` **appList**: `Signal`\<`AppsNavigationConfig`[]\>
-
-Defined in: [default-header/apps-button/apps-button.component.ts:42](https://gitlab.com/rxap/packages/-/blob/5c9d13911b2e801186e53ea55b76b15441bb2700/packages/angular/layout/src/lib/default-header/apps-button/apps-button.component.ts#L42)
-
-***
-
-### hasApps
-
-> `readonly` **hasApps**: `Signal`\<`boolean`\>
-
-Defined in: [default-header/apps-button/apps-button.component.ts:43](https://gitlab.com/rxap/packages/-/blob/5c9d13911b2e801186e53ea55b76b15441bb2700/packages/angular/layout/src/lib/default-header/apps-button/apps-button.component.ts#L43)
-
-***
-
-### isOpen
-
-> `readonly` **isOpen**: `WritableSignal`\<`boolean`\>
-
-Defined in: [default-header/apps-button/apps-button.component.ts:39](https://gitlab.com/rxap/packages/-/blob/5c9d13911b2e801186e53ea55b76b15441bb2700/packages/angular/layout/src/lib/default-header/apps-button/apps-button.component.ts#L39)
-
-The signal that indicates if the app list is open
-
-## Methods
-
-### ngOnInit()
-
-> **ngOnInit**(): `void`
-
-Defined in: [default-header/apps-button/apps-button.component.ts:49](https://gitlab.com/rxap/packages/-/blob/5c9d13911b2e801186e53ea55b76b15441bb2700/packages/angular/layout/src/lib/default-header/apps-button/apps-button.component.ts#L49)
-
-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`
-
-***
-
-### toggle()
-
-> **toggle**(): `void`
-
-Defined in: [default-header/apps-button/apps-button.component.ts:45](https://gitlab.com/rxap/packages/-/blob/5c9d13911b2e801186e53ea55b76b15441bb2700/packages/angular/layout/src/lib/default-header/apps-button/apps-button.component.ts#L45)
-
-#### Returns
-
-`void`

package/docs/markdown/classes/BaseLayoutComponent.md

@@ -1,19 +0,0 @@
-[**@rxap/layout**](../README.md)
-
-***
-
-[@rxap/layout](../globals.md) / BaseLayoutComponent
-
-# Class: BaseLayoutComponent
-
-Defined in: [base-layout/base-layout.component.ts:18](https://gitlab.com/rxap/packages/-/blob/5c9d13911b2e801186e53ea55b76b15441bb2700/packages/angular/layout/src/lib/base-layout/base-layout.component.ts#L18)
-
-## Constructors
-
-### new BaseLayoutComponent()
-
-> **new BaseLayoutComponent**(): [`BaseLayoutComponent`](BaseLayoutComponent.md)
-
-#### Returns
-
-[`BaseLayoutComponent`](BaseLayoutComponent.md)

package/docs/markdown/classes/DefaultHeaderComponent.md

@@ -1,59 +0,0 @@
-[**@rxap/layout**](../README.md)
-
-***
-
-[@rxap/layout](../globals.md) / DefaultHeaderComponent
-
-# Class: DefaultHeaderComponent
-
-Defined in: [default-header/default-header.component.ts:36](https://gitlab.com/rxap/packages/-/blob/5c9d13911b2e801186e53ea55b76b15441bb2700/packages/angular/layout/src/lib/default-header/default-header.component.ts#L36)
-
-## Constructors
-
-### new DefaultHeaderComponent()
-
-> **new DefaultHeaderComponent**(): [`DefaultHeaderComponent`](DefaultHeaderComponent.md)
-
-#### Returns
-
-[`DefaultHeaderComponent`](DefaultHeaderComponent.md)
-
-## Properties
-
-### collapsable
-
-> `readonly` **collapsable**: `Signal`\<`boolean`\>
-
-Defined in: [default-header/default-header.component.ts:40](https://gitlab.com/rxap/packages/-/blob/5c9d13911b2e801186e53ea55b76b15441bb2700/packages/angular/layout/src/lib/default-header/default-header.component.ts#L40)
-
-***
-
-### hasPortals
-
-> `readonly` **hasPortals**: `Signal`\<`boolean`\>
-
-Defined in: [default-header/default-header.component.ts:47](https://gitlab.com/rxap/packages/-/blob/5c9d13911b2e801186e53ea55b76b15441bb2700/packages/angular/layout/src/lib/default-header/default-header.component.ts#L47)
-
-***
-
-### opened
-
-> `readonly` **opened**: `Signal`\<`boolean`\>
-
-Defined in: [default-header/default-header.component.ts:41](https://gitlab.com/rxap/packages/-/blob/5c9d13911b2e801186e53ea55b76b15441bb2700/packages/angular/layout/src/lib/default-header/default-header.component.ts#L41)
-
-***
-
-### portals
-
-> `readonly` **portals**: `Signal`\<`Portal`\<`unknown`\>[]\>
-
-Defined in: [default-header/default-header.component.ts:46](https://gitlab.com/rxap/packages/-/blob/5c9d13911b2e801186e53ea55b76b15441bb2700/packages/angular/layout/src/lib/default-header/default-header.component.ts#L46)
-
-***
-
-### profile
-
-> `readonly` **profile**: `Signal`\<`unknown`\>
-
-Defined in: [default-header/default-header.component.ts:42](https://gitlab.com/rxap/packages/-/blob/5c9d13911b2e801186e53ea55b76b15441bb2700/packages/angular/layout/src/lib/default-header/default-header.component.ts#L42)

package/docs/markdown/classes/DefaultHeaderService.md

@@ -1,87 +0,0 @@
-[**@rxap/layout**](../README.md)
-
-***
-
-[@rxap/layout](../globals.md) / DefaultHeaderService
-
-# Class: DefaultHeaderService
-
-Defined in: [default-header/default-header.service.ts:21](https://gitlab.com/rxap/packages/-/blob/5c9d13911b2e801186e53ea55b76b15441bb2700/packages/angular/layout/src/lib/default-header/default-header.service.ts#L21)
-
-## Constructors
-
-### new DefaultHeaderService()
-
-> **new DefaultHeaderService**(): [`DefaultHeaderService`](DefaultHeaderService.md)
-
-#### Returns
-
-[`DefaultHeaderService`](DefaultHeaderService.md)
-
-## Properties
-
-### portalCount
-
-> `readonly` **portalCount**: `Signal`\<`number`\>
-
-Defined in: [default-header/default-header.service.ts:42](https://gitlab.com/rxap/packages/-/blob/5c9d13911b2e801186e53ea55b76b15441bb2700/packages/angular/layout/src/lib/default-header/default-header.service.ts#L42)
-
-Computes the count of portals.
-
-#### Returns
-
-The count of portals.
-
-***
-
-### portals
-
-> `readonly` **portals**: `Signal`\<`Portal`\<`unknown`\>[]\>
-
-Defined in: [default-header/default-header.service.ts:34](https://gitlab.com/rxap/packages/-/blob/5c9d13911b2e801186e53ea55b76b15441bb2700/packages/angular/layout/src/lib/default-header/default-header.service.ts#L34)
-
-Represents an array of `Portal` objects with unknown type.
-
-## Methods
-
-### pushPortal()
-
-> **pushPortal**(`portal`): `void`
-
-Defined in: [default-header/default-header.service.ts:52](https://gitlab.com/rxap/packages/-/blob/5c9d13911b2e801186e53ea55b76b15441bb2700/packages/angular/layout/src/lib/default-header/default-header.service.ts#L52)
-
-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: [default-header/default-header.service.ts:68](https://gitlab.com/rxap/packages/-/blob/5c9d13911b2e801186e53ea55b76b15441bb2700/packages/angular/layout/src/lib/default-header/default-header.service.ts#L68)
-
-Removes a portal from the list of portals.
-
-#### Parameters
-
-##### portal
-
-`Portal`\<`unknown`\>
-
-The portal to be removed.
-
-#### Returns
-
-`void`