tsimp

TSimp

pronounced as T Simp, read as TS imp

Just like SpuckJs, but better and typed!

Description:

1. Object oriented, every TSimp object converts to DOM element
2. Autocompletion and JS-Doc documentation included, thnx to Typescript
3. State Management
4. Effect Management
5. An easy and intuitive way of sharing states

DOCS

You can read this to get an idea of getting started, these are spuckjs docs but both the libraries are very similar.
You'll be using a build tool and Vite is recomended.

Initializing:

npm create vite@latest
npm i
npm i tsimp

main.ts

import TSimp from 'tsimp';

const element = new TSimp({ type: 'h1', parent: '#app', class: "heading", id: "head" });
element.prop = { 
  text: "Hello World",
  css: {
    color: "blue"
  }
};
element.attr = { title: "Heading" };
element.make();

DOM Methods

Library gives some methods to manipulate and listen to the dom.
render(): converts/update a virtual element (JSimp object) into a physical DOM element.
mount() : puts the element to the dom.
unMount(): removes the element from the dom.
isMount(): checks if the element is in the dom.
onMount(func): calls the func function when an element is mounted.
onUnmount(func): ...element is unmounted.

States

States are internal variables of elements that when change automatically update their references in these specific properties:
html, text, css, value, class, id.

const [count, setCount] = element.state('count', 0);
element.prop = { text: "count is $count$" }

$statename$ - This textual way of referencing states is used in the mentioned 6 properties to get a truly reactive nature.
count is a function that returns the state value and can be used inside effects and events to get the latest value of thr state. setCount updates the state value.

const button = new TSimp({ type: 'button', parent: '#app' });
button.prop = { text: 'Update Count' };
button.events = {
  click: () => setCount(count() + 1)
}
button.make();

count() in the event will always have the latest value of the state as that line of code will call the getter function again.

- State Operations

You can perform various operations like arithmetic and reasoning on your states and pseudo-states
Syntax:

"Sum of $num1$ and %num2% = {{ $num1$ + %num2% }}"

All the expressions are defined inside {{ ... }}.
Basically you can write any valid js inside these brackets.

text: "{{ console.log('hello') }}"
// In DOM: "{{ console.log('hello') }}", and will log 'hello'.

// count = 5
text: "{{ console.log($count$) }}"
// In DOM: "{{ console.log($count$) }}", and will log 5.

text: "console.log($count$)"
// In DOM: "console.log(5)", no log, cause expressions are executed inside " {{ }} "

Some valid examples:

// js methods
_.prop = {
  text: "Answer is: {{ ['first', 'third'].includes('$answer$') }}"
}
// ternary operations
_.prop = {
  text: "Count is: {{ $count$ > 5 : 'Big' :'Small' }}"
}
// arithmetic operations
_.prop = {
  text: "Answer = {{ $num1$ + ((%num2% - 3) * 5)/10 }}"
}

These operations can be applied in properties where stringy states are valid.

- Sharing States

Suppose another element wants to show the count of element in its text. For that, it will subscribe for element's state to access them.
For this we use the static method of the class TSimp, i.e,
subscribe.

Note:

After subscribing, states are accessible as pseudo-states and are refernced like this: %statename%

import TSimp from 'tsimp';
Tsimp.subscribe();

// or
import TSimp, { subscribe } from 'tsimp';
subscribe();

//top-level
import TSimp, { subscribe } from 'tsimp';

const para = new TSimp({ type: 'p', parent: '#app' });
subscribe(para, element, []);
para.prop = { text: "Element's count is %count%" };
para.make();

Note:

Whenever the subscribed states change, the subscriber also re-renders with the main element.

Structure of subscribe method:

subscribe(subscriber, main, forStates);
/*
  *subscriber- the element which will access the states.
  *main- the element that'll share its states.
  *forStates- States of the `main` element to be shared, leave the array empty to trigger all
*/

- Subscription Events:

_.onSubscribed(func): Called on the subscriber element when subscription is added.
_.onnewSubscriber(func): Called on the element to which the subscriber is subscribing when subscription is added.

Effects:

Effects are functions that get called when some states or pseudoStates (dependencies) change

@param func — this function will get called when the dependencies change

@param dependencyArray — add states that will affect the effect, examples:

['$count$', '%color%'] 
(this will run the effect when either of state/pseudoState changes)

['f'] 
(this will run the effect on the first render only)

['e'] 
(this will run the effect on every render)

@param onFirst — default: true, by default every effect runs on its first render whether the deps change or not.

element.effect(func, dependencyArray, onFirst=true);

para example:

para.effect(() => {
  console.log('Effect Ran')
}, ['%count%']);

Conditional Mount

This feature allows you to show the element in the DOM only when the condition provided is satisfied.

Continuing with the para example.
Say we want to show the para element only when the pseudo-state count is odd.
We'll use the .putIf method.

// till now
const para = new TSimp({ type: 'p', parent: '#app' });
para.subscribe(element, []);
para.prop = { text: "Element's count is %count%" };

para.effect(() => {
  console.log('Effect Ran')
}, ['%count%']);

// conditional mount
para.putIf(() => count() % 2 != 0);
para.make();

Structure of putIf:

.putIf(condition:function:boolean, stick:boolean)

- Condition as a String

We can also provide the condition as a string that signifies a boolean expression.

para.putIf(() => count() % 2 != 0);

Doing this in a "stringy" way:

para.putIf('%count% % 2 != 0')

- The "stick" parameter:

There is a second parameter to the .putIf method, "stick : boolean", that can be passed to refer if the element after re-mounting will be in its old position or not.
By default: false.