-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathpreloader.html
More file actions
298 lines (248 loc) · 12.7 KB
/
preloader.html
File metadata and controls
298 lines (248 loc) · 12.7 KB
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
<!doctype html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="shortcut icon" href="./assets/img/favicon.ico">
<title>Preloader</title> <script type="module" crossorigin src="./js/app.min.js?v=1774807247395"></script>
<link rel="stylesheet" crossorigin href="./css/app.min.css?v=1774807247395">
</head>
<body>
<div class="wrapper">
<header class="header" data-anim-header="" data-anim-header-scroll="">
<div class="header__container">
<nav class="menu__body">
<a class="menu__logo" href="/docs/index.html">
<img src="./assets/img/logo.jpg" aria-label="Animmaster Logo" width="50" height="50">
</a>
<ul class="menu__list">
<li class="menu__item">
<a class="menu__link" href="/docs/index.html">Documentation</a>
</li>
<li class="menu__item">
<a class="menu__link menu__link--special" target="_blank" href="https://www.patreon.com/collection/1946808?view=condensed">Animmaster PRO Pack</a>
</li>
</ul>
</nav>
</div>
</header>
<main class="page">
<div data-anim-preloaderdoc="" class="doc">
<section class="doc-page box-padding">
<div class="doc-page__container">
<!-- ========================================================= -->
<!-- Top -->
<!-- ========================================================= -->
<div class="doc-top">
<a class="doc-top__back" href="/docs/index.html">← Back to Documentation</a>
</div>
<!-- ========================================================= -->
<!-- Hero -->
<!-- ========================================================= -->
<div class="doc-hero" id="top">
<p class="doc-hero__kicker">Documentation</p>
<h1 class="doc-hero__title">
Component: Preloader
<span class="doc-hero__title-sub">Loading animation while the page is being prepared</span>
</h1>
<p class="doc-hero__lead">
The Preloader component shows an animation during page loading.
It’s useful for pages with heavy media (lots of images), where you want to avoid a “jumping”
layout and give users a clear loading state.
</p>
<div class="doc-actions">
<a class="doc-btn doc-btn--primary doc-btn--pulse" href="https://www.patreon.com/collection/1946808?view=condensed" target="_blank" rel="noreferrer">
<span class="doc-btn__text doc-btn__text--default">
Download <span>Animmaster</span> Vite Template
</span>
<span class="doc-btn__text doc-btn__text--hover">
Save your time — start now
</span>
</a>
</div>
</div>
<div class="doc-layout">
<article class="doc-content">
<!-- ========================================================= -->
<!-- 1) Overview -->
<!-- ========================================================= -->
<section class="doc-section" id="intro" data-anim-watcher="navigator">
<h2 class="doc-h2">What is a preloader?</h2>
<p class="doc-p">
A preloader is a UI layer that appears before the page is fully ready. It can help you:
show a consistent loading state, reduce perceived waiting time, and avoid showing
unfinished layout while assets are loading.
</p>
<div class="doc-callout doc-callout--accent">
<div class="doc-callout__title">Best use case</div>
<div class="doc-callout__text">
Use a preloader on landing pages, portfolios, galleries, and any page with many images
or heavy content. For simple pages, it’s better to keep things instant.
</div>
</div>
</section>
<!-- ========================================================= -->
<!-- 2) Location -->
<!-- ========================================================= -->
<section class="doc-section" id="location" data-anim-watcher="navigator">
<h2 class="doc-h2">Component location</h2>
<p class="doc-p">
Files are located in <code>src/components/effects/preloader</code>.
Inside you’ll find:
</p>
<ul class="doc-list">
<li class="doc-list__item">JS file with preloader logic.</li>
<li class="doc-list__item">An HTML file that is auto-included into <code><head></code>.</li>
<li class="doc-list__item">SCSS file for styling the preloader animation.</li>
</ul>
</section>
<!-- ========================================================= -->
<!-- 3) Enable via locals -->
<!-- ========================================================= -->
<section class="doc-section" id="usage" data-anim-watcher="navigator">
<h2 class="doc-h2">Enable the preloader</h2>
<p class="doc-p">
On pages where you need the preloader, pass settings to the page template via
<code>locals</code>. The component is controlled by two options:
<code>enable</code> and <code>once</code>.
</p>
<div class="codeblock" data-codeblock="">
<div class="codeblock__top">
<div class="codeblock__file">Template locals — preloader settings</div>
<button class="codeblock__copy" type="button" data-copy="">Copy</button>
</div>
<pre class="codeblock__pre"><code class="codeblock__code">...
"preloader": {
"enable": "true",
"once": "false"
},
...</code></pre>
</div>
<ul class="doc-list">
<li class="doc-list__item"><code>preloader.enable</code> — turns the component on/off for the page.
</li>
<li class="doc-list__item"><code>preloader.once</code> — if <code>true</code>, shows the preloader
only once (first visit / first load).</li>
</ul>
<div class="doc-callout doc-callout--warn">
<div class="doc-callout__title">Note</div>
<div class="doc-callout__text">
Values are passed as strings (<code>"true"</code>/<code>"false"</code>) because they come from
HTML template locals.
</div>
</div>
</section>
<!-- ========================================================= -->
<!-- 4) Typical setups -->
<!-- ========================================================= -->
<section class="doc-section" id="modes" data-anim-watcher="navigator">
<h2 class="doc-h2">Typical setups</h2>
<div class="doc-grid">
<div class="doc-card doc-card--inline">
<h3 class="doc-h3">Always show</h3>
<p class="doc-p">
Use this for pages that load a lot of media and should always show a loading state.
</p>
<div class="codeblock codeblock--compact" data-codeblock="">
<div class="codeblock__top">
<div class="codeblock__file">Always show</div>
<button class="codeblock__copy" type="button" data-copy="">Copy</button>
</div>
<pre class="codeblock__pre"><code class="codeblock__code">"preloader": { "enable": "true", "once": "false" }</code></pre>
</div>
</div>
<div class="doc-card doc-card--inline">
<h3 class="doc-h3">Show once</h3>
<p class="doc-p">
Good for brand/intro preloaders: show only on the first load, then keep navigation fast.
</p>
<div class="codeblock codeblock--compact" data-codeblock="">
<div class="codeblock__top">
<div class="codeblock__file">Show once</div>
<button class="codeblock__copy" type="button" data-copy="">Copy</button>
</div>
<pre class="codeblock__pre"><code class="codeblock__code">"preloader": { "enable": "true", "once": "true" }</code></pre>
</div>
</div>
</div>
</section>
<!-- ========================================================= -->
<!-- Download -->
<!-- ========================================================= -->
<section class="doc-section" id="download" data-anim-watcher="navigator">
<h2 class="doc-h2">Download</h2>
<p class="doc-p doc-p--margin-b">
Add a clean loading experience to media-heavy pages.
Download the template and ship faster with ready-to-use components.
</p>
<div class="doc-actions">
<a class="doc-btn doc-btn--primary doc-btn--pulse" href="https://www.patreon.com/collection/1946808?view=condensed" target="_blank" rel="noreferrer">
<span class="doc-btn__text doc-btn__text--default">
Download <span>Animmaster</span> Vite Template
</span>
<span class="doc-btn__text doc-btn__text--hover">
Save your time — start now
</span>
</a>
</div>
</section>
<div class="doc-divider"></div>
<!-- ========================================================= -->
<!-- Next -->
<!-- ========================================================= -->
<nav class="doc-next">
<a class="doc-next__link" href="/docs/cursor.html">
Next: Custom cursor component
<span class="doc-next__arrow">→</span>
</a>
</nav>
</article>
<!-- ========================================================= -->
<!-- TOC -->
<!-- ========================================================= -->
<aside class="doc-toc" aria-label="On this page">
<div class="doc-toc__box">
<div class="doc-toc__title">On this page</div>
<ol class="doc-toc__list">
<li><a class="doc-toc__link" href="#" data-anim-scrollto-header="" data-anim-scrollto="#what">What it
does</a></li>
<li><a class="doc-toc__link" href="#" data-anim-scrollto-header="" data-anim-scrollto="#usage">How to
use</a></li>
<li><a class="doc-toc__link" href="#" data-anim-scrollto-header="" data-anim-scrollto="#examples">Examples</a>
</li>
<li><a class="doc-toc__link" href="#" data-anim-scrollto-header="" data-anim-scrollto="#tips">Tips</a>
</li>
<li><a class="doc-toc__link" href="#" data-anim-scrollto-header="" data-anim-scrollto="#download">Download</a>
</li>
</ol>
</div>
</aside>
</div>
</div>
</section>
</div>
</main>
<footer class="footer" data-anim-footer="">
<div class="footer__container">
<!-- BOTTOM -->
<div class="footer__bottom">
<p class="footer__copy">© 2026 Animmaster</p>
<div class="footer__bug">
<span>Found bug?</span>
<a href="mailto:animmasterstudio@gmail.com">
Report it
</a>
</div>
<div class="footer__author">
Crafted with <span>🤍</span> by
<a target="_blank" href="https://www.instagram.com/animmaster_studio?igsh=MXN0MXkycGxrbDlpag==">
Animmaster
</a>
</div>
</div>
</div>
</footer>
</div>
</body>
</html>