variables.html 10.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359
  1. ---
  2. title: Variables
  3. layout: documentation
  4. doc-tab: overview
  5. doc-subtab: variables
  6. initial_colors:
  7. - name: $black
  8. value: hsl(0, 0%, 4%)
  9. - name: $black-bis
  10. value: hsl(0, 0%, 7%)
  11. - name: $black-ter
  12. value: hsl(0, 0%, 14%)
  13. - name: $grey-darker
  14. value: hsl(0, 0%, 21%)
  15. - name: $grey-dark
  16. value: hsl(0, 0%, 29%)
  17. - name: $grey
  18. value: hsl(0, 0%, 48%)
  19. - name: $grey-light
  20. value: hsl(0, 0%, 71%)
  21. - name: $grey-lighter
  22. value: hsl(0, 0%, 86%)
  23. - name: $white-ter
  24. value: hsl(0, 0%, 96%)
  25. - name: $white-bis
  26. value: hsl(0, 0%, 98%)
  27. - name: $white
  28. value: hsl(0, 0%, 100%)
  29. - name: $orange
  30. value: hsl(14, 100%, 53%)
  31. - name: $yellow
  32. value: hsl(48, 100%, 67%)
  33. - name: $green
  34. value: hsl(141, 71%, 48%)
  35. - name: $turquoise
  36. value: hsl(171, 100%, 41%)
  37. - name: $blue
  38. value: hsl(217, 71%, 53%)
  39. - name: $purple
  40. value: hsl(271, 100%, 71%)
  41. - name: $red
  42. value: hsl(348, 100%, 61%)
  43. initial_variables:
  44. - name: $family-sans-serif
  45. value: BlinkMacSystemFont, -apple-system, "Segoe UI", "Roboto", "Oxygen", "Ubuntu", "Cantarell", "Fira Sans", "Droid Sans", "Helvetica Neue", "Helvetica", "Arial", sans-serif
  46. - name: $family-monospace
  47. value: monospace
  48. - name: $render-mode
  49. value: optimizeLegibility
  50. - name: $size-1
  51. value: 3rem
  52. - name: $size-2
  53. value: 2.5rem
  54. - name: $size-3
  55. value: 2rem
  56. - name: $size-4
  57. value: 1.5rem
  58. - name: $size-5
  59. value: 1.25rem
  60. - name: $size-6
  61. value: 1rem
  62. - name: $size-7
  63. value: 0.75rem
  64. - name: $weight-light
  65. value: 300
  66. - name: $weight-normal
  67. value: 400
  68. - name: $weight-medium
  69. value: 500
  70. - name: $weight-semibold
  71. value: 600
  72. - name: $weight-bold
  73. value: 700
  74. - name: $gap
  75. value: 32px
  76. - name: $tablet
  77. value: 769px
  78. - name: $desktop
  79. value: 960px + (2 * $gap)
  80. - name: $widescreen
  81. value: 1152px + (2 * $gap)
  82. - name: $fullhd
  83. value: 1344px + (2 * $gap)
  84. - name: $easing
  85. value: ease-out
  86. - name: $radius-small
  87. value: 2px
  88. - name: $radius
  89. value: 3px
  90. - name: $radius-large
  91. value: 5px
  92. - name: $speed
  93. value: 86ms
  94. derived_variables:
  95. - name: $primary
  96. value: $turquoise
  97. - name: $info
  98. value: $blue
  99. - name: $success
  100. value: $green
  101. - name: $warning
  102. value: $yellow
  103. - name: $danger
  104. value: $red
  105. - name: $light
  106. value: $white-ter
  107. - name: $dark
  108. value: $grey-darker
  109. - name: $orange-invert
  110. value: findColorInvert($orange)
  111. - name: $yellow-invert
  112. value: findColorInvert($yellow)
  113. - name: $green-invert
  114. value: findColorInvert($green)
  115. - name: $turquoise-invert
  116. value: findColorInvert($turquoise)
  117. - name: $blue-invert
  118. value: findColorInvert($blue)
  119. - name: $purple-invert
  120. value: findColorInvert($purple)
  121. - name: $red-invert
  122. value: findColorInvert($red)
  123. - name: $primary-invert
  124. value: $turquoise-invert
  125. - name: $info-invert
  126. value: $blue-invert
  127. - name: $success-invert
  128. value: $green-invert
  129. - name: $warning-invert
  130. value: $yellow-invert
  131. - name: $danger-invert
  132. value: $red-invert
  133. - name: $light-invert
  134. value: $dark
  135. - name: $dark-invert
  136. value: $light
  137. - name: $background
  138. value: $white-ter
  139. - name: $border
  140. value: $grey-lighter
  141. - name: $border-hover
  142. value: $grey-light
  143. - name: $text
  144. value: $grey-dark
  145. - name: $text-invert
  146. value: findColorInvert($text)
  147. - name: $text-light
  148. value: $grey
  149. - name: $text-strong
  150. value: $grey-darker
  151. - name: $code
  152. value: $red
  153. - name: $code-background
  154. value: $background
  155. - name: $pre
  156. value: $text
  157. - name: $pre-background
  158. value: $background
  159. - name: $link
  160. value: $primary
  161. - name: $link-invert
  162. value: $primary-invert
  163. - name: $link-visited
  164. value: $purple
  165. - name: $link-hover
  166. value: $grey-darker
  167. - name: $link-hover-border
  168. value: $grey-light
  169. - name: $link-focus
  170. value: $grey-darker
  171. - name: $link-focus-border
  172. value: $primary
  173. - name: $link-active
  174. value: $grey-darker
  175. - name: $link-active-border
  176. value: $grey-dark
  177. - name: $family-primary
  178. value: $family-sans-serif
  179. - name: $family-code
  180. value: $family-monospace
  181. - name: $size-small
  182. value: $size-7
  183. - name: $size-normal
  184. value: $size-6
  185. - name: $size-medium
  186. value: $size-5
  187. - name: $size-large
  188. value: $size-4
  189. - name: $colors
  190. value: '("white": ($white, $black), "black": ($black, $white), "light": ($light, $light-invert), "dark": ($dark, $dark-invert), "primary": ($primary, $primary-invert), "info": ($info, $info-invert), "success": ($success, $success-invert), "warning": ($warning, $warning-invert), "danger": ($danger, $danger-invert))'
  191. - name: $shades
  192. value: '("black-bis": $black-bis, "black-ter": $black-ter, "grey-darker": $grey-darker, "grey-dark": $grey-dark, "grey": $grey, "grey-light": $grey-light, "grey-lighter": $grey-lighter, "white-ter": $white-ter, "white-bis": $white-bis)'
  193. - name: $sizes
  194. value: $size-1 $size-2 $size-3 $size-4 $size-5 $size-6
  195. generic_variables:
  196. - name: $body-background-color
  197. value: '#fff'
  198. - name: $body-size
  199. value: 16px
  200. - name: $body-rendering
  201. value: optimizeLegibility
  202. - name: $body-family
  203. value: $family-primary
  204. - name: $body-color
  205. value: $text
  206. - name: $body-weight
  207. value: $weight-normal
  208. - name: $body-line-height
  209. value: 1.5
  210. - name: $code-family
  211. value: $family-code
  212. - name: $code-padding
  213. value: 0.25em 0.5em 0.25em
  214. - name: $code-weight
  215. value: normal
  216. - name: $code-size
  217. value: 0.875em
  218. - name: $hr-background-color
  219. value: $border
  220. - name: $hr-height
  221. value: 1px
  222. - name: $hr-margin
  223. value: 1.5rem 0
  224. - name: $strong-color
  225. value: $text-strong
  226. - name: $strong-weight
  227. value: $weight-bold
  228. ---
  229. {% include subnav-overview.html %}
  230. <section class="section">
  231. <div class="container">
  232. <h1 class="title">Variables</h1>
  233. <h2 class="subtitle">Easily <strong>customize</strong> Bulma to match your design</h2>
  234. <hr>
  235. <div class="content">
  236. <p>Bulma has <strong>two</strong> variable files divided into <strong>4</strong> sections:</p>
  237. <ol>
  238. <li>
  239. <strong>Initial variables</strong>: where you define variables by <strong>literal value</strong>, like:
  240. <ul>
  241. <li><strong>colors</strong>: <code>$blue: hsl(217, 71%, 53%)</code></li>
  242. <li><strong>font sizes</strong>: <code>$size-1: 3rem</code></li>
  243. <li><strong>dimensions</strong>: <code>$gap: 24px</code></li>
  244. <li><strong>other values</strong>: <code>$easing: ease-out</code> or <code>$radius-large: 5px</code></li>
  245. </ul>
  246. </li>
  247. <li>
  248. <strong>Derived variables</strong> where variables are <strong>calculated</strong> from the values set in the previous file. For example, you can have:
  249. <ul>
  250. <li>
  251. <strong>Primary colors</strong> derived from the initial variables:
  252. <ul>
  253. <li><code>$primary: $turquoise</code></li>
  254. <li><code>$info: $blue</code></li>
  255. <li><code>$success: $green</code></li>
  256. <li><code>$warning: $yellow</code></li>
  257. <li><code>$danger: $red</code></li>
  258. <li><code>$dark: $grey-darker</code></li>
  259. <li><code>$text: $grey-dark</code></li>
  260. </ul>
  261. </li>
  262. <li><code>$background: $white-ter</code>: a general background color</li>
  263. <li><code>$link: $primary</code>: the links use the primary color</li>
  264. <li><code>$family-primary: $family-sans-serif</code>: the primary font family is the sans-serif one</li>
  265. <li>
  266. <strong>Lists and maps</strong> which are collections so already defined variables:
  267. <ul>
  268. <li><code>$colors: (dark: ($dark, $dark-invert), primary: ($primary, $primary-invert), info: ($info, $info-invert), success: ($success, $success-invert), warning: ($warning, $warning-invert), danger: ($danger, $danger-invert))</code></li>
  269. <li><code>$shades: ("black-bis": $black-bis, "black-ter": $black-ter, "grey-darker": $grey-darker, "grey-dark": $grey-dark, "grey": $grey, "grey-light": $grey-light, "grey-lighter": $grey-lighter, "white-ter": $white-ter, "white-bis": $white-bis)</code></li>
  270. <li><code>$sizes: $size-1 $size-2 $size-3 $size-4 $size-5 $size-6</code></li>
  271. </ul>
  272. </li>
  273. </ul>
  274. </li>
  275. </ol>
  276. <p>
  277. To <strong>override</strong> any of these variables, just set them <em>before</em> importing Bulma.
  278. </p>
  279. </div>
  280. {% include anchor.html name="Initial variables" %}
  281. <div class="content">
  282. <p>
  283. These are variables with a <strong>literal</strong> value.
  284. </p>
  285. </div>
  286. <table class="table is-bordered is-striped">
  287. {% for color in page.initial_colors %}
  288. <tr>
  289. <td>
  290. <code style="white-space: nowrap;">{{ color.name }}</code>
  291. </td>
  292. <td>
  293. <span class="bd-color" style="background: {{ color.value }};"></span>
  294. <code>{{ color.value }}</code>
  295. </td>
  296. </tr>
  297. {% endfor %}
  298. {% for variable in page.initial_variables %}
  299. <tr>
  300. <td>
  301. <code style="white-space: nowrap;">{{ variable.name }}</code>
  302. </td>
  303. <td>
  304. <code>{{ variable.value }}</code>
  305. </td>
  306. </tr>
  307. {% endfor %}
  308. </table>
  309. {% include anchor.html name="Derived variables" %}
  310. <div class="content">
  311. <p>
  312. These are variables with a value that <strong>references</strong> another variable.
  313. </p>
  314. </div>
  315. <table class="table is-bordered is-striped">
  316. {% for variable in page.derived_variables %}
  317. <tr>
  318. <td>
  319. <code style="white-space: nowrap;">{{ variable.name }}</code>
  320. </td>
  321. <td>
  322. <code>{{ variable.value }}</code>
  323. </td>
  324. </tr>
  325. {% endfor %}
  326. </table>
  327. {% include anchor.html name="Generic variables" %}
  328. <div class="content">
  329. <p>
  330. The following generic variables are provided in <code>./sass/base/generic.sass</code>.
  331. </p>
  332. </div>
  333. <table class="table is-bordered is-striped">
  334. {% for variable in page.generic_variables %}
  335. <tr>
  336. <td>
  337. <code style="white-space: nowrap;">{{ variable.name }}</code>
  338. </td>
  339. <td>
  340. <code>{{ variable.value }}</code>
  341. </td>
  342. </tr>
  343. {% endfor %}
  344. </table>
  345. </div>
  346. </section>