flagstrap.js是一款基于bootstrap3的jquery国家选择插件。flagstrap.js插件能在bootstrap3原生selec下拉选择框的基础上,制作出带国旗效果的国家选择下拉框。
使用方法
在页面中引入jquery和bootstrap相关文件,以及flags.css和jquery.flags.js文件。
HTML结构
使用该jquery国家选择插件的基本HTML结构如下:
选择一个国家
可以通过data-*属性来添加配置参数。
选择一个国家
data-input-name="country2"
data-selected-country="DE"
data-button-size="btn-md"
data-button-type="btn-default"
data-scrollable-height="250px"
data-scrollable="true">
上面的代码生成一个带所有可选国家,默认选择德国,高度为250像素的select下拉下拉选择框。
初始化插件
在页面DOM元素加载完毕之后,可以通过flagStrap()方法来初始化该jquery国家选择插件。
$(document).ready(function() {
$('#flagstrap').flagStrap();
});
或者在初始化是传入配置参数:
选择一个国家
$('#flagstrap2').flagStrap({
countries: {
"AU": "Australia",
"GB": "United Kingdom",
"US": "United States"
},
inputName: 'country',
buttonSize: "btn-lg",
buttonType: "btn-primary",
labelMargin: "20px",
scrollable: false,
scrollableHeight: "350px",
onSelect: function(value, element) {
//
},
placeholder: {
value: "",
text: "Please select a country"
}
});
配置参数
该jquery国家选择插件的可用配置参数有:
参数
类型
默认值
描述
inputName
string
uniquely generated
select下拉框的name属性。
inputId
string
uniquely generated
select下拉框的id属性。
buttonSize
string
"btn-md"
下拉框的bootstrap按钮尺寸class。
buttonType
string
"btn-default"
下拉框的bootstrap按钮情景类class。
labelMargin
string
"20px"
国家图标和文本之间的间距。
scrollable
boolean
false
下拉框是否可以滚动。
scrollableHeight
string
"250px"
下拉框的max-height。
countries(可选)
object
(all)
只显示指定的国家。例如:
{"GB": "United Kingdom", "US": "United States"}
onSelect(可选)
function
null
select下拉框改变时的回调函数。接收两个参数,一个是新的值,一个是select元素。
placeholder
bool|object
{value: "", text: "Please select a country"}
设置占位文本。如果要禁用占位文本,设置为false。