Only - Atomic Layout

Search…
Only
Specification
"Only" component renders its children according to the media query parameters provided to it via props. By default, it integrates with the configured Layout breakpoints, allowing quick breakpoint references.
Props
Prop name
Prop type
Default value
Description
for
string | Object
–
Exact breakpoint name at which to render the children. Has the highest priority whenever provided.
from
string | Object
–
Starting breakpoint at which to render the children. Can be combined with the other props.
to
string | Object
–
Ending breakpoint at which to render the children. Can be combined with the other props.
except
boolean
false
Flag that controls a notch behavior, when set to true. Can be combined with the other props.
Example
Explicit breakpoint
1
import React from 'react'
2
import { Only } from 'atomic-layout'
3
​
4
export const Post = () => (
5
  <article>
6
    {/* Refer to a breakpoint defined in "Layout.configure()" by name */}
7
    <Only for="sm">
8
      <p>Renders on "sm" breakpoint</p>
9
    </Only>
10
    
11
    {/* Or, provide a custom breakpoint object */}
12
    <Only for={{ minWidth: 900, maxWidth: 1000 }}>
13
      <p>Renders on the custom breakpoint</p>
14
    </Only>
15
  </article>
16
)
Copied!
High-pass
High-pass is a display model where the content is shown after a specified breakpoint (incl.).
1
import React from 'react'
2
import { Only } from 'atomic-layout'
3
​
4
export const Post = () => (
5
  <Only from="md">
6
    <p>Doesn't render on xs and sm.</p>
7
  </Only>
8
)
Copied!
Low-pass
Low-pass is a display model where the content is displayed prior to a specified breakpoint.
1
import React from 'react'
2
import { Only } from 'atomic-layout'
3
​
4
export const Post = () => (
5
  <Only to="md">
6
    <p>Doesn't render after md.</p>
7
  </Only>
8
)
Copied!
Bell
Bell is a combination of low-pass and high-pass display models. The content is displayed starting from a certain breakpoint, and displayed prior to a certain breakpoint.
1
import React from 'react'
2
import { Only } from 'atomic-layout'
3
​
4
export const Post = () => (
5
  <Only from="sm" to="lg">
6
    <p>Renders only from "sm" up to "lg" (not including).</p>
7
  </Only>
8
)
Copied!
Notch
Notch is the reversed variant of the Bell behavior: the content is rendered everywhere except the given breakpoints range.
1
import React from 'react'
2
import { Only } from 'atomic-layout'
3
​
4
export const Post = () => (
5
  <Only except from="sm" to="lg">
6
    <p>Renders on xs and xl.</p>
7
  </Only>
8
)
Copied!
Standalone usage
This component can be used independently from any other components of the library.
1
import React from 'react'
2
import { Only } from 'atomic-layout'
3
​
4
export const Post = (props) => (
5
  <article>
6
    <h2>{props.title}</h2>
7
    <p>{props.content}</p>
8
​
9
    <Only to="sm">
10
      <a href={props.shareUrl}>Share on Twitter</a>
11
    </Only>
12
  </article>
13
)
Copied!
Custom breakpoints
Apart from passing defined breakpoint names, you can provide a custom breakpoint Object to the props of this component. The provided breakpoint's options will be used to control the rendering behavior.
1
import { Only } from 'atomic-layout'
2
​
3
export const Post = () => (
4
  <article>
5
    {/* Explicit */}
6
    <Only for={{ maxWidth: 568 }}>
7
      <p>Renders for the given breakpoint</p>
8
    </Only>
9
    
10
    {/* High-pass */}
11
    <Only from={{ minWidth: 792 }}>
12
      <p>Renders stating from the given breakpoint</p>
13
    </Only>
14
    
15
    {/* Low-pass */}
16
    <Only to={{ maxWidth: 500 }}>
17
      <p>Renders prior to the given breakpoint.</p>
18
    </Only>
19
    
20
    {/* Bell */}
21
    <Only from={{ minWidth: 568 }} to={{ maxWidth: 769 }}>
22
      <p>Renders only between the given two breakpoints.</p>
23
    </Only>
24
    
25
    {/* Notch */}
26
    <Only except from={{ minWidth: 568 }} to={{ maxWidth: 769 }}>
27
      <p>Renders everywhere except the given breakpoint range.</p>
28
    </Only>
29
  </article>
30
)
Copied!
Composition
Visible
Last modified 1yr ago
Copy link
Contents