tippy_rails 1.2.1 → 1.2.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +59 -0
- data/Rakefile +17 -0
- data/lib/tippy_rails.rb +16 -0
- data/lib/tippy_rails/engine.rb +6 -0
- data/lib/tippy_rails/errors/unsupported_platform_error.rb +5 -0
- data/lib/tippy_rails/railtie.rb +6 -0
- data/lib/tippy_rails/sprockets.rb +5 -0
- data/lib/tippy_rails/version.rb +3 -0
- metadata +25 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 1c10bec75b5d862d20e3f56e2b95920e5d5589ec
|
4
|
+
data.tar.gz: 7111da01ca4191667229609e840ac814d1cc02ca
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 242f78048a7377ca2c96f4d05259b683f3b84d8c62947abd924712b551a0496ef0cd39c9f5dd808f958d9c8157d74c975d6f657a720b04adc32e252bce7e5846
|
7
|
+
data.tar.gz: 404b069269ccfb22c691739fb4925db51720bfa136213025c9fa79d491ddad48c4bc23578eeb85a4da3bc9122b6bf34b194b669fa59dd74baff5f832d8af72eb
|
data/README.md
ADDED
@@ -0,0 +1,59 @@
|
|
1
|
+
# TippyRails
|
2
|
+
|
3
|
+
This is the Ruby extension for the [Tippy JS](https://github.com/atomiks/tippyjs) tooltipping library, allowing you to easily use it in any Rails or Sprockets backed project.
|
4
|
+
|
5
|
+
## Installation
|
6
|
+
|
7
|
+
Add this line to your application's Gemfile:
|
8
|
+
|
9
|
+
```ruby
|
10
|
+
gem 'tippy_rails', '~> 1.2'
|
11
|
+
```
|
12
|
+
|
13
|
+
And then execute:
|
14
|
+
|
15
|
+
$ bundle install
|
16
|
+
|
17
|
+
Or install it yourself as:
|
18
|
+
|
19
|
+
$ gem install tippy_rails
|
20
|
+
|
21
|
+
## Usage
|
22
|
+
|
23
|
+
To begin, you'll need to include the gem in your `application.js` file, after JQuery, like so:
|
24
|
+
|
25
|
+
```js
|
26
|
+
\\= require jquery
|
27
|
+
\\= require tippy
|
28
|
+
\\= require tree .
|
29
|
+
```
|
30
|
+
|
31
|
+
Additionally you can include CSS files by adding the following to `application.css` or `application.scss` (respectively):
|
32
|
+
|
33
|
+
```scss
|
34
|
+
*= require tippy
|
35
|
+
|
36
|
+
OR
|
37
|
+
|
38
|
+
@import 'tippy';
|
39
|
+
```
|
40
|
+
|
41
|
+
Now you're all set up and ready to go, additional usage instructions can be found on the [Tippy.js Website](https://atomiks.github.io/tippyjs/).
|
42
|
+
|
43
|
+
## Development
|
44
|
+
|
45
|
+
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
|
46
|
+
|
47
|
+
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
|
48
|
+
|
49
|
+
## Contributing
|
50
|
+
|
51
|
+
Bug reports and pull requests are welcome on GitHub at https://github.com/ElliottAYoung/tippy_rails. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
|
52
|
+
|
53
|
+
## License
|
54
|
+
|
55
|
+
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
|
56
|
+
|
57
|
+
## Code of Conduct
|
58
|
+
|
59
|
+
Everyone interacting in the TippyRails project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ElliottAYoung/tippy_rails/blob/master/CODE_OF_CONDUCT.md).
|
data/Rakefile
ADDED
@@ -0,0 +1,17 @@
|
|
1
|
+
begin
|
2
|
+
require 'bundler/setup'
|
3
|
+
rescue LoadError
|
4
|
+
puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
|
5
|
+
end
|
6
|
+
|
7
|
+
require 'rdoc/task'
|
8
|
+
|
9
|
+
RDoc::Task.new(:rdoc) do |rdoc|
|
10
|
+
rdoc.rdoc_dir = 'rdoc'
|
11
|
+
rdoc.title = 'TippyRails'
|
12
|
+
rdoc.options << '--line-numbers'
|
13
|
+
rdoc.rdoc_files.include('README.md')
|
14
|
+
rdoc.rdoc_files.include('lib/**/*.rb')
|
15
|
+
end
|
16
|
+
|
17
|
+
require 'bundler/gem_tasks'
|
data/lib/tippy_rails.rb
ADDED
@@ -0,0 +1,16 @@
|
|
1
|
+
require "tippy_rails/version"
|
2
|
+
|
3
|
+
module TippyRails
|
4
|
+
if defined? ::Rails
|
5
|
+
if ::Rails.version.to_s < '3.1'
|
6
|
+
require 'tippy_rails/railtie'
|
7
|
+
else
|
8
|
+
require 'tippy_rails/engine'
|
9
|
+
end
|
10
|
+
elsif defined? ::Sprockets
|
11
|
+
require 'tippy_rails/sprockets'
|
12
|
+
else
|
13
|
+
require 'tippy_rails/errors/unsupported_platform_error'
|
14
|
+
raise UnsupportedPlatformError
|
15
|
+
end
|
16
|
+
end
|
metadata
CHANGED
@@ -1,12 +1,12 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: tippy_rails
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.2.1
|
4
|
+
version: 1.2.1.1
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- ElliottAYoung
|
8
8
|
autorequire:
|
9
|
-
bindir:
|
9
|
+
bindir: bin
|
10
10
|
cert_chain: []
|
11
11
|
date: 2017-08-22 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
@@ -38,13 +38,35 @@ dependencies:
|
|
38
38
|
- - "~>"
|
39
39
|
- !ruby/object:Gem::Version
|
40
40
|
version: '10.0'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: rdoc
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - ">="
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '0'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - ">="
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '0'
|
41
55
|
description: A Ruby extension of the Tippy JS library
|
42
56
|
email:
|
43
57
|
- elliott.a.young@gmail.com
|
44
58
|
executables: []
|
45
59
|
extensions: []
|
46
60
|
extra_rdoc_files: []
|
47
|
-
files:
|
61
|
+
files:
|
62
|
+
- README.md
|
63
|
+
- Rakefile
|
64
|
+
- lib/tippy_rails.rb
|
65
|
+
- lib/tippy_rails/engine.rb
|
66
|
+
- lib/tippy_rails/errors/unsupported_platform_error.rb
|
67
|
+
- lib/tippy_rails/railtie.rb
|
68
|
+
- lib/tippy_rails/sprockets.rb
|
69
|
+
- lib/tippy_rails/version.rb
|
48
70
|
homepage: https://github.com/ElliottAYoung/tippy_rails.git
|
49
71
|
licenses:
|
50
72
|
- MIT
|