0.1.25 • Published 1 year ago

js-slider v0.1.25

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

Slider

Beautiful slider for React

Demo

https://user-images.githubusercontent.com/107611589/222640699-2c32bfe6-2ae9-473b-b45f-f4ca41f96a71.mov

Install

npm install -s js-slider

Usage

For general

import {JSSlider} from 'js-slider'
import {JSSliderData} from 'js-slider/dist/cjs/src/lib/JSSlider'

...

const stateEl = useRef<HTMLButtonElement>(null)

const itemList: JSSliderData[] = [
  {order: 1, image: '/image8.png'},
  {order: 2, image: '/image9.png'},
  {order: 3, image: '/image10.png'},
]

...

<JSSlider
  items={itemList}
  stateButton={stateEl.current}
  duration={200}
  interval={5000}
  onChangeItem={console.log}
  onChangeState={console.log}
/>
<button ref={stateEl}>Toggle State</button>

For React development environment

This feature is for About useEffect called twice issue in React 18

<JSSlider
  ...
  startEffect="useEffectOnce"
 />

or

const useEffectOnce = (callback: React.EffectCallback, dependencyList: React.DependencyList | undefined) => {
  ...
}

...

<JSSlider
  ...
  startEffect={useEffectOnce}
 />

Properties

PropertyDefaultTypeDescription
itemsundefinedextends JSSliderData
prevButtonundefinedextends HTMLElement
nextButtonundefinedextends HTMLElement
stateButtonundefinedextends HTMLElement
duration200number
interval0number
widthundefinednumber
heightundefinednumber
startEffectundefined'useEffectOnce' or useEffect typeFor React dev environment
type JSSliderData = {
  image: string
  order: number
  /** image styles */
  backgroundColor?: Property.BackgroundColor
  objectFit?: Property.ObjectFit
} & ({
  link: string
  newTab?: boolean
} | {
  link?: never
  newTab?: never
})
(callback: React.EffectCallback, dependencyList: React.DependencyList | undefined) => void
0.1.10

1 year ago

0.1.11

1 year ago

0.1.12

1 year ago

0.1.13

1 year ago

0.1.14

1 year ago

0.1.15

1 year ago

0.1.20

1 year ago

0.1.21

1 year ago

0.1.22

1 year ago

0.1.23

1 year ago

0.1.24

1 year ago

0.1.25

1 year ago

0.1.0

1 year ago

0.1.2

1 year ago

0.1.1

1 year ago

0.1.16

1 year ago

0.1.8

1 year ago

0.1.17

1 year ago

0.1.7

1 year ago

0.1.18

1 year ago

0.1.19

1 year ago

0.1.9

1 year ago

0.1.4

1 year ago

0.1.3

1 year ago

0.1.6

1 year ago

0.1.5

1 year ago

1.0.0

2 years ago