asciidoctor-tabs 1.0.0.alpha.5 → 1.0.0.alpha.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a220a5fcabda931f52d5ca7d6fbf4b3c459eb258c6694288cd147b5db58f68b
-  data.tar.gz: 20b389528d89b8e450e06dedfc0e9dc4944c9672854a12469b4e15189dfd8868
+  metadata.gz: 53a90833ce2142600152bf87248d9470058d6e39495863c644ac7e7bcc8c8ef0
+  data.tar.gz: fd0c9ab6d3e8a27c7bcb48489115b7c7a069a5aee6985626ffb91dc827830baa
 SHA512:
-  metadata.gz: 641e2de8bba5626ba461fca9b5b212769bf4175724d02f6fc56d2f891395dffdd9072aa65224530fc0ec26e84d35ff21026097aa0f57a37d7e81a957dbf14c6d
-  data.tar.gz: 5d723e02e0b9a4255715ee4daae0502900a1598e804dbf08801dd9e7acc91a78e2c3b9451a95a4b1d1d6a1060e41ef2c91d6527c3b3e278940f8b27045f41d0a
+  metadata.gz: 7f187bad924fd98d618d23b452f5d06551392bb3c2acc25990793af0a2d0a55897a3d1557790df64a9658d9c4dc9a533b7da6e0ae4abb53e9993121a356c2e8e
+  data.tar.gz: '039a9561293145c0717da9f98942d027ee18e89bdd23ab975deec004461e14ac85a1d4aa0540e52d28e9b531d495428f3c4bf74bf3f3c5ea118694ac703547d1'

data/CHANGELOG.adoc

@@ -4,6 +4,43 @@
 This document provides a curated view of the changes to Asciidoctor Tabs per release.
 For a detailed view of what has changed, refer to the {url-repo}/commits/main[commit history] on GitHub.
 
