@progress/kendo-angular-navigation 19.1.2-develop.3 → 19.1.2-develop.5

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.
Files changed (62) hide show
  1. package/actionsheet/actionsheet.component.d.ts +18 -17
  2. package/actionsheet/models/actionsheet-action-layout.d.ts +15 -13
  3. package/actionsheet/models/actionsheet-action.d.ts +9 -30
  4. package/actionsheet/models/actionsheet-item.interface.d.ts +13 -18
  5. package/actionsheet/models/animation.d.ts +4 -2
  6. package/actionsheet/models/group.d.ts +6 -0
  7. package/actionsheet/models/item-click.event.d.ts +5 -3
  8. package/actionsheet/templates/actionsheet-template.d.ts +10 -1
  9. package/actionsheet/templates/content-template.directive.d.ts +10 -1
  10. package/actionsheet/templates/footer-template.directive.d.ts +10 -1
  11. package/actionsheet/templates/header-template.directive.d.ts +10 -1
  12. package/actionsheet/templates/item-template.directive.d.ts +10 -1
  13. package/actionsheet.module.d.ts +5 -18
  14. package/appbar/appbar-section.component.d.ts +9 -13
  15. package/appbar/appbar-spacer.component.d.ts +13 -21
  16. package/appbar/appbar.component.d.ts +19 -25
  17. package/appbar/models/position-mode.d.ts +5 -6
  18. package/appbar/models/position.d.ts +3 -8
  19. package/appbar/models/theme-color.d.ts +6 -7
  20. package/appbar.module.d.ts +5 -18
  21. package/bottomnavigation/bottomnavigation.component.d.ts +17 -31
  22. package/bottomnavigation/events/select-event.d.ts +5 -5
  23. package/bottomnavigation/templates/item-template.directive.d.ts +11 -3
  24. package/bottomnavigation/types/bottomnavigation-fill.d.ts +3 -3
  25. package/bottomnavigation/types/bottomnavigation-item-flow.d.ts +3 -3
  26. package/bottomnavigation/types/bottomnavigation-item.d.ts +11 -10
  27. package/bottomnavigation/types/bottomnavigation-position-mode.d.ts +3 -3
  28. package/bottomnavigation/types/bottomnavigation-theme-color.d.ts +12 -12
  29. package/bottomnavigation.module.d.ts +6 -18
  30. package/breadcrumb/breadcrumb.component.d.ts +14 -19
  31. package/breadcrumb/models/breadcrumb-item.interface.d.ts +10 -11
  32. package/breadcrumb/models/breadcrumb-size.d.ts +1 -2
  33. package/breadcrumb/models/collapse-mode.d.ts +5 -3
  34. package/breadcrumb/template-directives/item-template.directive.d.ts +12 -1
  35. package/breadcrumb.module.d.ts +6 -18
  36. package/directives.d.ts +94 -5
  37. package/esm2022/actionsheet/actionsheet.component.mjs +18 -17
  38. package/esm2022/actionsheet/models/item-click.event.mjs +5 -3
  39. package/esm2022/actionsheet/templates/actionsheet-template.mjs +10 -1
  40. package/esm2022/actionsheet/templates/content-template.directive.mjs +10 -1
  41. package/esm2022/actionsheet/templates/footer-template.directive.mjs +10 -1
  42. package/esm2022/actionsheet/templates/header-template.directive.mjs +10 -1
  43. package/esm2022/actionsheet/templates/item-template.directive.mjs +10 -1
  44. package/esm2022/actionsheet.module.mjs +5 -18
  45. package/esm2022/appbar/appbar-section.component.mjs +9 -13
  46. package/esm2022/appbar/appbar-spacer.component.mjs +13 -21
  47. package/esm2022/appbar/appbar.component.mjs +19 -25
  48. package/esm2022/appbar.module.mjs +5 -18
  49. package/esm2022/bottomnavigation/bottomnavigation.component.mjs +17 -31
  50. package/esm2022/bottomnavigation/events/select-event.mjs +5 -5
  51. package/esm2022/bottomnavigation/templates/item-template.directive.mjs +11 -3
  52. package/esm2022/bottomnavigation/types/bottomnavigation-theme-color.mjs +12 -12
  53. package/esm2022/bottomnavigation.module.mjs +6 -18
  54. package/esm2022/breadcrumb/breadcrumb.component.mjs +14 -19
  55. package/esm2022/breadcrumb/template-directives/item-template.directive.mjs +12 -1
  56. package/esm2022/breadcrumb.module.mjs +6 -18
  57. package/esm2022/directives.mjs +94 -5
  58. package/esm2022/navigation.module.mjs +6 -18
  59. package/esm2022/package-metadata.mjs +2 -2
  60. package/fesm2022/progress-kendo-angular-navigation.mjs +297 -240
  61. package/navigation.module.d.ts +6 -18
  62. package/package.json +7 -7
