@frctl/web-plugin

v0.9.14
A web UI for your Fractal pattern library.

Fractal web plugin

A theme-able web UI for your Fractal component library.

This plugin comes bundled with Fractal by default so does not need to be installed separately.

Usage

See the Fractal documentation for usage information.

Configuration

This plugin exposes the following configuration defaults:

{
    port: null,
    static: {
        path: null,
        mount: '/'
    },
    build: {
        path: 'build',
        concurrency: 100,
        root: null
    },
    sync: false,
    favicon: null,
    middleware: [],
    theme: '@frctl/mandelbrot',
    engine: {}
}

These can be configured in your fractal.js file using a path that looks like plugins.web.[path]. For example:

const fractal = require('@frctl/fractal');

fractal.set('plugins.web.port', 5000);
fractal.set('plugins.web.build.path', 'exports/build');
npm i @frctl/web-plugin

Metadata

  • MIT
  • >= 4.0.0
  • Mark Perkins
  • released 5/5/2016

Downloads

Maintainers