@authman2/mosaic
TypeScript icon, indicating that this package has built-in type declarations

0.6.7 • Public • Published

Mosaic logo

npm Downloads NPM

Mosaic

Mosaic is a declarative front-end JavaScript library for building user interfaces!

💠 (Web) Component-Based: Mosaic uses the Custom Elements API to create web components that can keep track of their own data, actions, and more, and can be included in other components to create single page applications.

⚡️ Observable Data: Mosaic uses Observables to keep track of changes to a component's data. This means that there is no need to call "setState" or anything like that to update a component - instead just change the data directly.

🧠 Smart DOM: Updates in Mosaic work by remembering which nodes are dynamic (i.e. subject to change) and traveling directly to those nodes to make changes, rather than traversing the tree again.

🔀 Built-in Router: Comes with a basic, client-side router which allows Mosaic components to be used as separate pages.

🌐 State Manager: Comes with a built-in global state manager called Portfolio.

👌 Small Library Size: The minified Mosaic library comes in at a size of 22KB.

🔖 Tagged Template Literals: Views are written using tagged template literals, which means there is no need for a compiler:

const name = "Mosaic";
html`<h1>Welcome to ${name}!</h1>`

Demo

Here is an example of a simple Mosaic application. All you need is an index.html file and an index.js file. For a more detailed example, run the project inside the "example" folder.

index.html:

<html>
  <head>
    <title>My Mosaic App</title>
  </head>
    
  <div id='root'></div>

  <script src='https://unpkg.com/@authman2/mosaic@latest/dist/index.js'></script>
  <script type="text/javascript" src='./index.js'></script>
</html>

index.js:

// Import Mosaic
import Mosaic from '@authman2/mosaic';

// The "text" data property gets injected by 
// the parent component so we need to specify
// that in the "data" option with a default value.
new Mosaic({
    name: 'my-label',
    data: { text: '' },
    view: self => {
        return html`
            <h2>${ self.data.text }</h2>
            <p>This is a custom label component!</p>
            ${self.descendants}
        `;
    }
});

// Create an app component. Note how components
// do not need to be nested under a single div.
const app = new Mosaic({
    name: 'my-app',
    element: 'root',
    data: { title: "Mosaic App" },
    sayHello: function() {
        console.log("Hello World!!");
        console.log("This component is ", this);
    },
    view: function() {
        return html`
            <h1>This is a ${this.data.title}!</h1>
            <p>Click below to print a message!</p>
            <button onclick="${this.sayHello}">Click Me!</button>

            <my-label text='Welcome to Mosaic!'>
                Awesome, right?
            </my-label>
        `;
    }
});

// Paint the Mosaic onto the page.
app.paint();

Installation

The easiest way to use Mosaic is to first install the npm package by using:

npm install --save @authman2/mosaic

or with a script tag.

<script src='https://unpkg.com/@authman2/mosaic@latest/dist/index.js'></script>

(Optional) For fast builds and hot reloading, install the build tool "Parcel." This is not required, though, as Mosaic uses built-in JavaScript features. This means that no build tool is required, but any may be used if it helps the overall project structure.

npm install --save-dev parcel-bundler

Now you are ready to use Mosaic!

Author

  • Year: 2019
  • Programmer: Adeola Uthman
  • Languages/Tools: JavaScript, TypeScript, Parcel

Readme

Keywords

Package Sidebar

Install

npm i @authman2/mosaic

Weekly Downloads

2

Version

0.6.7

License

MIT

Unpacked Size

31.8 kB

Total Files

8

Last publish

Collaborators

  • authman2