Skip to main content

OrcaKeyCodeCommand

Extends: object

An object representing a keyboard command for the Orca screen reader. Get available commands from unstable_orca.keyboardCommands or the orcaKeyCodeCommands collection.

import { unstable_orca } from "@guidepup/guidepup";

(async () => {
  await unstable_orca.start();

  const command = unstable_orca.keyboardCommands.MoveToNextSibling;
  console.log(command.command);
  console.log(command.description);
  console.log(command.representation);
  console.log(command.service);

  await unstable_orca.perform(command);
  await unstable_orca.stop();
})();

Contents:

orcaKeyCodeCommand.command​

The name of the Orca command.

Type: string

orcaKeyCodeCommand.description​

A description of the Orca command.

Type: string

orcaKeyCodeCommand.representation​

The keyboard shortcut used to invoke the command in Orca.

Type: string

orcaKeyCodeCommand.service​

The Orca service that provides the command.

Type: string