file.html 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768
  1. ---
  2. title: File upload
  3. subtitle: "A custom <strong>file upload</strong> input, without JavaScript"
  4. layout: documentation
  5. doc-tab: form
  6. doc-subtab: file
  7. breadcrumb:
  8. - home
  9. - documentation
  10. - form
  11. - form-file
  12. file_name: "Screen Shot 2017-07-29 at 15.54.25.png"
  13. variables_keys:
  14. - file-border-color
  15. - file-radius
  16. - file-cta-background-color
  17. - file-cta-color
  18. - file-cta-hover-color
  19. - file-cta-active-color
  20. - file-name-border-color
  21. - file-name-border-style
  22. - file-name-border-width
  23. - file-name-max-width
  24. meta:
  25. experimental: true
  26. colors: true
  27. sizes: true
  28. variables: true
  29. ---
  30. {% capture file %}
  31. <div class="file">
  32. <label class="file-label">
  33. <input class="file-input" type="file" name="resume">
  34. <span class="file-cta">
  35. <span class="file-icon">
  36. <i class="fas fa-upload"></i>
  37. </span>
  38. <span class="file-label">
  39. Choose a file…
  40. </span>
  41. </span>
  42. </label>
  43. </div>
  44. {% endcapture %}
  45. {% capture file_name %}
  46. <div class="file has-name">
  47. <label class="file-label">
  48. <input class="file-input" type="file" name="resume">
  49. <span class="file-cta">
  50. <span class="file-icon">
  51. <i class="fas fa-upload"></i>
  52. </span>
  53. <span class="file-label">
  54. Choose a file…
  55. </span>
  56. </span>
  57. <span class="file-name">
  58. {{ page.file_name }}
  59. </span>
  60. </label>
  61. </div>
  62. {% endcapture %}
  63. {% capture file_name_right %}
  64. <div class="file has-name is-right">
  65. <label class="file-label">
  66. <input class="file-input" type="file" name="resume">
  67. <span class="file-cta">
  68. <span class="file-icon">
  69. <i class="fas fa-upload"></i>
  70. </span>
  71. <span class="file-label">
  72. Choose a file…
  73. </span>
  74. </span>
  75. <span class="file-name">
  76. {{ page.file_name }}
  77. </span>
  78. </label>
  79. </div>
  80. {% endcapture %}
  81. {% capture file_name_fullwidth %}
  82. <div class="file has-name is-fullwidth">
  83. <label class="file-label">
  84. <input class="file-input" type="file" name="resume">
  85. <span class="file-cta">
  86. <span class="file-icon">
  87. <i class="fas fa-upload"></i>
  88. </span>
  89. <span class="file-label">
  90. Choose a file…
  91. </span>
  92. </span>
  93. <span class="file-name">
  94. {{ page.file_name }}
  95. </span>
  96. </label>
  97. </div>
  98. {% endcapture %}
  99. {% capture file_boxed %}
  100. <div class="file is-boxed">
  101. <label class="file-label">
  102. <input class="file-input" type="file" name="resume">
  103. <span class="file-cta">
  104. <span class="file-icon">
  105. <i class="fas fa-upload"></i>
  106. </span>
  107. <span class="file-label">
  108. Choose a file…
  109. </span>
  110. </span>
  111. </label>
  112. </div>
  113. {% endcapture %}
  114. {% capture file_boxed_name %}
  115. <div class="file has-name is-boxed">
  116. <label class="file-label">
  117. <input class="file-input" type="file" name="resume">
  118. <span class="file-cta">
  119. <span class="file-icon">
  120. <i class="fas fa-upload"></i>
  121. </span>
  122. <span class="file-label">
  123. Choose a file…
  124. </span>
  125. </span>
  126. <span class="file-name">
  127. {{ page.file_name }}
  128. </span>
  129. </label>
  130. </div>
  131. {% endcapture %}
  132. {% capture file_colors %}
  133. <div class="field">
  134. <div class="file is-primary">
  135. <label class="file-label">
  136. <input class="file-input" type="file" name="resume">
  137. <span class="file-cta">
  138. <span class="file-icon">
  139. <i class="fas fa-upload"></i>
  140. </span>
  141. <span class="file-label">
  142. Primary file…
  143. </span>
  144. </span>
  145. </label>
  146. </div>
  147. </div>
  148. <div class="field">
  149. <div class="file is-info has-name">
  150. <label class="file-label">
  151. <input class="file-input" type="file" name="resume">
  152. <span class="file-cta">
  153. <span class="file-icon">
  154. <i class="fas fa-upload"></i>
  155. </span>
  156. <span class="file-label">
  157. Info file…
  158. </span>
  159. </span>
  160. <span class="file-name">
  161. {{ page.file_name }}
  162. </span>
  163. </label>
  164. </div>
  165. </div>
  166. <div class="field">
  167. <div class="file is-warning is-boxed">
  168. <label class="file-label">
  169. <input class="file-input" type="file" name="resume">
  170. <span class="file-cta">
  171. <span class="file-icon">
  172. <i class="fas fa-cloud-upload-alt"></i>
  173. </span>
  174. <span class="file-label">
  175. Warning file…
  176. </span>
  177. </span>
  178. </label>
  179. </div>
  180. </div>
  181. <div class="field">
  182. <div class="file is-danger has-name is-boxed">
  183. <label class="file-label">
  184. <input class="file-input" type="file" name="resume">
  185. <span class="file-cta">
  186. <span class="file-icon">
  187. <i class="fas fa-cloud-upload-alt"></i>
  188. </span>
  189. <span class="file-label">
  190. Danger file…
  191. </span>
  192. </span>
  193. <span class="file-name">
  194. {{ page.file_name }}
  195. </span>
  196. </label>
  197. </div>
  198. </div>
  199. {% endcapture %}
  200. {% capture file_sizes %}
  201. <div class="field">
  202. <div class="file is-small">
  203. <label class="file-label">
  204. <input class="file-input" type="file" name="resume">
  205. <span class="file-cta">
  206. <span class="file-icon">
  207. <i class="fas fa-upload"></i>
  208. </span>
  209. <span class="file-label">
  210. Small file…
  211. </span>
  212. </span>
  213. </label>
  214. </div>
  215. </div>
  216. <div class="field">
  217. <div class="file">
  218. <label class="file-label">
  219. <input class="file-input" type="file" name="resume">
  220. <span class="file-cta">
  221. <span class="file-icon">
  222. <i class="fas fa-upload"></i>
  223. </span>
  224. <span class="file-label">
  225. Normal file…
  226. </span>
  227. </span>
  228. </label>
  229. </div>
  230. </div>
  231. <div class="field">
  232. <div class="file is-medium">
  233. <label class="file-label">
  234. <input class="file-input" type="file" name="resume">
  235. <span class="file-cta">
  236. <span class="file-icon">
  237. <i class="fas fa-upload"></i>
  238. </span>
  239. <span class="file-label">
  240. Medium file…
  241. </span>
  242. </span>
  243. </label>
  244. </div>
  245. </div>
  246. <div class="field">
  247. <div class="file is-large">
  248. <label class="file-label">
  249. <input class="file-input" type="file" name="resume">
  250. <span class="file-cta">
  251. <span class="file-icon">
  252. <i class="fas fa-upload"></i>
  253. </span>
  254. <span class="file-label">
  255. Large file…
  256. </span>
  257. </span>
  258. </label>
  259. </div>
  260. </div>
  261. {% endcapture %}
  262. {% capture file_sizes_name %}
  263. <div class="field">
  264. <div class="file is-small has-name">
  265. <label class="file-label">
  266. <input class="file-input" type="file" name="resume">
  267. <span class="file-cta">
  268. <span class="file-icon">
  269. <i class="fas fa-upload"></i>
  270. </span>
  271. <span class="file-label">
  272. Small file…
  273. </span>
  274. </span>
  275. <span class="file-name">
  276. {{ page.file_name }}
  277. </span>
  278. </label>
  279. </div>
  280. </div>
  281. <div class="field">
  282. <div class="file has-name">
  283. <label class="file-label">
  284. <input class="file-input" type="file" name="resume">
  285. <span class="file-cta">
  286. <span class="file-icon">
  287. <i class="fas fa-upload"></i>
  288. </span>
  289. <span class="file-label">
  290. Normal file…
  291. </span>
  292. </span>
  293. <span class="file-name">
  294. {{ page.file_name }}
  295. </span>
  296. </label>
  297. </div>
  298. </div>
  299. <div class="field">
  300. <div class="file is-medium has-name">
  301. <label class="file-label">
  302. <input class="file-input" type="file" name="resume">
  303. <span class="file-cta">
  304. <span class="file-icon">
  305. <i class="fas fa-upload"></i>
  306. </span>
  307. <span class="file-label">
  308. Medium file…
  309. </span>
  310. </span>
  311. <span class="file-name">
  312. {{ page.file_name }}
  313. </span>
  314. </label>
  315. </div>
  316. </div>
  317. <div class="field">
  318. <div class="file is-large has-name">
  319. <label class="file-label">
  320. <input class="file-input" type="file" name="resume">
  321. <span class="file-cta">
  322. <span class="file-icon">
  323. <i class="fas fa-upload"></i>
  324. </span>
  325. <span class="file-label">
  326. Large file…
  327. </span>
  328. </span>
  329. <span class="file-name">
  330. {{ page.file_name }}
  331. </span>
  332. </label>
  333. </div>
  334. </div>
  335. {% endcapture %}
  336. {% capture file_sizes_boxed %}
  337. <div class="field">
  338. <div class="file is-small is-boxed">
  339. <label class="file-label">
  340. <input class="file-input" type="file" name="resume">
  341. <span class="file-cta">
  342. <span class="file-icon">
  343. <i class="fas fa-upload"></i>
  344. </span>
  345. <span class="file-label">
  346. Small file…
  347. </span>
  348. </span>
  349. </label>
  350. </div>
  351. </div>
  352. <div class="field">
  353. <div class="file is-boxed">
  354. <label class="file-label">
  355. <input class="file-input" type="file" name="resume">
  356. <span class="file-cta">
  357. <span class="file-icon">
  358. <i class="fas fa-upload"></i>
  359. </span>
  360. <span class="file-label">
  361. Normal file…
  362. </span>
  363. </span>
  364. </label>
  365. </div>
  366. </div>
  367. <div class="field">
  368. <div class="file is-medium is-boxed">
  369. <label class="file-label">
  370. <input class="file-input" type="file" name="resume">
  371. <span class="file-cta">
  372. <span class="file-icon">
  373. <i class="fas fa-upload"></i>
  374. </span>
  375. <span class="file-label">
  376. Medium file…
  377. </span>
  378. </span>
  379. </label>
  380. </div>
  381. </div>
  382. <div class="field">
  383. <div class="file is-large is-boxed">
  384. <label class="file-label">
  385. <input class="file-input" type="file" name="resume">
  386. <span class="file-cta">
  387. <span class="file-icon">
  388. <i class="fas fa-upload"></i>
  389. </span>
  390. <span class="file-label">
  391. Large file…
  392. </span>
  393. </span>
  394. </label>
  395. </div>
  396. </div>
  397. {% endcapture %}
  398. {% capture file_centered %}
  399. <div class="field">
  400. <div class="file is-centered is-boxed is-success has-name">
  401. <label class="file-label">
  402. <input class="file-input" type="file" name="resume">
  403. <span class="file-cta">
  404. <span class="file-icon">
  405. <i class="fas fa-upload"></i>
  406. </span>
  407. <span class="file-label">
  408. Centered file…
  409. </span>
  410. </span>
  411. <span class="file-name">
  412. {{ page.file_name }}
  413. </span>
  414. </label>
  415. </div>
  416. </div>
  417. {% endcapture %}
  418. {% capture file_right %}
  419. <div class="field">
  420. <div class="file is-right is-info">
  421. <label class="file-label">
  422. <input class="file-input" type="file" name="resume">
  423. <span class="file-cta">
  424. <span class="file-icon">
  425. <i class="fas fa-upload"></i>
  426. </span>
  427. <span class="file-label">
  428. Right file…
  429. </span>
  430. </span>
  431. <span class="file-name">
  432. {{ page.file_name }}
  433. </span>
  434. </label>
  435. </div>
  436. </div>
  437. {% endcapture %}
  438. {% capture file_sizes_boxed_name %}
  439. <div class="field">
  440. <div class="file is-small is-boxed has-name">
  441. <label class="file-label">
  442. <input class="file-input" type="file" name="resume">
  443. <span class="file-cta">
  444. <span class="file-icon">
  445. <i class="fas fa-upload"></i>
  446. </span>
  447. <span class="file-label">
  448. Small file…
  449. </span>
  450. </span>
  451. <span class="file-name">
  452. {{ page.file_name }}
  453. </span>
  454. </label>
  455. </div>
  456. </div>
  457. <div class="field">
  458. <div class="file is-boxed has-name">
  459. <label class="file-label">
  460. <input class="file-input" type="file" name="resume">
  461. <span class="file-cta">
  462. <span class="file-icon">
  463. <i class="fas fa-upload"></i>
  464. </span>
  465. <span class="file-label">
  466. Normal file…
  467. </span>
  468. </span>
  469. <span class="file-name">
  470. {{ page.file_name }}
  471. </span>
  472. </label>
  473. </div>
  474. </div>
  475. <div class="field">
  476. <div class="file is-medium is-boxed has-name">
  477. <label class="file-label">
  478. <input class="file-input" type="file" name="resume">
  479. <span class="file-cta">
  480. <span class="file-icon">
  481. <i class="fas fa-upload"></i>
  482. </span>
  483. <span class="file-label">
  484. Medium file…
  485. </span>
  486. </span>
  487. <span class="file-name">
  488. {{ page.file_name }}
  489. </span>
  490. </label>
  491. </div>
  492. </div>
  493. <div class="field">
  494. <div class="file is-large is-boxed has-name">
  495. <label class="file-label">
  496. <input class="file-input" type="file" name="resume">
  497. <span class="file-cta">
  498. <span class="file-icon">
  499. <i class="fas fa-upload"></i>
  500. </span>
  501. <span class="file-label">
  502. Large file…
  503. </span>
  504. </span>
  505. <span class="file-name">
  506. {{ page.file_name }}
  507. </span>
  508. </label>
  509. </div>
  510. </div>
  511. {% endcapture %}
  512. <div class="content">
  513. <p>
  514. The <code>.file</code> element is a simple <strong>interactive label</strong> that wraps an <code>&lt;input type="file"&gt;</code>. It comprises several sub-elements:
  515. </p>
  516. <ul>
  517. <li>
  518. <code>.file</code> the main <strong>container</strong>
  519. <ul>
  520. <li>
  521. <code>.file-label</code> the actual <strong>interactive</strong> and clickable part of the element
  522. <ul>
  523. <li>
  524. <code>.file-input</code> the <strong>native</strong> file input, hidden for styling purposes
  525. </li>
  526. <li>
  527. <code>.file-cta</code> the upload <strong>call-to-action</strong>
  528. <ul>
  529. <li>
  530. <code>.file-icon</code> an optional <strong>upload</strong> icon
  531. </li>
  532. <li>
  533. <code>.file-label</code> the "Choose a file…" text
  534. </li>
  535. </ul>
  536. </li>
  537. <li>
  538. <code>.file-name</code> a container for the <strong>chosen file</strong> name
  539. </li>
  540. </ul>
  541. </li>
  542. </ul>
  543. </li>
  544. </ul>
  545. </div>
  546. {% include snippet.html content=file %}
  547. {% include anchor.html name="Modifiers" %}
  548. <div class="columns">
  549. <div class="column">
  550. <div class="content">
  551. <p>
  552. With the <code>.has-name</code> modifier combined with the <code>.file-name</code> element, you can add a <strong>placeholder</strong> for the selected file name.
  553. </p>
  554. </div>
  555. <div class="bd-example">
  556. {{ file_name }}
  557. </div>
  558. </div>
  559. <div class="column highlight-full">
  560. {% highlight html %}{{ file_name }}{% endhighlight %}
  561. </div>
  562. </div>
  563. <div class="columns">
  564. <div class="column">
  565. <div class="content">
  566. <p>
  567. You can move the CTA to the <strong>right side</strong> with the <code>.is-right</code> modifier.
  568. </p>
  569. </div>
  570. <div class="bd-example">
  571. {{ file_name_right }}
  572. </div>
  573. </div>
  574. <div class="column highlight-full">
  575. {% highlight html %}{{ file_name_right }}{% endhighlight %}
  576. </div>
  577. </div>
  578. <div class="columns">
  579. <div class="column">
  580. <div class="content">
  581. <p>
  582. You can also <strong>expand</strong> the name to fill up the space with the <code>.is-fullwidth</code> modifier.
  583. </p>
  584. </div>
  585. <div class="bd-example">
  586. {{ file_name_fullwidth }}
  587. </div>
  588. </div>
  589. <div class="column highlight-full">
  590. {% highlight html %}{{ file_name_fullwidth }}{% endhighlight %}
  591. </div>
  592. </div>
  593. <div class="columns">
  594. <div class="column">
  595. <div class="content">
  596. <p>
  597. You can have a <strong>boxed block</strong> with the <code>.is-boxed</code> modifier.
  598. </p>
  599. </div>
  600. <div class="bd-example">
  601. {{ file_boxed }}
  602. </div>
  603. </div>
  604. <div class="column highlight-full">
  605. {% highlight html %}{{ file_boxed }}{% endhighlight %}
  606. </div>
  607. </div>
  608. <div class="columns">
  609. <div class="column">
  610. <div class="content">
  611. <p>
  612. You can <strong>combine</strong> <code>.has-name</code> and <code>.is-boxed</code>.
  613. </p>
  614. </div>
  615. <div class="bd-example">
  616. {{ file_boxed_name }}
  617. </div>
  618. </div>
  619. <div class="column highlight-full">
  620. {% highlight html %}{{ file_boxed_name }}{% endhighlight %}
  621. </div>
  622. </div>
  623. {% include anchor.html name="Colors" %}
  624. <div class="content">
  625. <p>
  626. You can style the file element by appending one of the <strong>{{ site.data.colors.derived | size }} color modifiers</strong>:
  627. </p>
  628. <ul>
  629. {% for color in site.data.colors.derived %}
  630. <li>
  631. <code>is-{{ color.id }}</code>
  632. </li>
  633. {% endfor %}
  634. </ul>
  635. </div>
  636. {% include snippet.html content=file_colors clipped=true %}
  637. {% include anchor.html name="Sizes" %}
  638. <div class="content">
  639. <p>
  640. You can append one of <strong>3 additional sizes</strong>:
  641. </p>
  642. <ul>
  643. <li>
  644. <code>.is-small</code>
  645. </li>
  646. <li>
  647. <code>.is-medium</code>
  648. </li>
  649. <li>
  650. <code>.is-large</code>
  651. </li>
  652. </ul>
  653. </div>
  654. {% include snippet.html content=file_sizes clipped=true %}
  655. {% include snippet.html content=file_sizes_name clipped=true %}
  656. {% include snippet.html content=file_sizes_boxed clipped=true %}
  657. {% include snippet.html content=file_sizes_boxed_name clipped=true %}
  658. {% include anchor.html name="Alignment" %}
  659. <div class="content">
  660. <p>
  661. You can <strong>align</strong> the file input:
  662. </p>
  663. <ul>
  664. <li>
  665. to the <strong>center</strong> with the <code>is-centered</code> modifier
  666. </li>
  667. <li>
  668. to the <strong>right</strong> with the <code>is-right</code> modifier
  669. </li>
  670. </ul>
  671. </div>
  672. {% include snippet.html content=file_centered %}
  673. {% include snippet.html content=file_right %}
  674. {% include anchor.html name="JavaScript" %}
  675. <div class="content">
  676. <p>
  677. A file upload input requires JavaScript to <strong>retrieve</strong> the <strong>selected file name</strong>.
  678. <br>
  679. User <a href="https://github.com/chintanbanugaria"><strong>@chintanbanugaria</strong></a> on GitHub <a href="https://github.com/jgthms/bulma/issues/280#issuecomment-294099510">has provided</a> a simple solution <a href="https://jsfiddle.net/chintanbanugaria/uzva5byy/">on JSFiddle</a>.
  680. </p>
  681. </div>
  682. {% include anchor.html name="Variables" %}
  683. <div class="content">
  684. <p>
  685. You can use <a href="{{ site.data.meta.github | append: '/blob/master/sass/elements/form.sass#L25,L36' }}" 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>.
  686. </p>
  687. </div>
  688. <table class="table is-bordered">
  689. <thead>
  690. <tr>
  691. <th>Name</th>
  692. <th>Default value</th>
  693. </tr>
  694. </thead>
  695. <tfoot>
  696. <tr>
  697. <th>Name</th>
  698. <th>Default value</th>
  699. </tr>
  700. </tfoot>
  701. <tbody>
  702. {% for key in page.variables_keys %}
  703. {% assign variable = site.data.variables.elements.form.vars[key] %}
  704. <tr>
  705. <td>
  706. <code>{{ variable.name }}</code>
  707. </td>
  708. <td>
  709. <code>{{ variable.value }}</code>
  710. </td>
  711. </tr>
  712. {% endfor %}
  713. </tbody>
  714. </table>