Import JSON file in React

JavascriptJsonReactjs

Javascript Problem Overview


I'm new to React and I'm trying to import a JSON DATA variable from an external file. I'm getting the following error:

> Cannot find module "./customData.json"

Could some one help me? It works if I have my DATA variable in index.js but not when it's in an external JSON file.

index.js
import React, {Component} from 'react';
import ReactDOM from 'react-dom';
import customData from './customData.json';
import Profile from './components/profile';
import Hobbies from './components/hobbies';

class App extends Component {
  render() {
    return (
      <div>
        <Profile name={this.props.profileData.name}imgUrl={this.props.profileData.imgURL} />
        <Hobbies hobbyList={this.props.profileData.hobbyList}/>
      </div>
    );
  }
}

ReactDOM.render(<App profileData={DATA}/>, document.querySelector('.container'));
hobbies.js
import React, {Component} from 'react';

var Hobbies = React.createClass({
  render: function(){
    var hobbies = this.props.hobbyList.map(function(hobby, index){
        return (<li key={index}>{hobby}</li>);
    });
    return (
    	<div>
        	<h5>My hobbies:</h5>
            <ul>
            	{hobbies}
            </ul>
        </div>
    );
  } 
});

export default Hobbies;
profile.js
import React from 'react';

var Profile = React.createClass({
render: function(){
	return (
		<div>
			<h3>{this.props.name}</h3>
			<img src={this.props.imgUrl} />
		</div>
	)
  }
});

export default Profile
customData.json
var DATA = {    
    name: 'John Smith',
    imgURL: 'http://lorempixel.com/100/100/',
    hobbyList: ['coding', 'writing', 'skiing']
}

export default DATA

Javascript Solutions


Solution 1 - Javascript

One nice way (without adding a fake .js extension which is for code not for data and configs) is to use json-loader module. If you have used create-react-app to scaffold your project, the module is already included, you just need to import your json:

import Profile from './components/profile';

This answer explains more.

Solution 2 - Javascript

This old chestnut...

In short, you should be using require and letting node handle the parsing as part of the require call, not outsourcing it to a 3rd party module. You should also be taking care that your configs are bulletproof, which means you should check the returned data carefully.

But for brevity's sake, consider the following example:

For Example, let's say I have a config file 'admins.json' in the root of my app containing the following:

admins.json
[{  "userName": "tech1337",  "passSalted": "xxxxxxxxxxxx"}]

Note the quoted keys, "userName", "passSalted"!

I can do the following and get the data out of the file with ease.

let admins = require('~/app/admins.json');
console.log(admins[0].userName);

Now the data is in and can be used as a regular (or array of) object.

Solution 3 - Javascript

With json-loader installed, you can use

import customData from '../customData.json';

or also, even more simply

import customData from '../customData';

To install json-loader

npm install --save-dev json-loader

Solution 4 - Javascript

Simplest approach is following

// Save this as someJson.js
const someJson = {
  name: 'Name',
  age: 20
}

export default someJson

then

import someJson from './someJson'

Solution 5 - Javascript

The solution that worked for me is that:- I moved my data.json file from src to public directory. Then used fetch API to fetch the file

fetch('./data.json').then(response => {
      console.log(response);
      return response.json();
    }).then(data => {
      // Work with JSON data here
      console.log(data);
    }).catch(err => {
      // Do something for an error here
      console.log("Error Reading data " + err);
    });

The problem was that after compiling react app the fetch request looks for the file at URL "http://localhost:3000/data.json" which is actually the public directory of my react app. But unfortunately while compiling react app data.json file is not moved from src to public directory. So we have to explicitly move data.json file from src to public directory.

Solution 6 - Javascript

Please store your JSON file with the .js extension and make sure that your JSON should be in same directory.

Solution 7 - Javascript

// rename the .json file to .js and keep in src folder

Declare the json object as a variable

var customData = {
   "key":"value"
};

Export it using module.exports

