demo
* content_tag(name, content, options={}) * Creates an html tag with given name, content and options * content_tag(:p, "demo", :class => 'light') =>demo
* content_tag(:p, :class => 'dark') { ...content... } =>...content...
* input_tag(type, options = {}) * Creates an html input field with given type and options * input_tag :text, :class => "demo" * input_tag :password, :value => "secret", :class => "demo" ==== Asset Helpers * flash_tag(kind, options={}) * Creates a div to display the flash of given type if it exists * flash_tag(:notice, :class => 'flash', :id => 'flash-notice') * link_to(*args, &block) * Creates a link element with given name, url and options * link_to 'click me', '/dashboard', :class => 'linky' * link_to('/dashboard', :class => 'blocky') { ...content... } * mail_to(email, caption=nil, mail_options={}) * Creates a mailto link tag to the specified email_address * mail_to "me@demo.com" * mail_to "me@demo.com", "My Email", :subject => "Feedback", :cc => 'test@demo.com' * image_tag(url, options={}) * Creates an image element with given url and options * image_tag('icons/avatar.png') * stylesheet_link_tag(*sources) * Returns a stylesheet link tag for the sources specified as arguments * stylesheet_link_tag 'style', 'application', 'layout' * javascript_include_tag(*sources) * Returns an html script tag for each of the sources provided. * javascript_include_tag 'application', 'special' ==== Form Helpers * form_tag(url, options={}, &block) * Constructs a form without object based on options * Supports form methods 'put' and 'delete' through hidden field * form_tag('/register', :class => 'example') { ... } * field_set_tag(*args, &block) * Constructs a field_set to group fields with given options * field_set_tag(:class => 'office-set') { } * field_set_tag("Office", :class => 'office-set') { } * error_messages_for(record, options={}) * Constructs list html for the errors for a given object * error_messages_for @user * label_tag(name, options={}, &block) * Constructs a label tag from the given options * label_tag :username, :class => 'long-label' * label_tag(:username, :class => 'blocked-label') { ... } * hidden_field_tag(name, options={}) * Constructs a hidden field input from the given options * hidden_field_tag :session_key, :value => 'secret' * text_field_tag(name, options={}) * Constructs a text field input from the given options * text_field_tag :username, :class => 'long' * text_area_tag(name, options={}) * Constructs a text area input from the given options * text_area_tag :username, :class => 'long' * password_field_tag(name, options={}) * Constructs a password field input from the given options * password_field_tag :password, :class => 'long' * check_box_tag(name, options={}) * Constructs a checkbox input from the given options * check_box_tag :remember_me, :checked => true * radio_button_tag(name, options={}) * Constructs a radio button input from the given options * radio_button_tag :gender, :value => 'male' * select_tag(name, settings={}) * Constructs a select tag with options from the given settings * select_tag(:favorite_color, :options => ['1', '2', '3'], :selected => '1') * select_tag(:more_color, :options => [['label', '1'], ['label2', '2']]) * select_tag(:multiple_color, :options => [...], :multiple => true) * file_field_tag(name, options={}) * Constructs a file field input from the given options * file_field_tag :photo, :class => 'long' * submit_tag(caption, options={}) * Constructs a submit button from the given options * submit_tag "Create", :class => 'success' * button_tag(caption, options={}) * Constructs an input (type => 'button') from the given options * button_tag "Cancel", :class => 'clear' * image_submit_tag(source, options={}) * Constructs an image submit button from the given options * image_submit_tag "submit.png", :class => 'success' A form_tag might look like: - form_tag '/destroy', :class => 'destroy-form', :method => 'delete' do = flash_tag(:notice) - field_set_tag do %p = label_tag :username, :class => 'first' = text_field_tag :username, :value => params[:username] %p = label_tag :password, :class => 'first' = password_field_tag :password, :value => params[:password] %p = label_tag :strategy = select_tag :strategy, :options => ['delete', 'destroy'], :selected => 'delete' %p = check_box_tag :confirm_delete - field_set_tag(:class => 'buttons') do = submit_tag "Remove" ==== FormBuilders * form_for(object, url, settings={}, &block) * Constructs a form using given or default form_builder * Supports form methods 'put' and 'delete' through hidden field * Defaults to StandardFormBuilder but you can easily create your own! * form_for(@user, '/register', :id => 'register') { |f| ...field-elements... } * form_for(:user, '/register', :id => 'register') { |f| ...field-elements... } * fields_for(object, settings={}, &block) * Constructs fields for a given object for use in an existing form * Defaults to StandardFormBuilder but you can easily create your own! * fields_for @user.assignment do |assignment| ... end * fields_for :assignment do |assigment| ... end The following are fields provided by AbstractFormBuilder that can be used within a form_for or fields_for: * error_messages(options={}) * Displays list html for the errors on form object * f.errors_messages * label(field, options={}) * f.label :name, :class => 'long' * text_field(field, options={}) * f.text_field :username, :class => 'long' * check_box(field, options={}) * Uses hidden field to provide a 'unchecked' value for field * f.check_box :remember_me, :uncheck_value => 'false' * radio_button(field, options={}) * f.radio_button :gender, :value => 'male' * hidden_field(field, options={}) * f.hidden_field :session_id, :class => 'hidden' * text_area(field, options={}) * f.text_area :summary, :class => 'long' * password_field(field, options={}) * f.password_field :secret, :class => 'long' * file_field(field, options={}) * f.file_field :photo, :class => 'long' * select(field, options={}) * f.select(:state, :options => ['California', 'Texas', 'Wyoming']) * f.select(:state, :collection => @states, :fields => [:name, :id]) * f.select(:state, :options => [...], :include_blank => true) * submit(caption, options={}) * f.submit "Update", :class => 'long' * image_submit(source, options={}) * f.image_submit "submit.png", :class => 'long' A form_for using these basic fields might look like: - form_for @user, '/register', :id => 'register' do |f| = f.error_messages %p = f.label :username, :caption => "Nickname" = f.text_field :username %p = f.label :email = f.text_field :email %p = f.label :password = f.password_field :password %p = f.label :is_admin, :caption => "Admin User?" = f.check_box :is_admin %p = f.label :color, :caption => "Favorite Color?" = f.select :color, :options => ['red', 'black'] %p - fields_for @user.location do |location| = location.text_field :street = location.text_field :city %p = f.submit "Create", :class => 'button' There is also a StandardFormBuilder which builds on the abstract fields that can be used within a form_for: * text_field_block(field, options={}, label_options={}) * text_field_block(:nickname, :class => 'big', :caption => "Username") * text_area_block(field, options={}, label_options={}) * text_area_block(:about, :class => 'big') * password_field_block(field, options={}, label_options={}) * password_field_block(:code, :class => 'big') * file_field_block(field, options={}, label_options={}) * file_field_block(:photo, :class => 'big') * check_box_block(field, options={}, label_options={}) * check_box_block(:remember_me, :class => 'big') * select_block(field, options={}, label_options={}) * select_block(:country, :option => ['USA', 'Canada']) * submit_block(caption, options={}) * submit_block(:username, :class => 'big') * image_submit_block(source, options={}) * image_submit_block('submit.png', :class => 'big') A form_for using these standard fields might look like: - form_for @user, '/register', :id => 'register' do |f| = f.error_messages = f.text_field_block :name, :caption => "Full name" = f.text_field_block :email = f.check_box_block :remember_me = f.select_block :fav_color, :options => ['red', 'blue'] = f.password_field_block :password = f.submit_block "Create", :class => 'button' and would generate this html: You can also easily build your own FormBuilder which allows for customized fields: class MyCustomFormBuilder < AbstractFormBuilder # Here we have access to a number of useful variables # # * template (use this to invoke any helpers)(ex. template.hidden_field_tag(...)) # * object (the record for this form) (ex. object.valid?) # * object_name (object's underscored type) (ex. object_name => 'admin_user') # # We also have access to self.field_types => [:text_field, :text_area, ...] # In addition, we have access to all the existing field tag helpers (text_field, hidden_field, file_field, ...) end Once a custom builder is defined, any call to form_for can use the new builder: - form_for @user, '/register', :builder => 'MyCustomFormBuilder', :id => 'register' do |f| ...fields here... The form builder can even be made into the default builder when form_for is invoked: # anywhere in the sinatra application set :default_builder, 'MyCustomFormBuilder' And there you have it, a fairly complete form builder solution for sinatra. I hope to create or merge in an even better 'default' form_builder in the near future. ==== Format Helpers * escape_html (alias h and h!) * (from RackUtils) Escape ampersands, brackets and quotes to their HTML/XML entities. * relative_time_ago(date) * Returns relative time in words referencing the given date * relative_time_ago(2.days.ago) => "2 days" * relative_time_ago(5.minutes.ago) => "5 minutes" * relative_time_ago(2800.days.ago) => "over 7 years" * time_in_words(date) * Returns relative time in the past or future using appropriate date format * time_in_words(2.days.ago) => "2 days ago" * time_in_words(100.days.ago) => "Tuesday, July 21" * time_in_words(1.day.from_now) => "tomorrow" * escape_javascript(html_content) * Escapes html to allow passing information to javascript. Used for passing data inside an ajax .js.erb template * escape_javascript("Go to the <%= link_to 'accounts dashboard', url_for(:accounts) %> to view your accounts
Go to account for <%= link_to 'first account', url_for(:account, :id => 1, :name => 'first') %>
Simply invoking url_for(name, *parameters) will return the full mapped url for use in links or anywhere else
that the url might be required.
The routing system also supports url route configuration namespaces:
# /app/routes/example.rb
map(:admin, :show).to("/admin/:id/show")
namespace :admin do
get :show do
"admin show for #{params[:id]}"
end
end
You could also define the route aliases themselves using a namespace for convenience:
# /app/routes/example.rb
map :admin do |namespace|
namespace.map(:show).to("/admin/:id/show")
namespace.map(:destroy).to("/admin/:id/destroy")
end
namespace :admin do
get :show do
"admin show for #{params[:id]}"
end
get :destroy do
"admin destroy for #{params[:id]}"
end
end
You can then reference the urls using the same url_for method:
<%= link_to 'admin page', url_for(:admin, :show, :id => 25) %>
<%= link_to 'admin page', url_for(:admin, :update, :id => 25) %>
<%= link_to 'admin page', url_for(:admin, :show, :id => 25) %>
You can freely use both named route aliases and traditional Sinatra routes in the same application without conflict.
See the wiki article for additional information: