presenter 0.5.4 → 0.6.0

package/dist/src/objects/arrow.d.ts

@@ -1,62 +0,0 @@
-import { ObjectProps, SlideObject } from "../presentation/object";
-import { BuildFunction } from "../util/animation";
-import { Position } from "../util/position";
-import { Line } from "./line";
-import { Path } from "./path";
-import { Polygon } from "./polygon";
-export interface ArrowProps extends ObjectProps {
-    start: Position;
-    end: Position;
-    color: string;
-    width: number;
-    arrowSize: number;
-    filledHead: boolean;
-    doubledHead: boolean;
-    growFromCenter: boolean;
-    /**
-     * Property describing whether the arrow has been fully drawn.
-     * If an arrow hasn't been drawn, it can be animated to draw in.
-     */
-    drawn: boolean;
-    /**
-     * The start and end points can have "padding".
-     * This is equivalent to adding (x, y) values to the start and end points.
-     *
-     * This can be useful when drawing an arrow from an object at a particular
-     * location. The arrow's start/end point can match the object's, with some
-     * added padding so that the arrow doesn't overlap the object.
-     *
-     * It can also be useful if multiple arrows start or end at the same place,
-     * and you want to adjust their endpoints slightly to avoid overlap.
-     */
-    padStart: Partial<Position>;
-    padEnd: Partial<Position>;
-}
-export declare class Arrow extends SlideObject<ArrowProps> {
-    line: Line | null;
-    arrowhead: Polygon | Path | null;
-    doubledArrowhead: Polygon | Path | null;
-    constructor(props?: Partial<ArrowProps>);
-    tagName(): string;
-    /**
-     * Computes coordinates for the line and arrowhead of the arrow.
-     */
-    calculateShapes(props: ArrowProps): {
-        line: {
-            start: Position;
-            end: {
-                x: number;
-                y: number;
-            };
-        };
-        arrowhead: Position[];
-        doubledArrowhead: Position[];
-    };
-    children(): Node[];
-    animate(props: Partial<ArrowProps>, animationParams?: anime.AnimeParams, delay?: number | null, animate?: boolean): BuildFunction;
-    draw(animationParams?: anime.AnimeParams): BuildFunction;
-    /**
-     * Returns animations for changes in arrowhead.
-     */
-    animateArrow(arrowProps: Partial<ArrowProps>, animationParams?: anime.AnimeParams, delay?: number | null, animate?: boolean): BuildFunction;
-}

package/dist/src/objects/circle.d.ts

@@ -1,24 +0,0 @@
-import { ObjectProps, SlideObject } from "../presentation/object";
-import { BuildFunction } from "../util/animation";
-export interface CircleProps extends ObjectProps {
-    fill: string;
-    radius: number;
-    borderWidth: number;
-    borderColor: string;
-    drawn: boolean;
-}
-interface PathDrawOnProps {
-    drawDuration: number;
-    fillDuration: number;
-    easing: string;
-}
-export declare class Circle extends SlideObject<CircleProps> {
-    constructor(props?: Partial<CircleProps>);
-    tagName(): string;
-    attributes(): Partial<Record<string, string>>;
-    animate(props: Partial<CircleProps>, animationParams?: anime.AnimeParams & {
-        fillDuration?: number;
-    }, delay?: number | null, animate?: boolean): BuildFunction;
-    drawOn(props?: Partial<PathDrawOnProps>): BuildFunction;
-}
-export {};

package/dist/src/objects/grid.d.ts

@@ -1,17 +0,0 @@
-/**
- * A grid of identical or similar objects.
- */
-import { SlideObject } from "../presentation/object";
-import { Position } from "../util/position";
-import { Group, GroupProps } from "./group";
-export interface GridProps extends Omit<GroupProps, "objects"> {
-    origin: Position;
-    spacing: Partial<Position>;
-    rows: number;
-    cols: number;
-    objects: (row: number, col: number) => SlideObject<any> | null;
-}
-export declare class Grid extends Group {
-    objects: (SlideObject<any> | null)[][];
-    constructor(props: Partial<GridProps>);
-}

package/dist/src/objects/group.d.ts

