presenter 0.1.1 → 0.2.2

package/dist/src/presentation/presentation.d.ts

@@ -0,0 +1,99 @@
+import { BoundingBox } from "../util/position";
+import { Slide } from "./slide";
+export interface PresentationOptions {
+    /**
+     * Width of the presentation.
+     */
+    width: number;
+    /**
+     * Height of the presentation.
+     */
+    height: number;
+    /**
+     * Slide color for the presentation.
+     */
+    backgroundColor: string;
+}
+interface PresentationState {
+    currentSlide: number;
+}
+export declare class Presentation {
+    /**
+     * Title of the presentation.
+     */
+    title: string;
+    /**
+     * Element where presentation should be mounted.
+     */
+    element: HTMLElement;
+    /**
+     * SVG container element.
+     */
+    container: HTMLElement;
+    /**
+     * Parent SVG element of presentation.
+     */
+    svg: SVGSVGElement | null;
+    /**
+     * Shadow SVG element, not displayed and used for calculating sizes.
+     */
+    shadow: SVGSVGElement | null;
+    /**
+     * Presentation settings.
+     */
+    options: PresentationOptions;
+    /**
+     * Bounds of presentation.
+     */
+    boundingBox: BoundingBox;
+    /**
+     * Presentation slides.
+     */
+    slides: Slide[];
+    /**
+     * Presentation state.
+     */
+    presentationState: PresentationState;
+    /**
+     *
+     * @param title Title of the presentation.
+     */
+    constructor(title: string, slides: Slide[], element: HTMLElement, options?: Partial<PresentationOptions>);
+    present(): void;
+    /**
+     * Sets up keyboard commands for the presentation.
+     */
+    setupKeyboardCommands(): void;
+    /**
+     * Updates the size of the parent SVG element.
+     *
+     * The size of the parent SVG element needs to be updated.
+     */
+    updateSVGContainerSize(): void;
+    /**
+     * Advances to next animation in slide, or next slide if there is no next animation.
+     * Returns true if we were able to successfully advance.
+     * @param includeIntermediateBuilds Determines whether to progress through builds.
+     */
+    next(includeIntermediateBuilds: boolean): boolean;
+    /**
+     * Goes back to the previous slide.
+     * @param includeIntermediateBuilds Determines whether to progress through builds.
+     */
+    previous(includeIntermediateBuilds: boolean): void;
+    /**
+     * Checks if the presentation takes the entire document body.
+     * @returns True if the presentation takes the entire document body.
+     */
+    isFullBodyPresentation(): boolean;
+    /**
+     * Computes the current size of an element in the DOM.
+     * Optionally accepts a custom list of children to see what the size of an
+     * element would be with different children.
+     * @param element Element to compute size of.
+     * @param children Custom children to use for element.
+     * @returns BoundingBox
+     */
+    computeRenderedBoundingBox(element: SVGGraphicsElement, children?: Node[] | null): BoundingBox;
+}
+export {};

package/dist/src/presentation/slide.d.ts

@@ -0,0 +1,23 @@
+import { BuildFunction } from "../util/animation";
+import { SlideObject } from "./object";
+import { Presentation } from "./presentation";
+export interface SlideProps {
+}
+export declare class Slide {
+    objects: SlideObject<any>[];
+    animations: BuildFunction[];
+    animationIndex: number;
+    /**
+     * Property for use during development/debugging only.
+     * Manually set this property to a build function index
+     * to debug a specific animation.
+     */
+    debugAnimation: number | null;
+    constructor(objects: SlideObject<any>[], animations?: BuildFunction[]);
+    render(presentation: Presentation, animationIndex?: number): void;
+    nextAnimation(presentation: Presentation): boolean;
+    /**
+     * Sleep for a specified number of milliseconds in an animation.
+     */
+    sleep(ms: number): Promise<unknown>;
+}

package/dist/src/util/animation.d.ts

