sm-banner
v1.0.2
Published
This is reusable responsive banner package.
Downloads
2
Readme
sm-banner
This package provides a reusable responsive banner component for React applications, allowing easy integration of banners with customizable content and animations.
Installation
You can install sm-banner
via npm or yarn:
npm install sm-banner
# or
yarn add sm-banner
Usage
import React from "react";
import Banner from "sm-banner";
import jsonData from "./path_to_your_json_data.json";
import backgroundImage from "./path_to_your_background_image.jpg";
const MyComponent = () => {
return (
<Banner jsondata={jsonData} backgroundImage={backgroundImage} />
);
}
export default MyComponent;
Props
jsondata
: JSON object containing the configuration for the banner component.backgroundImage
: Path to the background image for the banner.
Example JSON Data
{
"id": "exampleId",
"bannerHeight": "60vh",
"backgroundColor": "bg-dark",
"color": "text-white",
"heading": "Your Heading",
"description": "Your description goes here.",
"button_1": "Button 1",
"button_1_color": "light",
"button_2": "Button 2",
"button_2_color": "light",
"wow_animation": "fadeInUp", // Example animation class
"wow_duration": "1s", // Example animation duration
"wow_delay": "0.5s" // Example animation delay
}
License
This project is licensed under the ISC License. See the LICENSE file below :
ISC License
Copyright (c) 2024, Shivam Makwana
Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.