@bitrise/beam

Beam

Beam is a JavaScript widget that add-on developers can embed into their page to allow users to return to Bitrise. It has no dependencies and works on a wide variety of screen sizes and browser versions.

Screenshots

Usage

Install:

npm install @bitrise/beam

var Beam = require("@bitrise/beam").Beam;
import { Beam } from "@bitrise/beam";

// after DOMContentLoaded
Beam.init({
  // options
});

Or include into a webpage

<script src="https://unpkg.com/@bitrise/beam@<version>/dist/beam.min.js"></script>
<script type="text/javascript">
  Beam.init({
    // options
  });
</script>

Options

• anchor: node to attach Beam to, document.body by default
• app_slug: slug for the app whole add-on page we're on
• app_name: name of the app whose add-on page we're on
• addon_documentation: URL to the documentation for this addon

Local example

Beam can be run locally using webpack-dev-server.