file.html 18 KB

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