pageflow-outline-navigation-bar 0.1.0

data/.scss-lint.yml

@@ -0,0 +1,145 @@
+scss_files: "**/*.scss"
+linters:
+  BangFormat:
+    enabled: true
+    space_before_bang: true
+    space_after_bang: false
+  BorderZero:
+    enabled: false
+    convention: zero
+  ColorKeyword:
+    enabled: true
+    severity: warning
+  ColorVariable:
+    enabled: true
+  Comment:
+    enabled: true
+  DebugStatement:
+    enabled: true
+  DeclarationOrder:
+    enabled: false
+  DuplicateProperty:
+    enabled: true
+  ElsePlacement:
+    enabled: true
+    style: same_line
+  EmptyLineBetweenBlocks:
+    enabled: true
+    ignore_single_line_blocks: true
+  EmptyRule:
+    enabled: true
+  FinalNewline:
+    enabled: true
+    present: true
+  HexLength:
+    enabled: false
+    style: short
+  HexNotation:
+    enabled: true
+    style: lowercase
+  HexValidation:
+    enabled: true
+  IdSelector:
+    enabled: true
+  ImportantRule:
+    enabled: true
+  ImportPath:
+    enabled: true
+    leading_underscore: false
+    filename_extension: false
+  Indentation:
+    enabled: true
+    allow_non_nested_indentation: false
+    character: space
+    width: 2
+  LeadingZero:
+    enabled: true
+    style: include_zero
+  MergeableSelector:
+    enabled: true
+    force_nesting: true
+  NameFormat:
+    enabled: true
+    allow_leading_underscore: true
+    convention: hyphenated_lowercase
+  NestingDepth:
+    enabled: true
+    max_depth: 4
+    severity: warning
+  PlaceholderInExtend:
+    enabled: false
+  PropertyCount:
+    enabled: true
+    include_nested: false
+    max_properties: 10
+  PropertySortOrder:
+    enabled: false
+    ignore_unspecified: false
+    severity: warning
+    separate_groups: false
+  PropertySpelling:
+    enabled: true
+    extra_properties: []
+  QualifyingElement:
+    enabled: false
+    allow_element_with_attribute: false
+    allow_element_with_class: false
+    allow_element_with_id: false
+    severity: warning
+  SelectorDepth:
+    enabled: true
+    max_depth: 3
+    severity: warning
+  SelectorFormat:
+    enabled: true
+    convention: snake_case
+  Shorthand:
+    enabled: false
+    severity: warning
+  SingleLinePerProperty:
+    enabled: true
+    allow_single_line_rule_sets: true
+  SingleLinePerSelector:
+    enabled: true
+  SpaceAfterComma:
+    enabled: true
+  SpaceAfterPropertyColon:
+    enabled: true
+    style: one_space
+  SpaceAfterPropertyName:
+    enabled: true
+  SpaceBeforeBrace:
+    enabled: true
+    style: space
+    allow_single_line_padding: false
+  SpaceBetweenParens:
+    enabled: true
+    spaces: 0
+  StringQuotes:
+    enabled: true
+    style: double_quotes
+  TrailingSemicolon:
+    enabled: true
+  TrailingZero:
+    enabled: false
+  UnnecessaryMantissa:
+    enabled: true
+  UnnecessaryParentReference:
+    enabled: true
+  UrlFormat:
+    enabled: true
+  UrlQuotes:
+    enabled: true
+  VariableForProperty:
+    enabled: false
+    properties: []
+  VendorPrefixes:
+    enabled: true
+    identifier_list: bourbon
+    include: []
+    exclude: []
+  ZeroUnit:
+    enabled: true
+    severity: warning
+  Compass::PropertyWithMixin:
+    enabled: false

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# CHANGELOG
+
+### Version 0.1.0
+
+2016-09-09
+
+Initial release.

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in chart.gemspec
+gemspec

data/README.md

