Skip to content

Commit ed9ee1b

Browse files
committed
fix docs
1 parent 055216f commit ed9ee1b

1 file changed

Lines changed: 5 additions & 16 deletions

File tree

packages/spotlight/src/tabTraversal.js

Lines changed: 5 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
1-
/*
1+
/**
22
* Tab key linear focus traversal for Spotlight.
3+
*
4+
* @module spotlight/tabTraversal
5+
* @private
36
*/
47

58
import last from 'ramda/src/last';
@@ -27,23 +30,9 @@ const TAB_ROW_THRESHOLD = 24;
2730
// CSS class applied by @enact/i18n I18nDecorator to the app root for RTL locales.
2831
const I18N_RTL_CLASS = 'enact-locale-right-to-left';
2932

30-
/**
31-
* Live tab traversal API, set when Spotlight initializes via {@link createTabTraversal}.
32-
*
33-
* @type {Object|null}
34-
*/
33+
// Live tab traversal API, set when Spotlight initializes via createTabTraversal.
3534
export let tabTraversal = null;
3635

37-
/**
38-
* Creates tab traversal helpers wired to Spotlight focus routines.
39-
*
40-
* @param {Object} deps
41-
* @param {Function} deps.focusElement
42-
* @param {Function} deps.getCurrent
43-
* @param {Function} deps.isPaused
44-
* @param {Function} deps.restoreFocus
45-
* @returns {Object} Tab traversal API
46-
*/
4736
export function createTabTraversal ({
4837
focusElement,
4938
getCurrent,

0 commit comments

Comments
 (0)