0.1.3 • Published 4 years ago

@nutriot/responsive-ratio v0.1.3

Weekly downloads
-
License
MIT
Repository
github
Last release
4 years ago

@nutriot/responsive-ratio

Library to adjust iFrame aspect-ratios reponsively, written in TypeScript

npm npm CircleCI

Installation

npm install --save @nutriot/responsive-ratio

Usage

Import and initialize the module

import { responsiveRatio } from '@nutriot/responsive-ratio';

window.addEventListener('DOMContentLoaded', event => {
  const options = {
    selectors: 'iframe, video'
  };

  responsiveRatio(options);
});

Here's another example for a React application

import React, { useEffect} from 'react'
import { responsiveRatio} from '@nutriot/responsive-ratio';

export default const App = props => {

  useEffect(() => responsiveRatio(), []);

  return (
    <iframe
      src="https://www.youtube.com/embed/-QFS_VPcbjI"
      width="1920"
      height="1080"
    />
  )
}

Options

injectStyles

Type: boolean
Default: true

Specifies whether to inject default styles

selectors

Type: string
Default: iframe

CSS selector for elements that should be resized

wrapperClass

Type: string
Default: responsive-ratio

Specifies the wrapper elements default class name

License

This work is licensed under The MIT License