Skip to content

Commit 309be00

Browse files
committed
Add deprecated comments
1 parent 624b513 commit 309be00

File tree

7 files changed

+31
-0
lines changed

7 files changed

+31
-0
lines changed

src/banner/banner-content.interface.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
/**
2+
* Deprecated in favour of `NotificationContent` (to be removed in v3.0).
3+
*
4+
* @deprecated
5+
*/
16
export interface BannerContent {
27
type: string;
38
title: string;

src/banner/banner.component.spec.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,11 @@ import { StaticIconModule } from "./../icon/static-icon.module";
55
import { Banner, BannerService } from "./banner.module";
66
import { I18nModule } from "../i18n/i18n.module";
77

8+
/**
9+
* Deprecated in favour of `Notification` (to be removed in v3.0).
10+
*
11+
* @deprecated
12+
*/
813

914
describe("Banner", () => {
1015
beforeEach(() => {

src/banner/banner.component.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,12 @@ import { NotificationContent } from "./banner-content.interface";
1313
import { I18n } from "./../i18n/i18n.module";
1414

1515
/**
16+
* Deprecated in favour of `InlineNotification` (to be removed in v3.0).
1617
* Banner messages are displayed toward the top of the UI and do not interrupt user’s work.
1718
*
1819
* @export
1920
* @class Banner
21+
* @deprecated
2022
*/
2123
@Component({
2224
selector: "ibm-banner",

src/banner/banner.module.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,11 @@ export { BannerService } from "./banner.service";
1212
export { Banner } from "./banner.component";
1313
export { Toast } from "./toast.component";
1414

15+
/**
16+
* Deprecated in favour of `NotificationModule` (to be removed in v3.0).
17+
*
18+
* @deprecated
19+
*/
1520
@NgModule({
1621
declarations: [
1722
Toast,

src/banner/banner.service.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,14 @@ import { BannerContent, NotificationContent, ToastContent } from "./banner-conte
1313
import { Banner, Toast } from "./banner.module";
1414

1515
/**
16+
* Deprecated in favour of `NotificationService` (to be removed in v3.0).
1617
* Provides a way to use the banner component.
1718
*
1819
* Banners are displayed toward the top of the UI and do not interrupt the user’s work.
1920
*
2021
* @export
2122
* @class BannerService
23+
* @deprecated
2224
*/
2325
@Injectable()
2426
export class BannerService implements OnDestroy {

src/banner/banner.stories.ts

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,11 @@ import { Component } from "@angular/core";
77

88
import { BannerModule, BannerService } from "./banner.module";
99

10+
/**
11+
* Deprecated in favour of `InlineNotificationStory` (to be removed in v3.0).
12+
*
13+
* @deprecated
14+
*/
1015
@Component({
1116
selector: "app-banner-story",
1217
template: `
@@ -28,6 +33,11 @@ class BannnerStory {
2833
}
2934
}
3035

36+
/**
37+
* Deprecated in favour of `ToastNotificationStory` (to be removed in v3.0).
38+
*
39+
* @deprecated
40+
*/
3141
@Component({
3242
selector: "app-toast-story",
3343
template: `

src/banner/toast.component.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,12 @@ import { ToastContent } from "./banner-content.interface";
55
import { Banner } from "./banner.component";
66

77
/**
8+
* Deprecated in favour of `ToastNotification` (to be removed in v3.0).
89
* Banner messages are displayed toward the top of the UI and do not interrupt user’s work.
910
*
1011
* @export
1112
* @class Banner
13+
* @deprecated
1214
*/
1315
@Component({
1416
selector: "ibm-toast",

0 commit comments

Comments
 (0)