/react-native-android-taskdescription

Android TaskDescription component for React Native

Primary LanguageJava

React Native Android TaskDescription

Android TaskDescription component for React Native

Overview

Allows configuration of the Android TaskDescription, allowing you to change the background color and text of the TaskDescription shown on the recent apps Overview Cards. Changing the icon is not yet supported.

Examples

Change the color

import TaskDescriptionAndroid from 'react-native-android-taskdescription'

  // ...
  render() {
    return (
      <View>
        <TaskDescriptionAndroid backgroundColor="#8fa224" />
        <Text>My awesome app!</Text>
      </View>
    )
  }

Change TaskDescription background color

Change the text

import TaskDescriptionAndroid from 'react-native-android-taskdescription'

  // ...
  render() {
    return (
      <View>
        <TaskDescriptionAndroid label="Super Awesome App" />
        <Text>My awesome app!</Text>
      </View>
    )
  }

Change TaskDescription text

Change color and text

import TaskDescriptionAndroid from 'react-native-android-taskdescription'

  // ...render
  render() {
    return (
      <View>
        <TaskDescriptionAndroid backgroundColor="#5c34d2" label="Super Awesome App" />

        <Text>My awesome app!</Text>
      </View>
    )
  }

Change TaskDescription background color and text

Installation and setup

Install

npm install --save react-native-android-taskdescription

IMPORTANT: for RN <= 0.28, please use version 0.2.0 and follow the README installation and usage instructions from that version, ie npm install --save react-native-android-taskdescription@0.2.0

Setup

Option 1 (recommended): Automatically

After installing, run:

react-native link

Option 2: Manually

Update android/settings.gradle
...
include ':react-native-android-taskdescription'
project(':react-native-android-taskdescription').projectDir = new File(settingsDir, '../node_modules/react-native-android-taskdescription/android')
Update android/app/build.gradle
...
dependencies {
  ...
  compile project(':react-native-android-taskdescription')
}

Register module in MainApplication.java

  import com.jwarby.reactnativeandroidtaskdescription.TaskDescriptionPackage; // <--- import package

  // ...
  @Override
  protected List<ReactPackage> getPackages() {
    return Arrays.<ReactPackage>asList(
      new MainReactPackage(),
      new TaskDescriptionPackage() // <--- add package
    );
  }

Changelog

v1.0.1 (20th Oct 2016)

Add support for linking project using react-native link.

v1.0.0 (8th Jul 2016)

  • Changes to make plugin compatible with React Native 0.29
  • Change API for setting text - use label prop instead of <Text /> child component

v0.2.0 (20th May 2016)

Import React, Component and PropTypes from react instead of react-native as per changes in react-native@0.25+. RN 0.25 spat out warnings about importing these from react-native, and 0.26 removed the warnings and just failed instead.

v0.1.0 (14th Apr 2016)

First released version.