@@ -0,0 +1,42 @@
+# Pageflow Outline Navigation Bar
+
+[![Gem Version](https://badge.fury.io/rb/pageflow-outline-navigation-bar.svg)](http://badge.fury.io/rb/pageflow-outline-navigation-bar)
+
+A navigation bar displaying chapter titles.
+
+## Installation
+
+Add this line to your application's `Gemfile`:
+
+    gem 'pageflow-outline-navigation-bar'
+
+Register the plugin inside the configure block in `config/initializers/pageflow.rb`
+
+    Pageflow.configure do |config|
+      config.plugin(Pageflow::OutlineNavigationBar.plugin)
+    end
+
+Include javascripts and stylesheets:
+
+    # app/assets/javascripts/pageflow/application.js
+    //= require pageflow/outline_navigation_bar
+
+    # app/assets/stylesheets/pageflow/themes/default.css.scss
+    @import "pageflow/outline_navigation_bar/themes/default";
+
+Execute `bundle install` and restart the application server. Now the
+widget type can be enabled in your feature settings.
+
+## Troubleshooting
+
+If you run into problems while installing the page type, please also refer to the
+[Troubleshooting](https://github.com/codevise/pageflow/wiki/Troubleshooting) wiki
+page in the [Pageflow  repository](https://github.com/codevise/pageflow). If that
+doesn't help, consider
+[filing an issue](https://github.com/codevise/pageflow-outline-navigation-bar/issues).
+
+## Contributing Locales
+
+Edit the translations directly on the
+[pageflow-outline-navigation-bar](http://www.localeapp.com/projects/public?search=tf/pageflow-outline-navigation-bar)
+locale project.

data/Rakefile

@@ -0,0 +1,10 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+Bundler::GemHelper.install_tasks
+
+require 'semmy'
+Semmy::Tasks.install

data/app/assets/javascript/pageflow/outline_navigation_bar.js

@@ -0,0 +1,26 @@
+//= require_self
+
+//= require ./outline_navigation_bar/events
+//= require ./outline_navigation_bar/expander
+//= require ./outline_navigation_bar/hide_text_button
+//= require ./outline_navigation_bar/resizer
+//= require ./outline_navigation_bar/navigator
+//= require ./outline_navigation_bar/scroller
+//= require ./outline_navigation_bar/panels
+//= require ./outline_navigation_bar/menu_item
+
+//= require ./outline_navigation_bar/widget
+
+pageflow.outlineNavigationBar = pageflow.outlineNavigationBar || {};
+
+pageflow.widgetTypes.register('outline_navigation_bar_expandable', {
+  enhance: function(element) {
+    element.outlineNavigationBar();
+  }
+});
+
+pageflow.widgetTypes.register('outline_navigation_bar_fixed', {
+  enhance: function(element) {
+    element.outlineNavigationBar();
+  }
+});

data/app/assets/javascript/pageflow/outline_navigation_bar/events.js

@@ -0,0 +1,30 @@
+pageflow.outlineNavigationBar.events = {
+  pointerUp: 'touchend mouseup MSPointerUp pointerup',
+  pointerDown: 'touchstart mousedown MSPointerDown pointerdown',
+
+  onPointerDown: function(element, selectorOrHandler, handler) {
+    var selector = handler ? selectorOrHandler : null;
+    handler = handler || selectorOrHandler;
+
+    this._onPointerDown(handler, function(event, fn) {
+      element.on(event, selector, fn);
+    });
+  },
+
+  _onPointerDown: function(handler, on) {
+    on(this.pointerDown, function(event) {
+      event.preventDefault();
+      handler.call(this);
+    });
+
+    on('click', function(event) {
+      event.preventDefault();
+    });
+
+    on('keypress', function(event) {
+      if (event.which == 13) {
+        handler.call(this);
+      }
+    });
+  },
+};

data/app/assets/javascript/pageflow/outline_navigation_bar/expander.js

@@ -0,0 +1,34 @@
+pageflow.outlineNavigationBar.Expander = pageflow.Object.extend({
+  initialize: function(options) {
+    this.options = options;
+    this.expandedBy = {};
+  },
+
+  expand: function(options) {
+    this.expandedBy[(options && options.by) || 'button'] = true;
+    clearTimeout(this.collapseTimeout);
+
+    if (!this.expanded && this.options.enabled()) {
+      this.expanded = true;
+      this.options.expand();
+    }
+  },
+
+  collapse: function(options) {
+    delete this.expandedBy[(options && options.by) || 'button'];
+    clearTimeout(this.collapseTimeout);
+
+    if (this.expanded && _.keys(this.expandedBy).length === 0) {
+      this.expanded = false;
+      this.options.collapse();
+    }
+  },
+
+  scheduleCollapse: function(options) {
+    var that = this;
+
+    this.collapseTimeout = setTimeout(function() {
+      that.collapse(options);
+    }, 200);
+  }
+});

data/app/assets/javascript/pageflow/outline_navigation_bar/fullscreen_button.js

@@ -0,0 +1,24 @@
+(function($) {
+  $.widget('pageflow.outlineNavigationBarFullscreenButton', {
+    _create: function() {
+      var element = this.element;
+
+      if ($.support.fullscreen) {
+        element.click(function() {
+          element.toggleClass('fs').updateTitle();
+
+          $('#outer_wrapper').fullScreen({
+            callback: function(isFullScreen) {
+              element
+                .toggleClass('active', !!isFullScreen)
+                .updateTitle();
+            }
+          });
+        });
+      }
+      else {
+        element.parent().hide();
+      }
+    }
+  });
+}(jQuery));

data/app/assets/javascript/pageflow/outline_navigation_bar/hide_text_button.js

@@ -0,0 +1,17 @@
+(function($) {
+  var events = pageflow.outlineNavigationBar.events;
+
+  $.widget('pageflow.outlineNavigationBarHideTextButton', {
+    _create: function() {
+      var element = this.element;
+
+      element.click(function() {
+        pageflow.hideText.toggle();
+      });
+
+      pageflow.hideText.on('activate deactivate', function() {
+        element.toggleClass('active', pageflow.hideText.isActive()).updateTitle();
+      });
+    }
+  });
+}(jQuery));

data/app/assets/javascript/pageflow/outline_navigation_bar/menu_item.js

@@ -0,0 +1,41 @@
+(function($) {
+  var events = pageflow.outlineNavigationBar.events;
+
+  $.widget('pageflow.outlineNavigationBarMenuItem', {
+    _create: function() {
+      this._setupPressedClass();
+      this._ensureOpenWhileFocusInMenuBox();
+    },
+
+    _setupPressedClass: function() {
+      var element = this.element;
+
+      element.on(events.pointerDown, '> a', function() {
+        var link = $(this);
+        link.addClass('pressed');
+
+        $('body').one(events.pointerUp, function() {
+          link.removeClass('pressed');
+        });
+      });
+    },
+
+    _ensureOpenWhileFocusInMenuBox: function() {
+      var element = this.element;
+
+      element.find('.menu_box a').on({
+        focus: function() {
+          element.addClass('focused');
+        },
+
+        blur: function() {
+          element.removeClass('focused');
+        }
+      });
+
+      element.on('mouseleave', function() {
+        element.blur();
+      });
+    }
+  });
+}(jQuery));

data/app/assets/javascript/pageflow/outline_navigation_bar/navigator.js

@@ -0,0 +1,35 @@
+(function($) {
+  var events = pageflow.outlineNavigationBar.events;
+
+  $.widget('pageflow.outlineNavigationBarNavigator', {
+    _create: function() {
+      var element = this.element;
+      var scroller = this.options.scroller;
+      var links = element.find('a');
+
+      element.on(events.pointerDown, 'a', function(event) {
+        event.preventDefault();
+        $(this).one(events.pointerUp, goToPage);
+      });
+
+      element.on('click', 'a', function(event) {
+        event.preventDefault();
+      });
+
+      element.on('keydown', 'a', function(event) {
+        if (event.which == 13) {
+          goToPage.call(this);
+        }
+      });
+
+      scroller.on('scroll', function() {
+        links.off(events.pointerUp, goToPage);
+      });
+
+      function goToPage() {
+        var id = $(this).data('link');
+        pageflow.slides.goToById(id);
+      }
+    }
+  });
+}(jQuery));

data/app/assets/javascript/pageflow/outline_navigation_bar/panels.js

@@ -0,0 +1,54 @@
+(function($) {
+  var events = pageflow.outlineNavigationBar.events;
+
+  $.widget('pageflow.outlineNavigationBarPanels', {
+    _create: function() {
+      var links = this.options.toggles.find('a');
+      var expander = this.options.expander;
+      var widget = this;
+
+      events.onPointerDown(links, function() {
+        var link = $(this);
+        var panelName = link.data('panel');
+        var collapsed = false;
+
+        if (link.data('toggle') === 'expandable') {
+          if (link.hasClass('active')) {
+            expander.collapse();
+            collapsed = true;
+          }
+          else {
+            expander.expand();
+          }
+        }
+        else if (link.data('toggle')) {
+          if (link.hasClass('active')) {
+            panelName = link.data('toggle');
+          }
+        }
+
+        widget.update(panelName, collapsed);
+      });
+    },
+
+    reset: function() {
+      var defaultLink = this.options.toggles.find('a[data-toggle="expandable"]');
+      this.update(defaultLink.data('panel'), true);
+    },
+
+    update: function(panelName, collapsed) {
+      var links = this.options.toggles.find('a');
+      var panels = this.options.panels;
+
+      links.each(function() {
+        var link = $(this);
+        link.toggleClass('active', link.data('panel') === panelName && !collapsed);
+      });
+
+      panels.each(function() {
+        var panel = $(this);
+        panel.toggleClass('active', panel.hasClass(panelName));
+      });
+    }
+  });
+}(jQuery));