presenter 0.8.2 → 0.8.4

package/README.md

@@ -2,4 +2,46 @@
 
 Presenter.js is a presentation tool for programmatically building animated visual slides.
 
-This library is still in development and its API may change at any time.
+[View Documentation](https://presenter.js.org)
+
+## Get Started
+
+Start a new project by creating a Presenter.js presentation:
+
+```bash
+npm create presenter
+```
+
+Or add Presenter.js to an existing project with `npm install presenter`.
+
+## Presentation Structure
+
+A presentation is a JavaScript object that includes an array of slides to render in order.
+
+```typescript
+export const presentation = Presentation({
+  title: "Presentation",
+  slides: [TitleSlide],
+});
+```
+
+A slide specifies objects on the slide, plus any animations for those objects.
+
+```typescript
+import { Anchor, Slide, Text } from "presenter";
+import { position } from "../size";
+
+const title = Text("Welcome to Presenter.js!", {
+  anchor: Anchor.CENTER,
+  fontSize: 150,
+  ...position(0.5, 0.5),
+});
+
+export const TitleSlide = Slide({
+  objects: [title],
+});
+```
+
+## Notes
+
+This library is still in development and its API may change in the future.

package/dist/navigator/openNavigator.d.ts

@@ -1,8 +1,30 @@
 import { Presentation } from '../types/Presentation';
+import { ShortcutState } from '../types/ShortcutState';
+export declare let navigatorWindowBounds: {
+    width: number;
+    height: number;
+    left: number;
+    top: number;
+};
 interface Args {
     readonly presentation: Presentation;
+    readonly shortcutState: ShortcutState;
     readonly onNavigateToSlide: (slideIndex: number) => void;
+    readonly onRenderSlide: (slideIndex: number | null, buildIndex: number) => void;
+    readonly onNext: (skipIntermediateBuilds?: boolean) => void;
+    readonly onPrevious: (skipIntermediateBuilds?: boolean) => void;
 }
-export declare function openNavigator({ presentation, onNavigateToSlide }: Args): void;
-export declare function createNavigatorElement(presentation: Presentation, onNavigateToSlide: (slideIndex: number) => void): HTMLDivElement;
+export interface NavigatorApi {
+    readonly currentCanvas: HTMLCanvasElement;
+    readonly nextCanvas: HTMLCanvasElement;
+    readonly currentLabel: HTMLDivElement;
+    readonly nextLabel: HTMLDivElement;
+    readonly isOpen: () => boolean;
+    readonly update: (slideIndex: number, buildIndex: number, nextSlideIndex: number | null, nextBuildIndex: number) => void;
+}
+type NavigatorElementApi = NavigatorApi & {
+    readonly element: HTMLDivElement;
+};
+export declare function openNavigator({ presentation, shortcutState, onNavigateToSlide, onRenderSlide, onNext, onPrevious, }: Args): NavigatorApi | null;
+export declare function createNavigatorElement(presentation: Presentation, onNavigateToSlide: (slideIndex: number) => void, onNext: () => void): NavigatorElementApi;
 export {};