@@ -1,29 +0,0 @@
-import { ObjectProps, SlideObject } from "../presentation/object";
-import { Position } from "../util/position";
-export interface GroupProps extends ObjectProps {
-    /**
-     * A positioned group places the group's anchor at a particular coordinate.
-     * A non-positioned group uses the position as an offset for its children.
-     */
-    positioned: boolean;
-    objects: SlideObject<any>[];
-    rotation: number;
-    rotationOrigin: Position;
-    transformOrigin: Position | string | null;
-    scale: number;
-    skewX: number;
-    skewY: number;
-}
-export declare class Group extends SlideObject<GroupProps> {
-    constructor(objects: SlideObject<any>[], props?: Partial<GroupProps>, positioned?: boolean | null);
-    tagName(): string;
-    attributes(): Partial<Record<string, string>>;
-    additionalAttributes(): Partial<Record<string, string>>;
-    /**
-     * Returns the element to be used for computing the bounding box of the group.
-     * Allows overriding so that sometimes we can use custom rules for determining
-     * a group's bounding box.
-     */
-    sizingElement(): SVGGraphicsElement;
-    children(): Node[];
-}

package/dist/src/objects/iframe.d.ts

@@ -1,16 +0,0 @@
-import { ObjectProps, SlideObject } from "../presentation/object";
-export interface IFrameProps extends ObjectProps {
-    url: string;
-    width: number;
-    height: number;
-    backgroundColor: string;
-    pointerEvents: string;
-    scale: number;
-}
-export declare class IFrame extends SlideObject<IFrameProps> {
-    constructor(props?: Partial<IFrameProps>);
-    tagName(): string;
-    attributes(): Partial<Record<string, string>>;
-    styles(): Partial<Record<string, string>>;
-    children(): Node[];
-}

package/dist/src/objects/image.d.ts

@@ -1,20 +0,0 @@
-import { ObjectProps, SlideObject } from "../presentation/object";
-export interface ImageProps extends ObjectProps {
-    href: string;
-    width: number;
-    height: number;
-    rounding: number;
-}
-export declare class Image extends SlideObject<ImageProps> {
-    constructor(href: string, props?: Partial<ImageProps>);
-    tagName(): string;
-    attributes(): Partial<Record<string, string>>;
-    styles(): Partial<Record<string, string>>;
-    /**
-     * By default, browsers might not fetch an image until the image element is
-     * added to the DOM. Pre-fetching them when the image object is created
-     * means the image will be fetched before the slide is rendered, so there's
-     * no delay between the slide appearing and the image loading.
-     */
-    static prefetch(href: string): void;
-}

package/dist/src/objects/line.d.ts

@@ -1,21 +0,0 @@
-import { ObjectProps, SlideObject } from "../presentation/object";
-import { BuildFunction } from "../util/animation";
-import { Position } from "../util/position";
-export interface LineProps extends ObjectProps {
-    start: Position;
-    end: Position;
-    color: string;
-    width: number;
-    linecap: "butt" | "round" | "square" | null;
-    /**
-     * Property describing whether the line has been fully drawn.
-     * If a line hasn't been drawn, it can be animated to draw in.
-     */
-    drawn: boolean;
-}
-export declare class Line extends SlideObject<LineProps> {
-    constructor(props?: Partial<LineProps>);
-    tagName(): string;
-    attributes(): Partial<Record<string, string>>;
-    animate(props: Partial<LineProps>, animationParams?: anime.AnimeParams, delay?: number | null, animate?: boolean): BuildFunction;
-}

package/dist/src/objects/mask.d.ts

@@ -1,13 +0,0 @@
-import { ObjectProps, SlideObject } from "../presentation/object";
-export interface MaskProps extends ObjectProps {
-    id: string;
-    objects: SlideObject<any>[];
-}
-export declare class Mask extends SlideObject<MaskProps> {
-    id: string;
-    static maskIndex: number;
-    constructor(objects: SlideObject<any>[], props?: Partial<MaskProps>);
-    tagName(): string;
-    attributes(): Partial<Record<string, string>>;
-    children(): Node[];
-}

package/dist/src/objects/paragraph.d.ts

