react-native-header-motion 0.4.0 → 1.0.0-beta.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.
Files changed (140) hide show
  1. package/README.md +400 -335
  2. package/lib/module/components/Bridge.js +16 -0
  3. package/lib/module/components/Bridge.js.map +1 -0
  4. package/lib/module/components/FlatList.js +5 -62
  5. package/lib/module/components/FlatList.js.map +1 -1
  6. package/lib/module/components/Header.js +71 -13
  7. package/lib/module/components/Header.js.map +1 -1
  8. package/lib/module/components/HeaderDynamic.js +34 -0
  9. package/lib/module/components/HeaderDynamic.js.map +1 -0
  10. package/lib/module/components/HeaderMotion.js +59 -23
  11. package/lib/module/components/HeaderMotion.js.map +1 -1
  12. package/lib/module/components/HeaderPanBoundary.js +54 -0
  13. package/lib/module/components/HeaderPanBoundary.js.map +1 -0
  14. package/lib/module/components/NavigationBridge.js +20 -0
  15. package/lib/module/components/NavigationBridge.js.map +1 -0
  16. package/lib/module/components/ScrollManager.js +7 -5
  17. package/lib/module/components/ScrollManager.js.map +1 -1
  18. package/lib/module/components/ScrollView.js +6 -47
  19. package/lib/module/components/ScrollView.js.map +1 -1
  20. package/lib/module/components/createHeaderMotionScrollable.js +136 -0
  21. package/lib/module/components/createHeaderMotionScrollable.js.map +1 -0
  22. package/lib/module/components/index.js +3 -1
  23. package/lib/module/components/index.js.map +1 -1
  24. package/lib/module/context.js +8 -1
  25. package/lib/module/context.js.map +1 -1
  26. package/lib/module/hooks/index.js +1 -0
  27. package/lib/module/hooks/index.js.map +1 -1
  28. package/lib/module/hooks/useActiveScrollId.js +7 -6
  29. package/lib/module/hooks/useActiveScrollId.js.map +1 -1
  30. package/lib/module/hooks/useHeaderMotionBridge.js +14 -0
  31. package/lib/module/hooks/useHeaderMotionBridge.js.map +1 -0
  32. package/lib/module/hooks/useMotionProgress.js +10 -36
  33. package/lib/module/hooks/useMotionProgress.js.map +1 -1
  34. package/lib/module/hooks/useMotionProgress.test.js +56 -0
  35. package/lib/module/hooks/useMotionProgress.test.js.map +1 -0
  36. package/lib/module/hooks/useScrollManager.js +219 -109
  37. package/lib/module/hooks/useScrollManager.js.map +1 -1
  38. package/lib/module/index.js +21 -18
  39. package/lib/module/index.js.map +1 -1
  40. package/lib/module/utils/defaults.js +2 -1
  41. package/lib/module/utils/defaults.js.map +1 -1
  42. package/lib/module/utils/header.js +24 -0
  43. package/lib/module/utils/header.js.map +1 -0
  44. package/lib/module/utils/headerOffsetStyle.js +31 -0
  45. package/lib/module/utils/headerOffsetStyle.js.map +1 -0
  46. package/lib/module/utils/index.js +3 -0
  47. package/lib/module/utils/index.js.map +1 -1
  48. package/lib/module/utils/refreshControl.js +93 -0
  49. package/lib/module/utils/refreshControl.js.map +1 -0
  50. package/lib/module/utils/values.js +36 -0
  51. package/lib/module/utils/values.js.map +1 -1
  52. package/lib/typescript/src/components/Bridge.d.ts +19 -0
  53. package/lib/typescript/src/components/Bridge.d.ts.map +1 -0
  54. package/lib/typescript/src/components/FlatList.d.ts +7 -15
  55. package/lib/typescript/src/components/FlatList.d.ts.map +1 -1
  56. package/lib/typescript/src/components/Header.d.ts +73 -12
  57. package/lib/typescript/src/components/Header.d.ts.map +1 -1
  58. package/lib/typescript/src/components/HeaderDynamic.d.ts +11 -0
  59. package/lib/typescript/src/components/HeaderDynamic.d.ts.map +1 -0
  60. package/lib/typescript/src/components/HeaderMotion.d.ts +37 -18
  61. package/lib/typescript/src/components/HeaderMotion.d.ts.map +1 -1
  62. package/lib/typescript/src/components/HeaderPanBoundary.d.ts +11 -0
  63. package/lib/typescript/src/components/HeaderPanBoundary.d.ts.map +1 -0
  64. package/lib/typescript/src/components/NavigationBridge.d.ts +19 -0
  65. package/lib/typescript/src/components/NavigationBridge.d.ts.map +1 -0
  66. package/lib/typescript/src/components/ScrollManager.d.ts +18 -25
  67. package/lib/typescript/src/components/ScrollManager.d.ts.map +1 -1
  68. package/lib/typescript/src/components/ScrollView.d.ts +7 -14
  69. package/lib/typescript/src/components/ScrollView.d.ts.map +1 -1
  70. package/lib/typescript/src/components/createHeaderMotionScrollable.d.ts +86 -0
  71. package/lib/typescript/src/components/createHeaderMotionScrollable.d.ts.map +1 -0
  72. package/lib/typescript/src/components/index.d.ts +3 -1
  73. package/lib/typescript/src/components/index.d.ts.map +1 -1
  74. package/lib/typescript/src/context.d.ts +3 -13
  75. package/lib/typescript/src/context.d.ts.map +1 -1
  76. package/lib/typescript/src/hooks/index.d.ts +1 -0
  77. package/lib/typescript/src/hooks/index.d.ts.map +1 -1
  78. package/lib/typescript/src/hooks/useActiveScrollId.d.ts +7 -6
  79. package/lib/typescript/src/hooks/useActiveScrollId.d.ts.map +1 -1
  80. package/lib/typescript/src/hooks/useHeaderMotionBridge.d.ts +10 -0
  81. package/lib/typescript/src/hooks/useHeaderMotionBridge.d.ts.map +1 -0
  82. package/lib/typescript/src/hooks/useMotionProgress.d.ts +8 -25
  83. package/lib/typescript/src/hooks/useMotionProgress.d.ts.map +1 -1
  84. package/lib/typescript/src/hooks/useMotionProgress.test.d.ts +2 -0
  85. package/lib/typescript/src/hooks/useMotionProgress.test.d.ts.map +1 -0
  86. package/lib/typescript/src/hooks/useScrollManager.d.ts +63 -31
  87. package/lib/typescript/src/hooks/useScrollManager.d.ts.map +1 -1
  88. package/lib/typescript/src/index.d.ts +56 -26
  89. package/lib/typescript/src/index.d.ts.map +1 -1
  90. package/lib/typescript/src/types.d.ts +63 -15
  91. package/lib/typescript/src/types.d.ts.map +1 -1
  92. package/lib/typescript/src/utils/defaults.d.ts +3 -2
  93. package/lib/typescript/src/utils/defaults.d.ts.map +1 -1
  94. package/lib/typescript/src/utils/header.d.ts +10 -0
  95. package/lib/typescript/src/utils/header.d.ts.map +1 -0
  96. package/lib/typescript/src/utils/headerOffsetStyle.d.ts +19 -0
  97. package/lib/typescript/src/utils/headerOffsetStyle.d.ts.map +1 -0
  98. package/lib/typescript/src/utils/index.d.ts +3 -0
  99. package/lib/typescript/src/utils/index.d.ts.map +1 -1
  100. package/lib/typescript/src/utils/refreshControl.d.ts +150 -0
  101. package/lib/typescript/src/utils/refreshControl.d.ts.map +1 -0
  102. package/lib/typescript/src/utils/values.d.ts +4 -1
  103. package/lib/typescript/src/utils/values.d.ts.map +1 -1
  104. package/package.json +13 -5
  105. package/src/components/Bridge.tsx +29 -0
  106. package/src/components/FlatList.tsx +18 -84
  107. package/src/components/Header.tsx +159 -23
  108. package/src/components/HeaderDynamic.tsx +45 -0
  109. package/src/components/HeaderMotion.tsx +114 -41
  110. package/src/components/HeaderPanBoundary.tsx +92 -0
  111. package/src/components/NavigationBridge.tsx +30 -0
  112. package/src/components/ScrollManager.tsx +38 -43
  113. package/src/components/ScrollView.tsx +16 -68
  114. package/src/components/createHeaderMotionScrollable.tsx +438 -0
  115. package/src/components/index.ts +3 -1
  116. package/src/context.ts +12 -18
  117. package/src/hooks/index.ts +1 -0
  118. package/src/hooks/useActiveScrollId.ts +7 -6
  119. package/src/hooks/useHeaderMotionBridge.ts +15 -0
  120. package/src/hooks/useMotionProgress.test.ts +67 -0
  121. package/src/hooks/useMotionProgress.ts +12 -37
  122. package/src/hooks/useScrollManager.ts +310 -129
  123. package/src/index.ts +82 -36
  124. package/src/types.ts +85 -25
  125. package/src/utils/defaults.ts +7 -1
  126. package/src/utils/header.tsx +52 -0
  127. package/src/utils/headerOffsetStyle.ts +40 -0
  128. package/src/utils/index.ts +3 -0
  129. package/src/utils/refreshControl.tsx +118 -0
  130. package/src/utils/values.ts +57 -1
  131. package/lib/module/components/HeaderBase.js +0 -59
  132. package/lib/module/components/HeaderBase.js.map +0 -1
  133. package/lib/module/hooks/refreshControl.js +0 -31
  134. package/lib/module/hooks/refreshControl.js.map +0 -1
  135. package/lib/typescript/src/components/HeaderBase.d.ts +0 -34
  136. package/lib/typescript/src/components/HeaderBase.d.ts.map +0 -1
  137. package/lib/typescript/src/hooks/refreshControl.d.ts +0 -13
  138. package/lib/typescript/src/hooks/refreshControl.d.ts.map +0 -1
  139. package/src/components/HeaderBase.tsx +0 -51
  140. package/src/hooks/refreshControl.ts +0 -55
