fluidvids.js
Fluidvids is a 1KB standalone module that provides a fluid solution for video embeds. Fluidvids has the ability for custom players to be added as well as support for dynamically injected (XHR/Ajax/createElement) videos.
- Polymer.js Web Component version
- React.js component version
- WordPress plugin version
Methods
init()
Pass in your configuration. That's it.
fluidvids.init({ selector: ['iframe', 'object'], // runs querySelectorAll() players: ['www.youtube.com', 'player.vimeo.com'] // players to support });
selector
Type: Array
Default: ['iframe']
Custom selector(s) that fluidvids
will search for in the DOM and make fluid.
players
Type: Array
Default: ['www.youtube.com', 'player.vimeo.com']
Internally constructs a strict RegExp
which tells fluidvids
which videos from specific domains to make fluid. This avoids any unwanted videos being parsed and adds developer flexibility.
render()
Provides dynamic video support. Using render()
should only be done when you want to requery the DOM and look for newly added videos, such as document.createElement('iframe');
. Fluidvids uses internal object caching to lookup init()
configuration, so it's lightning fast.
// run after dynamic elements have been injected // you'll need to run this each time you need it fluidvids.render();
Installing with Bower
Use the repository hook:
bower install https://github.com/toddmotto/fluidvids.git
browserify
Installing withUse the repository hook:
npm install toddmotto/fluidvids
Then require fluidvids
in your file:
// Note that it is called as a function var fluidvids = require('fluidvids.js')();
Manual installation
Ensure you're using the files from the dist
directory (contains compiled production-ready code). Ensure you place the script before the closing </body>
tag.
<body> <!-- html above --> <script src="dist/fluidvids.js"></script> <script> // fluidvids module available </script> </body>
Contributing
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.
Release history
- 2.4.1
- Fix bug for class names already existing on host element
- Update Jasmine test accordingly
- 2.4.0
- Fix bug for comparing width/height attrs
> 1000
- Finish all unit tests
- Move to Gulp
- Fix bug for comparing width/height attrs
- 2.3.0
- Add support for videos where
height > width
- Multiple
selector
support and CSS change to unrestrict element type - Add
npm
entry point - Change
apply()
torender()
for better naming - Use while loop for and improved loop perf
- Add support for videos where
- 2.2.0
- XHR/Ajax content support via new
apply()
method to requery DOM - Add AMD support
- XHR/Ajax content support via new
- 2.1.0
- Fix IE8 bug
- 2.0.0
- Complete rewrite using Module pattern with public methods
- Better ability to add custom players
- Add a custom selector
- 1.2.0
- Make use of Prototypes
- 1.1.0
- Better structure
- 1.0.0
- Initial release