@opensea/react-media
Advanced tools
Javascript library to deal with media queries in isomorphic React applications.
@opensea/react-media is a Javascript library to deal with media queries in isomorphic React applications.
Its heavily inspired by https://github.com/artsy/fresnel but is compatible with React 18.
npm
npm i @opensea/react-media
yarn
yarn add @opensea/react-media
// media/setup.ts
import { createMedia } from "@opensea/react-media"
const { createMediaStyle, prepareComponents } = createMedia({
sm: 640,
md: 768,
lg: 1024,
xl: 1280,
"2xl": 1536,
container: 1600,
"3xl": 1910,
})
export const mediaStyle = createMediaStyle()
// media/components.ts
import { prepareComponents } from "./setup"
const { Media, SizeProvider, useSizeContextSelector } = prepareComponents()
export { Media, SizeProvider, useSizeContextSelector }
// ComponentX.react.tsx
import { Media } from "./media/components"
export function ComponentX() {
return <Media greaterThan="md">Render if greater than md</Media>
}
// __app.tsx
import React from "react"
import { SizeProvider } from "./media/components"
import type { AppProps } from "next/app"
export default function App({ Component, pageProps }: AppProps) {
return (
<SizeProvider>
<Component {...pageProps} />
</SizeProvider>
)
}
// _document.tsx
import { Html, Head, Main, NextScript } from "next/document"
import { mediaStyles } from "./media/setup"
export default function Document() {
return (
<Html>
<Head>
<style
dangerouslySetInnerHTML={{ __html: mediaStyles }}
type="text/css"
/>
</Head>
<body>
<Main />
<NextScript />
</body>
</Html>
)
}
// client-providers.tsx
"use client"
import { SizeProvider } from "./media/components"
export function ClientProviders(props: { children: React.ReactNode }) {
return <SizeProvider>{props.children}</SizeProvider>
}
// layout.tsx
import { ClientProviders } from "./client-providers"
import { mediaStyles } from "./media/setup"
export default function RootLayout({
children,
}: {
children: React.ReactNode
}) {
return (
<html lang="en">
<head>
<style
dangerouslySetInnerHTML={{ __html: mediaStyles }}
type="text/css"
/>
</head>
<body>
<ClientProviders>{children}</ClientProviders>
</body>
</html>
)
}
Note: useSizeContextSelector hook relies on the window width/height which is not accessible on the server.
As such its not suitable for rendering content based on it as it will lead to server-client miss-matches.
// ComponentX.react.tsx
import { breakpoints } from "./media/setup"
import { useSizeContextSelector } from "./media/components"
const useIsLessThanLg = () => {
return useSizeContextSelector(value => value.width < breakpoints.lg)
}
export function ComponentX() {
const isLessThanLg = useIsLessThanLg()
return (
<button
onClick={() => {
if (isLessThanLg) {
console.log("less than lg")
} else {
console.log("not less than lg")
}
}}
>
Click me
</button>
)
}
FAQs
Javascript library to deal with media queries in isomorphic React applications.
The npm package @opensea/react-media receives a total of 190 weekly downloads. As such, @opensea/react-media popularity was classified as not popular.
We found that @opensea/react-media demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 10 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Biden's executive order pushes for AI-driven cybersecurity, software supply chain transparency, and stronger protections for federal and open source systems.
Security News
Fluent Assertions is facing backlash after dropping the Apache license for a commercial model, leaving users blindsided and questioning contributor rights.
Research
Security News
Socket researchers uncover the risks of a malicious Python package targeting Discord developers.