presenter 0.6.1 → 0.6.2

package/dist/renderer/browser-canvas/types/BrowserCanvasRendererState.d.ts

@@ -2,6 +2,8 @@ import { ShortcutState } from "../../../types/ShortcutState";
 import { UnifiedImage } from "./UnifiedImage";
 export interface BrowserCanvasRendererState {
     canvas: HTMLCanvasElement | null;
+    extrasContainer: SVGSVGElement | null;
+    mountedExtrasCleanups: (() => void)[];
     /** The index of the currently displayed slide. */
     slideIndex: number;
     /** The index of the current build within the current slide.

package/dist/renderer/browser-canvas/utils/extras/createExtrasElement.d.ts

@@ -0,0 +1,6 @@
+import { Size } from "../../../../types/Size";
+/**
+ * Extra elements are treated as foreignObjects in an SVG container element.
+ * This function creates the extras container SVG element to host the slide extras.
+ */
+export declare function createExtrasElement(size: Size): SVGSVGElement;

package/dist/renderer/browser-canvas/utils/extras/mountWebExtra.d.ts

@@ -0,0 +1,2 @@
+import { SlideWebExtra } from "../../../../types/SlideWebExtra";
+export declare function mountWebExtra(container: SVGSVGElement | null, extra: SlideWebExtra): (() => void) | null;

package/dist/types/Color.d.ts

@@ -8,8 +8,7 @@ export interface Color {
     /** Alpha channel, in [0, 1] */
     alpha: number;
 }
-type HexColor = `#${string}`;
-export declare function Color(color: Partial<Color> | HexColor): Color;
+export declare function Color(color: Partial<Color> | string): Color;
 export declare function Color(red: number, green: number, blue: number, alpha?: number): Color;
 export declare namespace Color {
     var BLACK: Color;
@@ -20,4 +19,3 @@ export declare namespace Color {
     var WHITE: Color;
 }
 export declare const DEFAULT_COLOR: Color;
-export {};

package/dist/types/Slide.d.ts

@@ -1,8 +1,10 @@
 import { SlideAnimation } from "./SlideAnimation";
 import { SlideObject } from "./SlideObject";
+import { SlideWebExtra } from "./SlideWebExtra";
 export interface Slide {
     readonly objects: SlideObject[];
     readonly animations: SlideAnimation[];
+    readonly extras: SlideWebExtra[];
     readonly isAllKey: boolean;
     readonly isEndKey: boolean;
     readonly isStartKey: boolean;

package/dist/types/SlideWebExtra.d.ts

@@ -0,0 +1,23 @@
+import { Anchor } from "./Anchor";
+/**
+ * A "Web Extra" is additional HTML/JavaScript content added to a slide. This
+ * allows embedded arbitrary web content on a slide. This content is not part of
+ * the core slide content, and will not be produced by non-web renderers like
+ * PDF/image renderers, but can be used to enhance web-based presentations.
+ */
+export interface SlideWebExtra {
+    /** HTML element that will be added to the presentation. */
+    readonly content: HTMLElement | null;
+    /**
+     * Setup function that will be called when the extra is mounted.
+     * It can optionally return a cleanup function that will be called
+     * when the extra is unmounted.
+     */
+    readonly setup: ((foreignObject: SVGForeignObjectElement) => void | (() => void)) | null;
+    readonly anchor: Anchor;
+    readonly height: number;
+    readonly width: number;
+    readonly x: number;
+    readonly y: number;
+}
+export declare function SlideWebExtra(props?: Partial<SlideWebExtra> | null): SlideWebExtra;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "presenter",
-  "version": "0.6.1",
+  "version": "0.6.2",
   "description": "A JavaScript presentation library",
   "main": "dist/presenter.js",
   "types": "dist/index.d.ts",