@enact/ui 4.5.2 → 4.6.1

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 (222) hide show
  1. package/AnnounceDecorator/Announce.js +1 -40
  2. package/AnnounceDecorator/AnnounceDecorator.js +3 -21
  3. package/AnnounceDecorator/tests/Announce-specs.js +2 -7
  4. package/AnnounceDecorator/tests/AnnounceDecorator-specs.js +2 -6
  5. package/AnnounceDecorator/tests/useAnnounce-specs.js +8 -19
  6. package/AnnounceDecorator/useAnnounce.js +0 -6
  7. package/BodyText/BodyText.js +8 -28
  8. package/BodyText/tests/BodyText-specs.js +0 -19
  9. package/Button/Button.js +33 -63
  10. package/Button/tests/Button-specs.js +0 -26
  11. package/CHANGELOG.md +45 -0
  12. package/Cancelable/Cancelable.js +8 -47
  13. package/Cancelable/cancelHandler.js +5 -12
  14. package/Cancelable/modalHandler.js +3 -11
  15. package/Cancelable/tests/Cancelable-specs.js +3 -57
  16. package/Changeable/Changeable.js +2 -34
  17. package/Changeable/tests/Changeable-specs.js +20 -66
  18. package/ComponentOverride/ComponentOverride.js +1 -13
  19. package/FloatingLayer/FloatingLayer.js +17 -73
  20. package/FloatingLayer/FloatingLayerContainer.js +0 -15
  21. package/FloatingLayer/FloatingLayerDecorator.js +4 -17
  22. package/FloatingLayer/Scrim.js +9 -53
  23. package/FloatingLayer/index.js +0 -4
  24. package/FloatingLayer/package.json +3 -0
  25. package/FloatingLayer/tests/FloatingLayer-specs.js +8 -22
  26. package/FloatingLayer/tests/Scrim-specs.js +0 -9
  27. package/FloatingLayer/tests/useFloatingLayerDecorator-specs.js +0 -13
  28. package/FloatingLayer/useFloatingLayer.js +3 -14
  29. package/FloatingLayer/useFloatingLayerDecorator.js +3 -11
  30. package/ForwardRef/ForwardRef.js +1 -10
  31. package/GridListImageItem/GridListImageItem.js +18 -51
  32. package/Group/Group.js +5 -36
  33. package/Group/GroupItem.js +16 -33
  34. package/Group/tests/Group-specs.js +0 -32
  35. package/Heading/Heading.js +8 -36
  36. package/Heading/tests/Heading-specs.js +81 -14
  37. package/Icon/Icon.js +19 -53
  38. package/Icon/tests/Icon-specs.js +0 -22
  39. package/IconButton/IconButton.js +24 -57
  40. package/IconButton/tests/IconButton-specs.js +0 -7
  41. package/Image/Image.js +17 -46
  42. package/Image/tests/Image-specs.js +0 -14
  43. package/ImageItem/ImageItem.js +18 -47
  44. package/ImageItem/tests/ImageItem-specs.js +0 -25
  45. package/Item/Item.js +9 -33
  46. package/Item/tests/Item-specs.js +0 -24
  47. package/LabeledIcon/LabeledIcon.js +22 -53
  48. package/LabeledIcon/tests/LabeledIcon-specs.js +0 -14
  49. package/Layout/Cell.js +18 -44
  50. package/Layout/Layout.js +23 -46
  51. package/Layout/tests/Layout-specs.js +10 -39
  52. package/Marquee/MarqueeBase.js +29 -63
  53. package/Marquee/MarqueeController.js +11 -72
  54. package/Marquee/MarqueeDecorator.js +70 -196
  55. package/Marquee/index.js +1 -5
  56. package/Marquee/tests/Marquee-specs.js +295 -87
  57. package/Measurable/Measurable.js +12 -34
  58. package/Measurable/tests/Measurable-specs.js +115 -0
  59. package/Media/Media.js +15 -65
  60. package/Media/tests/Media-specs.js +168 -0
  61. package/Placeholder/PlaceholderControllerDecorator.js +7 -43
  62. package/Placeholder/PlaceholderDecorator.js +7 -38
  63. package/Placeholder/index.js +1 -5
  64. package/Placeholder/tests/PlaceholderControllerDecorator-specs.js +25 -0
  65. package/Placeholder/tests/PlaceholderDecorator-specs.js +28 -0
  66. package/ProgressBar/ProgressBar.js +14 -45
  67. package/ProgressBar/tests/ProgressBar-specs.js +0 -17
  68. package/RadioDecorator/RadioControllerDecorator.js +7 -29
  69. package/RadioDecorator/RadioDecorator.js +9 -42
  70. package/RadioDecorator/tests/RadioDecorator-specs.js +12 -49
  71. package/Repeater/Repeater.js +9 -33
  72. package/Repeater/tests/Repeater-specs.js +0 -38
  73. package/Resizable/Resizable.js +9 -37
  74. package/Resizable/tests/Resizable-specs.js +34 -0
  75. package/Routable/Link.js +11 -47
  76. package/Routable/Routable.js +12 -35
  77. package/Routable/Route.js +0 -6
  78. package/Routable/Router.js +15 -58
  79. package/Routable/tests/Routable-specs.js +7 -33
  80. package/Routable/tests/Router-specs.js +18 -44
  81. package/Routable/useLink.js +4 -8
  82. package/Routable/util.js +18 -24
  83. package/Scrollable/ScrollAnimator.js +49 -65
  84. package/Scrollable/ScrollThumb.js +2 -13
  85. package/Scrollable/Scrollable.js +180 -387
  86. package/Scrollable/ScrollableNative.js +189 -392
  87. package/Scrollable/Scrollbar.js +30 -102
  88. package/Scroller/Scroller.js +15 -39
  89. package/Scroller/ScrollerBasic.js +34 -89
  90. package/Scroller/UiScrollerBase.js +37 -84
  91. package/Scroller/tests/Scroller-specs.js +56 -0
  92. package/Skinnable/Skinnable.js +11 -38
  93. package/Skinnable/tests/Skinnable-specs.js +3 -74
  94. package/Skinnable/tests/useSkins-specs.js +1 -13
  95. package/Skinnable/tests/util-specs.js +0 -14
  96. package/Skinnable/useSkins.js +8 -15
  97. package/Skinnable/util.js +9 -20
  98. package/Slider/Knob.js +5 -24
  99. package/Slider/PositionDecorator.js +16 -54
  100. package/Slider/Slider.js +29 -67
  101. package/Slider/tests/Slider-specs.js +94 -7
  102. package/Slider/utils.js +0 -2
  103. package/SlotItem/SlotItem.js +23 -45
  104. package/SlotItem/tests/SlotItem-specs.js +0 -5
  105. package/Slottable/Slottable.js +4 -12
  106. package/Slottable/tests/Slottable-specs.js +19 -46
  107. package/Slottable/tests/useSlots-specs.js +27 -65
  108. package/Slottable/useSlots.js +8 -33
  109. package/Spinner/Spinner.js +16 -43
  110. package/Spinner/tests/Spinner-specs.js +0 -15
  111. package/ToggleIcon/ToggleIcon.js +10 -36
  112. package/ToggleIcon/tests/ToggleIcon-specs.js +0 -16
  113. package/ToggleItem/ToggleItem.js +24 -57
  114. package/ToggleItem/tests/ToggleItem-specs.js +0 -30
  115. package/Toggleable/Toggle.js +1 -15
  116. package/Toggleable/Toggleable.js +12 -45
  117. package/Toggleable/tests/Toggleable-specs.js +28 -96
  118. package/Toggleable/useToggle.js +3 -19
  119. package/Touchable/ClickAllow.js +5 -14
  120. package/Touchable/Drag.js +16 -54
  121. package/Touchable/Flick.js +11 -42
  122. package/Touchable/Hold.js +21 -68
  123. package/Touchable/Pinch.js +185 -0
  124. package/Touchable/Touch.js +71 -76
  125. package/Touchable/Touchable.js +95 -75
  126. package/Touchable/config.js +27 -24
  127. package/Touchable/tests/Touchable-specs.js +360 -119
  128. package/Touchable/tests/useTouch-specs.js +6 -80
  129. package/Touchable/useTouch.js +57 -65
  130. package/Transition/Transition.js +37 -118
  131. package/Transition/tests/Transition-specs.js +20 -60
  132. package/ViewManager/Arranger.js +10 -22
  133. package/ViewManager/TransitionGroup.js +32 -107
  134. package/ViewManager/View.js +35 -91
  135. package/ViewManager/ViewManager.js +20 -84
  136. package/ViewManager/tests/View-specs.js +0 -17
  137. package/ViewManager/tests/ViewManager-specs.js +236 -305
  138. package/ViewManager/tests/test-utils.js +0 -8
  139. package/VirtualList/UiVirtualListBase.js +265 -409
  140. package/VirtualList/VirtualList.js +29 -69
  141. package/VirtualList/VirtualListBase.js +0 -3
  142. package/VirtualList/VirtualListBasic.js +273 -431
  143. package/VirtualList/tests/VirtualGridList-native-specs.js +161 -0
  144. package/VirtualList/tests/VirtualGridList-specs.js +614 -0
  145. package/VirtualList/tests/VirtualList-native-specs.js +152 -0
  146. package/VirtualList/tests/VirtualList-specs.js +423 -95
  147. package/internal/IdProvider/IdProvider.js +7 -21
  148. package/internal/IdProvider/Provider.js +4 -17
  149. package/internal/IdProvider/tests/IdProvider-specs.js +44 -0
  150. package/internal/IdProvider/tests/useId-specs.js +6 -20
  151. package/internal/IdProvider/useId.js +0 -6
  152. package/internal/Pure/Pure.js +3 -30
  153. package/internal/Pure/tests/Pure-specs.js +88 -0
  154. package/internal/localized-fonts/localized-fonts.js +33 -62
  155. package/internal/localized-fonts/tests/localized-fonts-specs.js +33 -0
  156. package/internal/selection/selection.js +1 -6
  157. package/internal/selection/tests/selection-specs.js +6 -4
  158. package/internal/validators/tests/validators-specs.js +80 -0
  159. package/internal/validators/validators.js +14 -34
  160. package/package.json +9 -3
  161. package/resolution/ResolutionDecorator.js +4 -40
  162. package/resolution/index.js +0 -7
  163. package/resolution/resolution.js +42 -80
  164. package/resolution/tests/ResolutionDecorator-specs.js +4 -11
  165. package/resolution/tests/resolution-specs.js +2 -2
  166. package/useControlledState/tests/useControlledState-specs.js +15 -46
  167. package/useControlledState/useControlledState.js +11 -22
  168. package/useScroll/ScrollAnimator.js +49 -65
  169. package/useScroll/Scrollbar.js +22 -58
  170. package/useScroll/ScrollbarTrack.js +3 -19
  171. package/useScroll/useScroll.js +267 -454
  172. package/useScroll/utilDOM.js +8 -14
  173. package/useScroll/utilEvent.js +0 -4
  174. package/AnnounceDecorator/AnnounceDecorator.d.ts +0 -64
  175. package/BodyText/BodyText.d.ts +0 -66
  176. package/Button/Button.d.ts +0 -125
  177. package/Cancelable/Cancelable.d.ts +0 -64
  178. package/Changeable/Changeable.d.ts +0 -54
  179. package/ComponentOverride/ComponentOverride.d.ts +0 -52
  180. package/ForwardRef/ForwardRef.d.ts +0 -22
  181. package/GridListImageItem/GridListImageItem.d.ts +0 -85
  182. package/Group/Group.d.ts +0 -107
  183. package/Heading/Heading.d.ts +0 -90
  184. package/Icon/Icon.d.ts +0 -88
  185. package/IconButton/IconButton.d.ts +0 -115
  186. package/Image/Image.d.ts +0 -113
  187. package/ImageItem/ImageItem.d.ts +0 -83
  188. package/Item/Item.d.ts +0 -64
  189. package/LabeledIcon/LabeledIcon.d.ts +0 -130
  190. package/Layout/Layout.d.ts +0 -247
  191. package/Marquee/index.d.ts +0 -258
  192. package/Measurable/Measurable.d.ts +0 -26
  193. package/Media/Media.d.ts +0 -99
  194. package/Placeholder/index.d.ts +0 -53
  195. package/ProgressBar/ProgressBar.d.ts +0 -92
  196. package/RadioDecorator/RadioDecorator.d.ts +0 -35
  197. package/Repeater/Repeater.d.ts +0 -83
  198. package/Resizable/Resizable.d.ts +0 -31
  199. package/Routable/Routable.d.ts +0 -148
  200. package/Scrollable/Scrollable.d.ts +0 -0
  201. package/Scroller/Scroller.d.ts +0 -276
  202. package/Skinnable/Skinnable.d.ts +0 -94
  203. package/Slider/Slider.d.ts +0 -202
  204. package/SlotItem/SlotItem.d.ts +0 -118
  205. package/Slottable/Slottable.d.ts +0 -22
  206. package/Spinner/Spinner.d.ts +0 -95
  207. package/ToggleIcon/ToggleIcon.d.ts +0 -90
  208. package/ToggleItem/ToggleItem.d.ts +0 -134
  209. package/Toggleable/Toggleable.d.ts +0 -103
  210. package/Touchable/Touchable.d.ts +0 -175
  211. package/Transition/Transition.d.ts +0 -196
  212. package/ViewManager/ViewManager.d.ts +0 -191
  213. package/VirtualList/VirtualList.d.ts +0 -530
  214. package/index.d.ts +0 -0
  215. package/internal/IdProvider/IdProvider.d.ts +0 -0
  216. package/internal/Pure/Pure.d.ts +0 -0
  217. package/internal/localized-fonts/localized-fonts.d.ts +0 -53
  218. package/internal/selection/selection.d.ts +0 -0
  219. package/internal/validators/validators.d.ts +0 -0
  220. package/resolution/index.d.ts +0 -187
  221. package/useControlledState/useControlledState.d.ts +0 -0
  222. package/useScroll/useScroll.d.ts +0 -0
