react-scroll-snap-anime-slider 1.0.0 → 1.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Kanra Su
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,5 @@
+<div align="center"><img src="docs/static/img/logo-slider.png" width="250"/></div>
+
 <h1 align="center">React Scroll Snap Anime Slider</h1>
 
 <div align="center">
@@ -6,6 +8,8 @@ A simple slider/carousel using css style [scroll-snap](https://developer.mozilla
 
 Works natively on touchable devices
 
+:grinning:[Demo](https://karanokara.github.io/react-scroll-snap-anime-slider/)
+
 </div>
 
 ## :star: Features 
@@ -13,6 +17,7 @@ Works natively on touchable devices
 | Features                             |                       Comment                       |       Status        |
 | ------------------------------------ | :-------------------------------------------------: | :-----------------: |
 | **Multiple slides per view**         |           Can also adjust slides per step           | :heavy_check_mark:  |
+| **Customized DOM structure**         |     Construct the slider components by yourself     | :heavy_check_mark:  |
 | **Touch scrolling**                  |                      Built-in                       | :heavy_check_mark:  |
 | **Scroll and snap**                  |                Snap to slide's edge                 | :heavy_check_mark:  |
 | **Free scrolling**                   |                                                     | :heavy_check_mark:  |
@@ -30,16 +35,19 @@ Works natively on touchable devices
 | **Vertical scrolling**               |                       Pending                       |      :clock3:       |
 
 ## :neutral_face: Motivation 
-The reason to start creating my own JS slider is because I couldn't find a slider that works smoothly on desktop browser and mobile device. There are a ton of wonderfull sliders out there such as [Swiper](https://swiperjs.com/), [Pure React Carousel](https://express-labs.github.io/pure-react-carousel/) and a lot, but they are all not dynamic and reponsive enough, especially when use on iOS (the animation not works sometime). 
+The reason to start creating my own JS slider is because I couldn't find a slider that works smoothly on both desktop browser and mobile device. There are a ton of wonderfull sliders out there such as [Swiper](https://swiperjs.com/), [Pure React Carousel](https://express-labs.github.io/pure-react-carousel/) and a lot, but they are not utilizing the native scrolling feature, and so not work natively on iOS browser (the animation not works smoothly). 
+
+## 🤔 Do I need this slider?
+If you are looking for an animation effect of slider that works like those sliders you saw in some native Apps, you can try this one. However this slider has limitions such as it only provides sliding effect (no fade, swiping effects, for example). So, if you are looking for a powerful slider, you should other powerful library such as [Swiper](https://swiperjs.com/).
 
 ## :pushpin: Geting started
 
-Install:
+### Install:
 ```bash
 npm install react-scroll-snap-anime-slider
 ```
 
-Create a simple slider:
+### Create a simple slider:
 ```js
 import { Slider, } from "react-scroll-snap-anime-slider";
 
@@ -47,7 +55,10 @@ import { Slider, } from "react-scroll-snap-anime-slider";
 ```
 
 
-
 ## :book: Documentation
+You can learn more from [here](https://karanokara.github.io/react-scroll-snap-anime-slider/).
+
+
 
-You can learn more from [here](https://facebook.github.io/create-react-app/docs/getting-started).
+## :bug: Bugs or :bow: Requests 
+You can file an issue under the [Issues](../../issues) page.

package/dist/index.d.ts

@@ -1,6 +1,14 @@
-export { Slider } from "./lib/Slider";
-export type { IProps as SliderProps } from "./lib/Slider";
+export { Carousel } from "./lib/Carousel";
+export { Slider, } from "./lib/Slider";
+export type { IProps as ISliderProps, OnScrollProps } from "./lib/Slider";
 export { Slide } from "./lib/Slide";
 export type { IProps as SlideProps } from "./lib/Slide";
+export { ButtonBack } from "./lib/ButtonBack";
+export { ButtonNext } from "./lib/ButtonNext";
+export { SliderBarLine } from "./lib/SliderBarLine";
+export { SliderBarDotGroup } from "./lib/SliderBarDotGroup";
+export type { IRenderDotsProps } from "./lib/SliderBarDotGroup";
+export { renderDotsDynamicCircle, renderDotsDynamicPill, renderDotsDynamicByScale, CircleDot, PillDot } from "./lib/DotGroupRenderDotsUtil";
+export type { ScaleDot, ScaleDotProps } from "./lib/DotGroupRenderDotsUtil";
 export * from "./lib/Utility";
-export * from "./types";
+export * from "./lib/Types";