README.md in repres-bootstrap-1.0.3 vs README.md in repres-bootstrap-1.1
- old
+ new
@@ -1,11 +1,11 @@
# Repres Bootstrap Bootstrap资源表现引擎
[](http://opensource.org/licenses/MIT)
[](https://badge.fury.io/rb/repres-bootstrap)
-Repres (REsource REPResentation) is a series of resource presentation engines. The Bootstrap resource presentation engine includes Bootstrap-based resource presentation templates & snippets.
+Repres (REsource PRESentation) is a series of resource presentation engines. The Bootstrap resource presentation engine includes Bootstrap-based resource presentation templates & snippets.
Repres (资源表现)是一系列的资源表现引擎。Bootstrap 资源表现引擎包括基于Bootstrap的资源表现模版和片段。
## Recent Update
@@ -19,26 +19,46 @@
gem 'repres-bootstrap'
```
+## Include the Helper in your Application Controller before Render the Style or Script with the helper methods
+```ruby
+include Repres::Bootstrap::ApplicationHelper
+```
+
+
+
## Render the Pre-defined Partials
```erb
<html>
<head>
<%= render partial: 'repres/bootstrap/style', locals: { options: { bootstrap: true } } %>
+ <!-- or the following line works identically -->
+ <%= bootstrap_style bootstrap: true %>
</head>
<body>
<div class='container'>
<%= form_for @person do |f| %>
+
<%= render partial: 'repres/bootstrap/form_field', locals: { options: { model: model, form: f, name: :phone_number, type: :telephone_field } } %>
+ <!-- or the following line works identically -->
+ <%= bootstrap_form_field model: model, form: f, name: :phone_number, type: :telephone_field %>
+
<%= render partial: 'repres/bootstrap/form_select_box', locals: { options: { model: model, form: f, name: :gender, choices: { 'Male' => '1', 'Female' => '2' }, options: { include_blank: 'Please Select...' } } } %>
+ <!-- or the following line works identically -->
+ <%= bootstrap_form_select_box model: model, form: f, name: :gender, choices: { 'Male' => '1', 'Female' => '2' }, options: { include_blank: 'Please Select...' } %>
+
<% end %>
</div>
+
<%= render partial: 'repres/bootstrap/script', locals: { options: { bootstrap: true } } %>
+ <!-- or the following line works identically -->
+ <%= bootstrap_script bootstrap: true %>
+
</body>
</html>
```
@@ -48,21 +68,27 @@
The Script partial includes the HTML script tags for Bootstrap and its extensions. Only the [Boot CDN](http://cdn.bootcss.com/) servers are supported.
The following code snippet does __not__ load any JavaScript library.
```erb
<%= render partial: 'repres/bootstrap/script' %>
+<!-- or the following line works identically -->
+<%= bootstrap_script %>
```
The following code snippet loads the latest Bootstrap JavaScript library.
```erb
<%= render partial: 'repres/bootstrap/script', locals: { options: { bootstrap: true } } %>
+<!-- or the following line works identically -->
+<%= bootstrap_script bootstrap: true %>
```
The following code snippet loads the Bootstrap JavaScript library with the given version.
```erb
<%= render partial: 'repres/bootstrap/script', locals: { options: { bootstrap: { version: '3.3.5' } } }
%>
+<!-- or the following line works identically -->
+<%= bootstrap_script bootstrap: { version: '3.3.5' } %>
```
The following JavaScript libraries are switchable, and the version can be configurable:
- :bootstrap
- :'bootstrap-datepicker'
@@ -76,20 +102,26 @@
The Style partial includes the HTML style tags for Bootstrap and its extensions. Only the [Boot CDN](http://cdn.bootcss.com/) servers are supported.
The following code snippet does __not__ load any CSS library.
```erb
<%= render partial: 'repres/bootstrap/style' %>
+<!-- or the following line works identically -->
+<%= bootstrap_style %>
```
The following code snippet loads the latest Bootstrap CSS library.
```erb
<%= render partial: 'repres/bootstrap/style', locals: { options: { bootstrap: true } } %>
+<!-- or the following line works identically -->
+<%= bootstrap_style bootstrap: true %>
```
The following code snippet loads the Bootstrap CSS library with the given version.
```erb
<%= render partial: 'repres/bootstrap/style', locals: { options: { bootstrap: { version: '3.3.5' } } } %>
+<!-- or the following line works identically -->
+<%= bootstrap_style bootstrap: { version: '3.3.5' } %>
```
The following CSS libraries are switchable, and the version can be configurable:
- :bootstrap
- :'bootstrap-theme'
@@ -111,10 +143,13 @@
name: :phone_number,
type: :telephone_field
}
}
%>
+<!-- or the following line works identically -->
+<%= bootstrap_form_field model: model, form: f, name: :phone_number, type: :telephone_field %>
+
<%= render partial: 'repres/bootstrap/form_field',
locals: {
options: {
model: model,
form: f,
@@ -122,27 +157,31 @@
type: :file_field,
input_accept: 'image/*'
}
}
%>
+<!-- or the following line works identically -->
+<%= bootstrap_form_field model: model, form: f, name: :photo, type: :file_field, input_accept: 'image/*' %>
```
### Render the Form Select Box
The Form Select Box partial includes the HTML select tags for Rails Form Builder and Bootstrap.
```ruby
-<%= render partial: 'repres/bootstrap/form_field',
+<%= render partial: 'repres/bootstrap/form_select_box',
locals: {
options: {
model: model,
form: f,
name: :country_id,
choices: @countries.select('id, name').map { |country| [ country.name, country.id ] },
options: { prompt: '请选择国家' }
}
}
%>
+<!-- or the following line works identically -->
+<%= bootstrap_form_select_box model: model, form: f, name: :country_id, choices: @countries.select('id, name').map { |country| [ country.name, country.id ] }, options: { prompt: '请选择国家' } %>
```
The 4 options are required: model, form, name, and type.