mtrl 0.8.0-next.32 → 0.8.0-next.34

package/dist/components/sheet/sheet.d.ts

@@ -1,6 +1,18 @@
 import { SheetConfig } from "./types";
 /**
  * Creates a new Sheet component
+ *
+ * @deprecated Since 0.8.0. Use {@link createBottomSheet} for a sheet anchored
+ * to the bottom edge, or {@link createSideSheet} for one docked to a vertical
+ * edge. Those follow the M3 bottom sheet and side sheet specifications, which
+ * this component predates and does not match.
+ *
+ * This component is also broken: `open()`, `close()` and the drag gestures
+ * call `component.events.emit(...)`, but it composes the event feature that
+ * provides `emit` directly and no `events` object, so every one of them
+ * throws. Its scrim is never inserted into the page either. It is kept only so
+ * that existing imports keep resolving, and it will be removed.
+ *
  * @param {SheetConfig} config - Sheet configuration object
  * @returns {SheetComponent} Sheet component instance
  */

package/dist/components/sheet/types.d.ts

@@ -24,6 +24,10 @@ export declare const SHEET_EVENTS: {
     readonly DRAG_START: "dragstart";
     readonly DRAG_END: "dragend";
 };
+/**
+ * @deprecated Since 0.8.0. Use BottomSheetConfig or SideSheetConfig.
+ * The sheet component this belongs to does not open: see createSheet.
+ */
 /**
  * Configuration interface for the Sheet component
  * @category Components
@@ -146,6 +150,10 @@ export interface TitleAPI {
      */
     getElement: () => HTMLElement | null;
 }
+/**
+ * @deprecated Since 0.8.0. Use BottomSheetComponent or SideSheetComponent.
+ * The sheet component this belongs to does not open: see createSheet.
+ */
 /**
  * Sheet component interface
  * @category Components