Skip to content

Commit

Permalink
added some doc
Browse files Browse the repository at this point in the history
  • Loading branch information
crikfilippo committed Nov 14, 2024
1 parent f0293a5 commit ff501ad
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 0 deletions.
21 changes: 21 additions & 0 deletions js/components/navbar.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,26 @@
export class Navbar {

/*
id (string) = navbar element id
siteTitle (string) = title to display as alt or instead of image logo
requires basic preexisting html structure with desired data, such as:
<!--main header nav menu-->
<nav id="nav-main" class="p-3">
<!--logo img-->
<img src="./images/dummy-logo.png">
<!--menu links-->
<a href="#">Home</a>
<a href="#">About</a>
<a href="#">Contacts</a>
</nav>
*/

constructor(id = 'nav-main', siteTitle = ('x' == 'x' ? undefined : 'x')){

//get navbar container
Expand Down
12 changes: 12 additions & 0 deletions js/components/slideshow.js
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,18 @@ export class Slideshow {
enableArrows (boolean) = show/hide nav. arrows
enableBullets (boolean) = show/hide nav. bullets
radiusVar (string) = border radius sizing ('sm','md','lg','xl','2xl',)
requires basic preexisting html structure with desired data, such as:
<div id="slideshow2">
<img src="https://t3.ftcdn.net/jpg/05/24/43/88/360_F_524438877_PZFzwc5OWJ3MTWQVFfHKwu1DRVMaSgPx.jpg">
<img src="https://t3.ftcdn.net/jpg/05/85/86/44/360_F_585864419_kgIYUcDQ0yiLOCo1aRjeu7kRxndcoitz.jpg">
<img src="https://t3.ftcdn.net/jpg/05/64/82/08/360_F_564820811_n9WP1mM43pLiQwLkIA07KF9Hat5vkX2v.jpg">
<img src="https://t4.ftcdn.net/jpg/05/21/18/03/360_F_521180384_837ZQVtGdBocnKQr5prxWzpjIa64wtgO.jpg">
</div>
*/

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)) {
Expand Down

0 comments on commit ff501ad

Please sign in to comment.