Test-keyboard NPM

test-keyboard

A test keyboard for dispatching events to the dom which mimics keyboard actions from the user.

The problem

You want to write tests for code that makes heavy usage of the keyboard and you're finding it hard to compose these keyboard events together.

This solution

test-keyboard is an elegant way of composing keyboard events together as if a user was typing.

It is primarily designed for dom-test environments but could be extracted out into something that can be used in your front-end code.

Installation

yarn add test-keyboard

`Keyboard.create` - `(params: KeyboardConstructorParams) => Keyboard`

import { Keyboard } from 'test-keyboard';

const target = document.getElementById('editor');
Keyboard.create({
    target,
  })
    .start() // Allows events to be dispatched
    .mod({ text: 'Ctrl-Shift-Enter' })
    .end(); // Dispatches al the events.
};

`KeyboardConstructorParams`

Property	Type	Default	Description
`target`	`Element`	REQUIRED	The target of our events.
`defaultOptions`	`KeyboardEventInit`	`{}`	The target of our events.
`isMac`	`boolean`	`false`	Whether to simulate a mac.
`batch`	`boolean`	`false`	Whether to wait until end is called before running all accumulated actions.
`onEventDispatch`	`(event: KeyboardEvent) => void`	`() => {}`	Called whenever an event is dispatched with the keyboard event as a parameter.

Acknowledgements

Puppeteer for providing the US Keyboard information.

compose events events keyboard

@babel/runtime @remirror/core-helpers @remirror/core-types

@infinitebrahmanuniverse/nolb-test-k @everything-registry/sub-chunk-2902 jest-prosemirror

6 months ago

6 months ago

6 months ago

6 months ago

5 months ago

7 months ago

7 months ago

7 months ago

7 months ago

10 months ago

10 months ago

9 months ago

7 months ago

9 months ago

9 months ago

9 months ago

10 months ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

2 years ago

1 year ago

1 year ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

1.0.0-pr706.8fe0e466c

3 years ago

1.0.0-pr706.5d63815ad

3 years ago

1.0.0-pr706.d0b3ea524

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

0.7.3-ci.1577125215.2

4 years ago

0.7.3-ci.1576395303.1

4 years ago

0.7.2

4 years ago

0.7.2-ci.1575994466.3

4 years ago

0.7.2-ci.1575982835.2

4 years ago

0.7.0

4 years ago

0.6.5

4 years ago

0.6.4

4 years ago

0.6.4-ci.1573124774.1

4 years ago

0.6.3

5 years ago

0.6.2

5 years ago

0.6.1

5 years ago

0.6.1-ci.1570418446.8

5 years ago

0.6.1-ci.1570407282.7

5 years ago

0.6.1-ci.1570320842.7

5 years ago

0.6.1-ci.1570234430.7

5 years ago

0.6.1-ci.1570148094.7

5 years ago

0.6.1-ci.1570061667.7

5 years ago

0.6.1-ci.1569975306.7

5 years ago

0.6.1-ci.1569888857.7

5 years ago

0.6.1-ci.1569840847.7

5 years ago

0.6.0

5 years ago

0.5.1-ci.1569399527.2

5 years ago

0.5.0

5 years ago

0.4.2-ci.1569229282.9

5 years ago

test-keyboard

The problem

This solution

Installation

Keyboard.create - (params: KeyboardConstructorParams) => Keyboard

KeyboardConstructorParams

Acknowledgements

`Keyboard.create` - `(params: KeyboardConstructorParams) => Keyboard`

`KeyboardConstructorParams`