@@ -1,21 +0,0 @@
-import { ObjectProps, SlideObject } from "../presentation/object";
-export interface ParagraphProps extends ObjectProps {
-    content: string | string[];
-    width: number;
-    height: number;
-    fontStyle: string;
-    fontWeight: string | number;
-    fontSize: number;
-    fontFamily: string;
-    color: string;
-    align: "left" | "center" | "right";
-    lineHeight: number | string | null;
-}
-export declare class Paragraph extends SlideObject<ParagraphProps> {
-    constructor(content: string | string[], props?: Partial<ParagraphProps>);
-    tagName(): string;
-    attributes(): Partial<Record<string, string>>;
-    children(): Node[];
-    additionalAttributes(): Partial<Record<string, string>>;
-    requiresChildrenUpdate(props: Partial<ParagraphProps>): boolean;
-}

package/dist/src/objects/path.d.ts

@@ -1,29 +0,0 @@
-import { ObjectProps, SlideObject } from "../presentation/object";
-import { BuildFunction } from "../util/animation";
-import { Position } from "../util/position";
-export interface PathProps extends ObjectProps {
-    points: Position[];
-    color: string;
-    fill: string;
-    width: number;
-    linecap: "butt" | "round" | "square" | null;
-    drawn: boolean;
-}
-interface PathDrawOnProps {
-    drawDuration: number;
-    fillDuration: number;
-    easing: string;
-}
-export declare class Path extends SlideObject<PathProps> {
-    constructor(props?: Partial<PathProps>);
-    tagName(): string;
-    attributes(): Partial<Record<string, string>>;
-    animate(props: Partial<PathProps>, animationParams?: anime.AnimeParams & {
-        fillDuration?: number;
-    }, delay?: number | null, animate?: boolean): BuildFunction;
-    /**
-     * Animates drawing of SVG path.
-     */
-    drawOn(props?: Partial<PathDrawOnProps>): BuildFunction;
-}
-export {};

package/dist/src/objects/polygon.d.ts

@@ -1,13 +0,0 @@
-import { ObjectProps, SlideObject } from "../presentation/object";
-import { Position } from "../util/position";
-export interface PolygonProps extends ObjectProps {
-    points: Position[];
-    fill: string;
-    borderWidth: number;
-    borderColor: string;
-}
-export declare class Polygon extends SlideObject<PolygonProps> {
-    constructor(points: Position[], props?: Partial<PolygonProps>);
-    tagName(): string;
-    attributes(): Partial<Record<string, string>>;
-}

package/dist/src/objects/rectangle.d.ts

@@ -1,26 +0,0 @@
-import { ObjectProps, SlideObject } from "../presentation/object";
-import { BuildFunction } from "../util/animation";
-export interface RectangleProps extends ObjectProps {
-    fill: string;
-    width: number;
-    height: number;
-    rounding: number;
-    borderWidth: number;
-    borderColor: string;
-    drawn: boolean;
-}
-interface PathDrawOnProps {
-    drawDuration: number;
-    fillDuration: number;
-    easing: string;
-}
-export declare class Rectangle extends SlideObject<RectangleProps> {
-    constructor(props?: Partial<RectangleProps>);
-    tagName(): string;
-    attributes(): Partial<Record<string, string>>;
-    animate(props: Partial<RectangleProps>, animationParams?: anime.AnimeParams & {
-        fillDuration?: number;
-    }, delay?: number | null, animate?: boolean): BuildFunction;
-    drawOn(props?: Partial<PathDrawOnProps>): BuildFunction;
-}
-export {};

package/dist/src/objects/screenCapture.d.ts

@@ -1,17 +0,0 @@
-import { ObjectProps, SlideObject } from "../presentation/object";
-export interface ScreenCaptureProps extends ObjectProps {
-    width: string | number | null;
-    height: string | number | null;
-    scale: number;
-    align: "left" | "center" | "right";
-}
-export declare class ScreenCapture extends SlideObject<ScreenCaptureProps> {
-    videoElement: HTMLVideoElement | null;
-    constructor(props?: Partial<ScreenCaptureProps>);
-    tagName(): string;
-    attributes(): Partial<Record<string, string>>;
-    styles(): {
-        "text-align": "left" | "center" | "right";
-    };
-    children(): HTMLVideoElement[];
-}

package/dist/src/objects/text.d.ts

