input.html 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516
  1. ---
  2. title: Input
  3. subtitle: "The <strong>text input</strong> and its variations"
  4. layout: documentation
  5. doc-tab: form
  6. doc-subtab: input
  7. breadcrumb:
  8. - home
  9. - documentation
  10. - form
  11. - form-input
  12. variables_keys:
  13. - input-color
  14. - input-background-color
  15. - input-border-color
  16. - input-shadow
  17. - input-hover-color
  18. - input-hover-border-color
  19. - input-focus-color
  20. - input-focus-border-color
  21. - input-focus-box-shadow-size
  22. - input-focus-box-shadow-color
  23. - input-disabled-color
  24. - input-disabled-background-color
  25. - input-disabled-border-color
  26. - input-arrow
  27. - input-icon-color
  28. - input-icon-active-color
  29. - input-radius
  30. meta:
  31. colors: true
  32. sizes: true
  33. variables: true
  34. ---
  35. {% capture input_example %}
  36. <input class="input" type="text" placeholder="Text input">
  37. {% endcapture %}
  38. {% capture colors_example %}
  39. <div class="field">
  40. <div class="control">
  41. <input class="input is-primary" type="text" placeholder="Primary input">
  42. </div>
  43. </div>
  44. <div class="field">
  45. <div class="control">
  46. <input class="input is-info" type="text" placeholder="Info input">
  47. </div>
  48. </div>
  49. <div class="field">
  50. <div class="control">
  51. <input class="input is-success" type="text" placeholder="Success input">
  52. </div>
  53. </div>
  54. <div class="field">
  55. <div class="control">
  56. <input class="input is-warning" type="text" placeholder="Warning input">
  57. </div>
  58. </div>
  59. <div class="field">
  60. <div class="control">
  61. <input class="input is-danger" type="text" placeholder="Danger input">
  62. </div>
  63. </div>
  64. {% endcapture %}
  65. {% capture sizes_example %}
  66. <div class="field">
  67. <div class="control">
  68. <input class="input is-small" type="text" placeholder="Small input">
  69. </div>
  70. </div>
  71. <div class="field">
  72. <div class="control">
  73. <input class="input" type="text" placeholder="Normal input">
  74. </div>
  75. </div>
  76. <div class="field">
  77. <div class="control">
  78. <input class="input is-medium" type="text" placeholder="Medium input">
  79. </div>
  80. </div>
  81. <div class="field">
  82. <div class="control">
  83. <input class="input is-large" type="text" placeholder="Large input">
  84. </div>
  85. </div>
  86. {% endcapture %}
  87. {% capture rounded_example %}
  88. <input class="input is-rounded" type="text" placeholder="Rounded input">
  89. {% endcapture %}
  90. {% capture normal_example %}
  91. <div class="control">
  92. <input class="input" type="text" placeholder="Normal input">
  93. </div>
  94. {% endcapture %}
  95. {% capture hover_example %}
  96. <div class="control">
  97. <input class="input is-hovered" type="text" placeholder="Hovered input">
  98. </div>
  99. {% endcapture %}
  100. {% capture focus_example %}
  101. <div class="control">
  102. <input class="input is-focused" type="text" placeholder="Focused input">
  103. </div>
  104. {% endcapture %}
  105. {% capture loading_example %}
  106. <div class="control is-loading">
  107. <input class="input" type="text" placeholder="Loading input">
  108. </div>
  109. {% endcapture %}
  110. {% capture loading_sizes_example %}
  111. <div class="field">
  112. <div class="control is-small is-loading">
  113. <input class="input is-small" type="text" placeholder="Small loading input">
  114. </div>
  115. </div>
  116. <div class="field">
  117. <div class="control is-loading">
  118. <input class="input" type="text" placeholder="Normal loading input">
  119. </div>
  120. </div>
  121. <div class="field">
  122. <div class="control is-medium is-loading">
  123. <input class="input is-medium" type="text" placeholder="Medium loading input">
  124. </div>
  125. </div>
  126. <div class="field">
  127. <div class="control is-large is-loading">
  128. <input class="input is-large" type="text" placeholder="Large loading input">
  129. </div>
  130. </div>
  131. {% endcapture %}
  132. {% capture disabled_example %}
  133. <div class="control">
  134. <input class="input" type="text" placeholder="Disabled input" disabled>
  135. </div>
  136. {% endcapture %}
  137. {% capture readonly_example %}
  138. <div class="control">
  139. <input class="input" type="text" value="This text is readonly" readonly>
  140. </div>
  141. {% endcapture %}
  142. {% capture static_example %}
  143. <div class="field is-horizontal">
  144. <div class="field-label is-normal">
  145. <label class="label">From</label>
  146. </div>
  147. <div class="field-body">
  148. <div class="field">
  149. <p class="control">
  150. <input class="input is-static" type="email" value="me@example.com" readonly>
  151. </p>
  152. </div>
  153. </div>
  154. </div>
  155. <div class="field is-horizontal">
  156. <div class="field-label is-normal">
  157. <label class="label">To</label>
  158. </div>
  159. <div class="field-body">
  160. <div class="field">
  161. <p class="control">
  162. <input class="input" type="email" placeholder="Recipient email">
  163. </p>
  164. </div>
  165. </div>
  166. </div>
  167. {% endcapture %}
  168. {% capture icons_example %}
  169. <div class="field">
  170. <p class="control has-icons-left has-icons-right">
  171. <input class="input" type="email" placeholder="Email">
  172. <span class="icon is-small is-left">
  173. <i class="fas fa-envelope"></i>
  174. </span>
  175. <span class="icon is-small is-right">
  176. <i class="fas fa-check"></i>
  177. </span>
  178. </p>
  179. </div>
  180. <div class="field">
  181. <p class="control has-icons-left">
  182. <input class="input" type="password" placeholder="Password">
  183. <span class="icon is-small is-left">
  184. <i class="fas fa-lock"></i>
  185. </span>
  186. </p>
  187. </div>
  188. {% endcapture %}
  189. {% capture has_icons_small_example %}
  190. <div class="control has-icons-left has-icons-right">
  191. <input class="input is-small" type="email" placeholder="Email">
  192. <span class="icon is-small is-left">
  193. <i class="fas fa-envelope"></i>
  194. </span>
  195. <span class="icon is-small is-right">
  196. <i class="fas fa-check"></i>
  197. </span>
  198. </div>
  199. {% endcapture %}
  200. {% capture has_icons_normal_example %}
  201. <div class="control has-icons-left has-icons-right">
  202. <input class="input" type="email" placeholder="Email">
  203. <span class="icon is-small is-left">
  204. <i class="fas fa-envelope"></i>
  205. </span>
  206. <span class="icon is-small is-right">
  207. <i class="fas fa-check"></i>
  208. </span>
  209. </div>
  210. {% endcapture %}
  211. {% capture has_icons_medium_example %}
  212. <div class="control has-icons-left has-icons-right">
  213. <input class="input is-medium" type="email" placeholder="Email">
  214. <span class="icon is-left">
  215. <i class="fas fa-envelope"></i>
  216. </span>
  217. <span class="icon is-right">
  218. <i class="fas fa-check"></i>
  219. </span>
  220. </div>
  221. {% endcapture %}
  222. {% capture has_icons_large_example %}
  223. <div class="control has-icons-left has-icons-right">
  224. <input class="input is-large" type="email" placeholder="Email">
  225. <span class="icon is-medium is-left">
  226. <i class="fas fa-envelope"></i>
  227. </span>
  228. <span class="icon is-medium is-right">
  229. <i class="fas fa-check"></i>
  230. </span>
  231. </div>
  232. {% endcapture %}
  233. <div class="content">
  234. <p>The following <strong>modifiers</strong> are supported:</p>
  235. <ul>
  236. <li>the <strong><a href="#colors">color</a></strong></li>
  237. <li>the <strong><a href="#sizes">size</a></strong></li>
  238. <li>the <strong><a href="#states">state</a></strong></li>
  239. </ul>
  240. <p>The following <a href="http://htmlreference.io/element/input/" target="_blank">type attributes</a> are supported:</p>
  241. <ul>
  242. <li><code>type="text"</code></li>
  243. <li><code>type="password"</code></li>
  244. <li><code>type="email"</code></li>
  245. <li><code>type="tel"</code></li>
  246. </ul>
  247. </div>
  248. <div class="columns">
  249. <div class="column is-half">
  250. {{input_example}}
  251. </div>
  252. <div class="column is-half highlight-full">
  253. {% highlight html %}{{input_example}}{% endhighlight %}
  254. </div>
  255. </div>
  256. {% include anchor.html name="Colors" %}
  257. <div class="columns">
  258. <div class="column is-half">
  259. {{colors_example}}
  260. </div>
  261. <div class="column is-half highlight-full">
  262. {% highlight html %}{{colors_example}}{% endhighlight %}
  263. </div>
  264. </div>
  265. {% include anchor.html name="Sizes" %}
  266. <div class="columns">
  267. <div class="column is-half">
  268. {{sizes_example}}
  269. </div>
  270. <div class="column is-half">
  271. {% highlight html %}{{sizes_example}}{% endhighlight %}
  272. </div>
  273. </div>
  274. {% include anchor.html name="Styles" %}
  275. {% include elements/new-tag.html version="0.6.2" %}
  276. <div class="columns">
  277. <div class="column is-half">
  278. {{ rounded_example }}
  279. </div>
  280. <div class="column is-half">
  281. {% highlight html %}{{ rounded_example }}{% endhighlight %}
  282. </div>
  283. </div>
  284. {% include anchor.html name="States" %}
  285. <h4 class="subtitle">Normal</h4>
  286. <div class="columns">
  287. <div class="column is-half">
  288. {{normal_example}}
  289. </div>
  290. <div class="column is-half">
  291. {% highlight html %}{{normal_example}}{% endhighlight %}
  292. </div>
  293. </div>
  294. <h4 class="subtitle">Hover</h4>
  295. <div class="columns">
  296. <div class="column is-half">
  297. {{hover_example}}
  298. </div>
  299. <div class="column is-half">
  300. {% highlight html %}{{hover_example}}{% endhighlight %}
  301. </div>
  302. </div>
  303. <h4 class="subtitle">Focus</h4>
  304. <div class="columns">
  305. <div class="column is-half">
  306. {{focus_example}}
  307. </div>
  308. <div class="column is-half">
  309. {% highlight html %}{{focus_example}}{% endhighlight %}
  310. </div>
  311. </div>
  312. <h4 class="subtitle">Loading</h4>
  313. <div class="columns">
  314. <div class="column is-half">
  315. {{loading_example}}
  316. </div>
  317. <div class="column is-half">
  318. {% highlight html %}{{loading_example}}{% endhighlight %}
  319. </div>
  320. </div>
  321. <div class="columns">
  322. <div class="column is-half">
  323. <div class="content">
  324. <p>
  325. You can resize the loading spinner by appending <code>is-small</code>, <code>is-medium</code> or <code>is-large</code> to the <code>control</code> container.
  326. </p>
  327. </div>
  328. {{loading_sizes_example}}
  329. </div>
  330. <div class="column is-half">
  331. {% highlight html %}{{loading_sizes_example}}{% endhighlight %}
  332. </div>
  333. </div>
  334. <h4 class="subtitle">Disabled</h4>
  335. <div class="columns">
  336. <div class="column is-half">
  337. {{disabled_example}}
  338. </div>
  339. <div class="column is-half">
  340. {% highlight html %}{{disabled_example}}{% endhighlight %}
  341. </div>
  342. </div>
  343. <h4 class="subtitle">Readonly and static inputs</h4>
  344. <p style="margin-bottom: 0.5rem;">
  345. <span class="tag is-success">New!</span>
  346. <span class="tag is-info">0.5.3</span>
  347. </p>
  348. <div class="content">
  349. <p>
  350. If you use the <code>readonly</code> HTML attribute, the input will look similar to a normal one, but is not editable and has no shadow.
  351. </p>
  352. </div>
  353. <div class="columns">
  354. <div class="column is-half">
  355. {{ readonly_example }}
  356. </div>
  357. <div class="column is-half">
  358. {% highlight html %}{{ readonly_example }}{% endhighlight %}
  359. </div>
  360. </div>
  361. <div class="content">
  362. <p>
  363. If you <em>also</em> append the <code>is-static</code> modifier, it removes the background, border, shadow, and horizontal padding, while maintaining the <strong>vertical spacing</strong> so you can easily align the input in any context, like a horizontal form.
  364. </p>
  365. </div>
  366. <div class="bd-example">
  367. {{ static_example }}
  368. </div>
  369. {% highlight html %}{{ static_example }}{% endhighlight %}
  370. <!-- Font Awesome Icons -->
  371. {% include anchor.html name="With Font Awesome icons" %}
  372. <div class="content">
  373. <p>You can append one of 2 <strong>modifiers</strong> on a control:</p>
  374. <ul>
  375. <li>
  376. <code>has-icons-left</code>
  377. </li>
  378. <li>
  379. and/or <code>has-icons-right</code>
  380. </li>
  381. </ul>
  382. <p>You also need to add a modifier on the <strong>icon</strong>:</p>
  383. <ul>
  384. <li>
  385. <code>icon is-left</code> if <code>has-icons-left</code> is used
  386. </li>
  387. <li>
  388. <code>icon is-right</code> if <code>has-icons-right</code> is used
  389. </li>
  390. </ul>
  391. <p>The size of the <strong>input</strong> will define the size of the icon container.</p>
  392. </div>
  393. <div class="columns">
  394. <div class="column is-half">
  395. {{icons_example}}
  396. </div>
  397. <div class="column is-half">
  398. {% highlight html %}{{icons_example}}{% endhighlight %}
  399. </div>
  400. </div>
  401. <div class="columns">
  402. <div class="column is-half">
  403. <div class="content">
  404. <p>
  405. If the control contains an icon, Bulma will make sure the icon remains <strong>centered</strong>, no matter the size of the input <em>or</em> of the icon.
  406. </p>
  407. </div>
  408. {{has_icons_small_example}}
  409. </div>
  410. <div class="column is-half">
  411. {% highlight html %}{{has_icons_small_example}}{% endhighlight %}
  412. </div>
  413. </div>
  414. <div class="columns">
  415. <div class="column is-half">
  416. {{has_icons_normal_example}}
  417. </div>
  418. <div class="column is-half">
  419. {% highlight html %}{{has_icons_normal_example}}{% endhighlight %}
  420. </div>
  421. </div>
  422. <div class="columns">
  423. <div class="column is-half">
  424. {{has_icons_medium_example}}
  425. </div>
  426. <div class="column is-half">
  427. {% highlight html %}{{has_icons_medium_example}}{% endhighlight %}
  428. </div>
  429. </div>
  430. <div class="columns">
  431. <div class="column is-half">
  432. {{has_icons_large_example}}
  433. </div>
  434. <div class="column is-half">
  435. {% highlight html %}{{has_icons_large_example}}{% endhighlight %}
  436. </div>
  437. </div>
  438. {% include anchor.html name="Variables" %}
  439. <div class="content">
  440. <p>
  441. You can use <a href="{{ site.data.meta.github | append: '/blob/master/sass/elements/form.sass#L1,L23' }}" target="_blank">these variables</a> to <strong>customize</strong> this element. Simply set one or multiple of these variables <em>before</em> importing Bulma. <a href="{{ site.url }}/documentation/overview/customize/">Learn how</a>.
  442. </p>
  443. </div>
  444. <table class="table is-bordered">
  445. <thead>
  446. <tr>
  447. <th>Name</th>
  448. <th>Default value</th>
  449. </tr>
  450. </thead>
  451. <tfoot>
  452. <tr>
  453. <th>Name</th>
  454. <th>Default value</th>
  455. </tr>
  456. </tfoot>
  457. <tbody>
  458. {% for key in page.variables_keys %}
  459. {% assign variable = site.data.variables.elements.form.vars[key] %}
  460. <tr>
  461. <td>
  462. <code>{{ variable.name }}</code>
  463. </td>
  464. <td>
  465. <code>{{ variable.value }}</code>
  466. </td>
  467. </tr>
  468. {% endfor %}
  469. </tbody>
  470. </table>