Files
front/build/documentation/sticky-block.html
2021-12-29 13:15:44 +01:00

806 lines
28 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!DOCTYPE html>
<html lang="en">
<head>
<!-- Required Meta Tags Always Come First -->
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<!-- Title -->
<title>Sticky Block - Documentation | Front - Multipurpose Responsive Template</title>
<!-- Favicon -->
<link rel="shortcut icon" href="../favicon.ico">
<!-- Font -->
<link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;600&display=swap" rel="stylesheet">
<!-- CSS Implementing Plugins -->
<link rel="stylesheet" href="../assets/css/vendor.min.css">
<link rel="stylesheet" href="../assets/vendor/bootstrap-icons/font/bootstrap-icons.css">
<!-- CSS Front Template -->
<link rel="stylesheet" href="../assets/css/theme.min.css?v=1.0">
<link rel="stylesheet" href="../assets/css/docs.css">
</head>
<body class="navbar-sidebar-aside-lg">
<!-- ========== HEADER ========== -->
<header id="header" class="navbar navbar-expand navbar-fixed navbar-end navbar-light navbar-sticky-lg-top bg-white">
<div class="container-fluid">
<nav class="navbar-nav-wrap">
<div class="row flex-grow-1">
<!-- Default Logo -->
<div class="docs-navbar-sidebar-container d-flex align-items-center mb-2 mb-lg-0">
<a class="navbar-brand" href="../documentation/index.html" aria-label="Space">
<img class="navbar-brand-logo" src="../assets/svg/logos/logo.svg" alt="Logo">
</a>
<a href="../documentation/changelog.html">
<span class="badge bg-soft-primary text-primary">v4.1</span>
</a>
</div>
<!-- End Default Logo -->
<div class="col-md px-lg-0">
<div class="d-flex justify-content-between align-items-center px-lg-5 px-xl-10">
<div class="d-none d-md-block">
<!-- Search Form -->
<form id="docsSearch" class="position-relative"
data-hs-list-options='{
"searchMenu": true,
"keyboard": true,
"item": "searchTemplate",
"valueNames": ["component", "category", {"name": "link", "attr": "href"}],
"empty": "#searchNoResults"
}'>
<!-- Input Group -->
<div class="input-group input-group-merge navbar-input-group">
<div class="input-group-prepend input-group-text">
<i class="bi-search"></i>
</div>
<input type="search" class="search form-control form-control-sm" placeholder="Search in docs" aria-label="Search in docs">
<a class="input-group-append input-group-text" href="javascript:;">
<i id="clearSearchResultsIcon" class="bi-x" style="display: none;"></i>
</a>
</div>
<!-- End Input Group -->
<!-- List -->
<div class="list dropdown-menu navbar-dropdown-menu-borderless w-100 overflow-auto" style="max-height: 16rem;"></div>
<!-- End List -->
<!-- Empty -->
<div id="searchNoResults" style="display: none;">
<div class="text-center p-4">
<img class="mb-3" src="../assets/svg/illustrations/oc-error.svg" alt="Image Description" style="width: 10rem;">
<p class="mb-0">No Results</p>
</div>
</div>
<!-- End Empty -->
</form>
<!-- End Search Form -->
<!-- List Item Template -->
<div class="d-none">
<div id="searchTemplate" class="dropdown-item">
<a class="d-block link" href="#">
<span class="category d-block fw-normal text-muted mb-1"></span>
<span class="component text-dark"></span>
</a>
</div>
</div>
<!-- End List Item Template -->
</div>
<!-- Navbar -->
<ul class="navbar-nav p-0">
<li class="nav-item">
<a class="btn btn-ghost-secondary btn-sm" href="https://htmlstream.com/contact-us" target="_blank">
Get Support <i class="bi-box-arrow-up-right ms-1"></i>
</a>
</li>
<li class="nav-item">
<a class="btn btn-primary btn-sm" href="../index.html">
<i class="bi-eye me-1"></i> Preview Demo
</a>
</li>
</ul>
<!-- End Navbar -->
</div>
</div>
<!-- End Col -->
</div>
<!-- End Row -->
</nav>
</div>
</header>
<!-- ========== END HEADER ========== -->
<!-- ========== MAIN CONTENT ========== -->
<main id="content" role="main">
<!-- Navbar -->
<nav class="js-nav-scroller navbar navbar-expand-lg navbar-sidebar navbar-vertical navbar-light bg-white border-end"
data-hs-nav-scroller-options='{
"type": "vertical",
"target": ".navbar-nav .active",
"offset": 80
}'>
<!-- Navbar Toggle -->
<button type="button" class="navbar-toggler btn btn-white d-grid w-100" data-bs-toggle="collapse" data-bs-target="#navbarVerticalNavMenu" aria-label="Toggle navigation" aria-expanded="false" aria-controls="navbarVerticalNavMenu">
<span class="d-flex justify-content-between align-items-center">
<span class="h3 mb-0">Nav menu</span>
<span class="navbar-toggler-default">
<i class="bi-list"></i>
</span>
<span class="navbar-toggler-toggled">
<i class="bi-x"></i>
</span>
</span>
</button>
<!-- End Navbar Toggle -->
<!-- Navbar Collapse -->
<div id="navbarVerticalNavMenu" class="collapse navbar-collapse">
<div class="navbar-brand-wrapper border-end" style="height: auto;">
<!-- Default Logo -->
<div class="d-flex align-items-center mb-3">
<a class="navbar-brand" href="../documentation/index.html" aria-label="Space">
<img class="navbar-brand-logo" src="../assets/svg/logos/logo.svg" alt="Logo">
</a>
<a class="navbar-brand-badge" href="../documentation/changelog.html">
<span class="badge bg-soft-primary text-primary ms-2">v4.1</span>
</a>
</div>
<!-- End Default Logo -->
<!-- Nav -->
<ul class="nav nav-segment nav-fill nav-justified">
<li class="nav-item">
<a class="nav-link active" href="../documentation/index.html">Docs</a>
</li>
<li class="nav-item">
<a class="nav-link" href="../snippets/index.html">Snippets</a>
</li>
</ul>
<!-- End Nav -->
</div>
<div class="docs-navbar-sidebar-aside-body navbar-sidebar-aside-body">
<ul id="navbarSettings" class="navbar-nav nav nav-vertical nav-tabs nav-tabs-borderless nav-sm">
<li class="nav-item">
<span class="nav-subtitle">Documentation</span>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/index.html">Introduction</a>
</li>
<li class="nav-item my-2 my-lg-5"></li>
<li class="nav-item">
<span class="nav-subtitle">Getting started</span>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/getting-started.html">Getting Started</a>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/gulp.html">Gulp</a>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/customization.html">Customization</a>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/credits.html">Credits</a>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/changelog.html">Changelog</a>
</li>
<li class="nav-item my-2 my-lg-5"></li>
<li class="nav-item">
<span class="nav-subtitle">Design &amp; Graphics</span>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/bs-icons.html">Bootstrap Icons</a>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/duotone-icons.html">Duotone Icons</a>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/illustrations.html">Illustrations</a>
</li>
<li class="nav-item my-2 my-lg-5"></li>
<li class="nav-item">
<span class="nav-subtitle">Components</span>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/accordion.html">Accordion</a>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/alerts.html">Alerts</a>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/avatars.html">Avatars</a>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/badge.html">Badge</a>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/breadcrumb.html">Breadcrumb</a>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/buttons.html">Buttons</a>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/cards.html">Cards</a>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/collapse.html">Collapse</a>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/column-divider.html">Column Divider</a>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/devices.html">Devices</a>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/divider.html">Divider</a>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/dropdowns.html">Dropdowns</a>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/icons.html">Icons</a>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/list-group.html">List Group</a>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/lists.html">Lists</a>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/legend-indicator.html">Legend Indicator</a>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/modal.html">Modal</a>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/offcanvas.html">Offcanvas</a>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/page-header.html">Page Header</a>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/pagination.html">Pagination</a>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/popovers.html">Popovers</a>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/progress.html">Progress</a>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/profile.html">Profile</a>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/shapes.html">Shapes</a>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/spinners.html">Spinners</a>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/steps.html">Steps</a>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/tab.html">Tab</a>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/tables.html">Tables</a>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/text-highlight.html">Text Highlight</a>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/toasts.html">Toasts</a>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/tooltips.html">Tooltips</a>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/typography.html">Typography</a>
</li>
<li class="nav-item my-2 my-lg-5"></li>
<li class="nav-item">
<small class="nav-subtitle d-block">Navbars</small>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/navbar.html">Navbar</a>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/navs.html">Navs</a>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/mega-menu.html">Mega Menu</a>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/scrollspy.html">Scrollspy</a>
</li>
<li class="nav-item my-2 my-lg-5"></li>
<li class="nav-item">
<small class="nav-subtitle d-block">Basic forms</small>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/basic-forms.html">Basic Forms</a>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/checks-and-switches.html">Checks &amp; Switches</a>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/input-group.html">Input Group</a>
</li>
<li class="nav-item my-2 my-lg-5"></li>
<li class="nav-item">
<small class="nav-subtitle">Advanced Forms</small>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/select.html">Advanced Select</a>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/file-attachments.html">File Attachments</a>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/dropzone.html">Drag n Drop File Uploads</a>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/quill.html">WYSIWYG Editor</a>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/quantity-counter.html">Quantity Counter</a>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/input-mask.html">Input Mask</a>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/step-forms.html">Step Forms (Wizards)</a>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/range-slider.html">Range Slider (noUiSlider)</a>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/add-field.html">Add Field</a>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/toggle-password.html">Toggle Password</a>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/count-characters.html">Count Characters</a>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/toggle-switch.html">Toggle Switch</a>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/toggle-state.html">Toggle State</a>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/switch.html">Switch</a>
</li>
<li class="nav-item my-2 my-lg-5"></li>
<li class="nav-item">
<small class="nav-subtitle">Media</small>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/fslightbox.html">Fullscreen Lightbox</a>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/video-bg.html">Video Background</a>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/video-player.html">Video Player</a>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/swiper.html">Swiper</a>
</li>
<li class="nav-item my-2 my-lg-5"></li>
<li class="nav-item">
<small class="nav-subtitle">Others</small>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/maps-leaflet.html">Maps (Leaflet)</a>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/chartjs.html">Chart.js</a>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/circles.html">Circles.js (Pie Chart)</a>
</li>
<li class="nav-item">
<a class="nav-link active" href="../documentation/sticky-block.html">Sticky Block</a>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/countdown.html">Countdown</a>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/sorting.html">Sorting (Shuffle.js)</a>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/go-to.html">Go To</a>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/show-animation.html">Show Animation</a>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/typedjs.html">Typed.js</a>
</li>
<li class="nav-item my-2 my-lg-5"></li>
<li class="nav-item">
<small class="nav-subtitle d-block">Utilities</small>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/backgrounds.html">Backgrounds</a>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/borders.html">Borders</a>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/colors.html">Colors</a>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/links.html">Links</a>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/position.html">Position</a>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/rotations.html">Rotations</a>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/shadows.html">Shadows</a>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/sizing.html">Sizing</a>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/spacing.html">Spacing</a>
</li>
<li class="nav-item">
<a class="nav-link " href="../documentation/z-index.html">Z-index</a>
</li>
</ul>
</div>
</div>
<!-- End Navbar Collapse -->
</nav>
<!-- End Navbar -->
<!-- Content -->
<div class="navbar-sidebar-aside-content content-space-1 content-space-md-2 px-lg-5 px-xl-10">
<!-- Page Header -->
<div class="docs-page-header">
<div class="row align-items-center">
<div class="col-sm">
<h1 class="docs-page-header-title">Sticky Block</h1>
<p class="docs-page-header-text">This is for making any block floating on your page.</p>
</div>
</div>
</div>
<!-- End Page Header -->
<!-- Heading -->
<h2 id="how-to-use" class="hs-docs-heading">
How to use <a class="anchorjs-link" href="#how-to-use" aria-label="Anchor" data-anchorjs-icon="#"></a>
</h2>
<!-- End Heading -->
<p>Copy-paste the following <code>&lt;script&gt;</code> near the end of your pages under <em><u>JS Implementing Plugins</u></em> to enable it.</p>
<pre class="rounded mb-4">
<code class="language-html" data-lang="html">
&lt;script src="../assets/vendor/hs-sticky-block/dist/hs-sticky-block.min.js"&gt;&lt;/script&gt;
</code>
</pre>
<p>Copy-paste the init function under <em><u>JS Plugins Init.</u></em>, before the closing <code>&lt;/body&gt;</code> tag, to enable it.</p>
<pre class="rounded">
<code class="language-html" data-lang="html">
&lt;script&gt;
(function() {
// INITIALIZATION OF STICKY BLOCKS
// =======================================================
new HSStickyBlock('.js-sticky-block', {
targetSelector: document.getElementById('header').classList.contains('navbar-fixed') ? '#header' : null
})
})
&lt;/script&gt;
</code>
</pre>
<!-- Heading -->
<h2 id="example" class="hs-docs-heading">
Example <a class="anchorjs-link" href="#example" aria-label="Anchor" data-anchorjs-icon="#"></a>
</h2>
<!-- End Heading -->
<pre class="rounded">
<code class="language-markup" data-lang="html">
&lt;!-- Sticky Block --&gt;
&lt;div id="stickyBlockStartPoint"&gt;
&lt;nav class="js-sticky-block bg-primary rounded"
data-hs-sticky-block-options='{
"parentSelector": "#stickyBlockStartPoint",
"breakpoint": "lg",
"startPoint": "#stickyBlockStartPoint",
"endPoint": "#stickyBlockEndPoint",
"stickyOffsetTop": 20,
"stickyOffsetBottom": 20
}'&gt;
Example text ...
&lt;/nav&gt;
&lt;/div&gt;
&lt;!-- End Sticky Block --&gt;
&lt;!-- Sticky Block End Point --&gt;
&lt;div id="stickyBlockEndPoint"&gt;&lt;/div&gt;
</code>
</pre>
<!-- Heading -->
<h2 id="methods" class="hs-docs-heading">
Methods <a class="anchorjs-link" href="#methods" aria-label="Anchor" data-anchorjs-icon="#"></a>
</h2>
<!-- End Heading -->
<!-- Card -->
<div class="card">
<!-- Table -->
<div class="table-responsive">
<table class="table">
<thead class="thead-light">
<tr>
<th>Parameters</th>
<th style="width: 50%;">Description</th>
<th class="text-nowrap">Default value</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<p><code>parentSelector</code></p>
</td>
<td>Defines the parent element</td>
<td><code>null</code></td>
</tr>
<tr>
<td>
<p><code>targetSelector</code></p>
</td>
<td>Determines the height of which element should be taken into account when calculating the <code>startPoint</code></td>
<td><code>null</code></td>
</tr>
<tr>
<td>
<p><code>stickyOffsetTop</code></p>
</td>
<td>Determines the distance above the edge of the visible area</td>
<td><code>0</code></td>
</tr>
<tr>
<td>
<p><code>stickyOffsetBottom</code></p>
</td>
<td>Determines the distance below the edge of the visible area</td>
<td><code>0</code></td>
</tr>
<tr>
<td>
<p><code>startPoint</code></p>
</td>
<td>Determines upon reaching which block specified in the value, the sticks the block begins to become <code>fixed</code></td>
<td><code>null</code></td>
</tr>
<tr>
<td>
<p><code>endPoint</code></p>
</td>
<td>Determines upon reaching which block specified in the value, the sticks the block ceases to be <code>fixed</code>. If the stick does not have a breakpoint, then set the value to <code>9999999</code>, that is, the maximum possible page height</td>
<td><code>null</code></td>
</tr>
<tr>
<td>
<p><code>breakpoint</code></p>
</td>
<td>Determines with what permission the plugin is initialized. Resolution Map corresponds to Bootstrap 4</td>
<td><code>'lg'</code></td>
</tr>
</tbody>
</table>
</div>
<!-- End Table -->
</div>
<!-- End Card -->
</div>
<!-- End Content -->
</main>
<!-- ========== END MAIN CONTENT ========== -->
<!-- ========== SECONDARY CONTENTS ========== -->
<!-- Go To -->
<a class="js-go-to go-to position-fixed" href="javascript:;" style="visibility: hidden;"
data-hs-go-to-options='{
"offsetTop": 700,
"position": {
"init": {
"right": "2rem"
},
"show": {
"bottom": "2rem"
},
"hide": {
"bottom": "-2rem"
}
}
}'>
<i class="bi-chevron-up"></i>
</a>
<!-- ========== END SECONDARY CONTENTS ========== -->
<!-- JS Implementing Plugins -->
<script src="../assets/js/vendor.min.js"></script>
<!-- JS Front -->
<script src="../assets/js/theme.min.js"></script>
<!-- JS Plugins Init. -->
<script>
(function() {
// INITIALIZATION OF HEADER
// =======================================================
new HSHeader('#header').init()
// INITIALIZATION OF NAV SCROLLER
// =======================================================
new HsNavScroller('.js-nav-scroller', {
delay: 400,
offset: 140
})
// INITIALIZATION OF LISTJS COMPONENT
// =======================================================
const docsSearch = HSCore.components.HSList.init('#docsSearch')
// GET JSON FILE RESULTS
// =======================================================
fetch('../assets/json/docs-search.json')
.then(response => response.json())
.then(data => {
docsSearch.getItem(0).add(data)
})
// INITIALIZATION OF GO TO
// =======================================================
new HSGoTo('.js-go-to')
// INITIALIZATION OF STICKY BLOCKS
// =======================================================
new HSStickyBlock('.js-sticky-block', {
targetSelector: document.getElementById('header').classList.contains('navbar-fixed') ? '#header' : null
})
})()
</script>
</body>
</html>