@enact/ui 3.2.6 → 3.2.7
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.
- package/AnnounceDecorator/AnnounceDecorator.d.ts +1 -1
- package/BodyText/BodyText.d.ts +3 -3
- package/Button/Button.d.ts +8 -8
- package/CHANGELOG.md +4 -0
- package/ComponentOverride/ComponentOverride.d.ts +1 -1
- package/GridListImageItem/GridListImageItem.d.ts +2 -2
- package/Group/Group.d.ts +4 -4
- package/Heading/Heading.d.ts +3 -2
- package/Icon/Icon.d.ts +5 -5
- package/IconButton/IconButton.d.ts +6 -6
- package/Image/Image.d.ts +1 -1
- package/Item/Item.d.ts +2 -2
- package/LabeledIcon/LabeledIcon.d.ts +6 -6
- package/Layout/Layout.d.ts +22 -22
- package/Marquee/index.d.ts +2 -2
- package/Media/Media.d.ts +1 -1
- package/ProgressBar/ProgressBar.d.ts +1 -1
- package/Repeater/Repeater.d.ts +4 -3
- package/Routable/Routable.d.ts +2 -2
- package/Scroller/Scroller.d.ts +3 -3
- package/Slider/Slider.d.ts +6 -6
- package/SlotItem/SlotItem.d.ts +4 -4
- package/Spinner/Spinner.d.ts +3 -3
- package/ToggleIcon/ToggleIcon.d.ts +3 -3
- package/ToggleItem/ToggleItem.d.ts +15 -13
- package/Touchable/Touchable.d.ts +3 -3
- package/Transition/Transition.d.ts +31 -29
- package/ViewManager/ViewManager.d.ts +10 -10
- package/VirtualList/VirtualList.d.ts +9 -8
- package/package.json +2 -2
package/BodyText/BodyText.d.ts
CHANGED
|
@@ -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
|
-
|
|
14
|
+
[theming] .
|
|
15
15
|
*/
|
|
16
16
|
centered?: boolean;
|
|
17
17
|
/**
|
|
@@ -35,7 +35,7 @@ corresponding internal Elements and states of this component.
|
|
|
35
35
|
*/
|
|
36
36
|
|
|
37
37
|
export class BodyTextBase extends React.Component<
|
|
38
|
-
|
|
38
|
+
Merge<React.HTMLProps<HTMLElement>, BodyTextBaseProps>
|
|
39
39
|
> {}
|
|
40
40
|
|
|
41
41
|
export interface BodyTextDecoratorProps extends ui_ForwardRef_ForwardRefProps {}
|
|
@@ -49,7 +49,7 @@ export interface BodyTextProps {}
|
|
|
49
49
|
*/
|
|
50
50
|
|
|
51
51
|
export class BodyText extends React.Component<
|
|
52
|
-
|
|
52
|
+
Merge<React.HTMLProps<HTMLElement>, BodyTextProps>
|
|
53
53
|
> {}
|
|
54
54
|
|
|
55
55
|
export default BodyText;
|
package/Button/Button.d.ts
CHANGED
|
@@ -44,10 +44,10 @@ locale positioning of the custom component.
|
|
|
44
44
|
*/
|
|
45
45
|
icon?: React.ReactNode;
|
|
46
46
|
/**
|
|
47
|
-
* The component used to render the
|
|
47
|
+
* The component used to render the [icon] .
|
|
48
48
|
*
|
|
49
49
|
* This component will receive the `size` property set on the Button as well as the `icon`
|
|
50
|
-
class to customize its styling. If
|
|
50
|
+
class to customize its styling. If [icon] is not a
|
|
51
51
|
string, this property is not used.
|
|
52
52
|
*/
|
|
53
53
|
iconComponent?: React.ComponentType;
|
|
@@ -55,28 +55,28 @@ string, this property is not used.
|
|
|
55
55
|
* Enforces a minimum width for the component.
|
|
56
56
|
*
|
|
57
57
|
* Applies the `minWidth` CSS class which can be customized by
|
|
58
|
-
|
|
58
|
+
[theming] .
|
|
59
59
|
*/
|
|
60
60
|
minWidth?: boolean;
|
|
61
61
|
/**
|
|
62
62
|
* Indicates the component is depressed.
|
|
63
63
|
*
|
|
64
64
|
* Applies the `pressed` CSS class which can be customized by
|
|
65
|
-
|
|
65
|
+
[theming] .
|
|
66
66
|
*/
|
|
67
67
|
pressed?: boolean;
|
|
68
68
|
/**
|
|
69
69
|
* Indicates the component is selected.
|
|
70
70
|
*
|
|
71
71
|
* Applies the `selected` CSS class which can be customized by
|
|
72
|
-
|
|
72
|
+
[theming] .
|
|
73
73
|
*/
|
|
74
74
|
selected?: boolean;
|
|
75
75
|
/**
|
|
76
76
|
* The size of the button.
|
|
77
77
|
*
|
|
78
78
|
* Applies either the `small` or `large` CSS class which can be customized by
|
|
79
|
-
|
|
79
|
+
[theming] .
|
|
80
80
|
*/
|
|
81
81
|
size?: "small" | "large";
|
|
82
82
|
}
|
|
@@ -85,7 +85,7 @@ string, this property is not used.
|
|
|
85
85
|
*/
|
|
86
86
|
|
|
87
87
|
export class ButtonBase extends React.Component<
|
|
88
|
-
|
|
88
|
+
Merge<React.HTMLProps<HTMLElement>, ButtonBaseProps>
|
|
89
89
|
> {}
|
|
90
90
|
|
|
91
91
|
export interface ButtonDecoratorProps extends ui_Touchable_TouchableProps {}
|
|
@@ -100,7 +100,7 @@ export interface ButtonProps
|
|
|
100
100
|
*/
|
|
101
101
|
|
|
102
102
|
export class Button extends React.Component<
|
|
103
|
-
|
|
103
|
+
Merge<React.HTMLProps<HTMLElement>, ButtonProps>
|
|
104
104
|
> {}
|
|
105
105
|
|
|
106
106
|
export default Button;
|
package/CHANGELOG.md
CHANGED
|
@@ -46,7 +46,7 @@ const LabeledIconButton = ({iconComponent, label, ...rest}) => {
|
|
|
46
46
|
*/
|
|
47
47
|
|
|
48
48
|
export class ComponentOverride extends React.Component<
|
|
49
|
-
|
|
49
|
+
Merge<React.HTMLProps<HTMLElement>, ComponentOverrideProps>
|
|
50
50
|
> {}
|
|
51
51
|
|
|
52
52
|
export default ComponentOverride;
|
|
@@ -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
|
|
39
|
+
* Placeholder image used while [source]
|
|
40
40
|
is loaded.
|
|
41
41
|
*/
|
|
42
42
|
placeholder?: string;
|
|
@@ -79,7 +79,7 @@ const SelectionOverlay = kind({
|
|
|
79
79
|
*/
|
|
80
80
|
|
|
81
81
|
export class GridListImageItem extends React.Component<
|
|
82
|
-
|
|
82
|
+
Merge<React.HTMLProps<HTMLElement>, GridListImageItemProps>
|
|
83
83
|
> {}
|
|
84
84
|
|
|
85
85
|
export default GridListImageItem;
|
package/Group/Group.d.ts
CHANGED
|
@@ -13,7 +13,7 @@ properties and events.
|
|
|
13
13
|
*/
|
|
14
14
|
|
|
15
15
|
export class GroupBase extends React.Component<
|
|
16
|
-
|
|
16
|
+
Merge<React.HTMLProps<HTMLElement>, GroupBaseProps>
|
|
17
17
|
> {}
|
|
18
18
|
|
|
19
19
|
export interface GroupProps extends ui_Changeable_ChangeableProps {
|
|
@@ -60,9 +60,9 @@ information.
|
|
|
60
60
|
* Selection mode for the group
|
|
61
61
|
* * `single` - Allows for 0 or 1 item to be selected. The selected item may be deselected.
|
|
62
62
|
* * `radio` - Allows for 0 or 1 item to be selected. The selected item may only be
|
|
63
|
-
|
|
63
|
+
deselected by selecting another item.
|
|
64
64
|
* * `multiple` - Allows 0 to _n_ items to be selected. Each item may be selected or
|
|
65
|
-
|
|
65
|
+
deselected.
|
|
66
66
|
*/
|
|
67
67
|
select?: string;
|
|
68
68
|
/**
|
|
@@ -82,7 +82,7 @@ events.
|
|
|
82
82
|
*/
|
|
83
83
|
|
|
84
84
|
export class Group extends React.Component<
|
|
85
|
-
|
|
85
|
+
Merge<React.HTMLProps<HTMLElement>, GroupProps>
|
|
86
86
|
> {}
|
|
87
87
|
|
|
88
88
|
export default Group;
|
package/Heading/Heading.d.ts
CHANGED
|
@@ -32,7 +32,8 @@ corresponding internal Elements and states of this component.
|
|
|
32
32
|
* Set the size of this component.
|
|
33
33
|
* * `'title'` and `'subtitle'` are generally considered to be used only once on a given screen.
|
|
34
34
|
* * `'large'` , `'medium'` , `'small'` , and `'tiny'` are typically used as section headings
|
|
35
|
-
|
|
35
|
+
*
|
|
36
|
+
* for content on a screen, starting with `'large'` for the first tier of information
|
|
36
37
|
followed by `'medium'` for the next, and so fourth.
|
|
37
38
|
*
|
|
38
39
|
* If the `spacing` prop is not set (defaulting to "auto"), these values automatically set
|
|
@@ -60,7 +61,7 @@ by this component's `css` prop.
|
|
|
60
61
|
*/
|
|
61
62
|
|
|
62
63
|
export class Heading extends React.Component<
|
|
63
|
-
|
|
64
|
+
Merge<React.HTMLProps<HTMLElement>, HeadingProps>
|
|
64
65
|
> {}
|
|
65
66
|
|
|
66
67
|
export default Heading;
|
package/Icon/Icon.d.ts
CHANGED
|
@@ -10,7 +10,7 @@ export interface IconProps {
|
|
|
10
10
|
* The icon content.
|
|
11
11
|
*
|
|
12
12
|
* May be specified as either:
|
|
13
|
-
* * A string that represents an icon from the
|
|
13
|
+
* * A string that represents an icon from the [iconList] ,
|
|
14
14
|
* * An HTML entity string, Unicode reference or hex value (in the form '0x...'),
|
|
15
15
|
* * A URL specifying path to an icon image, or
|
|
16
16
|
* * An object representing a resolution independent resource (See ).
|
|
@@ -22,8 +22,8 @@ corresponding internal Elements and states of this component.
|
|
|
22
22
|
*
|
|
23
23
|
* The following classes are supported:
|
|
24
24
|
* * `icon` - The root component class
|
|
25
|
-
* * `dingbat` - Applied when the value of
|
|
26
|
-
found in
|
|
25
|
+
* * `dingbat` - Applied when the value of [ `icon` ] is not
|
|
26
|
+
found in [iconList]
|
|
27
27
|
* * `large` - Applied when `size` prop is `'large'`
|
|
28
28
|
* * `pressed` - Applied when `pressed` prop is `true`
|
|
29
29
|
* * `small` - Applied when `size` prop is `'small'`
|
|
@@ -50,7 +50,7 @@ renders in a React + JSX string.
|
|
|
50
50
|
* The size of the button.
|
|
51
51
|
*
|
|
52
52
|
* Applies either the `small` or `large` CSS class which can be customized by
|
|
53
|
-
|
|
53
|
+
[theming] .
|
|
54
54
|
*/
|
|
55
55
|
size?: "small" | "large";
|
|
56
56
|
}
|
|
@@ -59,7 +59,7 @@ renders in a React + JSX string.
|
|
|
59
59
|
*/
|
|
60
60
|
|
|
61
61
|
export class Icon extends React.Component<
|
|
62
|
-
|
|
62
|
+
Merge<React.HTMLProps<HTMLElement>, IconProps>
|
|
63
63
|
> {}
|
|
64
64
|
|
|
65
65
|
export default Icon;
|
|
@@ -13,7 +13,7 @@ export interface IconButtonBaseProps {
|
|
|
13
13
|
*/
|
|
14
14
|
buttonComponent: React.ComponentType | JSX.Element;
|
|
15
15
|
/**
|
|
16
|
-
* The component used to render the
|
|
16
|
+
* The component used to render the [icon] .
|
|
17
17
|
*
|
|
18
18
|
* This component will receive the `flip` and `size` property set on the `IconButton` as well as the
|
|
19
19
|
`icon` class to customize its styling.
|
|
@@ -31,7 +31,7 @@ corresponding internal Elements and states of this component.
|
|
|
31
31
|
*
|
|
32
32
|
* The following classes are supported:
|
|
33
33
|
* * `iconButton` - The root component class
|
|
34
|
-
* * `icon` - The
|
|
34
|
+
* * `icon` - The [icon component] class
|
|
35
35
|
* * `large` - Applied when `size` prop is `'large'`
|
|
36
36
|
* * `small` - Applied when `size` prop is `'small'`
|
|
37
37
|
* * `pressed` - Applied when `pressed` prop is `true`
|
|
@@ -41,7 +41,7 @@ corresponding internal Elements and states of this component.
|
|
|
41
41
|
* Disables IconButton.
|
|
42
42
|
*
|
|
43
43
|
* When `true` , the button is shown as disabled and does not generate
|
|
44
|
-
`onClick`
|
|
44
|
+
`onClick` [events] .
|
|
45
45
|
*/
|
|
46
46
|
disabled?: boolean;
|
|
47
47
|
/**
|
|
@@ -66,7 +66,7 @@ corresponding internal Elements and states of this component.
|
|
|
66
66
|
* The size of the button.
|
|
67
67
|
*
|
|
68
68
|
* Applies either the `small` or `large` CSS class which can be customized by
|
|
69
|
-
|
|
69
|
+
[theming] .
|
|
70
70
|
*/
|
|
71
71
|
size?: "small" | "large";
|
|
72
72
|
}
|
|
@@ -75,7 +75,7 @@ corresponding internal Elements and states of this component.
|
|
|
75
75
|
*/
|
|
76
76
|
|
|
77
77
|
export class IconButtonBase extends React.Component<
|
|
78
|
-
|
|
78
|
+
Merge<React.HTMLProps<HTMLElement>, IconButtonBaseProps>
|
|
79
79
|
> {}
|
|
80
80
|
|
|
81
81
|
export interface IconButtonDecoratorProps extends ui_Touchable_TouchableProps {}
|
|
@@ -97,7 +97,7 @@ export interface IconButtonProps
|
|
|
97
97
|
*/
|
|
98
98
|
|
|
99
99
|
export class IconButton extends React.Component<
|
|
100
|
-
|
|
100
|
+
Merge<React.HTMLProps<HTMLElement>, IconButtonProps>
|
|
101
101
|
> {}
|
|
102
102
|
|
|
103
103
|
export default IconButton;
|
package/Image/Image.d.ts
CHANGED
|
@@ -83,7 +83,7 @@ events. The image that you see on screen is a `background-image` from the `di
|
|
|
83
83
|
*/
|
|
84
84
|
|
|
85
85
|
export class Image extends React.Component<
|
|
86
|
-
|
|
86
|
+
Merge<React.HTMLProps<HTMLElement>, ImageProps>
|
|
87
87
|
> {}
|
|
88
88
|
|
|
89
89
|
export default Image;
|
package/Item/Item.d.ts
CHANGED
|
@@ -42,7 +42,7 @@ corresponding internal Elements and states of this component.
|
|
|
42
42
|
*/
|
|
43
43
|
|
|
44
44
|
export class ItemBase extends React.Component<
|
|
45
|
-
|
|
45
|
+
Merge<React.HTMLProps<HTMLElement>, ItemBaseProps>
|
|
46
46
|
> {}
|
|
47
47
|
|
|
48
48
|
export interface ItemDecoratorProps
|
|
@@ -57,7 +57,7 @@ export interface ItemProps extends Merge<ItemBaseProps, ItemDecoratorProps> {}
|
|
|
57
57
|
*/
|
|
58
58
|
|
|
59
59
|
export class Item extends React.Component<
|
|
60
|
-
|
|
60
|
+
Merge<React.HTMLProps<HTMLElement>, ItemProps>
|
|
61
61
|
> {}
|
|
62
62
|
|
|
63
63
|
export default Item;
|
|
@@ -22,8 +22,8 @@ corresponding internal Elements and states of this component.
|
|
|
22
22
|
* * `labeledIcon` - The root component class
|
|
23
23
|
* * `icon` - The icon component class
|
|
24
24
|
* * `iconCell` - Applied to the `iconComponent` directly, like `.icon` . If `icon` in a
|
|
25
|
-
|
|
26
|
-
|
|
25
|
+
React component, this class is applied to the container of the icon,
|
|
26
|
+
rather than the icon itself.
|
|
27
27
|
* * `label` - The label component class
|
|
28
28
|
* * `inline` - Applied when the inline prop is set
|
|
29
29
|
* * `above` - Applied when the labelPosition prop is set to above
|
|
@@ -61,7 +61,7 @@ also receive the `flip` and `size` props as set on the component.
|
|
|
61
61
|
* Enables this component to be used in an "inline" context.
|
|
62
62
|
*
|
|
63
63
|
* This is useful for when you have several of these components in a row and are not using a
|
|
64
|
-
|
|
64
|
+
[Layout] or flex-box configuration.
|
|
65
65
|
*/
|
|
66
66
|
inline?: boolean;
|
|
67
67
|
/**
|
|
@@ -82,7 +82,7 @@ also receive the `flip` and `size` props as set on the component.
|
|
|
82
82
|
* The size of the icon.
|
|
83
83
|
*
|
|
84
84
|
* Applies either the `small` or `large` CSS class which can be customized by
|
|
85
|
-
|
|
85
|
+
[theming] .
|
|
86
86
|
*/
|
|
87
87
|
size?: "large" | "small";
|
|
88
88
|
}
|
|
@@ -91,7 +91,7 @@ also receive the `flip` and `size` props as set on the component.
|
|
|
91
91
|
*/
|
|
92
92
|
|
|
93
93
|
export class LabeledIconBase extends React.Component<
|
|
94
|
-
|
|
94
|
+
Merge<React.HTMLProps<HTMLElement>, LabeledIconBaseProps>
|
|
95
95
|
> {}
|
|
96
96
|
|
|
97
97
|
export interface LabeledIconDecoratorProps
|
|
@@ -114,7 +114,7 @@ export interface LabeledIconProps
|
|
|
114
114
|
*/
|
|
115
115
|
|
|
116
116
|
export class LabeledIcon extends React.Component<
|
|
117
|
-
|
|
117
|
+
Merge<React.HTMLProps<HTMLElement>, LabeledIconProps>
|
|
118
118
|
> {}
|
|
119
119
|
|
|
120
120
|
export default LabeledIcon;
|
package/Layout/Layout.d.ts
CHANGED
|
@@ -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
|
|
22
|
+
* Any valid [Node] that should be positioned in this `Cell` .
|
|
23
23
|
*/
|
|
24
24
|
children?: Any;
|
|
25
25
|
/**
|
|
@@ -33,14 +33,14 @@ horizontally in the case of a vertical layout. `"start"` , `"center"` and
|
|
|
33
33
|
* A `shrink` able cell will contract to its minimum size, according to the dimensions of its
|
|
34
34
|
contents. This is used when you want the size of this Cell's content to influence the
|
|
35
35
|
dimensions of this cell. `shrink` will not allow the contents of the Layout to be pushed
|
|
36
|
-
beyond its boundaries (overflowing). See the
|
|
36
|
+
beyond its boundaries (overflowing). See the [size] property
|
|
37
37
|
for more details.
|
|
38
38
|
*/
|
|
39
39
|
shrink?: boolean;
|
|
40
40
|
/**
|
|
41
41
|
* Sets the desired size of the Cell using any valid CSS measurement value.
|
|
42
42
|
*
|
|
43
|
-
* When used in conjunction with
|
|
43
|
+
* When used in conjunction with [shrink] , the size will be
|
|
44
44
|
the maximum size, shrinking as necessary, to fit the content.
|
|
45
45
|
*
|
|
46
46
|
* E.g.
|
|
@@ -50,18 +50,18 @@ and will match your contents size if it's smaller
|
|
|
50
50
|
*
|
|
51
51
|
* This accepts any valid CSS measurement value string. If a numeric value is used, it will
|
|
52
52
|
be treated as a pixel value and converted to a
|
|
53
|
-
|
|
54
|
-
|
|
53
|
+
[relative unit] based on the rules of
|
|
54
|
+
[resolution independence] .
|
|
55
55
|
*/
|
|
56
56
|
size?: string | number;
|
|
57
57
|
}
|
|
58
58
|
/**
|
|
59
59
|
* A stateless component that provides a space for your content in a
|
|
60
|
-
|
|
60
|
+
[Layout] , without applied.
|
|
61
61
|
*/
|
|
62
62
|
|
|
63
63
|
export class CellBase extends React.Component<
|
|
64
|
-
|
|
64
|
+
Merge<React.HTMLProps<HTMLElement>, CellBaseProps>
|
|
65
65
|
> {}
|
|
66
66
|
|
|
67
67
|
export interface CellDecoratorProps extends ui_ForwardRef_ForwardRefProps {}
|
|
@@ -73,7 +73,7 @@ export interface LayoutBaseProps {
|
|
|
73
73
|
/**
|
|
74
74
|
* The alignment of children.
|
|
75
75
|
*
|
|
76
|
-
* Aligns the children
|
|
76
|
+
* Aligns the children [Cells] vertically in the case of a horizontal
|
|
77
77
|
layout or horizontally in the case of a vertical layout. `"start"` , `"center"` and
|
|
78
78
|
`"end"` are the most commonly used, although all values of `align-items` are supported.
|
|
79
79
|
`"start"` refers to the top in a horizontal layout, and left in a vertical LTR layout
|
|
@@ -86,7 +86,7 @@ separated by a space.
|
|
|
86
86
|
*/
|
|
87
87
|
align?: string;
|
|
88
88
|
/**
|
|
89
|
-
* Only
|
|
89
|
+
* Only [Cell] components are supported as children.
|
|
90
90
|
*/
|
|
91
91
|
children?: Cell | Cell[];
|
|
92
92
|
/**
|
|
@@ -100,7 +100,7 @@ instead of carving out the entire horizontal space for itself.
|
|
|
100
100
|
*/
|
|
101
101
|
inline?: boolean;
|
|
102
102
|
/**
|
|
103
|
-
* The orientation of the `Layout` , i.e. how the children
|
|
103
|
+
* The orientation of the `Layout` , i.e. how the children [Cells] are
|
|
104
104
|
positioned on the screen. Must be either `'horizontal'` or `'vertical'` .
|
|
105
105
|
*/
|
|
106
106
|
orientation?: string;
|
|
@@ -118,9 +118,9 @@ additional lines are placed above/before the preceding line instead of below/aft
|
|
|
118
118
|
/**
|
|
119
119
|
* A container for `Cell` s.
|
|
120
120
|
*
|
|
121
|
-
* A stateless component that acts as a containing area for
|
|
121
|
+
* A stateless component that acts as a containing area for [Cells] to be
|
|
122
122
|
positioned in a row or a column (horizontally or vertically, respectively. It supports an
|
|
123
|
-
|
|
123
|
+
[orientation] property for laying-out its contents
|
|
124
124
|
( `Cells` ) in an organized, readable way.
|
|
125
125
|
*
|
|
126
126
|
* Example:
|
|
@@ -142,17 +142,17 @@ import css from './LayoutExample.less';
|
|
|
142
142
|
*/
|
|
143
143
|
|
|
144
144
|
export class LayoutBase extends React.Component<
|
|
145
|
-
|
|
145
|
+
Merge<React.HTMLProps<HTMLElement>, LayoutBaseProps>
|
|
146
146
|
> {}
|
|
147
147
|
|
|
148
148
|
export interface CellProps extends Merge<CellBaseProps, CellDecoratorProps> {}
|
|
149
149
|
/**
|
|
150
150
|
* A stateless component that provides a space for your content in a
|
|
151
|
-
|
|
151
|
+
[Layout] .
|
|
152
152
|
*/
|
|
153
153
|
|
|
154
154
|
export class Cell extends React.Component<
|
|
155
|
-
|
|
155
|
+
Merge<React.HTMLProps<HTMLElement>, CellProps>
|
|
156
156
|
> {}
|
|
157
157
|
|
|
158
158
|
export interface LayoutDecoratorProps extends ui_ForwardRef_ForwardRefProps {}
|
|
@@ -165,9 +165,9 @@ export interface LayoutProps
|
|
|
165
165
|
/**
|
|
166
166
|
* A container for `Cell` s.
|
|
167
167
|
*
|
|
168
|
-
* A stateless component that acts as a containing area for
|
|
168
|
+
* A stateless component that acts as a containing area for [Cells] to be
|
|
169
169
|
positioned in a row or a column (horizontally or vertically, respectively. It supports an
|
|
170
|
-
|
|
170
|
+
[orientation] property for laying-out its contents
|
|
171
171
|
( `Cells` ) in an organized, readable way.
|
|
172
172
|
*
|
|
173
173
|
* Example:
|
|
@@ -189,14 +189,14 @@ import css from './LayoutExample.less';
|
|
|
189
189
|
*/
|
|
190
190
|
|
|
191
191
|
export class Layout extends React.Component<
|
|
192
|
-
|
|
192
|
+
Merge<React.HTMLProps<HTMLElement>, LayoutProps>
|
|
193
193
|
> {}
|
|
194
194
|
|
|
195
195
|
export interface ColumnProps
|
|
196
196
|
extends Merge<LayoutProps, ui_ForwardRef_ForwardRefProps> {}
|
|
197
197
|
/**
|
|
198
198
|
* Shorthand for `<Layout orientation="vertical">` , which positions its
|
|
199
|
-
|
|
199
|
+
[Cells] vertically.
|
|
200
200
|
* ```
|
|
201
201
|
┌────┐
|
|
202
202
|
├────┤
|
|
@@ -207,14 +207,14 @@ export interface ColumnProps
|
|
|
207
207
|
*/
|
|
208
208
|
|
|
209
209
|
export class Column extends React.Component<
|
|
210
|
-
|
|
210
|
+
Merge<React.HTMLProps<HTMLElement>, ColumnProps>
|
|
211
211
|
> {}
|
|
212
212
|
|
|
213
213
|
export interface RowProps
|
|
214
214
|
extends Merge<LayoutProps, ui_ForwardRef_ForwardRefProps> {}
|
|
215
215
|
/**
|
|
216
216
|
* Shorthand for `<Layout orientation="horizontal">` , which positions its
|
|
217
|
-
|
|
217
|
+
[Cells] horizontally.
|
|
218
218
|
* ```
|
|
219
219
|
┌─┬─┬─┬─┐
|
|
220
220
|
│ │ │ │ │
|
|
@@ -223,7 +223,7 @@ export interface RowProps
|
|
|
223
223
|
*/
|
|
224
224
|
|
|
225
225
|
export class Row extends React.Component<
|
|
226
|
-
|
|
226
|
+
Merge<React.HTMLProps<HTMLElement>, RowProps>
|
|
227
227
|
> {}
|
|
228
228
|
|
|
229
229
|
export default Layout;
|
package/Marquee/index.d.ts
CHANGED
|
@@ -86,7 +86,7 @@ composite layers for improved performance.
|
|
|
86
86
|
*/
|
|
87
87
|
|
|
88
88
|
export class MarqueeBase extends React.Component<
|
|
89
|
-
|
|
89
|
+
Merge<React.HTMLProps<HTMLElement>, MarqueeBaseProps>
|
|
90
90
|
> {}
|
|
91
91
|
|
|
92
92
|
export interface MarqueeControllerConfig extends Object {
|
|
@@ -237,7 +237,7 @@ export interface MarqueeProps
|
|
|
237
237
|
*/
|
|
238
238
|
|
|
239
239
|
export class Marquee extends React.Component<
|
|
240
|
-
|
|
240
|
+
Merge<React.HTMLProps<HTMLElement>, MarqueeProps>
|
|
241
241
|
> {}
|
|
242
242
|
|
|
243
243
|
export default Marquee;
|
package/Media/Media.d.ts
CHANGED
|
@@ -93,7 +93,7 @@ element and props matching their name will be executed as callback functions whe
|
|
|
93
93
|
*/
|
|
94
94
|
|
|
95
95
|
export class Media extends React.Component<
|
|
96
|
-
|
|
96
|
+
Merge<React.HTMLProps<HTMLElement>, MediaProps>
|
|
97
97
|
> {}
|
|
98
98
|
|
|
99
99
|
export default Media;
|
package/Repeater/Repeater.d.ts
CHANGED
|
@@ -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
|
-
|
|
26
|
+
*
|
|
27
|
+
* data. See for more information.
|
|
27
28
|
*/
|
|
28
29
|
children: string[] | { key: number | string; [propName: string]: any }[];
|
|
29
30
|
/**
|
|
@@ -51,7 +52,7 @@ data. See for more information.
|
|
|
51
52
|
*/
|
|
52
53
|
|
|
53
54
|
export class RepeaterBase extends React.Component<
|
|
54
|
-
|
|
55
|
+
Merge<React.HTMLProps<HTMLElement>, RepeaterBaseProps>
|
|
55
56
|
> {}
|
|
56
57
|
|
|
57
58
|
export interface RepeaterDecoratorProps extends ui_ForwardRef_ForwardRefProps {}
|
|
@@ -66,7 +67,7 @@ export interface RepeaterProps
|
|
|
66
67
|
*/
|
|
67
68
|
|
|
68
69
|
export class Repeater extends React.Component<
|
|
69
|
-
|
|
70
|
+
Merge<React.HTMLProps<HTMLElement>, RepeaterProps>
|
|
70
71
|
> {}
|
|
71
72
|
|
|
72
73
|
export default Repeater;
|
package/Routable/Routable.d.ts
CHANGED
|
@@ -9,7 +9,7 @@ export interface RoutableConfig extends Object {
|
|
|
9
9
|
/**
|
|
10
10
|
* The event to listen to for path changes.
|
|
11
11
|
*
|
|
12
|
-
* This defines the actual name of the
|
|
12
|
+
* This defines the actual name of the [navigate]
|
|
13
13
|
property.
|
|
14
14
|
*/
|
|
15
15
|
navigate: string;
|
|
@@ -73,7 +73,7 @@ navigate `AppPanel` and `HomePanel` .
|
|
|
73
73
|
*/
|
|
74
74
|
|
|
75
75
|
export class Route extends React.Component<
|
|
76
|
-
|
|
76
|
+
Merge<React.HTMLProps<HTMLElement>, RouteProps>
|
|
77
77
|
> {}
|
|
78
78
|
|
|
79
79
|
export default Routable;
|
package/Scroller/Scroller.d.ts
CHANGED
|
@@ -20,7 +20,7 @@ export interface ScrollerBaseProps {
|
|
|
20
20
|
* * {animate} - When `true` , scroll occurs with animation. When `false` , no
|
|
21
21
|
animation occurs.
|
|
22
22
|
* * {focus} - When `true` , attempts to focus item after scroll. Only valid when scrolling
|
|
23
|
-
|
|
23
|
+
by `index` or `node` .
|
|
24
24
|
*
|
|
25
25
|
* Note: Only specify one of: `position` , `align` , `index` or `node`
|
|
26
26
|
*
|
|
@@ -122,7 +122,7 @@ render = () => (
|
|
|
122
122
|
*/
|
|
123
123
|
|
|
124
124
|
export class ScrollerBase extends React.Component<
|
|
125
|
-
|
|
125
|
+
Merge<React.HTMLProps<HTMLElement>, ScrollerBaseProps>
|
|
126
126
|
> {}
|
|
127
127
|
|
|
128
128
|
export interface ScrollerProps extends ScrollerBaseProps {}
|
|
@@ -136,7 +136,7 @@ export interface ScrollerProps extends ScrollerBaseProps {}
|
|
|
136
136
|
*/
|
|
137
137
|
|
|
138
138
|
export class Scroller extends React.Component<
|
|
139
|
-
|
|
139
|
+
Merge<React.HTMLProps<HTMLElement>, ScrollerProps>
|
|
140
140
|
> {}
|
|
141
141
|
|
|
142
142
|
export default Scroller;
|
package/Slider/Slider.d.ts
CHANGED
|
@@ -40,7 +40,7 @@ will have its props merged with the above props.
|
|
|
40
40
|
*/
|
|
41
41
|
|
|
42
42
|
export class Knob extends React.Component<
|
|
43
|
-
|
|
43
|
+
Merge<React.HTMLProps<HTMLElement>, KnobProps>
|
|
44
44
|
> {}
|
|
45
45
|
|
|
46
46
|
export interface SliderBaseProps {
|
|
@@ -69,7 +69,7 @@ corresponding internal Elements and states of this component.
|
|
|
69
69
|
* The following classes are supported:
|
|
70
70
|
* * `slider` - The root component class
|
|
71
71
|
* * `knob` - The knob node
|
|
72
|
-
* * `horizontal` - Applied when `orientation` prop is `"horizontal"
|
|
72
|
+
* * `horizontal` - Applied when `orientation` prop is `"horizontal"``
|
|
73
73
|
* * `pressed` - Applied when `pressed` prop is `true`
|
|
74
74
|
* * `noFill` - Applied when `noFill` prop is `true`
|
|
75
75
|
* * `vertical` - Applied when `orientation` prop is `"vertical"`
|
|
@@ -101,14 +101,14 @@ will have its props merged with the above props.
|
|
|
101
101
|
* The maximum value of the slider.
|
|
102
102
|
*
|
|
103
103
|
* The range between `min` and `max` should be evenly divisible by
|
|
104
|
-
|
|
104
|
+
[step] .
|
|
105
105
|
*/
|
|
106
106
|
max?: number;
|
|
107
107
|
/**
|
|
108
108
|
* The minimum value of the slider.
|
|
109
109
|
*
|
|
110
110
|
* The range between `min` and `max` should be evenly divisible by
|
|
111
|
-
|
|
111
|
+
[step] .
|
|
112
112
|
*/
|
|
113
113
|
min?: number;
|
|
114
114
|
/**
|
|
@@ -164,7 +164,7 @@ will have its props merged with the above props.
|
|
|
164
164
|
*/
|
|
165
165
|
|
|
166
166
|
export class SliderBase extends React.Component<
|
|
167
|
-
|
|
167
|
+
Merge<React.HTMLProps<HTMLElement>, SliderBaseProps>
|
|
168
168
|
> {}
|
|
169
169
|
|
|
170
170
|
export interface SliderDecoratorProps
|
|
@@ -185,7 +185,7 @@ export interface SliderProps
|
|
|
185
185
|
*/
|
|
186
186
|
|
|
187
187
|
export class Slider extends React.Component<
|
|
188
|
-
|
|
188
|
+
Merge<React.HTMLProps<HTMLElement>, SliderProps>
|
|
189
189
|
> {}
|
|
190
190
|
|
|
191
191
|
export default Slider;
|
package/SlotItem/SlotItem.d.ts
CHANGED
|
@@ -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
|
|
15
|
+
to `SlotItem` . A derivative of [Item] is recommended.
|
|
16
16
|
*/
|
|
17
17
|
component: React.ComponentType;
|
|
18
18
|
/**
|
|
@@ -42,7 +42,7 @@ corresponding internal Elements and states of this component.
|
|
|
42
42
|
* * `after` - Applied to the slot that falls after the content
|
|
43
43
|
* * `before` - Applied to the slot that falls before the content
|
|
44
44
|
* * `hidden` - Applied to a slot when that slot is supposed to be hidden, according to
|
|
45
|
-
|
|
45
|
+
`autoHide` prop
|
|
46
46
|
*/
|
|
47
47
|
css?: object;
|
|
48
48
|
/**
|
|
@@ -74,7 +74,7 @@ This may be set to `null` to define your own layout method.
|
|
|
74
74
|
*/
|
|
75
75
|
|
|
76
76
|
export class SlotItemBase extends React.Component<
|
|
77
|
-
|
|
77
|
+
Merge<React.HTMLProps<HTMLElement>, SlotItemBaseProps>
|
|
78
78
|
> {}
|
|
79
79
|
|
|
80
80
|
export interface SlotItemDecoratorProps
|
|
@@ -102,7 +102,7 @@ export interface SlotItemProps
|
|
|
102
102
|
*/
|
|
103
103
|
|
|
104
104
|
export class SlotItem extends React.Component<
|
|
105
|
-
|
|
105
|
+
Merge<React.HTMLProps<HTMLElement>, SlotItemProps>
|
|
106
106
|
> {}
|
|
107
107
|
|
|
108
108
|
export default SlotItem;
|
package/Spinner/Spinner.d.ts
CHANGED
|
@@ -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
|
|
29
|
+
by setting [scrim] prop to `true` .
|
|
30
30
|
*/
|
|
31
31
|
blockClickOn?: string | any;
|
|
32
32
|
/**
|
|
@@ -64,7 +64,7 @@ by default or when blockClickOn is `null` .
|
|
|
64
64
|
*/
|
|
65
65
|
|
|
66
66
|
export class SpinnerBase extends React.Component<
|
|
67
|
-
|
|
67
|
+
Merge<React.HTMLProps<HTMLElement>, SpinnerBaseProps>
|
|
68
68
|
> {}
|
|
69
69
|
|
|
70
70
|
export interface SpinnerDecoratorProps extends ui_ForwardRef_ForwardRefProps {}
|
|
@@ -79,7 +79,7 @@ export interface SpinnerProps
|
|
|
79
79
|
*/
|
|
80
80
|
|
|
81
81
|
export class Spinner extends React.Component<
|
|
82
|
-
|
|
82
|
+
Merge<React.HTMLProps<HTMLElement>, SpinnerProps>
|
|
83
83
|
> {}
|
|
84
84
|
|
|
85
85
|
export default Spinner;
|
|
@@ -44,7 +44,7 @@ corresponding internal Elements and states of this component.
|
|
|
44
44
|
*/
|
|
45
45
|
|
|
46
46
|
export class ToggleIconBase extends React.Component<
|
|
47
|
-
|
|
47
|
+
Merge<React.HTMLProps<HTMLElement>, ToggleIconBaseProps>
|
|
48
48
|
> {}
|
|
49
49
|
|
|
50
50
|
export interface ToggleIconDecoratorProps
|
|
@@ -55,7 +55,7 @@ event executes.
|
|
|
55
55
|
*/
|
|
56
56
|
|
|
57
57
|
export class ToggleIconDecorator extends React.Component<
|
|
58
|
-
|
|
58
|
+
Merge<React.HTMLProps<HTMLElement>, ToggleIconDecoratorProps>
|
|
59
59
|
> {}
|
|
60
60
|
|
|
61
61
|
export interface ToggleIconProps
|
|
@@ -70,7 +70,7 @@ export interface ToggleIconProps
|
|
|
70
70
|
*/
|
|
71
71
|
|
|
72
72
|
export class ToggleIcon extends React.Component<
|
|
73
|
-
|
|
73
|
+
Merge<React.HTMLProps<HTMLElement>, ToggleIconProps>
|
|
74
74
|
> {}
|
|
75
75
|
|
|
76
76
|
export default ToggleIcon;
|
|
@@ -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:
|
|
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
|
-
|
|
29
|
+
[ToggleIcon] for this.
|
|
30
30
|
*/
|
|
31
31
|
iconComponent: React.ComponentType | JSX.Element;
|
|
32
32
|
/**
|
|
@@ -44,7 +44,7 @@ corresponding internal Elements and states of this component.
|
|
|
44
44
|
/**
|
|
45
45
|
* An optional prop that lets you override the icon of the `iconComponent` component.
|
|
46
46
|
*
|
|
47
|
-
* This accepts any string that the
|
|
47
|
+
* This accepts any string that the [Icon] component supports, provided
|
|
48
48
|
the recommendations of `iconComponent` are followed.
|
|
49
49
|
*/
|
|
50
50
|
icon?: string | object;
|
|
@@ -61,14 +61,16 @@ or behind the existing `icon` . See `itemIconPosition` for options.
|
|
|
61
61
|
*/
|
|
62
62
|
itemIcon?: React.ReactNode;
|
|
63
63
|
/**
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
after`
|
|
70
|
-
|
|
71
|
-
|
|
64
|
+
* Specifies where `itemIcon` appears.
|
|
65
|
+
* * `'before'` - first element in the item
|
|
66
|
+
* * `'beforeChildren'` - before `children` . If `iconPosition` is `'before'` , `icon` will be
|
|
67
|
+
*
|
|
68
|
+
* before `itemIcon`
|
|
69
|
+
* * `'afterChildren'` - after `children` . If iconPosition `is` 'after' `, ` icon` will be
|
|
70
|
+
*
|
|
71
|
+
* after `itemIcon`
|
|
72
|
+
* * `'after'` - the last element in the item
|
|
73
|
+
*/
|
|
72
74
|
itemIconPosition?: "before" | "beforeChildren" | "afterChildren" | "after";
|
|
73
75
|
/**
|
|
74
76
|
* Called when the toggle item is toggled. Developers should generally use `onToggle` instead.
|
|
@@ -92,7 +94,7 @@ after` itemIcon`
|
|
|
92
94
|
*/
|
|
93
95
|
|
|
94
96
|
export class ToggleItemBase extends React.Component<
|
|
95
|
-
|
|
97
|
+
Merge<React.HTMLProps<HTMLElement>, ToggleItemBaseProps>
|
|
96
98
|
> {}
|
|
97
99
|
|
|
98
100
|
export interface ToggleItemDecoratorProps
|
|
@@ -116,7 +118,7 @@ export interface ToggleItemProps
|
|
|
116
118
|
*/
|
|
117
119
|
|
|
118
120
|
export class ToggleItem extends React.Component<
|
|
119
|
-
|
|
121
|
+
Merge<React.HTMLProps<HTMLElement>, ToggleItemProps>
|
|
120
122
|
> {}
|
|
121
123
|
|
|
122
124
|
export default ToggleItem;
|
package/Touchable/Touchable.d.ts
CHANGED
|
@@ -31,7 +31,7 @@ Only applies when `global` is `false` .
|
|
|
31
31
|
* * `'border-box'` - the default, includes the padding and border but excludes the margin.
|
|
32
32
|
* * `'content-box'` - excludes the padding, border, and margin.
|
|
33
33
|
* * `global` - When `true` , drag gestures will continue when leaving the bounds of the component
|
|
34
|
-
|
|
34
|
+
or blurring the component.
|
|
35
35
|
* * `moveTolerance` - The number of pixels from the start position of the drag that the pointer
|
|
36
36
|
may move before cancelling the drag. Defaults to `16` .
|
|
37
37
|
*
|
|
@@ -46,7 +46,7 @@ time per move, that must be exceeded to generate a `onFlick` event.
|
|
|
46
46
|
* * `cancelOnMove` - When `true` , the hold is cancelled when moving beyond the `moveTolerance` .
|
|
47
47
|
Defaults to `false`
|
|
48
48
|
* * `global` - When `true` , hold gestures will continue when leaving the bounds of the component
|
|
49
|
-
|
|
49
|
+
or blurring the component.
|
|
50
50
|
* * `moveTolerance` - The number of pixels from the start position of the hold that the pointer
|
|
51
51
|
may move before cancelling the hold. Ignored when `cancelOnMove` is `false` . Defaults to
|
|
52
52
|
`16` .
|
|
@@ -130,7 +130,7 @@ export interface TouchableProps {
|
|
|
130
130
|
* * `type` - Type of event, `'onHold'`
|
|
131
131
|
* * `name` - The name of the hold as configured in the events list
|
|
132
132
|
* * `time` - Time, in milliseconds, configured for this hold which may vary slightly
|
|
133
|
-
|
|
133
|
+
from time since the hold began
|
|
134
134
|
*/
|
|
135
135
|
onHold?: Function;
|
|
136
136
|
/**
|
|
@@ -75,10 +75,11 @@ are also supported and treated as milliseconds.
|
|
|
75
75
|
*/
|
|
76
76
|
noAnimation?: boolean;
|
|
77
77
|
/**
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
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
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
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
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
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
|
-
|
|
101
|
-
|
|
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
|
/**
|
|
@@ -114,7 +115,7 @@ In general, you'll probably want to use the `Transition` instead of `Transiti
|
|
|
114
115
|
*/
|
|
115
116
|
|
|
116
117
|
export class TransitionBase extends React.Component<
|
|
117
|
-
|
|
118
|
+
Merge<React.HTMLProps<HTMLElement>, TransitionBaseProps>
|
|
118
119
|
> {}
|
|
119
120
|
|
|
120
121
|
export interface TransitionProps {
|
|
@@ -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
|
-
|
|
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
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
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
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
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
|
-
|
|
177
|
-
|
|
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
|
/**
|
|
@@ -188,7 +190,7 @@ properties and events.
|
|
|
188
190
|
*/
|
|
189
191
|
|
|
190
192
|
export class Transition extends React.Component<
|
|
191
|
-
|
|
193
|
+
Merge<React.HTMLProps<HTMLElement>, TransitionProps>
|
|
192
194
|
> {}
|
|
193
195
|
|
|
194
196
|
export default Transition;
|
|
@@ -97,17 +97,13 @@ string comparison of the first child's key.
|
|
|
97
97
|
}
|
|
98
98
|
/**
|
|
99
99
|
* The base `ViewManager` component, without
|
|
100
|
-
|
|
100
|
+
[ViewManagerDecorator] applied.
|
|
101
101
|
*/
|
|
102
102
|
|
|
103
103
|
export class ViewManagerBase extends React.Component<
|
|
104
|
-
|
|
104
|
+
Merge<React.HTMLProps<HTMLElement>, ViewManagerBaseProps>
|
|
105
105
|
> {}
|
|
106
106
|
|
|
107
|
-
/**
|
|
108
|
-
* A basic arranger factory that must be configured with `direction` and optionally an `amount` .
|
|
109
|
-
*/
|
|
110
|
-
export function SlideArranger(config: object): Arranger;
|
|
111
107
|
/**
|
|
112
108
|
* A function that generates an animation for a given transition configuration
|
|
113
109
|
*/
|
|
@@ -125,18 +121,22 @@ export interface ArrangerCallback {
|
|
|
125
121
|
export interface Arranger {
|
|
126
122
|
/**
|
|
127
123
|
* Returns an array of keyframes describing the animation when
|
|
128
|
-
|
|
124
|
+
a view is entering the viewport.
|
|
129
125
|
*/
|
|
130
126
|
enter: ArrangerCallback /**
|
|
131
127
|
* Returns an array of keyframes describing the animation when
|
|
132
|
-
|
|
128
|
+
a view is leaving the viewport.
|
|
133
129
|
*/;
|
|
134
130
|
leave: ArrangerCallback /**
|
|
135
131
|
* Returns an array of keyframes describing the animation when
|
|
136
|
-
|
|
132
|
+
a view is remaining in the viewport.
|
|
137
133
|
*/;
|
|
138
134
|
stay?: ArrangerCallback;
|
|
139
135
|
}
|
|
136
|
+
/**
|
|
137
|
+
* A basic arranger factory that must be configured with `direction` and optionally an `amount` .
|
|
138
|
+
*/
|
|
139
|
+
export function SlideArranger(config: object): Arranger;
|
|
140
140
|
/**
|
|
141
141
|
* An arranger that enters from the left and leaves to the right.
|
|
142
142
|
*/
|
|
@@ -168,7 +168,7 @@ transitioned on and off the viewport.
|
|
|
168
168
|
*/
|
|
169
169
|
|
|
170
170
|
export class ViewManager extends React.Component<
|
|
171
|
-
|
|
171
|
+
Merge<React.HTMLProps<HTMLElement>, ViewManagerProps>
|
|
172
172
|
> {}
|
|
173
173
|
|
|
174
174
|
export default ViewManager;
|
|
@@ -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
|
|
10
|
+
in a list for [VirtualGridList] .
|
|
11
11
|
*/
|
|
12
12
|
export interface gridListItemSizeShape {
|
|
13
13
|
/**
|
|
@@ -38,12 +38,12 @@ export interface VirtualListProps extends VirtualListBaseProps {
|
|
|
38
38
|
*/
|
|
39
39
|
|
|
40
40
|
export class VirtualList extends React.Component<
|
|
41
|
-
|
|
41
|
+
Merge<React.HTMLProps<HTMLElement>, VirtualListProps>
|
|
42
42
|
> {}
|
|
43
43
|
|
|
44
44
|
/**
|
|
45
45
|
* The shape for the list different item size
|
|
46
|
-
in a list for
|
|
46
|
+
in a list for [VirtualList] .
|
|
47
47
|
*/
|
|
48
48
|
export interface itemSizesShape {
|
|
49
49
|
/**
|
|
@@ -77,7 +77,7 @@ export interface VirtualGridListProps extends VirtualListBaseProps {
|
|
|
77
77
|
*/
|
|
78
78
|
|
|
79
79
|
export class VirtualGridList extends React.Component<
|
|
80
|
-
|
|
80
|
+
Merge<React.HTMLProps<HTMLElement>, VirtualGridListProps>
|
|
81
81
|
> {}
|
|
82
82
|
|
|
83
83
|
export interface VirtualListBaseProps {
|
|
@@ -85,7 +85,8 @@ export interface VirtualListBaseProps {
|
|
|
85
85
|
* The rendering function called for each item in the list.
|
|
86
86
|
*
|
|
87
87
|
* Note : The list does not always render a component whenever its render function is called
|
|
88
|
-
|
|
88
|
+
*
|
|
89
|
+
* due to performance optimization.
|
|
89
90
|
*
|
|
90
91
|
* Example:
|
|
91
92
|
* ```
|
|
@@ -115,7 +116,7 @@ This option is available for only `VirtualList` kind.
|
|
|
115
116
|
* * {animate} - When `true` , scroll occurs with animation. When `false` , no
|
|
116
117
|
animation occurs.
|
|
117
118
|
* * {focus} - When `true` , attempts to focus item after scroll. Only valid when scrolling
|
|
118
|
-
|
|
119
|
+
by `index` or `node` .
|
|
119
120
|
*
|
|
120
121
|
* Note: Only specify one of: `position` , `align` , `index` or `node`
|
|
121
122
|
*
|
|
@@ -239,11 +240,11 @@ render = () => (
|
|
|
239
240
|
}
|
|
240
241
|
/**
|
|
241
242
|
* A basic base component for
|
|
242
|
-
|
|
243
|
+
[VirtualList] and [VirtualGridList] .
|
|
243
244
|
*/
|
|
244
245
|
|
|
245
246
|
export class VirtualListBase extends React.Component<
|
|
246
|
-
|
|
247
|
+
Merge<React.HTMLProps<HTMLElement>, VirtualListBaseProps>
|
|
247
248
|
> {}
|
|
248
249
|
|
|
249
250
|
export default VirtualList;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@enact/ui",
|
|
3
|
-
"version": "3.2.
|
|
3
|
+
"version": "3.2.7",
|
|
4
4
|
"description": "A collection of simplified unstyled cross-platform UI components for Enact",
|
|
5
5
|
"main": "index.js",
|
|
6
6
|
"scripts": {
|
|
@@ -28,7 +28,7 @@
|
|
|
28
28
|
"extends": "enact/strict"
|
|
29
29
|
},
|
|
30
30
|
"dependencies": {
|
|
31
|
-
"@enact/core": "^3.2.
|
|
31
|
+
"@enact/core": "^3.2.7",
|
|
32
32
|
"classnames": "^2.2.5",
|
|
33
33
|
"direction": "^1.0.1",
|
|
34
34
|
"invariant": "^2.2.2",
|