Git Product home page Git Product logo

elementree's Introduction

stability-experimental JavaScript Style Guide Build Status

Elementree

"Celebrate the code of the problem domain as opposed to the framework."

Elementree is an extremely small front-end JavaScript "framework" with a focus on getting the job done with the mimimum amount of framework-y concepts.

Example

<!DOCTYPE html>
<html>
  <body>
    <script type="module">
      import { merge, prepare, render } from 'https://unpkg.com/elementree'

      function View (state) {
        if (!state.email) state.requestUser()
        return render`
          <body>
            <p>Hello! ${state.email}</p>
            <button onclick=${() => state.nextEmail()}>Next Email</button>
          </body>
        `
      }

      const State = {
        id: 1,
        email: '',
        nextEmail() {
          this.email = null
          this.id += 1
        },
        async requestUser() {
          const response = await fetch(`https://reqres.in/api/users/${this.id}`)
          const { data } = await response.json()
          this.email = data.email
        }
      }
      merge('body', prepare(View, State))
    </script>
  </body>
</html>

Elementree API

merge(to: String, view: Function [, state: Object]) -> undefined

merge wires up a view and an optional object representing the application state and merges it to a selector. Simply put, merge renders your root view to the DOM.

The first argument to merge is a string which will be used by document.querySelector, after DOMContentLoaded, to find root element. The second argument is the top-level view. This argument is a Function that returns a function that returns an HTMLElement such as a prepare call. The third, optional, argument is an object representing the application's state. This object will passed to the renderer function as an parent argument (i.e. following the view's state if there is one).

Elementree adds a single property to the application's state object. The route property is a concatenation of location.pathname, location.search and location.hash. Updating the route property will cause a history.pushState. Updating the address through browser interations will update the route property.

If the window object does not exist the call to merge will return the outerHTML on the result of the rendering.

prepare(template: Function [, state: Object]) -> (Function -> HTMLElement)

prepare a template function with a state object, creating a view function. At a minimum, a template function is required to be passed as the first argument. The second argument, which is optional, is an object representing the local view state. If the template function is joined with a state, the state object will ALWAYS be the 0th argument to the view function. All parent arguments will follow.

render`template: String` -> HTMLElement

A tagged template function. Turn a JavaScript template string into an HTMLElement. If the template has more than one root element a DocumentFragment is returned.

html`unescaped: String` -> HTMLElement

Use html to interpolate HTML, without escaping it, directly into your template.

Attribution

This project would suck a whole lot more without the input from my awesome co-workers at Bitovi, the inspiration from @choojs, and the amazing packages from @sindresorhus. Thank you.

elementree's People

Contributors

dependabot-preview[bot] avatar dependabot[bot] avatar greenkeeper[bot] avatar mjstahl avatar

Stargazers

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

Watchers

 avatar  avatar  avatar  avatar

elementree's Issues

Remove 'forceUpdate' from being exported

Removing forceUpdate for routing is more difficult. It cannot be removed until I figure out how to update app state without changing the route.

Maybe a special function that is attached to the appstate object that updates the value and re-renders the tree.

Routing is not updating app state with values captured from url path

When working on the todomvc example. Using route the route was updated, but the variable I had configured was not on the application state object.

const routes = {
  '#/:state': renderer
}
#/active //was expected to work, with a 'state' variable on app state set to the value of 'active'

Possible memory leak when Element and children are not rendered

Right now, each components model is subscribed too. That way when it changes a render can start at the root and handle any changes.

Due to those changes, if an element is no longer rendered, its model is not unsubscribed from. This is probably a memory leak and needs to be rectified.

Probably with MutationObservers?

Routing

// app.js
import { attach, routes } from 'elementree'

import dashboard from 'views/dashboard'
import user from 'views/user'

const routes = {
  initial: 'dashboard',
  'dashboard': dashboard,
  'user/:id': user
}

attach('body', routes)

routes accept a function or an object in which to create a Stated object. If a Function is passed, the routes function will turn it into:

{
  view: user,
  title: 'Sets the title of the browser tab'
  // any other properties
}
// views/user.js
import { couple, render } from 'elementree'

export const state = {
  // local states
}
export function template (model, app) {
  return render`
    <p>Hello User ${app.location.id}</p>
  `
}

export default couple(template, state) 

Double-rendering when the model changes state in the render function

function template (model, greeting) {
  if (greeting.toLowerCase() !== model.state) {
    model.to(model.actions.TOGGLE)
  }
  return render`
    <span>${model.value}</span>
  `
}

if the conditional is true, this template function will be called twice.

Not sure how this should be solved yet. And it may not be a huge deal for small trees, but any tree with enough leaves will eventually suffer a performance hit.

We could pass a render function or event down to each template.

Idea: Bring '@elementree/location' into the main repo and add a 'routes' function

import { routes, merge, prepare } from 'https://unpkg.com/elementree'

// varargs function or array?
routes(
  '/items/:id',
  '/user/:name'
)

merge('body', prepare(...))

Application State would be populated a location and route property. Assuming an address of

.../items/1?sort=asc

Application State would look like:

location: '/items/1?sort=asc',
route: {
  path: {
    id: '1'
  },
  query: {
    sort: 'asc'
  },
  hash: ''
}

With any routes call or the arguments of routes is of length 0, the route property on Application State would be {}

Routing

import { attach } from 'elementree'

import { hello, goodbye, notFound } from 'components/'

const routes = {
  '/hello/:name': hello,
  '/goodbye/:name': goodbye,
  '*': notFound
}

attach('body', routes)
// hello/hello.js
import { prepare, render } from 'elementree'

function hello ({ location }) {
  return render`
    <h1>Hello ${location.path.name}</h1>
  `
}

export default prepare(hello)

This adds a location property onto the AppState object passed to the template. The value of the location property is an object with two properties:

  • path, an object containing key/value pairs that match the variables defined in the route (:id)
  • query, an object containing key/value pairs parsed from the query string (anything past the ?)

The 'on-change' package currently does not work with classes / constructor functions

class Counter {
  constructor () {
    setInterval(this.onTick.bind(this), 1000)
  }
  onTick () {
    const now = new Date()
    this.hours = now.getHours()
    this.minutes = now.getMinutes()
    this.seconds = now.getSeconds()
  }
}

The update performed by onTick does not cause a re-render. This is probably because this refers to the instance and not the Proxy returned from the onchange call.

Use requestAnimationFrame in __renderTree()?

Might be able to replace the following:

let rendering = false

function __renderTree () {
  if (rendering) { return }
  rendering = true
  rendering = !__merge(root, tree())
}

with:

function __renderTree() {
  window.requestAnimationFrame(() => {
    __merge(root, tree())
  })
}

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.