JSPM

  • Created
  • Published
  • Downloads 11916
  • Score
    100M100P100Q122287F
  • License MIT

A JavaScript framework for creating fully-featured web applications, components libraries, and single web components with unique declarative and functional architecture

Package Exports

    Readme

    hybrids

    build status coverage status npm version

    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 support without any additional configuration

    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 onclick="${increaseCount}">
          Count: ${count}
        </button>
      `,
    });
    <simple-counter count="42"></simple-counter>

    Open in StackBlitz

    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) && `Loading...`}
          ${store.error(user) && `Something went wrong...`}
    
          ${store.ready(user) && html`
            <p>${user.firstName} ${user.lastName}</p>
          `}
        </div>
      `,
    });
    <user-details user="2"></user-details>

    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",
      render: () => html`
        <template layout="column">
          <h1>Home</h1>
          <nav layout="row gap">
            <a href="${router.url(Details)}">Details</a>
          </nav>
          ...
        </template>  
      `,
    });
    
    export define({
      tag: "app-router",
      stack: router(Home),
      render: ({ stack }) => html`
        <template layout="column">
          ${stack}
        </template>
      `,
    });
    <app-router></app-router>

    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",
      render: () => html`
        <template layout="column center gap:2">
          <div layout="grow grid:1|max">
            <h1>Home</h1>
            ...
          </div>
    
          <footer layout@768px="hidden">...</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.