npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@solid-aria/focus

v0.1.4

Published

Primitives for dealing with focus rings and focus management.

Downloads

6,107

Readme

@solid-aria/focus

pnpm turborepo size version stage

Primitives for dealing with focus rings and focus management.

  • createFocusable - Make an element focusable, capable of auto focus and excludable from tab order.
  • createFocusRing - Determines whether a focus ring should be shown to indicate keyboard focus.
  • FocusScope - Utility component that can be used to manage focus for its descendants.

Installation

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

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.

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, createRadioGroup, and createSwitch 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.

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 file.