npm

sm-accordion

1.0.2 • Public • Published

sm-accordion

Version License

This package provides a responsive accordion component for React applications, allowing easy integration of collapsible sections with customizable content and animations.

Installation

You can install sm-accordion via npm or yarn:

npm install sm-accordion
# or
yarn add sm-accordion

Usage

import React from "react";
import Accordion from "sm-accordion";
import jsonData from "./path_to_your_json_data.json";

const MyComponent = () => {
    return (
        <Accordion jsondata={jsonData} />
    );
}

export default MyComponent;

Props

  • jsondata: JSON object containing the configuration for the accordion component.

Example JSON Data

{
    "id": "exampleId",
    "backgroundColor": "bg-dark",
    "accordionBodyColor": "bg-light",
    "accordionBodyTextColor": "text-dark",
    "openAccordionItem": {
        "accordionHeader": "Accordion Item #1",
        "accordionBodyTitle": "Accordion Title 1",
        "accordionBodyText": "Accordion description goes here..."
    },
    "accordionItems": [
        {
            "accordionHeader": "Accordion Item #2",
            "accordionBodyTitle": "Accordion Title 2",
            "accordionBodyText": "Accordion description goes here..."
        },
        {
            "accordionHeader": "Accordion Item #3",
            "accordionBodyTitle": "Accordion Title 3",
            "accordionBodyText": "Accordion description goes here..."
        }
    ],
    "wow_animation": "fadeIn", // 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.

Readme

Keywords

Package Sidebar

Install

npm i sm-accordion

Weekly Downloads

2

Version

1.0.2

License

ISC

Unpacked Size

400 kB

Total Files

9

Last publish

Collaborators

  • sea_marshall