@south-paw/react-obfuscate-ts - npm Package Compare versions

Comparing version 0.0.1-alpha.2 to 1.0.0

dist/Obfuscate.d.ts

@@ -41,3 +41,16 @@ import * as React from 'react';
 }
+/**
+ * A React component to obfuscate your contact links and text on your website.
+ *
+ * ```
+ * // use the component's children to create the link and display
+ * <Obfuscate email>[e-mail]</Obfuscate>
+ *
+ * // or specify the email address for the link with custom children
+ * <Obfuscate email="[e-mail]">Email me!</Obfuscate>
+ * ```
+ *
+ * @see https://github.com/South-Paw/react-obfuscate-ts
+ */
 declare const Obfuscate: React.FC<ObfuscateProps>;
 export { Obfuscate };

dist/react-obfuscate-ts.cjs.development.js

@@ -105,2 +105,15 @@ 'use strict';
 var Component = /*#__PURE__*/styled('a')( /*#__PURE__*/_templateObject());
+/**
+ * A React component to obfuscate your contact links and text on your website.
+ *
+ * ```
+ * // use the component's children to create the link and display
+ * <Obfuscate email>[e-mail]</Obfuscate>
+ *
+ * // or specify the email address for the link with custom children
+ * <Obfuscate email="[e-mail]">Email me!</Obfuscate>
+ * ```
+ *
+ * @see https://github.com/South-Paw/react-obfuscate-ts
+ */
 
@@ -107,0 +120,0 @@ var Obfuscate = function Obfuscate(_ref) {

dist/react-obfuscate-ts.esm.js

@@ -99,2 +99,15 @@ import { useState, useMemo, useCallback, createElement } from 'react';
 var Component = /*#__PURE__*/styled('a')( /*#__PURE__*/_templateObject());
+/**
+ * A React component to obfuscate your contact links and text on your website.
+ *
+ * ```
+ * // use the component's children to create the link and display
+ * <Obfuscate email>[e-mail]</Obfuscate>
+ *
+ * // or specify the email address for the link with custom children
+ * <Obfuscate email="[e-mail]">Email me!</Obfuscate>
+ * ```
+ *
+ * @see https://github.com/South-Paw/react-obfuscate-ts
+ */
 
@@ -101,0 +114,0 @@ var Obfuscate = function Obfuscate(_ref) {

package.json

 {
   "name": "@south-paw/react-obfuscate-ts",
-  "version": "0.0.1-alpha.2",
-  "description": "A React component to obfuscate your website's contact links",
+  "version": "1.0.0",
+  "description": "A React component to obfuscate contact links and text",
   "keywords": [
@@ -34,7 +34,7 @@ "react",
   "scripts": {
-    "clean": "rimraf dist",
+    "clean": "rimraf dist storybook-static",
     "start": "tsdx watch",
     "start:storybook": "start-storybook -p 9000",
     "build": "tsdx build",
-    "build:storybook": "build-storybook",
+    "build:storybook": "build-storybook --docs",
     "lint": "eslint ./src",
@@ -47,9 +47,9 @@ "test": "tsdx test --passWithNoTests",
     "@babel/core": "^7.11.4",
-    "@storybook/addon-actions": "^6.0.18",
-    "@storybook/addon-docs": "^6.0.18",
-    "@storybook/addon-knobs": "^6.0.18",
-    "@storybook/react": "^6.0.18",
+    "@storybook/addon-actions": "^6.0.19",
+    "@storybook/addon-docs": "^6.0.19",
+    "@storybook/addon-knobs": "^6.0.19",
+    "@storybook/react": "^6.0.19",
     "@testing-library/jest-dom": "^5.11.4",
     "@testing-library/react": "^10.4.9",
-    "@types/react": "^16.9.47",
+    "@types/react": "^16.9.48",
     "@types/react-dom": "^16.9.8",
@@ -56,0 +56,0 @@ "@types/styled-components": "^5.1.2",

README.md

 # @south-paw/react-obfuscate-ts
 
-🕵️ A React component to obfuscate your website's contact links
+🕵️ A React component to obfuscate contact links and text
 
@@ -5,0 +5,0 @@ [![npm](https://img.shields.io/npm/v/@south-paw/react-obfuscate-ts.svg)](https://www.npmjs.com/package/@south-paw/react-obfuscate-ts)

Fixed alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

52172

5.24%

Lines of code

450

9.49%

Number of low quality alerts

1

-50%

No dependency changes