Merge pull request #346 from sparkled/add-react-typings

Add TypeScript definitions for React

packages/simplebar-react/package.json

@@ -13,6 +13,7 @@
   },
   "main": "dist/simplebar-react.js",
   "module": "dist/simplebar-react.esm.js",
+  "types": "dist/simplebar-react.d.ts",
   "bugs": "https://github.com/grsmto/simplebar/issues",
   "homepage": "https://grsmto.github.io/simplebar/",
   "license": "MIT",
@@ -31,7 +32,8 @@
     "react-dom": "^0.14.9 || ^15.3.0 || ^16.0.0-rc || ^16.0"
   },
   "devDependencies": {
-    "react-test-renderer": "^16.3.2"
+    "react-test-renderer": "^16.3.2",
+    "rollup-plugin-copy": "^3.0.0"
   },
   "jest": {
     "transform": {

packages/simplebar-react/rollup.config.js

@@ -1,6 +1,7 @@
 import resolve from 'rollup-plugin-node-resolve';
 import commonjs from 'rollup-plugin-commonjs';
 import babel from 'rollup-plugin-babel';
+import copy from 'rollup-plugin-copy';
 import license from 'rollup-plugin-license';
 import { terser } from 'rollup-plugin-terser';
 import pkg from './package.json';
@@ -17,7 +18,7 @@ const banner = {
 };
 const globals = {
   'prop-types': 'PropTypes',
-  'react': 'React'
+  react: 'React'
 };
 const external = [...Object.keys(pkg.dependencies), 'react'];
 
@@ -37,6 +38,9 @@ export default [
       }),
       resolve(), // so Rollup can find dependencies
       commonjs(), // so Rollup can convert dependencies to an ES module
+      copy({
+        targets: [{ src: 'simplebar-react.d.ts', dest: 'dist' }]
+      }),
       terser(),
       license(banner)
     ]

packages/simplebar-react/simplebar-react.d.ts

@@ -0,0 +1,10 @@
+import React from 'react';
+
+declare module 'simplebar-react' {
+  interface Props extends React.HTMLAttributes<HTMLElement> {
+    scrollableNodeProps?: object;
+    options?: object;
+  }
+
+  export default class SimpleBar extends React.Component<Props> {}
+}