elegant-smooth-slider
v1.0.5
Published
Image Slide Library
Downloads
56
Maintainers
Readme
Elegant Smooth Slider
Elegant Smooth Slider is a customizable image slider component for React applications. It allows you to display an array of images with various details and provides a smooth sliding effect.
Component Preview
Table of Contents
Installation
You can install this package using npm:
npm install elegant-smooth-slider
Or using yarn
yarn add elegant-smooth-slider
Usage
import React from 'react';
import ElegantSmoothSlider from 'elegant-smooth-slider';
const data = [
{
img: "https://elegant-smooth-slider/img1.jpg",
title: "Elegant Smooth Slider ", description: "Elegant Smooth Slider is a customizable image slider component",
link: "https://elegant-smooth-slider/"
},
];
const App = () => {
return (
<div>
<ElegantSmoothSlider
slides={data}
automatedSlides={true} {* Slide automated or not *}
automatedDelay= {3} {* Delay time in seccond ( if you want)*}
slideButtonBackground="#e6e6e6"
slideButtonIconColor="#000000"
slideButtonBackgroundHover="#cccccc"
slideButtonIconColorHover="#333333"
buttontype="primary" {* 'primary' or 'secondary' *}
imageTint={true}
slidArrowButton={true}
slideContent={true}
contentTitle={true}
contentDescription={true}
contentLink={true}
contentTitleColor="#f0f0f0"
contentDescriptionColor="#f0f0f0"
linkButtonColor="#e6e6e6"
linkButtonColorHover="#cccccc"
linkButtonTextColor="#000000"
linkButtonTextColorHover="#333333"
subImages={true}
subImagePosition="bottom" {* 'bottom' , 'center' , 'top' *}
/>
</div>
);
};
export default App;
ElegantSmoothSlider (Props)
|Name|Type|Default| Description| |:-|:-|:-|:-| |slides |array| NO Default| Array of slide items.| |automatedSlides |boolean |true |Whether slides should auto-slide (optional).| |automatedDelay |number| 3s| Delay od slide animation in seccond (optional).| |slideButtonBackground |string |#e6e6e6 |Background color of slide buttons (optional).| |slideButtonIconColor |string |#000000 |Icon color of slide buttons (optional).| |slideButtonBackgroundHover |string |#cccccc |Hover background color of slide buttons (optional).| |slideButtonIconColorHover |string |#333333 |Hover icon color of slide buttons (optional).| |buttontype |string |'primary' |Type of button ('primary' or 'secondary') (optional).| |imageTint |boolean |false |Whether images should have a tint (optional).| |slidArrowButton |boolean |true |Whether to show slide arrow buttons (optional).| |slideContent |boolean |true |Whether to display content (title, description) (optional).| |contentTitle |boolean |true |Whether to display the content title (optional).| |contentDescription |boolean |true |Whether to display the content description (optional).| |contentLink |boolean |true |Whether to display the content link (optional).| |contentTitleColor |string |#f0f0f0 |Color of the content title (optional).| |contentDescriptionColor |string |#f0f0f0 |Color of the content description (optional).| |linkButtonColor |string |#e6e6e6 |Background color of link buttons (optional).| |linkButtonColorHover |string |#cccccc |Hover background color of link buttons (optional).| |linkButtonTextColor |string |#000000 |Text color of link buttons (optional).| |linkButtonTextColorHover |string |#333333 |Hover text color of link buttons (optional).| |subImages |boolean |true |Whether to display sub-images (optional).| |subImagePosition |string |'bottom' |Position of sub-images ('bottom' , 'center' or 'top') (optional).|
Slide Items Types
|Key |Type |Default |Description| |:-|:-|:-|:-| |img |string |N/A |Image link| |title |string |N/A |Title of the slide (optional)| |description |string |N/A |Description of the slide (optional)| |link |string |N/A |URL link for the slide (optional)| |buttonName |string |See More |Name of the button (optional)| |titleColor |string |#e6e6e6 |Color of the title (optional)| |descriptionColor |string |#e6e6e6 |Color of the description (optional)|
Example Of Array Of Data
[
{
img: "https://elegant-smooth-slider/img1.jpg",
title: "Elegant Smooth Slider ", description: "Elegant Smooth Slider is a customizable image slider component",
link: "https://elegant-smooth-slider/",
buttonName: "See More",
titleColor: "#e6e6e6"
descriptionColor: "#e6e6e6"
},
];