@micromag/core 0.4.88 → 0.4.90-alpha.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/assets/css/styles.css +4 -15
- package/assets/css/vendor.css +1 -1
- package/es/components.d.ts +106 -118
- package/es/components.js +1627 -1437
- package/es/contexts.d.ts +129 -90
- package/es/contexts.js +2 -136
- package/es/hooks.d.ts +80 -80
- package/es/index.d.ts +62 -46
- package/es/styles.css +4 -15
- package/es/utils.d.ts +85 -84
- package/es/utils.js +4 -4
- package/package.json +23 -20
package/es/hooks.d.ts
CHANGED
|
@@ -4,19 +4,19 @@ import * as _use_gesture_react_dist_declarations_src_types from '@use-gesture/re
|
|
|
4
4
|
export { useIntersectionObserver, useResizeObserver } from '@folklore/hooks';
|
|
5
5
|
|
|
6
6
|
declare function useActivityDetector({ disabled, timeout: timeoutDelay }?: {
|
|
7
|
-
disabled?: boolean;
|
|
8
|
-
timeout?: number;
|
|
7
|
+
disabled?: boolean | undefined;
|
|
8
|
+
timeout?: number | undefined;
|
|
9
9
|
}): {
|
|
10
|
-
ref: react.RefObject<
|
|
10
|
+
ref: react.RefObject<null>;
|
|
11
11
|
detected: boolean;
|
|
12
12
|
};
|
|
13
13
|
|
|
14
14
|
declare const useAnimationFrame: (onFrame: any, { disabled }?: {
|
|
15
|
-
disabled?: boolean;
|
|
15
|
+
disabled?: boolean | undefined;
|
|
16
16
|
}) => void;
|
|
17
17
|
|
|
18
|
-
declare const useFormattedDate: (options?:
|
|
19
|
-
declare const useFormattedTime: (options?:
|
|
18
|
+
declare const useFormattedDate: (options?: null) => (date: any) => string;
|
|
19
|
+
declare const useFormattedTime: (options?: null) => (date: any) => string;
|
|
20
20
|
|
|
21
21
|
declare const useDebounced: (handler: any, watchedValue: any, delay?: number) => void;
|
|
22
22
|
|
|
@@ -44,20 +44,20 @@ declare function useDragProgress({ progress: wantedProgress, onTap, disabled, dr
|
|
|
44
44
|
};
|
|
45
45
|
|
|
46
46
|
declare function useForm({ fields: providedFields, injectInFields, ...opts }?: {
|
|
47
|
-
fields?:
|
|
48
|
-
injectInFields?: boolean;
|
|
47
|
+
fields?: never[] | undefined;
|
|
48
|
+
injectInFields?: boolean | undefined;
|
|
49
49
|
}): {
|
|
50
50
|
fields: any[];
|
|
51
51
|
status: any;
|
|
52
52
|
response: unknown;
|
|
53
|
-
errors: Record<string, string | string[]>;
|
|
53
|
+
errors: Record<string, string | string[] | null>;
|
|
54
54
|
generalError: string;
|
|
55
55
|
success: boolean;
|
|
56
56
|
loading: boolean;
|
|
57
57
|
error: boolean;
|
|
58
58
|
value: Record<string, unknown>;
|
|
59
|
-
setValue: (value: Record<string, unknown>) => void;
|
|
60
|
-
setErrors: (errors: Record<string, string | string[]>) => void;
|
|
59
|
+
setValue: (value: Record<string, unknown> | null) => void;
|
|
60
|
+
setErrors: (errors: Record<string, string | string[] | null> | null) => void;
|
|
61
61
|
setGeneralError: (error: string | null) => void;
|
|
62
62
|
csrfToken: string;
|
|
63
63
|
submit: (submitValue?: Record<string, unknown>) => void;
|
|
@@ -66,8 +66,8 @@ declare function useForm({ fields: providedFields, injectInFields, ...opts }?: {
|
|
|
66
66
|
}) => void;
|
|
67
67
|
};
|
|
68
68
|
|
|
69
|
-
declare const useFormTransition: (initialPaths?:
|
|
70
|
-
direction: string;
|
|
69
|
+
declare const useFormTransition: (initialPaths?: null, initialStyles?: {}) => {
|
|
70
|
+
direction: string | null;
|
|
71
71
|
name: {
|
|
72
72
|
enter: string;
|
|
73
73
|
enterActive: string;
|
|
@@ -78,12 +78,12 @@ declare const useFormTransition: (initialPaths?: any, initialStyles?: {}) => {
|
|
|
78
78
|
};
|
|
79
79
|
|
|
80
80
|
declare const useFullscreen: () => {
|
|
81
|
-
ref: react.RefObject<
|
|
81
|
+
ref: react.RefObject<null>;
|
|
82
82
|
toggle: () => void;
|
|
83
83
|
fullscreen: () => void;
|
|
84
84
|
unFullscreen: () => void;
|
|
85
85
|
active: boolean;
|
|
86
|
-
enabled:
|
|
86
|
+
enabled: true;
|
|
87
87
|
};
|
|
88
88
|
|
|
89
89
|
interface UseIsVisibleOptions {
|
|
@@ -101,16 +101,16 @@ declare const useLoadedFonts: (fonts: any) => {
|
|
|
101
101
|
};
|
|
102
102
|
|
|
103
103
|
declare const useLongPress: ({ onLongPress, onLongPressStart, onLongPressEnd, onClick, shouldPreventDefault, shouldStopPropagation, preventClick, delay, }?: {
|
|
104
|
-
onLongPress?:
|
|
105
|
-
onLongPressStart?:
|
|
106
|
-
onLongPressEnd?:
|
|
107
|
-
onClick?:
|
|
108
|
-
shouldPreventDefault?: boolean;
|
|
109
|
-
shouldStopPropagation?: boolean;
|
|
110
|
-
preventClick?: boolean;
|
|
111
|
-
delay?: number;
|
|
104
|
+
onLongPress?: null | undefined;
|
|
105
|
+
onLongPressStart?: null | undefined;
|
|
106
|
+
onLongPressEnd?: null | undefined;
|
|
107
|
+
onClick?: null | undefined;
|
|
108
|
+
shouldPreventDefault?: boolean | undefined;
|
|
109
|
+
shouldStopPropagation?: boolean | undefined;
|
|
110
|
+
preventClick?: boolean | undefined;
|
|
111
|
+
delay?: number | undefined;
|
|
112
112
|
}) => {
|
|
113
|
-
bind: (props?:
|
|
113
|
+
bind: (props?: null) => {
|
|
114
114
|
onMouseDown: (e: any) => void;
|
|
115
115
|
onTouchStart: (e: any) => void;
|
|
116
116
|
onMouseUp: (e: any) => void;
|
|
@@ -128,8 +128,8 @@ declare const useMediaBuffering: (media?: MediaElement | null) => {
|
|
|
128
128
|
};
|
|
129
129
|
|
|
130
130
|
declare function useMediaState(media?: MediaElement | null, { playing: wantedPlaying, muted: wantedMuted }?: {
|
|
131
|
-
playing?: boolean;
|
|
132
|
-
muted?: boolean;
|
|
131
|
+
playing?: boolean | undefined;
|
|
132
|
+
muted?: boolean | undefined;
|
|
133
133
|
}): {
|
|
134
134
|
playing: boolean;
|
|
135
135
|
muted: boolean;
|
|
@@ -137,56 +137,56 @@ declare function useMediaState(media?: MediaElement | null, { playing: wantedPla
|
|
|
137
137
|
};
|
|
138
138
|
|
|
139
139
|
declare function useMediaCurrentTime(media: MediaElement | null, { id, disabled, updateInterval, onUpdate: customOnUpdate }?: {
|
|
140
|
-
id?:
|
|
141
|
-
disabled?: boolean;
|
|
142
|
-
updateInterval?: number;
|
|
143
|
-
onUpdate?:
|
|
140
|
+
id?: null | undefined;
|
|
141
|
+
disabled?: boolean | undefined;
|
|
142
|
+
updateInterval?: number | undefined;
|
|
143
|
+
onUpdate?: null | undefined;
|
|
144
144
|
}): number;
|
|
145
145
|
|
|
146
146
|
declare function useMediaDuration(media: MediaElement | null, { id }?: {
|
|
147
|
-
id?:
|
|
147
|
+
id?: null | undefined;
|
|
148
148
|
}): number;
|
|
149
149
|
|
|
150
150
|
declare function useMediaLoad(element: any, { preload, shouldLoad }?: {
|
|
151
|
-
preload?: string;
|
|
152
|
-
shouldLoad?: boolean;
|
|
151
|
+
preload?: string | undefined;
|
|
152
|
+
shouldLoad?: boolean | undefined;
|
|
153
153
|
}): void;
|
|
154
154
|
|
|
155
|
-
declare function useMediaProgress(media?:
|
|
155
|
+
declare function useMediaProgress(media?: null, options?: null): number;
|
|
156
156
|
|
|
157
157
|
declare function useMediaReady(media: MediaElement | null, { id }?: {
|
|
158
158
|
id?: string | null;
|
|
159
159
|
}): boolean;
|
|
160
160
|
|
|
161
161
|
declare function useMediaTimestampOffset(element: any, { attributeName }?: {
|
|
162
|
-
attributeName?: string;
|
|
162
|
+
attributeName?: string | undefined;
|
|
163
163
|
}): number;
|
|
164
164
|
|
|
165
165
|
declare class MediasParser {
|
|
166
166
|
constructor({ fieldsManager, screensManager, fieldsPattern }: {
|
|
167
167
|
fieldsManager: any;
|
|
168
168
|
screensManager: any;
|
|
169
|
-
fieldsPattern?: {};
|
|
169
|
+
fieldsPattern?: {} | undefined;
|
|
170
170
|
});
|
|
171
171
|
getParsedStoryTheme(storyId: any, theme: any): any;
|
|
172
172
|
getFieldsPatternByScreen(type: any): any;
|
|
173
173
|
toPath(story: any): any;
|
|
174
|
-
fromPath(story: any, defaultMedias?:
|
|
175
|
-
getFieldsPattern(fields: any, namePrefix?:
|
|
174
|
+
fromPath(story: any, defaultMedias?: null): any;
|
|
175
|
+
getFieldsPattern(fields: any, namePrefix?: null): any;
|
|
176
176
|
static fieldIsMedia({ media }: {
|
|
177
|
-
media?: boolean;
|
|
177
|
+
media?: boolean | undefined;
|
|
178
178
|
}): boolean;
|
|
179
179
|
static fieldIsFontFamily({ id }: {
|
|
180
|
-
id?:
|
|
180
|
+
id?: null | undefined;
|
|
181
181
|
}): boolean;
|
|
182
|
-
static replacePathsWithMedias(data: any, medias: any, patterns: any, keyPrefix?:
|
|
182
|
+
static replacePathsWithMedias(data: any, medias: any, patterns: any, keyPrefix?: null): any;
|
|
183
183
|
static getMediaPath({ id }: {
|
|
184
|
-
id?:
|
|
185
|
-
}): string;
|
|
186
|
-
static replaceMediasWithPaths(data: any, patterns: any, medias?:
|
|
184
|
+
id?: null | undefined;
|
|
185
|
+
}): string | null;
|
|
186
|
+
static replaceMediasWithPaths(data: any, patterns: any, medias?: null, keyPrefix?: null): any;
|
|
187
187
|
static getMediaPatternsFromData(obj: any): RegExp[];
|
|
188
188
|
static dot(obj: any): any;
|
|
189
|
-
static keys(obj: any):
|
|
189
|
+
static keys(obj: any): string[] | number[];
|
|
190
190
|
}
|
|
191
191
|
|
|
192
192
|
declare const useMediasParser: () => {
|
|
@@ -196,9 +196,9 @@ declare const useMediasParser: () => {
|
|
|
196
196
|
};
|
|
197
197
|
|
|
198
198
|
declare function useMediaWaveform(media: any, { fake, reduceBufferFactor }?: {
|
|
199
|
-
fake?: boolean;
|
|
200
|
-
reduceBufferFactor?: number;
|
|
201
|
-
}):
|
|
199
|
+
fake?: boolean | undefined;
|
|
200
|
+
reduceBufferFactor?: number | undefined;
|
|
201
|
+
}): null;
|
|
202
202
|
|
|
203
203
|
declare function useDimensionObserver(opts?: {}): {
|
|
204
204
|
entry: ResizeObserverEntry;
|
|
@@ -208,11 +208,11 @@ declare function useDimensionObserver(opts?: {}): {
|
|
|
208
208
|
};
|
|
209
209
|
|
|
210
210
|
declare const useParsedStory: (story: any, { disabled, withTheme, withMedias, withFonts, withMigrations, }?: {
|
|
211
|
-
disabled?: boolean;
|
|
212
|
-
withTheme?: boolean;
|
|
213
|
-
withMedias?: boolean;
|
|
214
|
-
withFonts?: boolean;
|
|
215
|
-
withMigrations?: boolean;
|
|
211
|
+
disabled?: boolean | undefined;
|
|
212
|
+
withTheme?: boolean | undefined;
|
|
213
|
+
withMedias?: boolean | undefined;
|
|
214
|
+
withFonts?: boolean | undefined;
|
|
215
|
+
withMigrations?: boolean | undefined;
|
|
216
216
|
}) => any;
|
|
217
217
|
|
|
218
218
|
declare function usePlaceholderStyle(selector: string, placeholderStyle: {
|
|
@@ -225,36 +225,36 @@ declare function usePlaceholderStyle(selector: string, placeholderStyle: {
|
|
|
225
225
|
}): string | null;
|
|
226
226
|
|
|
227
227
|
declare function useProgressSteps({ disabled, currentTime, duration, onStep, steps, }: {
|
|
228
|
-
disabled?: boolean;
|
|
228
|
+
disabled?: boolean | undefined;
|
|
229
229
|
currentTime: any;
|
|
230
230
|
duration: any;
|
|
231
|
-
onStep?:
|
|
232
|
-
steps?: number[];
|
|
231
|
+
onStep?: null | undefined;
|
|
232
|
+
steps?: number[] | undefined;
|
|
233
233
|
}): void;
|
|
234
234
|
|
|
235
235
|
declare const useDevicePixelRatio: () => number;
|
|
236
|
-
declare const useScreenSizeFromElement: (options?:
|
|
236
|
+
declare const useScreenSizeFromElement: (options?: null) => {
|
|
237
237
|
ref: react.RefObject<HTMLElement>;
|
|
238
238
|
fullWidth: any;
|
|
239
239
|
fullHeight: any;
|
|
240
240
|
screenSize: {
|
|
241
241
|
screen: any;
|
|
242
|
-
screens:
|
|
243
|
-
width:
|
|
244
|
-
height:
|
|
242
|
+
screens: never[];
|
|
243
|
+
width: null;
|
|
244
|
+
height: null;
|
|
245
245
|
landscape: boolean;
|
|
246
246
|
menuOverScreen: boolean;
|
|
247
247
|
resolution: number;
|
|
248
248
|
imageResolution: number;
|
|
249
249
|
};
|
|
250
|
-
scale: number;
|
|
250
|
+
scale: number | null;
|
|
251
251
|
resolution: number;
|
|
252
252
|
};
|
|
253
253
|
declare const useScreenSizeFromWindow: (opts: any) => {
|
|
254
254
|
screen: any;
|
|
255
|
-
screens:
|
|
256
|
-
width:
|
|
257
|
-
height:
|
|
255
|
+
screens: never[];
|
|
256
|
+
width: null;
|
|
257
|
+
height: null;
|
|
258
258
|
landscape: boolean;
|
|
259
259
|
menuOverScreen: boolean;
|
|
260
260
|
resolution: number;
|
|
@@ -266,17 +266,17 @@ declare function useSpringValue(wantedProgress: any, immediate: any, params: any
|
|
|
266
266
|
declare function useSupportsWebp(defaultValue?: boolean): boolean;
|
|
267
267
|
|
|
268
268
|
declare const useSwipe: ({ width, items: initialItems, withSpring, swipeWidthThreshold, animateScale, disabled, lockAxis, onSwipeStart, onSwipeEnd, onSwipeCancel, onTap, }?: {
|
|
269
|
-
width?:
|
|
270
|
-
items?:
|
|
271
|
-
withSpring?: boolean;
|
|
272
|
-
swipeWidthThreshold?: number;
|
|
273
|
-
animateScale?: boolean;
|
|
274
|
-
disabled?: boolean;
|
|
275
|
-
lockAxis?: boolean;
|
|
276
|
-
onSwipeStart?:
|
|
277
|
-
onSwipeEnd?:
|
|
278
|
-
onSwipeCancel?:
|
|
279
|
-
onTap?:
|
|
269
|
+
width?: null | undefined;
|
|
270
|
+
items?: null | undefined;
|
|
271
|
+
withSpring?: boolean | undefined;
|
|
272
|
+
swipeWidthThreshold?: number | undefined;
|
|
273
|
+
animateScale?: boolean | undefined;
|
|
274
|
+
disabled?: boolean | undefined;
|
|
275
|
+
lockAxis?: boolean | undefined;
|
|
276
|
+
onSwipeStart?: null | undefined;
|
|
277
|
+
onSwipeEnd?: null | undefined;
|
|
278
|
+
onSwipeCancel?: null | undefined;
|
|
279
|
+
onTap?: null | undefined;
|
|
280
280
|
}) => {
|
|
281
281
|
items: {
|
|
282
282
|
x: _react_spring_core.SpringValue<number>;
|
|
@@ -290,11 +290,11 @@ declare const useSwipe: ({ width, items: initialItems, withSpring, swipeWidthThr
|
|
|
290
290
|
|
|
291
291
|
declare const useThemeParser: () => (story: any) => any;
|
|
292
292
|
|
|
293
|
-
declare const useTrackScreenView: () => (screen?:
|
|
294
|
-
declare const useTrackScreenEvent: (type?:
|
|
295
|
-
declare const useTrackScreenMedia: (type?: string | null) => (media?:
|
|
296
|
-
declare const useTrackEvent: () => (category?:
|
|
297
|
-
declare const useTrackMedia: (type?:
|
|
293
|
+
declare const useTrackScreenView: () => (screen?: null, index?: null) => void;
|
|
294
|
+
declare const useTrackScreenEvent: (type?: null) => (action?: null, label?: null, opts?: null) => void;
|
|
295
|
+
declare const useTrackScreenMedia: (type?: string | null) => (media?: null, action?: null, opts?: null) => void;
|
|
296
|
+
declare const useTrackEvent: () => (category?: null, action?: null, label?: null, opts?: null) => void;
|
|
297
|
+
declare const useTrackMedia: (type?: null) => (media?: null, action?: null, opts?: null) => void;
|
|
298
298
|
|
|
299
299
|
declare const useWindowEvent: (event: any, callback: any, enabled?: boolean) => void;
|
|
300
300
|
|
package/es/index.d.ts
CHANGED
|
@@ -10,15 +10,16 @@ declare class ColorsParser {
|
|
|
10
10
|
screensManager: any;
|
|
11
11
|
});
|
|
12
12
|
parse(story: any): any;
|
|
13
|
-
getColorFieldPatterns(fields: any, namePrefix?:
|
|
13
|
+
getColorFieldPatterns(fields: any, namePrefix?: null): any;
|
|
14
14
|
static fieldIsColor({ id }: {
|
|
15
|
-
id?:
|
|
15
|
+
id?: null | undefined;
|
|
16
16
|
}): boolean;
|
|
17
|
-
static getColorsFromPath(data: any, patterns: any, colors?:
|
|
17
|
+
static getColorsFromPath(data: any, patterns: any, colors?: null, keyPrefix?: null): any;
|
|
18
18
|
}
|
|
19
19
|
|
|
20
|
-
type
|
|
21
|
-
type
|
|
20
|
+
type Message = MessageDescriptor;
|
|
21
|
+
type Text = Message | ReactNode;
|
|
22
|
+
type Label = Message | ReactNode;
|
|
22
23
|
type Target = '_blank' | '_self' | '_parent';
|
|
23
24
|
|
|
24
25
|
type MediaElement = HTMLVideoElement | HTMLAudioElement | HTMLMediaElement;
|
|
@@ -39,7 +40,7 @@ interface MediaFile {
|
|
|
39
40
|
}
|
|
40
41
|
interface Media {
|
|
41
42
|
id?: string;
|
|
42
|
-
type
|
|
43
|
+
type?: string;
|
|
43
44
|
url: string;
|
|
44
45
|
thumbnail_url?: string;
|
|
45
46
|
name?: string;
|
|
@@ -48,17 +49,17 @@ interface Media {
|
|
|
48
49
|
}
|
|
49
50
|
type MediaType = 'image' | 'video' | 'audio' | 'closed-captions' | 'font';
|
|
50
51
|
interface ImageMedia extends Omit<Media, 'type' | 'metadata'> {
|
|
51
|
-
type
|
|
52
|
+
type: 'image' | 'video';
|
|
52
53
|
metadata?: MediaMetadata & {
|
|
53
54
|
width?: number;
|
|
54
55
|
height?: number;
|
|
55
56
|
};
|
|
56
57
|
}
|
|
57
58
|
interface FontMedia extends Omit<Media, 'type'> {
|
|
58
|
-
type
|
|
59
|
+
type: 'font';
|
|
59
60
|
}
|
|
60
61
|
interface VideoMedia extends Omit<Media, 'type' | 'metadata'> {
|
|
61
|
-
type
|
|
62
|
+
type: 'video';
|
|
62
63
|
metadata?: MediaMetadata & {
|
|
63
64
|
width?: number;
|
|
64
65
|
height?: number;
|
|
@@ -66,13 +67,13 @@ interface VideoMedia extends Omit<Media, 'type' | 'metadata'> {
|
|
|
66
67
|
};
|
|
67
68
|
}
|
|
68
69
|
interface AudioMedia extends Omit<Media, 'type' | 'metadata'> {
|
|
69
|
-
type
|
|
70
|
+
type: 'audio';
|
|
70
71
|
metadata?: MediaMetadata & {
|
|
71
72
|
duration?: number;
|
|
72
73
|
};
|
|
73
74
|
}
|
|
74
75
|
interface ClosedCaptionsMedia extends Omit<Media, 'type'> {
|
|
75
|
-
type
|
|
76
|
+
type: 'closed-captions';
|
|
76
77
|
}
|
|
77
78
|
|
|
78
79
|
type Errors = string | string[];
|
|
@@ -83,10 +84,6 @@ type SelectOption = string | {
|
|
|
83
84
|
value: unknown;
|
|
84
85
|
label?: Label;
|
|
85
86
|
};
|
|
86
|
-
interface FormField {
|
|
87
|
-
name?: string;
|
|
88
|
-
component?: Component;
|
|
89
|
-
}
|
|
90
87
|
interface Definition {
|
|
91
88
|
id: string;
|
|
92
89
|
component?: Component;
|
|
@@ -96,7 +93,10 @@ interface Field {
|
|
|
96
93
|
type: string;
|
|
97
94
|
label?: Text;
|
|
98
95
|
isSection?: boolean;
|
|
96
|
+
component?: Component;
|
|
97
|
+
defaultValue?: (() => unknown) | unknown;
|
|
99
98
|
fields?: Field[];
|
|
99
|
+
[key: string]: unknown;
|
|
100
100
|
}
|
|
101
101
|
interface ScreenDefinition extends Definition {
|
|
102
102
|
type: 'screen';
|
|
@@ -150,7 +150,7 @@ interface Button {
|
|
|
150
150
|
}
|
|
151
151
|
type BootstrapTheme = 'primary' | 'secondary' | 'success' | 'danger' | 'warning' | 'info' | 'light' | 'dark';
|
|
152
152
|
type ButtonTheme = BootstrapTheme | 'outline-primary' | 'outline-secondary' | 'outline-success' | 'outline-danger' | 'outline-warning' | 'outline-info' | 'outline-light' | 'outline-dark' | 'outline-link' | null;
|
|
153
|
-
type ButtonSize = 'lg' | 'sm' | null;
|
|
153
|
+
type ButtonSize = 'lg' | 'sm' | 'xs' | null;
|
|
154
154
|
type FormControlSize = 'lg' | 'sm' | null;
|
|
155
155
|
type DropdownAlign = 'start' | 'end';
|
|
156
156
|
type ButtonLayout = 'label-bottom' | 'label-top' | 'no-label' | 'label-over' | 'label-left' | 'label-right';
|
|
@@ -205,6 +205,14 @@ interface FontStyle {
|
|
|
205
205
|
underline?: boolean;
|
|
206
206
|
upperCase?: boolean;
|
|
207
207
|
}
|
|
208
|
+
interface HighlightStyle {
|
|
209
|
+
color?: Color;
|
|
210
|
+
textColor?: Color;
|
|
211
|
+
}
|
|
212
|
+
interface LinkStyle {
|
|
213
|
+
color?: Color;
|
|
214
|
+
fontStyle?: FontStyle;
|
|
215
|
+
}
|
|
208
216
|
interface TextStyle {
|
|
209
217
|
fontFamily?: Font;
|
|
210
218
|
fontSize?: number;
|
|
@@ -213,6 +221,8 @@ interface TextStyle {
|
|
|
213
221
|
color?: Color;
|
|
214
222
|
letterSpacing?: number;
|
|
215
223
|
lineHeight?: number;
|
|
224
|
+
link?: LinkStyle;
|
|
225
|
+
highlight?: HighlightStyle;
|
|
216
226
|
}
|
|
217
227
|
type BorderType = 'dotted' | 'dashed' | 'solid' | 'double' | 'groove' | 'ridge' | 'inset' | 'outset' | 'hidden';
|
|
218
228
|
interface ShadowType {
|
|
@@ -238,6 +248,12 @@ interface Margin {
|
|
|
238
248
|
top?: number;
|
|
239
249
|
bottom?: number;
|
|
240
250
|
}
|
|
251
|
+
interface Padding {
|
|
252
|
+
top?: number;
|
|
253
|
+
bottom?: number;
|
|
254
|
+
left?: number;
|
|
255
|
+
right?: number;
|
|
256
|
+
}
|
|
241
257
|
interface GridLayoutItem {
|
|
242
258
|
rows?: number | number[];
|
|
243
259
|
columns?: number | number[];
|
|
@@ -483,9 +499,9 @@ declare class ComponentsManager extends EventEmitter {
|
|
|
483
499
|
constructor(components?: {});
|
|
484
500
|
addComponent(name: string, component: ComponentType, namespace?: string | null): this;
|
|
485
501
|
addComponents(components: ComponentsMap, namespace?: string | null): this;
|
|
486
|
-
merge(manager: ComponentsManager, namespace?:
|
|
502
|
+
merge(manager: ComponentsManager, namespace?: null): this;
|
|
487
503
|
addNamespace(namespace: string | null): this;
|
|
488
|
-
getComponent(name: string, namespace?: string | null): react.ElementType;
|
|
504
|
+
getComponent(name: string, namespace?: string | null): react.ElementType | null;
|
|
489
505
|
getComponents(namespace?: string | null): ComponentsMap;
|
|
490
506
|
hasComponent(name: string, namespace?: string | null): boolean;
|
|
491
507
|
}
|
|
@@ -498,10 +514,10 @@ declare class DefinitionsManager<T extends Definition = Definition> extends Even
|
|
|
498
514
|
addDefinitions(definitions: T[]): this;
|
|
499
515
|
merge(manager: DefinitionsManager<T>): this;
|
|
500
516
|
filter(filter: (definition: T) => boolean): DefinitionsManager<T>;
|
|
501
|
-
getDefinition(id: string): T;
|
|
517
|
+
getDefinition(id: string): T | null;
|
|
502
518
|
getDefinitions(): T[];
|
|
503
519
|
hasDefinition(id: string): boolean;
|
|
504
|
-
getComponent(id: string): Component;
|
|
520
|
+
getComponent(id: string): Component | null;
|
|
505
521
|
getComponents(): Record<string, Component>;
|
|
506
522
|
}
|
|
507
523
|
|
|
@@ -521,27 +537,27 @@ declare class MediasParser {
|
|
|
521
537
|
constructor({ fieldsManager, screensManager, fieldsPattern }: {
|
|
522
538
|
fieldsManager: any;
|
|
523
539
|
screensManager: any;
|
|
524
|
-
fieldsPattern?: {};
|
|
540
|
+
fieldsPattern?: {} | undefined;
|
|
525
541
|
});
|
|
526
542
|
getParsedStoryTheme(storyId: any, theme: any): any;
|
|
527
543
|
getFieldsPatternByScreen(type: any): any;
|
|
528
544
|
toPath(story: any): any;
|
|
529
|
-
fromPath(story: any, defaultMedias?:
|
|
530
|
-
getFieldsPattern(fields: any, namePrefix?:
|
|
545
|
+
fromPath(story: any, defaultMedias?: null): any;
|
|
546
|
+
getFieldsPattern(fields: any, namePrefix?: null): any;
|
|
531
547
|
static fieldIsMedia({ media }: {
|
|
532
|
-
media?: boolean;
|
|
548
|
+
media?: boolean | undefined;
|
|
533
549
|
}): boolean;
|
|
534
550
|
static fieldIsFontFamily({ id }: {
|
|
535
|
-
id?:
|
|
551
|
+
id?: null | undefined;
|
|
536
552
|
}): boolean;
|
|
537
|
-
static replacePathsWithMedias(data: any, medias: any, patterns: any, keyPrefix?:
|
|
553
|
+
static replacePathsWithMedias(data: any, medias: any, patterns: any, keyPrefix?: null): any;
|
|
538
554
|
static getMediaPath({ id }: {
|
|
539
|
-
id?:
|
|
540
|
-
}): string;
|
|
541
|
-
static replaceMediasWithPaths(data: any, patterns: any, medias?:
|
|
555
|
+
id?: null | undefined;
|
|
556
|
+
}): string | null;
|
|
557
|
+
static replaceMediasWithPaths(data: any, patterns: any, medias?: null, keyPrefix?: null): any;
|
|
542
558
|
static getMediaPatternsFromData(obj: any): RegExp[];
|
|
543
559
|
static dot(obj: any): any;
|
|
544
|
-
static keys(obj: any):
|
|
560
|
+
static keys(obj: any): string[] | number[];
|
|
545
561
|
}
|
|
546
562
|
|
|
547
563
|
type ScreensFieldsPattern = {
|
|
@@ -550,10 +566,10 @@ type ScreensFieldsPattern = {
|
|
|
550
566
|
};
|
|
551
567
|
declare class ScreensManager extends DefinitionsManager<ScreenDefinition> {
|
|
552
568
|
fieldsPattern: ScreensFieldsPattern | null;
|
|
553
|
-
constructor(definitions?:
|
|
554
|
-
getFields(id: string): Field[];
|
|
555
|
-
getLayouts(id: string): string[];
|
|
556
|
-
getFieldsPattern(): ScreensFieldsPattern;
|
|
569
|
+
constructor(definitions?: never[]);
|
|
570
|
+
getFields(id: string): Field[] | null;
|
|
571
|
+
getLayouts(id: string): string[] | null;
|
|
572
|
+
getFieldsPattern(): ScreensFieldsPattern | null;
|
|
557
573
|
setFieldsPattern(fieldsPattern: ScreensFieldsPattern): void;
|
|
558
574
|
filter(filter: (definition: ScreenDefinition) => boolean): ScreensManager;
|
|
559
575
|
merge(manager: ScreensManager): this;
|
|
@@ -566,10 +582,10 @@ declare class StoryParser {
|
|
|
566
582
|
fieldsPattern: any;
|
|
567
583
|
});
|
|
568
584
|
parse(story: any, { withTheme, withMedias, withFonts, withMigrations }?: {
|
|
569
|
-
withTheme?: boolean;
|
|
570
|
-
withMedias?: boolean;
|
|
571
|
-
withFonts?: boolean;
|
|
572
|
-
withMigrations?: boolean;
|
|
585
|
+
withTheme?: boolean | undefined;
|
|
586
|
+
withMedias?: boolean | undefined;
|
|
587
|
+
withFonts?: boolean | undefined;
|
|
588
|
+
withMigrations?: boolean | undefined;
|
|
573
589
|
}): any;
|
|
574
590
|
}
|
|
575
591
|
|
|
@@ -590,26 +606,26 @@ declare class FontsParser {
|
|
|
590
606
|
constructor({ fieldsManager, screensManager, fieldsPattern }: {
|
|
591
607
|
fieldsManager: any;
|
|
592
608
|
screensManager: any;
|
|
593
|
-
fieldsPattern?: {};
|
|
609
|
+
fieldsPattern?: {} | undefined;
|
|
594
610
|
});
|
|
595
611
|
getFieldsPatternByScreen(type: any): any;
|
|
596
612
|
parse(story: any): any;
|
|
597
|
-
getFieldsPattern(fields: any, namePrefix?:
|
|
613
|
+
getFieldsPattern(fields: any, namePrefix?: null): any;
|
|
598
614
|
static fieldIsFontFamily({ id }: {
|
|
599
|
-
id?:
|
|
615
|
+
id?: null | undefined;
|
|
600
616
|
}): boolean;
|
|
601
617
|
static valueIsFont({ type }: {
|
|
602
|
-
type?:
|
|
618
|
+
type?: null | undefined;
|
|
603
619
|
}): boolean;
|
|
604
|
-
static extractFontsWithPaths(data: any, patterns: any, keyPrefix?:
|
|
620
|
+
static extractFontsWithPaths(data: any, patterns: any, keyPrefix?: null): any;
|
|
605
621
|
}
|
|
606
622
|
|
|
607
623
|
declare class Tracking extends Tracking$1 {
|
|
608
624
|
constructor(opts?: {});
|
|
609
625
|
trackScreenView(screen: any, screenIndex: any): void;
|
|
610
|
-
trackEvent(category?:
|
|
611
|
-
trackMedia(type?:
|
|
626
|
+
trackEvent(category?: null, action?: null, label?: null, opts?: null): void;
|
|
627
|
+
trackMedia(type?: null, media?: null, action?: null, opts?: null): void;
|
|
612
628
|
}
|
|
613
629
|
|
|
614
630
|
export { ColorsParser, ComponentsManager, DefinitionsManager, EventsManager, FieldsManager, FontsParser, MediasParser, ScreensManager, StoryParser, ThemeParser, Tracking };
|
|
615
|
-
export type { ActiveForm, AdFormat, AdFormats, Alternatives, Answer, AudioElement, AudioMedia, AuthorElement, BackgroundElement, Badge, BootstrapTheme, BorderStyle, BorderType, BoxStyle, Breadcrumb, Button, ButtonLayout, ButtonSize, ButtonTheme, CallToAction, CallToActionType, ClosedCaptions, ClosedCaptionsElement, ClosedCaptionsMedia, Color, ColorObject, Component, ComponentsMap, Conversation, ConversationMessage, CustomAnswer, CustomFont, Definition, Device, DeviceScreen, DropdownAlign, Errors, Field, FieldDefinition, Font, FontMedia, FontStyle, Footer, FormControlSize, FormErrors,
|
|
631
|
+
export type { ActiveForm, AdFormat, AdFormats, Alternatives, Answer, AudioElement, AudioMedia, AuthorElement, BackgroundElement, Badge, BootstrapTheme, BorderStyle, BorderType, BoxStyle, Breadcrumb, Button, ButtonLayout, ButtonSize, ButtonTheme, CallToAction, CallToActionType, ClosedCaptions, ClosedCaptionsElement, ClosedCaptionsMedia, Color, ColorObject, Component, ComponentsMap, Conversation, ConversationMessage, CustomAnswer, CustomFont, Definition, Device, DeviceScreen, DropdownAlign, Errors, Field, FieldDefinition, Font, FontMedia, FontStyle, Footer, FormControlSize, FormErrors, GeoPosition, GridElement, GridLayout, GridLayoutItem, Header, HeadingElement, HighlightStyle, ImageElement, ImageElementWithCaption, ImageMedia, InputElement, Interaction, Label, LinkStyle, Margin, Marker, MarkerWithImage, Media, MediaElement, MediaFile, MediaMetadata, MediaType, MenuItem, Message, Modal, ObjectFit, ObjectFitSize, Organisation, Padding, Panel, QuizAnswer, RenderContext, ScreenComponent, ScreenDefinition, ScreenSize, SearchFilter, SelectOption, ShadowType, ShareIncentive, Speaker, StackAlign, StackDirection, StackElement, StackSpacing, Story, StoryComponent, StoryMetadata, StorySettings, StoryTheme, Target, Text, TextAlign, TextElement, TextStyle, TimingOverrides, TrackingCode, TrackingSettings, TrackingVariables, Transition, TransitionConfig, TransitionEasing, TransitionName, Transitions, User, VideoElement, VideoMedia, ViewerTheme, Visitor, VisualElement };
|