data-context-binding/README.html at master · manuel-lohmus/data-context-binding · GitHub

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
<!DOCTYPE html>
<html>
<head>
    <title>Data Context Binding</title>
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap@5/dist/css/bootstrap.min.css" />
    <script crossorigin="anonymous" src="https://cdn.jsdelivr.net/npm/bootstrap@5/dist/js/bootstrap.bundle.min.js"></script>
    <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.29.0/themes/prism.min.css" />
    <script crossorigin="anonymous" src="https://cdn.jsdelivr.net/npm/prismjs@1.29.0/prism.min.js"></script>
    <style>
        #list-headers ul {
            list-style: none;
            padding-left: .5em;
        }
        #list-headers > ul {
            padding: 0;
        }
        #list-headers h1, h2, h3, h4, h5 {
            white-space: nowrap;
        }
        .markdown-body {
            padding-left: 2em;
        }
        @media (min-width: 992px) {
            .vh-lg-100{
                height: 100vh !important;
            }
        }
    </style>
</head>
<body>
    <div class="row w-100">
<div class="col-12 text-center">
<h1 id="data-context-binding">Data Context Binding</h1>
<p>Simple and lightweight solution for binding data to DOM elements.<br>
This manual is also available in <a href="https://manuel-lohmus.github.io/data-context-binding/README.html">HTML5</a>.</p>
</div>
</div>
<div class="row w-100">
<div class="col-lg-3 d-lg-inline">
<div class="sticky-top overflow-auto vh-lg-100">
<div id="list-headers" class="list-group mt-2 ms-lg-2 ms-4">
<h4 id="table-of-contents">Table of contents</h4>
<ul>
<li><a href="#introduction"><strong>Introduction</strong></a></li>
<li><a href="#features"><strong>Features</strong></a></li>
<li><a href="#testing"><strong>Testing</strong></a></li>
<li><a href="#usage"><strong>Usage</strong></a></li>
<li><a href="#references"><strong>References</strong></a></li>
<li><a href="#license"><strong>License</strong></a></li>
</ul>
</div>
</div>
</div>

<div class="col-lg-9 mt-2">
<div class="ps-4 markdown-body" data-bs-spy="scroll" data-bs-target="#list-headers" data-bs-offset="0" tabindex="0">
<h2 id="introduction">Introduction</h2>
<p>Data context binding library for browser.
This library is a simple and lightweight solution for binding data to DOM elements.
Used when building a <strong>single-page application</strong> (<strong>SPA</strong>), this library offers a modern approach.
This module is part of the <a href="https://www.npmjs.com/package/conextra">'conextra'</a> framework,
which is a simple and easy-to-use single-page application (SPA) framework.
You have to try it! A different solution than MVC (model–view–controller).</p>
<p><strong>frontend workflow</strong>: data &gt;
<a href="https://www.npmjs.com/package/data-context">'data-context'</a> &gt;
<a href="https://www.npmjs.com/package/data-context-binding">'data-context-binding'</a> &gt;
DOM elements
<br>
<strong>backend to frontend workflow</strong>: file &gt;
<a href="https://www.npmjs.com/package/fs-broker">'fs-broker'</a> &gt;
<a href="https://www.npmjs.com/package/data-context">'data-context'</a> &gt;
<a href="https://www.npmjs.com/package/ws-user">'ws-user'</a> &gt;
<a href="https://www.npmjs.com/package/tiny-https-server">'tiny-https-server'</a> &gt;
<a href="https://www.npmjs.com/package/ws13">'ws13'</a> &gt;
browser &gt;
<a href="https://www.npmjs.com/package/ws-user">'ws-user'</a> &gt;
<a href="https://www.npmjs.com/package/data-context">'data-context'</a> &gt;
<a href="https://www.npmjs.com/package/data-context-binding">'data-context-binding'</a> &gt;
DOM elements</p>
<blockquote>
<p>Please note, this version is not backward compatible with version 1.x<br>
Requires <a href="https://www.npmjs.com/package/data-context">'data-context'</a> module version 2.x<br>
Note the restrictive requirements of the 'data-context' module.</p>
</blockquote>
<h2 id="features">Features</h2>
<ul>
<li>Bind data to the DOM elements.</li>
<li>template engine for rendering HTML.</li>
<li>Watch for changes in the data and update the DOM elements.</li>
</ul>
<h2 id="testing">Testing</h2>
<p>To test, open the '<a href="https://manuel-lohmus.github.io/data-context-binding/index.test.html">index.test.html</a>' file. The tests will run and the results will be displayed.</p>
<p>or on the command line in the project directory 'data-context-binding':</p>
<p><code>npm test</code></p>
<h2 id="usage">Usage</h2>
<p>This example demonstrates a simple and effective way to bind data to DOM elements using the data-context-binding library.</p>
<p><strong>Summary</strong></p>
<ul>
<li><strong>Import Modules</strong>: Load the required JavaScript libraries.</li>
<li><strong>Add Data</strong>: Define the data in a script tag with type application/json.</li>
<li><strong>Bind Data</strong>: Use path and bind attributes to bind data to DOM elements.</li>
<li><strong>Editable Fields</strong>: Allow users to edit data and reflect changes in real-time.</li>
<li><strong>Live Changes</strong>: Listen for data changes and update the DOM dynamically.</li>
</ul>
<p><a href="https://manuel-lohmus.github.io/data-context-binding/examples/hello-world.html">hello-world.html</a>:</p>
<pre><code class="language-html">&lt;!DOCTYPE html&gt;
&lt;html&gt;
&lt;head&gt;
    &lt;meta charset=&quot;utf-8&quot; /&gt;
    &lt;title&gt;data-context-binding&lt;/title&gt;
    &lt;!-- STEP 1. Import the modules 'data-context' and 'data-context-binding'.
        Import for an HTML page hosted on the server. --&gt;
    &lt;!--&lt;script src=&quot;./datacontext.js&quot;&gt;&lt;/script&gt;--&gt;
    &lt;!--&lt;script src=&quot;./browser.js&quot;&gt;&lt;/script&gt;--&gt;
    &lt;!-- STEP 1. Import the modules 'data-context' and 'data-context-binding'.
        Import for a standalone HTML page. --&gt;
    &lt;script async src=&quot;https://cdn.jsdelivr.net/npm/data-context&quot;&gt;&lt;/script&gt;
    &lt;script async src=&quot;https://cdn.jsdelivr.net/npm/data-context-binding&quot;&gt;&lt;/script&gt;
    &lt;!-- STEP 2. Add the data to a container with the ID 'data'. Its contents will be read automatically. --&gt;
    &lt;script id=&quot;data&quot; type=&quot;application/json&quot;&gt;
        {
            &quot;doc&quot;: {
                /* 1: The metadata-title context object */
                /* 2: The metadata-title context object */
                &quot;title&quot;: &quot;Hello World&quot;, // The title comment
                /* The metadata-description context object */
                &quot;description&quot;: &quot;This is a simple example of data context binding.&quot;, // The description comment
                /* { &quot;hidden&quot;: &quot;This is a must be hidden value.&quot; } */
                &quot;debug&quot;: false
            }
        }
    &lt;/script&gt;
