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

Improve mapper tool accessibility #90

Merged
merged 5 commits into from
Sep 8, 2023
Merged

Improve mapper tool accessibility #90

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
88e6af1
Update lockfile
iansan5653 Sep 8, 2023
d79d8e0
Adjust style and improve copy button
iansan5653 Sep 8, 2023
b183d25
Improve roles for input
iansan5653 Sep 8, 2023
f550448
Add index page
iansan5653 Sep 8, 2023
3058d39
Fix import
iansan5653 Sep 8, 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
29 changes: 29 additions & 0 deletions examples/demo.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
<!doctype html>
<html lang="en">

<head>
<meta charset="utf-8">
<title>hotkey | Demo</title>
</head>

<body>

<button onclick="alert('clicked button 1!')" data-hotkey-scope="text-area-1" data-hotkey="Control+d,Meta+d">press meta+d or ctrl+d in text area 1 to click button 1</button><br>
<textarea id="text-area-1" rows="4" cols="40">text area 1</textarea><br>
<button onclick="alert('clicked button 2!')" data-hotkey-scope="text-area-2" data-hotkey="Control+d,Meta+d">press meta+d or ctrl+d in text area 2 to click button 2</button><br>
<textarea id="text-area-2" rows="4" cols="40">text area 2</textarea><br>
<label><input data-hotkey="t" type="text">Press t to focus this field</label><br>
<label><input data-hotkey="r" type="checkbox">Press r to check/uncheck this checkbox</label><br>
<a href="#ok" data-hotkey="o k">Press <kbd>o k</kbd> click this link</a>

<script type="module">
// import {install} from '../dist/index.js'
import {install} from 'https://unpkg.com/@github/hotkey@latest?module'

for (const el of document.querySelectorAll('[data-hotkey]')) {
install(el)
}
</script>
</body>

</html>
47 changes: 27 additions & 20 deletions examples/hotkey_mapper.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,40 +4,47 @@
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width">
<title>Hotkey Mapper Tool</title>
<title>hotkey | Mapper Tool</title>
<link href="https://unpkg.com/@primer/css@^16.0.0/dist/primer.css" rel="stylesheet" />
<script type="module" src="https://unpkg.com/@github/clipboard-copy-element@latest?module"></script>
<style>
.copy {
/* marg */
}
</style>
</head>

<body>
<div class="blankslate mx-auto col-12 col-md-8 col-lg-6">
<h1>Hotkey Code</h1>
<p>Type your desired key combination on the keyboard to see the corresponding Hotkey string.</p>
<div class="mx-auto my-3 col-12 col-md-8 col-lg-6">
<h1 id="app-name">Hotkey Code</h1>
<p id="hint">Press a key combination to see the corresponding hotkey string.</p>
<div class="position-relative">
<clipboard-copy for="hotkey-code" class="position-absolute top-2 right-2">
<button aria-label="Copy to clipboard" class="btn">
<svg aria-hidden="true" role="img" class="StyledOcticon-uhnt7w-0 iIOaoH" viewBox="0 0 16 16" width="16" height="16" fill="currentColor" style="display:inline-block;user-select:none;vertical-align:text-bottom;overflow:visible"><path fill-rule="evenodd" d="M0 6.75C0 5.784.784 5 1.75 5h1.5a.75.75 0 010 1.5h-1.5a.25.25 0 00-.25.25v7.5c0 .138.112.25.25.25h7.5a.25.25 0 00.25-.25v-1.5a.75.75 0 011.5 0v1.5A1.75 1.75 0 019.25 16h-7.5A1.75 1.75 0 010 14.25v-7.5z"></path><path fill-rule="evenodd" d="M5 1.75C5 .784 5.784 0 6.75 0h7.5C15.216 0 16 .784 16 1.75v7.5A1.75 1.75 0 0114.25 11h-7.5A1.75 1.75 0 015 9.25v-7.5zm1.75-.25a.25.25 0 00-.25.25v7.5c0 .138.112.25.25.25h7.5a.25.25 0 00.25-.25v-7.5a.25.25 0 00-.25-.25h-7.5z"></path></svg>
</button>
<input
role="application"
aria-roledescription="Input Capture"
autofocus
aria-labelledby="app-name"
aria-describedby="hint"
aria-live="assertive"
aria-atomic="true"
id="hotkey-code"
class="border rounded-2 mt-2 p-6 f1 text-mono"
style="width: 100%"
/>

<clipboard-copy for="hotkey-code" class="position-absolute bottom-2 right-2 btn">
Copy to clipboard
</clipboard-copy>
<div id="hotkey-code" class="border rounded-2 p-6 f1 text-mono overflow-auto">&nbsp;</div>
</div>
</div>

<script type="module">
// import {eventToHotkeyString} from '../dist/index.js'
import {eventToHotkeyString} from 'https://unpkg.com/@github/hotkey@latest?module';
const codeInput = document.getElementById('hotkey-code');
document.addEventListener('keydown', event => {
const code = eventToHotkeyString(event);
console.log(`Hotkey Code is: "${code}"`);
codeInput.innerText = code;
import {eventToHotkeyString} from 'https://unpkg.com/@github/hotkey@latest?module'

document.getElementById('hotkey-code').addEventListener('keydown', event => {
if (event.key === "Tab")
return;

event.preventDefault();
event.stopPropagation();

event.currentTarget.value = eventToHotkeyString(event);
})
</script>
</body>
Expand Down
31 changes: 13 additions & 18 deletions examples/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,27 +3,22 @@

<head>
<meta charset="utf-8">
<title>hotkey demo</title>
<meta name="viewport" content="width=device-width">
<title>hotkey</title>
<link href="https://unpkg.com/@primer/css@^16.0.0/dist/primer.css" rel="stylesheet" />
</head>

<body>

<button onclick="alert('clicked button 1!')" data-hotkey-scope="text-area-1" data-hotkey="Control+d,Meta+d">press meta+d or ctrl+d in text area 1 to click button 1</button><br>
<textarea id="text-area-1" rows="4" cols="40">text area 1</textarea><br>
<button onclick="alert('clicked button 2!')" data-hotkey-scope="text-area-2" data-hotkey="Control+d,Meta+d">press meta+d or ctrl+d in text area 2 to click button 2</button><br>
<textarea id="text-area-2" rows="4" cols="40">text area 2</textarea><br>
<label><input data-hotkey="t" type="text">Press t to focus this field</label><br>
<label><input data-hotkey="r" type="checkbox">Press r to check/uncheck this checkbox</label><br>
<a href="#ok" data-hotkey="o k">Press <kbd>o k</kbd> click this link</a>

<script type="module">
// import {install} from '../dist/index.js'
import {install} from 'https://unpkg.com/@github/hotkey@latest?module'

for (const el of document.querySelectorAll('[data-hotkey]')) {
install(el)
}
</script>
<div class="mx-auto my-3 col-12 col-md-8 col-lg-6">
<h1 class="text-mono">@github/hotkey</h1>
<nav>
<ul>
<li><a href="https://github.com/github/hotkey">Repository & docs</a></li>
<li><a href="hotkey_mapper.html">Mapper tool</a></li>
<li><a href="demo.html">Demo</a></li>
</ul>
</nav>
</div>
</body>

</html>
Loading
Loading