vue-swatches - npm Package Compare versions

Comparing version 1.0.0-rc.1 to 1.0.0-rc.2

package.json

 {
   "name": "vue-swatches",
-  "version": "1.0.0-rc.1",
+  "version": "1.0.0-rc.2",
   "description": "Vue component to pick beautiful colors",
@@ -17,3 +17,3 @@ "author": "Diego Jara <[e-mail]>",
   },
-  "homepage": "https://vue-swatches.netlify.com",
+  "homepage": "https://saintplay.github.io/vue-swatches",
   "main": "dist/vue-swatches.min.js",
@@ -33,3 +33,3 @@ "unpkg": "dist/vue-swatches.min.js",
     "type": "git",
-    "url": "git+https://github.com/shentao/vue-swatches.git"
+    "url": "git+https://github.com/saintplay/vue-swatches.git"
   },
@@ -40,3 +40,3 @@ "scripts": {
     "bundle": "node build/bundle.js",
-    "docs": "rm -rf docs && mkdir docs && node build/build.js",
+    "docs": "node build/build-docs.js",
     "unit": "jest --config test/unit/jest.conf.js --coverage",
@@ -63,2 +63,3 @@ "test": "npm run unit",
     "copy-webpack-plugin": "^4.0.1",
+    "coveralls": "^3.0.0",
     "css-loader": "^0.28.0",
@@ -78,2 +79,3 @@ "eslint": "^3.19.0",
     "html-webpack-plugin": "^2.30.1",
+    "is-hex-color": "0.0.1",
     "jest": "^21.2.0",
@@ -90,3 +92,3 @@ "jest-serializer-vue": "^0.3.0",
     "postcss-import": "^11.0.0",
-    "postcss-loader": "^2.0.8",
+    "postcss-loader": "^2.0.9",
     "prismjs": "^1.9.0",
@@ -93,0 +95,0 @@ "pug": "^2.0.0-rc.4",

README.md

 <h1 align="center">
   <br>
-  <a href="http://www.amitmerchant.com/electron-markdownify">
+  <a href="https://saintplay.github.io/vue-swatches/">
     <img src="https://github.com/saintplay/vue-swatches/blob/master/.github/promo.png?raw=true" alt="Vue Swatches">
@@ -9,23 +9,87 @@ </a>
 <p align="center">
-  <a href="https://github.com/facebook/jest">
-    <img src="https://img.shields.io/badge/tested_with-jest-99424f.svg" alt="Jest">
+  <a href="https://travis-ci.org/saintplay/vue-swatches">
+    <img src="https://travis-ci.org/saintplay/vue-swatches.svg?branch=master" alt="Travis CI">
   </a>
+  <a href="https://coveralls.io/github/saintplay/vue-swatches?branch=master">
+    <img src="https://coveralls.io/repos/github/saintplay/vue-swatches/badge.svg?branch=master" alt="Coveralls">
+  </a>
   <a href="https://www.npmjs.org/package/vue-swatches">
+    <img src="https://img.shields.io/npm/v/vue-swatches.svg" alt="npm version">
+  </a>
+  <a href="https://www.npmjs.org/package/vue-swatches">
     <img src="https://img.shields.io/github/license/saintplay/vue-swatches.svg" alt="license">
   </a>
+  <a href="https://github.com/facebook/jest">
+    <img src="https://img.shields.io/badge/tested_with-jest-99424f.svg" alt="Jest">
+  </a>
 </p>
 
-<p align="center">
-  <a href="#key-features">Key Features</a> •
-  <a href="#how-to-use">Install</a> •
-  <a href="#download">Basic Usage</a> •
-  <a href="#credits">Props</a> •
-  <a href="#credits">Events</a> •
-  <a href="#related">Slots</a> •
-  <a href="#license">Contributing</a>
-  <a href="#license">License</a>
-</p>
+## Demo And Documentation ##
 
+<https://saintplay.github.io/vue-swatches/>
 
 
+## Table of Contents ##
+
+- [Introduction](#introduction)
+- [Features](#features)
+- [Install](#install)
+- [Basic Usage](#basic-usage)
+- [Contributing](#contributing)
+- [Browser Compatibility](#browser-compatibility)
+- [License](#license)
+
+## Introduction ##
+
+Vue Swatches is a UI Component for Vue that allows the user to choose colors.
+
+Unlike classic color pickers, where all colors are available (167 77 216 colors),
+Vue Swatches only shows a bunch of predefined colors.
+
+> More decisions require more effort
+
+With fewer options, the user experience will be improved
+
+## Features ##
+
+- Presets ready to use
+- Popover Mode
+- Inline Mode
+- Custom Colors
+- Nested Colors Array
+- Easily Customizable
+- Custom Trigger
+
+## Install ##
+
+`npm install --save vue-swatches`
+
+or
+
+`yarn add vue-swatches`
+
+## Basic Usage ##
+
+```html
+<!-- Vue component -->
+<template>
+  <div>
+    <swatches v-model="color" />
+  </div>
+</template>
+
+<script>
+  import Swatches from 'vue-swatches'
+
+  export default {
+    components: { Swatches },
+    data () {
+      return {
+        color: '#1CA085'
+      }
+    }
+  }
+</script>
+```
+
 ## Contributing ##
@@ -46,9 +110,16 @@
 
-# run unit tests watch
-npm run unit-watch
-
 ```
 
+## Browser Compatibility ##
+
+This component has the same support than Vue itself
+
+> Vue does not support IE8 and below, because it uses ECMAScript 5 features that are un-shimmable in IE8. However it supports all [ECMAScript 5 compliant browsers](https://caniuse.com/#feat=es5).
+
+However if you want to use this with IE9, you will probably need to work on the CSS styles.
+IE10 should be fine
+
+
 ## License
 
 MIT

src/presets/index.js

@@ -1,5 +0,5 @@
-import simple from './simple'
-import textSimple from './text-simple'
+import basic from './basic'
+import textBasic from './text-basic'
 import textAdvanced from './text-advanced'
-import materialSimple from './material-simple'
+import materialBasic from './material-basic'
 import materialLight from './material-light'
@@ -9,8 +9,18 @@ import materialDark from './material-dark'
 export default {
-  'simple': simple,
-  'text-simple': textSimple,
+  'basic': basic,
+  'text-basic': textBasic,
   'text-advanced': textAdvanced,
-  'material-simple': materialSimple,
+  'material-basic': materialBasic,
   'material-light': materialLight,
   'material-dark': materialDark
 }
+
+export const supportedProperties = [
+  'swatches', // Required
+  'borderRadius', // Optional String: '50px', '0', '40%'
+  'rowLength', // Optional Integer: 5, 8, 6
+  'swatchSize', // Optional Positive Number: 12.5, 36, 10
+  'spacingSize', // Optional Positive Number: 20, 28.2, 40
+  'maxHeight', // Optional Positive Number: 220, 500.40, 300
+  'showBorder' // Optional Boolean: true, false
+]

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

No website

Quality

Package does not have a website.

Found 1 instance in 1 package

Improved metrics

Number of low quality alerts

1

decreased by-50%

Number of lines in readme file

124

increased by133.96%

Worsened metrics

Total package byte prevSize

61963

decreased by-92.39%

Dev dependency count

64

increased by3.23%

Number of package files

17

decreased by-10.53%

Lines of code

162

decreased by-3.57%

No dependency changes