angular-float-box 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 833d9d882ae73f5c135dd014b83b1d46693c9ec4
-  data.tar.gz: f22b98252a94467700b71617302f7e63f3add46b
+  metadata.gz: d067131d3c8eb400ebdbe96b27936187d55a18ba
+  data.tar.gz: 9eba1b20c6bf11ab0cd10b5a89577cd934bc54ad
 SHA512:
-  metadata.gz: ab4eec874b0b6d59b517df0280d8709dee885ff336fd9ebf05d2eda59999e653b9191fc3fe51d08c07d909142c7cbe7754dabb5d8ff29be9e92d7914a762cae1
-  data.tar.gz: 74ae8492219458e2d75cdfe67710d0a89d58db82a5678f1e058ff0190e2634af39111fc72b23d6913326d0be35660bac0ae51bc206fd7148c03f1e1b0cf2469f
+  metadata.gz: 67b22adf36dfdc7dcc2a34379390c8067a92fb66385ddbc5872aa84f174a926df8d0563cbefa0f1b5e5cd87acb7a0c7b0ca30d9aefd56720fdca0dae7bef5b4d
+  data.tar.gz: 45b573e96fad81fab15ad202e572124ff3c4fb007bbf5e942204cd048b4f0691812b9842c8716f5878152f137d07aaab95fce63d510b849305dd53b07d902217

data/README.md

@@ -1,4 +1,4 @@
-# Angular::Float::Box
+# Angular Float Box
 
 Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/angular-float-box`. To experiment with that code, run `bin/console` for an interactive prompt.
 
@@ -14,15 +14,77 @@ gem 'angular-float-box'
 
 And then execute:
 
-    $ bundle
+```bash
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install angular-float-box
+```bash
+$ gem install angular-float-box
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+### Require Assets
+Require float-box to your application.css:
+```scss
+*= require angular-float-box.min
+```
+Require float-box to your application.js:
+```js
+//= require angular-float-box.min
+```
+Add the float-box module as a dependency to your application module:
+```js
+var app = angular.module('MyApp', ['angular-float-box'])
+```
+Add the float-box service as a dependency to the controller(s) you would like to use it in.
+```js
+app.controller("UsersCtrl", ['$scope' 'floatBox',
+function($scope, floatBox) {
+  ...
+}])
+```
+
+### Functions
+To start using the float-box functionality you will need to initialize it in your controller and pass in the $scope.
+```js
+floatBox.initialize($scope);
+```
+Float-box is built mobile friendly, which means appearing when you need it and disappearing when you don't.  For this purpose, float-box has a handful of functions for showing and hidding.
+```js
+// Display float-box
+floatBox.show();
+// Hide float-box
+floatBox.hide();
+// Show float-box via slide
+floatBox.slide_in(direction); // right, left, top, down
+// Hide float-box via slide
+floatBox.slide_out(direction); // right, left, top, down
+```
+Navigating between create, read and update tabs.
+```js
+// Show float-box-create-tab if not already shown.
+floatBox.create();
+// Show float-box-read-tab if not already shown.
+floatBox.read();
+// Show float-box-update-tab if not already shown.
+floatBox.update();
+```
+Formatting float-box
+```js
+// Adjust size of float-box-title if it is to large for float-box.
+floatBox.normalize_title();
+```
+
+## Float-Box HTML
+
+[Float Box Basic HTML](https://github.com/amcritchie/angular-float-box/wiki/Float-Box-HTML)
+* [Float Box Create Tab HTML](https://github.com/amcritchie/angular-float-box/wiki/Float-Box-HTML-Create-Tab)
+* [Float Box Read Tab HTML](https://github.com/amcritchie/angular-float-box/wiki/Float-Box-HTML-Read-Tab)
+* [Float Box Update Tab HTML](https://github.com/amcritchie/angular-float-box/wiki/Float-Box-HTML-Update-Tab)
+
 
 ## Development
 

data/angular-float-box.gemspec

@@ -14,11 +14,7 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/amcritchie/angular-float-box"
   spec.license       = "MIT"
 
-  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
-  # to allow pushing to a single host or delete this section to allow pushing to any host.
   if spec.respond_to?(:metadata)
-    # spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
-    # spec.metadata['allowed_push_host'] = "http://mygemserver.com"
     spec.metadata['allowed_push_host'] = "https://rubygems.org"
   else
     raise "RubyGems 2.0 or newer is required to protect against public gem pushes."

data/lib/angular-float-box/version.rb

@@ -1,3 +1,3 @@
 module AngularFloatBox
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/vendor/assets/javascripts/angular-float-box.js

@@ -93,15 +93,22 @@
       })
     }
 
-    // Show float-box via slide in from the right.
-    this.slide_in = function() {
-      $( "#float-box" ).show( "drop", {direction: 'right'})
+    // Show float-box
+    this.show = function() {
+      $( "#float-box" ).show()
     }
-
-    // Hide float-box via slide in from the right.
-    this.slide_out = function() {
+    // Hide float-box
+    this.hide = function() {
+      $( "#float-box" ).hide()
+    }
+    // Show float-box via slide in from the direction specified.
+    this.slide_in = function(direction) {
+      $( "#float-box" ).show( "drop", {direction: direction})
+    }
+    // Hide float-box via slide in from the direction specified.
+    this.slide_out = function(direction) {
       if ($(window).width() < 768) {
-        $( "#float-box" ).hide( "drop", {direction: 'right'})
+        $( "#float-box" ).hide( "drop", {direction: direction})
       };
     }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: angular-float-box
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Alexander Mcritchie