@lightningjs/blits 1.30.1 → 1.30.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (149) hide show
  1. package/.editorconfig +7 -7
  2. package/.eslintignore +1 -1
  3. package/.eslintrc.cjs +65 -65
  4. package/.github/workflows/comment-lint-results.yml +124 -124
  5. package/.github/workflows/comment-test-results.yml +108 -108
  6. package/.github/workflows/deploy-docs.yml +27 -27
  7. package/.github/workflows/run-blits-tests.yml +141 -141
  8. package/.github/workflows/run-lint.yml +127 -127
  9. package/.husky/pre-commit +1 -1
  10. package/.vscode/extensions.json +7 -7
  11. package/.vscode/settings.json +9 -9
  12. package/CHANGELOG.md +1019 -1012
  13. package/COPYING +1 -0
  14. package/LICENSE +202 -202
  15. package/NOTICE +12 -12
  16. package/README.md +33 -33
  17. package/bin/index.js +8 -8
  18. package/blits.d.ts +6 -6
  19. package/docs/README.md +19 -19
  20. package/docs/_sidebar.md +37 -37
  21. package/docs/built-in/directives.md +50 -50
  22. package/docs/built-in/for-loop.md +203 -203
  23. package/docs/built-in/layout.md +168 -168
  24. package/docs/components/component_state.md +90 -90
  25. package/docs/components/computed_properties.md +45 -45
  26. package/docs/components/lifecycle_events.md +42 -42
  27. package/docs/components/methods.md +45 -45
  28. package/docs/components/props.md +56 -56
  29. package/docs/components/user_input.md +186 -186
  30. package/docs/components/utility_methods.md +320 -320
  31. package/docs/components/watchers.md +34 -34
  32. package/docs/essentials/application_root.md +19 -19
  33. package/docs/essentials/components.md +68 -68
  34. package/docs/essentials/displaying_images.md +67 -67
  35. package/docs/essentials/displaying_text.md +135 -135
  36. package/docs/essentials/element_attributes.md +195 -195
  37. package/docs/essentials/settings.md +117 -117
  38. package/docs/essentials/template_syntax.md +83 -83
  39. package/docs/getting_started/file_structure.md +58 -58
  40. package/docs/getting_started/getting_started.md +45 -45
  41. package/docs/getting_started/intro.md +20 -20
  42. package/docs/index.html +47 -47
  43. package/docs/performance/lazy-loading.md +161 -161
  44. package/docs/plugins/global_app_state.md +98 -98
  45. package/docs/plugins/language.md +172 -172
  46. package/docs/plugins/text-to-speech-announcer.md +119 -119
  47. package/docs/plugins/theme.md +176 -176
  48. package/docs/router/basics.md +175 -175
  49. package/docs/router/hooks.md +70 -70
  50. package/docs/router/transitions.md +146 -146
  51. package/docs/sidebar.json +171 -171
  52. package/docs/transitions_animations/transitions.md +150 -150
  53. package/index.d.ts +1099 -1099
  54. package/index.js +28 -28
  55. package/jsconfig.json +12 -12
  56. package/package.json +56 -56
  57. package/public/assets/fps_sprite.base64.js +1 -1
  58. package/scripts/postpublish.js +59 -59
  59. package/scripts/prepublishOnly.js +84 -84
  60. package/scripts/prepush.js +78 -78
  61. package/src/announcer/announcer.js +162 -162
  62. package/src/announcer/speechSynthesis.js +107 -107
  63. package/src/application.js +100 -100
  64. package/src/component/base/announcer.js +27 -27
  65. package/src/component/base/events.js +69 -69
  66. package/src/component/base/index.js +33 -33
  67. package/src/component/base/methods.js +244 -244
  68. package/src/component/base/router.js +41 -41
  69. package/src/component/base/timeouts_intervals.js +99 -99
  70. package/src/component/base/utils.js +72 -72
  71. package/src/component/setup/computed.js +48 -48
  72. package/src/component/setup/index.js +62 -62
  73. package/src/component/setup/input.js +30 -30
  74. package/src/component/setup/methods.js +37 -37
  75. package/src/component/setup/props.js +62 -62
  76. package/src/component/setup/props.test.js +238 -238
  77. package/src/component/setup/routes.js +42 -42
  78. package/src/component/setup/state.js +59 -59
  79. package/src/component/setup/watch.js +35 -35
  80. package/src/component.js +437 -437
  81. package/src/component.test.js +388 -388
  82. package/src/components/Circle.js +73 -73
  83. package/src/components/Circle.orig.js +31 -31
  84. package/src/components/FPScounter.js +1510 -1510
  85. package/src/components/FPScounter.orig.js +121 -121
  86. package/src/components/RouterView.js +81 -81
  87. package/src/components/RouterView.orig.js +54 -54
  88. package/src/components/Sprite.js +94 -94
  89. package/src/components/Sprite.orig.js +58 -58
  90. package/src/components/index.js +28 -28
  91. package/src/components/index.orig.js +28 -28
  92. package/src/constants.js +21 -21
  93. package/src/engine.js +1 -1
  94. package/src/engines/L3/element.js +744 -744
  95. package/src/engines/L3/element.test.js +579 -579
  96. package/src/engines/L3/fontLoader.js +38 -38
  97. package/src/engines/L3/index.js +7 -7
  98. package/src/engines/L3/launch.js +123 -123
  99. package/src/engines/L3/shaderLoader.js +12 -12
  100. package/src/engines/index.js +1 -1
  101. package/src/focus.js +90 -90
  102. package/src/helpers/deepEqualArray.js +50 -50
  103. package/src/helpers/deepEqualArray.test.js +127 -127
  104. package/src/helpers/fetchJson.js +34 -34
  105. package/src/helpers/sequence.js +26 -26
  106. package/src/launch.js +123 -123
  107. package/src/lib/blitsfileconverter/blitsfileconverter.js +52 -52
  108. package/src/lib/codegenerator/generator.js +788 -788
  109. package/src/lib/codegenerator/generator.test.js +3801 -3801
  110. package/src/lib/colors/colors.js +92 -92
  111. package/src/lib/colors/colors.test.js +290 -290
  112. package/src/lib/colors/htmlColors.js +168 -168
  113. package/src/lib/componentId.js +49 -49
  114. package/src/lib/componentId.test.js +84 -84
  115. package/src/lib/eventListeners.js +123 -123
  116. package/src/lib/eventListeners.test.js +236 -236
  117. package/src/lib/hooks.js +59 -59
  118. package/src/lib/lifecycle.js +85 -85
  119. package/src/lib/log.js +117 -117
  120. package/src/lib/precompiler/precompiler.js +73 -73
  121. package/src/lib/reactivity/effect.js +93 -93
  122. package/src/lib/reactivity/effect.test.js +35 -35
  123. package/src/lib/reactivity/reactive.js +208 -208
  124. package/src/lib/reactivity/reactive.test.js +27 -27
  125. package/src/lib/reactivityguard/computedprops.js +218 -218
  126. package/src/lib/symbols.js +108 -108
  127. package/src/lib/templateparser/parser.js +386 -386
  128. package/src/lib/templateparser/parser.test.js +1411 -1411
  129. package/src/lib/utils.js +27 -27
  130. package/src/plugin.js +27 -27
  131. package/src/plugins/appstate.js +26 -26
  132. package/src/plugins/index.js +20 -20
  133. package/src/plugins/language.js +152 -152
  134. package/src/plugins/log.js +25 -25
  135. package/src/plugins/theme.js +94 -94
  136. package/src/router/router.js +514 -514
  137. package/src/router/router.test.js +473 -473
  138. package/src/router/transitions/fadeIn.js +27 -27
  139. package/src/router/transitions/fadeInOut.js +33 -33
  140. package/src/router/transitions/index.js +21 -21
  141. package/src/router/transitions/slideIn.js +28 -28
  142. package/src/router/transitions/slideInOut.js +33 -33
  143. package/src/settings.js +40 -40
  144. package/vite/blitsFileConverter.js +67 -67
  145. package/vite/index.js +28 -28
  146. package/vite/msdfGenerator.js +269 -269
  147. package/vite/preCompiler.js +42 -42
  148. package/vite/reactivityGuard.js +45 -45
  149. package/vscode/data/template-attributes.json +589 -589
