https://github.com/jiren/js_vars

javascript variables rendering helper in one place in html
https://github.com/jiren/js_vars

Last synced: 4 days ago
JSON representation

javascript variables rendering helper in one place in html

• Host: GitHub
• URL: https://github.com/jiren/js_vars
• Owner: jiren
• License: mit
• Created: 2014-04-17T07:23:12.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2014-07-04T05:56:09.000Z (almost 11 years ago)
• Last Synced: 2025-04-28T15:47:21.683Z (21 days ago)
• Language: Ruby
• Homepage:
• Size: 184 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# JsVars

It is view helper to render javascript variables in one place with namespaces. 

How to add js variables.  `@user.to_jsvar(:user)` this will add `@user` json value to variable map and it is render by `js_vars_tag` in view 

i.e

    

    APP = { user: {name: 'jiren', id: 1}, address: {city: 'pune'} }

### Why?

Many times we are using `javascript_tag` or `:javascript` to render javascript variables or json data in view.

i.e

  	:javascript

      var users = #{@users.to_json}  

    

  OR 

    

  	javascript_tag do

    	var users = #{@users.to_json} 

  	end  

  

So here there are no namespace for javascript variables i.e `var APP = {users: [....]}` and they are global. May be there are chances to conflict with other variables with same name. Also in debugging we find difficulties to find variable because variables are not define in namespace. If there are namespace so we can view all variables in namespace from debugging console.

To solve this problems I have written gem `jsvars`.

## Usage

- Add any object to js var map

  		@users.to_jsvar(:users)

     	@address.to_jsvar(:address)

- For rendering all added variables in html. Add following tag to end of the layout.

     

     	= js_vars_tag 

     

     OR

     

     	<%= js_vars_tag %>

    

     Output in html 

     	//<![CDATA[ 

     	    if(!window.APP){ window.APP = {}};

     		APP.users = [1,2,3]; 

     		window.address = 'pune'

     	//]]>

     

 

  Here `APP` is a namespace which holds `users` and `address` variables. 

  NOTE: If you are rendering using ajax then you have to add `js_vars_tag` in your partial.

  i.e in partail `events.js.erb`

      

      $("#events").text("Events ajax");

      <%= js_vars_tag %>

- `to_jsvar` options

     

        @users.to_jsvar(:users, namespace: 'User', json: { only: [:id]})  

  - hnamespace: To change particular variable namespace

  - json: To change rendering object fields.

### Configuration - It is optional

  To change default namespace add following code to your config initializers

  

  i.e in `config/initializers/js_vars.rb`

 	

    JsVars.configure do |c|

      c.namespace = 'MyNamespace'

    end

  So now by default all variables renders in  `MyNamespace` namespace

  

## Installation

Add this line to your application's Gemfile:

    gem 'js_vars'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install js_vars

### Contributing

1. Fork it

2. Create your feature branch (`git checkout -b my-new-feature`)

3. Commit your changes (`git commit -am 'Add some feature'`)

4. Push to the branch (`git push origin my-new-feature`)

5. Create new Pull Request