This is a jQuery plugin that provides a country and state selector based on the GeoNames database. (GeoNames is sensational. If you haven't already played with it, do so.)
-
jQuery. This works back at least as far as jQuery 1.2.3, although in practice I don't really care about versions pre-1.6. Sorry. Pull requests if I break pre-1.6 compatibility will be looked upon favourably.
-
If you want to update the data from GeoNames, you'll also need PHP 5.2 or later.
Create a couple of elements to be replaced within your HTML. (This ensures some level of compatibility for non-JavaScript clients.) I use inputs, personally. That is, something like this:
<label>Country: <input name="country"></label>
<label>State: <input name="state"></label>
Then load jQuery and the plugin, and call the plugin on the container for those inputs. (Say, a form.)
$(function () { $("form").geoSelector(); });
Once the JSON has been downloaded (it'll default to the same directory as the HTML file), voilà! You will now have cascading select elements. They will send the actual names selected when the form is submitted, not the GeoNames codes. (I find this more useful. Your mileage may vary.)
The geoSelector method supports a handful of options, all of which are
optional. You can provide an options object as the first argument to
geoSelector like so:
$("form").geoSelector({ data: "/js/divisions.json" });
The options available are:
| Option | Default | Description |
|---|---|---|
| countrySelector | *[name='country'] |
The selector used to find the country element to replace. This should match only one element. |
| stateSelector | *[name='state'] |
The selector used to find the state element to replace. This should match only one element. |
| data | divisions.json |
The path to the GeoNames JSON file. This needs to be relative to the HTML page, not the JavaScript file, since it's loaded via AJAX. |
| defaultCountry | Australia |
The default country to select. |
| defaultState | Western Australia |
The default state to select. |
To update the data from GeoNames:
php data/update.php > divisions.json
It's that easy!
The jQuery plugin is released under the MIT Licence, along with the update script and any other files included that aren't sourced from GeoNames.
The data contained within divisions.json is sourced from GeoNames and is released under the Creative Commons Attribution 3.0 License. All copyright remains with GeoNames for this data.
I welcome pull requests, issues, documentation, tests, and pretty much any other help, given the complete lack of free time I have for this sort of thing. You can contact me via e-mail or on Twitter if you really want to.