@enact/ui 4.0.9 → 4.0.10

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.
@@ -11,7 +11,7 @@ export interface BodyTextBaseProps {
11
11
  * Centers the contents.
12
12
  *
13
13
  * Applies the `centered` CSS class which can be customized by
14
- theming .
14
+ [theming] .
15
15
  */
16
16
  centered?: boolean;
17
17
  /**
@@ -55,10 +55,10 @@ externally.
55
55
  */
56
56
  icon?: React.ReactNode | boolean;
57
57
  /**
58
- * The component used to render the icon .
58
+ * The component used to render the [icon] .
59
59
  *
60
60
  * This component will receive the `icon` class to customize its styling.
61
- If icon is not assigned or is false, this component
61
+ If [icon] is not assigned or is false, this component
62
62
  will not be rendered.
63
63
  *
64
64
  * If this is a component rather than an HTML element string, this component will also
@@ -74,28 +74,28 @@ handle it.
74
74
  * Enforces a minimum width for the component.
75
75
  *
76
76
  * Applies the `minWidth` CSS class which can be customized by
77
- theming .
77
+ [theming] .
78
78
  */
79
79
  minWidth?: boolean;
80
80
  /**
81
81
  * Indicates the component is depressed.
82
82
  *
83
83
  * Applies the `pressed` CSS class which can be customized by
84
- theming .
84
+ [theming] .
85
85
  */
86
86
  pressed?: boolean;
87
87
  /**
88
88
  * Indicates the component is selected.
89
89
  *
90
90
  * Applies the `selected` CSS class which can be customized by
91
- theming .
91
+ [theming] .
92
92
  */
93
93
  selected?: boolean;
94
94
  /**
95
95
  * The size of the button.
96
96
  *
97
97
  * Applies the CSS class which can be customized by
98
- theming .
98
+ [theming] .
99
99
  */
100
100
  size?: string;
101
101
  }
package/CHANGELOG.md CHANGED
@@ -2,6 +2,10 @@
2
2
 
3
3
  The following is a curated list of changes in the Enact ui module, newest changes on the top.
4
4
 
5
+ ## [4.0.10] - 2022-04-05
6
+
7
+ No significant changes.
8
+
5
9
  ## [4.0.9] - 2021-12-15
6
10
 
7
11
  No significant changes.
@@ -36,7 +36,7 @@ If there is custom selectionOverlay component, this icon will not be shown.
36
36
  */
37
37
  imageComponent?: React.ComponentType;
38
38
  /**
39
- * Placeholder image used while source
39
+ * Placeholder image used while [source]
40
40
  is loaded.
41
41
  */
42
42
  placeholder?: string;
package/Group/Group.d.ts CHANGED
@@ -69,9 +69,9 @@ as `componentRef` .
69
69
  * Selection mode for the group
70
70
  * * `single` - Allows for 0 or 1 item to be selected. The selected item may be deselected.
71
71
  * * `radio` - Allows for 0 or 1 item to be selected. The selected item may only be
72
- deselected by selecting another item.
72
+ deselected by selecting another item.
73
73
  * * `multiple` - Allows 0 to _n_ items to be selected. Each item may be selected or
74
- deselected.
74
+ deselected.
75
75
  */
76
76
  select?: string;
