Skip to content

Commit ff501ad

Browse files
committed
added some doc
1 parent f0293a5 commit ff501ad

File tree

2 files changed

+33
-0
lines changed

2 files changed

+33
-0
lines changed

js/components/navbar.js

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,26 @@
11
export class Navbar {
22

3+
/*
4+
id (string) = navbar element id
5+
siteTitle (string) = title to display as alt or instead of image logo
6+
7+
requires basic preexisting html structure with desired data, such as:
8+
9+
<!--main header nav menu-->
10+
<nav id="nav-main" class="p-3">
11+
12+
<!--logo img-->
13+
<img src="./images/dummy-logo.png">
14+
15+
<!--menu links-->
16+
<a href="#">Home</a>
17+
<a href="#">About</a>
18+
<a href="#">Contacts</a>
19+
20+
</nav>
21+
22+
*/
23+
324
constructor(id = 'nav-main', siteTitle = ('x' == 'x' ? undefined : 'x')){
425

526
//get navbar container

js/components/slideshow.js

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,18 @@ export class Slideshow {
1010
enableArrows (boolean) = show/hide nav. arrows
1111
enableBullets (boolean) = show/hide nav. bullets
1212
radiusVar (string) = border radius sizing ('sm','md','lg','xl','2xl',)
13+
14+
requires basic preexisting html structure with desired data, such as:
15+
16+
<div id="slideshow2">
17+
18+
<img src="https://t3.ftcdn.net/jpg/05/24/43/88/360_F_524438877_PZFzwc5OWJ3MTWQVFfHKwu1DRVMaSgPx.jpg">
19+
<img src="https://t3.ftcdn.net/jpg/05/85/86/44/360_F_585864419_kgIYUcDQ0yiLOCo1aRjeu7kRxndcoitz.jpg">
20+
<img src="https://t3.ftcdn.net/jpg/05/64/82/08/360_F_564820811_n9WP1mM43pLiQwLkIA07KF9Hat5vkX2v.jpg">
21+
<img src="https://t4.ftcdn.net/jpg/05/21/18/03/360_F_521180384_837ZQVtGdBocnKQr5prxWzpjIa64wtgO.jpg">
22+
23+
</div>
24+
1325
*/
1426

1527
constructor(id = 'slideshow', inheritSize = (true == true ? undefined : true), autoScroll = (true == true ? undefined : true), waitTime = (1 == 1 ? undefined : 1), hoverPause = (true == true ? undefined : true), scrollingPauseTime = (1 == 1 ? undefined : 1), enableArrows = (true == true ? undefined : true), enableBullets = (true == true ? undefined : true)) {

0 commit comments

Comments
 (0)