javascript - create - Añadir Favicon con React y Webpack

png to ico

Question

Estoy intentando agregar un favicon a un sitio web basado en React que hice usando webpack. Ha sido una pesadilla total agregar un favicon y he probado muchas soluciones sin éxito. La última solución que me han recomendado se llama ''favicons-webpack-plugin'', que se puede encontrar aquí: https://github.com/jantimon/favicons-webpack-plugin .

Si alguien puede decirme lo que estoy haciendo mal, su ayuda sería muy apreciada.

Recibo el siguiente error cuando ejecuto ''npm run start''

Esta es mi estructura de directorio:

Este es mi archivo webpack.config.js:

const path = require(''path'');
const merge = require(''webpack-merge'');
const webpack = require(''webpack'');
const NpmInstallPlugin = require(''npm-install-webpack-plugin'');
const TARGET = process.env.npm_lifecycle_event;
const FaviconsWebpackPlugin = require(''favicons-webpack-plugin'');
const HtmlWebpackPlugin = require(''html-webpack-plugin'');
const CleanPlugin = require(''clean-webpack-plugin'');
const ExtractTextPlugin = require(''extract-text-webpack-plugin'');
var favicons = require(''favicons''),
    source = ''my-logo.png'',           // Source image(s). `string`, `buffer` or array of `{ size: filepath }`
    configuration = {
        appName: null,                  // Your application''s name. `string`
        appDescription: null,           // Your application''s description. `string`
        developerName: null,            // Your (or your developer''s) name. `string`
        developerURL: null,             // Your (or your developer''s) URL. `string`
        background: "#fff",             // Background colour for flattened icons. `string`
        path: "/",                      // Path for overriding default icons path. `string`
        url: "/",                       // Absolute URL for OpenGraph image. `string`
        display: "standalone",          // Android display: "browser" or "standalone". `string`
        orientation: "portrait",        // Android orientation: "portrait" or "landscape". `string`
        version: "1.0",                 // Your application''s version number. `number`
        logging: false,                 // Print logs to console? `boolean`
        online: false,                  // Use RealFaviconGenerator to create favicons? `boolean`
        icons: {
            android: true,              // Create Android homescreen icon. `boolean`
            appleIcon: true,            // Create Apple touch icons. `boolean`
            appleStartup: true,         // Create Apple startup images. `boolean`
            coast: true,                // Create Opera Coast icon. `boolean`
            favicons: true,             // Create regular favicons. `boolean`
            firefox: true,              // Create Firefox OS icons. `boolean`
            opengraph: true,            // Create Facebook OpenGraph image. `boolean`
            twitter: true,              // Create Twitter Summary Card image. `boolean`
            windows: true,              // Create Windows 8 tile icons. `boolean`
            yandex: true                // Create Yandex browser icon. `boolean`
        }
    },
    callback = function (error, response) {
        if (error) {
            console.log(error.status);  // HTTP error code (e.g. `200`) or `null`
            console.log(error.name);    // Error name e.g. "API Error"
            console.log(error.message); // Error description e.g. "An unknown error has occurred"
        }
        console.log(response.images);   // Array of { name: string, contents: <buffer> }
        console.log(response.files);    // Array of { name: string, contents: <string> }
        console.log(response.html);     // Array of strings (html elements)
    };

favicons(source, configuration, callback);
const pkg = require(''./package.json'');

const PATHS = {
  app: path.join(__dirname, ''app''),
  build: path.join(__dirname, ''build'')
};

process.env.BABEL_ENV = TARGET;

