Naughty Platypus Memorabilia

    @gugadev/wc-stories

    1.0.0 • Public • Published

    wc 🌐 stories

    Instagram/Whatsapp stories like built on Web Components and Web Animations API.


    Demos


    Vanilla JS

    Angular

    React

    Vue
    Link Link Link Link

    Browser support

    IE / Edge
    IE / Edge
    Firefox
    Firefox
    Chrome
    Chrome
    Safari
    Safari
    Opera
    Opera
    IE11, Edge last 10 versions last 10 versions last 10 versions last 10 versions

    📦 Install

    npm i @gugadev/wc-stories

    💡 What's the prupose of it?

    Just fun 🙂. I love learn and code, so, this every time I have free time, pick some crazy idea or got inspiration from another projects and make it. 😋

    🦄 Inspiration

    When I saw the project of Mohit, react-insta-stories, immediately wanted to know how complicated it would be to do the same thing using Web Components. So, I built this. Thanks, Mohit! 😃

    ⚙️ How it works?

    There are three components working together:

    • <wc-stories-story>: this component shows a image. The maximun size of an image is the containers viewport.
    • <wc-stories-progress>: this component shows the progress bar at top the the container. It uses Web Animations API to run it. If we change of image (clicking on left/right), the previous animation is cancelled.
    • <wc-stories>: this is the main component. This one harbor the two components above. Here is the logic for control which image should be revealed, what happen if the user clicks on left or right side, etc.

    🚀 How to run?

    After install depenencies, you just need to run yarn start. Once the server was started, go to localhost:4444 and see it in action.

    🛠️ How to build?

    Execute the yarn build command to compile the source code and get the ES5 equivalent. Compiled code will be available on dist/ folder.

    🙋 How to use it in my web/app?

    First, we need to add the needed polyfills:

    • @webcomponents/webcomponentsjs/custom-elements-es5-adapter.js
    • @webcomponents/webcomponentsjs/webcomponents-loader.js.
    • web-animations-js/web-animations.min.js

    Web Components/Vanilla JavaScript

    If you're using Web Components or vanilla JavaScript, just put the wc-stories tag inside your HTML and pass it the array of images:

    <wc-stories height="480" width="320" withShadow>
      <wc-stories-story src="/img/01.jpg"></wc-stories-story>
      <wc-stories-story src="/img/02.jpg"></wc-stories-story>
      <wc-stories-story src="/img/03.jpg"></wc-stories-story>
      <wc-stories-story src="/img/04.jpg"></wc-stories-story>
      <wc-stories-story src="/img/05.jpg"></wc-stories-story>
    </wc-stories>

    React

    If you're using React, use the component as is. Instead of passing raw values you can use state to store the component configuration:

    export class MyComponent extends React.Component {
      this.state = {
        width: 320,
        height: 480,
        withShadow: true,
        stories: [
          '/path/to/image',
          '/path/to/image',
          '/path/to/image',
          ...
        ]
      }
      render() {
        return (
          <wc-stories
            width={this.state.height}
            height={this.state.width}
            withShadow={this.state.withShadow}
          >
          {
            this.state.stories.map(story => (
              <wc-stories-story src={story} />
            ))
          }
          </wc-stories>
        )
      }
    }

    Angular

    If you're using Angular, put the component inside your template. Like React, you can put the configuration inside the controller instead passing raw values:

    <template>
      ...
      <wc-stories [width]="storiesWidth" [height]="storiesHeight" withShadow>
        <wc-stories-story *ngFor="let story of stories" [src]="story">
        </wc-stories-story>
      </wc-stories>
    </template>
    @Component({
      ...
    })
    class MyComponent implements OnInit {
     
      ngOnInit() {
        stories = [
          '/path/to/image',
          '/path/to/image',
          '/path/to/image',
          ...
        ]
      }
    }

    Vue

    If you're using Vue, put the component inside your template. Like React, you can put the configuration inside the controller instead passing raw values:

    <wc-stories :width="storiesWidth" :height="storiesHeigh" :withShadow="withShadow">
      <wc-stories-story v-if="story of stories" :src="story"></wc-stories>
    </wc-stories>
    export default {
      data: () => ({
        width: 320,
        height: 480,
        withShadow: tre,
        stories: [
          '/path/to/image',
          '/path/to/image',
          '/path/to/image',
          ...
        ]
      })
    }

    🆕 Lazy Loading

    There are several ways to lazy loading images like Low quality image placeholders and progressive images. This feature relies on the first one, so, in order to enable it, you need to pass, along with the images, the placeholders too.

    Tip: you can generate lightweight svg LQIP from high resolution images using sqip.

    <wc-stories height="667" width="375" withShadow>
      <wc-stories-story src="img/01.jpg" placeholder="img/01.ph.svg"></wc-stories-story>
      <wc-stories-story src="img/02.jpg" placeholder="img/02.ph.svg"></wc-stories-story>
      <wc-stories-story src="img/03.jpg" placeholder="img/03.ph.svg"></wc-stories-story>
      <wc-stories-story src="img/04.jpg" placeholder="img/04.ph.svg"></wc-stories-story>
      <wc-stories-story src="img/05.jpg" placeholder="img/05.ph.svg"></wc-stories-story>
    </wc-stories>

    🚧 Roadmap

    • Implement Typescript
    • Implement PostCSS.
    • Make builds with Webpack.
    • Compile down to ES5.
    • Control animation's flow.
    • Orientation device support.
    • Add mobile swipe support.
    • Add more transition effects.
    • Add lazy loading support.
    • Improve suite case.
    • Add demo page.
    • Publish the package to npm.

    🙌 Contribute

    If you found this project interesting, I'm glade to receive updates, new features or fixes 🙂. Just fork the project, create your branch, make your changes and send your Pull Request! 😃

    📖 API

    <wc-stories>

    • radius <number>:: border radius. Default: 0.
    • startAt <number>: initial image index to show. Default: 0.
    • duration <number>: visibility time of images and animation.
    • height <number>: self-explanatory.
    • width <number>: self-explanatory.
    • withShadow <boolean>: enable or disable drop shadow.

    <wc-stories-story>

    • src: image relative or absolute URL
    • placeholder: an image URL or a base64 string.

    Keywords

    none

    Install

    npm i @gugadev/wc-stories

    DownloadsWeekly Downloads

    10

    Version

    1.0.0

    License

    MIT

    Unpacked Size

    252 kB

    Total Files

    4

    Last publish

    Collaborators

    • gugadev