@@ -1,67 +0,0 @@
-import { ObjectProps, SlideObject } from "../presentation/object";
-import { BuildFunction } from "../util/animation";
-import { RichTextSpan } from "../util/richText";
-export type TextContent = string | (string | RichTextSpan[])[];
-export interface TextProps extends ObjectProps {
-    content: TextContent;
-    fontStyle: string;
-    fontWeight: string | number;
-    fontSize: number;
-    fontFamily: string;
-    color: string;
-    dominantBaseline: string;
-    textDecoration: string;
-    smallCaps: boolean;
-    baselineHeight: number;
-    length: number | null;
-    align: "left" | "center" | "right";
-    lineSpacing: string;
-    ligatures: string | null;
-}
-export declare class Text extends SlideObject<TextProps> {
-    constructor(content: TextContent, props?: Partial<TextProps>);
-    isRichText(): boolean;
-    tagName(): string;
-    attributes(): Partial<Record<string, string>>;
-    /**
-     * Text elements return position as additional attributes since computing text
-     * size and position requires other properties to be set first.
-     */
-    additionalAttributes(): Partial<Record<string, string>>;
-    styles(): Partial<Record<string, string>>;
-    children(): Node[];
-    requiresChildrenUpdate(props: Partial<TextProps>): boolean;
-    /**
-     * Returns the number of characters in the total text content.
-     * Optional argument: `throughLine` to return number of characters
-     * through the end of that line, assuming multi-line content.
-     * Defaults to `null`, which considers the full text.
-     */
-    contentLength(throughLine?: number | null): number;
-    /**
-     * Returns the children of a text node, up to a particular content length.
-     */
-    childrenWithContentLength(length: number | null): Node[];
-    regenerateChildren(): void;
-    animate(props: Partial<TextProps>, animationParams?: anime.AnimeParams, delay?: number | null, animate?: boolean): BuildFunction;
-    /**
-     * Returns a write-on animation for changing the characters.
-     *
-     * Writing on text requires a different approach than other text animations
-     * since the children of the element need to be replaced.
-     */
-    writeOn(length?: number | null, duration?: number, animate?: boolean): BuildFunction;
-    /**
-     * Sets position attributes of text and re-generates any children.
-     *
-     * This is because re-generating children alone won't change the position
-     * attributes, which menas the text might be mis-aligned.
-     */
-    generateChildrenAndReposition(): void;
-    /**
-     * Animates the content of a text element via an
-     * interpolation function that returns the text content
-     * for a given progress amount.
-     */
-    animateContent(computeContent: (proportion: number) => TextContent, duration?: number): BuildFunction;
-}

package/dist/src/objects/vectorGraphic.d.ts

@@ -1,48 +0,0 @@
-import { ObjectProps, SlideObject } from "../presentation/object";
-import { AnimationProps, BuildFunction } from "../util/animation";
-export interface VectorGraphicProps extends ObjectProps {
-    svg: string;
-    width: number;
-    height: number;
-}
-interface DrawOnProps {
-    color: string;
-    strokeWidth: number;
-    fill: boolean;
-    fillColor: string | null;
-    drawDuration: number;
-    fillDuration: number;
-    easing: string;
-    pathLength: number | null;
-    /**
-     * Controls whether there should still be a stroke present at end of animation.
-     * If `endWithoutStroke` is true, the stroke width fades out to 0 at the end.
-     */
-    endWithoutStroke: boolean;
-}
-export declare class VectorGraphic extends SlideObject<VectorGraphicProps> {
-    parsedChildren: Node[];
-    /**
-     * Returns an SVG node given string content.
-     */
-    static svgNode(content: string): SVGElement;
-    constructor(svg: string, props?: Partial<VectorGraphicProps>);
-    tagName(): string;
-    createElement(): SVGElement;
-    attributes(): Partial<Record<string, string>>;
-    children(): Node[];
-    /**
-     * Perform animation on a particular path of the graphic.
-     * Requires specifying `attributes` or `styles` for path animation props.
-     */
-    animatePath(selector: string, props: Partial<AnimationProps>, duration?: number, animate?: boolean): BuildFunction;
-    /**
-     * Sets path animation properties without animating.
-     */
-    setPath(selector: string, props: Partial<AnimationProps>): BuildFunction;
-    /**
-     * Animates the drawing on of a particular path.
-     */
-    drawOn(selector: string, props?: Partial<DrawOnProps>): BuildFunction;
-}
-export {};

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

