@enact/spotlight

Spotlight

An extensible library for 5-way navigation and focus control

Spotlight is an extensible utility that enables users to navigate applications using a keyboard or television remote control. Responding to input from the UP, DOWN, LEFT, RIGHT, and RETURN keys, Spotlight provides a navigation experience that compares favorably to that of a computer-with-mouse.

Usage

import kind from '@enact/core/kind';
import {SpotlightRootDecorator, Spottable} from '@enact/spotlight';

const MySpottableComponent = Spottable('div');

const MyApp = kind({
    name: 'MyApp',
    render: () => (<MySpottableComponent>Hello, Enact!</MySpottableComponent>)
});
const MySpotlightApp = SpotlightRootDecorator(MyApp);

See the docs for more information.

Additional Information

When using @enact/moonstone, the SpotlightRootDecorator is applied automatically by MoonstoneDecorator.

Acknowledgments

Spotlight is based on a fork of JavaScript SpatialNavigation (c) 2016 Luke Chang, under the terms of the Mozilla Public License.

Copyright and License Information

Unless otherwise specified, all content, including all source code files and documentation files in this repository are:

Copyright (c) 2012-2016 LG Electronics

Unless otherwise specified or set forth in the NOTICE file, all content, including all source code files and documentation files in this repository are: Licensed under the Apache License, Version 2.0 (the "License"); you may not use this content except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Changelog

[1.0.0-alpha.4] - 2016-12-2

NOTE: The framework was updated to support React 15.4

Added

• moonstone/Popup, moonstone/ContextualPopupDecorator, moonstone/Notification, moonstone/Dialog, moonstone/ExpandableInput, moonstone/Item.ItemOverlay, ui/FloatingLayer and ui/FloatingLayer.FloatingLayerDecorator components
• moonstone/Popup, moonstone/ContextualPopupDecorator, moonstone/Notification, moonstone/Dialog, moonstone/Item.ItemOverlay, moonstone/ExpandableInput and ui/Group samples
• marqueeCentered prop to moonstone/MarqueeDecorator and moonstone/MarqueeText
• placeholder prop to moonstone/Image
• moonstone/MarqueeController component to synchronize multiple moonstone/Marquee components
• Non-latin locale support to all existing Moonstone components
• Language-specific font support
• setPointerMode() and setActiveContainer() methods to @enact/spotlight export
• fit, noAnimation props to ui/TransitionBase
• onHide prop to ui/Transition

Changed

• moonstone/Input component's iconStart and iconEnd properties to be iconBefore and iconAfter, respectively, for consistency with moonstone/Item.ItemOverlay naming
• moonstone/Icon and moonstone/IconButton so the children property supports both font-based icons and images. This removes support for the src property.
• the checked property to selected for consistency across the whole framework. This allows better interoperability when switching between various components. Affects the following: CheckboxItem, RadioItem, SelectableItem, Switch, SwitchItem, and ToggleItem. Additionally, these now use moonstone/Item.ItemOverlay to position and handle their Icons.
• documentation to support our doc generation tool
• moonstone/Slider and moonstone/IncrementSlider to be more performant. No changes were made to the public API.
• moonstone/GridListImageItem so that a placeholder image displays while loading the image, and the caption and subcaption support marqueeing
• moonstone/MoonstoneDecorator to add FloatingLayerDecorator

Removed

• the src property from moonstone/Icon and moonstone/IconButton. Use the support for URLs in the children property as noted above.

Fixed

• Addressed many bugs and performance issues