@bluframe/bluframe - npm Package Compare versions

Comparing version 0.16.0 to 0.17.0

flow-typed/@bluframe/blublocks.js

@@ -139,2 +139,4 @@ // @flow
   declare type HamburgerProps = {|
+    isMenuExpanded?: boolean,
+    menuId?: string,
     +onClick?: () => void
@@ -195,2 +197,3 @@ |}
     +className?: string,
+    +label: React$Node,
     +name: string,
@@ -197,0 +200,0 @@ +onSelect: (selected: number | string | null) => void,

flow-typed/npm/@testing-library/react.js

 // @flow
 
 declare module "@testing-library/react" {
+  declare export var fireEvent: any
   declare export var render: any
+  declare export var screen: any
+  declare export var waitFor: any
 }

package.json

 {
   "name": "@bluframe/bluframe",
-  "version": "0.16.0",
-  "description": "Blu Frame Open Source!",
-  "main": "index.js",
+  "version": "0.17.0",
+  "description": "A collection of React UI Components and Hooks by Blu Frame",
   "repository": "[e-mail]:bluframe/bluframe.git",
@@ -67,12 +66,23 @@ "author": "Edoardo L'Astorina <[e-mail]>",
   "keywords": [
+    "bluframe",
+    "blublocks",
+    "grapple",
     "react",
-    "react-component",
-    "ui",
-    "design",
-    "framework",
-    "frontend",
-    "component",
-    "components",
-    "hooks"
+    "react-components",
+    "react-hooks",
+    "ui-components",
+    "frontend-framework",
+    "design-system",
+    "web-development",
+    "javascript",
+    "styled-components",
+    "typography",
+    "input-fields",
+    "buttons",
+    "loading-spinner",
+    "hamburger-menu",
+    "intersection-observer",
+    "toggle",
+    "text-trimming"
   ]
 }

README.md

@@ -7,30 +7,63 @@ <p align="center">
 
-# React Components and Hooks by Blu Frame
+# Blu Frame React Components and Hooks
 
+Blu Frame provides a comprehensive collection of React UI Components and Hooks to enhance your web development experience. With our easy-to-use and customizable building blocks, you can quickly create beautiful and responsive web applications.
+
 ## Blu Blocks
+
 ### UI React Components by Blu Frame
 
-Head over to [Blu Blocks](blublocks) - our UI building blocks for a simple, elegant and themed UI
+[Blu Blocks](./blublocks/README.md) is a set of UI building blocks that provide simple, elegant, and themed UI components for your web applications. Ranging from buttons and inputs to typography and content display, Blu Blocks has everything you need to create a consistent and professional-looking web app. Check out the [Blu Blocks README](./blublocks/README.md) for more information and detailed usage instructions.
 
 ## Grapple
+
 ### React Hooks by Blu Frame
 
-Here is our collection of React Hooks - check out [Grapple](grapple) and make your code shorter!
+[Grapple](./grapple/README.md) is our collection of reusable React Hooks, designed to help you write shorter and more efficient code. With hooks for state management, UI interactivity, and utility functions, Grapple makes it easy to enhance your React components with additional functionality. Explore the [Grapple README](./grapple/README.md) to learn more and see examples of how our hooks can simplify your codebase.
 
 ## How to Install
 
-If you are using `yarn`
+If you are using `yarn`:
 
-`yarn add @bluframe/blublocks` and `yarn add @bluframe/grapple`
+```sh
+yarn add @bluframe/blublocks
+yarn add @bluframe/grapple
+```
 
-And if you are using `npm`
+And if you are using `npm`:
 
-`npm i @bluframe/blublocks` and `npm i @bluframe/grapple`
+```sh
+npm i @bluframe/blublocks
+npm i @bluframe/grapple
+```
 
 ## How to import
 
-`import Button from "@bluframe/blublocks/Button"`
+You can import the components and hooks individually or together, depending on your needs:
 
-or
+```js
+import Button from "@bluframe/blublocks/Button";
+import usePrevious from "@bluframe/grapple/usePrevious";
+```
 
-`import { Button } from "@bluframe/blublocks"`
+Or import multiple components and hooks at once:
+
+```js
+import { Button, InputText } from "@bluframe/blublocks";
+import { usePrevious, useOnScreen } from "@bluframe/grapple";
+```
+
+## Contributing
+
+We welcome contributions to improve BluFrame React Components and Hooks! If you'd like to contribute, please follow these steps:
+
+1. Fork the repository.
+2. Create a new branch for your feature or bugfix.
+3. Make your changes and commit them to your branch.
+4. Submit a pull request with a detailed description of your changes.
+
+Please ensure that your code follows our coding style and passes all tests.
+
+## License
+
+BluFrame React Components and Hooks are [MIT licensed](LICENSE).

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

93501

increased by2.33%

Lines of code

2437

increased by0.25%

Number of lines in readme file

69

increased by91.67%

No dependency changes