To help you get started, we've collected the most common ways that hybrids is being used within popular public projects.

vogloblinsky / web-components-benchmark / todomvc / hybrids / js / todo-input.js View on Github

border: 0;
        outline: none;
        color: inherit;
        padding: 6px;
        border: 1px solid #CCC;
        box-shadow: inset 0 -1px 5px 0 rgba(0, 0, 0, 0.2);
        box-sizing: border-box;
    }

<form id="new-todo-form">
    <input placeholder="What needs to be done?" type="text" id="new-todo">
</form>
      `,
};

define('todo-input', TodoInput);

View more ways to use hybrids

> An extraordinary JavaScript framework for creating client-side web applications, UI components libraries, or single web components with unique mixed declarative and functional architecture

Hybrids provides a complete set of features for building modern web applications:

• Component Model based on plain objects and pure functions
• Global State Management with external storages, offline caching, relations, and more
• App-like Routing based on the graph structure of views
• Layout Engine making UI layouts development much faster
• Localization with automatic translation of the templates content
• Hot Module Replacement out of the box support and other DX features

Documentation

The project documentation is available at the hybrids.js.org site.

Quick Look

Component Model

It's based on plain objects and pure functions[^1], still using the Web Components API under the hood:

import { html, define } from "hybrids";
  
function increaseCount(host) {
  host.count += 1;
}

export default define({
  tag: "simple-counter",
  count: 0,
  render: ({ count }) => html`
    <button>
      Count: ${count}
    </button>
  `,
});

You can read more in the Component Model section.

Global State Management

A global state management uses declarative model definitions with support for async external storages, relations, offline caching, and many more:

import { define, store, html } from "hybrids";

const User = {
  id: true,
  firstName: "",
  lastName: "",
  [store.connect] : {
    get: id => fetch(`/users/${id}`).then(...),
  },
};

define({
  tag: "user-details",
  user: store(User),
  render: ({ user }) => html`
    <div>
      ${store.pending(user) &amp;&amp; `Loading...`}
      ${store.error(user) &amp;&amp; `Something went wrong...`}

      ${store.ready(user) &amp;&amp; html`
        <p>${user.firstName} ${user.lastName}</p>
      `}
    </div>
  `,
});

You can read more in the Store section.

App-like Routing

Rather than just matching URLs with the corresponding components, the router depends on a tree-like structure of views, which have their own routing configuration. It makes the URLs optional, have out-the-box support for dialogs, protected views, and many more.

import { define, html, router } from "hybrids";

import Details from  "./details.js";

const Home = define({
  [router.connect]: { stack: [Details, ...] },
  tag: "app-home",
  content: () => html`
    <template>
      <h1>Home</h1>
      <nav>
        <a href="${router.url(Details)}">Details</a>
      </nav>
      ...
    </template>  
  `,
});

export define({
  tag: "app-router",
  stack: router(Home),
  content: ({ stack }) =&gt; html`
    <template>
      ${stack}
    </template>
  `,
});

You can read more in the Router section.

Layout Engine

Create CSS layouts in-place in templates, even without using Shadow DOM, but still keeping the encapsulation of the component's styles:

define({
  tag: "app-home-view",
  content: () => html`
    <template>
      <div>
        <h1>Home</h1>
        ...
      </div>

      <footer>...</footer>
    </template>
  `
});

You can read more in the Layout Engine section of the documentation.

Localization

The library supports automatic translation of the component's content, which makes translation seamless and easy to integrate. Additionally, it provides a way to add dynamic messages with plural forms, HTML content, or use messages outside of the template context. Also, it comes with handy CLI tool to extract messages from the source code!

import { define, html, localize } from "hybrids";

export default define({
  tag: "my-element",
  name: "",
  render: ({ name }) => html`
    <div>Hello ${name}!</div>
  `,
});

localize("pl", {
  "Hello ${0}!": {
    message: "Witaj ${0}!",
  },
});

You can read more in the Localization section of the documentation.

Community

Do you need help? Something went wrong? Feel free to create an issue in the github repository or join the Gitter channel.

License

Hybrids is released under the MIT License.

[^1]: Pure functions only apply to the component definition. Side effects attached to event listeners might mutate the host element.