Back ArrowExplore all topics
technology logo
technology logo

Scroll to a specific component in React JS

share link

by vsasikalabe dot icon Updated: Mar 28, 2023

Solution Kit Solution Kit  

Scrolling is described as sliding-effect movement or changes in images, text, or graphics across the computer display screen horizontally, vertically, or both. During developing web pages, you can activate scrolling by default for the complete webpage or only some pages where it is required.  


By calling the scrollIntoView function on the element, we can scroll to an element most simply. We first need to get the DOM element ref from useRef, or you can select it from the DOM directly. Set a ref prop on the element you want to scroll to an element on click in React. On the other element, set the onClick prop. Call the scrollIntoView() method on the ref object every time the element is clicked. The useRef is a hook that allows you to create a reference to the DOM element in the functional component directly. The useImperativeHandle Hook allows us to expose a value, function, or state inside a child component to the parent component. 

element.scrollIntoView(alignToTop): 

  • The alignToTop is a Boolean value. 

element.scrollIntoView(options): 

Options have three main properties 

  • Block- This Property defines vertical alignment. 
  • Behavior -This property defines the transition animation. 
  • Inline - property defines horizontal alignment. 


Here is an example of how to Scroll to a specific component in Reaactjs: 

Preview of the output that you will get on running this code from your IDE.

Code:

In this solution we use the React library,useimperativeHandle,forwardRef and useRef hooks.

How to scroll to a specific component in React JS

JavaScriptdotLines of Code : 57dotLicense : Strong Copyleft (CC BY-SA 4.0)

Dependent Libraries : 
import { useImperativeHandle, forwardRef, useRef } from "react";

const LastComp = forwardRef((props, ref) => {
  const compRef = useRef();
  useImperativeHandle(ref, () => ({
    scrollIntoView: () => {
      compRef.current.scrollIntoView({ behavior: "smooth", block: "start" });
    }
  }));
  return (
    <div style={{ height: "600px", backgroundColor: "gray" }} ref={compRef}>
      Body of the last component
    </div>
  );
});

export default LastComp;

const FirstComp = ({ refToLastComp }) => {
  const scrolltoLast = () => {
    if (refToLastComp.current) {
      refToLastComp.current.scrollIntoView();
    }
  };

  return (
    <div
      style={{
        height: "600px",
        backgroundColor: "tomato"
      }}
    >
      <button onClick={scrolltoLast}>Scroll to Last</button>
      First
    </div>
  );
};

export default FirstComp;

import { useRef } from "react";
import FirstComp from "./FirstComp";
import SecondComp from "./SecondComp";
import LastComp from "./LastComp";

export default function Main() {
  const ref = useRef(null);

  return (
    <>
      <FirstComp refToLastComp={ref} />
      <SecondComp />
      <LastComp ref={ref} />
    </>
  );
}

Instructions

Follow the steps carefully to get the output easily.

  1. Install Node.js and React on your IDE(preferably Visual Studio Code).
  2. Create React Application using npx create-react-app foldername.
  3. cd foldername.
  4. Open the folder in IDE.
  5. Click on the code topic and Copy the main.js code using the "copy" button above and paste it into App.js file(remove the earlier code from App.js). Create LastComp.js and FirstComp.js files and Paste the code of LastComp.js and FirstComp.js to the corresponding file.
  6. Remove import SecondComp and also remove <SecondComp /> in line 11 from the App.js file.
  7. Open the terminal from IDE.
  8. npm start to run the file.


You can also refer to this url DEMO for getting the above output.

I hope you found this useful. I have added the link to dependent libraries, version information in the following sections.


I found this code snippet by searching for Scroll to a specific component in React JS in kandi. You can try any such use case!

Environment Tested

I tested this solution in the following versions. Be mindful of changes when working with other versions.

  1. The solution is created in VS Code 1.73.1 version.
  2. The solution is tested on Nodejs 16.14.2 version.
  3. react 18.2.0 version.


Using this solution, we are able to do scroll to a specific component in React JS with simple steps. This process also facilities an easy way to use, hassle-free method to create a hands-on working version of code which would help us to do scroll to a specific component in React JS.

Dependent Libraries

create-react-appby facebook

JavaScript doticonstar image 99898 doticonVersion:v5.0.1doticon
License: Permissive (MIT)

Set up a modern web app by running one command.

Support
    Quality
      Security
        License
          Reuse

            create-react-appby facebook

            JavaScript doticon star image 99898 doticonVersion:v5.0.1doticon License: Permissive (MIT)

            Set up a modern web app by running one command.
            Support
              Quality
                Security
                  License
                    Reuse

                      You can search for any dependent library on kandi like react.

                      Support

                      1. For any support on kandi solution kits, please use the chat
                      2. For further learning resources, visit the Open Weaver Community learning page

                      See similar Kits and Libraries

                      Open Weaver – Develop Applications Faster with Open Source

                      kandi

                      Community and Support

                      Company

                      Follow

                      • © 2023 Open Weaver Inc.