Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cllns/subdivision_select
:earth_africa: A Rails plugin to populate a state/province select box from country_select
https://github.com/cllns/subdivision_select
Last synced: 23 days ago
JSON representation
:earth_africa: A Rails plugin to populate a state/province select box from country_select
- Host: GitHub
- URL: https://github.com/cllns/subdivision_select
- Owner: cllns
- License: mit
- Created: 2015-04-30T15:24:32.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2024-01-22T10:53:08.000Z (about 1 year ago)
- Last Synced: 2025-01-23T02:33:54.189Z (23 days ago)
- Language: Ruby
- Homepage:
- Size: 268 KB
- Stars: 19
- Watchers: 2
- Forks: 18
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: MIT-LICENSE
Awesome Lists containing this project
- awesome-rails-gem - Subdivision Select - A Rails plugin to populate a state/province select box from country_select. (View Helper / Omniauth)
README
Subdivision Select
===
**subdivision_select** is a Rails plugin that extends the functionality of the [**country_select**](https://github.com/stefanpenner/country_select) gem.
When you select a country,
a select box for the states or provinces (i.e. subdivisions) is automatically populated for that country.
It loads them via AJAX,
but this plugin doesn't require you to write any javascript.
Terminology
---
This plugin is called **subdivision_select** but it could have been called
*state_selct* or *province_select*
The terminology comes from [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2).
The data is provided by the `countries` gem.
Example
---
```
<% form_for(@address) do |f| %>
<%= f.label :country %>
<%= f.country_select :country %>
<%= f.label :subdivision, "State / Province" %>
<%= f.subdivision_select :subdivision, @address.country %>
<%= f.submit %>
<% end %>
```
You can also use `subdivision_select_tag`,
if using
[FormTagHelpers](http://api.rubyonrails.org/classes/ActionView/Helpers/FormTagHelper.html).
This plugin makes no assumptions about what you call the subdivision select,
so if you already named your column 'state' or 'province',
you can use that instead.
Currently,
this plugin assumes your country column is named `country`,
and doesn't provide anyway to override that.
Installation
---
1) Add the following to your `Gemfile`:
```
gem "subdivision_select"
```
2) Add the following to your `config/routes.rb`:
```
mount SubdivisionSelect::Engine, at: 'subdivisions'
```
(the 'subdivisions' part is necessary, since that path is hardcoded in JS)
3) Add the following to `application.js` (or whatever your JS digest file is called)
```
//= require subdivision_select
```
Development and Testing
---
If you want to work on this gem, fork and clone the repo.
We use RSpec and Capybara.
There is a 'dummy app' in `spec/dummy` you can use for testing.
If you add a feature,
please add a feature spec for it,
using Capybara.
License
---
MIT
Contributing
---
Please open a new Github Issue for any problems you have with the gem.
Bugs reports and feature requests are always welcome,
but I'm also willing to do tech support
or take suggestions on ways you think the code quality can be improved.