@@ -0,0 +1,37 @@
+import anime from "animejs/lib/anime.es.js";
+/**
+ * Data needed to process an animation.
+ */
+export interface AnimationProps {
+    /**
+     * Whether to animate the change.
+     */
+    animate?: boolean;
+    element?: HTMLElement | SVGElement;
+    attributes?: Record<string, string>;
+    styles?: Record<string, string>;
+    animationParams?: anime.AnimeParams;
+    children?: Node[];
+    /**
+     * Delay, in milliseconds.
+     */
+    delay?: number;
+}
+/**
+ * Function that performs an animation on an element.
+ */
+export type Animator = (props: AnimationProps | AnimationProps[]) => Promise<void>;
+/**
+ * Function that possibly applies a sequence of animations.
+ */
+export type BuildFunction = (animate: Animator) => void;
+/**
+ * Perform an animation on an element.
+ * @param props Animation properties.
+ */
+export declare const performAnimation: Animator;
+/**
+ * Performs animations by skipping the animation duration and jumping to end of animation.
+ * @param props Animation properties.
+ */
+export declare const skipAnimation: Animator;

package/dist/src/util/position.d.ts

@@ -0,0 +1,11 @@
+export interface Position {
+    x: number;
+    y: number;
+}
+export declare class BoundingBox {
+    origin: Position;
+    width: number;
+    height: number;
+    constructor(origin: Position, width: number, height: number);
+    static fromElement(element: SVGGraphicsElement): BoundingBox;
+}

package/dist/src/util/richText.d.ts

@@ -0,0 +1,18 @@
+export interface RichTextProps {
+    fontStyle?: string;
+    fontWeight?: string | number;
+    fontSize?: number;
+    fontFamily?: string;
+    textDecoration?: string;
+    color?: string;
+    dy?: number;
+}
+export type RichTextSpan = string | [string, RichTextProps];
+/**
+ * Creates a text node with spaces replaced by non-breaking spaces.
+ */
+export declare function createSpacePreservingTextNode(text: string): Text;
+/**
+ * Given rich text configuration, returns the corresponding tspan nodes.
+ */
+export declare function generateTextNodes(lines: (string | RichTextSpan[])[], lineSpacing?: string, anchor?: "start" | "middle" | "end"): Node[];

package/dist/webpack.config.d.ts

@@ -0,0 +1,22 @@
+export let mode: string;
+export let entry: string;
+export namespace output {
+    let filename: string;
+    let path: string;
+    let library: string;
+    let libraryTarget: string;
+    let globalObject: string;
+}
+export namespace watchOptions {
+    let ignored: string[];
+}
+export namespace resolve {
+    let extensions: string[];
+}
+export namespace module {
+    let rules: {
+        test: RegExp;
+        use: string;
+        exclude: RegExp;
+    }[];
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "presenter",
-  "version": "0.1.1",
-  "description": "A JavaScript-based presentation library",
+  "version": "0.2.2",
+  "description": "A JavaScript presentation library",
   "main": "dist/presenter.js",
   "types": "dist/src/index.d.ts",
   "scripts": {
@@ -19,6 +19,12 @@
     "url": "https://github.com/brianyu28/presenter/issues"
   },
   "homepage": "https://github.com/brianyu28/presenter#readme",
+  "files": [
+    "./dist/"
+  ],
+  "dependencies": {
+    "animejs": "^3.2.2"
+  },
   "devDependencies": {
     "@types/animejs": "^3.1.12",
     "husky": "^9.1.7",
@@ -31,8 +37,5 @@
   },
   "lint-staged": {
     "**/*": "prettier --write --ignore-unknown"
-  },
-  "dependencies": {
-    "animejs": "^3.2.2"
   }
 }

package/.husky/pre-commit

@@ -1 +0,0 @@
-npx lint-staged

package/.prettierrc

@@ -1 +0,0 @@
-{}

package/examples/README.md

@@ -1,23 +0,0 @@
-# Examples
-
-Example Presenter.js presentations.
-
-## Usage
-
-The examples currently require [symlinking the Presenter.js package](https://docs.npmjs.com/cli/v9/commands/npm-link).
-
-In the root of this repository, run:
-
-```
-$ npm link
-```
-
-Then, in each of the examples, e.g. `examples/simple`, run:
-
-```
-$ npm link presenter
-```
-
-This symlinks the local version of the `presenter` package into the example presentation.
-
-Then, run the development server with `npm run serve` or build the production version with `npm run build`.

package/examples/simple/dist/index.html

@@ -1,8 +0,0 @@
-<!doctype html>
-<html lang="en">
-  <head>
-    <title>Simple Example</title>
-    <script src="main.js"></script>
-  </head>
-  <body></body>
-</html>