77
77
  /**
@@ -50,7 +50,8 @@ corresponding internal elements and states of this component.
50
50
  * Set the size of this component.
51
51
  * * `'title'` and `'subtitle'` are generally considered to be used only once on a given screen.
52
52
  * * `'large'` , `'medium'` , `'small'` , and `'tiny'` are typically used as section headings
53
- for content on a screen, starting with `'large'` for the first tier of information
53
+ *
54
+ * for content on a screen, starting with `'large'` for the first tier of information
54
55
  followed by `'medium'` for the next, and so fourth.
55
56
  *
56
57
  * If the `spacing` prop is not set (defaulting to "auto"), these values automatically set
package/Icon/Icon.d.ts CHANGED
@@ -11,7 +11,7 @@ export interface IconBaseProps {
11
11
  * The icon content.
12
12
  *
13
13
  * May be specified as either:
14
- * * A string that represents an icon from the iconList ,
14
+ * * A string that represents an icon from the [iconList] ,
15
15
  * * An HTML entity string, Unicode reference or hex value (in the form '0x...'),
16
16
  * * A URL specifying path to an icon image, or
17
17
  * * An object representing a resolution independent resource (See ).
@@ -30,8 +30,8 @@ corresponding internal elements and states of this component.
30
30
  *
31
31
  * The following classes are supported:
32
32
  * * `icon` - The root component class
33
- * * `dingbat` - Applied when the value of `icon` is not
34
- found in iconList
33
+ * * `dingbat` - Applied when the value of [ `icon` ] is not
34
+ found in [iconList]
35
35
  * * `large` - Applied when `size` prop is `'large'`
36
36
  * * `pressed` - Applied when `pressed` prop is `true`
37
37
  * * `small` - Applied when `size` prop is `'small'`
@@ -58,7 +58,7 @@ renders in a React + JSX string.
58
58
  * The size of the button.
59
59
  *
60
60
  * Applies the CSS class which can be customized by
61
- theming .
61
+ [theming] .
62
62
  */
63
63
  size?: string;
64
64
  }
@@ -14,7 +14,7 @@ export interface IconButtonBaseProps {
14
14
  */
15
15
  buttonComponent: React.ComponentType | JSX.Element;
16
16
  /**
17
- * The component used to render the icon .
17
+ * The component used to render the [icon] .
18
18
  *
19
19
  * This component will receive the `flip` and `size` property set on the `IconButton` as well as the
20
20
  `icon` class to customize its styling.
@@ -39,7 +39,7 @@ corresponding internal elements and states of this component.
39
39
  *
40
40
  * The following classes are supported:
41
41
  * * `iconButton` - The root component class
42
- * * `icon` - The icon component class
42
+ * * `icon` - The [icon component] class
43
43
  * * `large` - Applied when `size` prop is `'large'`
44
44
  * * `small` - Applied when `size` prop is `'small'`
45
45
  * * `pressed` - Applied when `pressed` prop is `true`
@@ -49,7 +49,7 @@ corresponding internal elements and states of this component.
49
49
  * Disables IconButton.
50
50
  *
51
51
  * When `true` , the button is shown as disabled and does not generate
52
- `onClick` events .
52
+ `onClick` [events] .
53
53
  */
54
54
  disabled?: boolean;
55
55
  /**
@@ -74,7 +74,7 @@ corresponding internal elements and states of this component.
74
74
  * The size of the button.
75
75
  *
76
76
  * Applies the CSS class which can be customized by
77
- theming .
77
+ [theming] .
78
78
  */
79
79
  size?: string;
80
80
  }
@@ -29,8 +29,8 @@ corresponding internal elements and states of this component.
29
29
  * * `labeledIcon` - The root component class
30
30
  * * `icon` - The icon component class
31
31
  * * `iconCell` - Applied to the `iconComponent` directly, like `.icon` . If `icon` in a
32
- React component, this class is applied to the container of the icon,
33
- rather than the icon itself.
32
+ React component, this class is applied to the container of the icon,
33
+ rather than the icon itself.
34
34
  * * `label` - The label component class
35
35
  * * `inline` - Applied when the inline prop is set
36
36
  * * `above` - Applied when the labelPosition prop is set to above
@@ -68,7 +68,7 @@ also receive the `flip` and `size` props as set on the component.
68
68
  * Enables this component to be used in an "inline" context.
69
69
  *
70
70
  * This is useful for when you have several of these components in a row and are not using a
71
- Layout or flex-box configuration.
71
+ [Layout] or flex-box configuration.
72
72
  */
73
73
  inline?: boolean;
74
74
  /**
@@ -89,7 +89,7 @@ also receive the `flip` and `size` props as set on the component.
89
89
  * The size of the icon.
90
90
  *
91
91
  * Applies the CSS class which can be customized by
92
- theming .
92
+ [theming] .
93
93
  */
94
94
  size?: string;
95
95
  }
