Skip to content

Latest commit

 

History

History
209 lines (154 loc) · 3.86 KB

README.md

File metadata and controls

209 lines (154 loc) · 3.86 KB
Raw

Refable

Super simple JS framework inspired by Stimulus.

Installation

npm install refable --save-dev

Application

Application is the main class for bootstrapping. Controllers are registered on an application instance. For registering glob of controllers please refer to your bundler's documentation.

import { Application } from "refable";
import Search from "./controllers/search";

const application = new Application();

application.register("search", Search);

application.run();

Controllers

Controllers are instances of classes that you register in your application. Each controller class inherits from the Controller base class. Controllers can be nested within controllers and can be referenced in the parent controller.

<div data-controller="search">
  <div data-controller="result"></div>
</div>
import { Controller } from "refable";
import Result from "./controllers/result";

export default class extends Controller {
  declare readonly resultController: Result;
  declare readonly resultControllers: Result[];

  created() {
    //
  }

  connected() {
    //
  }

  disconnected() {
    //
  }

  resultControllerConnected(result: Result) {
    //
  }

  resultControllerDisconnected(result: Result) {
    //
  }
}

Controller classes are templated so more specific elements can be used if needed.

import { Controller } from "refable";

export default class extends Controller<HTMLElement> {
  //
}

Values

<div data-controller="search" data-some-value="1"></div>
import { Controller } from "refable";

export default class extends Controller {
  declare readonly someValue: string;

  someValueChanged(value: string) {
    //
  }
}

Targets

Targets map important elements to controller properties.

<div data-controller="search">
  <div data-target="result"></div>
</div>
import { Controller } from "refable";

export default class extends Controller {
  declare readonly resultTarget: Element;
  declare readonly resultTargets: Element[];

  resultTargetConnected(el: Element) {
    //
  }

  resultTargetDisconnected(el: Element) {
    //
  }
}

Actions

Actions are for handling DOM events in controllers.

<div data-controller="search">
  <button data-action="click->find">Find</button>
</div>
import { Controller } from "refable";

export default class extends Controller {
  find() {
    //
  }
}

Action Options

You can append one or more action options to an action descriptor if you need to specify event listener options.

<button data-action="click->find[:option]">Find</button>

Following action options are supported:

:capture
:once
:passive
:stop
:prevent

Events

The Controller class has a method called dispatch that fires custom events. It takes an event name and an optional payload as arguments.

<div data-controller="search">
  <button data-action="click->find">Find</button>
</div>
import { Controller } from "refable";

export default class extends Controller {
  find(event: Event) {
    this.dispatch("found", { result: "found" });
  }
}

The dispatched event can be catched with an action in a parent element and handled in a different controller like an action. Optional payload is in event parameter's detail property.

Plain JS Example

<!DOCTYPE html>
<html>
  <head>
    <meta charset="UTF-8" />
  </head>
  <body data-controller="home">
    <script type="module">
      import {
        Application,
        Controller,
      } from "https://cdn.jsdelivr.net/npm/refable@0.0.9/+esm";

      class Home extends Controller {
        connected() {
          console.log("Connected");
        }
      }

      const application = new Application();

      application.register("home", Home);
      application.run();
    </script>
  </body>
</html>