Skip to content

Commit 856a98d

Browse files
fix doc
1 parent 3817485 commit 856a98d

File tree

2 files changed

+75
-1
lines changed

2 files changed

+75
-1
lines changed

README.md

+75
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,68 @@
22

33
*💡 **Zikojs** a versatile JavaScript library offering a rich set of UI components, advanced mathematical utilities,Reactivity,animations,client side routing and graphics capabilities*
44

5+
## Install
6+
```bash
7+
npm install ziko
8+
```
9+
## 🎬 Demos
10+
- ### [ Windows entanglement using zikojs and ziko-three ](https://www.linkedin.com/feed/update/urn:li:activity:7144023650394918913/)
11+
512
## Features :
613

14+
### 🔰 Seamlessly operates in both browser and Node.js environments
15+
16+
### 🔰 Mathematical Utilities & Tips
17+
18+
- ***Flexible Math Functions*** :
19+
20+
ZikoJS offers flexible math utilities, such as the `mapfun` function, which allows mapping standard mathematical operations to complex and nested data structures.
21+
For example, the `cos` function in ZikoJS is built on top of mapfun, enabling it to handle multiple arguments with diverse types (numbers, arrays, objects).
22+
23+
```js
24+
import { cos, PI } from "ziko";
25+
const result = cos(PI, PI / 2, PI / 4, [PI / 6, PI / 3], {
26+
x: PI / 2,
27+
y: PI / 4,
28+
z: [0, PI / 12],
29+
}
30+
);
31+
/*
32+
result =>
33+
[
34+
-1,
35+
0,
36+
0.707106781186548,
37+
[0.866025403784439, 0.5],
38+
{
39+
x: 0,
40+
y: 0.707106781186548,
41+
z: [1, 0.965925826289068],
42+
},
43+
];
44+
*/
45+
// console.log(result)
46+
47+
```
48+
You can also built your own flexible Math function using this mapfun util :
49+
```js
50+
import { mapfun } from "ziko";
51+
const parabolic_func = (a, b, c, x) => a * x ** 2 + b * x + c;
52+
const map_parabolic_func =
53+
(a, b, c) =>
54+
(...X) =>
55+
mapfun((n) => parabolic_func(a, b, c, n), ...X);
56+
const a = -1.5,
57+
b = 2,
58+
c = 3;
59+
const X = [0, 1, 2, 3];
60+
console.log(parabolic_func(a, b, c)(X));
61+
// [3,3,1,3]
62+
63+
```
64+
65+
- Built in Matrix, Complex, Random ... classes
66+
767
### 🔰 No Template Engines :
868
zikojs UI module adopts a distinctive approach to building and updating user interfaces. It doesn't rely on predefined markup templates. Instead, it leverages a hyperscript-like syntax to dynamically create and update user interfaces.
969

@@ -60,3 +120,18 @@ Currently supported frameworks:
60120
|ziko-icons||`fontawesome`|
61121
|ziko-tippy||`tippy.js`|
62122
123+
124+
### 🔰 Rich UI elements
125+
126+
### 🔰 Reactivity
127+
128+
### 🔰 Time loop and animations support
129+
130+
## ⭐️ Show your support <a name="support"></a>
131+
132+
If you appreciate the library, kindly demonstrate your support by giving it a star!<br>
133+
[![Star](https://img.shields.io/github/stars/zakarialaoui10/ziko.js?style=social)](https://github.com/zakarialaoui10/ziko.js)
134+
<!--## Financial support-->
135+
# License
136+
This projet is licensed under the terms of MIT License
137+
<img src="https://img.shields.io/github/license/zakarialaoui10/zikojs?color=rgb%2820%2C21%2C169%29" width="100" align="right">

src/app/spa-file-based-routing.js

-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@ import { Section } from "../ui";
44
async function FileBasedRouting(pages /* use import.meta.glob */){
55
const routes = Object.keys(pages)
66
const root = findCommonPath(routes)
7-
// console.log({root})
87
const pairs = {}
98
for(let i=0; i<routes.length; i++){
109
const module = await pages[routes[i]]()

0 commit comments

Comments
 (0)