react-native-tableview-simple

👉 This component is used in my production app Game ideas. Make sure to check it out! 👈

This cross-platform component is inspired by the iOS-TableView. Made with pure CSS, the intention is to provide a flexible and lightweight alternative to a bridged component. Don't be scared of React-Native upgrades anymore!

A possible use case might be an about- or a settings-screen with a few rows. For displaying long datalists it is recommended to use the FlatList Component together with Cell and Separator Components. (see example or live demo with expo)

🚀 If you like my component and want to buy me a coffee press the Sponsor Button and find out about GitHub Sponsors – Thanks! 👈

Have a look at the examples below! 😃

• Installation
• Extensible
• Props: TableView Cell Section Separator
• Examples
• Try it out

Installation

1. Install as dependency:

// yarn
yarn add react-native-tableview-simple
// or npm
npm i react-native-tableview-simple --S

2. Add needed components:

import { Cell, Section, TableView } from 'react-native-tableview-simple';

Extensible

react-native-tableview-simple provides you with some predefined CSS-styles, inspired by the native TableView. You can always mix the Cell-instances inside a Section, with other (React-Native)-Views.

Override defaults of Cell-Component

Don't repeat yourself. If you override the default props over and over again, just pass them as an object.

const cellPropsCustom = {
  cellStyle: 'Basic',
  title: 'Basic Custom',
  backgroundColor: 'black',
};

Separator BackgroundColor is derived from Cell BackgroundColor

The Separator-Component is a line from the left end to the right end. According to the original iOS TableView there should be an insent on the left end. This is done by separating the Separator-Component in two parts: SeparatorContainer (full width) and SeparatorInner (width - inset). (See: Separator.tsx) The SeparatorContainer has the same color that the Cell-Component above. The SeparatorInner has the default Separator Color. Pressing a Cell Component will change the color of SeparatorInner to transparent.

Why is that so complicated?

Because just hiding the separator would make the height of the component jump.

Props

• TableView
• Cell
• Section
• Separator

TableView

The TableView component controls the theme.

Section

The Section component is needed to render the Cells together with Separators. It's possible to use the Flatlist component instead (Example).

Cell

The style of the Cell component is inspired by the native UITableView. Because the Cell component is created with CSS only, its highly flexible. The content of the cell is separated in three views, which can all be modified via props: cellImageView | cellContentView | cellAccessoryView.

To get an idea what you can modify via props, have a look at the examples below.

Wrap Cell

Sometimes custom Cell components are needed. By creating a new component, which is based on Cell, its only necessary to set the props once. However, this comes with certain downsides. In order to keep the API as easy to use as possible, I implemented some automations for the Sections component. For example, the Cell.backgroundColor prop will also decide on the backgroundColor of the Separator component.

Given the following pattern:

import {
  Cell,
  Section,
  TableView,
} from 'react-native-tableview-simple';

const CellVariant = (props) => (
  
        
      
    }
  />
);

// ...


  <section>
    
    
    
    
  </section>

This pattern introduces an additional layer between Section and Cell: Section -> CellVariant -> Cell. The Section component is expecting a Cell component as a child and therefor tries to access the props as defined for the Cell component. If following the mentioned pattern, this would fail, because CellVariant.props only contains the prop title. Instead, I recommend to insert your new default props as description in this section: Override defaults of Cell-Component.

If this is not enough for you, and you still need to have a custom cell component, consider merging both approaches:

import {
  Cell,
  Section,
  TableView,
} from 'react-native-tableview-simple';


const cellPropsVariant = {
  hideSeparator: true,
  backgroundColor: 'black',
};

const CellVariant = (props) => (
  
        
      
    }
  />
);

// ...


  <section>
    
    
    
    
  </section>

Separator

In general the Separator component is used internally by the Section component. But additionally this component can be used together with FlatList. See the example below.

Examples

The following examples can be found in the folder example. To run the example project, follow these steps:

1. git clone https://github.com/Purii/react-native-tableview-simple
2. cd example
3. yarn or npm i
4. run /example/ios/example.xcodeproj via Xcode

• Quick look
• Use case: About-screen
• Complete example / vs. native iOS
• Render with FlatList

Quick look

// ActivityIndicator as accessory
  }
    contentContainerStyle={{ paddingVertical: 4 }} // Adjust height
  />

// Switch as accessory
  }
  />

// TextInput
  }
  />

// Image
  
    }
  />

Use case: About-screen

/**
 * Sample React Native App
 * https://github.com/facebook/react-native
 * @flow
 */

import React, { Component } from 'react';
import { AppRegistry, ScrollView, StyleSheet, Text, View } from 'react-native';
import { Cell, Section, TableView } from 'react-native-tableview-simple';

export default class App extends Component<{}> {
  render() {
    return (
      
        
    );
  }
}

const styles = StyleSheet.create({
  stage: {
    backgroundColor: '#EFEFF4',
    paddingBottom: 20,
    flex: 1,
  },
});

react-native-tableview-simple vs. Native iOS

The left and middle screens are build using react-native-tableview-simple. The right one is native.

react-native-tableview-simple (Dark Appearance)	react-native-tableview-simple	Native iOS

/**
 * Sample React Native App
 * https://github.com/facebook/react-native
 * @flow
 */

import React, { Component } from 'react';
import {
  ActivityIndicator,
  AppRegistry,
  Dimensions,
  Image,
  ScrollView,
  StyleSheet,
  Switch,
  Text,
  TextInput,
  View,
} from 'react-native';
import { Cell, Section, TableView } from 'react-native-tableview-simple';

export default class App extends Component<{}> {
  render() {
    return (
      
        
          <section>
            
            
            
            
             console.log('Heyho!')}
            /&gt;
          </section>
          <section>
            
            
            
            
             console.log('Heyho!')}
            /&gt;
          </section>
          <section>
            
            
            
            
             console.log('Heyho!')}
            /&gt;
          </section>
          <section>
            
              }
            /&gt;
            
              }
            /&gt;
            
              }
            /&gt;
            
              }
            /&gt;
             console.log('Heyho!')}
              image={
                <img style="{{">
              }
            /&gt;
            
              }
            /&gt;
          </section>
          <section>
            
            
            }
              contentContainerStyle={{ paddingVertical: 4 }}
            /&gt;
            }
            /&gt;
            
              }
            /&gt;
          </section>
          <section>
             console.log('Heyho!')}
              contentContainerStyle={{ alignItems: 'flex-start', height: 60 }}
              cellContentView={
                
              }
            /&gt;
          </section>
          <section>}&gt;
            
          </section>
        
        
    );
  }
}

const styles = StyleSheet.create({
  stage: {
    backgroundColor: '#EFEFF4',
    paddingTop: 20,
    paddingBottom: 20,
  },
});

Render with FlatList

Be aware of the prop keyboardShouldPersistTaps if using ScrollView or similar components. (See #85)

import React from 'react';
import { FlatList } from 'react-native';

import { Cell, Separator, TableView } from 'react-native-tableview-simple';

const data = [
  { id: 1, title: '1' },
  { id: 2, title: '2' },
  { id: 3, title: '3' },
  { id: 4, title: '4' },
];

export default ExampleWithFlatList = () => (
  
     item.id}
      renderItem={({ item, separators }) => (
        
      )}
      ItemSeparatorComponent={({ highlighted }) => (
        
      )}
    />
  
);

Try it out

Try it in Expo: https://snack.expo.io/@purii/react-native-tableview-simple