index.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta http-equiv="x-ua-compatible" content="ie=edge">
  6. <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
  7. <meta name="description" content="A simple jQuery plugin for picking provinces, cities and districts of China.">
  8. <meta name="keywords" content="中国, 省份, 城市, 行政区, 省市区, 三级联动, 地址选择器, HTML, CSS, JS, JavaScript, jQuery plugin, province, city, district, pick, picker, picking, front-end, frontend, web development">
  9. <meta name="author" content="Chen Fengyuan">
  10. <title>Distpicker</title>
  11. <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/4.1.3/css/bootstrap.min.css">
  12. <link rel="stylesheet" href="https://unpkg.com/highlightjs@9.10.0/styles/github.css">
  13. <link href="css/main.css" rel="stylesheet">
  14. </head>
  15. <body>
  16. <!--[if lt IE 9]>
  17. <div class="alert alert-warning alert-dismissible fade show m-0 rounded-0" role="alert">
  18. <button type="button" class="close" data-dismiss="alert" aria-label="Close">
  19. <span aria-hidden="true">&times;</span>
  20. </button>
  21. You are using an <strong>outdated</strong> browser. Please <a href="http://browsehappy.com/">upgrade your browser</a> to improve your experience.
  22. </div>
  23. <![endif]-->
  24. <!-- Header -->
  25. <header class="navbar navbar-light navbar-expand-md">
  26. <div class="container">
  27. <a class="navbar-brand" href="./">Distpicker</a>
  28. <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbar-collapse" aria-controls="navbar-collapse" aria-expanded="false" aria-label="Toggle navigation">
  29. <span class="navbar-toggler-icon"></span>
  30. </button>
  31. <div class="collapse navbar-collapse justify-content-end" id="navbar-collapse" role="navigation">
  32. <nav class="nav navbar-nav">
  33. <a class="nav-link" href="https://github.com/fengyuanchen/distpicker/blob/master/README.md" data-toggle="tooltip" title="View the documentation">Docs</a>
  34. <a class="nav-link" href="https://github.com/fengyuanchen/distpicker" data-toggle="tooltip" title="View the GitHub project">GitHub</a>
  35. <a class="nav-link" href="https://fengyuanchen.github.io" data-toggle="tooltip" title="More projects">More</a>
  36. <a class="nav-link" href="https://chenfengyuan.com" data-toggle="tooltip" title="About the author">About</a>
  37. </nav>
  38. </div>
  39. </nav>
  40. </header>
  41. <!-- Jumbotron -->
  42. <div class="jumbotron bg-primary text-white rounded-0">
  43. <div class="container">
  44. <div class="row">
  45. <div class="col-md col-lg-8">
  46. <h1>Distpicker <small class="h6">v2.0.5</small></h1>
  47. <p class="lead">A simple jQuery plugin for picking provinces, cities and districts of China.</p>
  48. </div>
  49. <div class="col-md col-lg-4">
  50. <div class="carbonads">
  51. <script id="_carbonads_js" src="//cdn.carbonads.com/carbon.js?serve=CKYI55Q7&placement=fengyuanchengithubio" async></script>
  52. </div>
  53. </div>
  54. </div>
  55. </div>
  56. </div>
  57. <!-- Content -->
  58. <div class="container">
  59. <div class="alert alert-warning">请注意以下市/县并未设置下一级的区/乡/镇:济源市、潜江市、神农架林区、天门市、仙桃市、东莞市、中山市、东沙群岛、白沙黎族自治县、保亭黎族苗族自治县、昌江黎族自治县、澄迈县、儋州市、定安县、东方市、乐东黎族自治县、临高县、陵水黎族自治县、琼海市、琼中黎族苗族自治县、屯昌县、万宁市、文昌市、五指山市、嘉峪关市、阿拉尔市、北屯市、可克达拉市、昆玉市、石河子市、双河市、铁门关市、图木舒克市、五家渠市。</div>
  60. <!-- Getting started -->
  61. <h2 id="getting-started">Getting started</h2>
  62. <hr>
  63. <h3>Installation</h3>
  64. <p>Include files:</p>
  65. <pre><code class="language-html">&lt;script src=&quot;/path/to/jquery.js&quot;&gt;&lt;/script&gt;&lt;!-- jQuery is required --&gt;
  66. &lt;script src=&quot;/path/to/distpicker.js&quot;&gt;&lt;/script&gt;</code></pre>
  67. <p>Create HTML elements:</p>
  68. <pre><code class="language-html">&lt;div&gt;&lt;!-- container --&gt;
  69. &lt;select&gt;&lt;/select&gt;&lt;!-- province --&gt;
  70. &lt;select&gt;&lt;/select&gt;&lt;!-- city --&gt;
  71. &lt;select&gt;&lt;/select&gt;&lt;!-- district --&gt;
  72. &lt;/div&gt;</code></pre>
  73. <h3>Initialize by <code>data-toggle=&quot;distpicker&quot;</code> attribute</h3>
  74. <h4>Basic</h4>
  75. <p>HTML:</p>
  76. <pre><code class="language-html">&lt;div data-toggle=&quot;distpicker&quot;&gt;
  77. &lt;select&gt;&lt;/select&gt;
  78. &lt;select&gt;&lt;/select&gt;
  79. &lt;select&gt;&lt;/select&gt;
  80. &lt;/div&gt;</code></pre>
  81. <p>Demo:</p>
  82. <form class="form-inline mt-2 mb-4">
  83. <div data-toggle="distpicker">
  84. <select class="form-control"></select>
  85. <select class="form-control"></select>
  86. <select class="form-control"></select>
  87. </div>
  88. </form>
  89. <h4>Custom placeholders</h4>
  90. <p>HTML:</p>
  91. <pre><code class="language-html">&lt;div data-toggle=&quot;distpicker&quot;&gt;
  92. &lt;select data-province=&quot;---- 选择省 ----&quot;&gt;&lt;/select&gt;
  93. &lt;select data-city=&quot;---- 选择市 ----&quot;&gt;&lt;/select&gt;
  94. &lt;select data-district=&quot;---- 选择区 ----&quot;&gt;&lt;/select&gt;
  95. &lt;/div&gt;
  96. </code></pre>
  97. <p>Demo:</p>
  98. <form class="form-inline mt-2 mb-4">
  99. <div data-toggle="distpicker">
  100. <select class="form-control" data-province="---- 选择省 ----"></select>
  101. <select class="form-control" data-city="---- 选择市 ----"></select>
  102. <select class="form-control" data-district="---- 选择区 ----"></select>
  103. </div>
  104. </form>
  105. <h4>Custom districts</h4>
  106. <p>HTML:</p>
  107. <pre><code class="language-html">&lt;div data-toggle=&quot;distpicker&quot;&gt;
  108. &lt;select data-province=&quot;浙江省&quot;&gt;&lt;/select&gt;
  109. &lt;select data-city=&quot;杭州市&quot;&gt;&lt;/select&gt;
  110. &lt;select data-district=&quot;西湖区&quot;&gt;&lt;/select&gt;
  111. &lt;/div&gt;</code></pre>
  112. <p>Demo:</p>
  113. <form class="form-inline mt-2 mb-4">
  114. <div data-toggle="distpicker">
  115. <select class="form-control" data-province="浙江省"></select>
  116. <select class="form-control" data-city="杭州市"></select>
  117. <select class="form-control" data-district="西湖区"></select>
  118. </div>
  119. </form>
  120. <h3>Initialize by <code>$.fn.distpicker</code> method</h3>
  121. <h4>Basic</h4>
  122. <p>HTML:</p>
  123. <pre><code class="language-html">&lt;div id=&quot;distpicker1&quot;&gt;
  124. &lt;select&gt;&lt;/select&gt;
  125. &lt;select&gt;&lt;/select&gt;
  126. &lt;select&gt;&lt;/select&gt;
  127. &lt;/div&gt;</code></pre>
  128. <p>JavaScript:</p>
  129. <pre><code class="language-js">$(&quot;#distpicker1&quot;).distpicker();</code></pre>
  130. <p>Demo:</p>
  131. <form class="form-inline mt-2 mb-4">
  132. <div id="distpicker1">
  133. <select class="form-control"></select>
  134. <select class="form-control"></select>
  135. <select class="form-control"></select>
  136. </div>
  137. </form>
  138. <h4>Custom placeholders</h4>
  139. <p>HTML:</p>
  140. <pre><code class="language-html">&lt;div id=&quot;distpicker2&quot;&gt;
  141. &lt;select&gt;&lt;/select&gt;
  142. &lt;select&gt;&lt;/select&gt;
  143. &lt;select&gt;&lt;/select&gt;
  144. &lt;/div&gt;</code></pre>
  145. <p>JavaScript:</p>
  146. <pre><code class="language-js">$(&quot;#distpicker2&quot;).distpicker({
  147. province: '---- 所在省 ----',
  148. city: '---- 所在市 ----',
  149. district: '---- 所在区 ----'
  150. });</code></pre>
  151. <p>Demo:</p>
  152. <form class="form-inline mt-2 mb-4">
  153. <div id="distpicker2">
  154. <select class="form-control"></select>
  155. <select class="form-control"></select>
  156. <select class="form-control"></select>
  157. </div>
  158. </form>
  159. <h4>Custom districts</h4>
  160. <p>HTML:</p>
  161. <pre><code class="language-html">&lt;div id=&quot;distpicker3&quot;&gt;
  162. &lt;select&gt;&lt;/select&gt;
  163. &lt;select&gt;&lt;/select&gt;
  164. &lt;select&gt;&lt;/select&gt;
  165. &lt;/div&gt;</code></pre>
  166. <p>JavaScript:</p>
  167. <pre><code class="language-js">$(&quot;#distpicker3&quot;).distpicker({
  168. province: '浙江省',
  169. city: '杭州市',
  170. district: '西湖区'
  171. });</code></pre>
  172. <p>Demo:</p>
  173. <form class="form-inline mt-2 mb-4">
  174. <div id="distpicker3">
  175. <select class="form-control"></select>
  176. <select class="form-control"></select>
  177. <select class="form-control"></select>
  178. </div>
  179. </form>
  180. <!-- Options -->
  181. <h2>Options</h2>
  182. <hr>
  183. <p>Supports to set the options by <code>data-*</code> attributes:</p>
  184. <p>HTML:</p>
  185. <pre><code class="language-html">&lt;div data-toggle=&quot;distpicker&quot; data-autoselect=&quot;3&quot; data-province=&quot;浙江省&quot;&gt;
  186. &lt;select&gt;&lt;/select&gt;
  187. &lt;select&gt;&lt;/select&gt;
  188. &lt;select&gt;&lt;/select&gt;
  189. &lt;/div&gt;</code></pre>
  190. <p>Demo:</p>
  191. <form class="form-inline mt-2 mb-4">
  192. <div data-toggle="distpicker" data-autoselect="3" data-province="浙江省">
  193. <select class="form-control"></select>
  194. <select class="form-control"></select>
  195. <select class="form-control"></select>
  196. </div>
  197. </form>
  198. <!-- Methods -->
  199. <h2>Methods</h2>
  200. <hr>
  201. <p>You can call methods by <code>$().distpicker('method', arg1, arg2, ..., argN)</code>.</p>
  202. <p>HTML:</p>
  203. <pre><code class="language-html">&lt;div id=&quot;distpicker&quot;&gt;
  204. &lt;select&gt;&lt;/select&gt;
  205. &lt;select&gt;&lt;/select&gt;
  206. &lt;select&gt;&lt;/select&gt;
  207. &lt;/div&gt;</code></pre>
  208. <p>JavaScript:</p>
  209. <pre><code class="language-js">$(&quot;#distpicker&quot;).distpicker({
  210. province: '福建省',
  211. city: '厦门市',
  212. district: '思明区'
  213. });</code></pre>
  214. <p>Demo:</p>
  215. <div class="docs-methods mt-2 mb-4">
  216. <form class="form-inline mb-2">
  217. <div id="distpicker">
  218. <select class="form-control"></select>
  219. <select class="form-control"></select>
  220. <select class="form-control"></select>
  221. </div>
  222. </form>
  223. <div>
  224. <button class="btn btn-primary" id="reset" type="button">Reset</button>
  225. <button class="btn btn-warning" id="reset-deep" type="button">Reset (deep)</button>
  226. <button class="btn btn-danger" id="destroy" type="button">Destroy</button>
  227. </div>
  228. </div>
  229. <!-- Examples -->
  230. <h2>Examples</h2>
  231. <hr>
  232. <h3>Only province and city</h3>
  233. <p>HTML:</p>
  234. <pre><code class="language-html">&lt;div data-toggle=&quot;distpicker&quot;&gt;
  235. &lt;select&gt;&lt;/select&gt;
  236. &lt;select&gt;&lt;/select&gt;
  237. &lt;/div&gt;</code></pre>
  238. <p>Demo:</p>
  239. <form class="form-inline mt-2 mb-4">
  240. <div data-toggle="distpicker">
  241. <select class="form-control"></select>
  242. <select class="form-control"></select>
  243. </div>
  244. </form>
  245. <h3>Only province</h3>
  246. <p>HTML:</p>
  247. <pre><code class="language-html">&lt;div data-toggle=&quot;distpicker&quot;&gt;
  248. &lt;select&gt;&lt;/select&gt;
  249. &lt;/div&gt;</code></pre>
  250. <p>Demo:</p>
  251. <form class="form-inline mt-2 mb-4">
  252. <div data-toggle="distpicker">
  253. <select class="form-control"></select>
  254. </div>
  255. </form>
  256. <h3>Select province automatically</h3>
  257. <p>HTML:</p>
  258. <pre><code class="language-html">&lt;div data-toggle=&quot;distpicker&quot; data-autoselect=&quot;1&quot;&gt;
  259. &lt;select&gt;&lt;/select&gt;
  260. &lt;select&gt;&lt;/select&gt;
  261. &lt;select&gt;&lt;/select&gt;
  262. &lt;/div&gt;
  263. </code></pre>
  264. <p>Demo:</p>
  265. <form class="form-inline mt-2 mb-4">
  266. <div data-toggle="distpicker" data-autoselect="1">
  267. <select class="form-control"></select>
  268. <select class="form-control"></select>
  269. <select class="form-control"></select>
  270. </div>
  271. </form>
  272. <h3>Select province and city automatically</h3>
  273. <p>HTML:</p>
  274. <pre><code class="language-html">&lt;div data-toggle=&quot;distpicker&quot; data-autoselect=&quot;2&quot;&gt;
  275. &lt;select&gt;&lt;/select&gt;
  276. &lt;select&gt;&lt;/select&gt;
  277. &lt;select&gt;&lt;/select&gt;
  278. &lt;/div&gt;
  279. </code></pre>
  280. <p>Demo:</p>
  281. <form class="form-inline mt-2 mb-4">
  282. <div data-toggle="distpicker" data-autoselect="2">
  283. <select class="form-control"></select>
  284. <select class="form-control"></select>
  285. <select class="form-control"></select>
  286. </div>
  287. </form>
  288. <h3>Select all districts automatically</h3>
  289. <p>HTML:</p>
  290. <pre><code class="language-html">&lt;div data-toggle=&quot;distpicker&quot; data-autoselect=&quot;3&quot;&gt;
  291. &lt;select&gt;&lt;/select&gt;
  292. &lt;select&gt;&lt;/select&gt;
  293. &lt;select&gt;&lt;/select&gt;
  294. &lt;/div&gt;
  295. </code></pre>
  296. <p>Demo:</p>
  297. <form class="form-inline mt-2 mb-4">
  298. <div data-toggle="distpicker" data-autoselect="3">
  299. <select class="form-control"></select>
  300. <select class="form-control"></select>
  301. <select class="form-control"></select>
  302. </div>
  303. </form>
  304. <h3>Without placeholders</h3>
  305. <p>HTML:</p>
  306. <pre><code class="language-html">&lt;div data-toggle=&quot;distpicker&quot; data-placeholder=&quot;false&quot;&gt;
  307. &lt;select&gt;&lt;/select&gt;
  308. &lt;select&gt;&lt;/select&gt;
  309. &lt;select&gt;&lt;/select&gt;
  310. &lt;/div&gt;
  311. </code></pre>
  312. <p>Demo:</p>
  313. <form class="form-inline mt-2 mb-4">
  314. <div data-toggle="distpicker" data-placeholder="false">
  315. <select class="form-control"></select>
  316. <select class="form-control"></select>
  317. <select class="form-control"></select>
  318. </div>
  319. </form>
  320. <h3>Administrative code as value</h3>
  321. <p>HTML:</p>
  322. <pre><code class="language-html">&lt;div data-toggle=&quot;distpicker&quot; data-value-type=&quot;code&quot;&gt;
  323. &lt;select data-province=&quot;330000&quot;&gt;&lt;/select&gt;
  324. &lt;select data-city=&quot;330100&quot;&gt;&lt;/select&gt;
  325. &lt;select data-district=&quot;330106&quot;&gt;&lt;/select&gt;
  326. &lt;/div&gt;
  327. </code></pre>
  328. <p>Demo:</p>
  329. <form class="form-inline mt-2 mb-4">
  330. <div data-toggle="distpicker" data-value-type="code">
  331. <select class="form-control" data-province="330000"></select>
  332. <select class="form-control" data-city="330100"></select>
  333. <select class="form-control" data-district="330106"></select>
  334. </div>
  335. </form>
  336. </div>
  337. <!-- Footer -->
  338. <footer class="docs-footer">
  339. <div class="container">
  340. <p class="heart"></p>
  341. <nav class="nav flex-wrap justify-content-center mb-3">
  342. <a class="nav-link" href="https://github.com/fengyuanchen/distpicker">GitHub</a>
  343. <a class="nav-link" href="https://github.com/fengyuanchen/distpicker/releases">Releases</a>
  344. <a class="nav-link" href="https://github.com/fengyuanchen/distpicker/issues">Issues</a>
  345. <a class="nav-link" href="https://github.com/fengyuanchen/distpicker/blob/master/LICENSE">License</a>
  346. <a class="nav-link" href="https://chenfengyuan.com">About</a>
  347. </nav>
  348. </div>
  349. </footer>
  350. <!-- Scripts -->
  351. <script src="https://code.jquery.com/jquery-3.3.1.slim.min.js"></script>
  352. <script src="https://maxcdn.bootstrapcdn.com/bootstrap/4.1.3/js/bootstrap.bundle.min.js"></script>
  353. <script src="https://unpkg.com/highlightjs@9.10.0/highlight.pack.js"></script>
  354. <script src="https://fengyuanchen.github.io/js/common.js"></script>
  355. <script src="js/distpicker.js"></script>
  356. <script src="js/main.js"></script>
  357. </body>
  358. </html>