0.0.2 • Published 4 years ago

react-native-whatsnew-kit v0.0.2

Weekly downloads
4
License
MIT
Repository
github
Last release
4 years ago

Battle Tested ✅

Plug & Play, beautiful WhatsNewKit for React Native

npm version npm Platform - Android and iOS License: MIT styled with prettier

Installation

Add the dependency:

npm i react-native-whatsnew-kit

Peer Dependencies

IMPORTANT! You need install them
"react": ">= 16.x.x",
"react-native": ">= 0.55.x",
"react-native-modal": ">= 11.5.3"

Usage

Import

import WhatsNew from "react-native-whatsnew-kit";

Basic Usage

<WhatsNew
  data={data}
  fullScreen={false}
  isVisible={isVisible}
  onBackdropPress={() => setIsVisible(false)}
/>

Data Array Format

Data MUST be with this format. If you want to use your own iconComponent instead of internal Image or ImageComponent (just as FastImage) then you need to set iconComponent field within the data format.

[
  {
    title: "Awesome",
    description:
      "Suspendisse ex mauris, viverra vitae mi eget, consectetur interdum sem. Phasellus sodales elit ac mauris posuere",
    icon: require("assets/check.png"),
    iconComponent: null
  },
  {
    title: "Dark Theme",
    description:
      "Orci varius. Aliquam accumsan lectus lorem, a congue diam commodo sit amet. Fusce laoreet sapien non lectus dignissim viverra.",
    icon: require("assets/theme.png"),
    iconComponent: null
  },
  {
    title: "Bug Fixes",
    description: "Donec non mauris sagittis, gravida velit vel, varius quam.",
    icon: require("assets/wiping.png"),
    iconComponent: null
  }
];

Configuration - Props

PropertyTypeDefaultDescription
dataObject Array[]You must set the formatted data as expected
widthnumber/stringundefinedchange the width of the whole modal
heightnumber/stringundefinedchange the height of the whole modal
titlestringWhatsNewKitchange the main title
onPressfunctionundefinedset your own function for the main button
isVisiblebooleanfalseVisibility of the WhatsNewKit Modal
fullScreenbooleanfalsemake the WhatsNewKit full screen
ImageComponentComponentImageset your own image component such as FastImage
backgroundColorcolor#fdfdfdchange the WhatsNewKit's background color
iconWidthstring/number50change the each icon's width
iconHeightstring/number50change the each icon's height
buttonTextstringAwesome!set the main button's text
buttonStylestyledefaultset your own style for main button
titleFontSizenumber32change the title's font size
buttonFontSizenumber16change the button's font size
titleFontColorcolor#000change the title's font color
titleTextStylestyledefaultset your own text style for title
buttonTextStylestyledefaultset your own text style for button
buttonFontColorcolor#fdfdfdchange the button's font color
textButtonValuestringRead morechange the text button's text
textButtonOnPressfunctionundefinedset your own function for text button as Read more button
itemDescTextStylestyledefaultset your own text style for item's description
itemTitleTextStylestyledefaultset your own text style for item's title
textButtonTextStylestyledefaultset your own text style for text button's text
textButtonFontColorcolor#3da7d2change the color of text button's font
buttonBackgroundColorcolor#3da7d2change the color of main button's background color

Future Plans

  • LICENSE
  • Animations
  • Write an article about the lib on Medium

Credits

WhatsNewKit is heavily inspired by SvenTiigi's WhatsNewKit Thank you so much for this awesome kit 🥳

Author

FreakyCoder, kurayogun@gmail.com

License

React Native WhatsNewKit is available under the MIT license. See the LICENSE file for more info.