ChinaRegions

Chinese provinces, cities, regions [prefecture-level cities] Ruby on Rails code, Ruby (> 1.9.x) And Rails (> 4.0)

How to update data

If you are using ChinaRegions version 0.1.x be sure to run:

>> rails g china_regions:regions

to have the javascript file copied over into your project.

Installation

Add it to your Gemfile:

gem 'china_regions'

Run the following command to install it:

>> bundle install

Run the generator:

>> rails g china_regions:install

Then you can see the changes that happened to the console: * copy db/migrate/xxxxxxxxxxx_create_china_regions_tables.rb to your project db/migrate * copy datasource cities.yml 到 config 目录. config/cities.yml * copy regions.en.yml 和 regions.zh.yml 文件到 config/locales 目录

Create tables (provinces, cities, districts):

>> rake db:migrate

Import data:

>> rake china_regions:import

Copy Models [, , ] into your app:

你可以执行 `rails g` 查看到 generator LIST.

 >> rails g china_regions:regions

Newly added models:

create  app/models/province.rb
create  app/models/city.rb
create  app/models/district.rb

Usage

Example:

= form_for @article do |f|

  = f.region_select [:province, :city, :district]

  # form_tag
  = region_select :article, :province_id
  = region_select :article, :city_id
  = region_select :article, :district_id

  OR

  = region_select :article, :province
  = region_select :article, :city
  = region_select :article, :district

  = f.submit class: 'btn'

Add prefix name:

= form_for @article do |f|

  = f.region_select [:province, :city, :district], :prefix => "home"
  = f.region_select [:province, :city, :district], :prefix => "work"

Pre-selected province:

= form_for @article do |f|

  = f.region_select [:province, :city, :district], province: "chongqing"

  OR

  = f.region_select [:province, :city, :district], province: "重庆市"

Prior choice:

= form_for @article do |f|

  = f.region_select [:province, :city, :district], priority: { province: ["重庆市"], district: %w(巴南区 北碚区 渝北区) }

Other languages

Chinese Readme

Contributing

We have a list of valued contributors. Check them all at: