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.

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

Adding keyboard navigation and screen reader support for Issue #182 #259

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
20 changes: 20 additions & 0 deletions src/components/bc-currency-switcher.ts
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ export class CurrencySwitcher extends withTwind()(BitcoinConnectElement) {
<div
class="${classes.interactive}"
@click=${this._showSelectVisibility}
@keydown=${this._handleKeydown}
>
<slot></slot>
</div>
Expand All @@ -81,7 +82,10 @@ export class CurrencySwitcher extends withTwind()(BitcoinConnectElement) {
class="${selectedCurrency === currency.value
? 'bg-blue-500 text-white'
: ''} flex items-center justify-center py-2 px-4 hover:text-white hover:bg-blue-500 rounded-lg hover:border-blue-500 cursor-pointer"
tabindex="0"
@click=${() => this._selectCurrency(currency.value)}
@keydown=${(event: KeyboardEvent) =>
this._handleCurrencyKeydown(event, currency.value)}
>
<span class="text-orange-400 inline-block mr-2 text-xl"
>${currency.flag}</span
Expand All @@ -100,6 +104,22 @@ export class CurrencySwitcher extends withTwind()(BitcoinConnectElement) {
store.getState().setCurrency(selectedCurrency);
this._isSwitchingCurrency = false;
}

// Handle keydown events for currency selection
private _handleCurrencyKeydown(event: KeyboardEvent, currency: string) {
if (event.key === 'Enter' || event.key === ' ') {
event.preventDefault();
this._selectCurrency(currency);
}
}

// Handle keydown events for opening the currency list
public _handleKeydown(event: KeyboardEvent) {
if (event.key === 'Enter' || event.key === ' ') {
event.preventDefault();
this._showSelectVisibility();
}
}
}

