@newhippo/react-joyride - npm Package Compare versions

Comparing version 2.3.1 to 2.3.2

package.json

 {
   "name": "@newhippo/react-joyride",
-  "version": "2.3.1",
+  "version": "2.3.2",
   "description": "Create guided tours for your apps",
@@ -13,3 +13,3 @@ "author": "Gil Barbara <[e-mail]>",
   },
-  "homepage": "https://react-joyride.com/",
+  "homepage": "https://gilbarbara.github.com/react-joyride/",
   "keywords": [
@@ -29,2 +29,3 @@ "react",
     "lib",
+    "src",
     "types/*.ts"
@@ -40,9 +41,9 @@ ],
     "deep-diff": "^1.0.2",
-    "deepmerge": "^4.0.0",
+    "deepmerge": "^3.0.0",
     "exenv": "^1.2.2",
-    "is-lite": "^0.4.1",
-    "nested-property": "^1.0.1",
-    "react-floater": "^0.6.5",
-    "react-is": "^16.8.6",
-    "scroll": "^3.0.1",
+    "is-lite": "^0.2.2",
+    "nested-property": "^0.0.7",
+    "react-floater": "^0.6.2",
+    "react-is": "^16.7.0",
+    "scroll": "^2.0.3",
     "scroll-doc": "^0.2.1",
@@ -53,68 +54,63 @@ "scrollparent": "^2.0.1",
   "devDependencies": {
-    "@babel/core": "^7.5.4",
-    "@babel/plugin-proposal-class-properties": "^7.5.0",
-    "@babel/plugin-proposal-decorators": "^7.4.4",
-    "@babel/plugin-proposal-do-expressions": "^7.5.0",
-    "@babel/plugin-proposal-export-default-from": "^7.5.2",
-    "@babel/plugin-proposal-export-namespace-from": "^7.5.2",
-    "@babel/plugin-proposal-function-sent": "^7.5.0",
+    "@babel/core": "^7.2.2",
+    "@babel/plugin-proposal-class-properties": "^7.2.3",
+    "@babel/plugin-proposal-decorators": "^7.2.3",
+    "@babel/plugin-proposal-do-expressions": "^7.2.0",
+    "@babel/plugin-proposal-export-default-from": "^7.2.0",
+    "@babel/plugin-proposal-export-namespace-from": "^7.2.0",
+    "@babel/plugin-proposal-function-sent": "^7.2.0",
     "@babel/plugin-proposal-json-strings": "^7.2.0",
     "@babel/plugin-proposal-logical-assignment-operators": "^7.2.0",
-    "@babel/plugin-proposal-nullish-coalescing-operator": "^7.4.4",
+    "@babel/plugin-proposal-nullish-coalescing-operator": "^7.2.0",
     "@babel/plugin-proposal-numeric-separator": "^7.2.0",
     "@babel/plugin-proposal-optional-chaining": "^7.2.0",
-    "@babel/plugin-proposal-pipeline-operator": "^7.5.0",
+    "@babel/plugin-proposal-pipeline-operator": "^7.2.0",
     "@babel/plugin-proposal-throw-expressions": "^7.2.0",
     "@babel/plugin-syntax-dynamic-import": "^7.2.0",
     "@babel/plugin-syntax-import-meta": "^7.2.0",
-    "@babel/plugin-transform-flow-strip-types": "^7.4.4",
-    "@babel/plugin-transform-runtime": "^7.5.0",
-    "@babel/preset-env": "^7.5.4",
+    "@babel/plugin-transform-flow-strip-types": "^7.2.3",
+    "@babel/plugin-transform-runtime": "^7.2.0",
+    "@babel/preset-env": "^7.2.3",
     "@babel/preset-flow": "^7.0.0",
     "@babel/preset-react": "^7.0.0",
-    "@types/react": "^16.8.23",
+    "@types/react": "^16.7.18",
     "babel-core": "^7.0.0-bridge.0",
-    "babel-eslint": "^10.0.2",
-    "babel-jest": "^24.8.0",
+    "babel-eslint": "^10.0.1",
+    "babel-jest": "^23.6.0",
     "babel-plugin-array-includes": "^2.0.3",
-    "babel-plugin-jsx-remove-data-test-id": "^2.0.0",
+    "babel-plugin-jsx-remove-data-test-id": "^1.2.1",
     "babel-plugin-transform-node-env-inline": "^0.4.3",
-    "babel-plugin-transform-react-remove-prop-types": "^0.4.24",
-    "bundlesize": "^0.18.0",
-    "chalk": "^2.4.2",
+    "babel-plugin-transform-react-remove-prop-types": "^0.4.21",
+    "bundlesize": "^0.17.0",
+    "chalk": "^2.4.1",
     "cross-env": "^5.2.0",
     "date-fns": "^1.30.1",
-    "dtslint": "^0.8.0",
-    "enzyme": "^3.10.0",
-    "enzyme-adapter-react-16": "^1.14.0",
-    "eslint": "^5.16.0",
-    "eslint-config-airbnb": "^17.1.1",
-    "eslint-config-prettier": "^5.1.0",
+    "dtslint": "^0.4.2",
+    "enzyme": "^3.8.0",
+    "enzyme-adapter-react-16": "^1.7.1",
+    "eslint": "^5.12.0",
+    "eslint-config-airbnb": "^17.1.0",
     "eslint-plugin-babel": "^5.3.0",
-    "eslint-plugin-flowtype": "^3.11.1",
-    "eslint-plugin-import": "^2.18.0",
-    "eslint-plugin-jsx-a11y": "^6.2.3",
-    "eslint-plugin-prettier": "^3.1.0",
-    "eslint-plugin-react": "^7.14.2",
-    "flow-bin": "^0.102.0",
-    "husky": "^3.0.0",
-    "is-ci-cli": "^1.1.1",
-    "jest": "^24.8.0",
-    "jest-chain": "^1.1.2",
-    "jest-environment-jsdom-global": "^1.2.0",
-    "jest-enzyme": "^7.0.2",
-    "jest-extended": "^0.11.2",
-    "jest-watch-typeahead": "^0.3.1",
-    "lint-staged": "^9.2.0",
-    "prettier": "^1.18.2",
+    "eslint-plugin-flowtype": "^3.2.0",
+    "eslint-plugin-import": "^2.14.0",
+    "eslint-plugin-jsx-a11y": "^6.1.2",
+    "eslint-plugin-react": "^7.12.3",
+    "flow-bin": "^0.89.0",
+    "husky": "^1.3.1",
+    "jest": "^23.6.0",
+    "jest-chain": "^1.0.5",
+    "jest-environment-jsdom-global": "^1.1.0",
+    "jest-enzyme": "^7.0.1",
+    "jest-extended": "^0.11.0",
+    "jest-watch-typeahead": "^0.2.0",
     "prop-types": "^15.6.2",
-    "react": "^16.8.6",
-    "react-dom": "^16.8.6",
+    "react": "^16.7.0",
+    "react-dom": "^16.7.0",
     "rimraf": "^2.6.3",
-    "rollup": "^1.17.0",
-    "rollup-plugin-babel": "^4.3.3",
-    "rollup-plugin-commonjs": "^10.0.1",
-    "rollup-plugin-node-resolve": "^5.2.0",
-    "typescript": "^3.5.3",
-    "yargs": "^13.2.4"
+    "rollup": "^0.68.2",
+    "rollup-plugin-babel": "^4.2.0",
+    "rollup-plugin-commonjs": "^9.2.0",
+    "rollup-plugin-node-resolve": "^4.0.0",
+    "typescript": "^3.2.2",
+    "yargs": "^12.0.5"
   },
