-
-
Notifications
You must be signed in to change notification settings - Fork 2
/
docs.html
337 lines (309 loc) · 14.1 KB
/
docs.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no" />
<meta name="theme-color" content="#ff4e6a" />
<title>Nano JSX • Documentation</title>
<link rel="manifest" href="/manifest.webmanifest" />
<link rel="stylesheet" href="/css/style.css?ver=0.0.7" />
<link rel="prefetch" href="/" as="document" />
<link rel="prefetch" href="/components.html" as="document" />
<link rel="prefetch" href="/examples.html" as="document" />
</head>
<body>
<div id="root">
<header style="padding-bottom: 0px; margin-bottom: -24px">
<div class="is-center">
<img id="logo" width="202" height="77" src="/img/logo-compressed.svg" alt="nano jsx logo" />
</div>
<div id="other-navigation" class="is-center">
<ul>
<li><a href="/">Home</a></li>
<li><a href="/docs.html">Docs</a></li>
<li><a href="/components.html">Components</a></li>
<li><a href="/examples.html">Examples</a></li>
<li><a href="/ui.html">UI</a></li>
<li>
<a href="https://github.com/nanojsx/nano/discussions" target="_blank" rel="noopener">Discussions</a>
</li>
</ul>
</div>
</header>
<script>
// underline active navigation element
const { pathname } = window.location
const list = document.getElementById('other-navigation').children[0].children
for (let i = 0; i < list.length; i++) {
const a = list[i].children[0]
const href = a.getAttribute('href')
if (href === pathname) a.classList.add('active')
}
</script>
<section>
<h1>Documentation</h1>
<h2>Getting Started</h2>
<h3>Template (Node.js/Browser)</h3>
<pre><code id="projectTemplate" class="language-tsx">loading...</code></pre>
<h3>npm (with TypeScript)</h3>
<pre><code id="npmInstall" class="language-tsx">loading...</code></pre>
<pre><code id="import" class="language-tsx">loading...</code></pre>
<pre><code id="tsConfig" class="language-tsx">loading...</code></pre>
<h3>Deno</h3>
<p>
Get it from <a href="https://deno.land/x/nano_jsx">deno.land/x/nano_jsx</a> and have a look at the
<a href="https://github.com/nanojsx/nano-jsx-deno-example">deno example</a>.
</p>
<h3>Bundle (with Tagged Templates)</h3>
<pre><code id="bundle" class="language-tsx">loading...</code></pre>
<h2>Important Things</h2>
<p>
It is important to know that the beauty of Nano JSX is, that it is so close to the DOM, that you can easily
mix Vanilla JS and Nano JSX however you want.
</p>
<p>You can:</p>
<ul class="dot-list">
<li><code class="is-code">render()</code> multiple Nano JSX application on the same page.</li>
<li>
Call <code class="is-code">render()</code> inside a Component to render another Nano JSX Component to
another DOM Element.
</li>
<li>Manipulate the DOM from inside a Component.</li>
<li>and much more...</li>
</ul>
<p>
Please have a closer look at the code below. You would probably never do this in a framework like React, but
in Nano JSX you have the freedom to use JSX however you like. All you see here is valid. If you use Nano JSX
cleverly, you will love its flexibility and make fast apps.
</p>
<pre><code id="validCode" class="language-tsx">loading...</code></pre>
<h2>Component Lifecycle</h2>
<h3>Mounting</h3>
<p>These methods are called in the following order when a class Component is created and rendered:</p>
<ul class="dot-list">
<li><code class="is-code">constructor()</code></li>
<li><code class="is-code">willMount()</code></li>
<li><code class="is-code">render()</code></li>
<li><code class="is-code">didMount()</code></li>
</ul>
<h3>Updating</h3>
<p>
When calling <code class="is-code">this.update()</code> on a class Component, these methods are called in the
following order:
</p>
<ul class="dot-list">
<li><code class="is-code">willUpdate()</code></li>
<li><code class="is-code">render()</code></li>
<li><code class="is-code">didUpdate()</code></li>
</ul>
<h3>Unmounting</h3>
<p>This method is called when a class Component has unmounted (detached from the DOM):</p>
<ul class="dot-list">
<li><code class="is-code">didUnmount()</code></li>
</ul>
<h3>Server Side (SSR)</h3>
<p>In SSR, non of the lifecycle hook are called.</p>
<h2>Update/Re-render class Components</h2>
<p>
Nano JSX does never update a class Component automatically. You have to call
<code class="is-code">update()</code> manually. On every component you call
<code class="is-code">update()</code>, the root element needs to be a DOM element or a Fragment of DOM
elements.
</p>
<h3>Provide dynamic content on update</h3>
<p>
The <code class="is-code">update(update?: any)</code> method can receive an optional argument. When provided
it will be passed as parameter to the Components <code class="is-code">render(param)</code> function and can
be accessed inside it.
</p>
<h2>Component Props</h2>
<p>You can simply pass props to children as you are used to in other JSX libraries.</p>
<pre><code id="props" class="language-tsx">loading...</code></pre>
<h2>State and Store</h2>
<ul class="dot-list">
<li>Store is reactive, State isn't.</li>
<li>You can access every State and Store from any component (functional and class).</li>
<li>Store can be persisted in localStorage and sessionStorage.</li>
<li>Store needs to be unsubscribed in didUnmount().</li>
</ul>
<h3>State</h3>
<pre><code id="state" class="language-tsx">loading...</code></pre>
<h3>Store</h3>
<pre><code id="store" class="language-tsx">loading...</code></pre>
<h2>Context API</h2>
<pre><code id="contextAPI" class="language-tsx">loading...</code></pre>
<h2>Fragment</h2>
<pre><code id="fragment" class="language-tsx">loading...</code></pre>
<h2>dangerouslySetInnerHTML</h2>
<p>
Nano JSX escapes text as a default behavior, this behavior protects your application from crises such as XSS
attacks, but sometimes you want not to escape text. Nano JSX provides API for that time as well as React.
</p>
<p><strong>dangerouslySetInnerHTML</strong>, this naming is same as React, allows you to set HTML directly.</p>
<p>
Nano JSX <strong>does not</strong> escape a text node in <code class="is-code"> <script /></code>,
<code class="is-code"> <style /></code>, <code class="is-code"> <noscript /></code>, and also all
content in <code class="is-code"> <Helmet /></code> for usability.
</p>
<pre><code id="dangerouslySetInnerHTML" class="language-tsx">loading...</code></pre>
<p>A more readable alternative style:</p>
<pre><code id="dangerouslySetInnerHTML2" class="language-tsx">loading...</code></pre>
<h2>withStyles()</h2>
<p>
Nano JSX offers an optional <code class="is-code">withStyles()</code> HOC (Higher Order Component) to style
your Components.
</p>
<p>
You can simply pass your css as a string, or use an appropriate loader, for
<a href="https://webpack.js.org/" target="_blank" rel="noopener">Webpack</a> or similar, to import css or
sass/scss files.
</p>
<p>You can pass to <code class="is-code">withStyles()</code> an array of (or separated by a comma):</p>
<ul class="dot-list">
<li><code class="is-code">string</code></li>
<li>object that has <code class="is-code">toString()</code></li>
<li>function that returns a <code class="is-code">string</code></li>
</ul>
<div class="alert alert-info">
<p><strong>Info:</strong></p>
<p>
For an example configuration using Webpack and <code class="is-code">withStyles().</code> with Sass/SCSS,
have a look at the
<a href="https://github.com/nanojsx/template" target="_blank" rel="noopener">Nano JSX Template</a>
</p>
</div>
<h3>Render Components using withStyles</h3>
<p>
This example demonstrates how to render a functional Component with pre-defined styles using
<code class="is-code">withStyles()</code>. For a more in depth example, check out the
<a href="/examples.html">withStyles example</a>.
</p>
<pre><code id="withStyles" class="language-html">loading...</code></pre>
<h2>CustomElementsMode</h2>
<p>
You can easily convert your Components to WebComponents via
<span class="is-code">defineAsCustomElements()</span>.
</p>
<pre><code id="customElementsMode" class="language-tsx">loading...</code></pre>
<pre><code id="customElementsModeHTML" class="language-html">loading...</code></pre>
</section>
<footer class="is-full-width has-background-light">
<div class="is-container is-center">
<div style="margin-bottom: 16px">
<a style="color: black" href="https://github.com/nanojsx/nano">https://github.com/nanojsx/nano</a>
</div>
<div>
<a
class="github-button"
href="https://github.com/yandeu"
data-color-scheme="no-preference: dark; light: dark; dark: dark;"
data-size="large"
data-show-count="true"
aria-label="Follow @yandeu on GitHub"
>Follow @yandeu</a
>
<a
class="github-button"
href="https://github.com/nanojsx/nano"
data-color-scheme="no-preference: dark; light: dark; dark: dark;"
data-icon="octicon-star"
data-size="large"
data-show-count="true"
aria-label="Star nanojsx/nano on GitHub"
>Star</a
>
<a
class="github-button"
href="https://github.com/sponsors/yandeu"
data-color-scheme="no-preference: dark; light: dark; dark: dark;"
data-icon="octicon-heart"
data-size="large"
aria-label="Sponsor @yandeu on GitHub"
>Sponsor</a
>
</div>
<div>
<br />
<a href="https://github.com/nanojsx/nano/discussions" target="_blank" rel="noopener"
><img
loading="lazy"
src="https://shields.io/badge/GitHub-%20Discussions-%237289da?logo=github"
alt="GitHub Discussions"
/></a>
<a href="https://discord.gg/96PGJeB8xf" target="_blank" rel="noopener"
><img
loading="lazy"
src="https://img.shields.io/discord/912874504877912075?color=%237289da&label=Discord&logo=discord&logoColor=%23fff"
alt="Join our discord server!"
/></a>
</div>
</div>
</footer>
</div>
<!-- github corner -->
<a href="https://github.com/nanojsx/nano" class="github-corner" aria-label="View source on GitHub">
<svg
width="80"
height="80"
viewBox="0 0 250 250"
style="fill: #151513; color: #fff; position: absolute; top: 0; border: 0; left: 0; transform: scale(-1, 1)"
aria-hidden="true"
>
<path d="M0,0 L115,115 L130,115 L142,142 L250,250 L250,0 Z"></path>
<path
d="M128.3,109.0 C113.8,99.7 119.0,89.6 119.0,89.6 C122.0,82.7 120.5,78.6 120.5,78.6 C119.2,72.0 123.4,76.3 123.4,76.3 C127.3,80.9 125.5,87.3 125.5,87.3 C122.9,97.6 130.6,101.9 134.4,103.2"
fill="currentColor"
style="transform-origin: 130px 106px"
class="octo-arm"
></path>
<path
d="M115.0,115.0 C114.9,115.1 118.7,116.5 119.8,115.4 L133.7,101.6 C136.9,99.2 139.9,98.4 142.2,98.6 C133.8,88.0 127.5,74.4 143.8,58.0 C148.5,53.4 154.0,51.2 159.7,51.0 C160.3,49.4 163.2,43.6 171.4,40.1 C171.4,40.1 176.1,42.5 178.8,56.2 C183.1,58.6 187.2,61.8 190.9,65.4 C194.5,69.0 197.7,73.2 200.1,77.6 C213.8,80.2 216.3,84.9 216.3,84.9 C212.7,93.1 206.9,96.0 205.4,96.6 C205.1,102.4 203.0,107.8 198.3,112.5 C181.9,128.9 168.3,122.5 157.7,114.1 C157.9,116.9 156.7,120.9 152.7,124.9 L141.0,136.5 C139.8,137.7 141.6,141.9 141.8,141.8 Z"
fill="currentColor"
class="octo-body"
></path>
</svg>
<style>
.github-corner:hover .octo-arm {
animation: octocat-wave 560ms ease-in-out;
}
@keyframes octocat-wave {
0%,
100% {
transform: rotate(0);
}
20%,
60% {
transform: rotate(-25deg);
}
40%,
80% {
transform: rotate(10deg);
}
}
@media (max-width: 500px) {
.github-corner:hover .octo-arm {
animation: none;
}
.github-corner .octo-arm {
animation: octocat-wave 560ms ease-in-out;
}
}
</style>
</a>
<!-- prism scripts -->
<link rel="stylesheet" href="./css/prism.css?ver=0.0.5" />
<script src="./js/prism.js?ver=0.0.5"></script>
<script src="/js/code-docs.js"></script>
<script>
window.addEventListener('load', event => {
for (const [key, value] of Object.entries(code)) {
setTimeout(() => {
document.getElementById(key).innerHTML = Prism.highlight(value, Prism.languages.tsx)
}, 0)
}
})
</script>
<!-- github buttons -->
<script async defer src="https://buttons.github.io/buttons.js"></script>
</body>
</html>