module.exports = customData;

From the component that needs it, make sure to back out two folders deep

import customData from '../customData';

Solution 8 - Javascript

React 17 created from create-react-app, importing json just work by default.

import config from './config.json'

Solution 9 - Javascript

try with export default DATA or module.exports = DATA

Solution 10 - Javascript

there are multiple ways to do this without using any third-party code or libraries (the recommended way).

1st STATIC WAY: create a .json file then import it in your react component example

my file name is "example.json"

{"example" : "my text"}

the example key inside the example.json can be anything just keep in mind to use double quotes to prevent future issues.

How to import in react component

import myJson from "jsonlocation";

and you can use it anywhere like this

myJson.example

now there are a few things to consider. With this method, you are forced to declare your import at the top of the page and cannot dynamically import anything.

Now, what about if we want to dynamically import the JSON data? example a multi-language support website?

2 DYNAMIC WAY

1st declare your JSON file exactly like my example above

but this time we are importing the data differently.

let language = require('./en.json');

this can access the same way.

but wait where is the dynamic load?

here is how to load the JSON dynamically

let language = require(`./${variable}.json`);

now make sure all your JSON files are within the same directory

here you can use the JSON the same way as the first example

myJson.example

what changed? the way we import because it is the only thing we really need.

I hope this helps.

Solution 11 - Javascript

In current react build you simply import and use:

import jsonData from 'path/to/myJson.json'

Solution 12 - Javascript

var langs={
  ar_AR:require('./locale/ar_AR.json'),
  cs_CZ:require('./locale/cs_CZ.json'),
  de_DE:require('./locale/de_DE.json'),
  el_GR:require('./locale/el_GR.json'),
  en_GB:require('./locale/en_GB.json'),
  es_ES:require('./locale/es_ES.json'),
  fr_FR:require('./locale/fr_FR.json'),
  hu_HU:require('./locale/hu_HU.json')
}
module.exports=langs;

Require it in your module:

let langs=require('./languages');

regards

Solution 13 - Javascript

This worked well in React 16.11.0

// in customData.js
export const customData = {
  //json data here
  name: 'John Smith',
  imgURL: 'http://lorempixel.com/100/100/',
  hobbyList: ['coding', 'writing', 'skiing']
}
// in index.js
import { customData } from './customData';

// example usage later in index.js
<p>{customData.name}</p>

Solution 14 - Javascript

Something that worked for me was to simply place the JSON file in the public folder. You can simply import in any js using

brain.loadData("exampleFile.json");

It is as simple as that I guess. Definitely worth a try :D

Attributions

All content for this solution is sourced from the original question on Stackoverflow.

The content on this page is licensed under the Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) license.

Content TypeOriginal AuthorOriginal Content on Stackoverflow
QuestionHugo SeleiroView Question on Stackoverflow
Solution 1 - JavascriptJavadView Answer on Stackoverflow
Solution 2 - JavascriptTech1337View Answer on Stackoverflow
Solution 3 - JavascriptLet Me Tink About ItView Answer on Stackoverflow
Solution 4 - Javascriptdev_khanView Answer on Stackoverflow
Solution 5 - JavascriptAkash Kumar SethView Answer on Stackoverflow
Solution 6 - JavascriptShubhamView Answer on Stackoverflow
Solution 7 - Javascriptcesar3sparzaView Answer on Stackoverflow
Solution 8 - Javascripts1n7axView Answer on Stackoverflow
Solution 9 - JavascriptSalvatoreView Answer on Stackoverflow
Solution 10 - JavascriptjerryurenaaView Answer on Stackoverflow
Solution 11 - JavascriptAvi E. KoenigView Answer on Stackoverflow
Solution 12 - Javascriptrabie jeghamView Answer on Stackoverflow
Solution 13 - JavascriptBuldoView Answer on Stackoverflow
Solution 14 - JavascriptUjjwal SharmaView Answer on Stackoverflow