Spatial navigation and focus management for TVs and gaming consoles done simple. Uses react-sunbeam 🌅 under the hood.
Provides three easy to use code components.
- Drag them onto your canvas
- Connect them to their content (
Framesor any other code components) - Specify the child property to update on focus for every
Focusable - Drop your
Focusables into the SunbeamScrollcomponent if you need scrolling behaviour - Run the preview of the
FramecontainingSunbeamContainer - Press arrow keys on your keyboard/gamepad/tv remote
- Enjoy spatial navigation magic happen
You can check out the example project that demonstrates how to set up Framer Sunbeam here.
Creates a focus management context.
Connect it to the Frame within which you want focus to be managed
You can only have one SunbeamContainer per artboard
Allows to override the default spacial navigation keys. See the full list of available key codes here
Allows to invoke some function when a keyboard key is pressed. Can be provided via code overrides.
Allows to invoke a function when the focus is updated. An event object containing the new focusPath is passed to this callback.
Can be provided via code overrides.
getPreferredChildOnFocusReceive?: (args: { focusableChildren: Map<string, FocusableTreeNode>; focusOrigin?: FocusableTreeNode; direction?: Direction; }) => FocusableTreeNode | undefined
Allows to override the default heuristic of focusing a focusable child when receiving focus. Can be provided via code overrides. Example:
import { Override } from "framer"
import { defaultGetPreferredChildOnFocusReceive } from "@framer/vladimirg.framersunbeam/code"
function FocusableContainerOverride(): Override {
return {
getPreferredChildOnFocusReceive({
focusableChildren,
focusOrigin,
direction,
}) {
// Initial load, when there is no previous focused element
if (!focusOrigin && !direction) {
// pick the child with a specific focusKey
return focusableChildren.get("my-preferred-child-focus-key")
}
// use default strategy otherwise
return defaultGetPreferredChildOnFocusReceive({
focusableChildren,
focusOrigin,
direction,
})
},
}
}Defines a component that can receive focus.
Connect it to a content component (Frame or any other code/design component).
Most of the time you want the size of the Focusable to match the size of its child content because when calculating the best candidate for receiving focus Sunbeam uses position and dimensions of the Focusable, not its content
You can nest Focusables, in this case the best candidate for the focus is first attempted to be found within the same Focusable parent.
This is useful when creating sections of the UI, e.g. Side Menu where the Focusable items are not necessarily positioned to each other closer than to the items from the Main section
Set to a randomly generated string by default.
Identifier of a Focusable. Has to be unique among the Focusable siblings
Set to false by default.
Specifies if the Focusable should receive focus when tapped/clicked
Name of the child prop that will be updated when Focusable receives/loses focus.
E.g. if you are wrapping a Frame you can find the list of the props available to you here
Type of focusProp
Focused value - focusedValueString?: string or focusedValueBoolean?: boolean or focusedValueNumber?: number or focusedValueColor?: string
Value that is passed to the child's prop when the Focusable is focused
Blurred value - blurredValueString?: string or blurredValueBoolean?: boolean or blurredValueNumber: number or blurredValueColor: string
Value that is passed to the child's prop when the Focusable is blurred
Function that is called when the Focusable receives focus.
Can be provided via code overrides.
Can be useful for saving the focus state or reacting to the focus updates, e.g. manual scrolling to the focused component
Function that is called when the Focusable loses focus.
Can be provided via code overrides.
Function that is called when the Focusable is focused and a key is pressed.
If event.stopPropagation() is called inside the function the onKeyPress handlers
of the parent and other focusable ancestors won't be called
Can be provided via code overrides.
getPreferredChildOnFocusReceive?: (args: { focusableChildren: Map<string, FocusableTreeNode>; focusOrigin?: FocusableTreeNode; direction?: Direction; }) => FocusableTreeNode | undefined
Allows to override the default heuristic of focusing a focusable child when receiving focus. Can be provided via code overrides. Example:
import { Override } from "framer"
import { defaultGetPreferredChildOnFocusReceive } from "@framer/vladimirg.framersunbeam/code"
function FocusableContainerOverride(): Override {
return {
getPreferredChildOnFocusReceive({
focusableChildren,
focusOrigin,
direction,
}) {
// Initial load, when there is no previous focused element
if (!focusOrigin && !direction) {
// pick the child with a specific focusKey
return focusableChildren.get("my-preferred-child-focus-key")
}
// use default strategy otherwise
return defaultGetPreferredChildOnFocusReceive({
focusableChildren,
focusOrigin,
direction,
})
},
}
}Mimics the behaviour of the Framer built-in Scroll component, but it is aware
of the currently focused Focusable child and automatically scrolls it into view when needed.
This component is useful for creating scrollable carousels and grids of Focusable components
Specifies whether the content overflowing the Scroll viewport should be visible or not
The allowed direction of scrolling
Controls the scrolling behaviour when the focused Focusable is taller than the viewport of the Scroll.
- The default
"auto"mode aligns theFocusable's top edge with the viewport's top when scrolling down, and the bottom edge with the viewport's bottom when scrolling up. - The
"top"mode always aligns theFocusable's top edge with the viewport's top disregarding of the scrolling direction. - The
"bottom"mode always aligns theFocusable's bottom edge with the viewport's bottom disregarding of the scrolling direction.
Controls the scrolling behaviour when the focused Focusable is wider than the viewport of the Scroll.
- The default
"auto"mode aligns theFocusable's left edge with the viewport's left when scrolling to the right, and the right edge with the viewport's right when scrolling to the left. - The
"left"mode always aligns theFocusable's left edge with the viewport's left disregarding of the scrolling direction. - The
"right"mode always aligns theFocusable's right edge with the viewport's right disregarding of the scrolling direction.
Transition - transition: { type: "spring", damping: number, stiffness: number } | { type: "tween", duration: number, easing: string } - default { type: "spring", damping: 40, stiffness: 300 }
The transition to use for the scrolling animation.
Framer Sunbeam re-exports some of the react-sunbeam 🌅 primitives and other helper functions, so you can use them directly in you code to create your own custom focusable components without connecting a Focusable to another component on canvas.
You can implement your own focusable Button like this:
import * as React from "react"
import { addPropertyControls, ControlType } from "framer"
import { useFocusable } from "@framer/vladimirg.framersunbeam/code"
addPropertyControls(Button, {
focusKey: {
type: ControlType.String,
defaultValue: "CHANGE THIS TO A UNIQUE VALUE",
},
})
export function Button({ focusKey, width, height }) {
const ref = React.useRef(null)
const { focused } = useFocusable(focusKey, ref, {
onKeyPress: event => {
if (event.key === "Enter") {
console.log('"Enter" was pressed while the button is focused')
// prevent event bubbling to the parent
event.stopPropagation()
}
},
onFocus: () => {
console.log(`${focusKey} was focused`)
},
})
return (
<button
ref={ref}
style={{
width,
height,
border: focused ? "2px solid tomato" : "none",
}}
>
Go
</button>
)
}In the example above we are using the useFocusable hook that allows to programmatically declare the current component
as "focusable" and use its focus state to change the rendering. While being convenient, useFocusable only allows to declare
a "leaf" focusable, so a node that cannot have any focusable children. Should you need the latter, use Focusable component instead.
import * as React from "react"
import { addPropertyControls, ControlType } from "framer"
import { Focusable } from "@framer/vladimirg.framersunbeam/code"
addPropertyControls(Button, {
focusKey: {
type: ControlType.String,
defaultValue: "CHANGE THIS TO A UNIQUE VALUE",
},
})
export function Button({ focusKey, width, height, children }) {
return (
<Focusable
focusableKey={focusKey}
style={{ width, height }}
onKeyPress={event => {
if (event.key === "Enter") {
console.log(
'"Enter" was pressed while the button is focused'
)
// prevent event bubbling to the parent
event.stopPropagation()
}
}}
onFocus={() => {
console.log(`${focusKey} was focused`)
}}
>
{({ focused }) => (
<button
style={{
width,
height,
border: focused ? "2px solid tomato" : "none",
}}
>
{/* children can contain other focusable nodes */}
{children}
</button>
)}
</Focusable>
)
}- 📜 Expose
Scrollcomponent for usage in code. - 🥢 Rename
vertical_stickinessandhorizontal_stickinessprops toverticalStickinessandhorizontalStickiness, respectively.
- 🥢 Add
vertical_stickinessandhorizontal_stickinessprops toScroll. - 🎛 Use
ControlType.Transitioninstead of a set of different property controls for defining the scrolling animation inScroll.
- 🦚 Add EventHandler controls for
onFocus,onBluretc... - 🎬 Slightly improve scrolling performance of
Scroll - ⬆️ Update
react-sunbeamto0.11.0
- 🎩 Introduce
onFocusandonBlurhandlers foruseFocusable
- 🎹 Introduce key press management (
onKeyPresshandler forSunbeamContainer,FocusableanduseFocusable) - ⏫ Upgrade
react-sunbeam -> 0.9.0
- Fix Scroll component when a prototype is scaled
- Expose
SunbeamContainerto use in code - Upgrade
react-sunbeam -> 0.7.0
- Expose
Focusableto use in code - Add commitizen (chore)
- Expose
useOnFocusedChangehook - New
onBlurprop onFocusable
Expose getPreferredChildOnFocusReceive prop for SunbeamContainer and Focusable
Fix Scroll fill
Expose property controls for Scroll's transition
Remove ScrollContext and useOnFocus, instead add the Scroll notification logic to useFocusable
Remove ScrollContext from module export but export it as a global variable SunbeamScrollContext
Export ScrollContext and useOnFocus
Export Focusable, useSunbeam, useFocusable and defaultGetPreferredChildOnFocusReceive so those can be used
directly in your custom code components.
Add onKeyPress and onFocusUpdate props to SunbeamContainer
Proudly introducing the new component - Scroll 🎉.
It mimics the behaviour of the Framer built-in Scroll component but it is aware of the currently focused Focusable
and automatically scrolls it into view
BREAKING CHANGE: onFocus callback now accepts an object of type { element: HTMLElement; focusablePath: string[] } as an argument, before it was a string focusablePath