Merge pull request #5 from iway1/improvement/type-declarations

Added type declarations (for vanilla JS projects)

Author: iway1

commit-and-push

@@ -0,0 +1,5 @@
+tsc -p package/tsconfig.json
+git add .
+read -p "Enter a commit message (no quotes): " commitMessage
+git commit -m "$commitMessage"
+git push

package/tsconfig.json

@@ -0,0 +1,9 @@
+{
+    "compilerOptions": {
+        "declaration": true,
+        "emitDeclarationOnly": true,
+        "outDir": "types",
+        "jsx": "react-native",
+        "esModuleInterop": true
+    },
+}

package/types/index.d.ts

@@ -0,0 +1,6 @@
+export { default as KeyboardAvoiderInsets } from './src/components/KeyboardAvoiderInsets';
+export { default as KeyboardAvoiderView } from './src/components/KeyboardAvoiderView';
+export { default as KeyboardAvoiderScrollView } from './src/components/KeyboardAvoiderScrollView';
+export { default as KeyboardAvoiderScrollSection } from './src/components/KeyboardAvoiderScrollSection';
+export { default as KeyboardAvoiderProvider } from './src/components/KeyboardAvoiderProvider';
+export { useAppHeight } from './src/components/KeyboardAvoiderProvider';

package/types/src/components/KeyboardAvoiderInsets.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+import { CommonProps } from "./common-props";
+export default function KeyboardAvoiderInsets({ animationEasing, animationTime, extraSpace }: CommonProps): JSX.Element;

package/types/src/components/KeyboardAvoiderProvider.d.ts

@@ -0,0 +1,7 @@
+import { ReactNode } from "react";
+export default function KeyboardAvoiderProvider({ children, }: {
+    children: ReactNode;
+}): JSX.Element;
+export declare function useAppHeight(): {
+    appHeight: number;
+};

package/types/src/components/KeyboardAvoiderScrollSection.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+import { ViewProps } from "react-native";
+export default function KeyboardAvoiderScrollSection(props: Omit<ViewProps, 'collapsable'>): JSX.Element;

package/types/src/components/KeyboardAvoiderScrollView.d.ts

@@ -0,0 +1,20 @@
+/// <reference types="react" />
+import { ScrollViewProps, View } from "react-native";
+import { CommonProps } from "./common-props";
+declare type Props = ScrollViewProps & CommonProps & {
+    /**
+     * What to do when the keyboard hides on iOS.
+     * @option 'stay' - *Default* scroll view will not move when the keyboard hides (it will stay where it is.)
+     * @option 'revert' - Scroll view will return to its original position when the keyboard hides.
+     */
+    iosHideBehavior?: 'stay' | 'revert';
+};
+export default function KeyboardAvoiderScrollView({ animationEasing, animationTime, extraSpace, iosHideBehavior, ...props }: Props): JSX.Element;
+export declare function useScrollViewContext(): {
+    registerView: ({ view, id, }: {
+        view: View;
+        id: string;
+    }) => void;
+    unregisterView: (id: string) => void;
+};
+export {};

package/types/src/components/KeyboardAvoiderView.d.ts

@@ -0,0 +1,17 @@
+/// <reference types="react" />
+import { ViewProps } from 'react-native';
+import Animated from 'react-native-reanimated';
+import { CommonProps } from './common-props';
+export declare type KeyboardAvoidMode = 'whole-view' | 'focused-input';
+export default function KeyboardAvoiderView({ animationEasing, animationTime, extraSpace, enableAndroid, avoidMode, ...props }: Animated.AnimateProps<ViewProps> & CommonProps & {
+    /**
+     * Enable on android. Defaults to true to ensure consistent behavior.
+     */
+    enableAndroid?: boolean;
+    /**
+     * Sets the avoid mode. Defaults to 'whole-view'.
+     * @option 'whole-view' - view moves to show the entire view when the keyboard is shown.
+     * @option 'focused-input' - view moves to show only the focused text input.
+     */
+    avoidMode?: KeyboardAvoidMode;
+}): JSX.Element;

package/types/src/components/common-props.d.ts

@@ -0,0 +1,21 @@
+import Animated from "react-native-reanimated";
+export declare type CommonProps = {
+    /**
+     * Duration of the keyboard avoiding animation.
+     */
+    animationTime?: number;
+    /**
+     * Extra space between the keyboard avoiding element and the keyboard.
+     */
+    extraSpace?: number;
+    /**
+     * Easing function to use. Can be any `react-native-reanimated` easing function. Defaults to Easing.quad.
+     * Open animation will use Easing.out(animationEasing), close animation will use Easing.in(animationEasing).
+     */
+    animationEasing?: Animated.EasingFunction;
+};
+export declare const defaultCommonProps: {
+    animationTime: number;
+    animationEasing: Animated.EasingFunction;
+    extraSpace: number;
+};

package/types/src/defaults.d.ts

@@ -0,0 +1 @@
+export {};