Merge pull request clauderic#377 from clauderic/provide-ts-types

Provide TypeScript type definitions

Author: Claudéric Demers

package.json

@@ -10,6 +10,7 @@
   "homepage": "https://github.com/clauderic/react-sortable-hoc",
   "main": "dist/commonjs/index.js",
   "jsnext:main": "dist/es6/index.js",
+  "types": "types/index.d.ts",
   "license": "MIT",
   "repository": {
     "type": "git",

types/index.d.ts

@@ -0,0 +1,97 @@
+import * as React from 'react';
+
+export type Axis = 'x' | 'y' | 'xy';
+
+export type Offset = number | string;
+
+export interface SortStart {
+  node: Element;
+  index: number;
+  collection: Offset;
+}
+
+export interface SortOver {
+  index: number;
+  oldIndex: number;
+  newIndex: number;
+  collection: Offset;
+}
+
+export interface SortEnd {
+  oldIndex: number;
+  newIndex: number;
+  collection: Offset;
+}
+
+export type SortEvent = React.MouseEvent<any> | React.TouchEvent<any>;
+
+export type SortEventWithTag = SortEvent & {
+  target: {
+    tagName: string
+  }
+};
+
+export type SortStartHandler = (sort: SortStart, event: SortEvent) => void;
+
+export type SortMoveHandler = (event: SortEvent) => void;
+
+export type SortEndHandler = (sort: SortEnd, event: SortEvent) => void;
+
+export type SortOverHandler = (sort: SortOver, event: SortEvent) => void;
+
+export type ContainerGetter = (element: React.ReactElement<any>) => HTMLElement;
+
+export interface Dimensions {
+  width: number;
+  height: number;
+}
+
+export interface SortableContainerProps {
+  axis?: Axis;
+  lockAxis?: Axis;
+  helperClass?: string;
+  transitionDuration?: number;
+  pressDelay?: number;
+  pressThreshold?: number;
+  distance?: number;
+  shouldCancelStart?: (event: SortEvent | SortEventWithTag) => boolean;
+  onSortStart?: SortStartHandler;
+  onSortMove?: SortMoveHandler;
+  onSortEnd?: SortEndHandler;
+  onSortOver?: SortOverHandler;
+  useDragHandle?: boolean;
+  useWindowAsScrollContainer?: boolean;
+  hideSortableGhost?: boolean;
+  lockToContainerEdges?: boolean;
+  lockOffset?: Offset | [Offset, Offset];
+  getContainer?: ContainerGetter;
+  getHelperDimensions?: (sort: SortStart) => Dimensions;
+}
+
+export interface SortableElementProps {
+  index: number;
+  collection?: Offset;
+  disabled?: boolean;
+}
+
+export interface Config {
+  withRef: boolean;
+}
+
+export type WrappedComponentFactory<P> = (props: P) => JSX.Element;
+
+export type WrappedComponent<P> = React.ComponentClass<P> | WrappedComponentFactory<P>;
+
+export function SortableContainer<P>(wrappedComponent: WrappedComponent<P>, config?: Config): React.ComponentClass<P & SortableContainerProps>;
+
+export function SortableElement<P>(wrappedComponent: WrappedComponent<P>, config?: Config): React.ComponentClass<P & SortableElementProps>;
+
+export function SortableHandle<P>(wrappedComponent: WrappedComponent<P>, config?: Config): React.ComponentClass<P>;
+
+export const sortableContainer = SortableContainer;
+
+export const sortableElement = SortableElement;
+
+export const sortableHandle = SortableHandle;
+
+export function arrayMove<T>(collection: T[], previousIndex: number, newIndex: number): T[];