-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathdocs.html
673 lines (594 loc) · 21.9 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
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>CRESCENT UI | DOCS</title>
<!-- favicon -->
<link rel="icon" href="img/favicon.png">
<!-- crescent ui components stylesheet -->
<link rel="stylesheet" href="https://crescent-components.netlify.app/css/crescent.css">
<!-- base stylesheet -->
<link rel="stylesheet" href="/css/docs.css">
<!-- base stylesheet for mobile view -->
<link rel="stylesheet" href="/css/docs-mobile.css">
<!-- highlight js css CDN -->
<link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/10.7.1/styles/default.min.css">
</head>
<body>
<header class="site-header">
<img src="img/icon.png" class="site-logo-img" alt="">
<span class="site-logo">CRESCENT UI</span>
<div class="site-header-nav">
<a href="index.html">Home</a>
<a href="https://github.com/codingwolf-at/crescent-ui" target="_blank">GitHub</a>
<a href="https://codingwolf-at.github.io" target="_blank">About Me</a>
</div>
</header>
<aside>
<div class="side-nav">
<h2 class="side-nav-heading">Components</h2>
<a href="#getting-started">Getting Started</a>
<a href="#avatar">Avatar</a>
<a href="#alert">Alert</a>
<a href="#badge">Badge</a>
<a href="#button">Button</a>
<a href="#card">Card</a>
<a href="#image">Image</a>
<a href="#input">Input</a>
<a href="#navbar">Navbar</a>
<a href="#spacing-utilities">Spacing Utilities</a>
<a href="#typography">Typography</a>
</div>
</aside>
<main>
<button class="btn btn-dark floating">Scroll to top ⬆️</button>
<!-- Getting Started -->
<section id="getting-started">
<header class="section-header">Getting Started</header>
<article>
<p>
To get started with CRESCENT UI the only thing which you need to do is to include our stylesheet
<span class="highlight"><link></span> in the <span class="highlight"><head></span> of your html
document.
</p>
<pre><code>
<link rel="stylesheet" href="https://crescent-components.netlify.app/css/crescent.css">
</code></pre>
</article>
</section>
<!-- Avatar -->
<section id="avatar">
<header class="section-header">Avatar</header>
<article>
<p>
Build beautiful circular avatars for your site. All you need do to is add the <span
class="highlight">avatar</span> class to any <span class="highlight"><img></span> element and our
library will take care of the rest.
</p>
<p>
Make sure the image you are using is having 1:1 ratio, i.e., a square picture having the same hight and width
or else if you use any rectangular picture then this may result in an oval avatar.
</p>
<div class="demo">
<img src="img/avatar/avatar (1).png" class="avatar mx-1" alt="avatar image">
<img src="img/avatar/avatar (2).png" class="avatar mx-1" alt="avatar image">
<img src="img/avatar/avatar (3).png" class="avatar mx-1" alt="avatar image">
<img src="img/avatar/avatar (4).png" class="avatar mx-1" alt="avatar image">
</div>
<pre><code>
<img src="img/avatar/avatar (1).png" class="avatar" alt="avatar image">
</code></pre>
</article>
</section>
<!-- Alert -->
<section id="alert">
<header class="section-header">Alert</header>
<article>
<p>
Provide contextual feedback messages for typical user actions with the handful of available and flexible alert
messages.
Alerts are available for any length of text, as well as an optional close button. For proper styling, use one
of the seven required contextual classes
</p>
<div class="demo-column">
<div class="alert alert-primary">
A simple primary alert - check it out!
<span class="alert-btn">X</span>
</div>
<div class="alert alert-secondary">
A simple secondary alert - check it out!
<span class="alert-btn">X</span>
</div>
<div class="alert alert-dark">
A simple dark alert - check it out!
<span class="alert-btn">X</span>
</div>
<div class="alert alert-success">
A simple success alert - check it out!
<span class="alert-btn">X</span>
</div>
<div class="alert alert-danger">
A simple danger alert - check it out!
<span class="alert-btn">X</span>
</div>
<div class="alert alert-warning">
A simple warning alert - check it out!
<span class="alert-btn">X</span>
</div>
<div class="alert alert-info">
A simple info alert - check it out!
<span class="alert-btn">X</span>
</div>
</div>
<pre><code>
<div class="alert alert-primary">
A simple primary alert - check it out!
<span class="alert-btn">X</span>
</div>
<div class="alert alert-secondary">
A simple secondary alert - check it out!
<span class="alert-btn">X</span>
</div>
<div class="alert alert-dark">
A simple dark alert - check it out!
<span class="alert-btn">X</span>
</div>
<div class="alert alert-success">
A simple success alert - check it out!
<span class="alert-btn">X</span>
</div>
<div class="alert alert-danger">
A simple danger alert - check it out!
<span class="alert-btn">X</span>
</div>
<div class="alert alert-warning">
A simple warning alert - check it out!
<span class="alert-btn">X</span>
</div>
<div class="alert alert-info">
A simple info alert - check it out!
<span class="alert-btn">X</span>
</div>
</code></pre>
</article>
</section>
<!-- Badge -->
<section id="badge">
<header class="section-header">Badge</header>
<article>
<p>
Badges can be used on both icon and avatar, for showing a count or any notification or online/offline status
of the avatar etc.
</p>
<div class="demo">
<div>
<img src="/img/icon-badge/home-key.png" alt="icon with badge">
<span class="badge">NEW</span>
</div>
<div>
<img class="avatar" src="img/avatar/avatar (4).png" alt="avatar with badge">
<span class="badge-avatar">22</span>
</div>
<div>
<img class="avatar" src="img/avatar/avatar (2).png" alt="avatar with badge">
<span class="badge-avatar">O</span>
</div>
</div>
<pre><code>
<div>
<img src="/img/icon-badge/home-key.png" alt="icon with badge">
<span class="badge">NEW</span>
</div>
<div>
<img class="avatar" src="img/avatar/avatar (4).png" alt="avatar badge">
<span class="badge-avatar">22</span>
</div>
<div>
<img class="avatar" src="img/avatar/avatar (2).png" alt="avatar badge">
<span class="badge-avatar">O</span>
</div>
</code></pre>
</article>
</section>
<!-- Buttons -->
<section id="button">
<header class="section-header">Button</header>
<article>
<p>
Use our custom button styles for actions in forms, dialogs, and more.
CRESCENT UI includes several predefined button styles, each serving its own semantic purpose, with a few
extras thrown in for more control.
</p>
<div class="demo">
<button class="btn btn-primary">Primary</button>
<button class="btn btn-secondary">Secondary</button>
<button class="btn btn-dark">Dark</button>
<button class="btn btn-success">Success</button>
<button class="btn btn-danger">Danger</button>
<button class="btn btn-warning">Warning</button>
<button class="btn btn-info">Info</button>
</div>
<div class="demo-column">
<button class="btn btn-primary btn-block">Primary Block</button>
<button class="btn btn-secondary btn-block">Secondary Block</button>
<button class="btn btn-dark btn-block">Dark Block</button>
</div>
<pre><code>
<button class="btn btn-primary">
Primary
</button>
<button class="btn btn-secondary">
Secondary
</button>
<button class="btn btn-dark">
Dark
</button>
<button class="btn btn-success">
Success
</button>
<button class="btn btn-danger">
Danger
</button>
<button class="btn btn-warning">
Warning
</button>
<button class="btn btn-info">
Info
</button>
</code></pre>
<pre><code>
<button class="btn btn-primary btn-block">
Primary Block
</button>
<button class="btn btn-secondary btn-block">
Secondary Block
</button>
<button class="btn btn-dark btn-block">
Dark Block
</button>
</code></pre>
</article>
</section>
<!-- Card -->
<section id="card">
<header class="section-header">Card</header>
<article>
<p>
A card is a flexible and extensible content container. It includes options for headers and footers, a wide
variety of content, contextual background colors, and powerful display options. Cards are built with as little
markup and styles as possible, but still manage to deliver a ton of control and customization. Built with
flexbox, they offer easy alignment and mix well with other CRESCENT UI components.
</p>
<div class="demo">
<div class="card">
<img src="img/card/32.jpg" class="card-img-top" alt="">
<div class="card-body">
<h2>Micky T-shirt</h2>
<h4>Price: 449/-</h4>
<button class="btn btn-primary btn-block">ADD TO CART</button>
</div>
</div>
<div class="card">
<img src="img/card/34.jpg" class="card-img-top" alt="">
<div class="card-body">
<h2>Lost T-shirt</h2>
<h4>Price: 549/-</h4>
<button class="btn btn-primary btn-block">ADD TO CART</button>
</div>
</div>
<div class="card">
<img src="img/card/35.jpg" class="card-img-top" alt="">
<div class="card-body">
<h2>Marvel T-shirt</h2>
<h4>Price: 449/-</h4>
<button class="btn btn-primary btn-block">ADD TO CART</button>
</div>
</div>
</div>
<pre><code>
<div class="card">
<img src="img/card/32.jpg" class="card-img-top" alt="">
<div class="card-body">
<h2>Micky T-shirt</h2>
<h4>Price: 449/-</h4>
<button class="btn btn-primary btn-block">ADD TO CART</button>
</div>
</div>
</code></pre>
</article>
</section>
<!-- Image -->
<section id="image">
<header class="section-header">Image</header>
<article>
<h2>Responsive Images</h2>
<p>
Images in CRESCENT UI are made responsive with <span class="highlight">.img-fluid</span> class. This applies
<span class="highlight">max-width: 100%;</span> and <span class="highlight">height: auto;</span> to the image
so that it scales with the parent element.
</p>
<div class="demo">
<img class="img-fluid" src="img/img/res.jpg" alt="responsive image">
</div>
<pre><code>
<img class="img-fluid" src="img/img/res.jpg" alt="responsive image">
</code></pre>
<h2>Round Image</h2>
<p>
You can create rounded images by adding <span class="highlight">rounded</span> class to it. Just make sure
the image you are using is of same width and height or else it may result into an oval shaped image.
</p>
<div class="demo">
<img src="img/img/res2.jpg" class="img-fluid rounded" alt="rounded image">
</div>
<pre><code>
<img src="img/img/res2.jpg" class="rounded" alt="rounded image">
</code></pre>
</article>
</section>
<!-- Input -->
<section id="input">
<header class="section-header">Input</header>
<article>
<p>
Add class <span class="highlight">input</span> to your input elements to make them sleek and modern.
</p>
<div class="demo">
<input type="text" class="input" placeholder="THIS IS AN INPUT FIELD">
</div>
<pre><code>
<input type="text" class="input" placeholder="THIS IS AN INPUT FIELD">
</code></pre>
</article>
</section>
<!-- Navbar -->
<section id="navbar">
<header class="section-header">Navbar</header>
<article>
<p>
Modern navbar made using flexbox which is responsive in nature and offer one brand logo and a set of nev
links.
You can use just <span class="highlight">nav</span> class for a transparent navbar or use <span
class="highlight">nav-primary</span>, <span class="highlight">nav-secondary</span> or <span
class="highlight">nav-dark</span> for navbars with different coloured backgrounds
</p>
<div class="demo-column-stretch">
<nav class="nav">
<span class="nav-brand">Site Logo</span>
<div class="nav-link-container">
<a href="javascript:void(0)" class="nav-link">Home</a>
<a href="javascript:void(0)" class="nav-link">Contact</a>
<a href="javascript:void(0)" class="nav-link">Services</a>
</div>
</nav>
<nav class="nav nav-primary">
<span class="nav-brand">Site Logo</span>
<div class="nav-link-container">
<a href="javascript:void(0)" class="nav-link">Home</a>
<a href="javascript:void(0)" class="nav-link">Contact</a>
<a href="javascript:void(0)" class="nav-link">Services</a>
</div>
</nav>
<nav class="nav nav-secondary">
<span class="nav-brand">Site Logo</span>
<div class="nav-link-container">
<a href="javascript:void(0)" class="nav-link">Home</a>
<a href="javascript:void(0)" class="nav-link">Contact</a>
<a href="javascript:void(0)" class="nav-link">Services</a>
</div>
</nav>
<nav class="nav nav-dark">
<span class="nav-brand">Site Logo</span>
<div class="nav-link-container">
<a href="javascript:void(0)" class="nav-link">Home</a>
<a href="javascript:void(0)" class="nav-link">Contact</a>
<a href="javascript:void(0)" class="nav-link">Services</a>
</div>
</nav>
</div>
<pre><code>
<nav class="nav">
<span class="nav-brand">Site Logo</span>
<div class="nav-link-container">
<a href="#" class="nav-link">Home</a>
<a href="#" class="nav-link">Contact</a>
<a href="#" class="nav-link">Services</a>
</div>
</nav>
<nav class="nav nav-primary">
<span class="nav-brand">Site Logo</span>
<div class="nav-link-container">
<a href="#" class="nav-link">Home</a>
<a href="#" class="nav-link">Contact</a>
<a href="#" class="nav-link">Services</a>
</div>
</nav>
<nav class="nav nav-secondary">
<span class="nav-brand">Site Logo</span>
<div class="nav-link-container">
<a href="#" class="nav-link">Home</a>
<a href="#" class="nav-link">Contact</a>
<a href="#" class="nav-link">Services</a>
</div>
</nav>
<nav class="nav nav-dark">
<span class="nav-brand">Site Logo</span>
<div class="nav-link-container">
<a href="#" class="nav-link">Home</a>
<a href="#" class="nav-link">Contact</a>
<a href="#" class="nav-link">Services</a>
</div>
</nav>
</code></pre>
</article>
</section>
<!-- Spacing Utilities -->
<section id="spacing-utilities">
<header class="section-header">Spacing Utilities</header>
<article>
<p>
Assign responsive-friendly margin or padding values to an element or a subset of its sides with shorthand
classes. Includes support for individual properties, all properties, and vertical and horizontal properties.
</p>
<h2>Padding</h2>
<p>
Use <span class="highlight">p-1</span>, <span class="highlight">p-2</span>, <span class="highlight">p-3</span>
and <span class="highlight">p-4</span> for giving overall padding to components.
</p>
<p>
Use <span class="highlight">py-1</span>, <span class="highlight">py-2</span>, <span
class="highlight">py-3</span> and <span class="highlight">py-4</span> classes to give vertical padding to
components.
</p>
<p>
Use <span class="highlight">px-1</span>, <span class="highlight">px-2</span>, <span
class="highlight">px-3</span> and <span class="highlight">px-4</span> classes to give horizontal padding to
the components.
</p>
<div class="demo">
<div class="demo-div p-1">
This div have some padding
</div>
<div class="demo-div px-1">
This div have horizontal padding only
</div>
<div class="demo-div py-1">
This div have vertical padding only
</div>
</div>
<pre><code>
<div class="demo-div p-1">
This div have some padding
</div>
<div class="demo-div px-1">
This div have horizontal padding only
</div>
<div class="demo-div py-1">
This div have vertical padding only
</div>
</code></pre>
<h2>Margin</h2>
<p>
Use <span class="highlight">m-1</span>, <span class="highlight">m-2</span>, <span class="highlight">m-3</span>
and <span class="highlight">m-4</span> for giving overall margin to components.
</p>
<p>
Use <span class="highlight">my-1</span>, <span class="highlight">my-2</span>, <span
class="highlight">my-3</span> and <span class="highlight">my-4</span> classes to give vertical margin to
components.
</p>
<p>
Use <span class="highlight">mx-1</span>, <span class="highlight">mx-2</span>, <span
class="highlight">mx-3</span> and <span class="highlight">mx-4</span> classes to give horizontal margin to
the components.
</p>
<div class="demo">
<div class="demo-div">
<p class="m-1">
This text have some margin
</p>
</div>
<div class="demo-div">
<p class="mx-1">
This text have horizontal margin
</p>
</div>
<div class="demo-div">
<p class="my-1">
This text have vertical margin
</p>
</div>
</div>
<pre><code>
<div class="demo-div">
<p class="m-1">
This text have some margin
</p>
</div>
<div class="demo-div">
<p class="mx-1">
This text have horizontal margin
</p>
</div>
<div class="demo-div">
<p class="my-1">
This text have vertical margin
</p>
</div>
</code></pre>
</article>
</section>
<!-- Typography -->
<section id="typography">
<header class="section-header">Typography</header>
<article>
<h2>Display Headings</h2>
<p>
Traditional heading elements are designed to work best in the meat of your page content. When you need a
heading to stand out, consider using a display heading—a larger, slightly more opinionated heading style.
</p>
<div class="demo-column-stretch">
<h1 class="display-1">Display 1</h1>
<h1 class="display-2">Display 2</h1>
<h1 class="display-3">Display 3</h1>
<h1 class="display-4">Display 4</h1>
<h1 class="display-5">Display 5</h1>
<h1 class="display-6">Display 6</h1>
</div>
<pre><code>
<h1 class="display-1">Display 1</h1>
<h1 class="display-2">Display 2</h1>
<h1 class="display-3">Display 3</h1>
<h1 class="display-4">Display 4</h1>
<h1 class="display-5">Display 5</h1>
<h1 class="display-6">Display 6</h1>
</code></pre>
<h2>Lead Paragraph</h2>
<p>
Make a paragraph stand out by adding <span class="highlight">lead</span> class.
</p>
<div class="demo-column-stretch">
<p class="lead">
This is a lead paragraph. <br>
A quick brown fox jumps over a lazy dog.
</p>
</div>
<pre><code>
<p class="lead">
This is a lead paragraph. <br>
A quick brown fox jumps over a lazy dog.
</p>
</code></pre>
<h2>Center Text</h2>
<p>
Make any text center aligned, just add <span class="highlight">center</span> class to it.
</p>
<div class="demo">
<p class="lead center">
This is center aligned lead text.
</p>
</div>
<pre><code>
<p class="lead center">
This is center aligned lead text.
</p>
</code></pre>
</article>
</section>
<!-- template -->
<section id="">
<header class="section-header"></header>
<article>
<p></p>
<div class="demo"></div>
</article>
</section>
<!-- highlight js -->
<script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/10.7.1/highlight.min.js"></script>
<script>hljs.highlightAll();</script>
<script src="./app.js"></script>
</main>
</body>
</html>