@react-motion-router/stack 2.0.0-beta.sha-c19f37e → 2.0.0-beta.sha-7188e1e
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/Anchor.d.ts +12 -6
- package/build/GestureRegion.d.ts +3 -2
- package/build/HistoryEntry.d.ts +1 -0
- package/build/Navigation.d.ts +3 -0
- package/build/Router.d.ts +4 -3
- package/build/Screen.d.ts +12 -6
- package/build/__tests__/Anchor/index.test.d.ts +1 -0
- package/build/__tests__/Anchor/preload.force.test.d.ts +1 -0
- package/build/__tests__/Anchor/preload.hover.test.d.ts +1 -0
- package/build/__tests__/Anchor/preload.onsight.test.d.ts +1 -0
- package/build/__tests__/Screen/dialog.test.d.ts +1 -0
- package/build/__tests__/Screen/modal.test.d.ts +1 -0
- package/build/common/constants.d.ts +1 -1
- package/build/common/events.d.ts +6 -9
- package/build/common/test-utils.d.ts +1 -0
- package/build/common/types.d.ts +2 -0
- package/build/index.js +1340 -1184
- package/build/index.js.map +1 -1
- package/package.json +2 -2
package/build/Anchor.d.ts
CHANGED
|
@@ -1,29 +1,35 @@
|
|
|
1
|
-
import { PlainObject
|
|
1
|
+
import { PlainObject } from '../../core/build';
|
|
2
2
|
import { ScreenConfig } from './Screen';
|
|
3
3
|
interface OnSightPreloadBehaviour extends UseIntersectionOptions {
|
|
4
4
|
type: 'onsight';
|
|
5
5
|
}
|
|
6
6
|
interface OnHoverPreloadBehaviour {
|
|
7
7
|
type: 'onhover';
|
|
8
|
-
|
|
8
|
+
pressureThreshold?: number;
|
|
9
9
|
}
|
|
10
|
-
interface AnchorProps extends
|
|
11
|
-
params?: PlainObject<string | boolean | number
|
|
10
|
+
interface AnchorProps extends React.DetailedHTMLProps<React.AnchorHTMLAttributes<HTMLAnchorElement>, HTMLAnchorElement> {
|
|
11
|
+
params?: PlainObject<string | boolean | number> | null;
|
|
12
12
|
/**
|
|
13
13
|
* Will override params object if supplied.
|
|
14
14
|
* Used to control the search params that get passed to the href attribute.
|
|
15
15
|
*/
|
|
16
|
-
searchParams?: PlainObject<string | boolean | number
|
|
16
|
+
searchParams?: PlainObject<string | boolean | number> | null;
|
|
17
17
|
config?: ScreenConfig;
|
|
18
18
|
preload?: boolean;
|
|
19
19
|
preloadBehaviour?: OnSightPreloadBehaviour | OnHoverPreloadBehaviour | {
|
|
20
20
|
type: 'force';
|
|
21
21
|
};
|
|
22
|
+
rel?: 'next' | 'prev' | (string & {});
|
|
23
|
+
historyEntryKey?: string;
|
|
24
|
+
reload?: boolean;
|
|
25
|
+
replace?: boolean;
|
|
26
|
+
traverse?: boolean;
|
|
27
|
+
children?: React.ReactNode;
|
|
22
28
|
}
|
|
23
29
|
interface UseIntersectionOptions {
|
|
24
30
|
root?: Element | null;
|
|
25
31
|
rootMargin?: string;
|
|
26
32
|
threshold?: number | number[];
|
|
27
33
|
}
|
|
28
|
-
export declare function Anchor({ preload, params, searchParams, config, preloadBehaviour, children, ...
|
|
34
|
+
export declare function Anchor({ ref: forwardedRef, preload, params, searchParams, config, preloadBehaviour, children, ...props }: AnchorProps): import("react/jsx-runtime").JSX.Element;
|
|
29
35
|
export {};
|
package/build/GestureRegion.d.ts
CHANGED
|
@@ -1,10 +1,11 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
1
2
|
type GestureRegion = {
|
|
2
|
-
[T in keyof JSX.IntrinsicElements]: ReturnType<typeof createGestureRegion<T>>;
|
|
3
|
+
[T in keyof React.JSX.IntrinsicElements]: ReturnType<typeof createGestureRegion<T>>;
|
|
3
4
|
};
|
|
4
5
|
interface GestureRegionProps {
|
|
5
6
|
gestureBehaviour?: 'contain' | 'none';
|
|
6
7
|
uaGestureAreaWidth?: number;
|
|
7
8
|
}
|
|
8
|
-
export declare const createGestureRegion: <T extends keyof JSX.IntrinsicElements>(tag: T) => ({ ref: forwardedRef, gestureBehaviour, uaGestureAreaWidth, ...props }: JSX.IntrinsicElements[T] & GestureRegionProps) => import("react/jsx-runtime").JSX.Element;
|
|
9
|
+
export declare const createGestureRegion: <T extends keyof React.JSX.IntrinsicElements>(tag: T) => ({ ref: forwardedRef, gestureBehaviour, uaGestureAreaWidth, ...props }: React.JSX.IntrinsicElements[T] & GestureRegionProps) => import("react/jsx-runtime").JSX.Element;
|
|
9
10
|
export declare const GestureRegion: GestureRegion;
|
|
10
11
|
export {};
|
package/build/HistoryEntry.d.ts
CHANGED
|
@@ -5,6 +5,7 @@ export declare class HistoryEntry implements Omit<NavigationHistoryEntry, 'url'>
|
|
|
5
5
|
constructor(nativeEntry: NavigationHistoryEntry, routerId: string, index: number);
|
|
6
6
|
set ondispose(handler: ((this: NavigationHistoryEntry, ev: Event) => void) | null);
|
|
7
7
|
get ondispose(): ((this: NavigationHistoryEntry, ev: Event) => void) | null;
|
|
8
|
+
get nativeEntry(): NavigationHistoryEntry;
|
|
8
9
|
get id(): string;
|
|
9
10
|
get globalIndex(): number;
|
|
10
11
|
get url(): URL | null;
|
package/build/Navigation.d.ts
CHANGED
|
@@ -4,7 +4,9 @@ import { HistoryEntry } from './HistoryEntry';
|
|
|
4
4
|
export interface NavigationConfig extends NavigationBaseConfig {
|
|
5
5
|
getCommitted(): Promise<NavigationHistoryEntry> | null;
|
|
6
6
|
getTransition(): NavigationTransition | LoadNavigationTransition | null;
|
|
7
|
+
getDestination(): NavigationDestination | null;
|
|
7
8
|
getPathPatterns(): PathPattern[];
|
|
9
|
+
getController(): AbortController | null;
|
|
8
10
|
}
|
|
9
11
|
export declare class Navigation extends NavigationBase {
|
|
10
12
|
private readonly config;
|
|
@@ -20,6 +22,7 @@ export declare class Navigation extends NavigationBase {
|
|
|
20
22
|
private createBackEvent;
|
|
21
23
|
private createForwardEvent;
|
|
22
24
|
private createNavigateEvent;
|
|
25
|
+
get controller(): AbortController | null;
|
|
23
26
|
get committed(): Promise<NavigationHistoryEntry> | null;
|
|
24
27
|
get transition(): NavigationTransition | LoadNavigationTransition | null;
|
|
25
28
|
get globalEntries(): NavigationHistoryEntry[];
|
package/build/Router.d.ts
CHANGED
|
@@ -16,6 +16,7 @@ export interface RouterProps extends RouterBaseProps<Screen> {
|
|
|
16
16
|
type InjectedScreenProps = Pick<ScreenProps, 'config' | 'defaultParams'> & ScreenInternalProps;
|
|
17
17
|
export interface RouterState extends RouterBaseState {
|
|
18
18
|
transition: NavigationTransition | LoadEvent['transition'] | null;
|
|
19
|
+
destination: NavigationDestination | null;
|
|
19
20
|
screenStack: ClonedElementType<ScreenChild<Screen>, InjectedScreenProps>[];
|
|
20
21
|
gestureDirection: SwipeDirection;
|
|
21
22
|
gestureAreaWidth: number;
|
|
@@ -29,6 +30,7 @@ export interface RouterState extends RouterBaseState {
|
|
|
29
30
|
}
|
|
30
31
|
export declare class Router extends RouterBase<RouterProps, RouterState> {
|
|
31
32
|
#private;
|
|
33
|
+
protected ref: import('react').RefObject<HTMLDivElement | null>;
|
|
32
34
|
readonly navigation: Navigation;
|
|
33
35
|
constructor(props: RouterProps, context: React.ContextType<typeof NestedRouterContext>);
|
|
34
36
|
static getDerivedStateFromProps(_: RouterProps, state: RouterState): {
|
|
@@ -40,10 +42,8 @@ export declare class Router extends RouterBase<RouterProps, RouterState> {
|
|
|
40
42
|
documentTitle: string | undefined;
|
|
41
43
|
};
|
|
42
44
|
componentDidMount(): void;
|
|
43
|
-
shouldComponentUpdate(nextProps: Readonly<RouterProps>, nextState: Readonly<RouterState>): boolean;
|
|
44
45
|
componentWillUnmount(): void;
|
|
45
46
|
onnavigate(e: NavigateEvent): void;
|
|
46
|
-
oncurrententrychange(): void;
|
|
47
47
|
onnavigatesuccess(): void;
|
|
48
48
|
onnavigateerror({ error }: ErrorEvent): void;
|
|
49
49
|
private readonly onGestureCancel;
|
|
@@ -62,7 +62,8 @@ export declare class Router extends RouterBase<RouterProps, RouterState> {
|
|
|
62
62
|
private handleLoad;
|
|
63
63
|
private handleReplace;
|
|
64
64
|
private handleDefault;
|
|
65
|
-
private
|
|
65
|
+
private prepareScreens;
|
|
66
|
+
private commitScreens;
|
|
66
67
|
private screenTransition;
|
|
67
68
|
render(): import("react/jsx-runtime").JSX.Element;
|
|
68
69
|
}
|
package/build/Screen.d.ts
CHANGED
|
@@ -1,8 +1,9 @@
|
|
|
1
|
-
import { ScreenBase, PlainObject, ScreenBaseProps, ScreenBaseState, ScreenBaseComponentProps, ScreenBaseConfig, MatchedRoute } from '../../core/build';
|
|
1
|
+
import { ScreenBase, PlainObject, ScreenBaseProps, ScreenBaseState, ScreenBaseComponentProps, ScreenBaseConfig, MatchedRoute, ElementForTag } from '../../core/build';
|
|
2
2
|
import { Navigation } from './Navigation';
|
|
3
3
|
import { HistoryEntryState, RouteProp, SwipeDirection } from './common/types';
|
|
4
4
|
import { Router } from './Router';
|
|
5
5
|
import { HistoryEntry } from './HistoryEntry';
|
|
6
|
+
import { RefObject } from 'react';
|
|
6
7
|
export type ScreenComponentProps<T extends PlainObject = object> = ScreenBaseComponentProps<RouteProp<T>, Navigation>;
|
|
7
8
|
export interface ScreenConfig extends ScreenBaseConfig<RouteProp> {
|
|
8
9
|
readonly title?: string;
|
|
@@ -16,13 +17,13 @@ export interface ScreenConfig extends ScreenBaseConfig<RouteProp> {
|
|
|
16
17
|
}
|
|
17
18
|
export interface ScreenProps extends ScreenBaseProps {
|
|
18
19
|
config?: ScreenConfig;
|
|
20
|
+
ref?: RefObject<Screen | null>;
|
|
19
21
|
}
|
|
20
|
-
export
|
|
22
|
+
export type ScreenState = ScreenBaseState;
|
|
23
|
+
export declare class Screen extends ScreenBase<ScreenProps, ScreenState, RouteProp> {
|
|
21
24
|
#private;
|
|
25
|
+
protected ref: RefObject<ElementForTag<"dialog" | "div"> | null>;
|
|
22
26
|
constructor(props: ScreenProps, router: Router);
|
|
23
|
-
static getDerivedStateFromProps(props: ScreenProps): {
|
|
24
|
-
elementType: string;
|
|
25
|
-
};
|
|
26
27
|
static historyEntryStateFromEntry(entry: HistoryEntry, matchInfo: MatchedRoute | null): HistoryEntryState;
|
|
27
28
|
protected setParams(newParams: PlainObject): void;
|
|
28
29
|
protected setConfig(newConfig: NonNullable<ScreenProps['config']>): void;
|
|
@@ -30,7 +31,10 @@ export declare class Screen extends ScreenBase<ScreenProps, ScreenBaseState, Rou
|
|
|
30
31
|
private get internalProps();
|
|
31
32
|
get resolvedPathname(): string;
|
|
32
33
|
private get historyEntryState();
|
|
34
|
+
get inert(): true | undefined;
|
|
35
|
+
get elementType(): React.JSX.ElementType;
|
|
33
36
|
get id(): string;
|
|
37
|
+
get viewTransitionName(): string;
|
|
34
38
|
get params(): {
|
|
35
39
|
[x: string]: any;
|
|
36
40
|
};
|
|
@@ -93,7 +97,9 @@ export declare class Screen extends ScreenBase<ScreenProps, ScreenBaseState, Rou
|
|
|
93
97
|
};
|
|
94
98
|
};
|
|
95
99
|
protected setHistoryState(newState: PlainObject | ((prevState: PlainObject) => PlainObject)): void;
|
|
96
|
-
|
|
100
|
+
onclick(e: MouseEvent): void;
|
|
101
|
+
onclose(): void;
|
|
97
102
|
onEnter(signal: AbortSignal): Promise<void>;
|
|
98
103
|
onExited(signal: AbortSignal): Promise<void>;
|
|
104
|
+
render(): import("react/jsx-runtime").JSX.Element;
|
|
99
105
|
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -5,5 +5,5 @@ export declare const DEFAULT_GESTURE_CONFIG: {
|
|
|
5
5
|
readonly gestureDirection: "right";
|
|
6
6
|
readonly gestureDisabled: false;
|
|
7
7
|
};
|
|
8
|
-
export declare const DEFAULT_PRELOAD_FORCE_THRESHOLD = 0
|
|
8
|
+
export declare const DEFAULT_PRELOAD_FORCE_THRESHOLD = 0;
|
|
9
9
|
export declare const DEFAULT_PLAYBACK_RATE = 1;
|
package/build/common/events.d.ts
CHANGED
|
@@ -6,23 +6,20 @@ export declare class NavigateEvent extends Event {
|
|
|
6
6
|
readonly props: NavigationProps;
|
|
7
7
|
readonly navigationType: NonNullable<NavigateOptions['type']>;
|
|
8
8
|
readonly signal: AbortSignal;
|
|
9
|
-
readonly
|
|
10
|
-
|
|
11
|
-
constructor(routerId: string, route: string, props: NavigationProps, type: NavigateOptions['type'], signal: AbortSignal, committed: Promise<NavigationHistoryEntry>, transition: NavigationTransition);
|
|
9
|
+
readonly result: NavigationResult;
|
|
10
|
+
constructor(routerId: string, route: string, props: NavigationProps, type: NavigateOptions['type'], signal: AbortSignal, result: NavigationResult);
|
|
12
11
|
}
|
|
13
12
|
export declare class BackEvent extends Event {
|
|
14
13
|
readonly routerId: string;
|
|
15
14
|
readonly signal: AbortSignal;
|
|
16
|
-
readonly
|
|
17
|
-
|
|
18
|
-
constructor(routerId: string, signal: AbortSignal, committed: Promise<NavigationHistoryEntry>, transition: NavigationTransition);
|
|
15
|
+
readonly result: NavigationResult;
|
|
16
|
+
constructor(routerId: string, signal: AbortSignal, result: NavigationResult);
|
|
19
17
|
}
|
|
20
18
|
export declare class ForwardEvent extends Event {
|
|
21
19
|
readonly routerId: string;
|
|
22
20
|
readonly signal: AbortSignal;
|
|
23
|
-
readonly
|
|
24
|
-
|
|
25
|
-
constructor(routerId: string, signal: AbortSignal, committed: Promise<NavigationHistoryEntry>, transition: NavigationTransition);
|
|
21
|
+
readonly result: NavigationResult;
|
|
22
|
+
constructor(routerId: string, signal: AbortSignal, result: NavigationResult);
|
|
26
23
|
}
|
|
27
24
|
export declare class GestureStartEvent extends Event {
|
|
28
25
|
readonly source: GestureEvent;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export declare function addEventListener<T extends EventTarget>(target: T | null, ...args: Parameters<T['addEventListener']>): () => void;
|
package/build/common/types.d.ts
CHANGED
|
@@ -2,6 +2,7 @@ import { PlainObject, RoutePropBase } from '../../../core/build';
|
|
|
2
2
|
import { ScreenProps } from '../Screen';
|
|
3
3
|
import { RefObject } from 'react';
|
|
4
4
|
import { BackEvent, ForwardEvent, GestureCancelEvent, GestureEndEvent, GestureStartEvent, NavigateEvent } from './events';
|
|
5
|
+
import { HistoryEntry } from '../HistoryEntry';
|
|
5
6
|
export interface NavigationBaseOptions {
|
|
6
7
|
signal?: AbortSignal;
|
|
7
8
|
}
|
|
@@ -44,4 +45,5 @@ export declare function isHorizontalDirection(direction: SwipeDirection): direct
|
|
|
44
45
|
export interface ScreenInternalProps {
|
|
45
46
|
resolvedPathname: string;
|
|
46
47
|
id: React.Key;
|
|
48
|
+
entry: HistoryEntry;
|
|
47
49
|
}
|