0.1.9 • Published 4 years ago

react-native-instagram-story-circle v0.1.9

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

Fully customizable Instagram Story Circle with Bounceable Animated Library for React Native

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

Installation

Add the dependency:

npm i react-native-instagram-story-circle

Peer Dependencies

"react-native-linear-gradient": ">= 2.5.6"
"@freakycoder/react-native-bounceable": ">= 0.1.0",

Usage

Import

import IGStoryCircle from "react-native-instagram-story-circle";

Fundamental Usage

Please look at the example simply run it and check how it works :)

<IGStoryCircle source={source} hasStory onPress={() => {}} />

Configuration - Props

PropertyTypeDefaultDescription
sourceimageundefinedset the image for the circle
sizenumber64change the size of the circle
onPressfunctionundefinedset the onPress functionality when the component is pressed
innerBorderColorstring"#000"change the inner circle of the component
outerBorderRadiusnumber32change the whole instagram story circle's outer border radius
innerBorderRadiusnumber32change the whole instagram story circle's inner border radius
hasStorybooleanundefinedset true to activate story's colorful ring
storyRingColorstring, string"#feda75", "#d62976"change the ring color
defaultRingColorstring, string"#000", "#000"change the default ring color when hasStory is false
profileImageBorderSizenumber0change the profile image border size
notificationCountnumberundefinedset the notification count
notificationBubbleBackgroundColorcolor"#eb3434"change the notification background color
notificationSizenumber18change the notification circle's size
notificationPositionTopnumberdefaultchange the notification circle's position of the top side
notificationPositionLeftnumberdefaultchange the notification circle's position of the left side
ImageComponentcomponentImageset your own Image component instead of default React Native's Image component

Future Plans

  • LICENSE
  • Write an article about the lib on Medium

Credits

Inspired on Zafer Ayan's Medium Article

Author

FreakyCoder, kurayogun@gmail.com

License

React Native Instagram Story Circle is available under the MIT license. See the LICENSE file for more info.