Using WebSocket in React

  • React
  • Gabriele Romanato

WebSockets are a two-way communication protocol that allows developers to build real-time web applications. In React, one of the most popular libraries for building user interfaces, WebSocket integration can be essential for implementing real-time update features like chat, notifications, and data streaming. In this guide, we will explore how to use WebSockets in a React application.

Installing dependencies

To get started, you need to install a WebSocket library for React. One of the common choices is socket.io-client. Install the library using the following command:


npm install socket.io-client --save

Creating a WebSocket component in React

Let's create a new React component to handle the WebSocket connection. For example, we can call it WebSocketComponent.js. Inside this component, we will import the socket.io-client library and establish the connection to the WebSocket server:


// WebSocketComponent.js
import { useEffect } from 'react';
import io from 'socket.io-client';

const WebSocketComponent = () => {
   useEffect(() => {
     // Connect to the WebSocket server
     const socket = io('http://localhost:3001'); // Replace with your WebSocket server URL

     // WebSocket event handling
     socket.on('connect', () => {
       console.log('Connected to WebSocket server');
     });

     socket.on('message', (data) => {
       console.log('Message received:', data);
       // Handle the message received from the server
     });

     // Close the connection upon disconnection or when the component is dismounted
     return () => {
       socket.disconnect();
     };
   }, []);

   return (
     <div>
       {/* Contents of WebSocket component */}
     </div>
   );
};

export default WebSocketComponent;

Sending data to the WebSocket server

To send data to the WebSocket server, we can use the emit method provided by the socket.io-client library. Let's modify our component to allow sending a message to the server:


// WebSocketComponent.js
// ... (imports and legacy code)

const WebSocketComponent = () => {
   useEffect(() => {
     const socket = io('http://localhost:3001');

     socket.on('connect', () => {
       console.log('Connected to WebSocket server');

       // Send a message to the server
       socket.emit('message', 'Hello, WebSocket server!');
     });

     socket.on('message', (data) => {
       console.log('Message received:', data);
       // Handle the message received from the server
     });

     return () => {
       socket.disconnect();
     };
   }, []);

   return (
    <div>
       {/* Contents of WebSocket component */}
     </div>
   );
};

export default WebSocketComponent;

Integration with other React components

Now that we have our WebSocket component working, we can integrate it with other React components in our application. For example, we can use it to dynamically update the display of messages in a chat or to update the application state based on data received in real time.


// App.js
import React from 'react';
import WebSocketComponent from './WebSocketComponent';

const App = () => {
   return (
     <div>
       <h1>React Application with WebSocket</h1>
       <WebSocketComponent />
       {/* Other React components */}
     </div>
   );
};

export default App;

With these simple changes, you will have created a working WebSocket connection in a React application. Remember to manage events and updates in real time based on the specific needs of your project.

Back to top