@@ -1,132 +0,0 @@
-import { BoundingBox, Position } from "../util/position";
-import { Presentation } from "./presentation";
-import { BuildFunction } from "../util/animation";
-export type Anchor = "topleft" | "top" | "topright" | "left" | "center" | "right" | "bottomleft" | "bottom" | "bottomright";
-export interface ObjectProps {
-    position: Position | null;
-    opacity?: number;
-    anchor: Anchor;
-    mask?: string;
-}
-export declare class SlideObject<Props extends ObjectProps> {
-    /**
-     * Starting values for each property.
-     */
-    initialProps: Props;
-    /**
-     * Current values for each property.
-     */
-    props: Props;
-    _presentation: Presentation | null;
-    _element: SVGElement | null;
-    _children: Node[];
-    /**
-     * Initializes a new object to include on a slide.
-     * @param props Object properties.
-     */
-    constructor(props: Partial<Props>);
-    /**
-     * Returns the tag name of the element.
-     * @returns Tag name.
-     */
-    tagName(): string;
-    /**
-     * Returns the DOM attributes that should be set for the element.
-     * @returns Object with attribute names and values.
-     */
-    attributes(): Partial<Record<string, string>>;
-    /**
-     * Returns additional DOM attributes to be set for the element.
-     * Some attributes can't be computed until after an element's other properties are set:
-     * e.g. text position depends on content and font size.
-     * Additional attributes are computed after all other attributes, styles, and children.
-     * @returns Object with attribute names and values.
-     */
-    additionalAttributes(): Partial<Record<string, string>>;
-    /**
-     * Returns the styles that should be set for the element.
-     * @returns Object with style names and values.
-     */
-    styles(): Partial<Record<string, string>>;
-    /**
-     * Returns the children that should be rendered for the object.
-     * @returns Array of SVG elements.
-     */
-    children(): Node[];
-    /**
-     * Given a set of prop updates, checks if the children of the object need to be updated.
-     * @param props Properties to update.
-     * @returns Boolean indicating whether children need to be updated.
-     */
-    requiresChildrenUpdate(props: Partial<Props>): boolean;
-    /**
-     * Given a particular initial bounding box, returns the DOM position attributes that should be set for the element.
-     * @param bbox Bounding box.
-     * @returns Object with attribute names and values.
-     */
-    positionAttributes(bbox: BoundingBox): any;
-    /**
-     * Re-generates the SVG element for the object.
-     * @param presentation Presentation object.
-     * @returns SVG element.
-     */
-    generate(presentation: Presentation): SVGElement;
-    /**
-     * Creates a new HTML element for the object.
-     */
-    createElement(): SVGElement;
-    /**
-     * Returns the element for the object.
-     * @returns SVG element.
-     */
-    element(): SVGElement;
-    /**
-     * Returns an animation to perform.
-     * @param props Properties of object to change.
-     * @param animationParams Animation behavior parameters.
-     * @returns Animation build function.
-     */
-    animate(props: Partial<Props>, animationParams?: anime.AnimeParams, delay?: number | null, animate?: boolean): BuildFunction;
-    /**
-     * Returns an update animation that skips the animation and just performs the change.
-     * @param props Properties of object to change.
-     */
-    set(props: Partial<Props>, delay?: number | null): BuildFunction;
-    /**
-     * Animates a movement of the object.
-     */
-    move(position: Position, animationParams?: anime.AnimeParams): BuildFunction;
-    /**
-     * Animates fading an object into view.
-     */
-    fadeIn(animationParams?: anime.AnimeParams): BuildFunction;
-    /**
-     * Animates fading an object out of view.
-     */
-    fadeOut(animationParams?: anime.AnimeParams): BuildFunction;
-    /**
-     * Sets an objects opacity to 1.
-     */
-    show(): BuildFunction;
-    /**
-     * Sets an objects opacity to 0.
-     */
-    hide(): BuildFunction;
-    /**
-     * Allow for x and y values to be interpreted as percentages of total width/height.
-     */
-    positionInPresentation(position: Position): Position;
-    /**
-     * Adjusts a bounding box to be anchored given the object's vertical and horizontal anchor settings.
-     * @param bbox Bounding box to anchor.
-     * @returns Anchored bounding box.
-     */
-    anchorBoundingBox(bbox: BoundingBox): BoundingBox;
-    /**
-     * Computes a bounding box for a given element given its rendered size and defined position.
-     * @param element Element for which to compute size.
-     * @param children Custom children to use when computing bounding box.
-     * @returns
-     */
-    computeRenderedBoundingBox(element: SVGGraphicsElement, children?: Node[] | null): BoundingBox;
-}