@@ -126,8 +122,6 @@ "scripts": {
     "lint": "eslint --ext .js --ext .jsx src test",
-    "test": "is-ci \"test:coverage\" \"test:watch\"",
-    "test:coverage": "jest --bail --coverage",
+    "test": "jest --coverage",
     "test:watch": "jest --watch --verbose",
-    "format": "prettier \"**/*.{js,jsx,ts,tsx}\" --write",
-    "validate": "npm run lint && npm run test:coverage && flow && npm run build && npm run bundlesize",
-    "bundlesize": "bundlesize"
+    "bundlesize": "bundlesize",
+    "validate": "npm run lint && npm test && flow && npm run build && npm run bundlesize"
   },
@@ -147,16 +141,5 @@ "bundlesize": [
       "post-merge": "node tools update",
-      "pre-commit": "node tools upstream && lint-staged && flow"
+      "pre-commit": "node tools upstream && npm run validate"
     }
-  },
-  "lint-staged": {
-    "*.js?(x)": [
-      "eslint --fix",
-      "git add",
-      "jest --findRelatedTests"
-    ],
-    "*.(js|jsx|json|yml|yaml|css|less|scss|ts|tsx|md|graphql|mdx)": [
-      "prettier --write",
-      "git add"
-    ]
   }
 }

README.md

@@ -9,3 +9,3 @@ # React Joyride
 
-Showcase your app to new users or explain functionality of new features.
+Showcase your app to new users or explain functionality of new features.  
 
