Ir ao contido principal Ir á navegación de documentos
Check
in English

Bootstrap e paquete web

A guía oficial de como incluír e agrupar CSS e JavaScript de Bootstrap no teu proxecto usando Webpack.

Nesta páxina
Queres saltar ata o final? Descarga o código fonte e a demostración de traballo desta guía desde o repositorio twbs/examples . Tamén podes abrir o exemplo en StackBlitz para a edición en directo.

Montar

Estamos construíndo un proxecto Webpack con Bootstrap desde cero, polo que hai algúns requisitos previos e pasos previos antes de poder comezar realmente. Esta guía require que teñas instalado Node.js e algo de familiaridade co terminal.

  1. Crea un cartafol do proxecto e configura npm. Crearemos o my-projectcartafol e inicializaremos npm co -yargumento para evitar que nos faga todas as preguntas interactivas.

    mkdir my-project && cd my-project
npm init -y

  2. Instalar Webpack. A continuación, necesitamos instalar as nosas dependencias de desenvolvemento de Webpack: webpackpara o núcleo de Webpack, webpack-clipara que poidamos executar comandos de Webpack desde o terminal, e webpack-dev-serverasí poder executar un servidor de desenvolvemento local. Usamos --save-devpara sinalar que estas dependencias son só para o desenvolvemento e non para a produción.

    npm i --save-dev webpack webpack-cli webpack-dev-server

  3. Instalar Bootstrap. Agora podemos instalar Bootstrap. Tamén instalaremos Popper xa que os nosos menús despregables, popovers e informacións sobre ferramentas dependen del para o seu posicionamento. Se non pensas usar eses compoñentes, podes omitir Popper aquí.

    npm i --save bootstrap @popperjs/core

  4. Instala dependencias adicionais. Ademais de Webpack e Bootstrap, necesitamos algunhas dependencias máis para importar e agrupar correctamente o CSS e o JS de Bootstrap con Webpack. Estes inclúen Sass, algúns cargadores e Autoprefixer.

    npm i --save-dev autoprefixer css-loader postcss-loader sass sass-loader style-loader

Agora que temos todas as dependencias necesarias instaladas, podemos poñernos a traballar creando os ficheiros do proxecto e importando Bootstrap.

Estrutura do proxecto

Xa creamos o my-projectcartafol e inicializamos npm. Agora tamén crearemos os nosos cartafoles srce distpara completar a estrutura do proxecto. Executa o seguinte desde my-project, ou crea manualmente o cartafol e a estrutura de ficheiros que se mostran a continuación.

mkdir {dist,src,src/js,src/scss}
touch dist/index.html src/js/main.js src/scss/styles.scss webpack.config.js

Cando remates, o teu proxecto completo debería verse así:

my-project/
├── dist/
│   └── index.html
├── src/
│   ├── js/
│   │   └── main.js
│   └── scss/
│       └── styles.scss
├── package-lock.json
├── package.json
└── webpack.config.js

Neste momento, todo está no lugar correcto, pero Webpack non funcionará porque aínda non enchemos o noso webpack.config.js.

Configurar Webpack

Con dependencias instaladas e o noso cartafol do proxecto preparado para que comecemos a codificar, agora podemos configurar Webpack e executar o noso proxecto localmente.

  1. Abre webpack.config.jsno teu editor. Xa que está en branco, necesitaremos engadirlle algunha configuración estándar para que poidamos iniciar o noso servidor. Esta parte da configuración indica que Webpack debería buscar o JavaScript do noso proxecto, onde sacar o código compilado ( dist) e como debería comportarse o servidor de desenvolvemento (tirando do distcartafol con recarga en quente).

    const path = require('path')

module.exports = {
  entry: './src/js/main.js',
  output: {
    filename: 'main.js',
    path: path.resolve(__dirname, 'dist')
  },
  devServer: {
    static: path.resolve(__dirname, 'dist'),
    port: 8080,
    hot: true
  }
}

  2. A continuación enchemos o noso dist/index.html. Esta é a páxina HTML que Webpack cargará no navegador para utilizar os CSS e JS que engadiremos a ela en pasos posteriores. Antes de que poidamos facelo, temos que darlle algo para renderizar e incluír o outputJS do paso anterior.

    <!doctype html>
