npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

react-stories-gram

v1.0.1

Published

React component like instagram stories. Based on react-insta-stories

Downloads

5

Readme

react-stories-gram

This is a react-insta-stories, but with modified output bundler (ESM)

Why

Because react-insta-stories is not SSR friendly. I tried using my custom react SSR project, the package not work(got document/window undefined error). My I assumption is because their target output library is 'UMD'. That's why I create and modify it and make the output target library to 'ESM' using preconstruct. And it work's for me.

Install

npm install --save react-stories-gram

Usage

import React, { Component } from "react";

import Stories from "react-stories-gram";

class App extends Component {
  render() {
    return (
      <Stories
        stories={stories}
        defaultInterval={1500}
        width={432}
        height={768}
      />
    );
  }
}

const stories = [
  //🆕! Rendering Components instead of video or images can now be done by passing a 'content' property into the story.
  //The props contain properties 'action'(fn) and 'isPaused'(bool)
  {
    content: ({ action, isPaused }) => {
      const handleClick = e => {
        e.preventDefault();
        action(isPaused ? "play" : "pause");
      };
      return (
        <div onClick={handleClick}>
          <h2>Hi</h2>
          <span>{isPaused ? "Paused" : "Playing"}</span>
        </div>
      );
    },
  },
  {
    url: "https://picsum.photos/1080/1920",
    seeMore: ({ close }) => (
      <div style={{ width: "100%", height: "100%" }}>Hello</div>
    ),
    header: {
      heading: "Mohit Karekar",
      subheading: "Posted 5h ago",
      profileImage: "https://picsum.photos/1000/1000",
    },
  },
  {
    url:
      "https://fsa.zobj.net/crop.php?r=dyJ08vhfPsUL3UkJ2aFaLo1LK5lhjA_5o6qEmWe7CW6P4bdk5Se2tYqxc8M3tcgYCwKp0IAyf0cmw9yCmOviFYb5JteeZgYClrug_bvSGgQxKGEUjH9H3s7PS9fQa3rpK3DN3nx-qA-mf6XN",
    header: {
      heading: "Mohit Karekar",
      subheading: "Posted 32m ago",
      profileImage: "https://picsum.photos/1080/1920",
    },
  },
  {
    url:
      "https://media.idownloadblog.com/wp-content/uploads/2016/04/iPhone-wallpaper-abstract-portrait-stars-macinmac.jpg",
    header: {
      heading: "mohitk05/react-insta-stories",
      subheading: "Posted 32m ago",
      profileImage:
        "https://avatars0.githubusercontent.com/u/24852829?s=400&v=4",
    },
  },
  {
    url: "https://storage.googleapis.com/coverr-main/mp4/Footboys.mp4",
    type: "video",
    duration: 1000,
  },
  {
    url:
      "http://commondatastorage.googleapis.com/gtv-videos-bucket/sample/ForBiggerJoyrides.mp4",
    type: "video",
    seeMore: ({ close }) => (
      <div style={{ width: "100%", height: "100%" }}>Hello</div>
    ),
  },
  {
    url:
      "http://commondatastorage.googleapis.com/gtv-videos-bucket/sample/ForBiggerBlazes.mp4",
    type: "video",
  },
  "https://images.unsplash.com/photo-1534856966153-c86d43d53fe0?ixlib=rb-1.2.1&ixid=eyJhcHBfaWQiOjEyMDd9&auto=format&fit=crop&w=564&q=80",
];

Props

| Property | Type | Default | Description | | ----------------- | --------------- | ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | stories | [String/Object] | required | An array of image urls or array of story objects (options described below) | | defaultInterval | Number | 1200 | Milliseconds duration for which a story persists | | loader | Component | Ripple loader | A loader component as a fallback until image loads from url | | header | Component | Default header as in demo | A header component which sits at the top of each story. It receives the header object from the story object. Data for header to be sent with each story object. | | width | Number | 360 | Width of the component in pixels | | height | Number | 640 | Height of the component in pixels | | storyStyles | Object | none | Override the default story styles mentioned below. | | loop | Boolean | false | The last story loop to the first one and restart the stories. | | New props | ⭐️ | ⭐️ | ⭐️ | | isPaused | Boolean | false | Toggle story playing state | | currentIndex | Number | undefined | Set the current story index | | onStoryStart | Function | - | Callback when a story starts | | onStoryEnd | Function | - | Callback when a story ends | | onAllStoriesEnd | Function | - | Callback when all stories in the array have ended |

Story object

Instead of simple string url, a comprehensive 'story object' can also be passed in the stories array.

| Property | Description | | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | url | The url of the resource, be it image or video. | | duration | Optional. Duration for which a story should persist. | | header | Optional. Adds a header on the top. Object with heading, subheading and profileImage properties. | | seeMore | Optional. Adds a see more icon at the bottom of the story. On clicking, opens up this component. (v2: updated to Function instead of element) | | type | Optional. To distinguish a video story. type: 'video' is necessary for a video story. | | styles | Optional. Override the default story styles mentioned below. |

Default story styles

Following are the default story content styles. Override them by providing your own style object with each story or a global override by using the storyStyles prop.

storyContent: {
    width: 'auto',
    maxWidth: '100%',
    maxHeight: '100%',
    margin: 'auto'
}

API

APIs will be deprecated from v2, and will be replaced by props based control. Check out '⭐️ new props' in the props table above.

Following functions can be accessed using the ref of default export, e.g. this.stories.pause()

pause(overrideHideProgress: Boolean)

Pause the currently playing story. Pass true to override the default hiding of progress bars.

play()

Play a paused story.

previous()

Jump to the previous story. Similar to when tapped on left side of the screen.

next()

Jump to the next story. Similar to when tapped on right side of the screen.

toggleSeeMore(show: Boolean)

Show or hide the Show More component. Pass true to show and otherwise.