const common = {
  entry: {
    app: PATHS.app
  },
  // Add resolve.extensions
  // '''' is needed to allow imports without an extension
  // note the .''s before the extension as it will fail to load without them
  resolve: {
    extensions: ['''', ''.js'', ''.jsx'', ''.json'']
  },
  output: {
    path: PATHS.build,
    filename: ''bundle.js''
  },
  module: {
    loaders: [
      {
        // Test expects a RegExp! Notethe slashes!
        test: //.css$/,
        loaders: [''style'', ''css''],
        //Include accepts either a path or an array of paths
        include: PATHS.app

      },
      //set up JSX. This accepts js too thanks to RegExp
      {
      test: //.(js|jsx)$/,
      //enable caching for improved performance during development
      //It uses default OS directory by default. If you need something more custom,
      //pass a path to it. ie: babel?cacheDirectory=<path>
      loaders: [
        ''babel?cacheDirectory,presets[]=es2015''
    ],
      //parse only app files Without this it will go thru the entire project.
      //beside being slow this will likely result in an error
      include: PATHS.app
      }
    ]
  }
};

// Default configuration. We will return this if
// Webpack is called outside of npm.
if(TARGET === ''start'' || !TARGET){
  module.exports = merge(common, {
    devtool: ''eval-source-map'',
    devServer: {
      contentBase: PATHS.build,

      //enable history API fallback so HTML5 HISTORY API based
      // routing works. This is a good default that will come in handy in more
      // complicated setups.
      historyApiFallback: true,
      hot: true,
      inline: true,
      progress: true,

      //display only errors to reduce output amount
      stats: ''errors only'',

      //Parse host and port from env so this is easy to customize
      host: process.env.HOST,
      port: process.env.PORT

},

plugins: [
  new webpack.HotModuleReplacementPlugin(),
  new NpmInstallPlugin({
    save: true //--save
  }),
  new FaviconsWebpackPlugin(''my-logo.png'')

]
});
}

if(TARGET === ''build'' || TARGET === ''stats'') {
  module.exports = merge(common, {
    entry: {
      vendor: Object.keys(pkg.dependencies).filter(function(v) {
        return v !== ''alt-utils'';
      }),
      style: PATHS.style
    },
    output: {
      path: PATHS.build,
      // Output using entry name
      filename: ''[name].[chunkhash].js'',
      chunkFilename: ''[chunkhash].js''
    },
    module: {
      loaders: [
        // Extract CSS during build
        {
          test: //.css$/,
          loader: ExtractTextPlugin.extract(''style'', ''css''),
          include: PATHS.app
        }
      ]
    },
    plugins: [
      // Output extracted CSS to a file
      new ExtractTextPlugin(''[name].[chunkhash].css''),
      // Extract vendor and manifest files
      new webpack.optimize.CommonsChunkPlugin({
        names: [''vendor'', ''manifest'']
      }),
      // Setting DefinePlugin affects React library size!
      new webpack.DefinePlugin({
        ''process.env.NODE_ENV'': ''"production"''
      }),
      new webpack.optimize.UglifyJsPlugin({
        compress: {
          warnings: false
        }
      })
    ]
  });
}

Este es mi archivo server.js:

/* Global Requires */

const express    = require(''express'');
const logger     = require(''morgan'');
const bodyParser = require(''body-parser'');
const path       = require(''path'');
const app        = express();
const ReactDOM = require(''react-dom'')
var favicon = require(''serve-favicon'');


if(process.env.NODE_ENV === ''development'') {
  console.log(''in development.'');
  require(''dotenv'').config();
} else {
  console.log(''in production.'');
}

/* App Config */
app.use(bodyParser.urlencoded({ extended: false }));
app.use(bodyParser.json());
app.use(express.static(path.join(__dirname, ''build'')));
app.use(favicon(__dirname + ''/public/favicon.ico''));

app.use(logger(''dev''));

/* Server Initialization */
app.get(''/'', (req, res) => res.sendFile(''index.html''));
var port = process.env.PORT || 3000;
app.listen(port, () => console.log(`Server initialized on // ${new Date()}`));

Answer 1

Agregar su favicon simplemente a la carpeta pública debería hacer. Asegúrese de que el favicon sea nombrado como "favicon.ico"

Answer 2

Así es como lo hice.

1. en public / index.html

   Agrega enlaces de favicon generados

2. en src / App.js

   importar ''/path/to/favicon.ico'';

3. en webpack.js

   nuevo HTMLWebpackPlugin ({favicon: ''/path/to/favicon.ico'',}),

Nota. Utilizo historyApiFallback en modo dev, pero no necesito tener ninguna configuración adicional para obtener el trabajo de favicon ni en el lado del servidor.

Answer 3

Es lo mismo que agregar cualquier otro script externo o hoja de estilo. Todo lo que tienes que hacer es enfocarte en dar la ruta correcta, y escribir y escribir .

Nota: cuando la imagen de mi favicon estaba en la carpeta de activos , no mostraba el favicon . Así que copié la imagen en la misma carpeta que mi index.html y funcionó perfectamente como debería.

<head>
    <link rel="shortcut icon" type="image/png/ico" href="/favicon.png" />
    <title>SITE NAME</title>
</head>

Funciono para mi Espero que funcione para usted también.

Answer 4

Los navegadores buscan su favicon en /favicon.ico , así que ahí es donde debe estar. Puede volver a verificar si lo ha colocado en el lugar correcto al navegar a [address:port]/favicon.ico y ver si aparece su icono.

En el modo dev, estás usando historyApiFallback, por lo que necesitarás configurar el paquete web para devolver explícitamente tu ícono para esa ruta:

historyApiFallback: {
    index: ''[path/to/index]'',
    rewrites: [
        // shows favicon
        { from: /favicon.ico/, to: ''[path/to/favicon]'' }
    ]
}

En su archivo server.js , intente volver a escribir explícitamente la url:

app.configure(function() {
    app.use(''/favicon.ico'', express.static(__dirname + ''[route/to/favicon]''));
});

(o sin embargo su configuración prefiere reescribir las URL)

Sugiero generar un verdadero archivo .ico lugar de usar un .png , ya que me parece que es más confiable en todos los navegadores.

Answer 5

Otra alternativa es

npm install react-favicon

Y en tu aplicación simplemente harías:

   import Favicon from ''react-favicon'';
   //other codes

    ReactDOM.render(
        <div>
            <Favicon url="/path/to/favicon.ico"/>
            // do other stuff here
        </div>
        , document.querySelector(''.react''));

Answer 6

Para futuros googlers: también puede usar copy-webpack-plugin y agregar esto a la configuración de producción de webpack:

plugins: [
  new CopyWebpackPlugin([
    // relative path is from src
    { from: ''./static/favicon.ico'' }, // <- your path to favicon
  ])
]

Answer 7

Utilice el cargador de archivos para eso:

{
    test: //.(svg|png|gif|jpg|ico)$/,
    include: path.resolve(__dirname, path),
    use: {
        loader: ''file-loader'',
        options: {
            context: ''src/assets'',
            name: ''root[path][name].[ext]''
        }
    }
}