Skip to content
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.

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

Open accordions using URL hashes #674

Merged
merged 5 commits into from
Mar 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
11 changes: 7 additions & 4 deletions _includes/components/accordion.html
Original file line number Diff line number Diff line change
@@ -1,12 +1,15 @@
{% assign slug = include.title | slugify %}
{% if include.slug %}
{% assign slug = include.slug %}
{% endif %}
<div class="accordion default" id="accordion-{{ slug }}">
<div class="accordion-item">
<p class="accordion-header" id="heading-{{ slug }}">
<button class="accordion-button {% unless(include.open) %}collapsed{% endunless %}" type="button" data-bs-toggle="collapse" data-bs-target="#collapse-{{ slug }}" aria-expanded="{% if(include.open) %}true{% else %}false{% endif %}" aria-controls="collapse-{{ slug }}">
<div class="accordion-item" id="accordion-item-{{ slug }}">
<p class="accordion-header" id="accordion-header-{{ slug }}">
<button class="accordion-button {% unless(include.open) %}collapsed{% endunless %}" type="button" data-bs-toggle="collapse" data-bs-target="#{{ slug }}" aria-expanded="{% if(include.open) %}true{% else %}false{% endif %}" aria-controls="{{ slug }}">
{{ include.title }}
</button>
</p>
<div id="collapse-{{ slug }}" class="accordion-collapse collapse {% if(include.open) %}show{% endif %}" aria-labelledby="heading-{{ slug }}" data-bs-parent="#accordion-{{ slug }}">
<div id="{{ slug }}" class="accordion-collapse collapse {% if(include.open) %}show{% endif %}" aria-labelledby="heading-{{ slug }}" data-bs-parent="#accordion-{{ slug }}">
<div class="accordion-body">
{{ include.content }}
</div>
Expand Down
1 change: 1 addition & 0 deletions _includes/scripts.html
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
<script src="/assets/js/bootstrap.bundle.min.js" crossorigin="anonymous"></script>
<script src="/assets/js/toc-scroll.js" async></script>
<script src="/assets/js/external-links.js" defer></script>
<script src="/assets/js/hashes.js"></script>

{% include google_analytics.html %}
2 changes: 1 addition & 1 deletion about/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ menus:
<!-- End: Info box -->

<!-- START: Accordions Each h2 below will be a separate accordion. -->
<div class="accordion default border-top-gradient-software-blue-green border-bottom-gradient-software-blue-green">
<div class="border-top-gradient-software-blue-green border-bottom-gradient-software-blue-green">
{% capture accordionContent %}
If you’re new to GitHub and open source in general, figuring out how to get set up can be a challenge. You may want to read through the GitHub Help pages on [setting up and managing your GitHub profile](https://support.github.com/features/account).

Expand Down
43 changes: 43 additions & 0 deletions assets/js/hashes.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
window.addEventListener('load', function() {
setupHashTrigger();
setupHashUpdates();

function setupHashTrigger() {
if (!window.location.hash) {
return;
}
const element = document.querySelector(window.location.hash);
if (!element) {
return;
}
if (element.className.indexOf('accordion-collapse') > -1) {
new bootstrap.Collapse(element, { show: true });
recordAccordionOpen(element);
}
}

function setupHashUpdates() {
const accordionElements = document.querySelectorAll('.accordion');
accordionElements.forEach(function(element) {
element.addEventListener('show.bs.collapse', function(event) {
const hash = '#' + event.target.id;
window.history.replaceState('', '', hash);
recordAccordionOpen(element);
});

element.addEventListener('hide.bs.collapse', function(event) {
const hash = '#' + event.target.id;
if (window.location.hash == hash) {
window.history.replaceState('', '', window.location.pathname + window.location.search);
}
});

});
}

function recordAccordionOpen(element) {
if (typeof _paq !== 'undefined') {
_paq.push(['trackEvent', 'Accordion', 'Opened', element.id]);
}
}
});
8 changes: 8 additions & 0 deletions assets/js/libs/angular-animate.min.js.map

Large diffs are not rendered by default.

8 changes: 5 additions & 3 deletions assets/js/toc-scroll.js
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
window.addEventListener('load', function() {
const headings = document.querySelectorAll('h2[id], h3[id]'),
jumpLinks = document.querySelectorAll('.jump-links a'),
const headings = Array.from(
document.querySelectorAll('h2[id], h3[id]')
).filter(element => !element.closest('.accordion'));
const jumpLinks = document.querySelectorAll('.jump-links a'),
jumpLinkLookup = {},
jumpLinkTargetLookup = {};

// create jumplink/heading lookups
for (var i = 0; i < jumpLinks.length; i++) {
const element = jumpLinks[i];
Expand Down