Version bump, changelog, strict values for Direction

Author: asgvard

CHANGELOG.md

@@ -4,6 +4,19 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+# [2.0.0]
+## Added
+- New property for `useFocusable` - `focusBoundaryDirections`, array of directions to block when `isFocusBoundary` is enabled
+- New property `useFocusable` - `forceFocus` to mark the component to be the target for auto-restore focus logic when focus is lost
+- New global method `doesFocusableExist` to check if the focusable component exists before setting focus on it. Safety feature
+
+## Changed
+- [BREAKING] Top level exports `setFocus, getCurrentFocusKey, navigateByDirection, pause, resume, updateAllLayouts` are now exported from `SpatialNavigation` instead of `useFocusable` hook.
+
+## Fixed
+- Context display name is now called `FocusContext` in React Devtools
+- Updating `lastFocusedChildKey` for newly added parent components
+
 # [1.3.3]
 ## Fixed
 - Fixed the issue where component would have kept itself in the array of `parentsHavingFocusedChild` array after removal

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@noriginmedia/norigin-spatial-navigation",
-  "version": "1.3.3",
+  "version": "2.0.0",
   "description": "React hooks based Spatial Navigation solution",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package.json

@@ -17,6 +17,8 @@ const DIRECTION_UP = 'up';
 const DIRECTION_DOWN = 'down';
 const KEY_ENTER = 'enter';
 
+export type Direction = 'up' | 'down' | 'left' | 'right';
+
 const DEFAULT_KEY_MAP = {
   [DIRECTION_LEFT]: [37],
   [DIRECTION_UP]: [38],
@@ -75,7 +77,7 @@ interface FocusableComponent {
   preferredChildFocusKey?: string;
   focusable: boolean;
   isFocusBoundary: boolean;
-  focusBoundaryDirections?: string[];
+  focusBoundaryDirections?: Direction[];
   autoRestoreFocus: boolean;
   forceFocus: boolean;
   lastFocusedChildKey?: string;
@@ -88,7 +90,7 @@ interface FocusableComponentUpdatePayload {
   preferredChildFocusKey?: string;
   focusable: boolean;
   isFocusBoundary: boolean;
-  focusBoundaryDirections?: string[];
+  focusBoundaryDirections?: Direction[];
   onEnterPress: (details?: KeyPressDetails) => void;
   onEnterRelease: () => void;
   onArrowPress: (direction: string, details: KeyPressDetails) => boolean;

src/SpatialNavigation.ts

@@ -12,7 +12,8 @@ import {
   SpatialNavigation,
   FocusableComponentLayout,
   FocusDetails,
-  KeyPressDetails
+  KeyPressDetails,
+  Direction
 } from './SpatialNavigation';
 import { useFocusContext } from './useFocusContext';
 
@@ -48,7 +49,7 @@ export interface UseFocusableConfig<P = object> {
   autoRestoreFocus?: boolean;
   forceFocus?: boolean;
   isFocusBoundary?: boolean;
-  focusBoundaryDirections?: string[];
+  focusBoundaryDirections?: Direction[];
   focusKey?: string;
   preferredChildFocusKey?: string;
   onEnterPress?: EnterPressHandler<P>;