Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/react-container-query/react-container-query
:package: Modular responsive component
https://github.com/react-container-query/react-container-query
browser container-queries element-queries react responsive responsive-layout
Last synced: 13 days ago
JSON representation
:package: Modular responsive component
- Host: GitHub
- URL: https://github.com/react-container-query/react-container-query
- Owner: react-container-query
- License: mit
- Created: 2015-12-22T01:40:14.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2023-09-14T19:07:39.000Z (about 1 year ago)
- Last Synced: 2024-05-20T10:15:07.590Z (6 months ago)
- Topics: browser, container-queries, element-queries, react, responsive, responsive-layout
- Language: JavaScript
- Homepage: http://react-container-query.github.io/react-container-query/
- Size: 3.73 MB
- Stars: 886
- Watchers: 13
- Forks: 46
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- awesomeLibrary - react-container-query - 📦 Modular responsive component (语言资源库 / JavaScript)
- best-of-react - GitHub - 32% open · ⏱️ 14.09.2023): (Styling)
README
# React Container Query
**True modularity in styling responsive component.**
[](https://badge.fury.io/js/react-container-query)
[](https://circleci.com/gh/react-container-query/react-container-query/tree/master)
[](https://saucelabs.com/beta/builds/de7d8039f4e5417399ec27c39036c1b8)
[](https://codecov.io/gh/react-container-query/react-container-query)
[](https://saucelabs.com/beta/builds/de7d8039f4e5417399ec27c39036c1b8)
## Installation
```sh
npm i -D react-container-query
```
## Disclaimer
This code in this repository is provided under an open source license. It's provided by the individuals who contribute to the project in their personal capacity, not by any of their employers.
## API
### useContainerQuery(query, initialSize?)
> Compare the hook style code with the original example from https://github.com/react-container-query/react-container-query#containerquery-queryquery-initialsizewidth-height
#### Hook Example 1 - Queries against a native DOM element as the container
- Native DOM element refers to `div`, `span`, etc.
```jsx
import React from 'react';
import { useContainerQuery } from 'react-container-query';
const query = {
'width-between-400-and-599': {
minWidth: 400,
maxWidth: 599,
},
'width-larger-than-600': {
minWidth: 600,
},
};
const MyComponent = () => {
const [params, containerRef] = useContainerQuery(query);
return
the box;
};
```
#### Hook Example 2 - Usage for a React component as the container - React.forwardRef
- If the container element we want to measure is a React component, and since we can't measure the size of React component itself, we can use `React.forwardRef`.
- The container React component must then forward the `ref` and set it on the actual native DOM element it renders (e.g, `div`, `span`, etc) - as seen in th example below
```jsx
import React from 'react';
import { useContainerQuery } from 'react-container-query';
const query = {
'width-between-400-and-599': {
minWidth: 400,
maxWidth: 599,
},
'width-larger-than-600': {
minWidth: 600,
},
};
const MyCustomWrapper = React.forwardRef((props, ref) => {
// MyCustomWrapper really renders a div which wraps the children.
// Setting the ref on it allows container query to measure its size.
return
{props.children}
});
const MyComponent = () => {
const [params, containerRef] = useContainerQuery(query);
return the box;
};
```
- In this example, `` would forward the `containerRef` and set it on the `div` element it is using to wrap the children.
### ``
```jsx
import React, {Component} from 'react';
import {render} from 'react-dom';
import {ContainerQuery} from 'react-container-query';
import classnames from 'classnames';
const query = {
'width-between-400-and-599': {
minWidth: 400,
maxWidth: 599
},
'width-larger-than-600': {
minWidth: 600,
}
};
function MyComponent() {
/**
* `params` in the children function will look like
* {
* 'width-between-400-and-599': true,
* 'width-larger-than-600': false
* }
*/
return (
{(params) => (
the box
)}
);
};
/**
* This will generate following HTML:
*
*/
render(, document.getElementById('app'));
```
#### properties
- `props.children`
Must be a function to return a single or an array of React elements. The function will be invoked with `params`, which is a key-value pair where keys are class names, values are booleans to indicate if that class name's constraints are all satisfied.
- `props.query`
"query" is key-value pairs where keys are the class names that will be applied to container element when all constraints are met. The values are the constraints.
- `props.initialSize?` (optional)
`initialSize` is an object with optional `width` or `height` property. Because the limitation on how size is computed based on underlying element, in the initial rendering pass, we don't have the size info (because element must be in the DOM have a valid size). At this time `initialSize` will be used as the size of the element.
### `applyContainerQuery(Component, query, initialSize?) -> ReactComponent`
```jsx
import React, {Component} from 'react';
import {render} from 'react-dom';
import {applyContainerQuery} from 'react-container-query';
import classnames from 'classnames';
const query = {
'width-between-400-and-599': {
minWidth: 400,
maxWidth: 599
},
'width-larger-than-600': {
minWidth: 600,
}
};
class Container extends Component {
render() {
/**
* `this.props.containerQuery` will look like
* {
* 'width-between-400-and-599': true,
* 'width-larger-than-600': false
* }
*/
return
the box;
}
}
const App = applyContainerQuery(Container, query)
/**
* This will generate following HTML:
*
*/
render(, document.getElementById('app'));
```
This is a very similar to ``, except it's higher order component style. You don't have to use them together.
## Why
Modularity is the heart of component based UI. With most JavaScript modularized, CSS failed to catch up. When developing a responsive web page, we use media queries to toggle styles based on the size of the viewport. This creates problems when creating component level styles. The same component will behave differently when it is placed in different locations on a page. It seriously breaks the modularity of a component. We need components to be responsive and independent of viewport sizes.
## What is container query
Container query is a work in process CSS feature. "Container queries allow an author to control styling based on the size of a containing element rather than the size of the user’s viewport." (from [Container Query](http://responsiveimagescg.github.io/container-queries/)). [Container Queries: Once More Unto the Breach](http://alistapart.com/article/container-queries-once-more-unto-the-breach) is the inspiration of this repo.
With below CSS, `.box` will be blue when `.container` is wider than 600px, green when width between 400px and 599px, and red for the rest of time.
```css
.box {
background-color: red;
}
.container:media(min-width: 400px) {
.box {
background-color: green;
}
}
.container:media(min-width: 600px) {
.box {
background-color: blue;
}
}
```
_Note: This library does *not* provide these CSS features._
## Demo
Checkout CodePen
- Adjustable Sidebar http://codepen.io/daiweilu/pen/wMrrZM
- Responsive Component Layout https://codepen.io/daiweilu/pen/EXWRqx
You can also check out [examples directory](./examples).
## Performance
react-container-query is using [element-resize-detector](https://www.npmjs.com/package/element-resize-detector) in mainstream browsers and [ResizeObserver](https://developers.google.com/web/updates/2016/10/resizeobserver) in cutting edge browsers. It's completely event based, so no excessive code runs if no changes on element sizes.