chore(demo): deprecated sheet (#5760)

taiga-family · Oct 30, 2023 · 6ea4134 · 6ea4134
1 parent 0fcfa19
commit 6ea4134
Show file tree

Hide file tree

Showing 6 changed files with 26 additions and 0 deletions.
diff --git a/projects/addon-mobile/components/sheet/sheet-options.ts b/projects/addon-mobile/components/sheet/sheet-options.ts
@@ -3,6 +3,9 @@ import {PolymorpheusContent} from '@tinkoff/ng-polymorpheus';
 
 import {TuiSheet} from './sheet';
 
+/**
+ * @deprecated: drop in v4.0
+ */
 export interface TuiSheetOptions<I = undefined, O = unknown> {
     readonly closeable: boolean;
     readonly data: I;
@@ -14,6 +17,9 @@ export interface TuiSheetOptions<I = undefined, O = unknown> {
     readonly stops: readonly string[];
 }
 
+/**
+ * @deprecated: drop in v4.0
+ */
 export const TUI_SHEET_DEFAULT_OPTIONS: Omit<TuiSheetOptions, 'data'> = {
     image: ``,
     imageSlide: true,
@@ -25,6 +31,7 @@ export const TUI_SHEET_DEFAULT_OPTIONS: Omit<TuiSheetOptions, 'data'> = {
 };
 
 /**
+ * @deprecated: drop in v4.0
  * Default parameters for sheet component
  */
 export const TUI_SHEET_OPTIONS = tuiCreateToken<Omit<TuiSheetOptions, 'data'>>({

diff --git a/projects/addon-mobile/components/sheet/sheet.directive.ts b/projects/addon-mobile/components/sheet/sheet.directive.ts
@@ -15,6 +15,10 @@ import {TuiSheet} from './sheet';
 import {TuiSheetService} from './sheet.service';
 import {TuiSheetOptions} from './sheet-options';
 
+/**
+ * @deprecated: use {@link TuiSheetDialogDirective}
+ * drop in v4.0
+ */
 @Directive({
     selector: 'ng-template[tuiSheet]',
 })

diff --git a/projects/addon-mobile/components/sheet/sheet.module.ts b/projects/addon-mobile/components/sheet/sheet.module.ts
@@ -14,6 +14,10 @@ import {TuiSheetTopDirective} from './directives/sheet-top/sheet-top.directive';
 import {TuiSheetWrapperDirective} from './directives/sheet-wrapper/sheet-wrapper.directive';
 import {TuiSheetDirective} from './sheet.directive';
 
+/**
+ * @deprecated: use {@link TuiSheetDialogModule}
+ * drop in v4.0
+ */
 @NgModule({
     imports: [
         CommonModule,

diff --git a/projects/addon-mobile/components/sheet/sheet.service.ts b/projects/addon-mobile/components/sheet/sheet.service.ts
@@ -7,6 +7,10 @@ import {BehaviorSubject, EMPTY, Observable} from 'rxjs';
 import {TuiSheet} from './sheet';
 import {TUI_SHEET_OPTIONS, TuiSheetOptions} from './sheet-options';
 
+/**
+ * @deprecated: use {@link TuiSheetDialogService}
+ * drop in v4.0
+ */
 @Injectable({
     providedIn: `root`,
 })

diff --git a/projects/addon-mobile/components/sheet/sheet.ts b/projects/addon-mobile/components/sheet/sheet.ts
@@ -4,6 +4,9 @@ import {Observable, Observer} from 'rxjs';
 
 import type {TuiSheetOptions} from './sheet-options';
 
+/**
+ * @deprecated: drop in v4.0
+ */
 export interface TuiSheet<O, I = undefined>
     extends TuiSheetOptions<I, O>,
         TuiContextWithImplicit<Observer<O>> {
@@ -12,6 +15,9 @@ export interface TuiSheet<O, I = undefined>
     readonly scroll$: Observable<number>;
 }
 
+/**
+ * @deprecated: drop in v4.0
+ */
 export interface TuiSheetRequiredProps<T = unknown> {
     item: TuiSheet<T>;
     stops: readonly number[];

diff --git a/projects/demo/src/modules/components/sheet/sheet.template.html b/projects/demo/src/modules/components/sheet/sheet.template.html
@@ -1,4 +1,5 @@
 <tui-doc-page
+    deprecated
     header="Sheet"
     package="ADDON-MOBILE"
     type="components"