@@ -6,34 +6,22 @@ import * as i0 from "@angular/core";
6
6
  import * as i1 from "./breadcrumb/breadcrumb.component";
7
7
  import * as i2 from "./breadcrumb/template-directives/item-template.directive";
8
8
  /**
9
- * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi'])
9
+ * Represents the [`NgModule`](link:site.data.urls.angular['ngmoduleapi'])
10
10
  * definition for the BreadCrumb component.
11
- * @example
12
11
  *
13
- * ```ts-no-run
14
- * // Import the BreadCrumb module
12
+ * @example
13
+ * ```typescript
15
14
  * import { BreadCrumbModule } from '@progress/kendo-angular-navigation';
16
- *
17
- * // The browser platform with a compiler
18
- * import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
19
15
  * import { BrowserModule } from '@angular/platform-browser';
20
- *
21
16
  * import { NgModule } from '@angular/core';
22
- *
23
- * // Import the app component
24
17
  * import { AppComponent } from './app.component';
25
18
  *
26
- * // Define the app module
27
- * _@NgModule({
28
- * declarations: [AppComponent], // declare app component
29
- * imports: [BrowserModule, BreadCrumbModule], // import BreadCrumb module
19
+ * @NgModule({
20
+ * declarations: [AppComponent],
21
+ * imports: [BrowserModule, BreadCrumbModule],
30
22
  * bootstrap: [AppComponent]
31
23
  * })
32
24
  * export class AppModule {}
33
- *
34
- * // Compile and launch the module
35
- * platformBrowserDynamic().bootstrapModule(AppModule);
36
- *
37
25
  * ```
38
26
  */
