Giter VIP home page Giter VIP logo

fragment-loader's Introduction

npm node deps tests cover chat size

fragment-loader

Getting Started

To begin, you'll need to install fragment-loader:

$ npm install fragment-loader --save-dev

Then add the loader to your webpack config. For example:

file.html

import file from 'file.html';

webpack.config.js

module.exports = {
  module: {
    rules: [
      {
        test: /.html$/,
        use: [
          {
            loader: `fragment-loader`,
            options: {
              ...options,
            },
          },
        ],
      },
    ],
  },
};

And run webpack via your preferred method.

Options

esModule

Type: boolean Default: false

Use ES modules syntax

webpack.config.js

module.exports = {
  module: {
    rules: [
      {
        loader: `fragment-loader`,
        options: {
          esModule: false,
        },
      },
    ],
  },
};

Examples

Use With html-loader

To use fragment-loader with html-loader, you will need another loader to evaluate the return value of html-loader, since it returns a javscript module and fragment-loader expects only a string. In this example, "execute-loader" is an installed loader that runs eval() on its content. You can make this loader yourself or find one that does this.

webpack.config.js

const path = require('path');
module.exports = {
  module: {
    rules: [
      {
        test: /\.fragment\.html$/,
        use: ['fragment-loader', 'execute-loader', 'html-loader'],
      },
    ],
  },
};

src/file.fragment.html

<h1>Hello from another file!</h1>

src/index.js

import fragment from './file.fragment.html';

// ... do whatever with this DocumentFragment,
// such as document.body.appendChild(fragment)

Add Typescript Typings

To add Typescript typings to *.html modules imported with fragment-loader, create @types/html.d.ts like below:

@types/html.d.ts

module '*.html' {
  const value: DocumentFragment;
  export default value;
}

Contributing

Please take a moment to read our contributing guidelines if you haven't yet done so.

CONTRIBUTING

License

MIT

fragment-loader's People

Contributors

jklein64 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.