--- title: Passing Props to a Component --- React components use *props* to communicate with each other. Every parent component can pass some information to its child components by giving them props. Props might remind you of HTML attributes, but you can pass any JavaScript value through them, including objects, arrays, and functions. * How to pass props to a component * How to read props from a component * How to specify default values for props * How to pass some JSX to a component * How props change over time ## Familiar props {/*familiar-props*/} Props are the information that you pass to a JSX tag. For example, `className`, `src`, `alt`, `width`, and `height` are some of the props you can pass to an ``: ```js function Avatar() { return ( Lin Lanying ); } export default function Profile() { return ( ); } ``` ```css body { min-height: 120px; } .avatar { margin: 20px; border-radius: 50%; } ``` The props you can pass to an `` tag are predefined (ReactDOM conforms to [the HTML standard](https://www.w3.org/TR/html52/semantics-embedded-content.html#the-img-element)). But you can pass any props to *your own* components, such as ``, to customize them. Here's how! ## Passing props to a component {/*passing-props-to-a-component*/} In this code, the `Profile` component isn't passing any props to its child component, `Avatar`: ```js export default function Profile() { return ( ); } ``` You can give `Avatar` some props in two steps. ### Step 1: Pass props to the child component {/*step-1-pass-props-to-the-child-component*/} First, pass some props to `Avatar`. For example, let's pass two props: `person` (an object), and `size` (a number): ```js export default function Profile() { return ( ); } ``` If double curly braces after `person=` confuse you, recall [they're merely an object](/learn/javascript-in-jsx-with-curly-braces#using-double-curlies-css-and-other-objects-in-jsx) inside the JSX curlies. Now you can read these props inside the `Avatar` component. ### Step 2: Read props inside the child component {/*step-2-read-props-inside-the-child-component*/} You can read these props by listing their names `person, size` separated by the commas inside `({` and `})` directly after `function Avatar`. This lets you use them inside the `Avatar` code, like you would with a variable. ```js function Avatar({ person, size }) { // person and size are available here } ``` Add some logic to `Avatar` that uses the `person` and `size` props for rendering, and you're done. Now you can configure `Avatar` to render in many different ways with different props. Try tweaking the values! ```js src/App.js import { getImageUrl } from './utils.js'; function Avatar({ person, size }) { return ( {person.name} ); } export default function Profile() { return (
); } ``` ```js src/utils.js export function getImageUrl(person, size = 's') { return ( 'https://react.dev/images/docs/scientists/' + person.imageId + size + '.jpg' ); } ``` ```css body { min-height: 120px; } .avatar { margin: 10px; border-radius: 50%; } ```
Props let you think about parent and child components independently. For example, you can change the `person` or the `size` props inside `Profile` without having to think about how `Avatar` uses them. Similarly, you can change how the `Avatar` uses these props, without looking at the `Profile`. You can think of props like "knobs" that you can adjust. They serve the same role as arguments serve for functions—in fact, props _are_ the only argument to your component! React component functions accept a single argument, a `props` object: ```js function Avatar(props) { let person = props.person; let size = props.size; // ... } ``` Usually you don't need the whole `props` object itself, so you destructure it into individual props. **Don't miss the pair of `{` and `}` curlies** inside of `(` and `)` when declaring props: ```js function Avatar({ person, size }) { // ... } ``` This syntax is called ["destructuring"](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Operators/Destructuring_assignment#Unpacking_fields_from_objects_passed_as_a_function_parameter) and is equivalent to reading properties from a function parameter: ```js function Avatar(props) { let person = props.person; let size = props.size; // ... } ``` ## Specifying a default value for a prop {/*specifying-a-default-value-for-a-prop*/} If you want to give a prop a default value to fall back on when no value is specified, you can do it with the destructuring by putting `=` and the default value right after the parameter: ```js function Avatar({ person, size = 100 }) { // ... } ``` Now, if `` is rendered with no `size` prop, the `size` will be set to `100`. The default value is only used if the `size` prop is missing or if you pass `size={undefined}`. But if you pass `size={null}` or `size={0}`, the default value will **not** be used. ## Forwarding props with the JSX spread syntax {/*forwarding-props-with-the-jsx-spread-syntax*/} Sometimes, passing props gets very repetitive: ```js function Profile({ person, size, isSepia, thickBorder }) { return (
); } ``` There's nothing wrong with repetitive code—it can be more legible. But at times you may value conciseness. Some components forward all of their props to their children, like how this `Profile` does with `Avatar`. Because they don't use any of their props directly, it can make sense to use a more concise "spread" syntax: ```js function Profile(props) { return (
); } ``` This forwards all of `Profile`'s props to the `Avatar` without listing each of their names. **Use spread syntax with restraint.** If you're using it in every other component, something is wrong. Often, it indicates that you should split your components and pass children as JSX. More on that next! ## Passing JSX as children {/*passing-jsx-as-children*/} It is common to nest built-in browser tags: ```js
``` Sometimes you'll want to nest your own components the same way: ```js ``` When you nest content inside a JSX tag, the parent component will receive that content in a prop called `children`. For example, the `Card` component below will receive a `children` prop set to `` and render it in a wrapper div: ```js src/App.js import Avatar from './Avatar.js'; function Card({ children }) { return (
{children}
); } export default function Profile() { return ( ); } ``` ```js src/Avatar.js import { getImageUrl } from './utils.js'; export default function Avatar({ person, size }) { return ( {person.name} ); } ``` ```js src/utils.js export function getImageUrl(person, size = 's') { return ( 'https://react.dev/images/docs/scientists/' + person.imageId + size + '.jpg' ); } ``` ```css .card { width: fit-content; margin: 5px; padding: 5px; font-size: 20px; text-align: center; border: 1px solid #aaa; border-radius: 20px; background: #fff; } .avatar { margin: 20px; border-radius: 50%; } ```
Try replacing the `` inside `` with some text to see how the `Card` component can wrap any nested content. It doesn't need to "know" what's being rendered inside of it. You will see this flexible pattern in many places. You can think of a component with a `children` prop as having a "hole" that can be "filled in" by its parent components with arbitrary JSX. You will often use the `children` prop for visual wrappers: panels, grids, etc. ## How props change over time {/*how-props-change-over-time*/} The `Clock` component below receives two props from its parent component: `color` and `time`. (The parent component's code is omitted because it uses [state](/learn/state-a-components-memory), which we won't dive into just yet.) Try changing the color in the select box below: ```js src/Clock.js active export default function Clock({ color, time }) { return (

{time}

); } ``` ```js src/App.js hidden import { useState, useEffect } from 'react'; import Clock from './Clock.js'; function useTime() { const [time, setTime] = useState(() => new Date()); useEffect(() => { const id = setInterval(() => { setTime(new Date()); }, 1000); return () => clearInterval(id); }, []); return time; } export default function App() { const time = useTime(); const [color, setColor] = useState('lightcoral'); return (

Pick a color:{' '}

); } ```
This example illustrates that **a component may receive different props over time.** Props are not always static! Here, the `time` prop changes every second, and the `color` prop changes when you select another color. Props reflect a component's data at any point in time, rather than only in the beginning. However, props are [immutable](https://en.wikipedia.org/wiki/Immutable_object)—a term from computer science meaning "unchangeable". When a component needs to change its props (for example, in response to a user interaction or new data), it will have to "ask" its parent component to pass it _different props_—a new object! Its old props will then be cast aside, and eventually the JavaScript engine will reclaim the memory taken by them. **Don't try to "change props".** When you need to respond to the user input (like changing the selected color), you will need to "set state", which you can learn about in [State: A Component's Memory.](/learn/state-a-components-memory) * To pass props, add them to the JSX, just like you would with HTML attributes. * To read props, use the `function Avatar({ person, size })` destructuring syntax. * You can specify a default value like `size = 100`, which is used for missing and `undefined` props. * You can forward all props with `` JSX spread syntax, but don't overuse it! * Nested JSX like `` will appear as `Card` component's `children` prop. * Props are read-only snapshots in time: every render receives a new version of props. * You can't change props. When you need interactivity, you'll need to set state. #### Extract a component {/*extract-a-component*/} This `Gallery` component contains some very similar markup for two profiles. Extract a `Profile` component out of it to reduce the duplication. You'll need to choose what props to pass to it. ```js src/App.js import { getImageUrl } from './utils.js'; export default function Gallery() { return (

Notable Scientists

Maria Skłodowska-Curie

Maria Skłodowska-Curie
  • Profession: physicist and chemist
  • Awards: 4 (Nobel Prize in Physics, Nobel Prize in Chemistry, Davy Medal, Matteucci Medal)
  • Discovered: polonium (chemical element)

Katsuko Saruhashi

Katsuko Saruhashi
  • Profession: geochemist
  • Awards: 2 (Miyake Prize for geochemistry, Tanaka Prize)
  • Discovered: a method for measuring carbon dioxide in seawater
); } ``` ```js src/utils.js export function getImageUrl(imageId, size = 's') { return ( 'https://react.dev/images/docs/scientists/' + imageId + size + '.jpg' ); } ``` ```css .avatar { margin: 5px; border-radius: 50%; min-height: 70px; } .profile { border: 1px solid #aaa; border-radius: 6px; margin-top: 20px; padding: 10px; } h1, h2 { margin: 5px; } h1 { margin-bottom: 10px; } ul { padding: 0px 10px 0px 20px; } li { margin: 5px; } ```
Start by extracting the markup for one of the scientists. Then find the pieces that don't match it in the second example, and make them configurable by props. In this solution, the `Profile` component accepts multiple props: `imageId` (a string), `name` (a string), `profession` (a string), `awards` (an array of strings), `discovery` (a string), and `imageSize` (a number). Note that the `imageSize` prop has a default value, which is why we don't pass it to the component. ```js src/App.js import { getImageUrl } from './utils.js'; function Profile({ imageId, name, profession, awards, discovery, imageSize = 70 }) { return (

{name}

{name}
  • Profession: {profession}
  • Awards: {awards.length} ({awards.join(', ')})
  • Discovered: {discovery}
); } export default function Gallery() { return (

Notable Scientists

); } ``` ```js src/utils.js export function getImageUrl(imageId, size = 's') { return ( 'https://react.dev/images/docs/scientists/' + imageId + size + '.jpg' ); } ``` ```css .avatar { margin: 5px; border-radius: 50%; min-height: 70px; } .profile { border: 1px solid #aaa; border-radius: 6px; margin-top: 20px; padding: 10px; } h1, h2 { margin: 5px; } h1 { margin-bottom: 10px; } ul { padding: 0px 10px 0px 20px; } li { margin: 5px; } ```
Note how you don't need a separate `awardCount` prop if `awards` is an array. Then you can use `awards.length` to count the number of awards. Remember that props can take any values, and that includes arrays too! Another solution, which is more similar to the earlier examples on this page, is to group all information about a person in a single object, and pass that object as one prop: ```js src/App.js import { getImageUrl } from './utils.js'; function Profile({ person, imageSize = 70 }) { const imageSrc = getImageUrl(person) return (

{person.name}

{person.name}
  • Profession: {person.profession}
  • Awards: {person.awards.length} ({person.awards.join(', ')})
  • Discovered: {person.discovery}
) } export default function Gallery() { return (

Notable Scientists

); } ``` ```js src/utils.js export function getImageUrl(person, size = 's') { return ( 'https://react.dev/images/docs/scientists/' + person.imageId + size + '.jpg' ); } ``` ```css .avatar { margin: 5px; border-radius: 50%; min-height: 70px; } .profile { border: 1px solid #aaa; border-radius: 6px; margin-top: 20px; padding: 10px; } h1, h2 { margin: 5px; } h1 { margin-bottom: 10px; } ul { padding: 0px 10px 0px 20px; } li { margin: 5px; } ```
Although the syntax looks slightly different because you're describing properties of a JavaScript object rather than a collection of JSX attributes, these examples are mostly equivalent, and you can pick either approach.
#### Adjust the image size based on a prop {/*adjust-the-image-size-based-on-a-prop*/} In this example, `Avatar` receives a numeric `size` prop which determines the `` width and height. The `size` prop is set to `40` in this example. However, if you open the image in a new tab, you'll notice that the image itself is larger (`160` pixels). The real image size is determined by which thumbnail size you're requesting. Change the `Avatar` component to request the closest image size based on the `size` prop. Specifically, if the `size` is less than `90`, pass `'s'` ("small") rather than `'b'` ("big") to the `getImageUrl` function. Verify that your changes work by rendering avatars with different values of the `size` prop and opening images in a new tab. ```js src/App.js import { getImageUrl } from './utils.js'; function Avatar({ person, size }) { return ( {person.name} ); } export default function Profile() { return ( ); } ``` ```js src/utils.js export function getImageUrl(person, size) { return ( 'https://react.dev/images/docs/scientists/' + person.imageId + size + '.jpg' ); } ``` ```css .avatar { margin: 20px; border-radius: 50%; } ``` Here is how you could go about it: ```js src/App.js import { getImageUrl } from './utils.js'; function Avatar({ person, size }) { let thumbnailSize = 's'; if (size > 90) { thumbnailSize = 'b'; } return ( {person.name} ); } export default function Profile() { return ( <> ); } ``` ```js src/utils.js export function getImageUrl(person, size) { return ( 'https://react.dev/images/docs/scientists/' + person.imageId + size + '.jpg' ); } ``` ```css .avatar { margin: 20px; border-radius: 50%; } ``` You could also show a sharper image for high DPI screens by taking [`window.devicePixelRatio`](https://developer.mozilla.org/en-US/docs/Web/API/Window/devicePixelRatio) into account: ```js src/App.js import { getImageUrl } from './utils.js'; const ratio = window.devicePixelRatio; function Avatar({ person, size }) { let thumbnailSize = 's'; if (size * ratio > 90) { thumbnailSize = 'b'; } return ( {person.name} ); } export default function Profile() { return ( <> ); } ``` ```js src/utils.js export function getImageUrl(person, size) { return ( 'https://react.dev/images/docs/scientists/' + person.imageId + size + '.jpg' ); } ``` ```css .avatar { margin: 20px; border-radius: 50%; } ``` Props let you encapsulate logic like this inside the `Avatar` component (and change it later if needed) so that everyone can use the `` component without thinking about how the images are requested and resized. #### Passing JSX in a `children` prop {/*passing-jsx-in-a-children-prop*/} Extract a `Card` component from the markup below, and use the `children` prop to pass different JSX to it: ```js export default function Profile() { return (

Photo

Aklilu Lemma

About

Aklilu Lemma was a distinguished Ethiopian scientist who discovered a natural treatment to schistosomiasis.

); } ``` ```css .card { width: fit-content; margin: 20px; padding: 20px; border: 1px solid #aaa; border-radius: 20px; background: #fff; } .card-content { text-align: center; } .avatar { margin: 10px; border-radius: 50%; } h1 { margin: 5px; padding: 0; font-size: 24px; } ```
Any JSX you put inside of a component's tag will be passed as the `children` prop to that component. This is how you can use the `Card` component in both places: ```js function Card({ children }) { return (
{children}
); } export default function Profile() { return (

Photo

Aklilu Lemma

About

Aklilu Lemma was a distinguished Ethiopian scientist who discovered a natural treatment to schistosomiasis.

); } ``` ```css .card { width: fit-content; margin: 20px; padding: 20px; border: 1px solid #aaa; border-radius: 20px; background: #fff; } .card-content { text-align: center; } .avatar { margin: 10px; border-radius: 50%; } h1 { margin: 5px; padding: 0; font-size: 24px; } ```
You can also make `title` a separate prop if you want every `Card` to always have a title: ```js function Card({ children, title }) { return (

{title}

{children}
); } export default function Profile() { return (
Aklilu Lemma

Aklilu Lemma was a distinguished Ethiopian scientist who discovered a natural treatment to schistosomiasis.

); } ``` ```css .card { width: fit-content; margin: 20px; padding: 20px; border: 1px solid #aaa; border-radius: 20px; background: #fff; } .card-content { text-align: center; } .avatar { margin: 10px; border-radius: 50%; } h1 { margin: 5px; padding: 0; font-size: 24px; } ```
--- ## Sitemap [Overview of all docs pages](/llms.txt)