react-checkbox-tree - npm Package Compare versions

Comparing version 0.0.4 to 0.0.5

gulpfile.js

@@ -12,3 +12,3 @@ var gulp     = require('gulp');
 
-gulp.task('script-test-format', function () {
+gulp.task('test-script-format', function () {
 	return gulp.src(['./src/js/**/*.js'])
@@ -20,3 +20,3 @@ .pipe(eslint())
 
-gulp.task('script-compile-test', function () {
+gulp.task('compile-test-script', function () {
 	return gulp.src(['./test/index.js'])
@@ -28,3 +28,3 @@ .pipe(webpack(require('./webpack.config.js')))
 // Disabled for now
-gulp.task('script-test-mocha', ['script-compile-test'], function () {
+gulp.task('test-mocha', ['script-compile-test'], function () {
 	return gulp.src(['test/test.html'])
@@ -34,5 +34,5 @@ .pipe(mocha({ reporter: 'spec' }));
 
-gulp.task('script-test', ['script-test-format', 'script-compile-test']);
+gulp.task('test-script', ['test-script-format']);
 
-gulp.task('script-build', ['script-test'], function () {
+gulp.task('build-script', ['test-script'], function () {
 	return gulp.src(['./src/index.js'])
@@ -46,3 +46,3 @@ .pipe(webpack(require('./webpack.config.js')))
 
-gulp.task('style-build', function () {
+gulp.task('build-style', function () {
 	return gulp.src('./src/sass/**/*.scss')
@@ -57,7 +57,13 @@ .pipe(scsslint())
 
+gulp.task('build-examples', ['build-script', 'build-style'], function () {
+	return gulp.src(['./examples/index.js'])
+		.pipe(webpack(require('./webpack.config.js')))
+		.pipe(gulp.dest('./examples/compiled/'));
+});
+
 gulp.task('watch', function () {
-	gulp.watch(['./src/js/**/*.js'], ['script-build']);
-	gulp.watch(['./src/sass/**/*.scss'], ['style-build']);
+	gulp.watch(['./src/js/**/*.js'], ['build-script']);
+	gulp.watch(['./src/sass/**/*.scss'], ['build-style']);
 });
 
-gulp.task('default', ['script-build', 'style-build']);
+gulp.task('default', ['build-script', 'build-style']);

package.json

 {
   "name": "react-checkbox-tree",
-  "version": "0.0.4",
+  "version": "0.0.5",
   "description": "React component for checkbox trees.",
@@ -13,2 +13,5 @@ "author": "Jake Zatecky",
   "main": "lib/index.js",
+  "scripts": {
+    "examples": "gulp build-examples && http-server"
+  },
   "devDependencies": {
@@ -31,2 +34,3 @@ "babel-core": "^6.4.5",
     "gulp-scss-lint": "^0.3.9",
+    "http-server": "^0.8.5",
     "mocha": "^2.4.5",
@@ -33,0 +37,0 @@ "react-dom": "^0.14.7",

README.md

 # react-checkbox-tree
 
+[![npm](https://img.shields.io/npm/v/react-checkbox-tree.svg?style=flat-square)](https://www.npmjs.com/package/react-checkbox-tree)
+[![Dependency Status](https://img.shields.io/david/jakezatecky/react-checkbox-tree.svg?style=flat-square)](https://david-dm.org/jakezatecky/react-checkbox-tree)
+[![devDependency Status](https://david-dm.org/jakezatecky/react-checkbox-tree/dev-status.svg?style=flat-square)](https://david-dm.org/jakezatecky/react-checkbox-tree#info=devDependencies)
+[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](https://raw.githubusercontent.com/jakezatecky/react-checkbox-tree/master/LICENSE.txt)
+
 Checkbox treeview for React.
 
-WORK IN PROGRESS.
+# Usage
+
+Install the library:
+
+``` shell
+npm install react-checkbox-tree --save
+```
+
+Then render the component:
+
+``` javascript
+import CheckboxTree from 'react-checkbox-tree';
+
+...
+
+render() {
+    const nodes = [{
+        value: 'node-1',
+        title: 'Parent Node 1',
+        children: [{
+            value: 'node-1-1',
+            title: 'Leaf Node 1-1',
+        }, {
+            value: 'node-1-2',
+            title: 'Leaf Node 1-2'
+        }],
+    }];
+
+    return <CheckboxTree node={nodes} />;
+}
+```

src/index.js

@@ -0,0 +0,0 @@ // Use CommonJS export to trick Webpack into working around the issues that

src/js/Tree.js

@@ -0,0 +0,0 @@ import React from 'react';

src/js/TreeNode.js

@@ -0,0 +0,0 @@ import React from 'react';

webpack.config.js

@@ -0,0 +0,0 @@ /* eslint-disable */

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

707079

increased by0.27%

Number of package files

15

increased by7.14%

Lines of code

17937

increased by0.04%

Number of lines in readme file

41

increased by583.33%

Worsened metrics

Dev dependency count

21

increased by5%

No dependency changes