pattern-lab/plugin-reload

Automatic Browser Reload Support for Pattern Lab

Installs: 152 981

Dependents: 2

Suggesters: 0

Security: 0

Stars: 7

Watchers: 5

Forks: 7

Open Issues: 4

Type:patternlab-plugin

v2.0.1 2016-07-03 00:36 UTC

This package is auto-updated.

Last update: 2024-11-06 12:45:13 UTC


README

license Packagist Gitter

Reload Plugin for Pattern Lab

The Reload Plugin adds Web Socket-based automatic browser reload support to Pattern Lab. The Reload Plugin will automatically reload the Pattern Lab iFrame if you're using the --watch flag or --server --with-watch flag combo.

Installation

To add the Reload Plugin to your project using Composer type:

composer require pattern-lab/plugin-reload

See Packagist for information on the latest release.

Usage

The Reload Plugin is automatically turned on when you install it. Simply "watch" your project using the following command:

php core/console --watch

You can also run your server and watch your project at the same time:

php core/console --server --with-watch

Disabling the Plugin

To disable the Reload Plugin you can either directly edit ./config/config.yml or use the command line option:

php core/console --config --set plugins.reload.enabled=false