Focus Navigation

CI Build Status Documentation
 
## Overview Focus Navigation is a collection of libraries used to build UI that can be navigated using directional input, like a gamepad or keyboard, in a more feature-rich way. The word "focus" in this library can be thought of as an expansion upon the existing concept of "selection". Some common uses include: * Easier keybinds and callback mappings * Custom behavior for containers when selection enters their UI tree * Managing logic for the currently selected object * Detecting what input method the user is utilizing ...and more! ## General Use The primary public interface for this library is through [React](https://github.com/Roblox/react-lua) via [ReactFocusNavigation](https://roblox.github.io/focus-navigation-internal/api-reference/react-focus-navigation), but non-React helpers are also provided in [FocusNavigation](https://roblox.github.io/focus-navigation-internal/api-reference/focus-navigation). Most features built using this library will use one of these options combined with [InputHandlers](https://roblox.github.io/focus-navigation-internal/api-reference/input-handlers) to manage keybinds and callbacks. ## Installation The Focus Navigation library can be installed via [Rotriever](https://github.com/roblox/rotriever). Add the following to the `rotriever.toml` file for your project: ```toml ReactFocusNavigation = "github.com/roblox/focus-navigation-internal@2.0.0" ``` Optionally, you may wish to include the [`InputHandlers`](https://roblox.github.io/focus-navigation-internal/api-reference/input-handlers) utility library as well: ```toml InputHandlers = "github.com/roblox/focus-navigation-internal@2.0.0" ``` ## Documentation Documentation for Focus Navigation is available on [the official documentation website](https://roblox.github.io/focus-navigation-internal). ## License Licensed under the [MIT License](http://opensource.org/licenses/MIT) — see [LICENSE.txt](LICENSE.txt). ### Contribution Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the MIT license, shall be licensed as above, without any additional terms or conditions. Take a look at the [contributing guide](CONTRIBUTING.md) for guidelines on how to contribute to Focus Navigation.