@@ -19,7 +19,7 @@ horizontally in the case of a vertical layout. `"start"` , `"center"` and
19
19
  */
20
20
  align?: string;
21
21
  /**
22
- * Any valid Node that should be positioned in this `Cell` .
22
+ * Any valid [Node] that should be positioned in this `Cell` .
23
23
  */
24
24
  children?: Any;
25
25
  /**
@@ -40,14 +40,14 @@ as `componentRef` .
40
40
  * A `shrink` able cell will contract to its minimum size, according to the dimensions of its
41
41
  contents. This is used when you want the size of this Cell's content to influence the
42
42
  dimensions of this cell. `shrink` will not allow the contents of the Layout to be pushed
43
- beyond its boundaries (overflowing). See the size property
43
+ beyond its boundaries (overflowing). See the [size] property
44
44
  for more details.
45
45
  */
46
46
  shrink?: boolean;
47
47
  /**
48
48
  * Sets the desired size of the Cell using any valid CSS measurement value.
49
49
  *
50
- * When used in conjunction with shrink , the size will be
50
+ * When used in conjunction with [shrink] , the size will be
51
51
  the maximum size, shrinking as necessary, to fit the content.
52
52
  *
53
53
  * E.g.
@@ -57,14 +57,14 @@ and will match your contents size if it's smaller
57
57
  *
58
58
  * This accepts any valid CSS measurement value string. If a numeric value is used, it will
59
59
  be treated as a pixel value and converted to a
60
- relative unit based on the rules of
61
- resolution independence .
60
+ [relative unit] based on the rules of
61
+ [resolution independence] .
62
62
  */
63
63
  size?: string | number;
64
64
  }
65
65
  /**
66
66
  * A stateless component that provides a space for your content in a
67
- Layout , without applied.
67
+ [Layout] , without applied.
68
68
  */
69
69
 
70
70
  export class CellBase extends React.Component<
