react-light-marquee - npm Package Compare versions

Comparing version 0.1.3 to 0.1.4

package.json

 {
   "name": "react-light-marquee",
-  "version": "0.1.3",
+  "version": "0.1.4",
   "private": false,
@@ -5,0 +5,0 @@ "type": "module",

README.md

@@ -1,5 +0,51 @@
-# Install
-yarn install react-light-marquee
+# react-light-marquee
+For most cases the number of elements in the dom is equal to number of children i.e it has ***no duplication***. Duplication is only done when it is absolutely necessary.
 
-#Status
-In beta testing
+Lightweight in bundle size and dom footprint.
+
+Marquee fills the parent container and renders the children
+
+# Installation
+
+    npm install react-light-marquee
+
+or
+
+    yarn install react-light-marquee
+
+# How to use
+
+	  import React from "react";
+	  import ListItem from "../ui/ListItem";
+	  import Marquee from "react-light-marquee";
+
+	  const Page = () => (
+	    <Marquee direction="right">
+	      <ListItem />
+	      <ListItem />
+	      <ListItem />
+	      <ListItem />
+	    </Marquee>
+	  );
+
+      export default Page;
+
+
+# API
+Marquee prop list
+| Property | Type | Default value | Details |
+|:--|:--|:--|:--|
+| direction | `"left" | "right"| "up"| "down"` | "left" | Direction of motion |
+| speed| number | 50 | Pixel per second |
+| pauseOnHover| boolean | false | `true` pauses the animation on hover |
+| initialSlideIndex | number | 0 | starting slide index |
+| children | React.ReactNode[] | null | slides to be rendered |
+
+# Upcoming in next releases
+- More features
+- Automation tests
+
+# Status
+
+In beta
+

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

No License Found

License

(Experimental) License information could not be found.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

45967

increased by5.05%

Number of package files

9

increased by12.5%

Number of low license alerts

0

decreased by-100%

Number of lines in readme file

52

increased by940%

No dependency changes