@ercpereda/react-native-accordion

An Accordion Component for React Native

Stats

StarsIssuesVersionUpdatedCreatedSize
@ercpereda/react-native-accordion
1012.0.64 years ago4 years agoMinified + gzip package size for @ercpereda/react-native-accordion in KB

Readme

React Native Accordion

npm npm downloads

react-native-accordion is an easy to use Accordion component for React Native app.

accordion

Preview

Using the expo project

Install

npm i --save @ercpereda/react-native-accordion

Usage

Using an Accordion in your app will usually look like this:

import React from 'react';
import { StyleSheet, Text, View } from 'react-native';
import Accordion from '@ercpereda/react-native-accordion';

const Header = ({ isOpen }) =>
  <View style={{
      paddingTop: 15,
      paddingRight: 15,
      paddingLeft: 15,
      paddingBottom: 15,
      borderBottomWidth: 1,
      borderBottomColor: '#a9a9a9',
      backgroundColor: '#f9f9f9',
    }}>
      <Text>{`${isOpen ? '-' : '+'} Click to Expand`}</Text>
    </View>;

const Content = (
  <View style={{
      display: 'flex',
      backgroundColor: '#31363D'
    }}>
      <Text style={{
        paddingTop: 15,
        paddingRight: 15,
        paddingBottom: 15,
        paddingLeft: 15,
        color: '#fff',
      }}>
        This content is hidden in the accordion
      </Text>
    </View>);

export default class App extends React.Component {
  render() {
    return (
      <View style={styles.container}>
        <Accordion
          header={Header}
          content={Content}
          duration={300}
        />
      </View>
    );
  }
}

const styles = StyleSheet.create({
  container: {
    flex: 1,
    backgroundColor: '#fff',
    alignItems: 'center',
    justifyContent: 'center',
  },
});

Examples

Here are a few examples of how you can use an accordion in your app:

Transit App Tweetbot
accordion-transit accordion-tweetbot

Props

The following props can be used to modify the Accordion's style and/or behaviour:

Prop Type Opt/Required Default Note
activeOpacity Number Optional 1 The active opacity of the TouchableHighlight.
animationDuration Number Optional 300 The duration of the animation.
content Element Required N/A The content you want hidden in the collapse accordion.
easing String Optional linear A tweening function from tween-functions.
expanded Boolean Optional false If the accordion is expanded by default when mounted.
header Element Required N/A The element that will expand the accordion when pressed.
onPress Function Optional N/A A function that will be called when the accordion is pressed.
underlayColor String Optional #000 The underlay color of the TouchableHighlight.
style Object Optional {} The styles you want to set on the accordion element.

Methods

The following methods can be used to open and close the accordion:

Method Parameters Note
open N/A Open the accordion.
close N/A Close the accordion.
toggle N/A Toggle the accordion.

License

Copyright (c) 2015, Naoufal Kadhom

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.

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.