-
Notifications
You must be signed in to change notification settings - Fork 4
/
README
70 lines (50 loc) · 1.81 KB
/
README
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
Jsvars
======
This rails plugin will hide the messiness of passing variables from rails into javascript. It will automatically add the js needed to create a variable you define in rails, or add variables to objects.
Install
======
Requires Json (require 'json')
./script/plugin install git://github.com/ejschmitt/jsvars.git
Example
=======
in your controller:
jsvars[:loginPath] = login_path
- Will create a global variable in the JS window object named 'loginPath' with the value you assigned.
jsvars[:myObject] = {:title => "My Page", :email => "me@example.com"}
- Adds the object variables that can be used as myObject.title & myObject.email in the view javascipt.
- This will add the object "myObject" if it does not exist, if it already does, only the variables will be added to the already existing object.
Example of extending an object:
In controller:
jsvars[:login] = {:path => '/login'}
in view:
<script>
var login = {
loginFuntion: function () {
// ....
},
specialVar: "My special Var"
};
</script>
in JS:
login.loginFunction = function()
login.specialVar = 'My special Var'
login.path = '/login'
Getting the rails environment in javascript for all pages
In ApplicationController:
before_filter :set_js_env
def set_js_env
jsvars[:railsEnv] = RAILS_ENV
end
In JS
railsEnv = "development"
What this solves
=======
This solves the mess of stuff like this:
<script>
var loginPath = '<%= login_path %>';
</script>
(requiring the js to be left in an .html.erb file, or a .js.erb file)
to simple adding:
jsvars[:loginPath] = login_path
to the controller and allowing all js to be kept in .js files out of the html.
This can get especially messy with objects with a few rails defines attributes.