Features ✨

• Fast.
• Lightweight.
• Easy to use.
• Highly customizable.

Install 🧰

You can install react-native-simple-accordion by running the following command

npm install react-native-simple-accordion

Usage 💡

1. Add the following import statement

import { SimpleAccordion } from 'react-native-simple-accordion';

2. Add the Simple Accordion Component

<SimpleAccordion viewInside={<View/>} title={"My Accordion Title"}/>

3. Replace the for whatever view you want to display inside the accordion.

4. Customize your accordion with the customization options.

Necessary Attributes ⚠️

| Attribute | Description | Type | | ----------------- |:--------------------------------------------------:| ----------- | | viewInside | The view that goes inside of the accordion | JSX.Element |

Customizable Attributes 🕹️

Callbacks and ref functions

| Callback & Refs | Description | Signature / Example | |-----------------|:----------------------------------------------------------------------------------:|:----------------------------------| | onStateChange | Callback for when the state changes from collapsed to not collapsed and vice-versa | (isCollapsed: boolean) => void | | open | Opens the accordion | accordionRef.current?.open(); | | close | Closes the accordion | accordionRef.current?.close(); | | toggle | Toggles the accordion state, closing if open and opening if closed | accordionRef.current?.toggle(); | | isCollapsed | Checks the isCollapsed variable inside the component | accordionRef.current?.isCollapsed |

Usage of onStateChange callback:

<SimpleAccordion viewInside={<View/>} onStateChange={(isCollapsed: boolean) => console.log("isCollapsed: ", state)}/>

Usage of open, close and toggle ref functions:

const accordionRef = useRef(null); 

<SimpleAccordion ref={accordionRef} viewInside={<View/>}/>

// Now you can call:
// accordionRef.current?.open();
// accordionRef.current?.close();
// accordionRef.current?.toggle();
// accordionRef.current?.isCollapsed

Try it yourself 📱

Try this Snack from your browser or device!

Alternatively, you can check out and run the example-app included in this package's repo.

Examples 📝

With view =

<View>
  <Text>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vestibulum congue lacus ligula, at auctor felis ultrices at. Nullam porta metus nec odio fringilla fringilla. Nullam eget scelerisque metus. Nunc nec leo porta, pulvinar elit non, sagittis ipsum. Maecenas vel sem vel ipsum aliquet pharetra non eget neque. Cras vitae pulvinar purus, sed dictum augue. Proin mauris risus, dignissim a placerat ut, porta id lorem. Ut sit amet sapien nec metus porta dictum. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Maecenas sit amet augue vestibulum, imperdiet massa vitae, mollis diam. Suspendisse dictum suscipit metus, et hendrerit orci. Integer id posuere velit. Ut aliquam auctor augue egestas tincidunt. Nulla tempus cursus sapien.</Text>
</View>

Simple accordion

<SimpleAccordion viewInside={view} title={"Simple Accordion"}/>

No Card accordion

<SimpleAccordion viewInside={view} title={"No Card Accordion"} showContentInsideOfCard={false} viewContainerStyle={{backgroundColor: "#E0E0E0"}}/>

Custom Style accordion

<SimpleAccordion viewInside={view} title={"Custom Style Accordion"} titleStyle={{fontStyle: "italic", color: "#FFFFFF", textDecorationLine: "underline"}} bannerStyle={{backgroundColor: "#7CA5B8"}} viewContainerStyle={{backgroundColor: "#C6EBBE"}}/>

No Arrow accordion

<SimpleAccordion viewInside={view} title={"No Arrows Accordion"} showArrows={false}/>

Custom Arrow Color Accordion

<SimpleAccordion viewInside={view} title={"Custom Arrow Color Accordion"} />

With view (with button) =

<View>
  <Text>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vestibulum congue lacus ligula, at auctor felis ultrices at. Nullam porta metus nec odio fringilla fringilla. Nullam eget scelerisque metus. Nunc nec leo porta, pulvinar elit non, sagittis ipsum. Maecenas vel sem vel ipsum aliquet pharetra non eget neque. Cras vitae pulvinar purus, sed dictum augue. Proin mauris risus, dignissim a placerat ut, porta id lorem. Ut sit amet sapien nec metus porta dictum. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Maecenas sit amet augue vestibulum, imperdiet massa vitae, mollis diam. Suspendisse dictum suscipit metus, et hendrerit orci. Integer id posuere velit. Ut aliquam auctor augue egestas tincidunt. Nulla tempus cursus sapien.</Text>
  <Button title={"Test Button"} onPress={() => Alert.alert("Test button clicked")}/>
</View>

<SimpleAccordion viewInside={viewWithButton} title={"Simple Accordion With Button"}/>

Contributing 🍰

This is my first publicly available package so until I figure out some guidelines and tools to work with others I won't be looking at forks and pull requests. If you want me to improve this package, feel free to reach out to me and I'll gladly update it.

Maintainers 👷

License ⚖️

MIT