Skip to content

vladshcherbin/rollup-plugin-svelte-static-html

Repository files navigation

rollup-plugin-svelte-static-html

Build Status Codecov

Generate static html file from your Svelte component using Rollup.

Installation

# yarn
yarn add rollup-plugin-svelte-static-html -D

# npm
npm install rollup-plugin-svelte-static-html -D

Usage

// rollup.config.js
import svelteStaticHtml from 'rollup-plugin-svelte-static-html'

export default {
  input: 'src/index.js',
  output: {
    file: 'dist/app.js',
    format: 'iife'
  },
  plugins: [
    svelteStaticHtml({
      component: 'src/App.svelte',
      output: 'dist/index.html',
      template: 'src/assets/template.html'
    })
  ]
}

Configuration

There are some useful options:

component

Type: string

Path to the component from which html is generated.

svelteStaticHtml({
  component: 'src/App.svelte'
})

output

Type: string

Path for the generated html file.

svelteStaticHtml({
  component: 'src/App.svelte',
  output: 'dist/index.html'
})

template

Type: string

Path to the template to use. When not set, only component html is saved.

svelteStaticHtml({
  component: 'src/App.svelte',
  output: 'dist/index.html',
  template: 'src/assets/template.html'
})

selector

Type: string | Default: body

Selector to append generated component html to. Can be a tag, a class or an id. Only used only when template is set.

svelteStaticHtml({
  component: 'src/App.svelte',
  output: 'dist/index.html',
  template: 'src/assets/template.html',
  selector: '#widget'
})

props

Type: object

Properties to pass to the component.

svelteStaticHtml({
  component: 'src/App.svelte',
  output: 'dist/index.html',
  props: {
    name: 'Jack'
  }
})

inlineCss

Type: boolean | Default: false

Add component css to the top of generated html or append to head if template is set.

svelteStaticHtml({
  component: 'src/App.svelte',
  output: 'dist/index.html',
  inlineCss: true
})

preprocess

Type: array | object

Preprocess the component. By default, svelte-preprocess is used in auto mode.

svelteStaticHtml({
  component: 'src/App.svelte',
  output: 'dist/index.html',
  preprocess: [
    scss(),
    pug()
  ]
})

License

MIT

About

Generate static html file from your Svelte component using Rollup

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published