@jeydotc/justjs v1.0.1
JustJS
- Mom, I want React
- We have React at Home
The React at home...
JustJS is this small experiment intended to create the smallest and simplest possible library that mimics a few functionalities from React, but without all the compiling, bundling, webpacking and other crazy stuff required to use it. Just plain old JavaScript.
Sample Usage
Let's create the classic counter app:
import { state, div, strong, button } from "justjs/index.js";
function Counter(){
const [getCount, setCount, subscribeToCount] = state(0);
const handleButtonClick = () => setCount(getCount() + 1);
return div({},
"The count Is: ",
strong({}, subscribeToCount),
div({},
button({
onClick: handleButtonClick
}, "Click here to add.")
)
)
}
document.body.appendChild(Counter());Basic Concepts
Most HTML-based UIs follow this cycle: 1: Render UI -> 2: Respond to user input -> 3: Update State -> 4: Update UI Then we go back to step 2 whenever user interacts with the UI.
The difference between one framework or the other usually lies in how they handle each step, but in essence, they all do more or less the same.
Let's see how we do that in our sample counter App:
1: Render UI
JustJs adds a set of functions that serve as a way to render the UI. These are rather simple, they just create a new Element instance. Though, they have several extra capabilities we'll see later on.
The basic way to create an HTML element is this:
import { el, div } from "justjs/index.js";
const divElement = div();
// Or
const divElement = el("div");The above code will create and return a simple HTMLDivElement instance which you can insert in your DOM.
The JustJs has the el function that allows to create any type of element, just send the element's tag name as the first parameter. All other HTML elements exist as functions on their own, but they have nothing special, they just call el providing a specific tag name.
The signature of el is this:
function el(tagName, attributes, child1, child2, ...){...}
// And for each HTML element e.g. <div>:
function div(attributes, child1, child2, ...){...}So, the first thing we do in our counter is to render the initial UI:
// Import the elements we'll need:
import { div, strong, button } from "justjs/index.js";
function Counter(){
return div({},
// Scalar values such a string, number, etc. will be converted into text nodes.
"The count Is: ",
strong({}),
div({},
button({}, "Click here to add.")
)
)
}
// Insert our Counter app into the DOM
document.body.appendChild(Counter());2: Respond to user Input
The typical way to respond to user input is by listening to events. The el function, thus all the element functions, treat all attributes starting with on as event listeners. So, whenever we send an on<event-name> attribute, we're telling el to add an event listener for <event-name>.
In our counter app, we want to listen to the button's click, so, this is what we do:
import { div, strong, button } from "justjs/index.js";
function Counter(){
// Let's create a handler as we usually do on React by convention:
const handleButtonClick = () => console.log("I got clicked");
return div({},
"The count Is: ",
strong({}),
div({},
button({
// Let's register the event handler.
onClick: handleButtonClick
}, "Click here to add.")
)
)
}
document.body.appendChild(Counter());3: Update the state
The idea is simple, just update some info, but the implications around it makes it a rather delicate task, mostly because that implies mutation, and mutation, being vital for the app to live, is also an enemy of clarity in functional code.
But there are plenty of articles and truly smart guys covering that, so, we're just going to cover how JustJs manages state.
The approach taken in this case is to have what I call a State Unit, which is nothing more than an object that holds a value and provides means to: Get the value, Set the value and Subscribe to value changes.
So, back to our counter app, all we need is to have a state unit for our count number:
//Let's import the state function.
import { state, div, strong, button } from "justjs/index.js";
function Counter(){
// Let's create a state unit for Count
const [getCount, setCount, subscribeToCount] = state(0);
const handleButtonClick = () => console.log("I got clicked");
return div({},
"The count Is: ",
strong({}),
div({},
button({
onClick: handleButtonClick
}, "Click here to add.")
)
)
}
document.body.appendChild(Counter());As you can see, in order to create a state unit, all we need to do is to call the state(initialValue) function. It receive an initial value and returns three functions in an array:
- The Getter which returns the latest state value.
- The Setter which allows to update the state value and also notifies the subscribers of a change in the state.
- The Subscribe which allows to provide a function (subscriber) that will be invoked whenever a change in the state happens.
Knowing that we can just use the setter to update the state, we could just change our click event listener so it does its job. We'll cover how to update the UI later in the next section.
//Let's import the state function.
import { state, div, strong, button } from "justjs/index.js";
function Counter(){
// Let's create a state unit for Count
const [getCount, setCount, subscribeToCount] = state(0);
// Let's update the state
const handleButtonClick = () => setCount(getCount() + 1);
return div({},
"The count Is: ",
strong({}),
div({},
button({
onClick: handleButtonClick
}, "Click here to add.")
)
)
}
document.body.appendChild(Counter());4: Update UI
DEADLY IMPORTANT NOTE: For those comming from React.
JustJS is a really simple library, so, it doesn't have its fancy and complex render cycle, it just provides a means to create and update DOM in a particular, and (hopefully) functional way. DOM is manipulated directly and the functions, although looking similar to React functional components, don't run in each "render" (there's no such thing here), they run only once.
Before covering how UI update works in JustJS, let's first do it the manual way:
import { state, div, strong, button } from "justjs/index.js";
function Counter(){
const [getCount, setCount, subscribeToCount] = state(0);
const handleButtonClick = () => setCount(getCount() + 1);
// Hold an instance of the element that we'll need to update:
const countDisplay = strong({}, getCount());
// Subscribe to changes in the Count state:
subscribeToCount((newValue) => countDisplay.textContent = newValue)
return div({},
"The count Is: ",
// Add the element to the Div
countDisplay,
div({},
button({
onClick: handleButtonClick
}, "Click here to add.")
)
)
}
document.body.appendChild(Counter());With the above code, we have effectively subscribed to Count changes and, whenever a change happens, we update our countDisplay instance. Since that object is a DOM node, the change will become visible in the screen.
So far, so good. But dealing with DOM references seems cumbersome and breaks the expressiveness of the UI creation, so, what can we do to simplify that? Well, it happens that el and its folks have a solution: Just send the subscribe function:
import { state, div, strong, button } from "justjs/index.js";
function Counter(){
const [getCount, setCount, subscribeToCount] = state(0);
const handleButtonClick = () => setCount(getCount() + 1);
return div({},
"The count Is: ",
// Add the element to the Div
strong({},
// Whenever we change the count, this text node will be replaced.
subscribeToCount
),
div({},
button({
onClick: handleButtonClick
}, "Click here to add.")
)
)
}
document.body.appendChild(Counter());What's going on here? Well, it happens that, el will interpret any child or attribute value (except for event listeners) as a signal to subscribe itself to changes, essentially doing what we covered in the manual way section. For child nodes it will replace the entire child node with the given value, and for attributes it will update the value.
The sideEffect Function
Until now, we have covered UI updates for pretty basic scenarios: Text nodes and text attributes. But what if we need to respond to state changes by rendering several elements? Or what if we need to convert the value to something else? This is where sideEffect function comes into play.
The sideEffect function covers these scenarios:
- State value needs to be transformed:
- To a DOM subtree.
- To an attribute value.
- We need to respond to multiple subscriptions/state units.
The structure of a side effect is this:
const subscribeToMySideEffect = sideEffect(
reducerFunction,
subscribeToState1,
subscribeToState2,
...
)What happens here is that we create a new subscribe function which value will be whatever the reducerFunction returns as a response to the other subscribeTo being invoked. The reducerFunction will receive the current state associated to each of the other subscribeTo as parameters.
All the above sounds confusing, but that's actually what happens. To clarify a little bit, let's look at some examples:
1. State value needs to be transformed
Let's take again our Counter example. Let's say we need to add a label saying if the number is odd or even, and use <em> for Odd and <strong> for Even values. One way to approach that is this:
// Let's import our sideEffect function
import { state, sideEffect, div, strong, em, button } from "justjs/index.js";
function Counter(){
const [getCount, setCount, subscribeToCount] = state(0);
const handleButtonClick = () => setCount(getCount() + 1);
// Create a new subscribe function
const subscribeToOddEvenElement = sideEffect(
// Which value will be what this function returns
(count) => count % 2 === 0 ? strong({}, "Even") : em({}, "Odd"),
// In response to this other subscribe function.
subscribeToCount
);
return div({},
"The count Is: ",
strong({}, subscribeToCount),
// Insert the element which will be updated whenever we call setCount.
subscribeToOddEvenElement,
div({},
button({
onClick: handleButtonClick
}, "Click here to add.")
)
)
}
document.body.appendChild(Counter());With the code above, you can render an element based on the current Count state and update it whenever the value changes. You could also separate the reducer function as its own component in order to make the code look clearer:
// Let's import our sideEffect function
import { state, sideEffect, div, strong, em, button } from "justjs/index.js";
// Let's separate the odd/even tag in its own component:
function OddEvenTag({ count }){
return count % 2 === 0 ? strong({}, "Even") : em({}, "Odd");
}
function Counter(){
const [getCount, setCount, subscribeToCount] = state(0);
const handleButtonClick = () => setCount(getCount() + 1);
// Create a new subscribe function
const subscribeToOddEvenElement = sideEffect(
// Which value will be what this function returns
(count) => OddEvenTag({ count }),
// In response to this other subscribe function.
subscribeToCount
);
return div({},
"The count Is: ",
strong({}, subscribeToCount),
// Insert the element which will be updated whenever we call setCount.
subscribeToOddEvenElement,
div({},
button({
onClick: handleButtonClick
}, "Click here to add.")
)
)
}
document.body.appendChild(Counter());2. Responding to multiple subscriptions/state units.
Now, let's assume we need to show a new field that accepts a number, and display the result of multiplying the given number by the current counter value.
This requires a new state unit (the multiplier) and an element that depends on changes on both, the count and the multiplier.
import { state, sideEffect, div, strong, em, button, input } from "justjs/index.js";
function OddEvenTag({ count }){
return count % 2 === 0 ? strong({}, "Even") : em({}, "Odd");
}
function Counter(){
const [getCount, setCount, subscribeToCount] = state(0);
// Let´s add the multiplier state.
const [getMultiplier, setMultiplier, subscribeToMultiplier] = state(1);
const handleButtonClick = () => setCount(getCount() + 1);
// Let's update the multiplier when input changes
const handleMultiplierChanged = (e) => setMultiplier(e.target.value);
const subscribeToOddEvenElement = sideEffect(
(count) => OddEvenTag({ count }),
subscribeToCount
);
// Let's create a subscriber that depends on the two states.
const subscribeToMultipliedValue = sideEffect(
// This reducer function receives two parameters: The current count and multiplier states.
// And returns the result of multiplying those values.
(count, multiplier) => count * multiplier,
// Here we declare that this subscriber depends these two states.
// The reducer parameters will be provided in the same order in which we send the subscribes.
subscribeToCount,
subscribeToMultiplier
);
return div({},
"The count Is: ",
strong({}, subscribeToCount),
subscribeToOddEvenElement,
// Let's display the multiplier
" and Multiplied by ", subscribeToMultiplier,
// Let's display the multiplied value.
" the result is: ", subscribeToMultipliedValue
div({},
// Let's add the multiplier input:
input({
type: "number",
onChange: handleMultiplierChanged
}),
button({
onClick: handleButtonClick
}, "Click here to add.")
)
)
}
document.body.appendChild(Counter());The Special Attributes
Most properties provided in the first parameter of elements is treated just like regular HTML attributes (set with setAttribute). But some of them are treated different in order to keep the ability of el to create elements easily in one line.
On<event> Attributes
We've seen these in previous sections. Any attribute which name starts with on is treated as an event listener, so, instead of setting an attribute, we invoke the element's addEventListener method.
Examples:
// Listen to the 'click' event
button({
onClick: (e) => {}
});
// Listen to the 'submit' event
form({
onsubmit: (e) => {}
})Function (Subscription) Attributes
Just as with child elements, all attributes (except for event listeners) can receive a subscribe function, making the attribute dependent on a state unit.
Example:
const [getProgress, setProgress, subscribeToProgress] = state(0);
// Let's create a <progress> element
progress({
max: 100,
// This attribute will be updated anytime we call setProgress
value: subscribeToProgress,
})Value Attribute
The input value attribute is a special case, setting it with setAttribute() method is practically worthless, so, in order for the input element to work correctly, we set this attribute by setting the value property in the DOM object instead.
Boolean Attributes
If you set an attribute with boolean true or false, el will not just set the attribute, but also, if the given value is false, it will make sure that the attribute will not be present in the element.
This is necessary for some special attributes which mere existence in the element changes its behavior (e.g. disabled).
Example:
// Let's create a disabled state
const [getDisabled, setDisabled, subscribeToDisabled] = state(false);
div({},
// The mere presence of 'disabled' attribute will cause the input to be disabled.
// The el function will remove the attribute whenever the value becomes boolean false.
input({type: "text", disabled: subscribeToDisabled }),
button({ onClick: () => setDisabled(!getDisabled()) }, "Toggle disabled.")
)Compound Attributes (Work In Progress, not yet released)
Some attributes can accept objects as parameters and will set the "inner" properties of such attributes from the given object values. So far, there are just two compound properties: style and data. Let's each one.
Style Attribute
The style attribute can accept two types of value: String or Object. When receiving a string, it will be set just as usual (with setAttribute), but if an object is received, el will map each property of the given object to one at element.style.
Example:
// These two examples do exactly the same:
div({
style: "background-color: red",
});
div({
style: {
// Here we use camel-case as usually recommended.
backgroundColor: "red"
},
});Data-* Attributes
You can set data- attributes in two ways: By just setting individual properties in the element's first parameter, or by providing an object to a single data property.
Example:
// These two examples produce the exact same result:
div({
"data-some-value": "Some Value",
"data-some-other-value": "Other Value",
});
div({
data: {
someValue: "Some Value",
someOtherValue: "Other Value",
},
});The data property is a convenient way to manage data- attributes all at once.
Compound Attributes and Subscribers
Subscribers don't work on attribute's properties
The ability to use subscribers on compound attributes, such as style and data, only applies to the attribute level, that is, properties within the attribute CAN'T be set to subscribers.
BAD Example:
// Let's have a style property that depends on state:
const [ getColor, setColor, subscribeToColor ] = state("red");
div({
style: {
// THIS WILL NOT WORK!
backgroundColor: subscribeToColor,
padding: "20px",
},
});GOOD Example:
const [ getColor, setColor, subscribeToColor ] = state("red");
div({
style: sideEffect((backgroundColor) => ({
backgroundColor,
padding: "20px",
}), subscribeToColor),
});Attribute properties will be cleared upon update
When updating a compound attribute, you'll be overriding any previous value it had.
For style this means that el will call element.setAttribute('style', '') to clear the element.style property before setting the new values.
For data this means that el will delete any data- attribute that is not part the given object.
This design decision is aimed to make the code more predictable.
Focus Attribute (work in progress)
Setting this attribute to boolean true, will cause el to attempt to focus the element. It will also enable it, so, use with caution when you have enable/disable logic on such element.
Example:
// Let's create a disabled state
const [getFocus, setFocus, subscribeToFocus] = state(false);
div({},
// Whenever focus becomes boolean true, we'll try to call .focus() on the input.
input({type: "text", focus: subscribeToFocus }),
button({ onClick: () => setFocus(true) }, "Focus on Input")
)2 years ago