hero-slider - npm Package Compare versions

Comparing version 1.1.0 to 1.1.1

dist/Slider/typings.d.ts

@@ -71,3 +71,2 @@ /// <reference types="react" />
     style?: React.CSSProperties;
-    shouldDisplayChange: boolean;
     autoplay: React.MutableRefObject<IntervalTimer>;
@@ -74,0 +73,0 @@ setIsManuallyPaused: React.Dispatch<React.SetStateAction<boolean>>;

package.json

 {
   "name": "hero-slider",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "description": "",
@@ -5,0 +5,0 @@ "author": "rmolinamir",

README.md

@@ -46,3 +46,4 @@ # hero-slider
   MenuNav,
-  ButtonsNav
+  ButtonsNav,
+  AutoplayButton
 } from 'hero-slider'
@@ -266,4 +267,18 @@ ```
 
+## AutoplayButton
+
+The AutoplayButton component comes in handy whenever the hero slider is set up to autoplay. This button will play or pause the autoplay instance respectively upon clicking it. It's really easy to setup. The button is an SVG image, which means it will scale well to any width or height. **The button has to be in the first level of the HeroSlider childrens, just like a Slide component would be. If you want to place it somewhere else, you may use a React portal**.
+
+You can position it just like you would position a nav component by using passing the `position` prop, but you may also pass a CSS class or inline styling as props. Here is a more detailed table explaining the props:
+
+| Prop | Type | Default | Definition |
+|:---------:|:-------------------:|:---------------------------:|:---------------------------------------------------------------------------------------------:|
+| position | `object` | (Same as the Nav component) | Object structured by the inline CSS `top`, `left`, `bottom`, and `right` position properties. |
+| style | React.CSSProperties | `null` | Inline CSS styling for the wrapper div element of the component. |
+| className | `string` | `null` | CSS class name. |
+
+---
+
 ## License
 
 MIT © [rmolinamir](https://github.com/rmolinamir)

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

513641

increased by0.22%

Number of lines in readme file

283

increased by5.6%

Worsened metrics

Lines of code

3814

decreased by-0.03%

No dependency changes