Merge pull request #27 from Mindsers/develop

v1.3.0

Author: mindsers

README.md

@@ -16,13 +16,14 @@ Check the [demo](https://mindsers.github.io/nativetable/) page.
 
 ### Package manager installation
 
-Nativetable is available as a client side npm dependency. To install Nativetable with npm :
+Nativetable is available as a client side npm dependency. To install Nativetable with npm or yarn:
 
-```bash
+```sh
 npm install nativetable --save
+yarn add nativetable
 ```
 
-Nativetable library is ready to be import on your project : `./node_modules/nativetable/dist/nativetable.min.js`
+Nativetable library is ready. Build file is available at this path: `./node_modules/nativetable/dist/nativetable.min.js`
 
 ### Manual installation
 You can build your own Nativetable with this project.
@@ -39,15 +40,40 @@ npm install
 npm run build
 ```
 
-Nativetable library is ready to be import on your project : `./dist/nativetable.min.js`
+Nativetable library is ready to be import on your project: `./dist/nativetable.min.js`
 
 ## Usage
 
+- If your are using tools for importing / bundling dependencies (umd format) for you, you can import Nativetable this way:
+
+```js
+const Nativetable = require('nativetable').Nativetable // classic
+
+const { Nativetable } = require('nativetable') // es6 destructuring
+
+import { Nativetable } from 'nativetable' // es6 import
+
+// ...
+
+const nt = new Nativetable('tableid')
+```
+
+- If you decide to import Nativetable with simple `<script/>` tag, all Nativetable classes is available in `nativetable` umd module. 
+
 Add a script tag on your page to call Nativatable.
 ```html
 <script src="nativetable.min.js"></script>
 ```
 
+And in `*.js|ts` file:
+```js
+const Nativetable = nativetable.Nativetable // get Nativetable class from nativetable module
+
+// ...
+
+const nt = new Nativetable('tableid')
+```
+
 ### Sample code
 
 ```js

package.json

@@ -1,14 +1,16 @@
 {
   "name": "nativetable",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "description": "Create and use dynamics HTML tables with native JS",
   "repository": "https://github.com/Mindsers/nativetable",
   "main": "dist/nativetable.min.js",
+  "types": "dist/nativetable.d.ts",
   "scripts": {
     "build:js": "rollup -c",
     "build:clean": "rm -rf dist",
+    "build:types": "cp src/nativetable/nativetable.d.ts dist/nativetable.d.ts",
     "build:dev": "NODE_ENV=development npm run build:clean && npm run build:js -- --sourcemap -w",
-    "build:prod": "NODE_ENV=production npm run build:clean && npm run build:js",
+    "build:prod": "NODE_ENV=production npm run build:clean && npm run build:js && npm run build:types",
     "build": "npm run build:prod",
     "test:coveralls": "npm run test:coverage && nyc report --reporter=text-lcov | coveralls",
     "test:coverage": "NODE_ENV=test nyc mocha",
@@ -21,8 +23,8 @@
     "table",
     "filter"
   ],
-  "author": "",
-  "license": "ISC",
+  "author": "Nathanael CHERRIER <https://github.com/Mindsers>",
+  "license": "MIT",
   "devDependencies": {
     "babel-plugin-istanbul": "^2.0.3",
     "babel-preset-es2015": "^6.16.0",

rollup.config.js

@@ -25,8 +25,8 @@ export default {
   targets: [
     {
       dest: pkg.main,
-      moduleName: 'Nativetable',
-      format: 'iife'
+      moduleName: 'nativetable',
+      format: 'umd'
     }
   ]
 }

src/demo/scripts/demo.js

@@ -1,4 +1,7 @@
-/* global Nativetable */
+/// <reference path="../../nativetable/nativetable.d.ts"/>
+/* global nativetable */
+
+const Nativetable = nativetable.Nativetable
 
 'use strict'
 

src/nativetable/nativetable.d.ts

@@ -0,0 +1,32 @@
+// Type definitions for Nativetable v1.2.0
+// Project: https://github.com/Mindsers/nativetable
+// Definitions by: Nathanael CHERRIER <https://github.com/Mindsers>
+
+declare module 'nativetable' {
+    export class Nativetable {
+        constructor(id: string, options?: {
+            sources?: any[],
+            filters?: {
+                $and?: any,
+                $or?: any
+            },
+            columns?: string[],
+            pagination?: {
+                maxLength?: number
+            },
+            sorting?: boolean
+        });
+
+        sources: any[];
+        filtered: any[];
+        paginated: any[];
+        sorted: any[];
+
+        columns: string[];
+        pagination: { currentPage: number, maxLength: number};
+        filters: { $and?: any, $or?: any };
+
+        reload(row: any[]): void;
+        draw(): void;
+    }
+}

src/nativetable/nativetable.js

@@ -1,4 +1,4 @@
-export default class Nativetable {
+export class Nativetable {
 
   /**
    * Data sources

test/nativetable.js

@@ -2,7 +2,7 @@
 
 import chai from 'chai'
 import spies from 'chai-spies'
-import Nativetable from '../src/nativetable/nativetable'
+import { Nativetable } from '../src/nativetable/nativetable'
 
 describe('Nativetable', () => {
   let nt