etudes 27.5.0 → 28.0.0
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/build/components/Burger.d.ts +16 -10
- package/build/components/BurgerButton.d.ts +18 -12
- package/build/components/CoverImage.d.ts +19 -21
- package/build/components/CoverVideo.d.ts +19 -13
- package/build/components/OptionButton.d.ts +9 -2
- package/build/components/PanoramaSlider.d.ts +22 -16
- package/build/components/SelectableButton.d.ts +9 -2
- package/build/etudes.js +2256 -2236
- package/build/etudes.umd.cjs +6 -6
- package/build/flows/Switch.d.ts +28 -33
- package/build/hocs/WithTooltip.d.ts +8 -1
- package/build/primitives/Accordion.d.ts +52 -48
- package/build/primitives/Button.d.ts +9 -4
- package/build/primitives/Carousel.d.ts +6 -4
- package/build/primitives/CodeInput.d.ts +17 -47
- package/build/primitives/Collection.d.ts +22 -17
- package/build/primitives/Counter.d.ts +23 -17
- package/build/primitives/Dial.d.ts +18 -12
- package/build/primitives/Dropdown.d.ts +34 -37
- package/build/primitives/FlatSVG.d.ts +9 -2
- package/build/primitives/Form.d.ts +9 -7
- package/build/primitives/Image.d.ts +9 -2
- package/build/primitives/MasonryGrid.d.ts +9 -2
- package/build/primitives/Panorama.d.ts +9 -2
- package/build/primitives/Picture.d.ts +9 -4
- package/build/primitives/RangeSlider.d.ts +24 -18
- package/build/primitives/Select.d.ts +34 -47
- package/build/primitives/Slider.d.ts +31 -41
- package/build/primitives/StepSlider.d.ts +38 -32
- package/build/primitives/SwipeRegion.d.ts +9 -2
- package/build/primitives/TextArea.d.ts +9 -4
- package/build/primitives/TextField.d.ts +9 -2
- package/build/primitives/Toggle.d.ts +20 -33
- package/build/primitives/Video.d.ts +9 -2
- package/build/utils/ExtractChild.d.ts +8 -3
- package/package.json +1 -1
|
@@ -1,9 +1,22 @@
|
|
|
1
|
-
import { HTMLAttributes } from 'react';
|
|
1
|
+
import { HTMLAttributes, Ref } from 'react';
|
|
2
|
+
/**
|
|
3
|
+
* Three-striped burger component that transforms into an "X" when active.
|
|
4
|
+
*
|
|
5
|
+
* @exports Burger.Bar Component for each bar in the burger.
|
|
6
|
+
*/
|
|
7
|
+
export declare function Burger({ className, ref, children, numberOfBars, isActive, isSplit, isTailHidden, ...props }: Burger.Props): import("react/jsx-runtime").JSX.Element;
|
|
8
|
+
export declare namespace Burger {
|
|
9
|
+
var displayName: string;
|
|
10
|
+
}
|
|
2
11
|
export declare namespace Burger {
|
|
3
12
|
/**
|
|
4
13
|
* Type describing the props of {@link Burger}.
|
|
5
14
|
*/
|
|
6
15
|
type Props = {
|
|
16
|
+
/**
|
|
17
|
+
* Reference to the root element.
|
|
18
|
+
*/
|
|
19
|
+
ref?: Ref<HTMLDivElement>;
|
|
7
20
|
/**
|
|
8
21
|
* Specifies if the burger is in its activated state.
|
|
9
22
|
*/
|
|
@@ -22,18 +35,11 @@ export declare namespace Burger {
|
|
|
22
35
|
*/
|
|
23
36
|
numberOfBars?: 2 | 3;
|
|
24
37
|
} & HTMLAttributes<HTMLDivElement>;
|
|
25
|
-
}
|
|
26
|
-
/**
|
|
27
|
-
* Three-striped burger component that transforms into an "X" when active.
|
|
28
|
-
*
|
|
29
|
-
* @exports Burger.Bar Component for each bar in the burger.
|
|
30
|
-
*/
|
|
31
|
-
export declare const Burger: import('react').ForwardRefExoticComponent<Readonly<Burger.Props> & import('react').RefAttributes<HTMLDivElement>> & {
|
|
32
38
|
/**
|
|
33
39
|
* Component for each bar in a {@link Burger}.
|
|
34
40
|
*/
|
|
35
|
-
Bar: {
|
|
41
|
+
const Bar: {
|
|
36
42
|
({ ...props }: HTMLAttributes<HTMLSpanElement>): import("react/jsx-runtime").JSX.Element;
|
|
37
43
|
displayName: string;
|
|
38
44
|
};
|
|
39
|
-
}
|
|
45
|
+
}
|
|
@@ -1,10 +1,24 @@
|
|
|
1
|
-
import { ButtonHTMLAttributes } from 'react';
|
|
1
|
+
import { ButtonHTMLAttributes, Ref } from 'react';
|
|
2
2
|
import { Burger } from './Burger.js';
|
|
3
|
+
/**
|
|
4
|
+
* Three-striped burger button component that transforms into an "X" when
|
|
5
|
+
* active.
|
|
6
|
+
*
|
|
7
|
+
* @exports BurgerButton.Bar Component for each bar in the burger button.
|
|
8
|
+
*/
|
|
9
|
+
export declare function BurgerButton({ className, ref, style, children, numberOfBars, isActive, isSplit, isTailHidden, onActivate, onDeactivate, onToggle, ...props }: BurgerButton.Props): import("react/jsx-runtime").JSX.Element;
|
|
10
|
+
export declare namespace BurgerButton {
|
|
11
|
+
var displayName: string;
|
|
12
|
+
}
|
|
3
13
|
export declare namespace BurgerButton {
|
|
4
14
|
/**
|
|
5
15
|
* Type describing the props of {@link BurgerButton}.
|
|
6
16
|
*/
|
|
7
17
|
type Props = {
|
|
18
|
+
/**
|
|
19
|
+
* Reference to the root element.
|
|
20
|
+
*/
|
|
21
|
+
ref?: Ref<HTMLButtonElement>;
|
|
8
22
|
/**
|
|
9
23
|
* Handler invoked when the button is activated.
|
|
10
24
|
*/
|
|
@@ -20,19 +34,11 @@ export declare namespace BurgerButton {
|
|
|
20
34
|
*/
|
|
21
35
|
onToggle?: (isActive: boolean) => void;
|
|
22
36
|
} & Omit<Burger.Props & ButtonHTMLAttributes<HTMLButtonElement>, 'onToggle'>;
|
|
23
|
-
}
|
|
24
|
-
/**
|
|
25
|
-
* Three-striped burger button component that transforms into an "X" when
|
|
26
|
-
* active.
|
|
27
|
-
*
|
|
28
|
-
* @exports BurgerButton.Bar Component for each bar in the burger button.
|
|
29
|
-
*/
|
|
30
|
-
export declare const BurgerButton: import('react').ForwardRefExoticComponent<Readonly<BurgerButton.Props> & import('react').RefAttributes<HTMLButtonElement>> & {
|
|
31
37
|
/**
|
|
32
38
|
* Component for each bar in a {@link BurgerButton}.
|
|
33
39
|
*/
|
|
34
|
-
Bar: {
|
|
35
|
-
({ ...props }: import(
|
|
40
|
+
const Bar: {
|
|
41
|
+
({ ...props }: import("react").HTMLAttributes<HTMLSpanElement>): import("react/jsx-runtime").JSX.Element;
|
|
36
42
|
displayName: string;
|
|
37
43
|
};
|
|
38
|
-
}
|
|
44
|
+
}
|
|
@@ -1,45 +1,43 @@
|
|
|
1
|
-
import { HTMLAttributes } from 'react';
|
|
1
|
+
import { HTMLAttributes, Ref } from 'react';
|
|
2
2
|
import { Picture } from '../primitives/Picture.js';
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
};
|
|
3
|
+
/**
|
|
4
|
+
* A component that displays an image with a fixed aspect ratio. The image is
|
|
5
|
+
* centered and cropped to fit the container (a.k.a. viewport).
|
|
6
|
+
*
|
|
7
|
+
* @exports CoverImage.Content Component for optional content inside the image.
|
|
8
|
+
* @exports CoverImage.Viewport Component for the viewport.
|
|
9
|
+
*/
|
|
10
|
+
export declare function CoverImage({ ref, style, alt, aspectRatio: externalAspectRatio, children, loadingMode, sources, src, onError, onLoad, onLoadStart, ...props }: Readonly<CoverImage.Props>): import("react/jsx-runtime").JSX.Element;
|
|
11
|
+
export declare namespace CoverImage {
|
|
12
|
+
var displayName: string;
|
|
13
|
+
}
|
|
11
14
|
export declare namespace CoverImage {
|
|
12
15
|
/**
|
|
13
16
|
* Type describing the props of {@link CoverImage}.
|
|
14
17
|
*/
|
|
15
18
|
type Props = {
|
|
19
|
+
/**
|
|
20
|
+
* Reference to the root element.
|
|
21
|
+
*/
|
|
22
|
+
ref?: Ref<HTMLDivElement>;
|
|
16
23
|
/**
|
|
17
24
|
* The known aspect ratio of the image, expressed by width / height. If
|
|
18
25
|
* unprovided, it will be inferred after loading the image.
|
|
19
26
|
*/
|
|
20
27
|
aspectRatio?: number;
|
|
21
28
|
} & Omit<HTMLAttributes<HTMLDivElement>, 'onLoadStart'> & Pick<Picture.Props, 'alt' | 'loadingMode' | 'onError' | 'onLoad' | 'onLoadStart' | 'sources' | 'src'>;
|
|
22
|
-
}
|
|
23
|
-
/**
|
|
24
|
-
* A component that displays an image with a fixed aspect ratio. The image is
|
|
25
|
-
* centered and cropped to fit the container (a.k.a. viewport).
|
|
26
|
-
*
|
|
27
|
-
* @exports CoverImage.Content Component for optional content inside the image.
|
|
28
|
-
* @exports CoverImage.Viewport Component for the viewport.
|
|
29
|
-
*/
|
|
30
|
-
export declare const CoverImage: import('react').ForwardRefExoticComponent<Readonly<CoverImage.Props> & import('react').RefAttributes<HTMLDivElement>> & {
|
|
31
29
|
/**
|
|
32
30
|
* Component for optional content inside a {@link CoverImage}.
|
|
33
31
|
*/
|
|
34
|
-
Content: {
|
|
32
|
+
const Content: {
|
|
35
33
|
({ children, ...props }: HTMLAttributes<HTMLDivElement>): import("react/jsx-runtime").JSX.Element;
|
|
36
34
|
displayName: string;
|
|
37
35
|
};
|
|
38
36
|
/**
|
|
39
37
|
* Component for the viewport of a {@link CoverImage}.
|
|
40
38
|
*/
|
|
41
|
-
Viewport: {
|
|
39
|
+
const Viewport: {
|
|
42
40
|
({ children, ...props }: HTMLAttributes<HTMLDivElement>): import("react/jsx-runtime").JSX.Element;
|
|
43
41
|
displayName: string;
|
|
44
42
|
};
|
|
45
|
-
}
|
|
43
|
+
}
|
|
@@ -1,37 +1,43 @@
|
|
|
1
|
-
import { HTMLAttributes } from 'react';
|
|
1
|
+
import { HTMLAttributes, Ref } from 'react';
|
|
2
2
|
import { Video } from '../primitives/Video.js';
|
|
3
|
+
/**
|
|
4
|
+
* A component that displays a video with a fixed aspect ratio. The video is
|
|
5
|
+
* centered and cropped to fit the container (a.k.a. viewport).
|
|
6
|
+
*
|
|
7
|
+
* @exports CoverVideo.Content Component for optional content inside the video.
|
|
8
|
+
* @exports CoverVideo.Viewport Component for the viewport.
|
|
9
|
+
*/
|
|
10
|
+
export declare function CoverVideo({ className, ref, style, aspectRatio: externalAspectRatio, autoLoop, autoPlay, children, playsInline, posterSrc, src, hasControls, isMuted, onCanPlay, onEnd, onFullscreenChange, onLoadMetadata, onLoadMetadataComplete, onLoadMetadataError, onPause, onPlay, onSizeChange, ...props }: Readonly<CoverVideo.Props>): import("react/jsx-runtime").JSX.Element;
|
|
11
|
+
export declare namespace CoverVideo {
|
|
12
|
+
var displayName: string;
|
|
13
|
+
}
|
|
3
14
|
export declare namespace CoverVideo {
|
|
4
15
|
/**
|
|
5
16
|
* Type describing the props of {@link CoverVideo}.
|
|
6
17
|
*/
|
|
7
18
|
type Props = {
|
|
19
|
+
/**
|
|
20
|
+
* Reference to the root element.
|
|
21
|
+
*/
|
|
22
|
+
ref?: Ref<HTMLDivElement>;
|
|
8
23
|
/**
|
|
9
24
|
* The known aspect ratio of the video, expressed by width / height. If
|
|
10
25
|
* unprovided, it will be inferred after loading the video.
|
|
11
26
|
*/
|
|
12
27
|
aspectRatio?: number;
|
|
13
28
|
} & Omit<HTMLAttributes<HTMLDivElement>, 'onCanPlay' | 'onPause' | 'onPlay'> & Pick<Video.Props, 'autoLoop' | 'autoPlay' | 'hasControls' | 'isMuted' | 'onCanPlay' | 'onEnd' | 'onFullscreenChange' | 'onLoadMetadata' | 'onLoadMetadataComplete' | 'onLoadMetadataError' | 'onPause' | 'onPlay' | 'onSizeChange' | 'playsInline' | 'posterSrc' | 'src'>;
|
|
14
|
-
}
|
|
15
|
-
/**
|
|
16
|
-
* A component that displays a video with a fixed aspect ratio. The video is
|
|
17
|
-
* centered and cropped to fit the container (a.k.a. viewport).
|
|
18
|
-
*
|
|
19
|
-
* @exports CoverVideo.Content Component for optional content inside the video.
|
|
20
|
-
* @exports CoverVideo.Viewport Component for the viewport.
|
|
21
|
-
*/
|
|
22
|
-
export declare const CoverVideo: import('react').ForwardRefExoticComponent<Readonly<CoverVideo.Props> & import('react').RefAttributes<HTMLDivElement>> & {
|
|
23
29
|
/**
|
|
24
30
|
* Component for optional content inside a {@link CoverVideo}.
|
|
25
31
|
*/
|
|
26
|
-
Content: {
|
|
32
|
+
const Content: {
|
|
27
33
|
({ children, ...props }: HTMLAttributes<HTMLDivElement>): import("react/jsx-runtime").JSX.Element;
|
|
28
34
|
displayName: string;
|
|
29
35
|
};
|
|
30
36
|
/**
|
|
31
37
|
* Component for the viewport of a {@link CoverVideo}.
|
|
32
38
|
*/
|
|
33
|
-
Viewport: {
|
|
39
|
+
const Viewport: {
|
|
34
40
|
({ children, ...props }: HTMLAttributes<HTMLDivElement>): import("react/jsx-runtime").JSX.Element;
|
|
35
41
|
displayName: string;
|
|
36
42
|
};
|
|
37
|
-
}
|
|
43
|
+
}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { ButtonHTMLAttributes } from 'react';
|
|
1
|
+
import { ButtonHTMLAttributes, Ref } from 'react';
|
|
2
2
|
export declare namespace OptionButton {
|
|
3
3
|
/**
|
|
4
4
|
* Type describing the props of {@link OptionButton}.
|
|
@@ -19,6 +19,10 @@ export declare namespace OptionButton {
|
|
|
19
19
|
label: string;
|
|
20
20
|
value: string;
|
|
21
21
|
}[] | string[];
|
|
22
|
+
/**
|
|
23
|
+
* Reference to the root element.
|
|
24
|
+
*/
|
|
25
|
+
ref?: Ref<HTMLButtonElement>;
|
|
22
26
|
/**
|
|
23
27
|
* Handler invoked when the button is clicked.
|
|
24
28
|
*
|
|
@@ -31,4 +35,7 @@ export declare namespace OptionButton {
|
|
|
31
35
|
/**
|
|
32
36
|
* A button component that cycles through a list of options when clicked.
|
|
33
37
|
*/
|
|
34
|
-
export declare
|
|
38
|
+
export declare function OptionButton({ ref, index, options, isDisabled, onChange, ...props }: OptionButton.Props): import("react/jsx-runtime").JSX.Element;
|
|
39
|
+
export declare namespace OptionButton {
|
|
40
|
+
var displayName: string;
|
|
41
|
+
}
|
|
@@ -1,11 +1,28 @@
|
|
|
1
|
-
import { HTMLAttributes } from 'react';
|
|
1
|
+
import { HTMLAttributes, Ref } from 'react';
|
|
2
2
|
import { Size } from 'spase';
|
|
3
3
|
import { Panorama } from '../primitives/Panorama.js';
|
|
4
|
+
/**
|
|
5
|
+
* A slider for a {@link Panorama}.
|
|
6
|
+
*
|
|
7
|
+
* @exports Panorama.SliderIndicator Component for the active indicator that
|
|
8
|
+
* appears when the slider is dragged.
|
|
9
|
+
* @exports Panorama.SliderReticle Component for the reticle that indicates the
|
|
10
|
+
* FOV of the backing {@link Panorama}.
|
|
11
|
+
* @exports Panorama.SliderTrack Component for the slide track.
|
|
12
|
+
*/
|
|
13
|
+
export declare function PanoramaSlider({ className, ref, style, angle, autoDimension, children, fov, speed, src, viewportSize, zeroAnchor, onAngleChange, onDragEnd, onDragStart, onImageSizeChange, onLoadImageComplete, onLoadImageError, onLoadImageStart, onPositionChange, ...props }: Readonly<PanoramaSlider.Props>): import("react/jsx-runtime").JSX.Element;
|
|
14
|
+
export declare namespace PanoramaSlider {
|
|
15
|
+
var displayName: string;
|
|
16
|
+
}
|
|
4
17
|
export declare namespace PanoramaSlider {
|
|
5
18
|
/**
|
|
6
19
|
* Type describing the props of {@link PanoramaSlider}.
|
|
7
20
|
*/
|
|
8
21
|
type Props = {
|
|
22
|
+
/**
|
|
23
|
+
* Reference to the root element.
|
|
24
|
+
*/
|
|
25
|
+
ref?: Ref<HTMLDivElement>;
|
|
9
26
|
/**
|
|
10
27
|
* Field-of-view (0.0 - 360.0 degrees, inclusive) that represents the size
|
|
11
28
|
* of the reticle. 360 indicates the reticle covers the entire image. If
|
|
@@ -28,36 +45,25 @@ export declare namespace PanoramaSlider {
|
|
|
28
45
|
*/
|
|
29
46
|
viewportSize?: Size;
|
|
30
47
|
} & Panorama.Props;
|
|
31
|
-
}
|
|
32
|
-
/**
|
|
33
|
-
* A slider for a {@link Panorama}.
|
|
34
|
-
*
|
|
35
|
-
* @exports Panorama.SliderIndicator Component for the active indicator that
|
|
36
|
-
* appears when the slider is dragged.
|
|
37
|
-
* @exports Panorama.SliderReticle Component for the reticle that indicates the
|
|
38
|
-
* FOV of the backing {@link Panorama}.
|
|
39
|
-
* @exports Panorama.SliderTrack Component for the slide track.
|
|
40
|
-
*/
|
|
41
|
-
export declare const PanoramaSlider: import('react').ForwardRefExoticComponent<Readonly<PanoramaSlider.Props> & import('react').RefAttributes<HTMLDivElement>> & {
|
|
42
48
|
/**
|
|
43
49
|
* Component for the active indicator of a {@link PanoramaSlider}.
|
|
44
50
|
*/
|
|
45
|
-
Indicator: {
|
|
51
|
+
const Indicator: {
|
|
46
52
|
({ ...props }: HTMLAttributes<HTMLDivElement>): import("react/jsx-runtime").JSX.Element;
|
|
47
53
|
displayName: string;
|
|
48
54
|
};
|
|
49
55
|
/**
|
|
50
56
|
* Component for the active reticle of a {@link PanoramaSlider}.
|
|
51
57
|
*/
|
|
52
|
-
Reticle: {
|
|
58
|
+
const Reticle: {
|
|
53
59
|
({ ...props }: HTMLAttributes<HTMLDivElement>): import("react/jsx-runtime").JSX.Element;
|
|
54
60
|
displayName: string;
|
|
55
61
|
};
|
|
56
62
|
/**
|
|
57
63
|
* Component for the slide track of a {@link PanoramaSlider}.
|
|
58
64
|
*/
|
|
59
|
-
Track: {
|
|
65
|
+
const Track: {
|
|
60
66
|
({ ...props }: HTMLAttributes<HTMLDivElement>): import("react/jsx-runtime").JSX.Element;
|
|
61
67
|
displayName: string;
|
|
62
68
|
};
|
|
63
|
-
}
|
|
69
|
+
}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { ButtonHTMLAttributes } from 'react';
|
|
1
|
+
import { ButtonHTMLAttributes, Ref } from 'react';
|
|
2
2
|
export declare namespace SelectableButton {
|
|
3
3
|
/**
|
|
4
4
|
* Type describing the props of {@link SelectableButton}.
|
|
@@ -20,6 +20,10 @@ export declare namespace SelectableButton {
|
|
|
20
20
|
* The label of the button.
|
|
21
21
|
*/
|
|
22
22
|
label?: string;
|
|
23
|
+
/**
|
|
24
|
+
* Reference to the root element.
|
|
25
|
+
*/
|
|
26
|
+
ref?: Ref<HTMLButtonElement>;
|
|
23
27
|
/**
|
|
24
28
|
* Handler invoked when the button is deselected.
|
|
25
29
|
*/
|
|
@@ -39,4 +43,7 @@ export declare namespace SelectableButton {
|
|
|
39
43
|
/**
|
|
40
44
|
* A button component that can be selected or deselected.
|
|
41
45
|
*/
|
|
42
|
-
export declare
|
|
46
|
+
export declare function SelectableButton({ className, ref, children, label, isDeselectable, isDisabled, isSelected, onDeselect, onSelect, onToggle, ...props }: SelectableButton.Props): import("react/jsx-runtime").JSX.Element;
|
|
47
|
+
export declare namespace SelectableButton {
|
|
48
|
+
var displayName: string;
|
|
49
|
+
}
|