-
Notifications
You must be signed in to change notification settings - Fork 205
Pointer events tutorial #732
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.
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
Open
dfreedm
wants to merge
2
commits into
main
Choose a base branch
from
pointer-events-tutorial
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
16 changes: 16 additions & 0 deletions
16
packages/lit-dev-content/samples/tutorials/pointer-events/00/before/index.html
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| <!DOCTYPE html> | ||
| <html> | ||
| <head> | ||
| <script type="module" src="my-element.js"></script> | ||
| <style> | ||
| body { | ||
| font-family: 'Open Sans', sans-serif; | ||
| font-size: 1.5em; | ||
| padding-left: 0.5em; | ||
| } | ||
| </style> | ||
| </head> | ||
| <body> | ||
| <my-element></my-element> | ||
| </body> | ||
| </html> |
34 changes: 34 additions & 0 deletions
34
packages/lit-dev-content/samples/tutorials/pointer-events/00/before/my-element.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| import {LitElement, html, css} from 'lit'; | ||
| import {customElement, state} from 'lit/decorators.js'; | ||
|
|
||
| @customElement('my-element') | ||
| class MyElement extends LitElement { | ||
| @state() log = ''; | ||
|
|
||
| static styles = [css` | ||
| div { | ||
| height: 100px; | ||
| width: 100px; | ||
| background: grey; | ||
| touch-action: none; | ||
| text-align: middle; | ||
| vertical-align: middle; | ||
| } | ||
| `]; | ||
|
|
||
| render() { | ||
| return html` | ||
| <div id="block" | ||
| @pointerdown=${this.handleEvent} | ||
| @pointerup=${this.handleEvent} | ||
| @pointerenter=${this.handleEvent} | ||
| @pointerleave=${this.handleEvent} | ||
| >Touch Here</div> | ||
| <pre>${this.log}</pre> | ||
| `; | ||
| } | ||
|
|
||
| handleEvent(ev: PointerEvent) { | ||
| this.log += `${ev.type} from pointer ${ev.pointerId}\n`; | ||
| } | ||
| } |
7 changes: 7 additions & 0 deletions
7
packages/lit-dev-content/samples/tutorials/pointer-events/00/before/project.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| { | ||
| "extends": "/samples/base.json", | ||
| "files": { | ||
| "my-element.ts": {}, | ||
| "index.html": {} | ||
| } | ||
| } |
16 changes: 16 additions & 0 deletions
16
packages/lit-dev-content/samples/tutorials/pointer-events/01/before/index.html
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| <!DOCTYPE html> | ||
| <html> | ||
| <head> | ||
| <script type="module" src="my-element.js"></script> | ||
| <style> | ||
| body { | ||
| font-family: 'Open Sans', sans-serif; | ||
| font-size: 1.5em; | ||
| padding-left: 0.5em; | ||
| } | ||
| </style> | ||
| </head> | ||
| <body> | ||
| <my-element></my-element> | ||
| </body> | ||
| </html> |
35 changes: 35 additions & 0 deletions
35
packages/lit-dev-content/samples/tutorials/pointer-events/01/before/my-element.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| import {LitElement, html, css} from 'lit'; | ||
| import {customElement, state} from 'lit/decorators.js'; | ||
|
|
||
| @customElement('my-element') | ||
| class MyElement extends LitElement { | ||
| @state() log = ''; | ||
|
|
||
| static styles = [css` | ||
| div { | ||
| height: 100px; | ||
| width: 100px; | ||
| background: grey; | ||
| touch-action: none; | ||
| text-align: middle; | ||
| vertical-align: middle; | ||
| } | ||
| `]; | ||
|
|
||
| render() { | ||
| return html` | ||
| <div id="block" | ||
| @pointerdown=${this.handleEvent} | ||
| @pointerup=${this.handleEvent} | ||
| @pointermove=${this.handleEvent} | ||
| @pointerenter=${this.handleEvent} | ||
| @pointerleave=${this.handleEvent} | ||
| >Touch Here</div> | ||
| <pre>${this.log}</pre> | ||
| `; | ||
| } | ||
|
|
||
| handleEvent(ev: PointerEvent) { | ||
| this.log += `${ev.type} from pointer ${ev.pointerId}\n`; | ||
| } | ||
| } | ||
7 changes: 7 additions & 0 deletions
7
packages/lit-dev-content/samples/tutorials/pointer-events/01/before/project.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| { | ||
| "extends": "/samples/base.json", | ||
| "files": { | ||
| "my-element.ts": {}, | ||
| "index.html": {} | ||
| } | ||
| } |
16 changes: 16 additions & 0 deletions
16
packages/lit-dev-content/samples/tutorials/pointer-events/02/before/index.html
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| <!DOCTYPE html> | ||
| <html> | ||
| <head> | ||
| <script type="module" src="my-element.js"></script> | ||
| <style> | ||
| body { | ||
| font-family: 'Open Sans', sans-serif; | ||
| font-size: 1.5em; | ||
| padding-left: 0.5em; | ||
| } | ||
| </style> | ||
| </head> | ||
| <body> | ||
| <my-element></my-element> | ||
| </body> | ||
| </html> |
40 changes: 40 additions & 0 deletions
40
packages/lit-dev-content/samples/tutorials/pointer-events/02/before/my-element.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| import {LitElement, html, css} from 'lit'; | ||
| import {customElement, state} from 'lit/decorators.js'; | ||
|
|
||
| @customElement('my-element') | ||
| class MyElement extends LitElement { | ||
| @state() log = ''; | ||
|
|
||
| static styles = [css` | ||
| div { | ||
| height: 100px; | ||
| width: 100px; | ||
| background: grey; | ||
| touch-action: none; | ||
| text-align: middle; | ||
| vertical-align: middle; | ||
| } | ||
| `]; | ||
|
|
||
| render() { | ||
| return html` | ||
| <div id="block" | ||
| @pointerdown=${this.handleEvent} | ||
| >Touch Here</div> | ||
| <pre>${this.log}</pre> | ||
| `; | ||
| } | ||
|
|
||
| handleEvent(ev: PointerEvent) { | ||
| const props = new Set([ | ||
| 'x', 'y', 'pointerId', 'pointerType', 'isPrimary', 'pressure', 'tiltX', 'tiltY', 'width', 'height', 'twist', 'buttons' | ||
| ]); | ||
| const copy: {[key: string]: unknown} = {}; | ||
| for (let key in ev) { | ||
| if (props.has(key)) { | ||
| copy[key] = (ev as any)[key]; | ||
| } | ||
| } | ||
| this.log = JSON.stringify(copy, null, 2); | ||
| } | ||
| } |
7 changes: 7 additions & 0 deletions
7
packages/lit-dev-content/samples/tutorials/pointer-events/02/before/project.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| { | ||
| "extends": "/samples/base.json", | ||
| "files": { | ||
| "my-element.ts": {}, | ||
| "index.html": {} | ||
| } | ||
| } |
16 changes: 16 additions & 0 deletions
16
packages/lit-dev-content/samples/tutorials/pointer-events/03/before/index.html
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| <!DOCTYPE html> | ||
| <html> | ||
| <head> | ||
| <script type="module" src="my-element.js"></script> | ||
| <style> | ||
| body { | ||
| font-family: 'Open Sans', sans-serif; | ||
| font-size: 1.5em; | ||
| padding-left: 0.5em; | ||
| } | ||
| </style> | ||
| </head> | ||
| <body> | ||
| <my-element></my-element> | ||
| </body> | ||
| </html> |
64 changes: 64 additions & 0 deletions
64
packages/lit-dev-content/samples/tutorials/pointer-events/03/before/my-element.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,64 @@ | ||
| import {LitElement, html, css} from 'lit'; | ||
| import {customElement, state, query} from 'lit/decorators.js'; | ||
|
|
||
| @customElement('my-element') | ||
| class MyElement extends LitElement { | ||
| @state() log = ''; | ||
| @state() enableMouseCapturing = false; | ||
| @state() disableTouchCapturing = false; | ||
| @query('#mousecapture') mouseCheckbox!: HTMLInputElement; | ||
| @query('#touchcapture') touchCheckbox!: HTMLInputElement; | ||
| @query('#block') target!: HTMLElement; | ||
|
|
||
| static styles = [css` | ||
| div { | ||
| height: 100px; | ||
| width: 100px; | ||
| background: grey; | ||
| user-select: none; | ||
| touch-action: none; | ||
| } | ||
| label { | ||
| font-size: 1rem; | ||
| } | ||
| `]; | ||
|
|
||
| render() { | ||
| return html` | ||
| <label>Capture Mouse Pointer <input type="checkbox" id="mousecapture" @change=${this.setCapturing}></label> | ||
| <br> | ||
| <label>Release Touch Pointer <input type="checkbox" id="touchcapture" @change=${this.setTouchCapturing}></label> | ||
| <div | ||
| id="block" | ||
| @pointerdown=${this.handlePointer} | ||
| @pointermove=${this.handlePointer} | ||
| @pointerup=${this.handlePointer} | ||
| @pointercancel=${this.handlePointer} | ||
| >Touch Here</div> | ||
| <pre>${this.log}</pre> | ||
| `; | ||
| } | ||
|
|
||
| setCapturing() { | ||
| this.enableMouseCapturing = this.mouseCheckbox.checked; | ||
| } | ||
|
|
||
| setTouchCapturing() { | ||
| this.disableTouchCapturing = this.touchCheckbox.checked; | ||
| } | ||
|
|
||
| handlePointer(ev: PointerEvent) { | ||
| const {type: eventType, x, y, buttons, isPrimary, pointerId, pointerType} = ev; | ||
| // ignore mousemoves without holding a button and multiple fingers | ||
| if (!isPrimary || eventType === 'pointermove' && buttons === 0) { | ||
| return; | ||
| } | ||
| if (this.enableMouseCapturing && eventType === 'pointerdown' && pointerType !== 'touch') { | ||
| this.target.setPointerCapture(pointerId); | ||
| } | ||
| if (this.disableTouchCapturing && eventType === 'pointerdown' && pointerType === 'touch' ) { | ||
| this.target.releasePointerCapture(pointerId); | ||
| } | ||
| this.log = `${eventType} (${Math.round(x)}px, ${Math.round(y)}px)`; | ||
| } | ||
| } |
7 changes: 7 additions & 0 deletions
7
packages/lit-dev-content/samples/tutorials/pointer-events/03/before/project.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| { | ||
| "extends": "/samples/base.json", | ||
| "files": { | ||
| "my-element.ts": {}, | ||
| "index.html": {} | ||
| } | ||
| } |
16 changes: 16 additions & 0 deletions
16
packages/lit-dev-content/samples/tutorials/pointer-events/04/before/index.html
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| <!DOCTYPE html> | ||
| <html> | ||
| <head> | ||
| <script type="module" src="my-element.js"></script> | ||
| <style> | ||
| body { | ||
| font-family: 'Open Sans', sans-serif; | ||
| font-size: 1.5em; | ||
| padding-left: 0.5em; | ||
| } | ||
| </style> | ||
| </head> | ||
| <body> | ||
| <my-element></my-element> | ||
| </body> | ||
| </html> |
68 changes: 68 additions & 0 deletions
68
packages/lit-dev-content/samples/tutorials/pointer-events/04/before/my-element.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| import {LitElement, html, css} from 'lit'; | ||
| import {customElement, state, query} from 'lit/decorators.js'; | ||
| import { styleMap } from 'lit/directives/style-map.js'; | ||
| import { repeat } from 'lit/directives/repeat.js'; | ||
|
|
||
| const TOUCH_ACTIONS = [ | ||
| 'auto', | ||
| 'none', | ||
| 'pan-left', | ||
| 'pan-right', | ||
| 'pan-x', | ||
| 'pan-up', | ||
| 'pan-down', | ||
| 'pan-y', | ||
| 'pinch-zoom', | ||
| 'manipulation' | ||
| ]; | ||
|
|
||
| @customElement('my-element') | ||
| class MyElement extends LitElement { | ||
| @query('select') select!: HTMLSelectElement; | ||
| @state() touchAction = 'auto'; | ||
| @state() log = ''; | ||
|
|
||
| static styles = [css` | ||
| div { | ||
| height: 150vh; | ||
| width: 150vw; | ||
| background: linear-gradient(to bottom right, #91ffff, #324fff); | ||
| user-select: none; | ||
| } | ||
| span { | ||
| font-size: 1rem; | ||
| } | ||
| pre { | ||
| position: fixed; | ||
| } | ||
| `]; | ||
|
|
||
| render() { | ||
| return html` | ||
| <span>Touch action setting</span> | ||
| <select @change=${this.setTouchAction}> | ||
| ${repeat(TOUCH_ACTIONS, (action) => html`<option>${action}</option>`)} | ||
| </select> | ||
| <br> | ||
| <br> | ||
| <div | ||
| id="block" | ||
| style=${styleMap({'touch-action': this.touchAction})} | ||
| @pointermove=${this.handlePointer} | ||
| @pointercancel=${this.handlePointer} | ||
| ><pre>${this.log}</pre></div> | ||
| `; | ||
| } | ||
|
|
||
| setTouchAction() { | ||
| this.touchAction = this.select.value; | ||
| } | ||
|
|
||
| handlePointer(ev: PointerEvent) { | ||
| const {type, x, y, buttons} = ev; | ||
| if (type === 'pointermove' && buttons === 0) { | ||
| return; | ||
| } | ||
| this.log = `${type} (${x}px, ${y}px)`; | ||
| } | ||
| } |
7 changes: 7 additions & 0 deletions
7
packages/lit-dev-content/samples/tutorials/pointer-events/04/before/project.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| { | ||
| "extends": "/samples/base.json", | ||
| "files": { | ||
| "my-element.ts": {}, | ||
| "index.html": {} | ||
| } | ||
| } |
1 change: 1 addition & 0 deletions
1
packages/lit-dev-content/samples/tutorials/pointer-events/description.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| Learn how to handle PointerEvents with Lit. |
24 changes: 24 additions & 0 deletions
24
packages/lit-dev-content/samples/tutorials/pointer-events/tutorial.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| { | ||
| "header": "Pointer Events", | ||
| "difficulty": "Beginner", | ||
| "size": "small", | ||
| "duration": 10, | ||
| "category": "Learn", | ||
| "steps": [ | ||
| { | ||
| "title": "Intro to Pointer Events" | ||
| }, | ||
| { | ||
| "title": "Event Types" | ||
| }, | ||
| { | ||
| "title": "Pointer Event Properties" | ||
| }, | ||
| { | ||
| "title": "Pointer Capturing" | ||
| }, | ||
| { | ||
| "title": "Controlling scrolling with touch-action" | ||
| } | ||
| ] | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd suggest some playground folds here to hide things like styling and focus the reader's attention on the parts that matter