https://github.com/codevideo/codevideo-virtual-mouse
TypeScript class that simulates a mouse
https://github.com/codevideo/codevideo-virtual-mouse
Last synced: 4 months ago
JSON representation
TypeScript class that simulates a mouse
- Host: GitHub
- URL: https://github.com/codevideo/codevideo-virtual-mouse
- Owner: codevideo
- Created: 2025-04-02T06:52:04.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-05-03T11:15:28.000Z (about 1 year ago)
- Last Synced: 2025-10-02T18:14:54.316Z (9 months ago)
- Language: TypeScript
- Size: 172 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# @fullstackcraft/codevideo-virtual-mouse
`codevideo-virtual-mouse` is a TypeScript class that simulates a virtual mouse that can speak. This lightweight and versatile library is ideal for building educational tools, code playgrounds, and interactive coding environments within web applications.
This library heavily relies on the types from [codevideo-types](https://github.com/codevideo/codevideo-types)
## Example Usage
```typescript
import { VirtualMouse } from '@fullstackcraftllc/codevideo-virtual-mouse';
// Initialize a VirtualMouse instance with initial existing command history
const virtualMouse = new VirtualMouse();
// Apply speak action to the virtual mouse
virtualMouse.applyActions([
{ name: 'mouse-move-file-explorer', value: "1" }
]);
// Use the virtual mouse object
const currentLocation = virtualMouse.getCurrentLocation();
// Log the final code and actions applied
console.log('Current mouse location:');
console.log(currentLocation); // "file-explorer"
```
## Why?
Why do we need a seemingly useless class? This library, along with many others create an entire event sourcing framework for the IDE. This is a small part of a larger project to create a declarative way to build, edit, and generate step by step educational video software courses.
See more at [codevideo.io](https://codevideo.io)