Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix typos in mouse/README.md #288

Merged
merged 2 commits into from
Jan 21, 2023
Merged

Fix typos in mouse/README.md #288

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4b507d1
Fix typos in mouse/README.md
sindreij Jan 21, 2023
7eb22f9
Fix more typos
sindreij Jan 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions packages/mouse/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ A collection of primitives, capturing current mouse cursor position, and helping

##### Non-reactive primitives:

- [`makeMousePositionListener`](#makeMousePositionListener) - Attaches event listeners to provided targat, listeneing for changes to the mouse/touch position.
- [`makeMouseInsideListener`](#makeMouseInsideListener) - Attaches event listeners to provided targat, listening for mouse/touch entering/leaving the element.
- [`makeMousePositionListener`](#makeMousePositionListener) - Attaches event listeners to provided target, listening for changes to the mouse/touch position.
- [`makeMouseInsideListener`](#makeMouseInsideListener) - Attaches event listeners to provided target, listening for mouse/touch entering/leaving the element.

##### Calculations:

Expand All @@ -37,7 +37,7 @@ yarn add @solid-primitives/mouse

## `createMousePosition`

Attaches event listeners to provided targat, providing a reactive up-to-date position of the cursor on the page.
Attaches event listeners to provided target, providing a reactive up-to-date position of the cursor on the page.

#### Usage

Expand Down Expand Up @@ -65,7 +65,7 @@ By default `createMousePosition` is listening to `touch` events as well. You can
// disables following touch position – only registers touch start
const pos = createMousePosition(window, { followTouch: false });

// disables listeneing to any touch events
// disables listening to any touch events
const pos = createMousePosition(window, { touch: false });
```

Expand Down Expand Up @@ -131,7 +131,7 @@ function createPositionToElement(

###### Added id `@2.0.0`

Attaches event listeners to provided targat, listeneing for changes to the mouse/touch position.
Attaches event listeners to provided target, listening for changes to the mouse/touch position.

```ts
const clear = makeMousePositionListener(el, pos => console.log(pos), { touch: false });
Expand All @@ -143,7 +143,7 @@ clear();

###### Added id `@2.0.0`

Attaches event listeners to provided targat, listening for mouse/touch entering/leaving the element.
Attaches event listeners to provided target, listening for mouse/touch entering/leaving the element.

```ts
const clear = makeMouseInsideListener(el, inside => console.log(inside), { touch: false });
Expand Down