@@ -19,4 +19,2 @@ It uses [react-floater](https://github.com/gilbarbara/react-floater) for positioning and styling.
 
-Chat about it in our [Spectrum community](https://spectrum.chat/react-joyride)
-
 ## Setup
@@ -63,23 +61,1 @@
 ```
-
-## Development
-
-Setting up a local development environment is easy!
-
-Clone (or fork) this repo on your machine, navigate to its location in the terminal and run:
-
-```bash
-npm install
-npm link # link your local repo to your global packages
-npm run watch # build the files and watch for changes
-```
-
-Now clone https://github.com/gilbarbara/react-joyride-demo and run:
-
-```bash
-npm install
-npm link react-joyride # just link your local copy into this project's node_modules
-npm start
-```
-
-**Start coding!** 🎉

types/index.d.ts

 import * as React from 'react';
 
-export type valueof<T> = T[keyof T];
+export type placement = 'top' | 'top-start' | 'top-end' |
+  'bottom' | 'bottom-start' | 'bottom-end' |
+  'left' | 'left-start' | 'left-end' |
+  'right' | 'right-start' | 'right-end' |
+  'auto' | 'center';
 
-export type Placement =
-  | 'top'
-  | 'top-start'
-  | 'top-end'
-  | 'bottom'
-  | 'bottom-start'
-  | 'bottom-end'
-  | 'left'
-  | 'left-start'
-  | 'left-end'
-  | 'right'
-  | 'right-start'
-  | 'right-end'
-  | 'auto'
-  | 'center';
+export type placementBeacon = 'top' | 'bottom' | 'left' | 'right';
 
-export type PlacementBeacon = 'top' | 'bottom' | 'left' | 'right';
-
 export interface StoreState {
@@ -34,8 +22,7 @@ action: string;
   close: () => void;
-  go: (nextIndex: number) => void;
+  go: () => void;
   info: () => StoreState;
   next: () => void;
-  open: () => void;
   prev: () => void;
-  reset: (restart: boolean) => void;
+  reset: () => void;
   skip: () => void;
@@ -49,3 +36,2 @@ }
   next?: React.ReactNode;
-  open?: React.ReactNode;
   skip?: React.ReactNode;
@@ -60,3 +46,3 @@ }
   size: number;
-  status: valueof<status>;
+  status: string;
   step: Step;
@@ -66,47 +52,6 @@ type: string;
 
-export interface GenericObject {
-  [key: string]: any;
-}
-
-export interface FloaterProps {
-  disableAnimation?: boolean;
-  options?: GenericObject;
-  styles?: GenericObject;
-  wrapperOptions?: GenericObject;
-}
-
-export interface Styles {
-  beacon?: React.CSSProperties;
-  beaconInner?: React.CSSProperties;
-  beaconOuter?: React.CSSProperties;
-  buttonBack?: React.CSSProperties;
-  buttonClose?: React.CSSProperties;
-  buttonNext?: React.CSSProperties;
-  buttonSkip?: React.CSSProperties;
-  options?: {
-    arrowColor?: string;
-    backgroundColor?: string;
-    beaconSize?: number;
-    overlayColor?: string;
-    primaryColor?: string;
-    spotlightShadow?: string;
-    textColor?: string;
-    width?: string | number;
-    zIndex?: number;
-  };
-  overlay?: React.CSSProperties;
-  overlayLegacy?: React.CSSProperties;
-  overlayLegacyCenter?: React.CSSProperties;
-  spotlight?: React.CSSProperties;
-  spotlightLegacy?: React.CSSProperties;
-  tooltip?: React.CSSProperties;
-  tooltipContainer?: React.CSSProperties;
-  tooltipContent?: React.CSSProperties;
-  tooltipFooter?: React.CSSProperties;
-  tooltipFooterSpacer?: React.CSSProperties;
-  tooltipTitle?: React.CSSProperties;
-}
-
-export interface CommonProps {
-  beaconComponent?: React.ElementType<BeaconRenderProps>;
+export interface Step {
+  beaconComponent?: (renderProps: BeaconRenderProps) => React.ReactNode;
+  content: React.ReactNode;
+  disableBeacon?: boolean;
   disableCloseOnEsc?: boolean;
@@ -117,5 +62,12 @@ disableOverlay?: boolean;
   disableScrollParentFix?: boolean;
-  floaterProps?: FloaterProps;
+  event?: string;
+  floaterProps?: object;
   hideBackButton?: boolean;
+  hideCloseButton?: boolean;
+  hideFooter?: boolean;
+  isFixed?: boolean;
   locale?: Locale;
+  offset?: number;
+  placement?: placement;
+  placementBeacon?: placementBeacon;
   showProgress?: boolean;
@@ -125,4 +77,6 @@ showSkipButton?: boolean;
   spotlightPadding?: number;
-  styles?: Styles;
-  tooltipComponent?: React.ElementType<TooltipRenderProps>;
+  styles?: object;
+  target: string | HTMLElement;
+  title?: React.ReactNode;
+  tooltipComponent?: (renderProps: TooltipRenderProps) => React.ReactNode;
 }
@@ -141,64 +95,56 @@
   backProps: {
-    'aria-label': string;
-    'data-action': string;
-    onClick: () => void;
-    role: string;
-    title: string;
+    'aria-label': string,
+    onClick: () => void,
+    role: string,
+    title: React.ReactNode
   };
   closeProps: {
-    'aria-label': string;
-    'data-action': string;
-    onClick: () => void;
-    role: string;
-    title: string;
+    'aria-label': string,
+    onClick: () => void,
+    role: string,
+    title: React.ReactNode
   };
   primaryProps: {
-    'aria-label': string;
-    'data-action': string;
-    onClick: () => void;
-    role: string;
-    title: string;
+    'aria-label': string,
+    onClick: () => void,
+    role: string,
+    title: React.ReactNode
   };
   skipProps: {
-    'aria-label': string;
-    'data-action': string;
-    onClick: () => void;
-    role: string;
-    title: string;
+    'aria-label': string,
+    onClick: () => void,
+    role: string,
+    title: React.ReactNode
   };
-  tooltipProps: {
-    'aria-modal': boolean;
-    ref: () => void;
-    role: string;
-  };
 }
 
-export interface Step extends CommonProps {
-  content: React.ReactNode;
-  disableBeacon?: boolean;
-  event?: string;
-  floaterProps?: FloaterProps;
-  hideCloseButton?: boolean;
-  hideFooter?: boolean;
-  isFixed?: boolean;
-  offset?: number;
-  placement?: Placement;
-  placementBeacon?: PlacementBeacon;
-  target: string | HTMLElement;
-  title?: React.ReactNode;
-}
-
-export interface Props extends CommonProps {
+export interface Props {
+  beaconComponent?: (renderProps: BeaconRenderProps) => React.ReactNode;
   callback?: (data: CallBackProps) => void;
   continuous?: boolean;
   debug?: boolean;
-  getHelpers?: (helpers: StoreHelpers) => any;
+  disableCloseOnEsc?: boolean;
+  disableOverlay?: boolean;
+  disableOverlayClose?: boolean;
+  disableScrolling?: boolean;
+  disableScrollParentFix?: boolean;
+  floaterProps?: object;
+  getHelpers?: () => StoreHelpers;
+  hideBackButton?: boolean;
+  locale?: Locale;
   run?: boolean;
   scrollOffset?: number;
   scrollToFirstStep?: boolean;
+  showProgress?: boolean;
+  showSkipButton?: boolean;
+  spotlightClicks?: boolean;
+  spotlightPadding?: boolean;
   stepIndex?: number;
   steps: Array<Step>;
+  styles?: object;
+  tooltipComponent?: (renderProps: TooltipRenderProps) => React.ReactNode;
 }
 
-export default class ReactJoyride extends React.Component<Props, StoreState> {}
+export default class ReactJoyride extends React.Component<Props, StoreState> {
+}
 
@@ -205,0 +151,0 @@ export interface actions {

New alerts

No website

Quality

Package does not have a website.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

255149

increased by34.12%

Dev dependency count

61

decreased by-7.58%

Number of package files

29

increased by383.33%

Lines of code

7645

increased by40.9%

Number of low supply chain risk alerts

3

decreased by-25%

Worsened metrics

Number of low quality alerts

1

increased byInfinity%

Number of lines in readme file

59

decreased by-28.92%

Dependency changes

• + Addeddeepmerge@3.3.0(transitive)

• + Addeddom-walk@0.1.2(transitive)

• + Addedglobal@4.3.2(transitive)

• + Addedis-lite@0.2.2(transitive)

• + Addedmin-document@2.19.0(transitive)

• + Addedprocess@0.5.2(transitive)

• + Addedrafl@1.2.2(transitive)

• + Addedscroll@2.0.3(transitive)

• - Removednested-property@1.0.4(transitive)

• - Removedscroll@3.0.1(transitive)

• Updateddeepmerge@^3.0.0

• Updatedis-lite@^0.2.2

• Updatednested-property@^0.0.7

• Updatedreact-floater@^0.6.2

• Updatedreact-is@^16.7.0

• Updatedscroll@^2.0.3