@@ -80,7 +80,7 @@ export interface LayoutBaseProps {
80
80
  /**
81
81
  * The alignment of children.
82
82
  *
83
- * Aligns the children Cells vertically in the case of a horizontal
83
+ * Aligns the children [Cells] vertically in the case of a horizontal
84
84
  layout or horizontally in the case of a vertical layout. `"start"` , `"center"` and
85
85
  `"end"` are the most commonly used, although all values of `align-items` are supported.
86
86
  `"start"` refers to the top in a horizontal layout, and left in a vertical LTR layout
@@ -93,7 +93,7 @@ separated by a space.
93
93
  */
94
94
  align?: string;
95
95
  /**
96
- * Only Cell components are supported as children.
96
+ * Only [Cell] components are supported as children.
97
97
  */
98
98
  children?: Cell | Cell[];
99
99
  /**
@@ -114,7 +114,7 @@ instead of carving out the entire horizontal space for itself.
114
114
  */
115
115
  inline?: boolean;
116
116
  /**
117
- * The orientation of the `Layout` , i.e. how the children Cells are
117
+ * The orientation of the `Layout` , i.e. how the children [Cells] are
118
118
  positioned on the screen. Must be either `'horizontal'` or `'vertical'` .
119
119
  */
120
120
  orientation?: string;
@@ -132,9 +132,9 @@ additional lines are placed above/before the preceding line instead of below/aft
132
132
  /**
133
133
  * A container for `Cell` s.
134
134
  *
135
- * A stateless component that acts as a containing area for Cells to be
135
+ * A stateless component that acts as a containing area for [Cells] to be
136
136
  positioned in a row or a column (horizontally or vertically, respectively. It supports an
137
- orientation property for laying-out its contents
137
+ [orientation] property for laying-out its contents
138
138
  ( `Cells` ) in an organized, readable way.
139
139
  *
140
140
  * Example:
@@ -163,7 +163,7 @@ export interface CellProps
163
163
  extends Omit<Merge<CellBaseProps, CellDecoratorProps>, "componentRef"> {}
164
164
  /**
165
165
  * A stateless component that provides a space for your content in a
166
- Layout .
166
+ [Layout] .
167
167
  */
168
168
 
169
169
  export class Cell extends React.Component<
@@ -183,9 +183,9 @@ export interface LayoutProps
183
183
  /**
184
184
  * A container for `Cell` s.
185
185
  *
186
- * A stateless component that acts as a containing area for Cells to be
186
+ * A stateless component that acts as a containing area for [Cells] to be
187
187
  positioned in a row or a column (horizontally or vertically, respectively. It supports an
188
- orientation property for laying-out its contents
188
+ [orientation] property for laying-out its contents
189
189
  ( `Cells` ) in an organized, readable way.
190
190
  *
191
191
  * Example:
@@ -214,7 +214,7 @@ export interface ColumnProps
214
214
  extends Merge<LayoutProps, ui_ForwardRef_ForwardRefProps> {}
215
215
  /**
216
216
  * Shorthand for `<Layout orientation="vertical">` , which positions its
217
- Cells vertically.
217
+ [Cells] vertically.
218
218
  * ```
219
219
  ┌────┐
220
220
  ├────┤
@@ -232,7 +232,7 @@ export interface RowProps
232
232
  extends Merge<LayoutProps, ui_ForwardRef_ForwardRefProps> {}
233
233
  /**
234
234
  * Shorthand for `<Layout orientation="horizontal">` , which positions its
235
- Cells horizontally.
235
+ [Cells] horizontally.
236
236
  * ```
237
237
  ┌─┬─┬─┬─┐
238
238
  │ │ │ │ │
@@ -23,7 +23,8 @@ You'll be responsible for setting properties like `disabled` , `className` , a
23
23
  text content using the `children` key.
24
24
  *
25
25
  * NOTE : When an array of objects is provided, make sure a unique `key` is assigned to each
26
- data. See for more information.
26
+ *
27
+ * data. See for more information.
27
28
  */
28
29
  children: string[] | { key: number | string; [propName: string]: any }[];
29
30
  /**
@@ -18,7 +18,7 @@ export interface RoutableConfig extends Object {
18
18
  /**
19
19
  * The event to listen to for path changes.
20
20
  *
21
- * This defines the actual name of the navigate
21
+ * This defines the actual name of the [navigate]
22
22
  property.
23
23
  */
24
24
  navigate: string;
@@ -60,7 +60,7 @@ export interface LinkProps extends Merge<LinkBaseProps, LinkableProps> {
60
60
  disabled?: boolean;
61
61
  }
62
62
  /**
63
- * A component that is used to make a link to navigate among `Route` components.
63
+ * A component that is used to make a link to navigate among [ `Route` ] components.
64
64
  *
65
65
  * In the following example, `Sample` would render `Main` with two Links for `About` and `FAQ` .
66
66
  If `About` is clicked, the content of `About` would be displayed under `Main` .
@@ -51,7 +51,7 @@ export interface ScrollerBaseProps {
51
51
  * * {animate} - When `true` , scroll occurs with animation. When `false` , no
52
52
  animation occurs.
53
53
  * * {focus} - When `true` , attempts to focus item after scroll. Only valid when scrolling
54
- by `index` or `node` .
54
+ by `index` or `node` .
55
55
  *
56
56
  * Note: Only specify one of: `position` , `align` , `index` or `node`
57
57
  *
@@ -169,7 +169,7 @@ export interface ScrollerProps extends ScrollerBasicProps {
169
169
  * * {animate} - When `true` , scroll occurs with animation. When `false` , no
170
170
  animation occurs.
171
171
  * * {focus} - When `true` , attempts to focus item after scroll. Only valid when scrolling
172
- by `node` .
172
+ by `node` .
173
173
  *
174
174
  * Note: Only specify one of: `position` , `align` , `node`
175
175
  *
@@ -76,7 +76,7 @@ corresponding internal elements and states of this component.
76
76
  * The following classes are supported:
77
77
  * * `slider` - The root component class
78
78
  * * `knob` - The knob node
79
- * * `horizontal` - Applied when `orientation` prop is `"horizontal" ``
79
+ * * `horizontal` - Applied when `orientation` prop is `"horizontal"``
80
80
  * * `pressed` - Applied when `pressed` prop is `true`
81
81
  * * `noFill` - Applied when `noFill` prop is `true`
82
82
  * * `vertical` - Applied when `orientation` prop is `"vertical"`
@@ -108,14 +108,14 @@ will have its props merged with the above props.
108
108
  * The maximum value of the slider.
109
109
  *
110
110
  * The range between `min` and `max` should be evenly divisible by
111
- step .
111
+ [step] .
112
112
  */
113
113
  max?: number;
114
114
  /**
115
115
  * The minimum value of the slider.
116
116
  *
117
117
  * The range between `min` and `max` should be evenly divisible by
118
- step .
118
+ [step] .
119
119
  */
120
120
  min?: number;
121
121
  /**
@@ -12,7 +12,7 @@ export interface SlotItemBaseProps {
12
12
  * The type of component to use to render the item.
13
13
  *
14
14
  * This component will receive the `inline` prop and any additional unhandled props provided
15
- to `SlotItem` . A derivative of Item is recommended.
15
+ to `SlotItem` . A derivative of [Item] is recommended.
16
16
  */
17
17
  component: React.ComponentType;
18
18
  /**
@@ -49,7 +49,7 @@ corresponding internal elements and states of this component.
49
49
  * * `after` - Applied to the slot that falls after the content
50
50
  * * `before` - Applied to the slot that falls before the content
51
51
  * * `hidden` - Applied to a slot when that slot is supposed to be hidden, according to
52
- `autoHide` prop
52
+ `autoHide` prop
53
53
  */
54
54
  css?: object;
55
55
  /**
@@ -26,7 +26,7 @@ changes the rendering tree and where this is used.
26
26
  * * 'container' blocks up to the nearest ancestor with absolute or relative positioning
27
27
  *
28
28
  * When `blockClickOn` is either `'screen'` or `'container'` , a translucent scrim can be added
29
- by setting scrim prop to `true` .
29
+ by setting [scrim] prop to `true` .
30
30
  */
31
31
  blockClickOn?: string | any;
32
32
  /**
@@ -18,7 +18,7 @@ export interface ToggleItemBaseProps {
18
18
  *
19
19
  * This receives the `css` prop for theme extension and therefore must be a custom
20
20
  component and not a simple HTML DOM node. Recommended component or themed
21
- derivative: SlotItem
21
+ derivative: [SlotItem]
22
22
  */
23
23
  component: React.ComponentType;
24
24
  /**
@@ -26,7 +26,7 @@ derivative: SlotItem
26
26
  *
27
27
  * This component receives the `selected` prop and value,
28
28
  and must therefore respond to it in some way. It is recommended to use
29
- ToggleIcon for this.
29
+ [ToggleIcon] for this.
30
30
  */
31
31
  iconComponent: React.ComponentType | JSX.Element;
32
32
  /**
@@ -51,7 +51,7 @@ corresponding internal elements and states of this component.
51
51
  /**
52
52
  * An optional prop that lets you override the icon of the `iconComponent` component.
53
53
  *
54
- * This accepts any string that the Icon component supports, provided
54
+ * This accepts any string that the [Icon] component supports, provided
55
55
  the recommendations of `iconComponent` are followed.
56
56
  */
57
57
  icon?: string | object;
@@ -68,14 +68,16 @@ or behind the existing `icon` . See `itemIconPosition` for options.
68
68
  */
69
69
  itemIcon?: React.ReactNode;
70
70
  /**
71
- * Specifies where `itemIcon` appears.
72
- * * `'before'` - first element in the item
73
- * * `'beforeChildren'` - before `children` . If `iconPosition` is `'before'` , `icon` will be
74
- before `itemIcon`
75
- * * `'afterChildren'` - after `children` . If iconPosition `is` 'after' `,` icon `will be
76
- after` itemIcon`
77
- * * `'after'` - the last element in the item
78
- */
71
+ * Specifies where `itemIcon` appears.
72
+ * * `'before'` - first element in the item
73
+ * * `'beforeChildren'` - before `children` . If `iconPosition` is `'before'` , `icon` will be
74
+ *
75
+ * before `itemIcon`
76
+ * * `'afterChildren'` - after `children` . If iconPosition `is` 'after' `, ` icon` will be
77
+ *
78
+ * after `itemIcon`
79
+ * * `'after'` - the last element in the item
80
+ */
79
81
  itemIconPosition?: "before" | "beforeChildren" | "afterChildren" | "after";
80
82
  /**
81
83
  * Called when the toggle item is toggled. Developers should generally use `onToggle` instead.
@@ -93,7 +93,7 @@ export interface TouchableProps {
93
93
  * * `type` - Type of event, `'onHoldStart'`
94
94
  * * `name` - The name of the hold as configured in the events list
95
95
  * * `time` - Time, in milliseconds, configured for this hold which may vary slightly
96
- from time since the hold began
96
+ from time since the hold began
97
97
  */
98
98
  onHoldStart?: Function;
99
99
  /**
@@ -146,7 +146,7 @@ Only applies when `global` is `false` .
146
146
  * * `'border-box'` - the default, includes the padding and border but excludes the margin.
147
147
  * * `'content-box'` - excludes the padding, border, and margin.
148
148
  * * `global` - When `true` , drag gestures will continue when leaving the bounds of the component
149
- or blurring the component.
149
+ or blurring the component.
150
150
  * * `moveTolerance` - The number of pixels from the start position of the drag that the pointer
151
151
  may move before cancelling the drag. Defaults to `16` .
152
152
  *
@@ -161,7 +161,7 @@ time per move, that must be exceeded to generate a `onFlick` event.
161
161
  * * `cancelOnMove` - When `true` , the hold is cancelled when moving beyond the `moveTolerance` .
162
162
  Defaults to `false`
163
163
  * * `global` - When `true` , hold gestures will continue when leaving the bounds of the component
164
- or blurring the component.
164
+ or blurring the component.
165
165
  * * `moveTolerance` - The number of pixels from the start position of the hold that the pointer
166
166
  may move before cancelling the hold. Ignored when `cancelOnMove` is `false` . Defaults to
167
167
  `16` .
@@ -75,10 +75,11 @@ are also supported and treated as milliseconds.
75
75
  */
76
76
  noAnimation?: boolean;
77
77
  /**
78
- * The transition timing function.
79
- * * Supported function names are: `ease` , `ease-in` , `ease-out` , `ease-in-out` , `ease-in-quart` ,
80
- `ease-out-quart` , and `linear` .
81
- */
78
+ * The transition timing function.
79
+ * * Supported function names are: `ease` , `ease-in` , `ease-out` , `ease-in-out` , `ease-in-quart` ,
80
+ *
81
+ * `ease-out-quart` , and `linear` .
82
+ */
82
83
  timingFunction?: string;
83
84
  /**
84
85
  * The type of transition to affect the content.
@@ -86,19 +87,19 @@ are also supported and treated as milliseconds.
86
87
  *
87
88
  * Details on types:
88
89
  * * `'slide'` - Typically used for bringing something which is off the edge of the screen,
89
- and not visible, onto the screen. Think of a popup, toast, notification, dialog, or
90
- an overlaying menu. This requires no re-rendering or repainting of the screen during
91
- the transition, making it very performant. However, this does not affect layout at
92
- all, which makes it less useful for transitioning from a place already on the
93
- screen.
90
+ and not visible, onto the screen. Think of a popup, toast, notification, dialog, or
91
+ an overlaying menu. This requires no re-rendering or repainting of the screen during
92
+ the transition, making it very performant. However, this does not affect layout at
93
+ all, which makes it less useful for transitioning from a place already on the
94
+ screen.
94
95
  * * `'clip'` - This is useful for showing a component that transitions-in from a location
95
- that is already on the screen. Examples would be an expanding header or an
96
- accordion. This type does affects layout, its current size will push other sibling
97
- elements to make room for itself. Because of this, repainting the layout does happen
98
- during transition.
96
+ that is already on the screen. Examples would be an expanding header or an
97
+ accordion. This type does affects layout, its current size will push other sibling
98
+ elements to make room for itself. Because of this, repainting the layout does happen
99
+ during transition.
99
100
  * * `'fade'` - Fade the components onto the screen, from 0 opacity (completely invisible)
100
- to 1 (full visibility). Pretty basic, but useful for fading on/off a tooltip, a
101
- menu, a panel, or even view contents. This does not affect layout at all.
101
+ to 1 (full visibility). Pretty basic, but useful for fading on/off a tooltip, a
102
+ menu, a panel, or even view contents. This does not affect layout at all.
102
103
  */
103
104
  type?: string;
104
105
  /**
@@ -130,7 +131,8 @@ export interface TransitionProps {
130
131
  /**
131
132
  * Controls how long the transition should take.
132
133
  * * Supported preset durations are: `'short'` (250ms), `'medium'` (500ms), and `'long'` (1s).
133
- `'medium'` (500ms) is default when no others are specified.
134
+ *
135
+ * `'medium'` (500ms) is default when no others are specified.
134
136
  *
135
137
  * Any valid CSS duration value is also accepted, e.g. "200ms" or "3s". Pure numeric values
136
138
  are also supported and treated as miliseconds.
@@ -162,19 +164,19 @@ Supported function names are: `ease` , `ease-in` , `ease-out` , `ease-in-out
162
164
  *
163
165
  * Details on types:
164
166
  * * `'slide'` - Typically used for bringing something which is off the edge of the screen,
165
- and not visible, onto the screen. Think of a popup, toast, notification, dialog, or
166
- an overlaying menu. This requires no re-rendering or repainting of the screen during
167
- the transition, making it very performant. However, this does not affect layout at
168
- all, which makes it less useful for transitioning from a place already on the
169
- screen.
167
+ and not visible, onto the screen. Think of a popup, toast, notification, dialog, or
168
+ an overlaying menu. This requires no re-rendering or repainting of the screen during
169
+ the transition, making it very performant. However, this does not affect layout at
170
+ all, which makes it less useful for transitioning from a place already on the
171
+ screen.
170
172
  * * `'clip'` - This is useful for showing a component that transitions-in from a location
171
- that is already on the screen. Examples would be an expanding header or an
172
- accordion. This type does affects layout, its current size will push other sibling
173
- elements to make room for itself. Because of this, repainting the layout does happen
174
- during transition.
173
+ that is already on the screen. Examples would be an expanding header or an
174
+ accordion. This type does affects layout, its current size will push other sibling
175
+ elements to make room for itself. Because of this, repainting the layout does happen
176
+ during transition.
175
177
  * * `'fade'` - Fade the components onto the screen, from 0 opacity (completely invisible)
176
- to 1 (full visibility). Pretty basic, but useful for fading on/off a tooltip, a
177
- menu, a panel, or even view contents. This does not affect layout at all.
178
+ to 1 (full visibility). Pretty basic, but useful for fading on/off a tooltip, a
179
+ menu, a panel, or even view contents. This does not affect layout at all.
178
180
  */
179
181
  type?: string;
180
182
  /**
@@ -111,7 +111,7 @@ horizontal direction).
111
111
  }
112
112
  /**
113
113
  * The base `ViewManager` component, without
114
- ViewManagerDecorator applied.
114
+ [ViewManagerDecorator] applied.
115
115
  */
116
116
 
117
117
  export class ViewManagerBase extends React.Component<
@@ -135,15 +135,15 @@ export interface ArrangerCallback {
135
135
  export interface Arranger {
136
136
  /**
137
137
  * Returns an array of keyframes describing the animation when
138
- a view is entering the viewport.
138
+ a view is entering the viewport.
139
139
  */
140
140
  enter: ArrangerCallback /**
141
141
  * Returns an array of keyframes describing the animation when
142
- a view is leaving the viewport.
142
+ a view is leaving the viewport.
143
143
  */;
144
144
  leave: ArrangerCallback /**
145
145
  * Returns an array of keyframes describing the animation when
146
- a view is remaining in the viewport.
146
+ a view is remaining in the viewport.
147
147
  */;
148
148
  stay?: ArrangerCallback;
149
149
  }
@@ -7,7 +7,7 @@ type Merge<M, N> = Omit<M, Extract<keyof M, keyof N>> & N;
7
7
 
8
8
  /**
9
9
  * The shape for the grid list item size
10
- in a list for VirtualGridList .
10
+ in a list for [VirtualGridList] .
11
11
  */
12
12
  export interface gridListItemSizeShape {
13
13
  /**
@@ -36,7 +36,7 @@ This option is available for only `VirtualList` kind.
36
36
  * * {animate} - When `true` , scroll occurs with animation. When `false` , no
37
37
  animation occurs.
38
38
  * * {focus} - When `true` , attempts to focus item after scroll. Only valid when scrolling
39
- by `index` or `node` .
39
+ by `index` or `node` .
40
40
  *
41
41
  * Note: Only specify one of: `position` , `align` , `index` or `node`
42
42
  *
@@ -156,7 +156,7 @@ export class VirtualList extends React.Component<
156
156
 
157
157
  /**
158
158
  * The shape for the list different item size
159
- in a list for VirtualList .
159
+ in a list for [VirtualList] .
160
160
  */
161
161
  export interface itemSizesShape {
162
162
  /**
@@ -173,7 +173,8 @@ export interface VirtualListBasicProps {
173
173
  * The rendering function called for each item in the list.
174
174
  *
175
175
  * Note : The list does not always render a component whenever its render function is called
176
- due to performance optimization.
176
+ *
177
+ * due to performance optimization.
177
178
  *
178
179
  * Example:
179
180
  * ```
@@ -237,7 +238,7 @@ renderItem = ({index, ...rest}) => {
237
238
  }
238
239
  /**
239
240
  * A basic base component for
240
- VirtualList and VirtualGridList .
241
+ [VirtualList] and [VirtualGridList] .
241
242
  */
242
243
 
243
244
  export class VirtualListBasic extends React.Component<
@@ -249,7 +250,8 @@ export interface VirtualListBaseProps {
249
250
  * The rendering function called for each item in the list.
250
251
  *
251
252
  * Note : The list does not always render a component whenever its render function is called
252
- due to performance optimization.
253
+ *
254
+ * due to performance optimization.
253
255
  *
254
256
  * Example:
255
257
  * ```
@@ -279,7 +281,7 @@ This option is available for only `VirtualList` kind.
279
281
  * * {animate} - When `true` , scroll occurs with animation. When `false` , no
280
282
  animation occurs.
281
283
  * * {focus} - When `true` , attempts to focus item after scroll. Only valid when scrolling
282
- by `index` or `node` .
284
+ by `index` or `node` .
283
285
  *
284
286
  * Note: Only specify one of: `position` , `align` , `index` or `node`
285
287
  *
@@ -403,7 +405,7 @@ render = () => (
403
405
  }
404
406
  /**
405
407
  * A basic base component for
406
- VirtualList and VirtualGridList .
408
+ [VirtualList] and [VirtualGridList] .
407
409
  */
408
410
 
409
411
  export class VirtualListBase extends React.Component<
@@ -427,7 +429,7 @@ This option is available for only `VirtualList` kind.
427
429
  * * {animate} - When `true` , scroll occurs with animation. When `false` , no
428
430
  animation occurs.
429
431
  * * {focus} - When `true` , attempts to focus item after scroll. Only valid when scrolling
430
- by `index` or `node` .
432
+ by `index` or `node` .
431
433
  *
432
434
  * Note: Only specify one of: `position` , `align` , `index` or `node`
433
435
  *
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@enact/ui",
3
- "version": "4.0.9",
3
+ "version": "4.0.10",
4
4
  "description": "A collection of simplified unstyled cross-platform UI components for Enact",
5
5
  "main": "index.js",
6
6
  "scripts": {
@@ -25,7 +25,7 @@
25
25
  }
26
26
  },
27
27
  "dependencies": {
28
- "@enact/core": "^4.0.9",
28
+ "@enact/core": "^4.0.10",
29
29
  "classnames": "^2.2.5",
30
30
  "direction": "^1.0.1",
31
31
  "invariant": "^2.2.2",