react-optimistic-toggle - npm Package Compare versions

Comparing version 0.2.0 to 0.5.0

package.json

 {
   "name": "react-optimistic-toggle",
-  "version": "0.2.0",
-  "description": "React component to optimistically handle async toggles",
+  "version": "0.5.0",
+  "description": "React component to build Optimistic UIs.",
   "main": "lib/OptimisticToggle.js",
@@ -15,3 +15,3 @@ "repository": "https://github.com/interviewstreet/react-optimistic-toggle.git",
     "docs": "styleguidist server",
-    "docs:dev": "nodemon -x 'npm run docs' --ignore src/",
+    "docs:dev": "nodemon -x 'npm run docs' --ignore src/ --ignore lib/",
     "docs:build": "styleguidist build"
@@ -18,0 +18,0 @@ },

README.md

@@ -1,2 +0,9 @@
-# react-optimistic-toggle
-React component to optimistically handle async toggles.
+# React Optimistic Toggle
+React component to build Optimistic UIs.
+
+If you see the 'FB or Twitter Like Button' or 'Add To Favorite' button in many websites you'll notice that when you click on the button it instantly shows that you have liked it. It then sends a request, if the request succeeds then the post stays liked otherwise it reverts back to unliked state. This is called Optimistic UI update.
+
+`react-optimistic-toggle` helps you build these kind of UI effortlessly.
+
+* [Docs](https://react-optimistic-toggle.netlify.com/)
+* [npm](https://www.npmjs.com/package/react-optimistic-toggle)

styleguide.config.js

@@ -8,4 +8,13 @@ const path = require('path');
   version: pkg.version,
-  components: 'src/**/*.js',
   usageMode: 'expand',
+  sections: [
+    {
+      name: 'Getting Started',
+      content: 'src/getting-started.docs.md',
+    },
+    {
+      name: 'Examples',
+      components: 'src/**/*.js',
+    },
+  ],
   ribbon: {
@@ -12,0 +21,0 @@ url: 'https://www.npmjs.com/package/react-optimistic-toggle',

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

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

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

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Improved metrics

Number of lines in readme file

10

increased by233.33%

Number of medium supply chain risk alerts

1

decreased by-50%

Worsened metrics

Total package byte prevSize

5519

decreased by-99.47%

Number of package files

6

decreased by-33.33%

Lines of code

47

decreased by-97.76%

No dependency changes