Skip to content

Instantly share code, notes, and snippets.

@gragland gragland/use-media.jsx
Last active Aug 2, 2019

Embed
What would you like to do?
import { useState, useEffect } from 'react';
function App() {
const columnCount = useMedia(
// Media queries
['(min-width: 1500px)', '(min-width: 1000px)', '(min-width: 600px)'],
// Column counts (relates to above media queries by array index)
[5, 4, 3],
// Default column count
2
);
// Create array of column heights (start at 0)
let columnHeights = new Array(columnCount).fill(0);
// Create array of arrays that will hold each column's items
let columns = new Array(columnCount).fill().map(() => []);
data.forEach(item => {
// Get index of shortest column
const shortColumnIndex = columnHeights.indexOf(Math.min(...columnHeights));
// Add item
columns[shortColumnIndex].push(item);
// Update height
columnHeights[shortColumnIndex] += item.height;
});
// Render columns and items
return (
<div className="App">
<div className="columns is-mobile">
{columns.map(column => (
<div className="column">
{column.map(item => (
<div
className="image-container"
style={{
// Size image container to aspect ratio of image
paddingTop: (item.height / item.width) * 100 + '%'
}}
>
<img src={item.image} alt="" />
</div>
))}
</div>
))}
</div>
</div>
);
}
// Hook
function useMedia(queries, values, defaultValue) {
// State update function
const match = () => {
// Get first media query that matches
const query = queries.findIndex(q => matchMedia(q).matches);
// Return related value or defaultValue if none
return values[query] || defaultValue;
};
// State and setter for current value
const [value, set] = useState(match);
useEffect(() => {
// Update state on window resize
// Usage of match function defined outside of useEffect ...
// ... ensures that it has current values of arguments.
const handler = () => set(match);
window.addEventListener('resize', handler);
// Remove event listener on cleanup
return () => window.removeEventListener('resize', handler);
}, []); // Empty array ensures effect is only run on mount and unmount
return value;
}
@ostgals

This comment has been minimized.

Copy link

ostgals commented Jan 25, 2019

I see two possible optimizations.

The first one allows to avoid unneed rerender each time the 'resize' event is fired by calling set only if value actually changed.
And the second will save some computations and memory allocation expences by memoizing matchMedia calls (matchMedia returns an instance of MediaQueryList which can be reused between renders).

Optimized sandbox: https://codesandbox.io/s/1vn230242l

@gragland

This comment has been minimized.

Copy link
Owner Author

gragland commented Feb 11, 2019

@ostgals Thanks for the tips! I've actually changed this hook quite a bit. It now supports any media query, not just screen width. I think as a result the issues you pointed out are resolved, but let me know if any other suggestions (or issues with updated hook).

@rluiten

This comment has been minimized.

Copy link

rluiten commented Mar 1, 2019

This is a question about the styling, it seems to me it could be a bit simpler. I do not know how you arrived at this solution and it may be an artifact of a previous version, or maybe it behaves differently in some scenario I am not conscious of.

I noticed if I remove the inline style on .image-container (remove the padding-top) then remove all the styles for .image-container except leaving only margin-bottom it seems to be equivalent. Is this so?

Noticed something else trivial I believe the two identifiers columnHeights, and columns can be made const.

By the way love your https://usehooks.com/ site

@gragland

This comment has been minimized.

Copy link
Owner Author

gragland commented Mar 27, 2019

@rluiten Yeah the stying is probably weird. Probably left-over from original source code I copied at https://codesandbox.io/s/26mjowzpr?from-embed. Generally, I just try to get the styling done as quickly as possible since the main focus is on the React hook recipe.. so don't go pushing my styling right to production :)

And glad you're liking the site!

@cbrannen9a

This comment has been minimized.

Copy link

cbrannen9a commented Apr 30, 2019

The eslint exhaustive-deps rules have issues with useEffect not using dependencies think the below resolves that, does require use of useCallback hook as well now, hope this helps:

`

function useMedia(queries, values, defaultValue) {
// Array containing a media query list for each query
const mediaQueryLists = queries.map(q => window.matchMedia(q));

// Function that gets value based on matching media query
const getValue = useCallback(() => {
    // Get index of first media query that matches
    const index = mediaQueryLists.findIndex(mql => mql.matches);
    // Return related value or defaultValue if none
    return typeof values[index] !== 'undefined'
        ? values[index]
        : defaultValue;
}, [values, defaultValue, mediaQueryLists]);

// State and setter for matched value
const [value, setValue] = useState(getValue);

useEffect(() => {
    // Event listener callback
    // Note: By defining getValue outside of useEffect we ensure that it has ...
    // ... current values of hook args (as this hook callback is created once on mount).
    const handler = () => setValue(getValue);
    // Set a listener for each media query with above handler as callback.
    mediaQueryLists.forEach(mql => mql.addListener(handler));
    // Remove listeners on cleanup
    return () =>
        mediaQueryLists.forEach(mql => mql.removeListener(handler));
}, [getValue, mediaQueryLists]);

return value;

}

`

@NateRadebaugh

This comment has been minimized.

Copy link

NateRadebaugh commented May 2, 2019

Why does this not use useLayoutEffect since it is likely based on layout changes?

@shuhei

This comment has been minimized.

Copy link

shuhei commented Jul 17, 2019

I think the following comment is not true. The useEffect's callback captures the getValue on mount, which holds hook args on mount.

    // Note: By defining getValue outside of useEffect we ensure that it has ...
    // ... current values of hook args (as this hook callback is created once on mount).
@AleVul

This comment has been minimized.

Copy link

AleVul commented Aug 2, 2019

this hooks crashes node process if the component is server side rendered, i propose to check window object to avoid that:
const mediaQueryLists = typeof window !== "undefined" ? queries.map(q => window.matchMedia(q)) : [];

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.