-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy path_best-practices-patterns.html
276 lines (255 loc) · 10.7 KB
/
_best-practices-patterns.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
<!doctype html>
<html>
<head>
<title>UIElement Docs – Best Practices & Patterns</title>
<link rel="stylesheet" href="assets/main.css">
<script type="module" src="assets/main.js"></script>
</head>
<body>
<header class="content-grid">
<h1 class="content">UIElement Docs <small>Version 0.9.4</small></h1>
<nav class="breakout">
<ol>
<li>
<a href="index.html">
<span class="icon">📘</span>
<strong>Introduction</strong>
<small>Overview and key benefits of UIElement</small>
</a>
</li>
<li>
<a href="installation-setup.html">
<span class="icon">⚙️</span>
<strong>Installation & Setup</strong>
<small>How to install and set up the library</small>
</a>
</li>
<li>
<a href="core-concepts.html">
<span class="icon">🧩</span>
<strong>Core Concepts</strong>
<small>Learn about signals, state, and reactivity</small>
</a>
</li>
<li>
<a href="detailed-walkthrough.html">
<span class="icon">📋</span>
<strong>Detailed Walkthrough</strong>
<small>Step-by-step guide to creating components</small>
</a>
</li>
<li class="active">
<a href="best-practices-patterns.html">
<span class="icon">💡</span>
<strong>Best Practices & Patterns</strong>
<small>Tips for effective and scalable usage</small>
</a>
</li>
<li>
<a href="advanced-topics.html">
<span class="icon">🚀</span>
<strong>Advanced Topics</strong>
<small>Diving deeper into contexts and performance</small>
</a>
</li>
<li>
<a href="examples-recipes.html">
<span class="icon">🧪</span>
<strong>Examples & Recipes</strong>
<small>Sample components and practical use cases</small>
</a>
</li>
<li>
<a href="troubleshooting-faqs.html">
<span class="icon">❓</span>
<strong>Troubleshooting & FAQs</strong>
<small>Common issues and frequently asked questions</small>
</a>
</li>
<li>
<a href="api-reference.html">
<span class="icon">📚</span>
<strong>API Reference</strong>
<small>Detailed documentation of classes and methods</small>
</a>
</li>
<li>
<a href="contributing-development.html">
<span class="icon">🤝</span>
<strong>Contributing & Development</strong>
<small>How to contribute and set up the dev environment</small>
</a>
</li>
<li>
<a href="changelog-versioning.html">
<span class="icon">📝</span>
<strong>Changelog & Versioning</strong>
<small>Track changes and understand versioning</small>
</a>
</li>
<li>
<a href="licensing-credits.html">
<span class="icon">⚖️</span>
<strong>Licensing & Credits</strong>
<small>License details and acknowledgments</small>
</a>
</li>
</ol>
</nav>
</header>
<main>
<section class="hero">
<h1>💡 Best Practices & Patterns</h1>
<p class="lead">Learn the best practices for building loosely coupled UIElement components, focusing on managing styles, states, and inter-component communication in a controlled and predictable way.</p>
</section>
<section>
<h2>Composability Principle</h2>
<p>Each component should be self-contained, managing its own state and styles, without relying directly on other components for its internal logic or presentation.</p>
<h3>Self-Managed State & Styles</h3>
<p>Components are responsible for their internal state and appearance, making them reusable and predictable. Parent components should not modify or style the internal DOM of their child components directly.</p>
<p>Components should not access elements higher up in the DOM tree or in a different branch thereof.</p>
</section>
<section>
<h2>Styling Components</h2>
<p>Avoid styling inner elements of sub-components directly from parent components, as this would make the appearance of the inner component dependent on the styles of the outer component. Parent components may style only the wrapper of child components for layout purposes (margins, gap, flex and grid properties).</p>
<h3>Scope Styles via Custom Element Name</h3>
<p>Each component should have scoped styles via their custom element name, ensuring its styles don't leak out. Custom element names are unique within the document, making them ideal for scoping purposes. Aim for low specificity selectors like tag names, so it's easy to override with a single class when you need to differentiate.</p>
<code-block language="css" copy-success="Copied!" copy-error="Error trying to copy to clipboard!">
<p class="meta">
<span class="language">css</span>
</p>
<pre class="language-css"><code>my-component {
padding: 1rem;
/* Only divs that are immediate children of my-component will be styled */
> div {
background-color: lightgray;
}
}</code></pre>
<input-button class="copy">
<button type="button" class="secondary small">Copy</button>
</input-button>
</code-block>
<h3>Customize via Class or CSS Custom Properties</h3>
<p>Components should allow reasonable variants via defined classes on the wrapper element or customizations via CSS custom properties.</p>
<p>Classes allow parent components to choose between certain given variants.</p>
<p>CSS custom properties allow parent components to influence the appearance of sub-components without directly styling their DOM internals.</p>
<code-block language="css" copy-success="Copied!" copy-error="Error trying to copy to clipboard!">
<p class="meta">
<span class="language">css</span>
</p>
<pre class="language-css"><code>parent-component {
--box-bg-color: red;
--box-text-color: white;
}
/* Base message box appearance can be influenced using CSS custom properties */
message-box {
background-color: var(--box-bg-color, lightgray);
color: var(--box-text-color, black);
/* While pre-defined variant with class "success" always comes with a fixed color scheme */
&.success {
background-color: green;
color: white;
}
}</code></pre>
<input-button class="copy">
<button type="button" class="secondary small">Copy</button>
</input-button>
</code-block>
</section>
<section>
<h2>Passing State Down</h2>
<p>Parent components can control sub-components by setting their publicly accessible signals. Use the <code>pass()</code> function to pass state directly and share signals.</p>
<h3>Passing State with pass()</h3>
<p>Use the <code>pass()</code> function to pass a state from a parent component to a child component, keeping the state synchronized.</p>
<code-block language="js" copy-success="Copied!" copy-error="Error trying to copy to clipboard!">
<p class="meta">
<span class="language">js</span>
</p>
<pre class="language-js"><code>class ParentComponent extends UIElement {
connectedCallback() {
this.set('parentColor', 'blue');
this.pass('parentColor', 'child-component', 'color');
}
}
ParentComponent.define('parent-component');</code></pre>
<input-button class="copy">
<button type="button" class="secondary small">Copy</button>
</input-button>
</code-block>
<code-block language="js" copy-success="Copied!" copy-error="Error trying to copy to clipboard!">
<p class="meta">
<span class="language">js</span>
</p>
<pre class="language-js"><code>class ChildComponent extends UIElement {
connectedCallback() {
this.first('.box').sync(setStyle('background-color', 'color'));
}
}
ChildComponent.define('child-component');</code></pre>
</code-block>
</section>
<section>
<h2>Bubbling Up State with Custom Events</h2>
<p>When a child component doesn't have full context for handling state changes, it can dispatch custom events that bubble up to parent components using <code>emit()</code>.</p>
<h3>Dispatching Custom Events with <code>emit()</code></h3>
<p>Use the <code>emit()</code> method to dispatch custom events to notify parent components of changes.</p>
<code-block language="js" copy-success="Copied!" copy-error="Error trying to copy to clipboard!">
<p class="meta">
<span class="language">js</span>
</p>
<pre class="language-js"><code>// In child component
this.emit('change', { detail: { value: this.get('value') } });</code></pre>
</code-block>
<h3>Handling Custom Events in Parent Components</h3>
<p>Parent components can listen for custom events from child components and respond accordingly.</p>
<code-block language="js" copy-success="Copied!" copy-error="Error trying to copy to clipboard!">
<p class="meta">
<span class="language">js</span>
</p>
<pre class="language-js"><code>// In parent component
this.first('child-component').on('change', (event) => {
console.log('Received change event:', event.detail.value);
// Handle state changes
});</code></pre>
</code-block>
<h3>Practical Example</h3>
<p>The child component emits a <code>change</code> event whenever an internal signal changes, and the parent listens and handles it.</p>
<code-block>
<pre><code>class ChildComponent extends UIElement {
connectedCallback() {
this.first('input').on('input', (event) => {
this.set('value', event.target.value);
this.emit('change', { detail: { value: event.target.value } });
});
}
}</code></pre>
</code-block>
<code-block>
<pre><code>class ParentComponent extends UIElement {
connectedCallback() {
this.first('child-component').on('change', (event) => {
console.log('Child value changed:', event.detail.value);
// Update parent state or perform an action
});
}
}</code></pre>
</code-block>
<code-block>
<pre><code><parent-component>
<child-component></child-component>
</parent-component></code></pre>
</code-block>
<h3>Best Practices for Custom Events</h3>
<ul>
<li><strong>Emit only when necessary</strong>: Emit events to notify parents of significant state changes.</li>
<li><strong>Consistent event names</strong>: Use clear, meaningful names for custom events.</li>
<li><strong>Use bubbling carefully</strong>: Understand the scope of event bubbling and which ancestor components may handle the event.</li>
</ul>
</section>
<section>
<h2>Conclusion & Next Steps</h2>
<p>By adhering to best practices for composability, styling, and state management, you can build efficient and loosely coupled <code>UIElement</code> components. Explore "Advanced Topics" to delve deeper into context and more complex patterns.</p>
</section>
</main>
</body>
</html>