--- title: Passing Data Deeply with Context --- Usually, you will pass information from a parent component to a child component via props. But passing props can become verbose and inconvenient if you have to pass them through many components in the middle, or if many components in your app need the same information. Context lets the parent component make some information available to any component in the tree below it—no matter how deep—without passing it explicitly through props. - What "prop drilling" is - How to replace repetitive prop passing with context - What are the common use cases for context - What are the common alternatives to context ## The problem with passing props {/*the-problem-with-passing-props*/} [Passing props](/learn/passing-props-to-a-component) is a great way to explicitly pipe data through your UI tree to the components that use it. But it can become verbose and inconvenient when you need to pass some prop deeply through the tree, or if many components need the same prop. The nearest common ancestor could be far removed from the components that need data, and [lifting state up](/learn/sharing-state-between-components) that high can lead to a situation sometimes called "prop drilling." Lifting state up vs prop drilling Wouldn't it be great if there were a way to "teleport" data to the components in the tree that need it without passing props? With React's context feature, there is! ## Context: an alternative to passing props {/*context-an-alternative-to-passing-props*/} Context lets a parent component provide data to the entire tree below it. There are many uses for context. Here is one example. Consider this `Heading` component that accepts a `level` for its size: ```js import Heading from './Heading.js'; import Section from './Section.js'; export default function Page() { return (
Title Heading Sub-heading Sub-sub-heading Sub-sub-sub-heading Sub-sub-sub-sub-heading
); } ``` ```js Section.js export default function Section({ children }) { return (
{children}
); } ``` ```js Heading.js export default function Heading({ level, children }) { switch (level) { case 1: return

{children}

; case 2: return

{children}

; case 3: return

{children}

; case 4: return

{children}

; case 5: return
{children}
; case 6: return
{children}
; default: throw Error('Unknown level: ' + level); } } ``` ```css .section { padding: 10px; margin: 5px; border-radius: 5px; border: 1px solid #aaa; } ```
Let's say you want multiple headers within the same `Section` to always have the same size: ```js import Heading from './Heading.js'; import Section from './Section.js'; export default function Page() { return (
Title
Heading Heading Heading
Sub-heading Sub-heading Sub-heading
Sub-sub-heading Sub-sub-heading Sub-sub-heading
); } ``` ```js Section.js export default function Section({ children }) { return (
{children}
); } ``` ```js Heading.js export default function Heading({ level, children }) { switch (level) { case 1: return

{children}

; case 2: return

{children}

; case 3: return

{children}

; case 4: return

{children}

; case 5: return
{children}
; case 6: return
{children}
; default: throw Error('Unknown level: ' + level); } } ``` ```css .section { padding: 10px; margin: 5px; border-radius: 5px; border: 1px solid #aaa; } ```
Currently, you pass the `level` prop to each `` separately: ```js
About Photos Videos
``` It would be nice if you could pass the `level` prop to the `
` component instead and remove it from the ``. This way you could enforce that all headings in the same section have the same size: ```js
About Photos Videos
``` But how can the `` component know the level of its closest `
`? **That would require some way for a child to "ask" for data from somewhere above in the tree.** You can't do it with props alone. This is where context comes into play. You will do it in three steps: 1. **Create** a context. (You can call it `LevelContext`, since it's for the heading level.) 2. **Use** that context from the component that needs the data. (`Header` will use `LevelContext`.) 3. **Provide** that context from the component that specifies the data. (`Section` will provide `LevelContext`.) Context lets a parent--even a distant one!--provide some data to the entire tree inside of it. Context provides data to the entire tree ### Step 1: Create the context {/*step-1-create-the-context*/} First, you need to create the context. You'll need to **export it from a file** so that your components can use it: ```js import Heading from './Heading.js'; import Section from './Section.js'; export default function Page() { return (
Title
Heading Heading Heading
Sub-heading Sub-heading Sub-heading
Sub-sub-heading Sub-sub-heading Sub-sub-heading
); } ``` ```js Section.js export default function Section({ children }) { return (
{children}
); } ``` ```js Heading.js export default function Heading({ level, children }) { switch (level) { case 1: return

{children}

; case 2: return

{children}

; case 3: return

{children}

; case 4: return

{children}

; case 5: return
{children}
; case 6: return
{children}
; default: throw Error('Unknown level: ' + level); } } ``` ```js LevelContext.js active import { createContext } from 'react'; export const LevelContext = createContext(1); ``` ```css .section { padding: 10px; margin: 5px; border-radius: 5px; border: 1px solid #aaa; } ```
The only argument to `createContext` is the _default_ value. Here, `1` refers to the biggest heading level, but you could pass any kind of value (even an object). You will see the significance of the default value in the next step. ### Step 2: Use the context {/*step-2-use-the-context*/} Import the `useContext` Hook from React and your context: ```js import { useContext } from 'react'; import { LevelContext } from './LevelContext.js'; ``` Currently, the `Heading` component reads `level` from props: ```js export default function Heading({ level, children }) { // ... } ``` Instead, remove the `level` prop and read the value from the context you just imported, `LevelContext`: ```js {2} export default function Heading({ children }) { const level = useContext(LevelContext); // ... } ``` `useContext` is a Hook. Just like `useState` and `useReducer`, you can only call a Hook at the top level of a React component. **`useContext` tells React that the `Heading` component wants to read the `LevelContext`.** Now that the `Heading` component doesn't have a `level` prop, you don't need to pass the level prop to `Heading` in your JSX like this anymore: ```js
Sub-sub-heading Sub-sub-heading Sub-sub-heading
``` Update the JSX so that it's the `Section` that receives it instead: ```jsx
Sub-sub-heading Sub-sub-heading Sub-sub-heading
``` As a reminder, this is the markup that you were trying to get working: ```js import Heading from './Heading.js'; import Section from './Section.js'; export default function Page() { return (
Title
Heading Heading Heading
Sub-heading Sub-heading Sub-heading
Sub-sub-heading Sub-sub-heading Sub-sub-heading
); } ``` ```js Section.js export default function Section({ children }) { return (
{children}
); } ``` ```js Heading.js import { useContext } from 'react'; import { LevelContext } from './LevelContext.js'; export default function Heading({ children }) { const level = useContext(LevelContext); switch (level) { case 1: return

{children}

; case 2: return

{children}

; case 3: return

{children}

; case 4: return

{children}

; case 5: return
{children}
; case 6: return
{children}
; default: throw Error('Unknown level: ' + level); } } ``` ```js LevelContext.js import { createContext } from 'react'; export const LevelContext = createContext(1); ``` ```css .section { padding: 10px; margin: 5px; border-radius: 5px; border: 1px solid #aaa; } ```
Notice this example doesn't quite work, yet! All the headers have the same size because **even though you're *using* the context, you have not *provided* it yet.** React doesn't know where to get it! If you don't provide the context, React will use the default value you've specified in the previous step. In this example, you specified `1` as the argument to `createContext`, so `useContext(LevelContext)` returns `1`, setting all those headings to `

`. Let's fix this problem by having each `Section` provide its own context. ### Step 3: Provide the context {/*step-3-provide-the-context*/} The `Section` component currently renders its children: ```js export default function Section({ children }) { return (
{children}
); } ``` **Wrap them with a context provider** to provide the `LevelContext` to them: ```js {1,6,8} import { LevelContext } from './LevelContext.js'; export default function Section({ level, children }) { return (
{children}
); } ``` This tells React: "if any component inside this `
` asks for `LevelContext`, give them this `level`." The component will use the value of the nearest `` in the UI tree above it. ```js import Heading from './Heading.js'; import Section from './Section.js'; export default function Page() { return (
Title
Heading Heading Heading
Sub-heading Sub-heading Sub-heading
Sub-sub-heading Sub-sub-heading Sub-sub-heading
); } ``` ```js Section.js import { LevelContext } from './LevelContext.js'; export default function Section({ level, children }) { return (
{children}
); } ``` ```js Heading.js import { useContext } from 'react'; import { LevelContext } from './LevelContext.js'; export default function Heading({ children }) { const level = useContext(LevelContext); switch (level) { case 1: return

{children}

; case 2: return

{children}

; case 3: return

{children}

; case 4: return

{children}

; case 5: return
{children}
; case 6: return
{children}
; default: throw Error('Unknown level: ' + level); } } ``` ```js LevelContext.js import { createContext } from 'react'; export const LevelContext = createContext(1); ``` ```css .section { padding: 10px; margin: 5px; border-radius: 5px; border: 1px solid #aaa; } ```
It's the same result as the original code, but you did not need to pass the `level` prop to each `Heading` component! Instead, it "figures out" its heading level by asking the closest `Section` above: 1. You pass a `level` prop to the `
`. 2. `Section` wraps its children into ``. 3. `Header` asks the closest value of `LevelContext` above with `useContext(LevelContext)`. ## Using and providing context from the same component {/*using-and-providing-context-from-the-same-component*/} Currently, you still have to specify each section's `level` manually: ```js export default function Page() { return (
...
...
... ``` Since context lets you read information from a component above, each `Section` could read the `level` from the `Section` above, and pass `level + 1` down automatically. Here is how you could do it: ```js Section.js {5,8} import { useContext } from 'react'; import { LevelContext } from './LevelContext.js'; export default function Section({ children }) { const level = useContext(LevelContext); return (
{children}
); } ``` With this change, you don't need to pass the `level` prop *either* to the `
` or to the ``: ```js import Heading from './Heading.js'; import Section from './Section.js'; export default function Page() { return (
Title
Heading Heading Heading
Sub-heading Sub-heading Sub-heading
Sub-sub-heading Sub-sub-heading Sub-sub-heading
); } ``` ```js Section.js import { useContext } from 'react'; import { LevelContext } from './LevelContext.js'; export default function Section({ children }) { const level = useContext(LevelContext); return (
{children}
); } ``` ```js Heading.js import { useContext } from 'react'; import { LevelContext } from './LevelContext.js'; export default function Heading({ children }) { const level = useContext(LevelContext); switch (level) { case 0: throw Error('Heading must be inside a Section!'); case 1: return

{children}

; case 2: return

{children}

; case 3: return

{children}

; case 4: return

{children}

; case 5: return
{children}
; case 6: return
{children}
; default: throw Error('Unknown level: ' + level); } } ``` ```js LevelContext.js import { createContext } from 'react'; export const LevelContext = createContext(0); ``` ```css .section { padding: 10px; margin: 5px; border-radius: 5px; border: 1px solid #aaa; } ```
Now both `Heading` and `Section` read the `LevelContext` to figure out how "deep" they are. And the `Section` wraps its children into the `LevelContext` to specify that anything inside of it is at a "deeper" level. >This example uses heading levels because they show visually how nested components can override context. But context is useful for many other use cases too. You can use it to pass down any information needed by the entire subtree: the current color theme, the currently logged in user, and so on. ## Context passes through intermediate components {/*context-passes-through-intermediate-components*/} You can insert as many components as you like between the component that provides context and the one that uses it. This includes both built-in components like `
` and components you might build yourself. In this example, the same `Post` component (with a dashed border) is rendered at two different nesting levels. Notice that the `` inside of it gets its level automatically from the closest `
`: ```js import Heading from './Heading.js'; import Section from './Section.js'; export default function ProfilePage() { return (
My Profile
); } function AllPosts() { return (
Posts
); } function RecentPosts() { return (
Recent Posts
); } function Post({ title, body }) { return (
{title}

{body}

); } ``` ```js Section.js import { useContext } from 'react'; import { LevelContext } from './LevelContext.js'; export default function Section({ children, isFancy }) { const level = useContext(LevelContext); return (
{children}
); } ``` ```js Heading.js import { useContext } from 'react'; import { LevelContext } from './LevelContext.js'; export default function Heading({ children }) { const level = useContext(LevelContext); switch (level) { case 0: throw Error('Heading must be inside a Section!'); case 1: return

{children}

; case 2: return

{children}

; case 3: return

{children}

; case 4: return

{children}

; case 5: return
{children}
; case 6: return
{children}
; default: throw Error('Unknown level: ' + level); } } ``` ```js LevelContext.js import { createContext } from 'react'; export const LevelContext = createContext(0); ``` ```css .section { padding: 10px; margin: 5px; border-radius: 5px; border: 1px solid #aaa; } .fancy { border: 4px dashed pink; } ```
You didn't do anything special for this to work. A `Section` specifies the context for the tree inside it, so you can insert a `` anywhere, and it will have the correct size. Try it in the sandbox above! **Context lets you write components that "adapt to their surroundings" and display themselves differently depending on _where_ (or, in other words, _in which context_) they are being rendered.** How context works might remind you of [CSS property inheritance](https://developer.mozilla.org/en-US/docs/Web/CSS/inheritance). In CSS, you can specify `color: blue` for a `
`, and any DOM node inside of it, no matter how deep, will inherit that color unless some other DOM node in the middle overrides it with `color: green`. Similarly, in React, the only way to override some context coming from above is to wrap children into a context provider with a different value. In CSS, different properties like `color` and `background-color` don't override each other. You can set all `
`'s `color` to red without impacting `background-color`. Similarly, **different React contexts don't override each other**. Each context that you make with `createContext()` is completely separate from other ones, and ties together components using and providing *that particular* context. One component may use or provide many different contexts without a problem. ## Before you use context {/*before-you-use-context*/} Context is very tempting to use! However, this also means it's too easy to overuse it. **Just because you need to pass some props several levels deep doesn't mean you should put that information into context.** Here's a few alternatives you should consider before using context: 1. **Start by [passing props](/learn/passing-props-to-a-component).** If your components are not trivial, it's not unusual to pass a dozen props down through a dozen components. It may feel like a slog, but it makes it very clear which components use which data! The person maintaining your code will be glad you've made the data flow explicit with props. 2. **Extract components and [pass JSX as `children`](/learn/passing-props-to-a-component#passing-jsx-as-children) to them.** If you pass some data through many layers of intermediate components that don't use that data (and only pass it further down), this often means that you forgot to extract some components along the way. For example, maybe you pass data props like `posts` to visual components that don't use them directly, like ``. Instead, make `Layout` take `children` as a prop, and render ``. This reduces the number of layers between the component specifying the data and the one that needs it. If neither of these approaches works well for you, consider context. ## Use cases for context {/*use-cases-for-context*/} * **Theming:** If your app lets the user change its appearance (e.g. dark mode), you can put a context provider at the top of your app, and use that context in components that need to adjust their visual look. * **Current account:** Many components might need to know the currently logged in user. Putting it in context makes it convenient to read it anywhere in the tree. Some apps also let you operate multiple accounts at the same time (e.g. to leave a comment as a different user). In those cases, it can be convenient to wrap a part of the UI into a nested provider with a different current account value. * **Routing:** Most routing solutions use context internally to hold the current route. This is how every link "knows" whether it's active or not. If you build your own router, you might want to do it too. * **Managing state:** As your app grows, you might end up with a lot of state closer to the top of your app. Many distant components below may want to change it. It is common to [use a reducer together with context](/learn/scaling-up-with-reducer-and-context) to manage complex state and pass it down to distant components without too much hassle. Context is not limited to static values. If you pass a different value on the next render, React will update all the components reading it below! This is why context is often used in combination with state. In general, if some information is needed by distant components in different parts of the tree, it's a good indication that context will help you. Context provides data to the entire tree * Context lets a component provide some information to the entire tree below it. * To pass context: 1. Create and export it with `export const MyContext = createContext(defaultValue)`. 2. Pass it to the `useContext(MyContext)` Hook to read it in any child component, no matter how deep. 3. Wrap children into `` to provide it from a parent. * Context passes through any components in the middle. * Context lets you write components that "adapt to their surroundings." * Before you use context, try passing props or passing JSX as `children`. ### Replace prop drilling with context {/*replace-prop-drilling-with-context*/} In this example, toggling the checkbox changes the `imageSize` prop passed to each ``. The checkbox state is held in the top-level `App` component, but each `` needs to be aware of it. Currently, `App` passes `imageSize` to `List`, which passes it to each `Place`, which passes it to the `PlaceImage`. Remove the `imageSize` prop, and instead pass it from the `App` component directly to `PlaceImage`. You can declare context in `Context.js`. ```js App.js import { useState } from 'react'; import { places } from './data.js'; import { getImageUrl } from './utils.js'; export default function App() { const [isLarge, setIsLarge] = useState(false); const imageSize = isLarge ? 150 : 100; return ( <>
) } function List({ imageSize }) { const listItems = places.map(place =>
  • ); return
      {listItems}
    ; } function Place({ place, imageSize }) { return ( <>

    {place.name} {': ' + place.description}

    ); } function PlaceImage({ place, imageSize }) { return ( {place.name} ); } ``` ```js Context.js ``` ```js data.js export const places = [{ id: 0, name: 'Bo-Kaap in Cape Town, South Africa', description: 'The tradition of choosing bright colors for houses began in the late 20th century.', imageId: 'K9HVAGH' }, { id: 1, name: 'Rainbow Village in Taichung, Taiwan', description: 'To save the houses from demolition, Huang Yung-Fu, a local resident, painted all 1,200 of them in 1924.', imageId: '9EAYZrt' }, { id: 2, name: 'Macromural de Pachuca, Mexico', description: 'One of the largest murals in the world covering homes in a hillside neighborhood.', imageId: 'DgXHVwu' }, { id: 3, name: 'Selarón Staircase in Rio de Janeiro, Brazil', description: 'This landmark was created by Jorge Selarón, a Chilean-born artist, as a "tribute to the Brazilian people."', imageId: 'aeO3rpI' }, { id: 4, name: 'Burano, Italy', description: 'The houses are painted following a specific color system dating back to 16th century.', imageId: 'kxsph5C' }, { id: 5, name: 'Chefchaouen, Marocco', description: 'There are a few theories on why the houses are painted blue, including that the color repells mosquitos or that it symbolizes sky and heaven.', imageId: 'rTqKo46' }, { id: 6, name: 'Gamcheon Culture Village in Busan, South Korea', description: 'In 2009, the village was converted into a cultural hub by painting the houses and featuring exhibitions and art installations.', imageId: 'ZfQOOzf' }]; ``` ```js utils.js export function getImageUrl(place) { return ( 'https://i.imgur.com/' + place.imageId + 'l.jpg' ); } ``` ```css ul { list-style-type: none; padding: 0px 10px; } li { margin-bottom: 10px; display: grid; grid-template-columns: auto 1fr; gap: 20px; align-items: center; } ```
    Remove `imageSize` prop from all the components. Create and export `ImageSizeContext` from `Context.js`. Then wrap the List into `` to pass the value down, and `useContext(ImageSizeContext)` to read it in the `PlaceImage`: ```js App.js import { useState, useContext } from 'react'; import { places } from './data.js'; import { getImageUrl } from './utils.js'; import { ImageSizeContext } from './Context.js'; export default function App() { const [isLarge, setIsLarge] = useState(false); const imageSize = isLarge ? 150 : 100; return (
    ) } function List({ imageSize }) { const listItems = places.map(place =>
  • ); return
      {listItems}
    ; } function Place({ place }) { return ( <>

    {place.name} {': ' + place.description}

    ); } function PlaceImage({ place }) { const imageSize = useContext(ImageSizeContext); return ( {place.name} ); } ``` ```js Context.js import { createContext } from 'react'; export const ImageSizeContext = createContext(500); ``` ```js data.js export const places = [{ id: 0, name: 'Bo-Kaap in Cape Town, South Africa', description: 'The tradition of choosing bright colors for houses began in the late 20th century.', imageId: 'K9HVAGH' }, { id: 1, name: 'Rainbow Village in Taichung, Taiwan', description: 'To save the houses from demolition, Huang Yung-Fu, a local resident, painted all 1,200 of them in 1924.', imageId: '9EAYZrt' }, { id: 2, name: 'Macromural de Pachuca, Mexico', description: 'One of the largest murals in the world covering homes in a hillside neighborhood.', imageId: 'DgXHVwu' }, { id: 3, name: 'Selarón Staircase in Rio de Janeiro, Brazil', description: 'This landmark was created by Jorge Selarón, a Chilean-born artist, as a "tribute to the Brazilian people."', imageId: 'aeO3rpI' }, { id: 4, name: 'Burano, Italy', description: 'The houses are painted following a specific color system dating back to 16th century.', imageId: 'kxsph5C' }, { id: 5, name: 'Chefchaouen, Marocco', description: 'There are a few theories on why the houses are painted blue, including that the color repells mosquitos or that it symbolizes sky and heaven.', imageId: 'rTqKo46' }, { id: 6, name: 'Gamcheon Culture Village in Busan, South Korea', description: 'In 2009, the village was converted into a cultural hub by painting the houses and featuring exhibitions and art installations.', imageId: 'ZfQOOzf' }]; ``` ```js utils.js export function getImageUrl(place) { return ( 'https://i.imgur.com/' + place.imageId + 'l.jpg' ); } ``` ```css ul { list-style-type: none; padding: 0px 10px; } li { margin-bottom: 10px; display: grid; grid-template-columns: auto 1fr; gap: 20px; align-items: center; } ```
    Note how components in the middle don't need to pass `imageSize` anymore.