&lt;/head&gt;
&lt;body&gt;
    &lt;!-- STEP 3. Bind data to the DOM elements.
        In this container we use the 'doc' object.
        The 'path' attribute is part of property path. --&gt;
    &lt;div path=&quot;doc&quot;&gt;
        &lt;div&gt;
            &lt;!-- STEP 3. Bind data to the DOM elements.
            The `path` attribute  is property path in the data object.
            The `bind` attribute is performed data binding. --&gt;
            &lt;h1 path=&quot;title&quot; bind&gt;Title&lt;/h1&gt;
            &lt;!-- STEP 3. Bind data to the DOM elements.
            The `path` attribute  is property path in the data object.
            The `bind` attribute is performed data binding. --&gt;
            &lt;p path=&quot;description&quot; bind&gt;Description&lt;/p&gt;
        &lt;/div&gt;
    &lt;/div&gt;
    &lt;hr /&gt;
    &lt;h3&gt;Edit the values:&lt;/h3&gt;
    &lt;label for=&quot;title&quot;&gt;Title:&lt;/label&gt;
    &lt;br /&gt;
    &lt;!-- STEP 3. Bind data to the DOM elements.
    The `path` attribute  is property path in the data object.
    The `bind` attribute is performed data binding. --&gt;
    &lt;input type=&quot;text&quot; path=&quot;doc.title&quot; bind style=&quot;width:380px&quot; /&gt;
    &lt;br /&gt;
    &lt;br /&gt;
    &lt;label&gt;Description:&lt;/label&gt;
    &lt;br /&gt;
    &lt;!-- STEP 3. Bind data to the DOM elements.
    The `path` attribute  is property path in the data object.
    The `bind` attribute is performed data binding. --&gt;
    &lt;input type=&quot;text&quot; path=&quot;doc.description&quot; bind style=&quot;width:380px&quot; /&gt;
    &lt;hr /&gt;
    &lt;label&gt;Live changes:&lt;/label&gt;
    &lt;br /&gt;
    &lt;!-- STEP 3. Bind data to the DOM elements.
    The `bind` attribute is performed data binding.
    Listens for data context changes --&gt;
    &lt;textarea cols=&quot;50&quot; rows=&quot;10&quot; bind=&quot;change&quot;&gt;&lt;/textarea&gt;
&lt;/body&gt;
&lt;/html&gt;
</code></pre>
<p>Here is also a <a href="https://manuel-lohmus.github.io/data-context-binding/demo.html">DEMO</a></p>
<h2 id="references">References</h2>
<h2 id="license">License</h2>
<p>This project is licensed under the MIT License.</p>
<p>Copyright © Manuel Lõhmus</p>
<p><a href="https://www.paypal.com/donate?hosted_button_id=4ZHDGZVF64YZQ"><img src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_SM.gif" alt="Donate" /></a></p>
<p>Donations are welcome and will go towards further development of this project.</p>
<br>
<br>
<br>
</div>
</div>
</div>

    <script>
        (function () {

            'use strict';

            var isIE = !!document.documentMode; // Detect IE

            if (!isIE) {

                // list-group style for headers
                document.querySelectorAll('#list-headers a')
                    .forEach(function (a) { a.classList.add('list-group-item', 'list-group-item-action') });
            }
        })();
    </script>
</body>
</html>