@@ -1,31 +0,0 @@
1
- "use strict";
2
-
3
- import { cloneElement, createElement, isValidElement } from 'react';
4
- import { RefreshControl } from 'react-native';
5
- function injectProgressViewOffset(refreshControl, progressViewOffset) {
6
- if (refreshControl.props.progressViewOffset !== undefined) {
7
- return refreshControl;
8
- }
9
- return /*#__PURE__*/cloneElement(refreshControl, {
10
- progressViewOffset: progressViewOffset
11
- });
12
- }
13
- export function resolveRefreshControl({
14
- refreshControl,
15
- refreshing,
16
- onRefresh,
17
- progressViewOffset
18
- }) {
19
- if (refreshControl) {
20
- return /*#__PURE__*/isValidElement(refreshControl) ? injectProgressViewOffset(refreshControl, progressViewOffset) : undefined;
21
- }
22
- if (!onRefresh) {
23
- return undefined;
24
- }
25
- return /*#__PURE__*/createElement(RefreshControl, {
26
- refreshing: refreshing ?? false,
27
- onRefresh: onRefresh,
28
- progressViewOffset: progressViewOffset
29
- });
30
- }
31
- //# sourceMappingURL=refreshControl.js.map
@@ -1 +0,0 @@
1
- {"version":3,"names":["cloneElement","createElement","isValidElement","RefreshControl","injectProgressViewOffset","refreshControl","progressViewOffset","props","undefined","resolveRefreshControl","refreshing","onRefresh"],"sourceRoot":"../../../src","sources":["hooks/refreshControl.ts"],"mappings":";;AAAA,SACEA,YAAY,EACZC,aAAa,EACbC,cAAc,QAET,OAAO;AACd,SAASC,cAAc,QAAkC,cAAc;AAYvE,SAASC,wBAAwBA,CAC/BC,cAAiD,EACjDC,kBAAuC,EACvC;EACA,IAAID,cAAc,CAACE,KAAK,CAACD,kBAAkB,KAAKE,SAAS,EAAE;IACzD,OAAOH,cAAc;EACvB;EAEA,oBAAOL,YAAY,CAACK,cAAc,EAAE;IAClCC,kBAAkB,EAAEA;EACtB,CAAC,CAAC;AACJ;AAEA,OAAO,SAASG,qBAAqBA,CAAC;EACpCJ,cAAc;EACdK,UAAU;EACVC,SAAS;EACTL;AAC4B,CAAC,EAEjB;EACZ,IAAID,cAAc,EAAE;IAClB,OAAO,aAAAH,cAAc,CAAsBG,cAAc,CAAC,GACtDD,wBAAwB,CAACC,cAAc,EAAEC,kBAAkB,CAAC,GAC5DE,SAAS;EACf;EAEA,IAAI,CAACG,SAAS,EAAE;IACd,OAAOH,SAAS;EAClB;EAEA,oBAAOP,aAAa,CAACE,cAAc,EAAE;IACnCO,UAAU,EAAGA,UAAU,IAAgB,KAAK;IAC5CC,SAAS,EAAEA,SAAuB;IAClCL,kBAAkB,EAAEA;EACtB,CAAC,CAAC;AACJ","ignoreList":[]}
@@ -1,34 +0,0 @@
1
- import { type ViewProps } from 'react-native';
2
- import { type AnimatedProps } from 'react-native-reanimated';
3
- export type HeaderBaseProps = ViewProps;
4
- export type AnimatedHeaderBaseProps = AnimatedProps<ViewProps>;
5
- /**
6
- * Base header component with absolute positioning.
7
- * Provides a foundation for building headers that need to be positioned absolutely.
8
- *
9
- * @example
10
- * ```tsx
11
- * <HeaderBase
12
- * onLayout={measureTotalHeight}
13
- * >
14
- * ...
15
- * </HeaderBase>
16
- * ```
17
- */
18
- export declare function HeaderBase({ style, ...rest }: HeaderBaseProps): import("react/jsx-runtime").JSX.Element;
19
- /**
20
- * Animated version of HeaderBase using Reanimated's Animated.View.
21
- * Use this when you need to animate the header based on scroll progress.
22
- *
23
- * @example
24
- * ```tsx
25
- * <AnimatedHeaderBase
26
- * onLayout={measureTotalHeight}
27
- * style={[{ paddingTop: insets.top }, animatedStyle]}
28
- * >
29
- * ...
30
- * </AnimatedHeaderBase>
31
- * ```
32
- */
33
- export declare function AnimatedHeaderBase({ style, ...rest }: AnimatedHeaderBaseProps): import("react/jsx-runtime").JSX.Element;
34
- //# sourceMappingURL=HeaderBase.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"HeaderBase.d.ts","sourceRoot":"","sources":["../../../../src/components/HeaderBase.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAoB,KAAK,SAAS,EAAE,MAAM,cAAc,CAAC;AAChE,OAAiB,EAAE,KAAK,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAEvE,MAAM,MAAM,eAAe,GAAG,SAAS,CAAC;AACxC,MAAM,MAAM,uBAAuB,GAAG,aAAa,CAAC,SAAS,CAAC,CAAC;AAE/D;;;;;;;;;;;;GAYG;AACH,wBAAgB,UAAU,CAAC,EAAE,KAAK,EAAE,GAAG,IAAI,EAAE,EAAE,eAAe,2CAE7D;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,kBAAkB,CAAC,EACjC,KAAK,EACL,GAAG,IAAI,EACR,EAAE,uBAAuB,2CAEzB"}
@@ -1,13 +0,0 @@
1
- import { type ReactElement } from 'react';
2
- import { type RefreshControlProps } from 'react-native';
3
- import type { SharedValue } from 'react-native-reanimated';
4
- type MaybeShared<T> = T | SharedValue<T | undefined>;
5
- export interface ResolveRefreshControlOptions {
6
- refreshControl?: MaybeShared<ReactElement<RefreshControlProps>>;
7
- refreshing?: MaybeShared<boolean>;
8
- onRefresh?: MaybeShared<() => void>;
9
- progressViewOffset: MaybeShared<number>;
10
- }
11
- export declare function resolveRefreshControl({ refreshControl, refreshing, onRefresh, progressViewOffset, }: ResolveRefreshControlOptions): ReactElement<RefreshControlProps> | undefined;
12
- export {};
13
- //# sourceMappingURL=refreshControl.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"refreshControl.d.ts","sourceRoot":"","sources":["../../../../src/hooks/refreshControl.ts"],"names":[],"mappings":"AAAA,OAAO,EAIL,KAAK,YAAY,EAClB,MAAM,OAAO,CAAC;AACf,OAAO,EAAkB,KAAK,mBAAmB,EAAE,MAAM,cAAc,CAAC;AACxE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAE3D,KAAK,WAAW,CAAC,CAAC,IAAI,CAAC,GAAG,WAAW,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC;AAErD,MAAM,WAAW,4BAA4B;IAC3C,cAAc,CAAC,EAAE,WAAW,CAAC,YAAY,CAAC,mBAAmB,CAAC,CAAC,CAAC;IAChE,UAAU,CAAC,EAAE,WAAW,CAAC,OAAO,CAAC,CAAC;IAClC,SAAS,CAAC,EAAE,WAAW,CAAC,MAAM,IAAI,CAAC,CAAC;IACpC,kBAAkB,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;CACzC;AAeD,wBAAgB,qBAAqB,CAAC,EACpC,cAAc,EACd,UAAU,EACV,SAAS,EACT,kBAAkB,GACnB,EAAE,4BAA4B,GAC3B,YAAY,CAAC,mBAAmB,CAAC,GACjC,SAAS,CAgBZ"}
@@ -1,51 +0,0 @@
1
- import { StyleSheet, View, type ViewProps } from 'react-native';
2
- import Animated, { type AnimatedProps } from 'react-native-reanimated';
3
-
4
- export type HeaderBaseProps = ViewProps;
5
- export type AnimatedHeaderBaseProps = AnimatedProps<ViewProps>;
6
-
7
- /**
8
- * Base header component with absolute positioning.
9
- * Provides a foundation for building headers that need to be positioned absolutely.
10
- *
11
- * @example
12
- * ```tsx
13
- * <HeaderBase
14
- * onLayout={measureTotalHeight}
15
- * >
16
- * ...
17
- * </HeaderBase>
18
- * ```
19
- */
20
- export function HeaderBase({ style, ...rest }: HeaderBaseProps) {
21
- return <View style={[style, styles.container]} {...rest} />;
22
- }
23
-
24
- /**
25
- * Animated version of HeaderBase using Reanimated's Animated.View.
26
- * Use this when you need to animate the header based on scroll progress.
27
- *
28
- * @example
29
- * ```tsx
30
- * <AnimatedHeaderBase
31
- * onLayout={measureTotalHeight}
32
- * style={[{ paddingTop: insets.top }, animatedStyle]}
33
- * >
34
- * ...
35
- * </AnimatedHeaderBase>
36
- * ```
37
- */
38
- export function AnimatedHeaderBase({
39
- style,
40
- ...rest
41
- }: AnimatedHeaderBaseProps) {
42
- return <Animated.View style={[style, styles.container]} {...rest} />;
43
- }
44
-
45
- const styles = StyleSheet.create({
46
- container: {
47
- position: 'absolute',
48
- left: 0,
49
- right: 0,
50
- },
51
- });
@@ -1,55 +0,0 @@
1
- import {
2
- cloneElement,
3
- createElement,
4
- isValidElement,
5
- type ReactElement,
6
- } from 'react';
7
- import { RefreshControl, type RefreshControlProps } from 'react-native';
8
- import type { SharedValue } from 'react-native-reanimated';
9
-
10
- type MaybeShared<T> = T | SharedValue<T | undefined>;
11
-
12
- export interface ResolveRefreshControlOptions {
13
- refreshControl?: MaybeShared<ReactElement<RefreshControlProps>>;
14
- refreshing?: MaybeShared<boolean>;
15
- onRefresh?: MaybeShared<() => void>;
16
- progressViewOffset: MaybeShared<number>;
17
- }
18
-
19
- function injectProgressViewOffset(
20
- refreshControl: ReactElement<RefreshControlProps>,
21
- progressViewOffset: MaybeShared<number>
22
- ) {
23
- if (refreshControl.props.progressViewOffset !== undefined) {
24
- return refreshControl;
25
- }
26
-
27
- return cloneElement(refreshControl, {
28
- progressViewOffset: progressViewOffset as number,
29
- });
30
- }
31
-
32
- export function resolveRefreshControl({
33
- refreshControl,
34
- refreshing,
35
- onRefresh,
36
- progressViewOffset,
37
- }: ResolveRefreshControlOptions):
38
- | ReactElement<RefreshControlProps>
39
- | undefined {
40
- if (refreshControl) {
41
- return isValidElement<RefreshControlProps>(refreshControl)
42
- ? injectProgressViewOffset(refreshControl, progressViewOffset)
43
- : undefined;
44
- }
45
-
46
- if (!onRefresh) {
47
- return undefined;
48
- }
49
-
50
- return createElement(RefreshControl, {
51
- refreshing: (refreshing as boolean) ?? false,
52
- onRefresh: onRefresh as () => void,
53
- progressViewOffset: progressViewOffset as number,
54
- }) as unknown as ReactElement<RefreshControlProps>;
55
- }