bay.js

What is bay.js?

Bay.js is a frontend library designed to facilitate the creation of reusable web-components, as well as to add state and interactivity to HTML. To see it in action, you can visit Bayjs.org and explore its examples.

Key features

• Optional build step: Simply add a script tag to get started.
• Strict Content Security Policy (CSP) compatibility, even without a build step.
• Versatile rendering: Regular DOM or web-component formats.
• Zero dependencies for lightweight implementation.
• Single-file bundling capability for streamlined components.
• Seamless integration with frameworks designed for rendering web-components.
• URL-based templates: Enable server-side rendering (SSR) or PHP-based templates.
• Utilize <template> in the DOM as a template source.
• Component creation from JavaScript strings for dynamic customization.
• User-friendly syntax for effortless development.

Installation

Bay.js can be used via a script tag or importing as a module.

Script tag:

<script src="//cdn.jsdelivr.net/npm/@dunks1980/bay.js/bay.min.js"></script>

Script tag example

ES Module:

<script type="module" src="main.js"></script>

// In main.js
import bay from '//cdn.jsdelivr.net/npm/@dunks1980/bay.js/bay.min.mjs';
bay();

You may want to add a version number like this to prevent breaking changes: '//cdn.jsdelivr.net/npm/@dunks1980/bay.js@< VERSION >/bay.min.mjs' the version number is optional and can be acquired from going to the npm package page. Or if using node_modules: './node_modules/@dunks1980/bay.js/bay.min.mjs';
ES Module example

NPM Module:

npm i @dunks1980/bay.js
import bay from '@dunks1980/bay.js';
bay();

NPM example

Settings:

import bay from ...

bay({
  text: `<h1 :style="margin: 1rem;">Settings</h1>`,
});

<template id="my-template">
  %{text} <!-- becomes: --> <h1 :style="margin: 1rem;">Settings</h1> 
</template>

<my-component bay="#my-template" message="Hello world!"></my-component>

Settings can only be set with ES or NPM modules, must be strings, and they can only be set once before creating components. Settings variables can be used anywhere within the templates.
Settings example

Usage

There are a few ways to define a component in bay.js:

1. Template with bay attribute in the DOM.

In your html create an inline template and apply bay attribute and any other props:

<template bay="my-component-name" message>
  <h1>${this.message}</h1>
</template>

<my-component-name message="Hello world!"></my-component-name>

2. Template with id in the DOM.

In your html create an inline template and supply bay.js the templates id:

<template id="my-template">
  <h1>${this.message}</h1>
</template>

<my-component bay="#my-template" message="Hello world!"></my-component>

3. Template in a file.

Create a file and supply bay.js the url (don't wrap file contents in template). The file extension can be anything you like as long as its contents are in the HTML format:

<my-component bay="/url/to/my/components.html" message="Hello world!"></my-component>
<!-- or -->
<my-component bay="/url/to/my/components.php" message="Hello world!"></my-component>

<!-- in component file -->
<h1>${this.message}</h1>

4. Create a template with JS.

Pass bay.js the imported template:

import my_component from "./../component_imports/my_component.html?raw";
import bay from "@dunks1980/bay.js";
bay();
bay.create("my-component", my_component, ["message"]);

Or create template and pass it: ( $ and ` within the string will need \ escaping if string literal)

import bay from "@dunks1980/bay.js";
bay();
bay.create("my-component", `<h1>\${this.message}</h1>`, ["message"]);

<!-- Anywhere in the HTML including other components -->
<my-component message="Hello world!"></my-component>

5. Using bay-hydrate.

In your html create an inline element with a template inside, then add bay-hydrate to the containing element:

<div bay-hydrate>
  <h1>This will be replaced once bay creates the component.</h1>
  <template>
    <h1>${this.message}</h1>
    <script>this.message = 'Hello World!'</script>
  </template>
</div>

Props will not be available using this method, but you can use settings. Content is rendered to the main DOM so styles will not be encapsulated and <style> tags defined within the template will have no effect.

A component can be used anywhere in the HTML but inline templates must be in the body of the document. "my-component" can be anything you like but it must have a dash in the name per the custom element spec.

Tags in components:

Internal Variables:

Attributes On Component:

Internal Attributes:

Script Lifecycle:

External Functions:

Internal Functions: