Skip to content

fix(types): export type for listenToKeyboardEvents and KeyboardAwareHOCOptions #569

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix(types): export type for listenToKeyboardEvents and KeyboardAwareHOCOptions #569

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 48 additions & 1 deletion index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@ import * as React from 'react'
import {
ScrollViewProps,
FlatListProps,
SectionListProps
SectionListProps,
ViewProps
} from 'react-native'

interface KeyboardAwareProps {
Expand Down Expand Up @@ -169,6 +170,11 @@ declare class ScrollableComponent<P, S> extends React.Component<P, S> {
) => void
}

export function listenToKeyboardEvents (options: any): (
(ScrollableComponent: React$Component, userOptions?: KeyboardAwareHOCOptions = {}) =>
typeof React.Component<KeyboardAwareHOCProps, KeyboardAwareHOCState>
);

export class KeyboardAwareMixin {}
export class KeyboardAwareScrollView extends ScrollableComponent<
KeyboardAwareScrollViewProps,
Expand All @@ -182,3 +188,44 @@ export class KeyboardAwareSectionList extends ScrollableComponent<
KeyboardAwareSectionListProps<any>,
KeyboardAwareState
> {}

export type KeyboardAwareHOCOptions = ?{
enableOnAndroid: boolean,
contentContainerStyle: ?Object,
enableAutomaticScroll: boolean,
extraHeight: number,
extraScrollHeight: number,
enableResetScrollToCoords: boolean,
keyboardOpeningTime: number,
viewIsInsideTabBar: boolean,
refPropName: string,
extractNativeRef: Function
}

export type KeyboardAwareHOCProps = ScrollViewProps & {
viewIsInsideTabBar?: boolean,
resetScrollToCoords?: {
x: number,
y: number
},
enableResetScrollToCoords?: boolean,
enableAutomaticScroll?: boolean,
extraHeight?: number,
extraScrollHeight?: number,
keyboardOpeningTime?: number,
onScroll?: Function,
update?: Function,
contentContainerStyle?: any,
enableOnAndroid?: boolean,
innerRef?: Function,
onKeyboardWillShow?: Function,
onKeyboardDidShow?: Function,
onKeyboardWillHide?: Function,
onKeyboardDidHide?: Function,
onKeyboardWillChangeFrame?: Function,
onKeyboardDidChangeFrame?: Function,
}

export type KeyboardAwareHOCState = {
keyboardSpace: number
}