pageflow-parent-page-box 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ed88f5cb153907c5949ecca188f1701a1e84a619
+  data.tar.gz: c085a7d052b7b6dfb76ec2c6ea94bc6d7238eefc
+SHA512:
+  metadata.gz: dddf179fb48c4af5b8a3b026a7e1757ffd7d73fc6b0dbacdf8f2272a217c2def3d7999b677ef43d314ed761a0094ae0c21f5722f6a9b5627167ec50b19df2988
+  data.tar.gz: 2e434ab3e003e2c0a87a67137b3ea9aa22ecda6a9cdd2c75b90803d695878f785d1fe4e76a8b9a02ca3447276a30b2b773b889f9bab94205095129fd05859d7b

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+*.sqlite3
+.bundle
+.config
+.yardoc
+.idea
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+log
+Gemfile.lock
+
+.localeapp

data/CHANGELOG.md

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

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in chart.gemspec
+gemspec
+
+# Rails 4 compat
+gem 'activeadmin', :git => 'https://github.com/codevise/active_admin.git', :branch => 'rails4'
+gem 'ransack'
+gem 'inherited_resources', '1.4.1'
+gem 'formtastic', '2.3.0.rc2'

data/README.md

@@ -0,0 +1,45 @@
+# Pageflow Parent Page Box
+
+[![Gem Version](https://badge.fury.io/rb/pageflow-parent-page-box.svg)](http://badge.fury.io/rb/pageflow-parent-page-box)
+
+A navigation widget to exit the current storyline and return to the
+parent page.
+
+## Installation
+
+Add this line to your application's `Gemfile`:
+
+    gem 'pageflow-parent-page-box'
+
+Register the plugin inside the configure block in `config/initializers/pageflow.rb`
+
+    Pageflow.configure do |config|
+      config.plugin(Pageflow::ParentPageBox.plugin)
+    end
+
+Include javascripts and stylesheets:
+
+    # app/assets/javascripts/components.js
+    //= require pageflow/parent_page_box/components
+
+    # app/assets/javascripts/pageflow/application.js
+    //= require pageflow/parent_page_box
+
+    # app/assets/stylesheets/pageflow/themes/default.scss
+    @import "pageflow/parent_page_box/themes/default";
+
+Execute `bundle install` Restart the application server.
+
+## 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-parent-page-box/issues).
+
+## Contributing Locales
+
+This project uses locales from the
+[pageflow-public-i18n](http://www.localeapp.com/projects/public?search=tf/pageflow-public-i18n)
+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/parent_page_box/components.js

@@ -0,0 +1,4 @@
+//= require_self
+//= require ./widget
+
+pageflow.parentPageBox = pageflow.parentPageBox || {};

data/app/assets/javascript/pageflow/parent_page_box/widget.jsx

@@ -0,0 +1,70 @@
+const {createContainer, createWidget, resolve, classNames} = pageflow.react;
+const {PageThumbnail} = pageflow.react.components;
+
+function ParentPageBox(props) {
+  return (
+    <div className="parent_page_box">
+      <a className={classNames('parent_page_box-link',
+                               props.parentPage && 'is_visible')}
+         href={`#${props.parentPage ? props.parentPage.permaId : ''}`}
+         tabIndex="2"
+         onClick={handleClick} />
+
+      {renderOverlay(props.parentPage, props.i18n)}
+    </div>
+  )
+}
+
+function renderOverlay(page, i18n) {
+  if (page) {
+    return (
+      <div className="parent_page_box-overlay">
+        {renderBackTo(page.chapter, i18n)}
+        <span className="parent_page_box-page_title">
+          {page.title}
+        </span>
+        <PageThumbnail className="parent_page_box-thumbnail" page={page} />
+      </div>
+    );
+  }
+  else {
+    return null;
+  }
+}
+
+function renderBackTo(chapter, i18n) {
+  if (chapter.title) {
+    return (
+      <div>
+        {i18n.t('pageflow.public.back_to_chapter')}
+        <div className="parent_page_box-chapter_title">
+          {chapter.title}
+        </div>
+        <hr className="parent_page_box-separator" />
+      </div>
+    );
+  }
+  else {
+    return (
+      <div className="parent_page_box-standalong_back_label">
+        {i18n.t('pageflow.public.back_to_chapter')}
+      </div>
+    );
+  }
+}
+
+function handleClick(event) {
+  pageflow.slides.goToParentPage();
+  event.preventDefault();
+}
+
+pageflow.parentPageBox.Widget = createWidget(createContainer(ParentPageBox, {
+  fragments: {
+    i18n: resolve('i18n'),
+    parentPage: resolve('currentParentPage', {
+      fragments: {
+        chapter: resolve('chapter')
+      }
+    })
+  }
+}));

data/app/assets/javascript/pageflow/parent_page_box/widget_type.js

@@ -0,0 +1,2 @@
+pageflow.widgetTypes.register('parent_page_box',
+                              pageflow.react.createWidgetType(pageflow.parentPageBox.Widget));

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

@@ -0,0 +1,9 @@
+//= require react
+//= require pageflow/react
+
+//= require_self
+
+//= require ./parent_page_box/components
+//= require ./parent_page_box/widget_type
+
+pageflow.parentPageBox = pageflow.parentPageBox || {};

data/app/assets/stylesheets/pageflow/parent_page_box/themes/default.scss

@@ -0,0 +1,108 @@
+@import "pageflow/extendables";
+
+.parent_page_box {
+  $basic-text-color: #fff !default;
+
+  $parent-page-box-background-color: $basic-background-color-transparent !default;
+  $parent-page-box-text-color: $basic-text-color !default;
+  $parent-page-box-border: solid 2px #aaa !default;
+  $parent-page-box-indicator-icon-color: fade-out($parent-page-box-text-color, 0.2);
+  $parent-page-box-indicator-icon-hover-color: $parent-page-box-text-color;
+  $parent-page-box-separator-color: fade-out($parent-page-box-text-color, 0.2);
+
+  $background-color: $parent-page-box-background-color;
+  $text-color: $parent-page-box-text-color;
+  $border: $parent-page-box-border;
+
+  $indicator-width: 40px;
+  $indicator-height: 50px;
+  $indicator-margin: 5px;
+
+  @extend %pageflow_widget;
+
+  position: absolute;
+  top: 75%;
+  left: 0;
+  z-index: 100;
+
+  .parent_page_box-link {
+    @include background-icon-center($color: $parent-page-box-indicator-icon-color, $left: 48%, $font-size: 30px);
+    @include fa-angle-left-icon;
+
+    position: absolute;
+    bottom: 0;
+    display: block;
+    height: $indicator-height;
+    width: $indicator-width;
+
+    background-color: $background-color;
+    text-decoration: none;
+
+    @include transition(transform 0.3s ease, visibility 0.3s ease);
+    @include transition-delay(0);
+    @include transform(translate3d(-100%, 0, 0));
+    visibility: hidden;
+
+    &::before {
+      font-weight: bold;
+    }
+
+    &.is_visible {
+      @include transform(translate3d(0, 0, 0));
+      @include transition-delay(1s);
+      visibility: visible;
+    }
+  }
+
+  .parent_page_box-overlay {
+    position: absolute;
+    bottom: 0;
+    left: $indicator-width + $indicator-margin;
+    padding: 15px;
+    display: none;
+    pointer-events: none;
+
+    background-color: $background-color;
+    color: $text-color;
+  }
+
+  &:hover {
+    .parent_page_box-link {
+      @include background-icon-color($parent-page-box-indicator-icon-hover-color);
+    }
+
+    .parent_page_box-overlay {
+      display: block;
+    }
+  }
+
+  .parent_page_box-thumbnail {
+    @extend %pageflow_page_type_thumbnail;
+
+    width: 170px;
+    height: 95px;
+    margin: 12px 0 5px 0;
+  }
+
+  .parent_page_box-separator {
+    border: none;
+    border-bottom: solid 1px $parent-page-box-separator-color;
+  }
+
+  .parent_page_box-standalong_back_label,
+  .parent_page_box-chapter_title {
+    font-weight: bold;
+  }
+}
+
+@include phone {
+  .parent_page_box {
+    display: none;
+  }
+}
+
+@include pad_portrait {
+  .parent_page_box {
+    display: none;
+  }
+}

data/config/locales/de.yml

@@ -0,0 +1,8 @@
+de:
+  pageflow:
+    parent_page_box:
+      widget_type_name: "Box am linken Seitenrand"
+    widgets:
+      roles:
+        parent_page_box:
+          "Übergeordnete Seite Hinweis"

data/config/locales/en.yml

@@ -0,0 +1,8 @@
+en:
+  pageflow:
+    parent_page_box:
+      widget_type_name: "Box at left page margin"
+    widgets:
+      roles:
+        parent_page_box:
+          "Parent Page Box"

data/lib/pageflow/parent_page_box/engine.rb

@@ -0,0 +1,10 @@
+module Pageflow
+  module ParentPageBox
+    class Engine < Rails::Engine
+      isolate_namespace Pageflow::ParentPageBox
+
+      config.autoload_paths << File.join(config.root, 'lib')
+      config.i18n.load_path += Dir[config.root.join('config', 'locales', '**', '*.yml').to_s]
+    end
+  end
+end

data/lib/pageflow/parent_page_box/plugin.rb

@@ -0,0 +1,9 @@
+module Pageflow
+  module ParentPageBox
+    class Plugin < Pageflow::Plugin
+      def configure(config)
+        config.widget_types.register(ParentPageBox.widget_type, default: true)
+      end
+    end
+  end
+end

data/lib/pageflow/parent_page_box/version.rb

@@ -0,0 +1,5 @@
+module Pageflow
+  module ParentPageBox
+    VERSION = '0.1.0'.freeze
+  end
+end

data/lib/pageflow-parent-page-box.rb

@@ -0,0 +1,15 @@
+require 'pageflow/parent_page_box/engine'
+
+module Pageflow
+  module ParentPageBox
+    def self.plugin
+      ParentPageBox::Plugin.new
+    end
+
+    def self.widget_type
+      Pageflow::React.create_widget_type('parent_page_box',
+                                         'parent_page_box',
+                                         'pageflow.parentPageBox.Widget')
+    end
+  end
+end

data/pageflow-parent-page-box.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pageflow/parent_page_box/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'pageflow-parent-page-box'
+  spec.version       = Pageflow::ParentPageBox::VERSION
+  spec.authors       = ['Codevise Solutions Ltd.']
+  spec.email         = ['info@codevise.de']
+  spec.summary       = 'Pageflow navigation widget to leave current storyline.'
+  spec.homepage      = 'https://github.com/codevise/pageflow-parent-page-box'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.test_files    = spec.files.grep(%r{^spec/})
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'pageflow', '~> 0.10'
+  spec.add_runtime_dependency 'pageflow-public-i18n', '~> 1.1'
+  spec.add_runtime_dependency 'pageflow-react'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+
+  # Semantic versioning rake tasks
+  spec.add_development_dependency 'semmy', '~> 0.2'
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: pageflow-parent-page-box
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Codevise Solutions Ltd.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pageflow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: pageflow-public-i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: pageflow-react
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: semmy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+description: 
+email:
+- info@codevise.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- README.md
+- Rakefile
+- app/assets/javascript/pageflow/parent_page_box.js
+- app/assets/javascript/pageflow/parent_page_box/components.js
+- app/assets/javascript/pageflow/parent_page_box/widget.jsx
+- app/assets/javascript/pageflow/parent_page_box/widget_type.js
+- app/assets/stylesheets/pageflow/parent_page_box/themes/default.scss
+- config/locales/de.yml
+- config/locales/en.yml
+- lib/pageflow-parent-page-box.rb
+- lib/pageflow/parent_page_box/engine.rb
+- lib/pageflow/parent_page_box/plugin.rb
+- lib/pageflow/parent_page_box/version.rb
+- pageflow-parent-page-box.gemspec
+homepage: https://github.com/codevise/pageflow-parent-page-box
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.5
+signing_key: 
+specification_version: 4
+summary: Pageflow navigation widget to leave current storyline.
+test_files: []