@solid-aria/focus
Version:
Primitives for dealing with focus rings and focus management.
135 lines (100 loc) • 5.1 kB
Markdown
<p>
<img width="100%" src="https://assets.solidjs.com/banner?type=Aria&background=tiles&project=Focus" alt="Solid Aria - Focus">
</p>
# @solid-aria/focus
[](https://pnpm.io/)
[](https://turborepo.org/)
[](https://bundlephobia.com/package/@solid-aria/focus)
[](https://www.npmjs.com/package/@solid-aria/focus)
[](https://github.com/solidjs-community/solid-aria#contribution-process)
Primitives for dealing with focus rings and focus management.
- [`createFocusable`](#createFocusable) - Make an element focusable, capable of auto focus and excludable from tab order.
- [`createFocusRing`](#createFocusRing) - Determines whether a focus ring should be shown to indicate keyboard focus.
- [`FocusScope`](#FocusScope) - Utility component that can be used to manage focus for its descendants.
## Installation
```bash
npm install @solid-aria/focus
# or
yarn add @solid-aria/focus
# or
pnpm add @solid-aria/focus
```
## `createFocusable`
Make an element focusable, capable of auto focus and excludable from tab order.
### How to use it
```tsx
import { createFocusable, CreateFocusableProps } from "@solid-aria/focus";
import { JSX, mergeProps } from "solid-js";
type TextFieldProps = JSX.IntrinsicElements["input"] & CreateFocusableProps;
function TextField(props: TextFieldProps) {
let ref: HTMLInputElement | undefined;
const { focusableProps } = createFocusable(props, () => ref);
const inputProps = mergeProps(props, focusableProps);
return <input {...inputProps} ref={ref} />;
}
function App() {
return (
<>
<TextField autofocus />
<TextField excludeFromTabOrder />
</>
);
}
```
## `createFocusRing`
The `createFocusRing` primitive returns whether a focus ring should be displayed to indicate keyboard focus for a component. This helps keyboard users determine which element on a page or in an application has keyboard focus as they navigate around. Focus rings are only visible when interacting with a keyboard so as not to distract mouse and touch screen users.
### How to use it
This example shows how to use `createFocusRing` to adjust styling when keyboard focus is on a button. Specifically, the outline property is used to create the focus ring when `isFocusVisible` is true.
```tsx
import { createFocusRing } from "@solid-aria/focus";
function Example() {
const { isFocusVisible, focusProps } = createFocusRing();
return (
<button
{...focusProps}
style={{
"-webkit-appearance": "none",
appearance: "none",
background: "green",
border: "none",
color: "white",
"font-size": "14px",
padding: "4px 8px",
outline: isFocusVisible() ? "2px solid dodgerblue" : "none",
"outline-offset": "2px"
}}
>
Test
</button>
);
}
```
See [`createCheckbox`](../checkbox/), [`createRadioGroup`](../radio/), and [`createSwitch`](../switch/) for more advanced examples of focus rings with other styling techniques.
## `FocusScope`
A FocusScope manages focus for its descendants. It supports containing focus inside the scope, restoring focus to the previously focused element on unmount, and auto focusing children on mount. It also acts as a container for a programmatic focus management interface that can be used to move focus forward and back in response to user events.
### How to use it
A basic example of a focus scope that contains focus within it. Clicking the "Open" button mounts a FocusScope, which auto focuses the first input inside it. Once open, you can press the `Tab` key to move within the scope, but focus is contained inside. Clicking the "Close" button unmounts the focus scope, which restores focus back to the button.
For a full example of building a modal dialog, see [`createDialog`](../dialog/README.md).
```tsx
import { FocusScope } from "@solid-aria/focus";
import { createSignal, Show } from "solid-js";
function Example() {
const [isOpen, setOpen] = createSignal(false);
return (
<>
<button onClick={() => setOpen(true)}>Open</button>
<Show when={isOpen()}>
<FocusScope contain restoreFocus autofocus>
<label for="first-input">First Input</label>
<input id="first-input" />
<label for="second-input">Second Input</label>
<input id="second-input" />
<button onClick={() => setOpen(false)}>Close</button>
</FocusScope>
</Show>
</>
);
}
```
## Changelog
All notable changes are described in the [CHANGELOG.md](./CHANGELOG.md) file.