Function clear

src/user-event/clear.ts:17–52

(this: UserEventInstance, instance: TestInstance)

import { dispatchEvent, wait } from './utils';

export async function clear(this: UserEventInstance, instance: TestInstance): Promise<void> {
  if (!isHostTextInput(instance)) {
    throw new ErrorWithStack(
      `clear() only supports host "TextInput" instances. Passed instance has type: "${instance.type}".`,
      clear,
    );
  }

  if (!isEditableTextInput(instance) || !isPointerEventEnabled(instance)) {
    return;
  }

  // 1. Enter instance
  await dispatchEvent(instance, 'focus', buildFocusEvent());

  // 2. Select all
  const textToClear = getTextInputValue(instance);
  const selectionRange = {
    start: 0,
    end: textToClear.length,
  };
  await dispatchEvent(instance, 'selectionChange', buildTextSelectionChangeEvent(selectionRange));

  // 3. Press backspace with selected text
  const emptyText = '';
  await emitTypingEvents(instance, {
    config: this.config,
    key: 'Backspace',
    text: emptyText,
  });

  // 4. Exit instance
  await wait(this.config);
  await dispatchEvent(instance, 'endEditing', buildEndEditingEvent(emptyText));
  await dispatchEvent(instance, 'blur', buildBlurEvent());
}