p-slides/utils.d.ts

Presentations made simple with Web Components

/**
 * The `<p-deck>` element will start loading its stylesheet at the default location of `css/`, if nothing has been set
 * on `PresentationDeckElement.styles`. You can change that _before defining or instantiating_ a `<p-deck>` element.
 *
 * Don't forget the final slash! Or do, if you want to provide a prefix for the file names.
 * @param {string} root
 */
export function setStyleRoot(root: string): void;
/**
 * @param {Node} root
 * @returns {Array<Element | Comment>}
 * @internal
 */
export function getNotes(root: Node): Array<Element | Comment>;
/**
 * @param {KeyboardEvent} keyEvent
 * @param {Record<T, Array<Partial<KeyboardEvent>>>} keyMap
 * @return {T | null}
 * @template {string} T
 * @internal
 */
export function matchKey<T extends string>(keyEvent: KeyboardEvent, keyMap: Record<T, Array<Partial<KeyboardEvent>>>): T | null;
export function whenAllDefined(): Promise<CustomElementConstructor[]>;
export function getStylesheets(styles: string | string[] | null): Promise<CSSStyleSheet[]>;
export function isSlide(element: unknown): element is PresentationSlideElement;
export function selectSlide(slides: PresentationSlideElement[], nextSlide: PresentationSlideElement): void;
export function copyNotes(noteContainer: Element, notes: Array<Element | Comment>): void;
export function checkNoteActivations(noteContainer: Element, notes: Array<Element | Comment>): void;
export function fireEvent<N extends PresentationEventSimpleName>(target: EventTarget, eventName: N, detail?: HTMLElementEventMap[`p-slides.${N}`]["detail"]): void;
export function formatClock(millis: number): [number, number, number];
export function isFragmentVisible(element: Element): boolean;
export function setFragmentVisibility(visible: boolean): (...elements: Element[]) => void;
export function setCurrentFragments(slide: PresentationSlideElement): void;
export function getSequencedFragments(fragments: ArrayLike<Element>): Element[][];
export function getLabel<C extends {
    labels: T;
}, T extends Record<string, string | ((context: C) => string)>>(context: C, name: keyof T): string;
export function getHighlightIndex(key: string, current: number, columns: number, slides: number): number;
export function getHoverIndex(pageX: number, pageY: number, slides: PresentationSlideElement[]): number;
export type PresentationSlideElement = import("./components/slide.js").PresentationSlideElement;
export type PresentationEventSimpleName = { [E in keyof HTMLElementEventMap]: E extends `p-slides.${infer N}` ? N : never; }[keyof HTMLElementEventMap];