Framer Sunbeam

Vladimir Guguiev

Framer Sunbeam

Framer Sunbeam

GitHub issues GitHub contributors Twitter Follow

Spatial navigation and focus management for TVs and gaming consoles done simple. Uses react-sunbeam 🌅 under the hood.

Details

Provides three easy to use code components.

  • Drag them onto your canvas
  • Connect them to their content (Frames or any other code components)
  • Specify the child property to update on focus for every Focusable
  • Drop your Focusables into the Sunbeam Scroll component if you need scrolling behaviour
  • Run the preview of the Frame containing SunbeamContainer
  • Press arrow keys on your keyboard/gamepad/tv remote
  • Enjoy spatial navigation magic happen

Example Project

You can check out the example project that demonstrates how to set up Framer Sunbeam here.

Components and API

  • SunbeamContainer
  • Focusable
  • Scroll
  • Using library in your code components (API)

SunbeamContainer

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

Props

Up key - upKey?: string - default "ArrowUp"
Down key - downKey?: string - default "ArrowDown"
Left key - leftKey?: string - default "ArrowLeft"
Right key - rightKey?: string - default "ArrowRight"

Allows to override the default spacial navigation keys. See the full list of available key codes here

onKeyPress?: (event: KeyboardEvent) => void

Allows to invoke some function when a keyboard key is pressed. Can be provided via code overrides.

onFocusUpdate?: (event: { focusPath: ReadonlyArray<string> }) => void

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,
            })
        },
    }
}

Focusable

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

Props

Key - focusableKey?: string

Set to a randomly generated string by default. Identifier of a Focusable. Has to be unique among the Focusable siblings

Tap to focus - tapToFocus?: boolean

Set to false by default. Specifies if the Focusable should receive focus when tapped/clicked

Focus prop - focusProp?: string

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

Focus prop type - focusPropType?: "string" | "boolean" | "number" | "color"

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

onFocus?: ({ element: HTMLElement; focusablePath: ReadonlyArray<string> }) => void

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

onBlur?: ({ element: HTMLElement; focusablePath: ReadonlyArray<string> }) => void

Function that is called when the Focusable loses focus. Can be provided via code overrides.

onKeyPress?: (event: KeyboardEvent) => void

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,
            })
        },
    }
}

Scroll

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

Props

Overflow - overflow: boolean

Specifies whether the content overflowing the Scroll viewport should be visible or not

Direction - direction: "vertical" | "horizontal" | "both"

The allowed direction of scrolling

↕ Stickiness - vertical_stickiness: "auto" | "top" | "bottom" - default "auto"

Controls the scrolling behaviour when the focused Focusable is taller than the viewport of the Scroll.

  • The default "auto" mode aligns the Focusable‘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 the Focusable‘s top edge with the viewport’s top disregarding of the scrolling direction.
  • The "bottom" mode always aligns the Focusable‘s bottom edge with the viewport’s bottom disregarding of the scrolling direction.
↔ Stickiness - horizontal_stickiness: "auto" | "left" | "right" - default "auto"

Controls the scrolling behaviour when the focused Focusable is wider than the viewport of the Scroll.

  • The default "auto" mode aligns the Focusable‘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 the Focusable‘s left edge with the viewport’s left disregarding of the scrolling direction.
  • The "right" mode always aligns the Focusable‘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.

Using the library in your code components (API)

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.

Example

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>
    )
}

CHANGELOG

v1.44.0

  • 🥢 Add vertical_stickiness and horizontal_stickiness props to Scroll.
  • 🎛 Use ControlType.Transition instead of a set of different property controls for defining the scrolling animation in Scroll.

v1.43.0

  • 🦚 Add EventHandler controls for onFocus, onBlur etc…
  • 🎬 Slightly improve scrolling performance of Scroll
  • ⬆️ Update react-sunbeam to 0.11.0

v1.39.0

  • 🎩 Introduce onFocus and onBlur handlers for useFocusable

v1.37.0

  • 🎹 Introduce key press management (onKeyPress handler for SunbeamContainer, Focusable and useFocusable)
  • ⏫ Upgrade react-sunbeam -> 0.9.0

v1.35.0

  • Fix Scroll component when a prototype is scaled

v1.34.0

  • Expose SunbeamContainer to use in code
  • Upgrade react-sunbeam -> 0.7.0

v1.33.0

  • Expose Focusable to use in code
  • Add commitizen (chore)

v1.32.0

  • Expose useOnFocusedChange hook
  • New onBlur prop on Focusable

v1.31.0

Expose getPreferredChildOnFocusReceive prop for SunbeamContainer and Focusable

v1.29.0

Fix Scroll fill

v1.25.0

Expose property controls for Scroll‘s transition

v1.24.0

Remove ScrollContext and useOnFocus, instead add the Scroll notification logic to useFocusable

v1.22.0

Remove ScrollContext from module export but export it as a global variable SunbeamScrollContext

v1.21.0

Export ScrollContext and useOnFocus

v1.20.0

Export Focusable, useSunbeam, useFocusable and defaultGetPreferredChildOnFocusReceive so those can be used directly in your custom code components.

v1.19.0

Add onKeyPress and onFocusUpdate props to SunbeamContainer

v1.15.0

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

v1.14.0

BREAKING CHANGE: onFocus callback now accepts an object of type { element: HTMLElement; focusablePath: string[] } as an argument, before it was a string focusablePath