Skip to content

Add back to top button & binding example #108

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Dec 31, 2024
Merged

Add back to top button & binding example #108

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ee6b13d
Add back to top button
jasalt Dec 29, 2024
2e39c90
Merge remote-tracking branch 'origin/master'
jasalt Dec 29, 2024
29b047f
Merge branch 'phel-lang:master' into master
jasalt Dec 29, 2024
7b0d8b5
add Binding example to Global and local bindings
jasalt Dec 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions content/documentation/global-and-local-bindings.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,3 +69,29 @@ To update a variable with a function the `swap!` function can be used.
(swap! foo + 2) # Evaluates to 12
(deref foo) # Evaluates to 12
```

## Binding

While writing tests on code depending on external state can be challenging, `binding` function allows to remap existing bindings which can be used for mocking functions or values during tests. As example, code depending on runtime environment:

```phel
(ns my-app\tests\demo
(:require phel\test :refer [deftest is]))

# Function that would return e.g. "x86_64", depending on the environment:
(defn get-system-architecture [] (php/php_uname "m"))

(defn greet-user-by-architecture []
(print "Hello" (get-system-architecture) "user!"))

# With binding, a mock function can be used in place of the original one
# allowing to write tests for cases that depend on system state:
(deftest greeting-test
(binding [get-system-architecture |(str "i386")] # <- mock function
(let [greeting-out (with-output-buffer (greet-user-by-architecture))]
(is (= "Hello i386 user!" greeting-out)
"i386 system user is greeted accordingly"))))

# Test is successful:
# ✔ greet-test: i386 system user is greeted accordingly
```
22 changes: 21 additions & 1 deletion sass/site.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,27 @@
@import 'post-list';

body {
padding-top: $header-height;
padding-top: $header-height;

#back-to-top-button {
display: none;
position: fixed;
bottom: 20px;
right: 30px;
z-index: 99;
border: none;
outline: none;
background-color: $color-base-primary;
color: $color-text-inverted;
cursor: pointer;
padding: 15px;
border-radius: 2px;
font-size: 18px;

&:hover {
background-color: $color-base-hover;
}
}
}

footer {
Expand Down
19 changes: 19 additions & 0 deletions static/back_to_top.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
// Get the button:
let mybutton = document.getElementById("back-to-top-button");

// When the user scrolls down 20px from the top of the document, show the button
window.onscroll = function() {scrollFunction()};

function scrollFunction() {
if (document.body.scrollTop > 20 || document.documentElement.scrollTop > 20) {
mybutton.style.display = "block";
} else {
mybutton.style.display = "none";
}
}

// When the user clicks on the button, scroll to the top of the document
function backToTop() {
document.body.scrollTop = 0; // For Safari
document.documentElement.scrollTop = 0; // For Chrome, Firefox, IE and Opera
}
3 changes: 3 additions & 0 deletions templates/base.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,12 @@
<body>
{% block body %} {% endblock %}

<button onclick="backToTop()" id="back-to-top-button" title="Go to top">Top</button>

<script type="text/javascript" src="{{ get_url(path='elasticlunr.min.js') }}" defer></script>
<script type="text/javascript" src="{{ get_url(path='api_search.js') }}" defer></script>
<script type="text/javascript" src="{{ get_url(path='search.js') }}" defer></script>
<script type="text/javascript" src="{{ get_url(path='back_to_top.js') }}" defer></script>
</body>

</html>
Loading