@vime/core
    TypeScript icon, indicating that this package has built-in type declarations

    5.3.1 • Public • Published

    @vime/core

    Vime is a customizable, extensible, accessible and framework agnostic media player. The @vime/core package contains all the core Vime web components that other packages rely on.

    Examples

    The examples below are using web components but there are bindings for React, Vue, Svelte, Stencil and Angular. If you want to see how they look check out our Demo.

    <vm-player autoplay muted>
      <vm-video poster="/media/poster.png" cross-origin>
        <!-- Why `data-src`? Lazy loading. You can always use `src` if you don't need it. -->
        <source data-src="/media/video.mp4" type="video/mp4" />
        <track
          default
          kind="subtitles"
          src="/media/subs/en.vtt"
          srclang="en"
          label="English"
        />
      </vm-video>
    
      <!-- Loads the default Vime UI. -->
      <vm-default-ui />
    </vm-player>

    Native UI?

    <!-- Here we are requesting to use the native controls. -->
    <vm-player autoplay muted controls>
      <vm-audio cross-origin>
        <source data-src="/media/audio.mp3" type="audio/mp3" />
      </vm-audio>
    </vm-player>

    Custom UI?

    <!-- Lets add a little splash of color throughout the player. -->
    <vm-player autoplay muted style="--vm-player-theme: #1873d3">
      <!-- Loading a YouTube video. -->
      <vm-youtube video-id="DyTCOwB0DVw" />
    
      <vm-ui>
        <vm-click-to-play />
        <vm-captions />
        <vm-poster />
        <vm-spinner />
        <vm-default-settings />
        <vm-controls pin="bottomLeft" active-duration="2750" full-width>
          <!-- 
            These are all predefined controls that you can easily customize. You could also build 
            your own controls completely from scratch.
          -->
          <vm-playback-control tooltip-direction="right" />
          <vm-volume-control />
          <vm-time-progress />
          <vm-control-spacer />
          <vm-caption-control />
          <vm-pip-control keys="p" />
          <vm-settings-control />
          <vm-fullscreen-control keys="f" tooltip-direction="left" />
        </vm-controls>
      </vm-ui>
    </vm-player>

    Related

    Install

    npm i @vime/core

    DownloadsWeekly Downloads

    3,489

    Version

    5.3.1

    License

    MIT

    Unpacked Size

    2.62 MB

    Total Files

    624

    Last publish

    Collaborators

    • mihar-22