Code Monkey home page Code Monkey logo

osagai's Introduction

Osagai ๐Ÿ€„๏ธ Build Status

A tiny library in a functional and browser way.

Why?

Creating WebComponent shouldn't be limited to extending classes. It should be easy to create and in a functional way. It should be able to be framework-agnostic and be reused in different libraries. Updating components should be fast and it should use native solutions without VirtualDOM and data binding magics. It should not need build processes for compiling non native solution (JSX) and take advantage in what the language has. (Template literal)

Install

You can get it on npm.

npm install osagai

Or import from unpkg

import { define } from "https://unpkg.com/osagai/osagai.mjs";
import { on } from "https://unpkg.com/osagai/events.mjs";

Define a Web component

Osagai comes with a function called define that defines a new custom element that you can use in your application. define receives the name of the custom element (it must contain a hyphen) and the Osagai component. The Osagai component is a function that returns a Template with a string representing the layout of the web component.

import { define } from 'osagai'

function MyComponent() {
	return () => `<h1>Hi ๐Ÿ‘‹!</h1>`
}

define('waving-hand', MyComponent)

Now, you just need to use your new custom element in your application.

<waving-hand></waving-hand>

Example

<!DOCTYPE html>
<html lang="en">
  <title>Osagai demo</title>

  <x-items></x-items>

  <script type="module">
    import { define } from "https://unpkg.com/osagai/osagai.mjs";
    import { on } from "https://unpkg.com/osagai/events.mjs";
    import { update } from "https://unpkg.com/osagai/dom.mjs";

    function Items({ element, query }) {
      const initialState = {
        items: []
      };

      on("click", query(".btn"), () => {
        update(element, ({ items } = initialState) => {
          items.push({
            name: `Item nr ${items.length + 1}`
          });

          return {
            items
          };
        });
      });

      return ({ items } = initialState) => `
        <div>
          <button class="btn">Add item</button>
          <ul class="list">
            ${items.map(item => `<li>${item.name}</li>`).join("")}
          </ul>
        </div>`;
    }

    define("x-items", Items);
  </script>
</html>

Project status

Osagai is still under development and it needs some feedback from the community. If you want to collaborate, please add an issue or PR with your suggestions or concerns.

osagai's People

Contributors

henriquelimas avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

Forkers

semmel

osagai's Issues

query and queryAll don't work in the shadow dom

in lib/define.js:

query: query(this), // <-- bound to the element not element.shadowRoot
queryAll: queryAll(this)

Although it's easy to just element.shadowRoot.querySelector(sel), I might be missing something here? It seems to me that shadow dom is one of the key benefits of web components.

Also just out of curiosity, why do query and queryAll return Promises? It's not that I could not handle it, but I don't find any indicator why this is necessary.

Btw. I really appreciate the osagai's functional approach - it makes all that class noise go away ๐Ÿ˜„. Also like to compliment you on the beautiful documentation - it really shines ๐ŸŒป !

Move when the onConnected is run

Right now the onConnected callbacks run before rendering the elements in the DOM. It should be more useful to run it later when the template is already in the DOM so can be manipulated.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.