39
27
  export declare class BreadCrumbModule {
package/directives.d.ts CHANGED
@@ -13,22 +13,111 @@ import { BottomNavigationItemTemplateDirective } from "./bottomnavigation/templa
13
13
  import { BreadCrumbComponent } from "./breadcrumb/breadcrumb.component";
14
14
  import { BreadCrumbItemTemplateDirective } from "./breadcrumb/template-directives/item-template.directive";
15
15
  /**
16
- * Utility array that contains all `ActionSheet` related components and directives.
16
+ * Use this utility array to access all ActionSheet-related components and directives in a standalone Angular component.
17
+ *
18
+ * @example
19
+ * ```typescript
20
+ * import { Component } from '@angular/core';
21
+ * import { KENDO_ACTIONSHEET } from '@progress/kendo-angular-navigation';
22
+ *
23
+ * @Component({
24
+ * selector: 'my-app',
25
+ * standalone: true,
26
+ * imports: [KENDO_ACTIONSHEET],
27
+ * template: `
28
+ * <kendo-actionsheet [items]="items">
29
+ * </kendo-actionsheet>
30
+ * `
31
+ * })
32
+ * export class AppComponent {}
33
+ * ```
17
34
  */
18
35
  export declare const KENDO_ACTIONSHEET: readonly [typeof ActionSheetComponent, typeof ActionSheetViewComponent, typeof ActionSheetHeaderTemplateDirective, typeof ActionSheetItemTemplateDirective, typeof ActionSheetContentTemplateDirective, typeof ActionSheetFooterTemplateDirective, typeof ActionSheetTemplateDirective];
19
36
  /**
20
- * Utility array that contains all `AppBar` related components and directives.
37
+ * Use this utility array to access all AppBar-related components and directives in a standalone Angular component.
38
+ *
39
+ * @example
40
+ * ```typescript
41
+ * import { Component } from '@angular/core';
42
+ * import { KENDO_APPBAR } from '@progress/kendo-angular-navigation';
43
+ *
44
+ * @Component({
45
+ * selector: 'my-app',
46
+ * standalone: true,
47
+ * imports: [KENDO_APPBAR],
48
+ * template: `
49
+ * <kendo-appbar>
50
+ * <!-- AppBar content -->
51
+ * </kendo-appbar>
52
+ * `
53
+ * })
54
+ * export class AppComponent {}
55
+ * ```
21
56
  */
22
57
  export declare const KENDO_APPBAR: readonly [typeof AppBarComponent, typeof AppBarSectionComponent, typeof AppBarSpacerComponent];
23
58
  /**
24
- * Utility array that contains all `BottomNavigation` related components and directives.
59
+ * Use this utility array to access all BottomNavigation-related components and directives in a standalone Angular component.
60
+ *
61
+ * @example
62
+ * ```typescript
63
+ * import { Component } from '@angular/core';
64
+ * import { KENDO_BOTTOMNAVIGATION } from '@progress/kendo-angular-navigation';
65
+ *
66
+ * @Component({
67
+ * selector: 'my-app',
68
+ * standalone: true,
69
+ * imports: [KENDO_BOTTOMNAVIGATION],
70
+ * template: `
71
+ * <kendo-bottomnavigation [items]="items">
72
+ * </kendo-bottomnavigation>
73
+ * `
74
+ * })
75
+ * export class AppComponent {}
76
+ * ```
25
77
  */
26
78
  export declare const KENDO_BOTTOMNAVIGATION: readonly [typeof BottomNavigationComponent, typeof BottomNavigationItemTemplateDirective];
27
79
  /**
28
- * Utility array that contains all `BreadCrumb` related components and directives.
80
+ * Use this utility array to access all BreadCrumb-related components and directives in a standalone Angular component.
81
+ *
82
+ * @example
83
+ * ```typescript
84
+ * import { Component } from '@angular/core';
85
+ * import { KENDO_BREADCRUMB } from '@progress/kendo-angular-navigation';
86
+ *
87
+ * @Component({
88
+ * selector: 'my-app',
89
+ * standalone: true,
90
+ * imports: [KENDO_BREADCRUMB],
91
+ * template: `
92
+ * <kendo-breadcrumb [items]="items">
93
+ * </kendo-breadcrumb>
94
+ * `
95
+ * })
96
+ * export class AppComponent {}
97
+ * ```
29
98
  */
30
99
  export declare const KENDO_BREADCRUMB: readonly [typeof BreadCrumbComponent, typeof BreadCrumbItemTemplateDirective];
31
100
  /**
32
- * Utility array that contains all `@progress/kendo-angular-navigation` related components and directives.
101
+ * Use this utility array to access all `@progress/kendo-angular-navigation`-related components and directives in a standalone Angular component.
102
+ *
103
+ * @example
104
+ * ```typescript
105
+ * import { Component } from '@angular/core';
106
+ * import { KENDO_NAVIGATION } from '@progress/kendo-angular-navigation';
107
+ *
108
+ * @Component({
109
+ * selector: 'my-app',
110
+ * standalone: true,
111
+ * imports: [KENDO_NAVIGATION],
112
+ * template: `
113
+ * <kendo-appbar>
114
+ * <!-- AppBar content -->
115
+ * </kendo-appbar>
116
+ * <kendo-breadcrumb [items]="breadcrumbItems">
117
+ * </kendo-breadcrumb>
118
+ * `
119
+ * })
120
+ * export class AppComponent {}
121
+ * ```
33
122
  */
34
123
  export declare const KENDO_NAVIGATION: readonly [typeof ActionSheetComponent, typeof ActionSheetViewComponent, typeof ActionSheetHeaderTemplateDirective, typeof ActionSheetItemTemplateDirective, typeof ActionSheetContentTemplateDirective, typeof ActionSheetFooterTemplateDirective, typeof ActionSheetTemplateDirective, typeof AppBarComponent, typeof AppBarSectionComponent, typeof AppBarSpacerComponent, typeof BottomNavigationComponent, typeof BottomNavigationItemTemplateDirective, typeof BreadCrumbComponent, typeof BreadCrumbItemTemplateDirective];
@@ -23,7 +23,13 @@ import * as i2 from "@angular/animations";
23
23
  const DEFAULT_ANIMATION_CONFIG = { duration: 300 };
24
24
  /**
25
25
  * Represents the [Kendo UI ActionSheet component for Angular](slug:overview_actionsheet).
26
- * Used to display a set of choices related to a task the user initiates.
26
+ * Use this component to display a set of choices related to a user-initiated task in a modal sheet that slides up from the bottom of the screen.
27
+ *
28
+ * @example
29
+ * ```html
30
+ * <kendo-actionsheet [items]="actionItems" [expanded]="true">
31
+ * </kendo-actionsheet>
32
+ * ```
27
33
  */
28
34
  export class ActionSheetComponent {
29
35
  element;
@@ -47,54 +53,50 @@ export class ActionSheetComponent {
47
53
  */
48
54
  direction;
49
55
  /**
50
- * Specifies the ActionSheet action buttons.
56
+ * Specifies the action buttons displayed in the ActionSheet footer.
51
57
  */
52
58
  actions;
53
59
  /**
54
- * Specifies the layout of the action buttons.
55
- * By default, the action buttons are rendered horizontally and stretched.
60
+ * Configures the layout of the action buttons in the footer. By default, actions are arranged horizontally and stretched to fill the container.
56
61
  */
57
62
  actionsLayout = {
58
63
  orientation: 'horizontal',
59
64
  alignment: 'stretched'
60
65
  };
61
66
  /**
62
- * Specifies if the ActionSheet is closed on overlay click.
67
+ * Determines whether the ActionSheet closes when the overlay is clicked.
63
68
  *
64
69
  * @default false
65
70
  */
66
71
  overlayClickClose = false;
67
72
  /**
68
- * Specifies the text that is rendered as title.
73
+ * Sets the title text displayed in the ActionSheet header.
69
74
  */
70
75
  title;
71
76
  /**
72
- * Specifies the text that is rendered under the title.
77
+ * Sets the subtitle text displayed below the title in the header.
73
78
  */
74
79
  subtitle;
75
80
  /**
76
- * The collection of items that will be rendered in the ActionSheet.
81
+ * Provides the collection of items rendered in the ActionSheet content area.
77
82
  */
78
83
  items;
79
84
  /**
80
- * The CSS classes that will be rendered on the inner ActionSheet element.
81
- * Supports the type of values that are supported by [ngClass](link:site.data.urls.angular['ngclassapi']).
85
+ * Applies CSS classes to the inner ActionSheet element. Accepts any value supported by [`ngClass`](link:site.data.urls.angular['ngclassapi']).
82
86
  */
83
87
  cssClass;
84
88
  /**
85
- * The inline styles that will be rendered on the inner ActionSheet element.
86
- * Supports the type of values that are supported by [ngStyle](link:site.data.urls.angular['ngstyleapi']).
89
+ * Applies inline styles to the inner ActionSheet element. Accepts any value supported by [`ngStyle`](link:site.data.urls.angular['ngstyleapi']).
87
90
  */
88
91
  cssStyle;
89
92
  /**
90
- * Configures the ActionSheet opening and closing animations ([see example](slug:animations_actionsheet)).
91
- * By default, the animations are turned off. The default animations' duration is `300ms`.
93
+ * Configures the opening and closing animations for the ActionSheet ([see example](slug:animations_actionsheet)).
92
94
  *
93
95
  * @default true
94
96
  */
95
97
  animation = true;
96
98
  /**
97
- * Specifies the state of the ActionSheet.
99
+ * Controls whether the ActionSheet is expanded or collapsed.
98
100
  *
99
101
  * @default false
100
102
  */
@@ -103,7 +105,6 @@ export class ActionSheetComponent {
103
105
  * Sets the `aria-labelledby` attribute of the ActionSheet wrapper element.
104
106
  * Use this option when the built-in header element is replaced through the [`ActionSheetHeaderTemplate`](slug:api_navigation_actionsheetheadertemplatedirective)
105
107
  * or [`ActionSheetContentTemplate`](slug:api_navigation_actionsheetcontenttemplatedirective).
106
- *
107
108
  */
108
109
  titleId = getId('k-actionsheet-title');
109
110
  /**
@@ -114,7 +115,7 @@ export class ActionSheetComponent {
114
115
  initialFocus = true;
115
116
  /**
116
117
  * Fires when the `expanded` property of the component is updated.
117
- * Used to provide a two-way binding for the `expanded` property.
118
+ * You can use this event to provide two-way binding for the `expanded` property.
118
119
  */
119
120
  expandedChange = new EventEmitter();
120
121
  /**
@@ -3,15 +3,17 @@
3
3
  * Licensed under commercial license. See LICENSE.md in the project root for more information
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  /**
6
- * Arguments for the `itemClick` event of the ActionSheet.
6
+ * Provides the event data for the `itemClick` event of the ActionSheet component.
7
+ *
8
+ * Use this event to access the clicked item and the original DOM event.
7
9
  */
8
10
  export class ActionSheetItemClickEvent {
9
11
  /**
10
- * The ActionSheet item that was clicked.
12
+ * Provides the ActionSheet item that was clicked.
11
13
  */
12
14
  item;
13
15
  /**
14
- * The DOM event that triggered the `itemClick` event.
16
+ * Represents the original DOM event that triggered the `itemClick` event.
15
17
  */
16
18
  originalEvent;
17
19
  }
@@ -5,9 +5,18 @@
5
5
  import { Directive, Optional, TemplateRef } from '@angular/core';
6
6
  import * as i0 from "@angular/core";
7
7
  /**
8
- * Represents a template that defines the content of the ActionSheet.
8
+ * Represents a template for customizing the overall content of the ActionSheet.
9
9
  * To define the template, nest an `<ng-template>` tag
10
10
  * with the `kendoActionSheetTemplate` directive inside the `<kendo-actionsheet>` tag.
11
+ *
12
+ * @example
13
+ * ```html
14
+ * <kendo-actionsheet>
15
+ * <ng-template kendoActionSheetTemplate>
16
+ * <div>Custom ActionSheet content</div>
17
+ * </ng-template>
18
+ * </kendo-actionsheet>
19
+ * ```
11
20
  */
12
21
  export class ActionSheetTemplateDirective {
13
22
  templateRef;
@@ -5,9 +5,18 @@
5
5
  import { Directive, Optional, TemplateRef } from '@angular/core';
6
6
  import * as i0 from "@angular/core";
7
7
  /**
8
- * Represents a template that defines the items list content of the ActionSheet.
8
+ * Represents a template for customizing the list content of the ActionSheet items.
9
9
  * To define the template, nest an `<ng-template>` tag
10
10
  * with the `kendoActionSheetContentTemplate` directive inside the `<kendo-actionsheet>` tag.
11
+ *
12
+ * @example
13
+ * ```html
14
+ * <kendo-actionsheet [items]="items">
15
+ * <ng-template kendoActionSheetContentTemplate>
16
+ * <div>Custom content here</div>
17
+ * </ng-template>
18
+ * </kendo-actionsheet>
19
+ * ```
11
20
  */
12
21
  export class ActionSheetContentTemplateDirective {
13
22
  templateRef;
@@ -5,9 +5,18 @@
5
5
  import { Directive, Optional, TemplateRef } from '@angular/core';
6
6
  import * as i0 from "@angular/core";
7
7
  /**
8
- * Represents a template that defines the footer of the ActionSheet.
8
+ * Represents a template for customizing the footer of the ActionSheet.
9
9
  * To define the template, nest an `<ng-template>` tag
10
10
  * with the `kendoActionSheetFooterTemplate` directive inside the `<kendo-actionsheet>` tag.
11
+ *
12
+ * @example
13
+ * ```html
14
+ * <kendo-actionsheet>
15
+ * <ng-template kendoActionSheetFooterTemplate>
16
+ * <button kendoButton>Custom Footer Button</button>
17
+ * </ng-template>
18
+ * </kendo-actionsheet>
19
+ * ```
11
20
  */
12
21
  export class ActionSheetFooterTemplateDirective {
13
22
  templateRef;
@@ -5,9 +5,18 @@
5
5
  import { Directive, Optional, TemplateRef } from '@angular/core';
6
6
  import * as i0 from "@angular/core";
7
7
  /**
8
- * Represents a template that defines the header content of the ActionSheet. Utilizing the template overrides both the `title` and `subtitle` of the ActionSheet.
8
+ * Represents a template for customizing the header content of the ActionSheet. If you implement this template, it will override the `title` and `subtitle` of the ActionSheet.
9
9
  * To define the template, nest an `<ng-template>` tag
10
10
  * with the `kendoActionSheetHeaderTemplate` directive inside the `<kendo-actionsheet>` tag.
11
+ *
12
+ * @example
13
+ * ```html
14
+ * <kendo-actionsheet>
15
+ * <ng-template kendoActionSheetHeaderTemplate>
16
+ * <h3>Custom Header</h3>
17
+ * </ng-template>
18
+ * </kendo-actionsheet>
19
+ * ```
11
20
  */
12
21
  export class ActionSheetHeaderTemplateDirective {
13
22
  templateRef;
@@ -5,9 +5,18 @@
5
5
  import { Directive, Optional, TemplateRef } from '@angular/core';
6
6
  import * as i0 from "@angular/core";
7
7
  /**
8
- * Represents a template that defines the item content of the ActionSheet.
8
+ * Represents a template for customizing the content of each ActionSheet item.
9
9
  * To define the template, nest an `<ng-template>` tag
10
10
  * with the `kendoActionSheetItemTemplate` directive inside the `<kendo-actionsheet>` tag.
11
+ *
12
+ * @example
13
+ * ```html
14
+ * <kendo-actionsheet [items]="items">
15
+ * <ng-template kendoActionSheetItemTemplate let-item>
16
+ * <span>{{ item.title }} (custom)</span>
17
+ * </ng-template>
18
+ * </kendo-actionsheet>
19
+ * ```
11
20
  */
12
21
  export class ActionSheetItemTemplateDirective {
13
22
  templateRef;
@@ -15,35 +15,22 @@ import * as i6 from "./actionsheet/templates/footer-template.directive";
15
15
  import * as i7 from "./actionsheet/templates/actionsheet-template";
16
16
  // IMPORTANT: NgModule export kept for backwards compatibility
17
17
  /**
18
- * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi'])
18
+ * Represents the [`NgModule`](link:site.data.urls.angular['ngmoduleapi'])
19
19
  * definition for the ActionSheet component.
20
20
  *
21
21
  * @example
22
- *
23
- * ```ts-no-run
24
- * // Import the ActionSheet module
22
+ * ```typescript
25
23
  * import { ActionSheetModule } from '@progress/kendo-angular-navigation';
26
- *
27
- * // The browser platform with a compiler
28
- * import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
29
24
  * import { BrowserModule } from '@angular/platform-browser';
30
- *
31
25
  * import { NgModule } from '@angular/core';
32
- *
33
- * // Import the app component
34
26
  * import { AppComponent } from './app.component';
35
27
  *
36
- * // Define the app module
37
- * _@NgModule({
38
- * declarations: [AppComponent], // declare app component
39
- * imports: [BrowserModule, ActionSheetModule], // import ActionSheet module
28
+ * @NgModule({
29
+ * declarations: [AppComponent],
30
+ * imports: [BrowserModule, ActionSheetModule],
40
31
  * bootstrap: [AppComponent]
41
32
  * })
42
33
  * export class AppModule {}
43
- *
44
- * // Compile and launch the module
45
- * platformBrowserDynamic().bootstrapModule(AppModule);
46
- *
47
34
  * ```
48
35
  */
49
36
  export class ActionSheetModule {
@@ -7,20 +7,16 @@ import * as i0 from "@angular/core";
7
7
  /**
8
8
  * Represents the [Kendo UI AppBarSection component for Angular]({% slug contentarrangement_appbar %}#toc-sections).
9
9
  *
10
- * @example
10
+ * Use the AppBarSection component to group content, actions, or navigation items within the AppBar.
11
11
  *
12
- * ```ts-no-run
13
- * * _@Component({
14
- * selector: 'my-app',
15
- * template: `
16
- * <kendo-appbar>
17
- * <kendo-appbar-section>
18
- * <h2>Page Title</h2>
19
- * </kendo-appbar-section>
20
- * </kendo-appbar>
21
- * `
22
- * })
23
- * class AppComponent {}
12
+ * @example
13
+ * ```html
14
+ * <kendo-appbar>
15
+ * <kendo-appbar-section>
16
+ * <h2>Page Title</h2>
17
+ * </kendo-appbar-section>
18
+ * </kendo-appbar>
19
+ * ```
24
20
  */
25
21
  export class AppBarSectionComponent {
26
22
  hostClass = true;
@@ -7,30 +7,22 @@ import { isPresent } from '../common/util';
7
7
  import * as i0 from "@angular/core";
8
8
  /**
9
9
  * Represents the [Kendo UI AppBarSpacer component for Angular]({% slug contentarrangement_appbar %}#toc-spacings).
10
- * Used to give additional white space between the AppBar sections and provides a way for customizing its width.
11
10
  *
12
- * @example
11
+ * Use the AppBarSpacer component to add white space between AppBar sections and customize its width.
13
12
  *
14
- * ```ts-no-run
15
- * * _@Component({
16
- * selector: 'my-app',
17
- * template: `
18
- * <kendo-appbar>
19
- * <kendo-appbar-section>
20
- * <button kendoButton fillMode="flat">
21
- * <kendo-icon name="menu"></kendo-icon>
22
- * </button>
23
- * </kendo-appbar-section>
13
+ * @example
14
+ * ```html
15
+ * <kendo-appbar>
16
+ * <kendo-appbar-section>
17
+ * <button kendoButton fillMode="flat" [svgIcon]="menuIcon"></button>
18
+ * </kendo-appbar-section>
24
19
  *
25
- * <kendo-appbar-spacer></kendo-appbar-spacer>
20
+ * <kendo-appbar-spacer></kendo-appbar-spacer>
26
21
  *
27
- * <kendo-appbar-section>
28
- * <h2>Page Title</h2>
29
- * </kendo-appbar-section>
30
- * </kendo-appbar>
31
- * `
32
- * })
33
- * class AppComponent {}
22
+ * <kendo-appbar-section>
23
+ * <h2>Page Title</h2>
24
+ * </kendo-appbar-section>
25
+ * </kendo-appbar>
34
26
  * ```
35
27
  */
36
28
  export class AppBarSpacerComponent {
@@ -43,7 +35,7 @@ export class AppBarSpacerComponent {
43
35
  /**
44
36
  * Specifies the width of the AppBarSpacer.
45
37
  *
46
- * If not set, the AppBarSpacer will take all the available space.
38
+ * If not set, the AppBarSpacer will take all of the available space.
47
39
  */
48
40
  width;
49
41
  constructor(renderer, element) {
@@ -13,7 +13,20 @@ const DEFAULT_POSITION = 'top';
13
13
  const DEFAULT_POSITION_MODE = 'static';
14
14
  /**
15
15
  * Represents the [Kendo UI AppBar component for Angular]({% slug overview_appbar %}).
16
- * Used to display information, actions, branding titles and additional navigation on the current screen.
16
+ *
17
+ * Use the AppBar component to display information, actions, brand titles, and additional navigation on the current screen.
18
+ *
19
+ * @example
20
+ * ```html
21
+ * <kendo-appbar>
22
+ * <kendo-appbar-section>
23
+ * <h2>Page Title</h2>
24
+ * </kendo-appbar-section>
25
+ * </kendo-appbar>
26
+ * ```
27
+ *
28
+ * @remarks
29
+ * Supported children components are: {@link AppBarSectionComponent}, {@link AppBarSpacerComponent}
17
30
  */
18
31
  export class AppBarComponent {
19
32
  localizationService;
@@ -28,15 +41,7 @@ export class AppBarComponent {
28
41
  * Specifies the position of the AppBar
29
42
  * ([see example]({% slug positioning_appbar %}#toc-position)).
30
43
  *
31
- * * The possible values are:
32
- * * `top` (Default)&mdash;Positions the AppBar at the top of the content.
33
- * Setting the `position` property to `top` requires adding the Appbar component before the page content.
34
- * The position property applies CSS `top: 0` style in [`fixed mode`](slug:api_navigation_appbarcomponent#toc-positionmode) and also adds a `box-shadow` to the bottom of the AppBar.
35
- *
36
- * * `bottom`&mdash;Positions the AppBar at the bottom of the content.
37
- * Setting the `position` property to `bottom` requires adding the Appbar component after the page content.
38
- * The position property applies CSS `bottom: 0` style in [`fixed mode`](slug:api_navigation_appbarcomponent#toc-positionmode) and also adds a `box-shadow ` to the top of the AppBar.
39
- *
44
+ * @default 'top'
40
45
  */
41
46
  set position(position) {
42
47
  const newPosition = position ? position : DEFAULT_POSITION;
@@ -47,13 +52,9 @@ export class AppBarComponent {
47
52
  return this._position;
48
53
  }
49
54
  /**
50
- * Specifies the positionMode of the AppBar
51
- * ([see example](slug:positioning_appbar#toc-position-mode)).
55
+ * Sets the position mode of the AppBar ([see example](slug:positioning_appbar#toc-position-mode)).
52
56
  *
53
- * * The possible values are:
54
- * * `static` (Default)&mdash;Does not position the AppBar in any special way. It is positioned according to the normal flow of the page.
55
- * * `sticky`&mdash;Positions the AppBar based on the user's scroll position. A sticky element toggles between static and fixed CSS [`position`](https://developer.mozilla.org/en-US/docs/Web/CSS/position) property, depending on the scroll position.
56
- * * `fixed`&mdash;Positions the AppBar relative to the viewport. It always stays in the same place even if the page is scrolled.
57
+ * @default 'static'
57
58
  */
58
59
  set positionMode(positionMode) {
59
60
  const newPositionMode = positionMode ? positionMode : DEFAULT_POSITION_MODE;
@@ -64,16 +65,9 @@ export class AppBarComponent {
64
65
  return this._positionMode;
65
66
  }
66
67
  /**
67
- * Specifies the theme color of the AppBar.
68
- * The theme color will be applied as background color of the component.
69
- *
70
- *
71
- * * The possible values are:
72
- * * `light` (Default)&mdash;Applies coloring based on light theme color.
73
- * * `dark`&mdash;Applies coloring based on dark theme color.
74
- * * `inherit`&mdash; Applies inherited coloring value.
75
- * * `primary`&mdash; Applies primary coloring value.
68
+ * Sets the theme color of the AppBar. The theme color is applied as the background color of the component.
76
69
  *
70
+ * @default 'light'
77
71
  */
78
72
  set themeColor(themeColor) {
79
73
  const newThemeColor = themeColor ? themeColor : DEFAULT_THEME_COLOR;
@@ -10,35 +10,22 @@ import * as i2 from "./appbar/appbar-section.component";
10
10
  import * as i3 from "./appbar/appbar-spacer.component";
11
11
  // IMPORTANT: NgModule export kept for backwards compatibility
12
12
  /**
13
- * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi'])
13
+ * Represents the [`NgModule`](link:site.data.urls.angular['ngmoduleapi'])
14
14
  * definition for the AppBar component.
15
15
  *
16
16
  * @example
17
- *
18
- * ```ts-no-run
19
- * // Import the AppBar module
17
+ * ```typescript
20
18
  * import { AppBarModule } from '@progress/kendo-angular-navigation';
21
- *
22
- * // The browser platform with a compiler
23
- * import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
24
19
  * import { BrowserModule } from '@angular/platform-browser';
25
- *
26
20
  * import { NgModule } from '@angular/core';
27
- *
28
- * // Import the app component
29
21
  * import { AppComponent } from './app.component';
30
22
  *
31
- * // Define the app module
32
- * _@NgModule({
33
- * declarations: [AppComponent], // declare app component
34
- * imports: [BrowserModule, AppBarModule], // import AppBar module
23
+ * @NgModule({
24
+ * declarations: [AppComponent],
25
+ * imports: [BrowserModule, AppBarModule],
35
26
  * bootstrap: [AppComponent]
36
27
  * })
37
28
  * export class AppModule {}
38
- *
39
- * // Compile and launch the module
40
- * platformBrowserDynamic().bootstrapModule(AppModule);
41
- *
42
29
  * ```
43
30
  */
44
31
  export class AppBarModule {