declare global {
Expand Down
20 changes: 20 additions & 0 deletions src/components/bc-modal-header.ts
Original file line number Diff line number Diff line change
Expand Up @@ -31,15 +31,19 @@ export class ModalHeader extends withTwind()(BitcoinConnectElement) {
${this.showHelp
? html`<div
class="${classes.interactive} ${classes['text-neutral-tertiary']}"
tabindex="0"
@click=${() => store.getState().pushRoute('/help')}
@keydown=${this._handleKeydownHelp}
>
${helpIcon}
</div>`
: null}
${this.closable
? html`<div
class="${classes.interactive} ${classes['text-neutral-tertiary']}"
tabindex="0"
@click=${this._handleClose}
@keydown=${this._handleKeydownClose}
>
${crossIcon}
</div>`
Expand All @@ -54,6 +58,22 @@ export class ModalHeader extends withTwind()(BitcoinConnectElement) {
private _handleClose() {
this.dispatchEvent(new Event('onclose', {bubbles: true, composed: true}));
}

// Handle keyboard interactions for the close button
private _handleKeydownClose(event: KeyboardEvent) {
if (event.key === 'Enter' || event.key === ' ') {
event.preventDefault();
this._handleClose();
}
}

// Handle keyboard interactions for the help button
private _handleKeydownHelp(event: KeyboardEvent) {
if (event.key === 'Enter' || event.key === ' ') {
event.preventDefault();
store.getState().pushRoute('/help');
}
}
}

declare global {
Expand Down
15 changes: 15 additions & 0 deletions src/components/bc-modal.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,14 @@ import {closeModal} from '../api';

@customElement('bc-modal')
export class Modal extends withTwind()(BitcoinConnectElement) {
override firstUpdated() {
window.addEventListener('keydown', this._handleKeydown);
}

override disconnectedCallback() {
window.removeEventListener('keydown', this._handleKeydown);
}

override render() {
return html` <div
class="fixed top-0 left-0 w-full h-full flex justify-center items-end sm:items-center z-[21000]"
Expand All @@ -19,6 +27,7 @@ export class Modal extends withTwind()(BitcoinConnectElement) {
'bg-foreground'
]} animate-darken"
@click=${this._handleClose}
tabindex="0"
></div>
<div
class="transition-all p-4 pt-6 pb-8 rounded-2xl shadow-2xl flex justify-center items-center w-full bg-white dark:bg-black max-w-md max-sm:rounded-b-none
Expand All @@ -32,6 +41,12 @@ export class Modal extends withTwind()(BitcoinConnectElement) {
private _handleClose = () => {
closeModal();
};

public _handleKeydown = (event: KeyboardEvent) => {
if (event.key === 'Escape') {
this._handleClose();
}
};
}

declare global {
Expand Down
9 changes: 9 additions & 0 deletions src/components/bc-navbar.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,9 @@ export class Navbar extends withTwind()(BitcoinConnectElement) {
<div class="absolute left-8 h-full flex items-center justify-center">
<div
class="${classes.interactive} ${classes['text-neutral-tertiary']}"
tabindex="0"
@click=${this._goBack}
@keydown=${this._handleKeydown}
>
${backIcon}
</div>
Expand All @@ -33,6 +35,13 @@ export class Navbar extends withTwind()(BitcoinConnectElement) {
store.getState().popRoute();
store.getState().setError(undefined);
};

public _handleKeydown(event: KeyboardEvent) {
if (event.key === 'Enter' || event.key === ' ') {
event.preventDefault();
this._goBack();
}
}
}

declare global {
Expand Down
9 changes: 9 additions & 0 deletions src/components/bc-start.ts
Original file line number Diff line number Diff line change
Expand Up @@ -74,13 +74,22 @@ export class Start extends withTwind()(BitcoinConnectElement) {
'text-brand-mixed'
]} "
@click=${() => store.getState().pushRoute('/new-wallet')}
@keydown=${this._handleKeydown}
tabindex="0"
>Get one here</a
>
</h1>
</div>
`}
</div>`;
}

public _handleKeydown(event: KeyboardEvent) {
if (event.key === 'Enter' || event.key === ' ') {
event.preventDefault();
store.getState().pushRoute('/new-wallet');
}
}
}

declare global {
Expand Down
10 changes: 10 additions & 0 deletions src/components/connectors/ConnectorElement.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,9 @@ export abstract class ConnectorElement extends withTwind()(
override render() {
return html`<div
class="flex flex-col justify-between items-center w-32 -mx-4 cursor-pointer ${classes.interactive}"
tabindex="0"
@click=${this._onClick}
@keydown=${this._handleKeydown}
>
<div
class="w-16 h-16 drop-shadow rounded-2xl flex justify-center items-center overflow-hidden"
Expand All @@ -48,6 +50,14 @@ export abstract class ConnectorElement extends withTwind()(
</div>`;
}

// Handle keyboard events for accessibility (Enter/Space key triggers click)
public _handleKeydown(event: KeyboardEvent) {
if (event.key === 'Enter' || event.key === ' ') {
event.preventDefault();
this._onClick();
}
}

protected _connect(
config: Omit<ConnectorConfig, 'connectorName' | 'connectorType'>
) {
Expand Down
7 changes: 7 additions & 0 deletions src/components/internal/bci-button.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,11 @@ export class Button extends withTwind()(InternalElement) {
})
block = false;

@property({
type: Number,
})
override tabIndex = 0;

override render() {
const isDarkMode =
window.matchMedia &&
Expand Down Expand Up @@ -57,6 +62,8 @@ export class Button extends withTwind()(InternalElement) {
? `${classes['text-brand-mixed']}`
: `${classes['text-neutral-tertiary']}`}
"
?autofocus="${this.variant === 'primary'}"
tabindex="${this.tabIndex}"
>
${this.ghost
? null
Expand Down
4 changes: 2 additions & 2 deletions src/components/pages/bc-help.ts
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ export class HelpPage extends withTwind()(BitcoinConnectElement) {
target="_blank"
class="${classes['hover-animation']} flex-1"
>
<bci-button>
<bci-button tabIndex=-1>
<span class="${classes['text-brand-mixed']}">Learn more</span>
${linkIcon}
</bci-button>
Expand All @@ -50,7 +50,7 @@ export class HelpPage extends withTwind()(BitcoinConnectElement) {
target="_blank"
class="${classes['hover-animation']} flex-1"
>
<bci-button>
<bci-button tabIndex=-1>
<span class="${classes['text-brand-mixed']}">Use it</span>
${linkIcon}
</bci-button>
Expand Down
12 changes: 11 additions & 1 deletion src/components/pages/bc-send-payment.ts
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ export class SendPayment extends withTwind()(BitcoinConnectElement) {
<div class="mt-8 w-full flex flex-col gap-4">
${this.paymentMethods === 'all' || this.paymentMethods === 'external'
? html`<a href="lightning:${this.invoice}">
<bci-button variant="primary" block>
<bci-button variant="primary" block tabindex="-1">
${walletIcon} Open in a Bitcoin Wallet
</bci-button>
</a>`
Expand Down Expand Up @@ -231,6 +231,8 @@ export class SendPayment extends withTwind()(BitcoinConnectElement) {
</a>
<a
@click=${this._copyInvoice}
@keydown=${this._handleKeydown}
tabindex="0"
class="
flex gap-1
mt-4
Expand Down Expand Up @@ -344,6 +346,14 @@ export class SendPayment extends withTwind()(BitcoinConnectElement) {
}
this._isPaying = false;
}

public _handleKeydown(event: KeyboardEvent) {
if (event.key === 'Enter' || event.key === ' ') {
event.preventDefault();
this._copyInvoice();
}
}

}

declare global {
Expand Down