Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@erickmerchant/framework

Package Overview
Dependencies
Maintainers
1
Versions
244
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@erickmerchant/framework

A simple data down, actions up framework.

  • 9.0.3
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
1
decreased by-99.57%
Maintainers
1
Weekly downloads
 
Created
Source

@erickmerchant/framework

This scoped package is my personal framework.

I wrote it to understand how modern javascript frameworks do things. It's greatly inspired by React and Redux, etc, obviously. Also hyperx, which demonstrated that you can use tagged template strings instead of JSX, was a huge inspiration.

I also wrote it because I don't really like any of the options out there. I wouldn't necessarily use it for anything serious, but intend to use it for any personal stuff I do.

It is meant to be used with browserify.

An Example

This example uses yo-yo (which uses hyperx), but you should be able to use diffHTML and possibly other solutions.

const framework = require('@erickmerchant/framework')
const html = require('yo-yo')
const diff = html.update
const target = document.querySelector('main')

framework({target, store, component, diff})(init)

function init ({dispatch}) {
  dispatch('increment')
}

function store (state = 0, action) {
  switch (action) {
    case 'increment': return state + 1
    case 'decrement': return state - 1
  }

  return state
}

function component ({state, dispatch}) {
  return html`<main>
    <output>${state}</output>
    <br>
    <button onclick=${decrement}>--</button>
    <button onclick=${increment}>++</button>
  </main>`

  function decrement () {
    dispatch('decrement')
  }

  function increment () {
    dispatch('increment')
  }
}

API Reference

Framework Code

framework

framework({target, store, component, diff, raf})

The function exported by this module.

  • target: a DOM element. The place to render your application
  • store
  • component
  • diff
  • raf: optional. A replacement for window.requestAnimationFrame. It defaults to window.requestAnimationFrame

Returns a function. See init

state

This is what is returned from the store. It can be anything from simply a number like in the example, to a complex object.

dispatch

dispatch(...arguments)

Initializes a change in state and causes a render

  • arguments: all get passed to the store
next

next(({target, dispatch}) => { ... })

A convenient helper to pass a callback to process.nextTick. Can be used to manipulate the page in some way after a render. For example scrolling to a specific element

init

init(({target, dispatch}) => { ... })

Application Code

store

store(state, ...arguments)

Called initially with zero arguments, it should return the default/initial state.

  • state: the previous thing returned from calling store
  • arguments: all the arguments passed to dispatch
component

component({state, dispatch, next})

Should return the element to pass to diff

diff

diff(target, element)

  • target: the target passed to framework
  • element: the new element returned from the component

FAQs

Package last updated on 10 Mar 2017

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc