# lal-lrud

> A React library for managing focus in TV apps. Fork of @please/lrud

Latest version **0.0.29** (published 2023-05-31) · MIT license · 0 weekly downloads

## Install

```sh
npm install lal-lrud
pnpm add lal-lrud
yarn add lal-lrud
bun add lal-lrud
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.29 |
| Published | 2023-05-31 |
| First published | 2023-03-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 1004.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | James Please |
| Maintainers | abhisheklalnediya |
| Keywords | lrud, tv, react, component, navigation, focus, remote |

## Links

- npm: https://www.npmjs.com/package/lal-lrud
- Repository: https://github.com/abhisheklalnediya/lrud
- Homepage: https://github.com/abhisheklalnediya/lrud#readme
- Issues: https://github.com/abhisheklalnediya/lrud/issues
- npm.io page: https://npm.io/package/lal-lrud

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 0.0.29 (latest) — 2023-05-31
- 0.0.28 — 2023-03-07
- 0.0.27 — 2023-03-06
- 0.0.25 — 2023-03-06
- 0.0.24 — 2023-03-06

## README

# lrud

A React library for managing focus in LRUD applications, A Fork of `@please/lrud`


## Guide

Refer parent Library (https://www.npmjs.com/package/@please/lrud)

### Basic Setup

Render the `FocusRoot` high up in your application's component tree.

```jsx
import { FocusRoot } from '@please/lrud';

export default function App() {
  return (
    <FocusRoot>
      <AppContents />
    </FocusRoot>
  );
}
```

You may then use FocusNode components to create a focusable elements on the page.

```jsx
import { FocusNode } from '@please/lrud';

export default function Profile() {
  return <FocusNode className="profile">Profile</FocusNode>;
}
```

This library automatically moves the focus between the FocusNodes as the user inputs
LRUD commands on their keyboard or remote control.

This behavior can be configured through the props of the FocusNode component. To
learn more about those props, refer to the API documentation below.

### Getting Started

The recommended way to familiarize yourself with this library is to begin by looking at the [examples](#examples). The examples
do a great job at demonstrating the kinds of interfaces you can create with this library using little code.

Once you've checked out a few examples you should be in a better position to read through these API docs!

### FAQ

#### What is LRUD?

LRUD is an acronym that stands for left-right-up-down, and it refers to the directional buttons typically found on remotes. In LRUD systems,
input devices usually also have some kind of "submit" button, and, less commonly, a back button.

## API Reference

This section of the documentation describes the library's named exports.

### `<FocusRoot />`

Serves as the root node of a new focus hierarchy. There should only ever be one `FocusRoot` in each application.

All props are optional.

| Prop            | Type    | Default value  | Description                                                                                             |
| --------------- | ------- | -------------- | ------------------------------------------------------------------------------------------------------- |
| `orientation`   | string  | `'horizontal'` | Whether the children of the root node are arranged horizontally or vertically.                          |
| `wrapping`      | boolean | `false`        | Set to `true` for the navigation to wrap when the user reaches the start or end of the root's children. |
| `pointerEvents` | boolean | `false`        | Set to `true` to enable pointer events. [Read the guide.](./guides/pointer-events.md) |
| `throttle`      | number  | 0              | Set the throttle wait for the long press of keys                                      |

---
_Source: https://npm.io/package/lal-lrud · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._