+== 1.0.0-alpha.7 (2022-11-28) - @mojavelinux
+
+=== Added
+
+* In tabs script, add `tab` class to tab element
+* Sync tab selection across tabs blocks if `sync` option is set on tabs block or `tabs-sync-option` attribute is set on document (#28)
+* Delist tabs block from sync if `nosync` option is set on block (#28)
+
+=== Changed
+
+* When inline anchor is used for tab ID, promote value of id attribute to id attribute on tab and remove anchor
+
+=== Fixed
+
+* Apply normal substitutions to principal text (first paragraph) of tab's content (#29)
+
+=== Details
+
+{url-repo}/releases/tag/v1.0.0-alpha.7[git tag] | {url-repo}/compare/v1.0.0-alpha.6\...v1.0.0-alpha.7[full diff]
+
+== 1.0.0-alpha.6 (2022-11-16) - @mojavelinux
+
+=== Added
+
+* Honor title on tabs block; apply normal subs to it (#26)
+* Clear location hash (URL fragment) when a tab is clicked (#24)
+* Register ref for each tab so its ID can be used as target of xref (#24)
+* Activate tab when selected from an internal xref (#24)
+
+=== Fixed
+
+* Decode fragment from URL so it can be matched against tab ID (#27)
+
+=== Details
+
+{url-repo}/releases/tag/v1.0.0-alpha.6[git tag] | {url-repo}/compare/v1.0.0-alpha.5\...v1.0.0-alpha.6[full diff]
+
 == 1.0.0-alpha.5 (2022-10-23) - @mojavelinux
 
 === Added
@@ -94,7 +131,7 @@ For a detailed view of what has changed, refer to the {url-repo}/commits/main[co
 
 == 1.0.0-alpha.1 (2022-10-01) - @mojavelinux
 
-_Initial release._
+_Initial prerelease._
 
 === Details
 

data/README.adoc

@@ -1,6 +1,6 @@
 = Asciidoctor Tabs
 Dan Allen <https://github.com/mojavelinux[@mojavelinux]>
-v1.0.0-alpha.5, 2022-10-23
+v1.0.0-alpha.7, 2022-11-28
 :idprefix:
 :idseparator: -
 ifndef::env-github[:icons: font]
@@ -84,7 +84,7 @@ The term is used as the tab's label and the description is used as the tab's con
 The contents can be defined as primary text, attached blocks, or both.
 If the attached blocks are themselves enclosed in a single open block, the open block enclosure itself is discarded upon conversion.
 
-You may decide to extend the block delimiter length instead of using the typical 4 characters to avoid conflicts with any example blocks inside the tab block (or just as a manner of style).
+You may choose to extend the block delimiter length from the typical 4 characters to 6 in order to avoid conflicts with any example blocks inside the tab block (or just as a matter of style).
 
 [,asciidoc]
 ----

data/data/js/tabs.js

@@ -1,46 +1,80 @@
-/*! Asciidoctor Tabs | Copyright (c) 2018-present Dan Allen | MIT License */
-;(function () {
+;(function () { /*! Asciidoctor Tabs | Copyright (c) 2018-present Dan Allen | MIT License */
   'use strict'
 
-  var hash = window.location.hash
-  find('.tabset').forEach(function (tabset) {
-    var active
-    var tabs = tabset.querySelector('.tabs')
-    if (tabs) {
-      var first
-      find('li', tabs).forEach(function (tab, idx) {
-        var id = (tab.querySelector('a[id]') || tab).id
-        if (!id) return
+  var forEach = Array.prototype.forEach
+
+  init(document.querySelectorAll('.tabset'))
+
+  function init (tabsets) {
+    if (!tabsets.length) return
+    var fragment = getFragment()
+    forEach.call(tabsets, function (tabset) {
+      var tabs = tabset.querySelectorAll('.tabs li')
+      if (!tabs.length) return tabset.classList.remove('is-loading')
+      var active, first, syncId
+      var syncIds = tabset.classList.contains('is-sync') ? {} : undefined
+      forEach.call(tabs, function (tab, idx) {
+        var id = tab.id
+        if (!id) {
+          var anchor = tab.querySelector('a[id]')
+          if (!anchor) return // invalid state
+          tab.id = id = anchor.parentNode.removeChild(anchor).id
+        }
+        tab.className = 'tab'
         var pane = tabset.querySelector('.tab-pane[aria-labelledby~="' + id + '"]')
-        if (!pane) return
-        if (!idx) first = { tab: tab, pane: pane }
-        if (!active && hash === '#' + id && (active = true)) {
+        if (!pane) return // invalid state
+        var instance = { tabset: tabset, tab: tab, pane: pane }
+        if (!idx) first = instance
+        if (!active && fragment === id && (active = true)) {
           tab.classList.add('is-active')
-          if (pane) pane.classList.add('is-active')
-        } else if (!idx) {
-          tab.classList.remove('is-active')
-          if (pane) pane.classList.remove('is-active')
+          pane.classList.add('is-active')
+        }
+        if (syncIds && !((syncId = tab.textContent.trim()) in syncIds)) {
+          syncIds[(tab.dataset.syncId = syncId)] = true
+          tab.addEventListener('click', activateTabSync.bind(instance))
+        } else {
+          tab.addEventListener('click', activateTab.bind(instance))
         }
-        tab.addEventListener('click', activateTab.bind({ tabset: tabset, tab: tab, pane: pane }))
       })
       if (!active && first) {
         first.tab.classList.add('is-active')
-        if (first.pane) first.pane.classList.add('is-active')
+        first.pane.classList.add('is-active')
       }
-    }
-    tabset.classList.remove('is-loading')
-  })
+      tabset.classList.remove('is-loading')
+    })
+    window.addEventListener('hashchange', onHashChange)
+  }
 
   function activateTab (e) {
     var tab = this.tab
-    var pane = this.pane
-    find('.tabs li, .tab-pane', this.tabset).forEach(function (it) {
-      it === tab || it === pane ? it.classList.add('is-active') : it.classList.remove('is-active')
+    var tabset = this.tabset || tab.closest('.tabset')
+    var pane = this.pane || tabset.querySelector('.tab-pane[aria-labelledby~="' + tab.id + '"]')
+    forEach.call(tabset.querySelectorAll('.tabs li, .tab-pane'), function (el) {
+      el === tab || el === pane ? el.classList.add('is-active') : el.classList.remove('is-active')
     })
+    if (!e) return
+    var loc = window.location
+    var hashIdx = loc.hash ? loc.href.indexOf('#') : -1
+    if (~hashIdx) window.history.replaceState(null, '', loc.href.slice(0, hashIdx))
     e.preventDefault()
   }
 
-  function find (selector, from) {
-    return Array.prototype.slice.call((from || document).querySelectorAll(selector))
+  function activateTabSync (e) {
+    activateTab.call(this, e)
+    var thisTab = this.tab
+    forEach.call(document.querySelectorAll('.tabs li'), function (tab) {
+      if (tab !== thisTab && tab.dataset.syncId === thisTab.dataset.syncId) activateTab.call({ tab: tab })
+    })
+  }
+
+  function getFragment (hash) {
+    return (hash = window.location.hash) && (~hash.indexOf('%') ? decodeURIComponent(hash.slice(1)) : hash.slice(1))
+  }
+
+  function onHashChange () {
+    var id = getFragment()
+    if (!id) return
+    var tab = document.getElementById(id)
+    if (tab && tab.classList.contains('tab')) activateTab.call({ tab: tab })
   }
 })()

data/lib/asciidoctor/tabs/block.rb

@@ -18,7 +18,11 @@ module Asciidoctor
         end
         tabset_number = doc.counter 'tabset-number'
         tabs_id = attrs['id'] || (generate_id %(tabset #{tabset_number}), doc)
-        parent << (create_html_fragment parent, %(<div id="#{tabs_id}" class="tabset is-loading">))
+        sync = !(block.option? 'nosync') && ((block.option? 'sync') || (doc.option? 'tabs-sync')) ? ' is-sync' : nil
+        parent << (create_html_fragment parent, %(<div id="#{tabs_id}" class="tabset#{sync || ''} is-loading">))
+        if (title = attrs['title'])
+          parent << (create_html_fragment parent, %(<div class="title">#{parent.apply_subs title}</div>))
+        end
         (tabs = create_list parent, :ulist).add_role 'tabs'
         panes = {}
         set_id_on_tab = (doc.backend == 'html5') || (list_item_supports_id? doc)
@@ -26,11 +30,15 @@ module Asciidoctor
           tab_ids = labels.map do |tab|
             tabs << tab
             tab_id = generate_id tab.text, doc, tabs_id
-            set_id_on_tab ? (tab.id = tab_id) : (tab.text = %([[#{tab_id}]]#{tab.instance_variable_get :@text}))
+            tab_source_text = tab.instance_variable_get :@text
+            set_id_on_tab ? (tab.id = tab_id) : (tab.text = %([[#{tab_id}]]#{tab_source_text}))
+            (doc.register :refs, [tab_id, tab]).set_attr 'reftext', tab_source_text
             tab_id
           end
           if content
-            tab_blocks = content.text? ? [(create_paragraph parent, (content.instance_variable_get :@text), nil)] : []
+            tab_blocks = content.text? ?
+              [(create_paragraph parent, (content.instance_variable_get :@text), nil, subs: :normal)]
+              : []
             if content.blocks?
               if (block0 = (blocks = content.blocks)[0]).context == :open && blocks.size == 1 && block0.blocks?
                 blocks = block0.blocks

data/lib/asciidoctor/tabs/version.rb

@@ -2,6 +2,6 @@
 
 module Asciidoctor
   module Tabs
-    VERSION = '1.0.0.alpha.5'
+    VERSION = '1.0.0.alpha.7'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-tabs
 version: !ruby/object:Gem::Version
-  version: 1.0.0.alpha.5
+  version: 1.0.0.alpha.7
 platform: ruby
 authors:
 - Dan Allen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-23 00:00:00.000000000 Z
+date: 2022-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -101,7 +101,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
 summary: An Asciidoctor extension that adds a tabs block to the AsciiDoc syntax.