Wondering what’s next for npm?Check out our public roadmap! »

    object-fit-videos

    1.0.4 • Public • Published

    object-fit-videos

    An open-source polyfill for CSS object-fit and object-position on videos. Supports IE9-11, Edge, and Safari <10 (and more?). Does nothing on browsers that support these properties.

    Installation

    $ npm install --save object-fit-videos

    Or yarn!

    $ yarn add object-fit-videos

    Usage

    Include the polyfill in your markup

    <script src="path/to/object-fit-videos/dist/object-fit-videos.min.js"></script>

    Add a special font-family CSS property for targeting IE/Edge or Safari

    video {
      object-fit: cover;
      font-family: 'object-fit: cover;';
    }

    object-position can be used similarly. Note that object-position only supports keyword positioning at this time. That's top, bottom, left, right, and center

    video {
      object-fit: cover;
      object-position: left top;
      font-family: 'object-fit: cover; object-position: left top;';
    }

    Make the JavaScript call to initialize the videos with the special CSS property

    objectFitVideos();

    You can make the call before the closing </body> tag or whenever the DOM is ready. The polyfill will do the rest.

    Polyfilling Specific Elements

    You can also pass elements to the objectFitVideos() function to only polyfill specific videos. A couple examples:

    objectFitVideos(document.querySelectorAll('.videos'));
    objectFitVideos(document.getElementById('vid'));

    So on and so forth.

    Contributions

    Feel free to open Pull Requests, bug reports, feature requests.

    Special thanks to these folks to who have contributed code:

    msorensson
    oncode
    richtr

    License

    Copyright (c) 2016 TricomB2B

    Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

    The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

    Install

    npm i object-fit-videos

    DownloadsWeekly Downloads

    3,479

    Version

    1.0.4

    License

    MIT

    Last publish

    Collaborators

    • avatar