@tigerface/lwc-test-utils/lib/simulate.d.ts

A collection of helpful utility functions for unit testing LWC components with Jest.

/**
 * A class containing helper functions for actions that a user would normally perform
 * such as typing into an input field or clicking keyboard keys.
 */
export declare class Simulate {
    /**
     * Simulate a user changing the value
     * of a checkbox
     * @param checkboxEl the checkbox element
     * @param value the updated value
     *
     * @example
     * ```
     *  // simulate checkbox getting checked
     *  Simulate.checkboxChange(checkboxEl, true);
     * ```
     */
    static checkboxChange(checkboxEl: HTMLInputElement, value: boolean): void;
    /**
     * Dispatches an event from an element.
     * @param element the element to dispatch the event from
     * @param eventName the name of the event
     * @param payload the payload of the event
     *
     * @example
     * ```
     *  // simulate a custom event
     *  Simulate.event(menuEl, 'select', { detail: { value: 'clip' } });
     * ```
     */
    static event(element: Window | Document | HTMLElement, eventName: string, payload?: CustomEventInit<any>): void;
    /**
     * Simulate a user changing the value
     * of an input element
     * @param inputEl the input element
     * @param value the updated value
     *
     * @example
     * ```
     *  // simulate input changing to hello world
     *  Simulate.inputChange(inputEl, 'hello world');
     * ```
     */
    static inputChange(inputEl: HTMLInputElement, value: string): void;
    /**
     * Simulate a user pressing a key on the
     * supplied element
     * @deprecated since version 0.0.4 Use keyEvent instead. Will be removed in version 1.0.
     * @param element the element to click
     * @param key the key to simulate a click. Full
     * list of key values can be found here:
     * https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key/Key_Values
     */
    static keyUp(element: Window | Document | HTMLElement, key: string): void;
    /**
     * Simulate a keyboard event
     * @param element the element to trigger the event
     * @param event the name of the keyboard event (Ex: keyup)
     * @param payload the payload of the event
     *
     * @example
     * ```
     *  // simulate enter key press
     *  Simulate.keyboardEvent(inputEl, 'keyup', { key: 'Enter' });
     * ```
     */
    static keyboardEvent(element: Window | Document | HTMLElement, event: 'keydown' | 'keypress' | 'keyup', payload: KeyboardEventInit): void;
    /**
     * Simulate a mouse event
     * @param element the element to click
     * @param event the name of the mouse event (Ex: click, dblclick, mouseup, mousemove, mousedown)
     * @param payload the payload of the event
     *
     * @example
     * ```
     *  // simulate mouse move event
     *  Simulate.mouseEvent(document, 'mousemove', { clientX: 150 });
     * ```
     */
    static mouseEvent(element: Window | Document | HTMLElement, event: string, payload: MouseEventInit): void;
}
//# sourceMappingURL=simulate.d.ts.map