responsive-height v1.1.1
Responsive height
A javaScript plugin to dynamically resize elements or their children to the max height based on the number of columns required at a specific breakpoint.
Installing
With npm / yarn / webpack
npm install responsive-height
# or
yarn add responsive-heightThen import it like so:
import ResponsiveHeight from 'responsive-height';
const container = document.querySelector('.container');
const controller = new ResponsiveHeight(container);Settings
| Option | Default | Details | ||
|---|---|---|---|---|
| delay (int) | 200 | Delay between resize of the screen and the recalculation of the required heights. This can be set to 0 and no delay will be factored in. | ||
| child (string) | null | Selector for the child element to be found inside the main selector. If this is set the height will be calculated and set to this element instead of the parent. However the parent will be used for calculating columns. | ||
| global (boolean) | false | If global is set to true it will ignore the widths option and set all elements (or their children) to the same height. | ||
| exclude_get *(selector | element | nodeList)* | null | Setting Exclude get with a css query selector, element or nodeList will stop the element (or child element if specified) from having their heights factor into the heights of the other elements in its row. If using child elements exclusions will be applied based on the child. |
| exclude_set *(selector | element | nodeList)* | null | Setting Exclude set with a css query selector, element or nodeList will stop the element (or child element if specified) from having its height set. If using child elements exclusions will be applied based on the child. |
| widths (array) | empty Array | A multi dimensional array of pixel widths and columns starting from the heights to lowest. This checks if the size is greater than a size, if so it sets the columns. | ||
| before_init (function) | null | Callback function called before initialisation. | ||
| after_init (function) | null | Callback function called after initialisation has finished. | ||
| before_resize (function) | null | Callback function called before resize starts. | ||
| after_resize (function) | null | Callback function called after resize has finished. | ||
| after_destroy (function) | null | Callback function called after destroy method is called. |
Methods
| Method | Details |
|---|---|
| refresh | Immediately trigger a recalculation of the heights for all elements based off the existing settings. |
| collect | Recollect the elements that will be resized, to be run after adding new items. This will not trigger a refresh of the sizes. |
| destroy | Removes the heights off all elements or their children and stops further processing. |
| init | Re initialises the plugin causing an immediate refresh and re binding the resizing of the window to trigger further refreshes. |
Example usage
Here you can see how a simple call for this function runs. This will set the heights of every element with a desc class found inside every child element of the container.
import ResponsiveHeight from 'responsive-height';
const container = document.querySelector('.container');
const controller = new ResponsiveHeight(container, {
child: '.desc',
widths: [
[1200, 8],
[768, 4],
[0, 1]
]
});<div class="container">
...
<div>
<p class="desc">Large block of text of varying height that we want to keep the same height</p>
<span>Some text we want to stick to the bottom</span>
</div>
...
</div>If you then updated the size of some of the content you could then trigger a recalculation of the heights.
container.children[0].querySelector('.desc').innerHTML = 'Changed the text';
controller.update();If necessary some options can be updated by modifying the objects property of the class directly. If you need to change the child or container you must also trigger the init method for this to recollect the elements. The destroy function should also be called first to unset the heights and remove the watcher on the existing elements in this instance.
So if you wanted to stop resizing based on children you could do the following
container.options.child = null;
controller.destroy();
controller.init();TODO
- Setup container to handle multiple elements at once
Credits
Chris Morris https://github.com/codecomp