<html lang="en">
  <head>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <title>Bootstrap w/ Webpack</title>
  </head>
  <body>
    <div class="container py-4 px-3 mx-auto">
      <h1>Hello, Bootstrap and Webpack!</h1>
      <button class="btn btn-primary">Primary button</button>
    </div>
    <script src="./main.js"></script>
  </body>
</html>

    Incluimos aquí un pouco de estilo Bootstrap co div class="container"e <button>para que vexamos cando Webpack carga o CSS de Bootstrap.

  3. Agora necesitamos un script npm para executar Webpack. Abre package.jsone engade o startscript que se mostra a continuación (xa deberías ter o script de proba). Usaremos este script para iniciar o noso servidor de desenvolvemento de Webpack local.

    {
  // ...
  "scripts": {
    "start": "webpack serve --mode development",
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  // ...
}

  4. E por último, podemos iniciar Webpack. Desde o my-projectcartafol do teu terminal, executa ese script npm recén engadido:

    npm start
    Servidor de desenvolvemento de Webpack en execución

Na seguinte e última sección desta guía, configuraremos os cargadores de Webpack e importaremos todos os CSS e JavaScript de Bootstrap.

Importar Bootstrap

Importar Bootstrap a Webpack require os cargadores que instalamos na primeira sección. Instalámolos con npm, pero agora hai que configurar Webpack para usalos.

  1. Configura os cargadores en webpack.config.js. O teu ficheiro de configuración xa está completo e debería coincidir co seguinte fragmento. A única parte nova aquí é a modulesección.

    const path = require('path')

module.exports = {
  entry: './src/js/main.js',
  output: {
    filename: 'main.js',
    path: path.resolve(__dirname, 'dist')
  },
  devServer: {
    static: path.resolve(__dirname, 'dist'),
    port: 8080,
    hot: true
  },
  module: {
    rules: [
      {
        test: /\.(scss)$/,
        use: [
          {
            loader: 'style-loader'
          },
          {
            loader: 'css-loader'
          },
          {
            loader: 'postcss-loader',
            options: {
              postcssOptions: {
                plugins: () => [
                  require('autoprefixer')
                ]
              }
            }
          },
          {
            loader: 'sass-loader'
          }
        ]
      }
    ]
  }
}

    Aquí tes un resumo de por que necesitamos todos estes cargadores. style-loaderinxecta o CSS nun <style>elemento <head>da páxina HTML, css-loaderaxuda a usar @importe url(), postcss-loaderé necesario para Autoprefixer e sass-loaderpermítenos usar Sass.

  2. Agora, imos importar o CSS de Bootstrap. Engade o seguinte a src/scss/styles.scsspara importar toda a fonte Sass de Bootstrap.

    // Import all of Bootstrap's CSS
@import "~bootstrap/scss/bootstrap";

    Tamén podes importar as nosas follas de estilo individualmente se queres. Lea os nosos documentos de importación de Sass para obter máis detalles.

  3. A continuación cargamos o CSS e importamos o JavaScript de Bootstrap. Engade o seguinte a src/js/main.jspara cargar o CSS e importar todos os JS de Bootstrap. Popper importarase automaticamente a través de Bootstrap.

    // Import our custom CSS
import '../scss/styles.scss'

// Import all of Bootstrap's JS
import * as bootstrap from 'bootstrap'

    Tamén pode importar complementos de JavaScript individualmente segundo sexa necesario para reducir o tamaño dos paquetes:

    import Alert from 'bootstrap/js/dist/alert'

// or, specify which plugins you need:
import { Tooltip, Toast, Popover } from 'bootstrap'

    Lea os nosos documentos de JavaScript para obter máis información sobre como usar os complementos de Bootstrap.

  4. E xa estás! 🎉 Co Sass e JS de orixe de Bootstrap cargados completamente, o teu servidor de desenvolvemento local debería verse así.

    Servidor de desenvolvemento de Webpack en execución con Bootstrap

    Agora podes comezar a engadir calquera compoñentes de Bootstrap que queiras usar. Asegúrate de consultar o proxecto de exemplo Webpack completo para ver como incluír Sass personalizado adicional e optimizar a túa compilación importando só as partes do CSS e JS de Bootstrap que necesites.

Optimizacións da produción

Dependendo da súa configuración, pode querer implementar algunhas optimizacións adicionais de seguridade e velocidade útiles para executar o proxecto en produción. Teña en conta que estas optimizacións non se aplican ao proxecto de exemplo de Webpack e dependen de vostede para implementar.

Extracción de CSS

O style-loaderque configuramos anteriormente emite CSS de forma conveniente no paquete, polo que dist/index.htmlnon é necesario cargar manualmente un ficheiro CSS. Non obstante, é posible que este enfoque non funcione cunha política de seguranza de contido estrita e pode converterse nun pescozo de botella na túa aplicación debido ao gran tamaño do paquete.

Para separar o CSS para cargalo directamente desde dist/index.html, utiliza o mini-css-extract-loadercomplemento Webpack.

Primeiro, instala o complemento:

npm install --save-dev mini-css-extract-plugin

A continuación, cree unha instancia e use o complemento na configuración do Webpack:

--- a/webpack/webpack.config.js
+++ b/webpack/webpack.config.js
@@ -1,8 +1,10 @@
+const miniCssExtractPlugin = require('mini-css-extract-plugin')
 const path = require('path')
 
 module.exports = {
   mode: 'development',
   entry: './src/js/main.js',
+  plugins: [new miniCssExtractPlugin()],
   output: {
     filename: "main.js",
     path: path.resolve(__dirname, "dist"),
@@ -18,8 +20,8 @@ module.exports = {
         test: /\.(scss)$/,
         use: [
           {
-            // Adds CSS to the DOM by injecting a `<style>` tag
-            loader: 'style-loader'
+            // Extracts CSS for each JS file that includes CSS
+            loader: miniCssExtractPlugin.loader
           },
           {

Despois de executar de npm run buildnovo, haberá un novo ficheiro dist/main.css, que conterá todos os CSS importados por src/js/main.js. Se ves dist/index.htmlagora no teu navegador, faltará o estilo, como está agora en dist/main.css. Podes incluír o CSS xerado dist/index.htmldeste xeito:

--- a/webpack/dist/index.html
+++ b/webpack/dist/index.html
@@ -3,6 +3,7 @@
   <head>
     <meta charset="utf-8">
     <meta name="viewport" content="width=device-width, initial-scale=1">
+    <link rel="stylesheet" href="./main.css">
     <title>Bootstrap w/ Webpack</title>
   </head>
   <body>

Extracción de ficheiros SVG

O CSS de Bootstrap inclúe varias referencias a ficheiros SVG mediante data:URIs en liña. Se defines unha Política de seguranza de contido para o teu proxecto que bloquee os data:URI das imaxes, estes ficheiros SVG non se cargarán. Podes evitar este problema extraendo os ficheiros SVG en liña usando a función de módulos de activos de Webpack.

Configure Webpack para extraer ficheiros SVG en liña como este:

--- a/webpack/webpack.config.js
+++ b/webpack/webpack.config.js
@@ -16,6 +16,14 @@ module.exports = {
   },
   module: {
     rules: [
+      {
+        mimetype: 'image/svg+xml',
+        scheme: 'data',
+        type: 'asset/resource',
+        generator: {
+          filename: 'icons/[hash].svg'
+        }
+      },
       {
         test: /\.(scss)$/,
         use: [

Despois de executar de npm run buildnovo, atoparás os ficheiros SVG extraídos dist/iconse referenciados correctamente desde CSS.

Ves algo incorrecto ou desactualizado aquí? Abre un problema en GitHub . Necesitas axuda para solucionar problemas? Busca ou inicia unha discusión en GitHub.