@pluralsight/react - npm Package Compare versions

Comparing version 0.0.0 to 0.4.1-experimental-e3c31c-20230428

package.json

 {
   "name": "@pluralsight/react",
-  "version": "0.0.0",
+  "version": "0.4.1-experimental-e3c31c-20230428",
   "description": "A React component library for Pando.",
@@ -28,2 +28,5 @@ "main": "npm/node/index.js",
   "sideEffects": false,
+  "workspaces": [
+    "sandbox"
+  ],
   "scripts": {
@@ -93,4 +96,3 @@ "build": "yarn clean && yarn compile:types && yarn bundle && yarn clean:allUnused",
     "components",
-    "ui components",
-    "pluralsight"
+    "ui components"
   ],
@@ -112,2 +114,2 @@ "publishConfig": {
   "packageManager": "yarn@3.5.0"
-}
+}

README.md

 # React
 
-A library of custom React hooks that help manage advanced React features like State and accessbility.
+A library of React components and hooks that help manage advanced React features like State and accessibility.
 
-- [Checkout the docs](design.pluralsight.com/development/react-utils)
-
 ## What role does this package play in Pando?
@@ -14,2 +12,3 @@
   PANDO ||--o{ HEADLESS-STYLES : contains
+  PANDO ||--o{ REACT : contains
   PANDO ||--o{ REACT-UTILS : contains
@@ -19,19 +18,19 @@ DESIGN-TOKENS ||..|{ NORMALIZE-SETUP : contains
   HEADLESS-STYLES ||--|{ DESIGN-TOKENS : uses
+  REACT ||--|{ HEADLESS-STYLES : uses
+  REACT ||--|{ REACT-UTILS : uses
 ```
 
-This package utilizes the latest version of React to export custom hooks to use along with [Headless Styles](https://design.pluralsight.com/docs/next/development/headless-styles/intro) or independently from Pando.
+This package utilizes the latest version of React to deliver component-based abstractions, helpers, and hooks of the Headless-styles library.
 
-### React Utils General Function
+### React General Function
 
-The react-utils package is independant from the Pando sister libraries, but works cohesively when combined with them. It's true purpose is to provide custom hooks that successfully work along side Headless Styles within the Pando Normalize system (i.e. themes, etc.).
+The react package is dependant on the Headless-styles library, and works cohesively with the other libraries when combined with them. It's true purpose is to provide a component and hook library within the Pando Normalize system (i.e. themes, etc.).
 
-However, most if not all custom hooks should work successfully outside of Pando due to the nature of its design.
-
 ## Install
 
-This project uses Yarn 3 with PnP so there are no setup commands needed. If you get any errors, you may need to run an initial `yarn install` or esnure you are using Node >= 18.
+This project uses Yarn 3 with PnP so there are no setup commands needed. If you get any errors, you may need to run an initial `yarn install` or ensure you are using Node >= 18.
 
 ## Development
 
-There is no development sandbox for this specific project, but most of the time, we import the hooks into the [Headless Styles sandbox](https://github.com/pluralsight/pando/tree/main/packages/headless-styles/sandbox) which is [just as easy](https://github.com/pluralsight/pando/blob/main/packages/headless-styles/sandbox/src/components/Tabs.jsx#L2-L8).
+We utilize a Vite TS/React sandbox to help keep security issues, complexity, and dependency size down which is a common problem when using a tool like Storybook.
 
@@ -41,3 +40,3 @@ From the **root directory of the project**, run:
 ```bash
-yarn start:sandbox
+yarn start:react-sandbox
 ```
@@ -44,0 +43,0 @@

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

39748

increased by468.4%

Number of package files

14

increased by7.69%

Published versions last year

318

increased by0.63%

Worsened metrics

Number of lines in readme file

52

decreased by-1.89%

No dependency changes