@lrnwebcomponents/beaker-broker

<beaker-broker>

Broker

A broker element that can play nicely with Beaker Browser and make the API even easier to work with then it already is.

Usage

To use this web component in your project you can utilize one of the following styles of syntax.

/* In an existing module / web component */
import '@lrnwebcomponents/beaker-broker/beaker-broker.js';
/* At top of an application */
<script type="module" src="node_modules/@lrnwebcomponents/beaker-broker/beaker-broker.js"></script>
/* Alternatives for top of application */
<script type="module">
  import '@lrnwebcomponents/beaker-broker/beaker-broker.js';

  import {BeakerBroker} from '@lrnwebcomponents/beaker-broker/beaker-broker.js';
</script>

Develop / Demo

Run yarn start will start a local development server, open your default browser to display it, open your finder to the correct window and start watching the /src directory for changes and automatically rebuilding the element and documentation site for the demo.

$ yarn start

Test

$ yarn run test

Build

Builds ensure that wcfactory can correctly compile your web component project to work on the maximum number of browsers possible.

$ yarn run build

Contributing

1. Fork it! git clone [e-mail]/elmsln/lrnwebcomponents.git
2. Create your feature branch: git checkout -b my-new-feature
3. Commit your changes: git commit -m 'Add some feature'
4. Push to the branch: git push origin my-new-feature
5. Submit a pull request :D

Code style

Broker (and all lrnwebcomponents) use Prettier to auto-format JS and JSON. The style rules get applied when you commit a change. If you choose to, you can integrate your editor with Prettier to have the style rules applied on every save.

License

Apache-2.0 License