1.0.0 • Published 4 months ago

@itswooble/react-native-insta-story v1.0.0

Weekly downloads
-
License
-
Repository
github
Last release
4 months ago

react-native-insta-story

Install

1. Step

npm install react-native-insta-story --save

or

yarn add react-native-insta-story

2. Step

cd ios && pod install

Import

import InstaStory from 'react-native-insta-story';

Props

NameDescriptionTypeDefault Value
dataArray of IUserStory. You can check from interfaces.object
unPressedBorderColorUnpressed border color of profile circlecolorred
pressedBorderColorPressed border color of profile circlecolorgrey
unPressedAvatarTextColorUnpressed avatar text colorcolorred
pressedAvatarTextColorPressed avatar text colorcolorgrey
onStorySeenCalled each time story is seenfunctionnull
onCloseTodo when closefunctionnull
onStartTodo when startfunctionnull
durationPer story duration secondsnumber10
swipeTextText of swipe componentstringSwipe Up
renderSwipeUpComponentRender a custom swipe up componentfunction
renderCloseComponentRender a custom close buttonfunction
renderTextComponentRender custom avatar text componentfunction
avatarSizeSize of avatar circlenumber60
showAvatarTextFor show or hide avatar text.booltrue
avatarTextStyleFor avatar text styleTextStyle
avatarImageStyleFor avatar image styleImageStyle
avatarWrapperStyleFor individual avatar wrapper styleViewStyle
avatarFlatListPropsHorizontal avatar flat list propsFlatListProps
showAvatarFlatListDisplay FlatList with avatarsbooltrue
loadedAnimationBarStyleFor loaded animation bar styleViewStyle
unloadedAnimationBarStyleFor unloaded animation bar styleViewStyle
animationBarContainerStyleFor animation bar container styleViewStyle
storyUserContainerStyleFor story item user container styleViewStyle
storyImageStyleFor story image styleImageStyle
storyAvatarImageStyleFor story avatar image styleImageStyle
storyContainerStyleFor story container styleViewStyle

Ref

NameDescriptionType
openStoryOpen story itemfunction
closeStoryClose story itemfunction

Usage

Basic

import InstaStory from 'react-native-insta-story';

const data = [
  {
    user_id: 1,
    user_image:
      'https://pbs.twimg.com/profile_images/1222140802475773952/61OmyINj.jpg',
    user_name: 'Ahmet Çağlar Durmuş',
    stories: [
      {
        story_id: 1,
        story_image:
          'https://image.freepik.com/free-vector/universe-mobile-wallpaper-with-planets_79603-600.jpg',
        swipeText: 'Custom swipe text for this story',
        onPress: () => console.log('story 1 swiped'),
      },
      {
        story_id: 2,
        story_image:
          'https://image.freepik.com/free-vector/mobile-wallpaper-with-fluid-shapes_79603-601.jpg',
      },
    ],
  },
  {
    user_id: 2,
    user_image:
      'https://images.unsplash.com/photo-1511367461989-f85a21fda167?ixid=MnwxMjA3fDB8MHxzZWFyY2h8Mnx8cHJvZmlsZXxlbnwwfHwwfHw%3D&ixlib=rb-1.2.1&w=1000&q=80',
    user_name: 'Test User',
    stories: [
      {
        story_id: 1,
        story_image:
          'https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcTjORKvjcbMRGYPR3QIs3MofoWkD4wHzRd_eg&usqp=CAU',
        swipeText: 'Custom swipe text for this story',
        onPress: () => console.log('story 1 swiped'),
      },
      {
        story_id: 2,
        story_image:
          'https://files.oyebesmartest.com/uploads/preview/vivo-u20-mobile-wallpaper-full-hd-(1)qm6qyz9v60.jpg',
        swipeText: 'Custom swipe text for this story',
        onPress: () => console.log('story 2 swiped'),
      },
    ],
  },
];

<InstaStory data={data} duration={10} />;

Custom components

The render component functions are all passed item as a prop which is the current IUserStoryItem being displayed.

renderSwipeUpComponent and renderCloseComponent are both passed the onPress prop which is a function that closes the current story item modal and calls the IUserStoryItem.onPress function. onPress is passed so you could add other buttons. This is useful when adding a button which has it's own onPress prop, eg. a share button, next to the close button.

renderTextComponent is passed the profileName of the current story's user.

const data = [...sameDataAsBasicExampleAbove];

const [seenStories, setSeenStories] = useState(new Set());

const updateSeenStories = ({ story: { story_id } }) => {
  setSeenStories((prevSet) => {
    prevSet.add(storyId);
    return prevSet;
  });
};

const handleSeenStories = async (item) => {
  console.log(item);
  const storyIds = [];
  seenStories.forEach((storyId) => {
    if (storyId) storyIds.push(storyId);
  });
  if (storyIds.length > 0) {
    await fetch('myApi', {
      method: 'POST',
      body: JSON.stringify({ storyIds }),
    });
    seenStories.clear();
  }
};

<InstaStory
  data={data}
  duration={10}
  onStart={(item) => console.log(item)}
  onClose={handleSeenStories}
  onStorySeen={updateSeenStories}
  renderCloseComponent={({ item, onPress }) => (
    <View style={{ flexDirection: 'row' }}>
      <Button onPress={shareStory}>Share</Button>
      <Button onPress={onPress}>X</Button>
    </View>
  )}
  renderTextComponent={({ item, profileName }) => (
    <View>
      <Text>{profileName}</Text>
      <Text>{item.customProps?.yourCustomProp}</Text>
    </View>
  )}
  style={{ marginTop: 30 }}
/>;

Ref

const data = [...sameDataAsBasicExampleAbove];

const ref = useRef < StoryInstance > null;

ref.openStory(data[0], 0);

ref.closeStory();

<InstaStory ref={ref} data={data} duration={10} />;