@@ -1,38 +1,38 @@
1
- import { SdfTrFontFace, WebTrFontFace } from '@lightningjs/renderer'
2
- import Settings from '../../settings.js'
3
- import { renderer } from './launch.js'
4
-
5
- export default () => {
6
- const stage = renderer.stage
7
- Settings.get('fonts', []).forEach((font) => {
8
- if (font.type === 'sdf' || font.type === 'msdf') {
9
- // automatically map png key to file name
10
- if (!font.png && font.file) {
11
- font.png = font.file.replace(/\.[^.]+$/, `.${font.type}.png`)
12
- }
13
- // automatically map json to file name
14
- if (!font.json && font.file) {
15
- font.json = font.file.replace(/\.[^.]+$/, `.${font.type}.json`)
16
- }
17
- stage.fontManager.addFontFace(
18
- new SdfTrFontFace(font.type, {
19
- fontFamily: font.family,
20
- descriptors: {},
21
- atlasUrl: font.png,
22
- atlasDataUrl: font.json,
23
- stage,
24
- metrics: font.metrics,
25
- })
26
- )
27
- } else if (font.type === 'web') {
28
- stage.fontManager.addFontFace(
29
- new WebTrFontFace({
30
- fontFamily: font.family,
31
- fontUrl: font.file,
32
- descriptors: {},
33
- metrics: font.metrics,
34
- })
35
- )
36
- }
37
- })
38
- }
1
+ import { SdfTrFontFace, WebTrFontFace } from '@lightningjs/renderer'
2
+ import Settings from '../../settings.js'
3
+ import { renderer } from './launch.js'
4
+
5
+ export default () => {
6
+ const stage = renderer.stage
7
+ Settings.get('fonts', []).forEach((font) => {
8
+ if (font.type === 'sdf' || font.type === 'msdf') {
9
+ // automatically map png key to file name
10
+ if (!font.png && font.file) {
11
+ font.png = font.file.replace(/\.[^.]+$/, `.${font.type}.png`)
12
+ }
13
+ // automatically map json to file name
14
+ if (!font.json && font.file) {
15
+ font.json = font.file.replace(/\.[^.]+$/, `.${font.type}.json`)
16
+ }
17
+ stage.fontManager.addFontFace(
18
+ new SdfTrFontFace(font.type, {
19
+ fontFamily: font.family,
20
+ descriptors: {},
21
+ atlasUrl: font.png,
22
+ atlasDataUrl: font.json,
23
+ stage,
24
+ metrics: font.metrics,
25
+ })
26
+ )
27
+ } else if (font.type === 'web') {
28
+ stage.fontManager.addFontFace(
29
+ new WebTrFontFace({
30
+ fontFamily: font.family,
31
+ fontUrl: font.file,
32
+ descriptors: {},
33
+ metrics: font.metrics,
34
+ })
35
+ )
36
+ }
37
+ })
38
+ }
@@ -1,7 +1,7 @@
1
- import Element from './element.js'
2
- import Launch from './launch.js'
3
-
4
- export default {
5
- Element,
6
- Launch,
7
- }
1
+ import Element from './element.js'
2
+ import Launch from './launch.js'
3
+
4
+ export default {
5
+ Element,
6
+ Launch,
7
+ }
@@ -1,123 +1,123 @@
1
- /*
2
- * Copyright 2023 Comcast Cable Communications Management, LLC
3
- * Licensed under the Apache License, Version 2.0 (the "License");
4
- * you may not use this file except in compliance with the License.
5
- * You may obtain a copy of the License at
6
- *
7
- * http://www.apache.org/licenses/LICENSE-2.0
8
- *
9
- * Unless required by applicable law or agreed to in writing, software
10
- * distributed under the License is distributed on an "AS IS" BASIS,
11
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
- * See the License for the specific language governing permissions and
13
- * limitations under the License.
14
- *
15
- * SPDX-License-Identifier: Apache-2.0
16
- */
17
-
18
- import { RendererMain } from '@lightningjs/renderer'
19
- import { WebGlCoreRenderer, SdfTextRenderer } from '@lightningjs/renderer/webgl'
20
- import { CanvasCoreRenderer, CanvasTextRenderer } from '@lightningjs/renderer/canvas'
21
- import { Inspector } from '@lightningjs/renderer/inspector'
22
-
23
- import { Log } from '../../lib/log.js'
24
- import { SCREEN_RESOLUTIONS, RENDER_QUALITIES } from '../../constants.js'
25
- import colors from '../../lib/colors/colors.js'
26
- import fontLoader from './fontLoader.js'
27
- import shaderLoader from './shaderLoader.js'
28
-
29
- /** @type {RendererMain|null} */
30
- export let renderer = null
31
-
32
- const renderEngine = (settings) => {
33
- const renderMode = 'renderMode' in settings ? settings.renderMode : 'webgl'
34
-
35
- if (renderMode === 'webgl') return WebGlCoreRenderer
36
- if (renderMode === 'canvas') return CanvasCoreRenderer
37
- }
38
-
39
- const textRenderEngines = (settings) => {
40
- const renderMode = 'renderMode' in settings ? settings.renderMode : 'webgl'
41
-
42
- if (renderMode === 'webgl') return [SdfTextRenderer, CanvasTextRenderer]
43
- if (renderMode === 'canvas') return [CanvasTextRenderer]
44
- }
45
-
46
- const textureMemorySettings = (settings) => {
47
- const gpuMemory = {
48
- ...{
49
- max: 200,
50
- target: 0.8,
51
- cleanupInterval: 5000,
52
- baseline: 25,
53
- strict: false,
54
- },
55
- ...('gpuMemory' in settings === true ? settings.gpuMemory : {}),
56
- }
57
-
58
- return {
59
- criticalThreshold: gpuMemory.max * 1024 * 1024, // convert from mb to bytes
60
- targetThresholdLevel: gpuMemory.target,
61
- cleanupInterval: gpuMemory.cleanupInterval,
62
- baselineMemoryAllocation: gpuMemory.baseline * 1024 * 1024, // convert from mb to bytes
63
- doNotExceedCriticalThreshold: gpuMemory.strict,
64
- }
65
- }
66
-
67
- /**
68
- * Launch the render engine and application
69
- *
70
- * @param {import('../../launch.js').BlitsAppFactory} App - Factory function that returns the application instance (extends BlitsComponent with .quit())
71
- * @param {HTMLElement} target - The target element to render the application into
72
- * @param {Partial<import('../../launch.js').BlitsSettings>} [settings] - The settings for the renderer
73
- *
74
- */
75
- export default (App, target, settings = {}) => {
76
- renderer = new RendererMain(
77
- {
78
- ...{
79
- appWidth: settings.w || 1920,
80
- appHeight: settings.h || 1080,
81
- fpsUpdateInterval: settings.fpsInterval || 1000,
82
- devicePhysicalPixelRatio:
83
- RENDER_QUALITIES[settings.renderQuality] || settings.renderQuality || 1,
84
- deviceLogicalPixelRatio:
85
- settings.pixelRatio ||
86
- SCREEN_RESOLUTIONS[settings.screenResolution] ||
87
- SCREEN_RESOLUTIONS[window.innerHeight] ||
88
- 1,
89
- numImageWorkers:
90
- 'webWorkersLimit' in settings
91
- ? settings.webWorkersLimit
92
- : window.navigator.hardwareConcurrency || 2,
93
- clearColor: (settings.canvasColor && colors.normalize(settings.canvasColor)) || 0x00000000,
94
- inspector: settings.inspector === true ? Inspector : undefined,
95
- boundsMargin: settings.viewportMargin || 0,
96
- renderEngine: renderEngine(settings),
97
- fontEngines: textRenderEngines(settings),
98
- canvas: settings.canvas,
99
- textureProcessingTimeLimit: settings.textureProcessingTimeLimit,
100
- textureMemory: textureMemorySettings(settings),
101
- createImageBitmapSupport: 'auto',
102
- },
103
- ...(settings.advanced || {}),
104
- },
105
- target
106
- )
107
-
108
- const initApp = () => {
109
- let app = App()
110
- app.quit = () => {
111
- Log.info('Closing App')
112
- app.destroy()
113
- app = null
114
- renderer = null
115
- }
116
- }
117
-
118
- shaderLoader()
119
- fontLoader()
120
- initApp()
121
-
122
- return renderer
123
- }
1
+ /*
2
+ * Copyright 2023 Comcast Cable Communications Management, LLC
3
+ * Licensed under the Apache License, Version 2.0 (the "License");
4
+ * you may not use this file except in compliance with the License.
5
+ * You may obtain a copy of the License at
6
+ *
7
+ * http://www.apache.org/licenses/LICENSE-2.0
8
+ *
9
+ * Unless required by applicable law or agreed to in writing, software
10
+ * distributed under the License is distributed on an "AS IS" BASIS,
11
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ * See the License for the specific language governing permissions and
13
+ * limitations under the License.
14
+ *
15
+ * SPDX-License-Identifier: Apache-2.0
16
+ */
17
+
18
+ import { RendererMain } from '@lightningjs/renderer'
19
+ import { WebGlCoreRenderer, SdfTextRenderer } from '@lightningjs/renderer/webgl'
20
+ import { CanvasCoreRenderer, CanvasTextRenderer } from '@lightningjs/renderer/canvas'
21
+ import { Inspector } from '@lightningjs/renderer/inspector'
22
+
23
+ import { Log } from '../../lib/log.js'
24
+ import { SCREEN_RESOLUTIONS, RENDER_QUALITIES } from '../../constants.js'
25
+ import colors from '../../lib/colors/colors.js'
26
+ import fontLoader from './fontLoader.js'
27
+ import shaderLoader from './shaderLoader.js'
28
+
29
+ /** @type {RendererMain|null} */
30
+ export let renderer = null
31
+
32
+ const renderEngine = (settings) => {
33
+ const renderMode = 'renderMode' in settings ? settings.renderMode : 'webgl'
34
+
35
+ if (renderMode === 'webgl') return WebGlCoreRenderer
36
+ if (renderMode === 'canvas') return CanvasCoreRenderer
37
+ }
38
+
39
+ const textRenderEngines = (settings) => {
40
+ const renderMode = 'renderMode' in settings ? settings.renderMode : 'webgl'
41
+
42
+ if (renderMode === 'webgl') return [SdfTextRenderer, CanvasTextRenderer]
43
+ if (renderMode === 'canvas') return [CanvasTextRenderer]
44
+ }
45
+
46
+ const textureMemorySettings = (settings) => {
47
+ const gpuMemory = {
48
+ ...{
49
+ max: 200,
50
+ target: 0.8,
51
+ cleanupInterval: 5000,
52
+ baseline: 25,
53
+ strict: false,
54
+ },
55
+ ...('gpuMemory' in settings === true ? settings.gpuMemory : {}),
56
+ }
57
+
58
+ return {
59
+ criticalThreshold: gpuMemory.max * 1024 * 1024, // convert from mb to bytes
60
+ targetThresholdLevel: gpuMemory.target,
61
+ cleanupInterval: gpuMemory.cleanupInterval,
62
+ baselineMemoryAllocation: gpuMemory.baseline * 1024 * 1024, // convert from mb to bytes
63
+ doNotExceedCriticalThreshold: gpuMemory.strict,
64
+ }
65
+ }
66
+
67
+ /**
68
+ * Launch the render engine and application
69
+ *
70
+ * @param {import('../../launch.js').BlitsAppFactory} App - Factory function that returns the application instance (extends BlitsComponent with .quit())
71
+ * @param {HTMLElement} target - The target element to render the application into
72
+ * @param {Partial<import('../../launch.js').BlitsSettings>} [settings] - The settings for the renderer
73
+ *
74
+ */
75
+ export default (App, target, settings = {}) => {
76
+ renderer = new RendererMain(
77
+ {
78
+ ...{
79
+ appWidth: settings.w || 1920,
80
+ appHeight: settings.h || 1080,
81
+ fpsUpdateInterval: settings.fpsInterval || 1000,
82
+ devicePhysicalPixelRatio:
83
+ RENDER_QUALITIES[settings.renderQuality] || settings.renderQuality || 1,
84
+ deviceLogicalPixelRatio:
85
+ settings.pixelRatio ||
86
+ SCREEN_RESOLUTIONS[settings.screenResolution] ||
87
+ SCREEN_RESOLUTIONS[window.innerHeight] ||
88
+ 1,
89
+ numImageWorkers:
90
+ 'webWorkersLimit' in settings
91
+ ? settings.webWorkersLimit
92
+ : window.navigator.hardwareConcurrency || 2,
93
+ clearColor: (settings.canvasColor && colors.normalize(settings.canvasColor)) || 0x00000000,
94
+ inspector: settings.inspector === true ? Inspector : undefined,
95
+ boundsMargin: settings.viewportMargin || 0,
96
+ renderEngine: renderEngine(settings),
97
+ fontEngines: textRenderEngines(settings),
98
+ canvas: settings.canvas,
99
+ textureProcessingTimeLimit: settings.textureProcessingTimeLimit,
100
+ textureMemory: textureMemorySettings(settings),
101
+ createImageBitmapSupport: 'auto',
102
+ },
103
+ ...(settings.advanced || {}),
104
+ },
105
+ target
106
+ )
107
+
108
+ const initApp = () => {
109
+ let app = App()
110
+ app.quit = () => {
111
+ Log.info('Closing App')
112
+ app.destroy()
113
+ app = null
114
+ renderer = null
115
+ }
116
+ }
117
+
118
+ shaderLoader()
119
+ fontLoader()
120
+ initApp()
121
+
122
+ return renderer
123
+ }
@@ -1,12 +1,12 @@
1
- import Settings from '../../settings.js'
2
- import { renderer } from './launch.js'
3
-
4
- export default () => {
5
- const stage = renderer.stage
6
- Settings.get('shaders', []).forEach((shader) => {
7
- stage.shManager.registerShaderType(shader.name, shader.type)
8
- })
9
- Settings.get('effects', []).forEach((effect) => {
10
- stage.shManager.registerShaderType(effect.name, effect.type)
11
- })
12
- }
1
+ import Settings from '../../settings.js'
2
+ import { renderer } from './launch.js'
3
+
4
+ export default () => {
5
+ const stage = renderer.stage
6
+ Settings.get('shaders', []).forEach((shader) => {
7
+ stage.shManager.registerShaderType(shader.name, shader.type)
8
+ })
9
+ Settings.get('effects', []).forEach((effect) => {
10
+ stage.shManager.registerShaderType(effect.name, effect.type)
11
+ })
12
+ }
@@ -1 +1 @@
1
- export { default as L3 } from './L3/index.js'
1
+ export { default as L3 } from './L3/index.js'
package/src/focus.js CHANGED
@@ -1,90 +1,90 @@
1
- /*
2
- * Copyright 2023 Comcast Cable Communications Management, LLC
3
- * Licensed under the Apache License, Version 2.0 (the "License");
4
- * you may not use this file except in compliance with the License.
5
- * You may obtain a copy of the License at
6
- *
7
- * http://www.apache.org/licenses/LICENSE-2.0
8
- *
9
- * Unless required by applicable law or agreed to in writing, software
10
- * distributed under the License is distributed on an "AS IS" BASIS,
11
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
- * See the License for the specific language governing permissions and
13
- * limitations under the License.
14
- *
15
- * SPDX-License-Identifier: Apache-2.0
16
- */
17
-
18
- import symbols from './lib/symbols.js'
19
- import { state } from './router/router.js'
20
- import Settings from './settings.js'
21
- import { DEFAULT_HOLD_TIMEOUT_MS } from './constants.js'
22
-
23
- let focusedComponent = null
24
- let focusChain = []
25
- let setFocusTimeout
26
-
27
- export const keyUpCallbacks = new Map()
28
-
29
- export default {
30
- _hold: false,
31
- set hold(v) {
32
- this._hold = v
33
- },
34
- get hold() {
35
- return this._hold
36
- },
37
- get() {
38
- return focusedComponent
39
- },
40
- set(component, event) {
41
- if (component === focusedComponent) return
42
- clearTimeout(setFocusTimeout)
43
- focusedComponent && focusedComponent !== component.parent && focusedComponent.unfocus()
44
- focusChain.reverse().forEach((cmp) => cmp.unfocus())
45
- if (component !== focusedComponent) {
46
- setFocusTimeout = setTimeout(
47
- () => {
48
- focusedComponent = component
49
- focusedComponent.lifecycle.state = 'focus'
50
- if (event instanceof KeyboardEvent) {
51
- document.dispatchEvent(new KeyboardEvent('keydown', event))
52
- } else {
53
- focusChain = []
54
- }
55
- },
56
- this.hold ? Settings.get('holdTimeout', DEFAULT_HOLD_TIMEOUT_MS) : 0
57
- )
58
- }
59
- },
60
- input(key, event) {
61
- if (state.navigating === true) return
62
- focusChain = walkChain([focusedComponent], key)
63
- const componentWithInputEvent = focusChain.shift()
64
-
65
- if (componentWithInputEvent) {
66
- let cb
67
- if (componentWithInputEvent[symbols.inputEvents][key]) {
68
- cb = componentWithInputEvent[symbols.inputEvents][key].call(componentWithInputEvent, event)
69
- } else if (componentWithInputEvent[symbols.inputEvents].any) {
70
- cb = componentWithInputEvent[symbols.inputEvents].any.call(componentWithInputEvent, event)
71
- }
72
- if (cb !== undefined) {
73
- keyUpCallbacks.set(event.code, cb)
74
- }
75
- }
76
- },
77
- }
78
-
79
- const walkChain = (components, key) => {
80
- if (
81
- components[0][symbols.inputEvents] &&
82
- (typeof components[0][symbols.inputEvents][key] === 'function' ||
83
- typeof components[0][symbols.inputEvents].any === 'function')
84
- ) {
85
- return components
86
- } else if (components[0].parent) {
87
- components.unshift(components[0].parent)
88
- return walkChain(components, key)
89
- } else return []
90
- }
1
+ /*
2
+ * Copyright 2023 Comcast Cable Communications Management, LLC
3
+ * Licensed under the Apache License, Version 2.0 (the "License");
4
+ * you may not use this file except in compliance with the License.
5
+ * You may obtain a copy of the License at
6
+ *
7
+ * http://www.apache.org/licenses/LICENSE-2.0
8
+ *
9
+ * Unless required by applicable law or agreed to in writing, software
10
+ * distributed under the License is distributed on an "AS IS" BASIS,
11
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ * See the License for the specific language governing permissions and
13
+ * limitations under the License.
14
+ *
15
+ * SPDX-License-Identifier: Apache-2.0
16
+ */
17
+
18
+ import symbols from './lib/symbols.js'
19
+ import { state } from './router/router.js'
20
+ import Settings from './settings.js'
21
+ import { DEFAULT_HOLD_TIMEOUT_MS } from './constants.js'
22
+
23
+ let focusedComponent = null
24
+ let focusChain = []
25
+ let setFocusTimeout
26
+
27
+ export const keyUpCallbacks = new Map()
28
+
29
+ export default {
30
+ _hold: false,
31
+ set hold(v) {
32
+ this._hold = v
33
+ },
34
+ get hold() {
35
+ return this._hold
36
+ },
37
+ get() {
38
+ return focusedComponent
39
+ },
40
+ set(component, event) {
41
+ if (component === focusedComponent) return
42
+ clearTimeout(setFocusTimeout)
43
+ focusedComponent && focusedComponent !== component.parent && focusedComponent.unfocus()
44
+ focusChain.reverse().forEach((cmp) => cmp.unfocus())
45
+ if (component !== focusedComponent) {
46
+ setFocusTimeout = setTimeout(
47
+ () => {
48
+ focusedComponent = component
49
+ focusedComponent.lifecycle.state = 'focus'
50
+ if (event instanceof KeyboardEvent) {
51
+ document.dispatchEvent(new KeyboardEvent('keydown', event))
52
+ } else {
53
+ focusChain = []
54
+ }
55
+ },
56
+ this.hold ? Settings.get('holdTimeout', DEFAULT_HOLD_TIMEOUT_MS) : 0
57
+ )
58
+ }
59
+ },
60
+ input(key, event) {
61
+ if (state.navigating === true) return
62
+ focusChain = walkChain([focusedComponent], key)
63
+ const componentWithInputEvent = focusChain.shift()
64
+
65
+ if (componentWithInputEvent) {
66
+ let cb
67
+ if (componentWithInputEvent[symbols.inputEvents][key]) {
68
+ cb = componentWithInputEvent[symbols.inputEvents][key].call(componentWithInputEvent, event)
69
+ } else if (componentWithInputEvent[symbols.inputEvents].any) {
70
+ cb = componentWithInputEvent[symbols.inputEvents].any.call(componentWithInputEvent, event)
71
+ }
72
+ if (cb !== undefined) {
73
+ keyUpCallbacks.set(event.code, cb)
74
+ }
75
+ }
76
+ },
77
+ }
78
+
79
+ const walkChain = (components, key) => {
80
+ if (
81
+ components[0][symbols.inputEvents] &&
82
+ (typeof components[0][symbols.inputEvents][key] === 'function' ||
83
+ typeof components[0][symbols.inputEvents].any === 'function')
84
+ ) {
85
+ return components
86
+ } else if (components[0].parent) {
87
+ components.unshift(components[0].parent)
88
+ return walkChain(components, key)
89
+ } else return []
90
+ }
@@ -1,50 +1,50 @@
1
- /*
2
- * Copyright 2024 Comcast Cable Communications Management, LLC
3
- * Licensed under the Apache License, Version 2.0 (the "License");
4
- * you may not use this file except in compliance with the License.
5
- * You may obtain a copy of the License at
6
- *
7
- * http://www.apache.org/licenses/LICENSE-2.0
8
- *
9
- * Unless required by applicable law or agreed to in writing, software
10
- * distributed under the License is distributed on an "AS IS" BASIS,
11
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
- * See the License for the specific language governing permissions and
13
- * limitations under the License.
14
- *
15
- * SPDX-License-Identifier: Apache-2.0
16
- */
17
-
18
- const deepEqualArray = (array1, array2) => {
19
- if (array1 === array2) return true
20
- if (array1.length !== array2.length) return false
21
-
22
- let l = array1.length
23
-
24
- while (l--) {
25
- const value1 = array1[l]
26
- const value2 = array2[l]
27
-
28
- // values are arrays, deepEqual nested arrays
29
- if (Array.isArray(value1) && Array.isArray(value2)) {
30
- if (deepEqualArray(value1, value2) === false) return false
31
- }
32
- // values are objects, deepEqual nested objects
33
- else if (
34
- typeof value1 === 'object' &&
35
- value1 !== null &&
36
- typeof value2 === 'object' &&
37
- value2 !== null
38
- ) {
39
- if (deepEqualArray(Object.entries(value1), Object.entries(value2)) === false) return false
40
- }
41
- // other type, do strict equal check
42
- else if (value1 !== value2) {
43
- return false
44
- }
45
- }
46
-
47
- return true
48
- }
49
-
50
- export default deepEqualArray
1
+ /*
2
+ * Copyright 2024 Comcast Cable Communications Management, LLC
3
+ * Licensed under the Apache License, Version 2.0 (the "License");
4
+ * you may not use this file except in compliance with the License.
5
+ * You may obtain a copy of the License at
6
+ *
7
+ * http://www.apache.org/licenses/LICENSE-2.0
8
+ *
9
+ * Unless required by applicable law or agreed to in writing, software
10
+ * distributed under the License is distributed on an "AS IS" BASIS,
11
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ * See the License for the specific language governing permissions and
13
+ * limitations under the License.
14
+ *
15
+ * SPDX-License-Identifier: Apache-2.0
16
+ */
17
+
18
+ const deepEqualArray = (array1, array2) => {
19
+ if (array1 === array2) return true
20
+ if (array1.length !== array2.length) return false
21
+
22
+ let l = array1.length
23
+
24
+ while (l--) {
25
+ const value1 = array1[l]
26
+ const value2 = array2[l]
27
+
28
+ // values are arrays, deepEqual nested arrays
29
+ if (Array.isArray(value1) && Array.isArray(value2)) {
30
+ if (deepEqualArray(value1, value2) === false) return false
31
+ }
32
+ // values are objects, deepEqual nested objects
33
+ else if (
34
+ typeof value1 === 'object' &&
35
+ value1 !== null &&
36
+ typeof value2 === 'object' &&
37
+ value2 !== null
38
+ ) {
39
+ if (deepEqualArray(Object.entries(value1), Object.entries(value2)) === false) return false
40
+ }
41
+ // other type, do strict equal check
42
+ else if (value1 !== value2) {
43
+ return false
44
+ }
45
+ }
46
+
47
+ return true
48
+ }
49
+
50
+ export default deepEqualArray