@@ -1,276 +0,0 @@
1
- // Type definitions for ui/Scroller
2
-
3
- import * as React from "react";
4
-
5
- type Omit<T, K extends keyof T> = Pick<T, Exclude<keyof T, K>>;
6
- type Merge<M, N> = Omit<M, Extract<keyof M, keyof N>> & N;
7
-
8
- export interface ScrollerBasicProps {
9
- /**
10
- * Direction of the scroller.
11
- *
12
- * Valid values are:
13
- * * `'both'` ,
14
- * * `'horizontal'` , and
15
- * * `'vertical'` .
16
- */
17
- direction?: string;
18
- }
19
- /**
20
- * An unstyled base scroller component.
21
- */
22
-
23
- export class ScrollerBasic extends React.Component<
24
- Merge<React.HTMLProps<HTMLElement>, ScrollerBasicProps>
25
- > {}
26
-
27
- export interface ScrollerBaseProps {
28
- /**
29
- * A callback function that receives a reference to the `scrollTo` feature.
30
- *
31
- * Once received, the `scrollTo` method can be called as an imperative interface.
32
- *
33
- * The `scrollTo` function accepts the following parameters:
34
- * * {position: {x, y}} - Pixel value for x and/or y position
35
- * * {align} - Where the scroll area should be aligned. Values are:
36
- `'left'` , `'right'` , `'top'` , `'bottom'` ,
37
- `'topleft'` , `'topright'` , `'bottomleft'` , and `'bottomright'` .
38
- * * {node} - Node to scroll into view
39
- * * {animate} - When `true` , scroll occurs with animation. When `false` , no
40
- animation occurs.
41
- * * {focus} - When `true` , attempts to focus item after scroll. Only valid when scrolling
42
- by `index` or `node` .
43
- *
44
- * Note: Only specify one of: `position` , `align` , `index` or `node`
45
- *
46
- * Example:
47
- * ```
48
- // If you set cbScrollTo prop like below;
49
- cbScrollTo: (fn) => {this.scrollTo = fn;}
50
- // You can simply call like below;
51
- this.scrollTo({align: 'top'}); // scroll to the top
52
- ```
53
- */
54
- cbScrollTo?: Function;
55
- /**
56
- * Direction of the scroller.
57
- *
58
- * Valid values are:
59
- * * `'both'` ,
60
- * * `'horizontal'` , and
61
- * * `'vertical'` .
62
- */
63
- direction?: string;
64
- /**
65
- * Specifies how to show horizontal scrollbar.
66
- *
67
- * Valid values are:
68
- * * `'auto'` ,
69
- * * `'visible'` , and
70
- * * `'hidden'` .
71
- */
72
- horizontalScrollbar?: string;
73
- /**
74
- * Prevents scroll by wheeling on the scroller.
75
- */
76
- noScrollByWheel?: boolean;
77
- /**
78
- * Called when scrolling.
79
- *
80
- * Passes `scrollLeft` and `scrollTop` .
81
- It is not recommended to set this prop since it can cause performance degradation.
82
- Use `onScrollStart` or `onScrollStop` instead.
83
- */
84
- onScroll?: Function;
85
- /**
86
- * Called when scroll starts.
87
- *
88
- * Passes `scrollLeft` and `scrollTop` .
89
- *
90
- * Example:
91
- * ```
92
- onScrollStart = ({scrollLeft, scrollTop}) => {
93
- // do something with scrollLeft and scrollTop
94
- }
95
-
96
- render = () => (
97
- <Scroller
98
- ...
99
- onScrollStart={this.onScrollStart}
100
- ...
101
- />
102
- )
103
- ```
104
- */
105
- onScrollStart?: Function;
106
- /**
107
- * Called when scroll stops.
108
- *
109
- * Passes `scrollLeft` and `scrollTop` .
110
- *
111
- * Example:
112
- * ```
113
- onScrollStop = ({scrollLeft, scrollTop}) => {
114
- // do something with scrollLeft and scrollTop
115
- }
116
-
117
- render = () => (
118
- <Scroller
119
- ...
120
- onScrollStop={this.onScrollStop}
121
- ...
122
- />
123
- )
124
- ```
125
- */
126
- onScrollStop?: Function;
127
- /**
128
- * Specifies how to show vertical scrollbar.
129
- *
130
- * Valid values are:
131
- * * `'auto'` ,
132
- * * `'visible'` , and
133
- * * `'hidden'` .
134
- */
135
- verticalScrollbar?: string;
136
- }
137
- /**
138
- * An unstyled base scroller component.
139
- *
140
- * In most circumstances, you will want to use the Scrollable version.
141
- */
142
-
143
- export class ScrollerBase extends React.Component<
144
- Merge<React.HTMLProps<HTMLElement>, ScrollerBaseProps>
145
- > {}
146
-
147
- export interface ScrollerProps extends ScrollerBasicProps {
148
- /**
149
- * A callback function that receives a reference to the `scrollTo` feature.
150
- *
151
- * Once received, the `scrollTo` method can be called as an imperative interface.
152
- * * {position: {x, y}} - Pixel value for x and/or y position
153
- * * {align} - Where the scroll area should be aligned. Values are:
154
- `'left'` , `'right'` , `'top'` , `'bottom'` ,
155
- `'topleft'` , `'topright'` , `'bottomleft'` , and `'bottomright'` .
156
- * * {node} - Node to scroll into view
157
- * * {animate} - When `true` , scroll occurs with animation. When `false` , no
158
- animation occurs.
159
- * * {focus} - When `true` , attempts to focus item after scroll. Only valid when scrolling
160
- by `node` .
161
- *
162
- * Note: Only specify one of: `position` , `align` , `node`
163
- *
164
- * Example:
165
- * ```
166
- // If you set cbScrollTo prop like below;
167
- cbScrollTo: (fn) => {this.scrollTo = fn;}
168
- // You can simply call like below;
169
- this.scrollTo({align: 'top'}); // scroll to the top
170
- ```
171
- */
172
- cbScrollTo?: Function;
173
- /**
174
- * Direction of the scroller.
175
- *
176
- * Valid values are:
177
- * * `'both'` ,
178
- * * `'horizontal'` , and
179
- * * `'vertical'` .
180
- */
181
- direction?: string;
182
- /**
183
- * Specifies how to show horizontal scrollbar.
184
- *
185
- * Valid values are:
186
- * * `'auto'` ,
187
- * * `'visible'` , and
188
- * * `'hidden'` .
189
- */
190
- horizontalScrollbar?: string;
191
- /**
192
- * Prevents scroll by wheeling on the scroller.
193
- */
194
- noScrollByWheel?: boolean;
195
- /**
196
- * Called when scrolling.
197
- *
198
- * Passes `scrollLeft` , `scrollTop` .
199
- It is not recommended to set this prop since it can cause performance degradation.
200
- Use `onScrollStart` or `onScrollStop` instead.
201
- */
202
- onScroll?: Function;
203
- /**
204
- * Called when scroll starts.
205
- *
206
- * Passes `scrollLeft` and `scrollTop` .
207
- *
208
- * Example:
209
- * ```
210
- onScrollStart = ({scrollLeft, scrollTop}) => {
211
- // do something with scrollLeft and scrollTop
212
- }
213
-
214
- render = () => (
215
- <Scroller
216
- ...
217
- onScrollStart={this.onScrollStart}
218
- ...
219
- />
220
- )
221
- ```
222
- */
223
- onScrollStart?: Function;
224
- /**
225
- * Called when scroll stops.
226
- *
227
- * Passes `scrollLeft` and `scrollTop` .
228
- *
229
- * Example:
230
- * ```
231
- onScrollStop = ({scrollLeft, scrollTop}) => {
232
- // do something with scrollLeft and scrollTop
233
- }
234
-
235
- render = () => (
236
- <Scroller
237
- ...
238
- onScrollStop={this.onScrollStop}
239
- ...
240
- />
241
- )
242
- ```
243
- */
244
- onScrollStop?: Function;
245
- /**
246
- * Specifies how to scroll.
247
- *
248
- * Valid values are:
249
- * * `'translate'` ,
250
- * * `'native'` .
251
- */
252
- scrollMode?: string;
253
- /**
254
- * Specifies how to show vertical scrollbar.
255
- *
256
- * Valid values are:
257
- * * `'auto'` ,
258
- * * `'visible'` , and
259
- * * `'hidden'` .
260
- */
261
- verticalScrollbar?: string;
262
- }
263
- /**
264
- * An unstyled scroller.
265
- *
266
- * Example:
267
- * ```
268
- <Scroller>Scroll me.</Scroller>
269
- ```
270
- */
271
-
272
- export class Scroller extends React.Component<
273
- Merge<React.HTMLProps<HTMLElement>, ScrollerProps>
274
- > {}
275
-
276
- export default Scroller;
@@ -1,94 +0,0 @@
1
- // Type definitions for ui/Skinnable
2
-
3
- type Omit<T, K extends keyof T> = Pick<T, Exclude<keyof T, K>>;
4
- type Merge<M, N> = Omit<M, Extract<keyof M, keyof N>> & N;
5
-
6
- export interface SkinnableConfig extends Object {
7
- /**
8
- * The prop in which to pass the skinVariants value to the wrapped component. The recommended
9
- value is "skinVariants".
10
- *
11
- * If left unset, the skinVariant will not be passed to the wrapped component.
12
- */
13
- variantsProp?: string;
14
- /**
15
- * The prop in which to pass the effective skin to the wrapped component.
16
- *
17
- * If left unset, the current skin will not be passed to the wrapped component.
18
- */
19
- prop?: string;
20
- /**
21
- * A hash mapping the available skin names to their CSS class name.
22
- *
23
- * The keys are accepted as the only valid values for the `skin` prop on the wrapped component.
24
- */
25
- skins?: object;
26
- /**
27
- * Assign a default skin from the `skins` list.
28
- *
29
- * This will be used if the instantiator of the wrapped component provides no value to the
30
- `skin` prop.
31
- */
32
- defaultSkin?: string;
33
- /**
34
- * Initial collection of applied variants
35
- *
36
- * This will be used if the instantiator of the wrapped component provides no value to the
37
- `skinVariants` prop.
38
- */
39
- defaultVariants?: string | string[];
40
- /**
41
- * A complete list of all supported variants.
42
- *
43
- * These will translate to CSS class names so should not conflict with any skin names.
44
- CamelCase is recommended for the values.
45
- */
46
- allowedVariants?: string[];
47
- }
48
- export interface SkinnableProps {
49
- /**
50
- * The name of the skin a component should use to render itself. Available skins are
51
- defined in the "defaultConfig" for this HOC.
52
- */
53
- skin?: string;
54
- /**
55
- * The variant(s) on a skin that a component should use when rendering. These will
56
- typically alter the appearance of a skin's existing definition in a way that does not
57
- override that skin's general styling.
58
- *
59
- * Multiple data types are supported by this prop, which afford different conveniences
60
- and abilities. String and Array are effectively the same, supporting just additions
61
- to the variants being applied to a component, and are much more convenient. Objects
62
- may also be used, and have the ability to disable variants being passed by their
63
- ancestors. Objects take the format of a basic hash, with variants as key names and
64
- true/false Booleans as values, depicting their state. If a variant is excluded from
65
- any version of data type used to set this prop, that variant will ignored, falling
66
- back to the defaultVariant or parent variant, in that order.
67
- *
68
- * skinVariants examples:
69
- * ```
70
- // String
71
- skinVariants="highContrast"
72
-
73
- // Array
74
- skinVariants={['highContrast']}
75
-
76
- // Object
77
- skinVariants={{
78
- highContrast: true,
79
- grayscale: false
80
- }}
81
- ```
82
- */
83
- skinVariants?: string | string[] | object;
84
- }
85
- export function Skinnable<P>(
86
- config: SkinnableConfig,
87
- Component: React.ComponentType<P> | string
88
- ): React.ComponentType<P & SkinnableProps>;
89
-
90
- export function Skinnable<P>(
91
- Component: React.ComponentType<P> | string
92
- ): React.ComponentType<P & SkinnableProps>;
93
-
94
- export default Skinnable;
@@ -1,202 +0,0 @@
1
- // Type definitions for ui/Slider
2
-
3
- import * as React from "react";
4
- import { ChangeableProps as ui_Changeable_ChangeableProps } from "@enact/ui/Changeable";
5
- import { TouchableProps as ui_Touchable_TouchableProps } from "@enact/ui/Touchable";
6
-
7
- type Omit<T, K extends keyof T> = Pick<T, Exclude<keyof T, K>>;
8
- type Merge<M, N> = Omit<M, Extract<keyof M, keyof N>> & N;
9
-
10
- export interface KnobProps {
11
- /**
12
- * The orientation of the slider, either `"horizontal"` or `"vertical"` .
13
- */
14
- orientation?: string;
15
- /**
16
- * A number between 0 and 1 representing the proportion of the `value` in terms of `min`
17
- and `max` props of the slider.
18
- */
19
- proportion?: boolean;
20
- /**
21
- * Adds a tooltip to the knob using the provided component.
22
- *
23
- * The following props are forwarded to the tooltip:
24
- * * `children` - The `value` prop from the slider
25
- * * `orientation` - The value of the `orientation` prop from the slider
26
- * * `proportion` - The value of the `proportion` prop from the knob
27
- *
28
- * This prop accepts either a Component (e.g. `MyTooltip` } which will be instantiated with
29
- the above props or a component instance (e.g. `<MyTooltip customProp="value" />` ) which
30
- will have its props merged with the above props.
31
- */
32
- tooltipComponent?: Function | JSX.Element;
33
- /**
34
- * The value of the slider.
35
- */
36
- value?: number;
37
- }
38
- /**
39
- * An unstyled, knob component to be used with a `Slider` .
40
- */
41
-
42
- export class Knob extends React.Component<
43
- Merge<React.HTMLProps<HTMLElement>, KnobProps>
44
- > {}
45
-
46
- export interface SliderBaseProps {
47
- /**
48
- * The component used to render the progress bar within the slider.
49
- *
50
- * The provided component will receive the following props from `Slider`
51
- * * backgroundProgress - The value of `backgroundProgress`
52
- * * orientation - The value of `orientation`
53
- * * progress - The `value` as a proportion between `min` and `max`
54
- * * progressAnchor - The value of `progressAnchor`
55
- *
56
- * This prop accepts either a Component (e.g. `MyProgress` } which will be instantiated with
57
- the above props or a component instance (e.g. `<MyProgress customProp="value" />` ) which
58
- will have its props merged with the above props.
59
- */
60
- progressBarComponent: React.ComponentType | JSX.Element;
61
- /**
62
- * Background progress, as a proportion between `0` and `1` .
63
- */
64
- backgroundProgress?: number;
65
- /**
66
- * Called with a reference to the root component.
67
- *
68
- * When using , the `ref` prop is forwarded to this component
69
- as `componentRef` .
70
- */
71
- componentRef?: object | Function;
72
- /**
73
- * Customizes the component by mapping the supplied collection of CSS class names to the
74
- corresponding internal elements and states of this component.
75
- *
76
- * The following classes are supported:
77
- * * `slider` - The root component class
78
- * * `knob` - The knob node
79
- * * `horizontal` - Applied when `orientation` prop is `"horizontal"``
80
- * * `pressed` - Applied when `pressed` prop is `true`
81
- * * `noFill` - Applied when `noFill` prop is `true`
82
- * * `vertical` - Applied when `orientation` prop is `"vertical"`
83
- */
84
- css?: object;
85
- /**
86
- * Disables component and does not generate events.
87
- */
88
- disabled?: boolean;
89
- /**
90
- * Defines a custom knob component for the slider.
91
- *
92
- * By default, Slider will use its own implementation, .
93
- *
94
- * The following props are forwarded to the knob:
95
- * * `className` - A `knob` class applied by the slider
96
- * * `disabled` - The value of `disabled`
97
- * * `orientation` - The value of `orientation`
98
- * * `proportion` - The `value` as a proportion between `min` and `max`
99
- * * `tooltipComponent` - The value of `tooltipComponent`
100
- * * `value` - The value of `value`
101
- *
102
- * This prop accepts either a Component (e.g. `MyKnob` } which will be instantiated with
103
- the above props or a component instance (e.g. `<MyKnob customProp="value" />` ) which
104
- will have its props merged with the above props.
105
- */
106
- knobComponent?: React.ComponentType | JSX.Element;
107
- /**
108
- * The maximum value of the slider.
109
- *
110
- * The range between `min` and `max` should be evenly divisible by
111
- [step] .
112
- */
113
- max?: number;
114
- /**
115
- * The minimum value of the slider.
116
- *
117
- * The range between `min` and `max` should be evenly divisible by
118
- [step] .
119
- */
120
- min?: number;
121
- /**
122
- * Applies the style where the slider bar does not display filled.
123
- */
124
- noFill?: boolean;
125
- /**
126
- * The orientation of the slider.
127
- *
128
- * Allowed values include:
129
- * * `'horizontal'` - A left and right orientation
130
- * * `'vertical'` - An up and down orientation
131
- */
132
- orientation?: string;
133
- /**
134
- * Applies a pressed visual effect.
135
- */
136
- pressed?: boolean;
137
- /**
138
- * Sets the point, as a proportion between 0 and 1, from which the slider is filled.
139
- *
140
- * Applies to both the slider's `value` and `backgroundProgress` . In both cases,
141
- setting the value of `progressAnchor` will cause the slider to fill from that point
142
- down, when `value` or `backgroundProgress` is proportionally less than the anchor, or up,
143
- when `value` or `backgroundProgress` is proportionally greater than the anchor, rather
144
- than always from the start of the slider.
145
- */
146
- progressAnchor?: number;
147
- /**
148
- * The amount to increment or decrement the value.
149
- *
150
- * It must evenly divide into the range designated by `min` and `max` .
151
- */
152
- step?: number;
153
- /**
154
- * Adds a tooltip to the slider using the provided component.
155
- *
156
- * The following props are forwarded to the tooltip:
157
- * * `children` - The `value` prop from the slider
158
- * * `orientation` - The value of the `orientation` prop from the slider
159
- * * `proportion` - The `value` as a proportion between `min` and `max`
160
- *
161
- * This prop accepts either a Component (e.g. `MyTooltip` } which will be instantiated with
162
- the above props or a component instance (e.g. `<MyTooltip customProp="value" />` ) which
163
- will have its props merged with the above props.
164
- */
165
- tooltipComponent?: React.ComponentType | JSX.Element;
166
- /**
167
- * The value of the slider.
168
- *
169
- * Defaults to the value of `min` .
170
- */
171
- value?: number;
172
- }
173
- /**
174
- * An unstyled, sliding range-selection component.
175
- */
176
-
177
- export class SliderBase extends React.Component<
178
- Merge<React.HTMLProps<HTMLElement>, SliderBaseProps>
179
- > {}
180
-
181
- export interface SliderDecoratorProps
182
- extends Merge<ui_Changeable_ChangeableProps, ui_Touchable_TouchableProps> {}
183
- export function SliderDecorator<P>(
184
- Component: React.ComponentType<P> | string
185
- ): React.ComponentType<P & SliderDecoratorProps>;
186
-
187
- export interface SliderProps
188
- extends Omit<Merge<SliderBaseProps, SliderDecoratorProps>, "componentRef"> {
189
- /**
190
- * Called when the value is changed.
191
- */
192
- onChange?: Function;
193
- }
194
- /**
195
- * A minimally-styled slider component with touch and drag support.
196
- */
197
-
198
- export class Slider extends React.Component<
199
- Merge<React.HTMLProps<HTMLElement>, SliderProps>
200
- > {}
201
-
202
- export default Slider;
@@ -1,118 +0,0 @@
1
- // Type definitions for ui/SlotItem
2
-
3
- import * as React from "react";
4
- import { SlottableProps as ui_Slottable_SlottableProps } from "@enact/ui/Slottable";
5
- import { ForwardRefProps as ui_ForwardRef_ForwardRefProps } from "@enact/ui/ForwardRef";
6
-
7
- type Omit<T, K extends keyof T> = Pick<T, Exclude<keyof T, K>>;
8
- type Merge<M, N> = Omit<M, Extract<keyof M, keyof N>> & N;
9
-
10
- export interface SlotItemBaseProps {
11
- /**
12
- * The type of component to use to render the item.
13
- *
14
- * This component will receive the `inline` prop and any additional unhandled props provided
15
- to `SlotItem` . A derivative of [Item] is recommended.
16
- */
17
- component: React.ComponentType;
18
- /**
19
- * Controls the visibility state of the slots.
20
- *
21
- * One, both, or neither slot can be shown. Choosing `'after'` will leave `slotBefore`
22
- visible at all times; only `slotAfter` will have its visibility toggled. Valid values
23
- are `'before'` , `'after'` and `'both'` . Omitting the property will result in
24
- no-auto-hiding for either slot so they will both be present.
25
- *
26
- * In order for `autoHide` to have a visual affect, the `hidden` class must be tied to
27
- another condition such as focus.
28
- * ```
29
- .slot.hidden:not(:focus) {
30
- display: none;
31
- }
32
- ```
33
- */
34
- autoHide?: boolean;
35
- /**
36
- * Called with a reference to the root component.
37
- *
38
- * When using , the `ref` prop is forwarded to this component
39
- as `componentRef` .
40
- */
41
- componentRef?: object | Function;
42
- /**
43
- * Customizes the component by mapping the supplied collection of CSS class names to the
44
- corresponding internal elements and states of this component.
45
- *
46
- * The following classes are supported:
47
- * * `slotItem` - The root class name
48
- * * `slot` - Applied to both slots
49
- * * `after` - Applied to the slot that falls after the content
50
- * * `before` - Applied to the slot that falls before the content
51
- * * `hidden` - Applied to a slot when that slot is supposed to be hidden, according to
52
- `autoHide` prop
53
- */
54
- css?: object;
55
- /**
56
- * Applies inline styling to the component.
57
- */
58
- inline?: boolean;
59
- /**
60
- * The layout technique for `SlotItem` .
61
- *
62
- * `"flex"` is applied as a default and gives basic flex support to the wrapping elements.
63
- This may be set to `null` to define your own layout method.
64
- */
65
- layout?: string;
66
- /**
67
- * Nodes to be inserted after `children` and hidden using `autoHide` .
68
- *
69
- * If nothing is specified, nothing, not even an empty container, is rendered in this place.
70
- */
71
- slotAfter?: React.ReactNode;
72
- /**
73
- * Nodes to be inserted before `children` and hidden using `autoHide` .
74
- *
75
- * If nothing is specified, nothing, not even an empty container, is rendered in this place.
76
- */
77
- slotBefore?: React.ReactNode;
78
- }
79
- /**
80
- * A ui-styled `SlotItem` without any behavior.
81
- */
82
-
83
- export class SlotItemBase extends React.Component<
84
- Merge<React.HTMLProps<HTMLElement>, SlotItemBaseProps>
85
- > {}
86
-
87
- export interface SlotItemDecoratorProps
88
- extends Merge<ui_Slottable_SlottableProps, ui_ForwardRef_ForwardRefProps> {}
89
- export function SlotItemDecorator<P>(
90
- Component: React.ComponentType<P> | string
91
- ): React.ComponentType<P & SlotItemDecoratorProps>;
92
-
93
- export interface SlotItemProps
94
- extends Omit<
95
- Merge<SlotItemBaseProps, SlotItemDecoratorProps>,
96
- "componentRef"
97
- > {}
98
- /**
99
- * A ui-styled item with built-in support for slots.
100
- *
101
- * Example:
102
- * ```
103
- <SlotItem component={Item} autoHide="both">
104
- <slotBefore>
105
- <Icon>flag</Icon>
106
- <Icon>star</Icon>
107
- </slotBefore>
108
- An Item that will show some icons slotBefore and slotAfter this text when spotted
109
- <Icon slot="slotAfter">trash</Icon>
110
- </SlotItem>
111
- ```
112
- */
113
-
114
- export class SlotItem extends React.Component<
115
- Merge<React.HTMLProps<HTMLElement>, SlotItemProps>
116
- > {}
117
-
118
- export default SlotItem;
@@ -1,22 +0,0 @@
1
- // Type definitions for ui/Slottable
2
-
3
- type Omit<T, K extends keyof T> = Pick<T, Exclude<keyof T, K>>;
4
- type Merge<M, N> = Omit<M, Extract<keyof M, keyof N>> & N;
5
-
6
- export interface SlottableConfig extends Object {
7
- /**
8
- * Array of slot names which will be extracted from `children` and distributed to props.
9
- */
10
- slots?: string[];
11
- }
12
- export interface SlottableProps {}
13
- export function Slottable<P>(
14
- config: SlottableConfig,
15
- Component: React.ComponentType<P> | string
16
- ): React.ComponentType<P & SlottableProps>;
17
-
18
- export function Slottable<P>(
19
- Component: React.ComponentType<P> | string
20
- ): React.ComponentType<P & SlottableProps>;
21
-
22
- export default Slottable;