@rxap/layout 19.0.1 → 19.0.2-dev.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +8 -0
- package/README.md +26 -24
- package/compodoc/changelog.html +4 -0
- package/compodoc/dependencies.html +12 -12
- package/compodoc/index.html +15 -21
- package/compodoc/js/search/search_index.js +2 -2
- package/compodoc/properties.html +1 -1
- package/docs/documentation.json +326 -326
- package/docs/html/assets/highlight.css +12 -19
- package/docs/html/classes/AppsButtonComponent.html +4 -4
- package/docs/html/classes/BaseLayoutComponent.html +1 -1
- package/docs/html/classes/DefaultHeaderComponent.html +2 -2
- package/docs/html/classes/DefaultHeaderService.html +5 -5
- package/docs/html/classes/ExternalAppsService.html +2 -2
- package/docs/html/classes/FooterComponent.html +2 -2
- package/docs/html/classes/FooterDirective.html +3 -3
- package/docs/html/classes/FooterService.html +5 -5
- package/docs/html/classes/HeaderComponent.html +2 -2
- package/docs/html/classes/HeaderDirective.html +3 -3
- package/docs/html/classes/HeaderService.html +5 -5
- package/docs/html/classes/LayoutComponent.html +2 -2
- package/docs/html/classes/LayoutService.html +2 -2
- package/docs/html/classes/LogoService.html +2 -2
- package/docs/html/classes/MinimalLayoutComponent.html +1 -1
- package/docs/html/classes/NavigationComponent.html +3 -3
- package/docs/html/classes/NavigationItemComponent.html +5 -5
- package/docs/html/classes/NavigationProgressBarComponent.html +2 -2
- package/docs/html/classes/NavigationService.html +3 -3
- package/docs/html/classes/ReleaseInfoComponent.html +2 -2
- package/docs/html/classes/SettingsButtonComponent.html +2 -2
- package/docs/html/classes/SidenavComponent.html +2 -2
- package/docs/html/classes/SidenavFooterDirective.html +2 -2
- package/docs/html/classes/SidenavHeaderDirective.html +2 -2
- package/docs/html/classes/SidenavToggleButtonComponent.html +2 -2
- package/docs/html/classes/UserProfileIconComponent.html +2 -2
- package/docs/html/functions/IsNavigationDividerItem.html +1 -1
- package/docs/html/functions/IsNavigationInsertItem.html +1 -1
- package/docs/html/functions/IsNavigationItem.html +1 -1
- package/docs/html/functions/provideExternalApps.html +1 -1
- package/docs/html/functions/provideLayout.html +1 -1
- package/docs/html/functions/withDefaultHeaderComponent.html +1 -1
- package/docs/html/functions/withDefaultHeaderItems.html +1 -1
- package/docs/html/functions/withFooterComponents.html +1 -1
- package/docs/html/functions/withHeaderComponents.html +1 -1
- package/docs/html/functions/withNavigationConfig.html +1 -1
- package/docs/html/functions/withNavigationInserts.html +1 -1
- package/docs/html/functions/withReleaseInfoModules.html +1 -1
- package/docs/html/functions/withSettingsMenuItems.html +1 -1
- package/docs/html/functions/withUserProfileDataSource.html +1 -1
- package/docs/html/index.html +35 -34
- package/docs/html/interfaces/NavigationDividerItem.html +2 -2
- package/docs/html/interfaces/NavigationInsertItem.html +2 -2
- package/docs/html/interfaces/NavigationItem.html +2 -2
- package/docs/html/interfaces/NavigationStatus.html +2 -2
- package/docs/html/interfaces/ReleaseInfoModule.html +2 -2
- package/docs/html/interfaces/SettingsMenuItem.html +2 -2
- package/docs/html/types/DefaultHeaderItemComponent.html +1 -1
- package/docs/html/types/ExternalApp.html +1 -1
- package/docs/html/types/ExtractUsernameFromProfileFn.html +1 -1
- package/docs/html/types/Navigation.html +1 -1
- package/docs/html/types/NavigationWithInserts.html +1 -1
- package/docs/html/types/SettingsMenuItemComponent.html +1 -1
- package/docs/html/variables/EXTRACT_USERNAME_FROM_PROFILE.html +1 -1
- package/docs/html/variables/RXAP_DEFAULT_HEADER_ITEM_COMPONENT.html +1 -1
- package/docs/html/variables/RXAP_EXTERNAL_APP.html +1 -1
- package/docs/html/variables/RXAP_EXTERNAL_APP_FILTER.html +1 -1
- package/docs/html/variables/RXAP_FOOTER_COMPONENT.html +1 -1
- package/docs/html/variables/RXAP_HEADER_COMPONENT.html +1 -1
- package/docs/html/variables/RXAP_LAYOUT_APPS_GRID.html +1 -1
- package/docs/html/variables/RXAP_LOGO_CONFIG.html +1 -1
- package/docs/html/variables/RXAP_NAVIGATION_CONFIG.html +1 -1
- package/docs/html/variables/RXAP_NAVIGATION_CONFIG_INSERTS.html +1 -1
- package/docs/html/variables/RXAP_RELEASE_INFO_MODULE.html +1 -1
- package/docs/html/variables/RXAP_SETTINGS_MENU_ITEM.html +1 -1
- package/docs/html/variables/RXAP_SETTINGS_MENU_ITEM_COMPONENT.html +1 -1
- package/docs/html/variables/RXAP_USER_PROFILE_DATA_SOURCE.html +1 -1
- package/docs/markdown/README.md +26 -24
- package/docs/markdown/classes/AppsButtonComponent.md +6 -6
- package/docs/markdown/classes/BaseLayoutComponent.md +1 -1
- package/docs/markdown/classes/DefaultHeaderComponent.md +6 -6
- package/docs/markdown/classes/DefaultHeaderService.md +5 -5
- package/docs/markdown/classes/ExternalAppsService.md +17 -17
- package/docs/markdown/classes/FooterComponent.md +3 -3
- package/docs/markdown/classes/FooterDirective.md +3 -3
- package/docs/markdown/classes/FooterService.md +5 -5
- package/docs/markdown/classes/HeaderComponent.md +4 -4
- package/docs/markdown/classes/HeaderDirective.md +3 -3
- package/docs/markdown/classes/HeaderService.md +5 -5
- package/docs/markdown/classes/LayoutComponent.md +4 -4
- package/docs/markdown/classes/LayoutService.md +16 -16
- package/docs/markdown/classes/LogoService.md +5 -5
- package/docs/markdown/classes/MinimalLayoutComponent.md +1 -1
- package/docs/markdown/classes/NavigationComponent.md +10 -10
- package/docs/markdown/classes/NavigationItemComponent.md +13 -13
- package/docs/markdown/classes/NavigationProgressBarComponent.md +3 -3
- package/docs/markdown/classes/NavigationService.md +11 -11
- package/docs/markdown/classes/ReleaseInfoComponent.md +4 -4
- package/docs/markdown/classes/SettingsButtonComponent.md +17 -17
- package/docs/markdown/classes/SidenavComponent.md +14 -14
- package/docs/markdown/classes/SidenavFooterDirective.md +3 -3
- package/docs/markdown/classes/SidenavHeaderDirective.md +3 -3
- package/docs/markdown/classes/SidenavToggleButtonComponent.md +3 -3
- package/docs/markdown/classes/UserProfileIconComponent.md +4 -4
- package/docs/markdown/functions/IsNavigationDividerItem.md +1 -1
- package/docs/markdown/functions/IsNavigationInsertItem.md +1 -1
- package/docs/markdown/functions/IsNavigationItem.md +1 -1
- package/docs/markdown/functions/provideExternalApps.md +1 -1
- package/docs/markdown/functions/provideLayout.md +1 -1
- package/docs/markdown/functions/withDefaultHeaderComponent.md +1 -1
- package/docs/markdown/functions/withDefaultHeaderItems.md +1 -1
- package/docs/markdown/functions/withFooterComponents.md +1 -1
- package/docs/markdown/functions/withHeaderComponents.md +1 -1
- package/docs/markdown/functions/withNavigationConfig.md +1 -1
- package/docs/markdown/functions/withNavigationInserts.md +1 -1
- package/docs/markdown/functions/withReleaseInfoModules.md +1 -1
- package/docs/markdown/functions/withSettingsMenuItems.md +1 -1
- package/docs/markdown/functions/withUserProfileDataSource.md +1 -1
- package/docs/markdown/interfaces/NavigationDividerItem.md +3 -3
- package/docs/markdown/interfaces/NavigationInsertItem.md +2 -2
- package/docs/markdown/interfaces/NavigationItem.md +6 -6
- package/docs/markdown/interfaces/NavigationStatus.md +2 -2
- package/docs/markdown/interfaces/ReleaseInfoModule.md +4 -4
- package/docs/markdown/interfaces/SettingsMenuItem.md +4 -4
- package/docs/markdown/type-aliases/DefaultHeaderItemComponent.md +1 -1
- package/docs/markdown/type-aliases/ExternalApp.md +1 -1
- package/docs/markdown/type-aliases/ExtractUsernameFromProfileFn.md +1 -1
- package/docs/markdown/type-aliases/Navigation.md +1 -1
- package/docs/markdown/type-aliases/NavigationWithInserts.md +1 -1
- package/docs/markdown/type-aliases/SettingsMenuItemComponent.md +1 -1
- package/docs/markdown/variables/EXTRACT_USERNAME_FROM_PROFILE.md +1 -1
- package/docs/markdown/variables/RXAP_DEFAULT_HEADER_ITEM_COMPONENT.md +1 -1
- package/docs/markdown/variables/RXAP_EXTERNAL_APP.md +1 -1
- package/docs/markdown/variables/RXAP_EXTERNAL_APP_FILTER.md +1 -1
- package/docs/markdown/variables/RXAP_FOOTER_COMPONENT.md +1 -1
- package/docs/markdown/variables/RXAP_HEADER_COMPONENT.md +1 -1
- package/docs/markdown/variables/RXAP_LAYOUT_APPS_GRID.md +1 -1
- package/docs/markdown/variables/RXAP_LOGO_CONFIG.md +1 -1
- package/docs/markdown/variables/RXAP_NAVIGATION_CONFIG.md +1 -1
- package/docs/markdown/variables/RXAP_NAVIGATION_CONFIG_INSERTS.md +1 -1
- package/docs/markdown/variables/RXAP_RELEASE_INFO_MODULE.md +1 -1
- package/docs/markdown/variables/RXAP_SETTINGS_MENU_ITEM.md +1 -1
- package/docs/markdown/variables/RXAP_SETTINGS_MENU_ITEM_COMPONENT.md +1 -1
- package/docs/markdown/variables/RXAP_USER_PROFILE_DATA_SOURCE.md +1 -1
- package/docs/wiki/Class.AppsButtonComponent.md +6 -6
- package/docs/wiki/Class.BaseLayoutComponent.md +1 -1
- package/docs/wiki/Class.DefaultHeaderComponent.md +6 -6
- package/docs/wiki/Class.DefaultHeaderService.md +5 -5
- package/docs/wiki/Class.ExternalAppsService.md +17 -17
- package/docs/wiki/Class.FooterComponent.md +3 -3
- package/docs/wiki/Class.FooterDirective.md +3 -3
- package/docs/wiki/Class.FooterService.md +5 -5
- package/docs/wiki/Class.HeaderComponent.md +4 -4
- package/docs/wiki/Class.HeaderDirective.md +3 -3
- package/docs/wiki/Class.HeaderService.md +5 -5
- package/docs/wiki/Class.LayoutComponent.md +4 -4
- package/docs/wiki/Class.LayoutService.md +16 -16
- package/docs/wiki/Class.LogoService.md +5 -5
- package/docs/wiki/Class.MinimalLayoutComponent.md +1 -1
- package/docs/wiki/Class.NavigationComponent.md +10 -10
- package/docs/wiki/Class.NavigationItemComponent.md +13 -13
- package/docs/wiki/Class.NavigationProgressBarComponent.md +3 -3
- package/docs/wiki/Class.NavigationService.md +11 -11
- package/docs/wiki/Class.ReleaseInfoComponent.md +4 -4
- package/docs/wiki/Class.SettingsButtonComponent.md +17 -17
- package/docs/wiki/Class.SidenavComponent.md +14 -14
- package/docs/wiki/Class.SidenavFooterDirective.md +3 -3
- package/docs/wiki/Class.SidenavHeaderDirective.md +3 -3
- package/docs/wiki/Class.SidenavToggleButtonComponent.md +3 -3
- package/docs/wiki/Class.UserProfileIconComponent.md +4 -4
- package/docs/wiki/Function.IsNavigationDividerItem.md +1 -1
- package/docs/wiki/Function.IsNavigationInsertItem.md +1 -1
- package/docs/wiki/Function.IsNavigationItem.md +1 -1
- package/docs/wiki/Function.provideExternalApps.md +1 -1
- package/docs/wiki/Function.provideLayout.md +1 -1
- package/docs/wiki/Function.withDefaultHeaderComponent.md +1 -1
- package/docs/wiki/Function.withDefaultHeaderItems.md +1 -1
- package/docs/wiki/Function.withFooterComponents.md +1 -1
- package/docs/wiki/Function.withHeaderComponents.md +1 -1
- package/docs/wiki/Function.withNavigationConfig.md +1 -1
- package/docs/wiki/Function.withNavigationInserts.md +1 -1
- package/docs/wiki/Function.withReleaseInfoModules.md +1 -1
- package/docs/wiki/Function.withSettingsMenuItems.md +1 -1
- package/docs/wiki/Function.withUserProfileDataSource.md +1 -1
- package/docs/wiki/Home.md +26 -24
- package/docs/wiki/Interface.NavigationDividerItem.md +3 -3
- package/docs/wiki/Interface.NavigationInsertItem.md +2 -2
- package/docs/wiki/Interface.NavigationItem.md +6 -6
- package/docs/wiki/Interface.NavigationStatus.md +2 -2
- package/docs/wiki/Interface.ReleaseInfoModule.md +4 -4
- package/docs/wiki/Interface.SettingsMenuItem.md +4 -4
- package/docs/wiki/TypeAlias.DefaultHeaderItemComponent.md +1 -1
- package/docs/wiki/TypeAlias.ExternalApp.md +1 -1
- package/docs/wiki/TypeAlias.ExtractUsernameFromProfileFn.md +1 -1
- package/docs/wiki/TypeAlias.Navigation.md +1 -1
- package/docs/wiki/TypeAlias.NavigationWithInserts.md +1 -1
- package/docs/wiki/TypeAlias.SettingsMenuItemComponent.md +1 -1
- package/docs/wiki/Variable.EXTRACT_USERNAME_FROM_PROFILE.md +1 -1
- package/docs/wiki/Variable.RXAP_DEFAULT_HEADER_ITEM_COMPONENT.md +1 -1
- package/docs/wiki/Variable.RXAP_EXTERNAL_APP.md +1 -1
- package/docs/wiki/Variable.RXAP_EXTERNAL_APP_FILTER.md +1 -1
- package/docs/wiki/Variable.RXAP_FOOTER_COMPONENT.md +1 -1
- package/docs/wiki/Variable.RXAP_HEADER_COMPONENT.md +1 -1
- package/docs/wiki/Variable.RXAP_LAYOUT_APPS_GRID.md +1 -1
- package/docs/wiki/Variable.RXAP_LOGO_CONFIG.md +1 -1
- package/docs/wiki/Variable.RXAP_NAVIGATION_CONFIG.md +1 -1
- package/docs/wiki/Variable.RXAP_NAVIGATION_CONFIG_INSERTS.md +1 -1
- package/docs/wiki/Variable.RXAP_RELEASE_INFO_MODULE.md +1 -1
- package/docs/wiki/Variable.RXAP_SETTINGS_MENU_ITEM.md +1 -1
- package/docs/wiki/Variable.RXAP_SETTINGS_MENU_ITEM_COMPONENT.md +1 -1
- package/docs/wiki/Variable.RXAP_USER_PROFILE_DATA_SOURCE.md +1 -1
- package/package.json +28 -28
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,14 @@
|
|
|
3
3
|
All notable changes to this project will be documented in this file.
|
|
4
4
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
5
5
|
|
|
6
|
+
## [19.0.2-dev.1](https://gitlab.com/rxap/packages/compare/@rxap/layout@19.0.2-dev.0...@rxap/layout@19.0.2-dev.1) (2025-02-18)
|
|
7
|
+
|
|
8
|
+
**Note:** Version bump only for package @rxap/layout
|
|
9
|
+
|
|
10
|
+
## [19.0.2-dev.0](https://gitlab.com/rxap/packages/compare/@rxap/layout@19.0.1...@rxap/layout@19.0.2-dev.0) (2025-02-17)
|
|
11
|
+
|
|
12
|
+
**Note:** Version bump only for package @rxap/layout
|
|
13
|
+
|
|
6
14
|
## [19.0.1](https://gitlab.com/rxap/packages/compare/@rxap/layout@19.0.1-dev.15...@rxap/layout@19.0.1) (2025-02-13)
|
|
7
15
|
|
|
8
16
|
**Note:** Version bump only for package @rxap/layout
|
package/README.md
CHANGED
|
@@ -1,30 +1,34 @@
|
|
|
1
1
|
This library provides a set of Angular components and services for creating consistent and configurable application layouts, including headers, footers, side navigation, and content areas. It offers features such as dynamic navigation, external application integration, and customizable themes. The library also includes directives for extending header and footer areas with custom content.
|
|
2
2
|
|
|
3
3
|
[](https://www.npmjs.com/package/@rxap/layout)
|
|
4
|
-
[](https://github.com/prettier/prettier)
|
|
8
|
-

|
|
4
|
+
[](https://commitizen.github.io/cz-cli/)
|
|
5
|
+
[](https://github.com/prettier/prettier)
|
|
6
|
+

|
|
10
7
|

|
|
11
|
-

|
|
12
|
-
|
|
8
|
+

|
|
9
|
+
|
|
10
|
+
- [Installation](#installation)
|
|
13
11
|
- [Get started](#get-started)
|
|
14
12
|
- [Generators](#generators)
|
|
15
|
-
|
|
13
|
+
- [init](#init)
|
|
14
|
+
|
|
15
|
+
# Installation
|
|
16
16
|
|
|
17
|
-
|
|
18
|
-
|
|
17
|
+
**Add the package to your workspace:**
|
|
18
|
+
```bash
|
|
19
|
+
yarn add @rxap/layout
|
|
20
|
+
```
|
|
21
|
+
**Install peer dependencies:**
|
|
22
|
+
```bash
|
|
23
|
+
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 @rxap/config@^19.0.1 @rxap/data-source@^19.0.1 @rxap/environment@^19.0.1 @rxap/material-directives@^19.0.1 @rxap/ngx-pub-sub@^19.0.1 @rxap/ngx-theme@^19.0.1 @rxap/pattern@^1.1.11 @rxap/utilities@^16.4.2 rxjs@^7.8.1
|
|
24
|
+
```
|
|
25
|
+
**Execute the init generator:**
|
|
26
|
+
```bash
|
|
27
|
+
yarn nx g @rxap/layout:init
|
|
19
28
|
```
|
|
20
|
-
**Install peer dependencies:** ```bash yarn add
|
|
21
|
-
@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.5 @rxap/config@^19.0.1-dev.5 @rxap/data-source@^19.0.1-dev.5 @rxap/environment@^19.0.1-dev.5 @rxap/material-directives@^19.0.1-dev.5 @rxap/ngx-pub-sub@^19.0.1-dev.5 @rxap/ngx-theme@^19.0.1-dev.5 @rxap/pattern@^1.1.11-dev.5 @rxap/utilities@^16.4.2-dev.4 rxjs@^7.8.1
|
|
22
|
-
```
|
|
23
|
-
**Execute the init generator:** ```bash yarn nx g
|
|
24
|
-
@rxap/layout:init ```
|
|
25
29
|
# Get started
|
|
26
30
|
|
|
27
|
-
|
|
31
|
+
## Layout
|
|
28
32
|
|
|
29
33
|
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.
|
|
30
34
|
|
|
@@ -289,11 +293,9 @@ that is rendered in the layout component, the template is rendered in the footer
|
|
|
289
293
|
|
|
290
294
|
# Generators
|
|
291
295
|
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
>
|
|
295
|
-
Initialize the package in the workspace
|
|
296
|
+
## init
|
|
297
|
+
> Initialize the package in the workspace
|
|
296
298
|
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
|
|
299
|
+
```bash
|
|
300
|
+
nx g @rxap/layout:init
|
|
301
|
+
```
|
package/compodoc/changelog.html
CHANGED
|
@@ -85,6 +85,10 @@
|
|
|
85
85
|
<h1>Change Log</h1>
|
|
86
86
|
<p>All notable changes to this project will be documented in this file.
|
|
87
87
|
See <a href="https://conventionalcommits.org">Conventional Commits</a> for commit guidelines.</p>
|
|
88
|
+
<h2><a href="https://gitlab.com/rxap/packages/compare/@rxap/layout@19.0.2-dev.0...@rxap/layout@19.0.2-dev.1">19.0.2-dev.1</a> (2025-02-18)</h2>
|
|
89
|
+
<p><strong>Note:</strong> Version bump only for package @rxap/layout</p>
|
|
90
|
+
<h2><a href="https://gitlab.com/rxap/packages/compare/@rxap/layout@19.0.1...@rxap/layout@19.0.2-dev.0">19.0.2-dev.0</a> (2025-02-17)</h2>
|
|
91
|
+
<p><strong>Note:</strong> Version bump only for package @rxap/layout</p>
|
|
88
92
|
<h2><a href="https://gitlab.com/rxap/packages/compare/@rxap/layout@19.0.1-dev.15...@rxap/layout@19.0.1">19.0.1</a> (2025-02-13)</h2>
|
|
89
93
|
<p><strong>Note:</strong> Version bump only for package @rxap/layout</p>
|
|
90
94
|
<h2><a href="https://gitlab.com/rxap/packages/compare/@rxap/layout@19.0.1-dev.14...@rxap/layout@19.0.1-dev.15">19.0.1-dev.15</a> (2025-02-13)</h2>
|
|
@@ -103,11 +103,11 @@
|
|
|
103
103
|
<li>
|
|
104
104
|
<b>@nx/devkit</b> : 20.4.2</li>
|
|
105
105
|
<li>
|
|
106
|
-
<b>@rxap/ts-morph</b> : ^1.5.
|
|
106
|
+
<b>@rxap/ts-morph</b> : ^1.5.4-dev.0</li>
|
|
107
107
|
<li>
|
|
108
|
-
<b>@rxap/workspace-ts-morph</b> : ^19.1.
|
|
108
|
+
<b>@rxap/workspace-ts-morph</b> : ^19.1.10-dev.1</li>
|
|
109
109
|
<li>
|
|
110
|
-
<b>@rxap/workspace-utilities</b> : ^19.6.1</li>
|
|
110
|
+
<b>@rxap/workspace-utilities</b> : ^19.6.2-dev.1</li>
|
|
111
111
|
<li>
|
|
112
112
|
<b>tslib</b> : 2.6.2</li>
|
|
113
113
|
</ul>
|
|
@@ -131,23 +131,23 @@
|
|
|
131
131
|
<li>
|
|
132
132
|
<b>@angular/router</b> : ^19.1.3</li>
|
|
133
133
|
<li>
|
|
134
|
-
<b>@rxap/browser-utilities</b> : ^1.1.10
|
|
134
|
+
<b>@rxap/browser-utilities</b> : ^1.1.10</li>
|
|
135
135
|
<li>
|
|
136
|
-
<b>@rxap/config</b> : ^19.0.1
|
|
136
|
+
<b>@rxap/config</b> : ^19.0.1</li>
|
|
137
137
|
<li>
|
|
138
|
-
<b>@rxap/data-source</b> : ^19.0.1
|
|
138
|
+
<b>@rxap/data-source</b> : ^19.0.1</li>
|
|
139
139
|
<li>
|
|
140
|
-
<b>@rxap/environment</b> : ^19.0.1
|
|
140
|
+
<b>@rxap/environment</b> : ^19.0.1</li>
|
|
141
141
|
<li>
|
|
142
|
-
<b>@rxap/material-directives</b> : ^19.0.1
|
|
142
|
+
<b>@rxap/material-directives</b> : ^19.0.1</li>
|
|
143
143
|
<li>
|
|
144
|
-
<b>@rxap/ngx-pub-sub</b> : ^19.0.1
|
|
144
|
+
<b>@rxap/ngx-pub-sub</b> : ^19.0.1</li>
|
|
145
145
|
<li>
|
|
146
|
-
<b>@rxap/ngx-theme</b> : ^19.0.1
|
|
146
|
+
<b>@rxap/ngx-theme</b> : ^19.0.1</li>
|
|
147
147
|
<li>
|
|
148
|
-
<b>@rxap/pattern</b> : ^1.1.11
|
|
148
|
+
<b>@rxap/pattern</b> : ^1.1.11</li>
|
|
149
149
|
<li>
|
|
150
|
-
<b>@rxap/utilities</b> : ^16.4.2
|
|
150
|
+
<b>@rxap/utilities</b> : ^16.4.2</li>
|
|
151
151
|
<li>
|
|
152
152
|
<b>rxjs</b> : ^7.8.1</li>
|
|
153
153
|
</ul>
|
package/compodoc/index.html
CHANGED
|
@@ -84,27 +84,24 @@
|
|
|
84
84
|
|
|
85
85
|
<p>This library provides a set of Angular components and services for creating consistent and configurable application layouts, including headers, footers, side navigation, and content areas. It offers features such as dynamic navigation, external application integration, and customizable themes. The library also includes directives for extending header and footer areas with custom content.</p>
|
|
86
86
|
<p><a href="https://www.npmjs.com/package/@rxap/layout"><img src="https://img.shields.io/npm/v/@rxap/layout?style=flat-square" alt="npm version" class="img-responsive"></a>
|
|
87
|
-
<a href="https://commitizen.github.io/cz-cli/"><img src="https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=flat-square" alt="commitizen
|
|
88
|
-
|
|
89
|
-
<
|
|
90
|
-
prettier" class="img-responsive"></a>
|
|
91
|
-
<img src="https://img.shields.io/librariesio/release/npm/@rxap/layout" alt="Libraries.io dependency status for latest release, scoped npm
|
|
92
|
-
package" class="img-responsive">
|
|
87
|
+
<a href="https://commitizen.github.io/cz-cli/"><img src="https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=flat-square" alt="commitizen friendly" class="img-responsive"></a>
|
|
88
|
+
<a href="https://github.com/prettier/prettier"><img src="https://img.shields.io/badge/styled_with-prettier-ff69b4.svg?style=flat-square" alt="styled with prettier" class="img-responsive"></a>
|
|
89
|
+
<img src="https://img.shields.io/librariesio/release/npm/@rxap/layout" alt="Libraries.io dependency status for latest release, scoped npm package" class="img-responsive">
|
|
93
90
|
<img src="https://img.shields.io/npm/dm/@rxap/layout" alt="npm" class="img-responsive">
|
|
94
|
-
<img src="https://img.shields.io/npm/l/@rxap/layout" alt="NPM" class="img-responsive">
|
|
95
|
-
<a href="#installation">Installation</a></p>
|
|
91
|
+
<img src="https://img.shields.io/npm/l/@rxap/layout" alt="NPM" class="img-responsive"></p>
|
|
96
92
|
<ul>
|
|
93
|
+
<li><a href="#installation">Installation</a></li>
|
|
97
94
|
<li><a href="#get-started">Get started</a></li>
|
|
98
95
|
<li><a href="#generators">Generators</a><ul>
|
|
99
96
|
<li><a href="#init">init</a></li>
|
|
100
97
|
</ul>
|
|
101
98
|
</li>
|
|
102
99
|
</ul>
|
|
103
|
-
<h1>Installation
|
|
104
|
-
<p
|
|
105
|
-
<b>Example :</b><div><pre class="line-numbers"><code class="language-
|
|
106
|
-
|
|
107
|
-
<h1>Get started</h1>
|
|
100
|
+
<h1>Installation</h1>
|
|
101
|
+
<p><strong>Add the package to your workspace:</strong></p>
|
|
102
|
+
<b>Example :</b><div><pre class="line-numbers"><code class="language-bash">yarn add @rxap/layout</code></pre></div><p><strong>Install peer dependencies:</strong></p>
|
|
103
|
+
<b>Example :</b><div><pre class="line-numbers"><code class="language-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 @rxap/config@^19.0.1 @rxap/data-source@^19.0.1 @rxap/environment@^19.0.1 @rxap/material-directives@^19.0.1 @rxap/ngx-pub-sub@^19.0.1 @rxap/ngx-theme@^19.0.1 @rxap/pattern@^1.1.11 @rxap/utilities@^16.4.2 rxjs@^7.8.1 </code></pre></div><p><strong>Execute the init generator:</strong></p>
|
|
104
|
+
<b>Example :</b><div><pre class="line-numbers"><code class="language-bash">yarn nx g @rxap/layout:init</code></pre></div><h1>Get started</h1>
|
|
108
105
|
<h2>Layout</h2>
|
|
109
106
|
<p>Create a new file <code>layout.routes.ts</code> in the <code>app</code> folder. This file will contain all child routes that should be loaded within the layout component.</p>
|
|
110
107
|
<b>Example :</b><div><pre class="line-numbers"><code class="language-typescript">import { LayoutComponent, provideLayout } from '@rxap/layout';
|
|
@@ -279,14 +276,11 @@ that is rendered in the layout component, the template is rendered in the footer
|
|
|
279
276
|
<ng-template rxapFooter>
|
|
280
277
|
<button mat-button>A button in the layout footer</button>
|
|
281
278
|
</ng-template></code></pre></div><h1>Generators</h1>
|
|
282
|
-
<
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
```bash nx g
|
|
288
|
-
@rxap/layout:init
|
|
289
|
-
```</code></pre></div>
|
|
279
|
+
<h2>init</h2>
|
|
280
|
+
<blockquote>
|
|
281
|
+
<p>Initialize the package in the workspace</p>
|
|
282
|
+
</blockquote>
|
|
283
|
+
<b>Example :</b><div><pre class="line-numbers"><code class="language-bash">nx g @rxap/layout:init</code></pre></div>
|
|
290
284
|
|
|
291
285
|
|
|
292
286
|
|