@chotot/clad-ui 0.16.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (405) hide show
  1. package/LICENSE +201 -0
  2. package/README.md +75 -0
  3. package/brand/ChototLogoText.d.ts +5 -0
  4. package/brand/CtC2C.d.ts +5 -0
  5. package/brand/CtProperty.d.ts +5 -0
  6. package/brand/CtVehicle.d.ts +5 -0
  7. package/brand/Tot.d.ts +5 -0
  8. package/brand/index.d.ts +5 -0
  9. package/components/Announcer/Announcer.d.ts +30 -0
  10. package/components/Announcer/Announcer.js +163 -0
  11. package/components/Announcer/Announcer.stories.js +388 -0
  12. package/components/Announcer/Announcer.styles.d.ts +20 -0
  13. package/components/Announcer/Announcer.styles.js +214 -0
  14. package/components/Box/Box.d.ts +79 -0
  15. package/components/Box/Box.js +314 -0
  16. package/components/Box/Box.spec.js +425 -0
  17. package/components/Box/Box.stories.js +491 -0
  18. package/components/Box/Box.styles.d.ts +5 -0
  19. package/components/Box/Box.styles.js +71 -0
  20. package/components/Breadcrumbs/Breadcrumbs.d.ts +20 -0
  21. package/components/Breadcrumbs/Breadcrumbs.js +92 -0
  22. package/components/Breadcrumbs/Breadcrumbs.stories.js +170 -0
  23. package/components/Breadcrumbs/Breadcrumbs.styles.d.ts +6 -0
  24. package/components/Breadcrumbs/Breadcrumbs.styles.js +44 -0
  25. package/components/Button/Button.d.ts +34 -0
  26. package/components/Button/Button.js +165 -0
  27. package/components/Button/Button.stories.js +370 -0
  28. package/components/Button/Button.styles.d.ts +2 -0
  29. package/components/Button/Button.styles.js +327 -0
  30. package/components/Button/ButtonLink.d.ts +29 -0
  31. package/components/Button/ButtonLink.js +89 -0
  32. package/components/Button/ButtonLink.stories.js +31 -0
  33. package/components/Button/IconButton.d.ts +28 -0
  34. package/components/Button/IconButton.js +81 -0
  35. package/components/Button/IconButton.stories.js +62 -0
  36. package/components/Checkbox/Checkbox.d.ts +30 -0
  37. package/components/Checkbox/Checkbox.js +106 -0
  38. package/components/Checkbox/Checkbox.stories.js +194 -0
  39. package/components/Checkbox/Checkbox.styles.d.ts +4 -0
  40. package/components/Checkbox/Checkbox.styles.js +112 -0
  41. package/components/Chip/Chip.d.ts +26 -0
  42. package/components/Chip/Chip.js +84 -0
  43. package/components/Chip/Chip.stories.js +130 -0
  44. package/components/Chip/Chip.styles.d.ts +5 -0
  45. package/components/Chip/Chip.styles.js +41 -0
  46. package/components/CurrencyInput/CurrencyInput.d.ts +53 -0
  47. package/components/CurrencyInput/CurrencyInput.js +369 -0
  48. package/components/CurrencyInput/CurrencyInput.spec.js +151 -0
  49. package/components/CurrencyInput/CurrencyInput.stories.js +202 -0
  50. package/components/CurrencyInput/CurrencyInput.styles.d.ts +18 -0
  51. package/components/CurrencyInput/CurrencyInput.styles.js +169 -0
  52. package/components/CurrencyInput/utils/_cleanValue.d.ts +11 -0
  53. package/components/CurrencyInput/utils/_cleanValue.js +55 -0
  54. package/components/CurrencyInput/utils/_cleanValue.spec.js +20 -0
  55. package/components/CurrencyInput/utils/_formatValue.d.ts +5 -0
  56. package/components/CurrencyInput/utils/_formatValue.js +99 -0
  57. package/components/CurrencyInput/utils/_formatValue.spec.js +32 -0
  58. package/components/Dropdown/Dropdown.d.ts +47 -0
  59. package/components/Dropdown/Dropdown.js +214 -0
  60. package/components/Dropdown/Dropdown.stories.js +323 -0
  61. package/components/Grid/Col.d.ts +30 -0
  62. package/components/Grid/Col.js +93 -0
  63. package/components/Grid/Col.spec.js +249 -0
  64. package/components/Grid/Grid.d.ts +36 -0
  65. package/components/Grid/Grid.js +180 -0
  66. package/components/Grid/Grid.spec.js +524 -0
  67. package/components/Grid/Grid.styles.d.ts +12 -0
  68. package/components/Grid/Grid.styles.js +228 -0
  69. package/components/Grid/aGrid.stories.js +577 -0
  70. package/components/Grid/bCol.stories.js +217 -0
  71. package/components/Input/Input.d.ts +50 -0
  72. package/components/Input/Input.js +342 -0
  73. package/components/Input/Input.spec.js +177 -0
  74. package/components/Input/Input.stories.js +424 -0
  75. package/components/Input/Input.styles.d.ts +20 -0
  76. package/components/Input/Input.styles.js +236 -0
  77. package/components/RadioButton/RadioButton.d.ts +30 -0
  78. package/components/RadioButton/RadioButton.js +107 -0
  79. package/components/RadioButton/RadioButton.stories.js +208 -0
  80. package/components/ShapeIcon/ShapeIcon.d.ts +36 -0
  81. package/components/ShapeIcon/ShapeIcon.js +74 -0
  82. package/components/ShapeIcon/ShapeIcon.stories.js +94 -0
  83. package/components/Snack/Snack.d.ts +20 -0
  84. package/components/Snack/Snack.js +82 -0
  85. package/components/Snack/Snack.spec.js +24 -0
  86. package/components/Snack/Snack.stories.js +235 -0
  87. package/components/Snack/Snack.styles.d.ts +6 -0
  88. package/components/Snack/Snack.styles.js +69 -0
  89. package/components/Tabs/Tab.d.ts +34 -0
  90. package/components/Tabs/Tab.js +145 -0
  91. package/components/Tabs/Tabs.d.ts +24 -0
  92. package/components/Tabs/Tabs.js +107 -0
  93. package/components/Tabs/Tabs.spec.js +57 -0
  94. package/components/Tabs/Tabs.stories.js +165 -0
  95. package/components/Tabs/Tabs.styles.d.ts +18 -0
  96. package/components/Tabs/Tabs.styles.js +86 -0
  97. package/components/TextArea/TextArea.d.ts +48 -0
  98. package/components/TextArea/TextArea.js +211 -0
  99. package/components/TextArea/TextArea.stories.js +411 -0
  100. package/components/TextArea/TextArea.styles.d.ts +16 -0
  101. package/components/TextArea/TextArea.styles.js +150 -0
  102. package/components/Tooltip/Tooltip.d.ts +34 -0
  103. package/components/Tooltip/Tooltip.js +188 -0
  104. package/components/Tooltip/Tooltip.spec.js +26 -0
  105. package/components/Tooltip/Tooltip.stories.js +467 -0
  106. package/components/Tooltip/Tooltip.styles.d.ts +5 -0
  107. package/components/Tooltip/Tooltip.styles.js +57 -0
  108. package/components/components-index.spec.js +29 -0
  109. package/components/index.d.ts +20 -0
  110. package/components/index.js +20 -0
  111. package/css/__snapshots__/baseline.spec.js.snap +3 -0
  112. package/css/baseline.d.ts +14 -0
  113. package/css/baseline.js +420 -0
  114. package/css/baseline.spec.js +32 -0
  115. package/declarations.d.ts +1 -0
  116. package/docs/1.1-intro.stories.mdx +18 -0
  117. package/docs/1.2-getting-started.stories.mdx +111 -0
  118. package/docs/1.3-theming.stories.mdx +193 -0
  119. package/docs/1.4-development-guide.stories.mdx +448 -0
  120. package/docs/1.5-contribution-guide.stories.mdx +19 -0
  121. package/docs/1.6-solution-rationale.stories.mdx +155 -0
  122. package/docs/1.7-team-members.stories.mdx +138 -0
  123. package/docs/2.1-tokens-intro.stories.mdx +51 -0
  124. package/docs/2.2-colors.stories.mdx +124 -0
  125. package/docs/2.2-typography.stories.mdx +126 -0
  126. package/docs/2.4-others.stories.mdx +180 -0
  127. package/docs/2.5-icons.stories.mdx +64 -0
  128. package/docs/2.6-baselinecss.stories.mdx +439 -0
  129. package/docs/2.7-layout-breakpoints.stories.mdx +185 -0
  130. package/icons/ArrowDown.d.ts +5 -0
  131. package/icons/ArrowDown.js +21 -0
  132. package/icons/ArrowDownB.d.ts +5 -0
  133. package/icons/ArrowDownB.js +21 -0
  134. package/icons/ArrowLeft.d.ts +5 -0
  135. package/icons/ArrowLeft.js +24 -0
  136. package/icons/ArrowRight.d.ts +5 -0
  137. package/icons/ArrowRight.js +24 -0
  138. package/icons/Back.d.ts +5 -0
  139. package/icons/Back.js +21 -0
  140. package/icons/Bell.d.ts +5 -0
  141. package/icons/Bell.js +21 -0
  142. package/icons/BellOutline.d.ts +5 -0
  143. package/icons/BellOutline.js +21 -0
  144. package/icons/BinOutline.d.ts +5 -0
  145. package/icons/BinOutline.js +25 -0
  146. package/icons/Bookmark.d.ts +5 -0
  147. package/icons/Bookmark.js +21 -0
  148. package/icons/BookmarkOutline.d.ts +5 -0
  149. package/icons/BookmarkOutline.js +21 -0
  150. package/icons/BoyFace.d.ts +5 -0
  151. package/icons/BoyFace.js +25 -0
  152. package/icons/BoyFaceOutline.d.ts +5 -0
  153. package/icons/BoyFaceOutline.js +21 -0
  154. package/icons/Bump.d.ts +5 -0
  155. package/icons/Bump.js +33 -0
  156. package/icons/BumpTime.d.ts +5 -0
  157. package/icons/BumpTime.js +35 -0
  158. package/icons/CallOutline.d.ts +5 -0
  159. package/icons/CallOutline.js +24 -0
  160. package/icons/Camera.d.ts +5 -0
  161. package/icons/Camera.js +31 -0
  162. package/icons/CardPayment.d.ts +5 -0
  163. package/icons/CardPayment.js +21 -0
  164. package/icons/Certificate.d.ts +5 -0
  165. package/icons/Certificate.js +25 -0
  166. package/icons/Chart.d.ts +5 -0
  167. package/icons/Chart.js +27 -0
  168. package/icons/ChartImpression.d.ts +5 -0
  169. package/icons/ChartImpression.js +28 -0
  170. package/icons/ChartView.d.ts +5 -0
  171. package/icons/ChartView.js +27 -0
  172. package/icons/Chat.d.ts +5 -0
  173. package/icons/Chat.js +29 -0
  174. package/icons/Check.d.ts +5 -0
  175. package/icons/Check.js +18 -0
  176. package/icons/CircleCheck.d.ts +5 -0
  177. package/icons/CircleCheck.js +27 -0
  178. package/icons/CircleCopylink.d.ts +5 -0
  179. package/icons/CircleCopylink.js +23 -0
  180. package/icons/CircleFacebook.d.ts +5 -0
  181. package/icons/CircleFacebook.js +22 -0
  182. package/icons/CircleMessenger.d.ts +5 -0
  183. package/icons/CircleMessenger.js +19 -0
  184. package/icons/CircleSms.d.ts +5 -0
  185. package/icons/CircleSms.js +22 -0
  186. package/icons/CircleUser.d.ts +5 -0
  187. package/icons/CircleUser.js +24 -0
  188. package/icons/CircleViber.d.ts +5 -0
  189. package/icons/CircleViber.js +28 -0
  190. package/icons/CircleZalo.d.ts +5 -0
  191. package/icons/CircleZalo.js +63 -0
  192. package/icons/Clock.d.ts +5 -0
  193. package/icons/Clock.js +21 -0
  194. package/icons/Close.d.ts +5 -0
  195. package/icons/Close.js +21 -0
  196. package/icons/CtCoin.d.ts +5 -0
  197. package/icons/CtCoin.js +218 -0
  198. package/icons/Download.d.ts +5 -0
  199. package/icons/Download.js +25 -0
  200. package/icons/Edit.d.ts +5 -0
  201. package/icons/Edit.js +23 -0
  202. package/icons/EditAd.d.ts +5 -0
  203. package/icons/EditAd.js +22 -0
  204. package/icons/Ellipsis.d.ts +5 -0
  205. package/icons/Ellipsis.js +21 -0
  206. package/icons/EllipsisOutline.d.ts +5 -0
  207. package/icons/EllipsisOutline.js +21 -0
  208. package/icons/FacebookOutline.d.ts +5 -0
  209. package/icons/FacebookOutline.js +32 -0
  210. package/icons/Follow.d.ts +5 -0
  211. package/icons/Follow.js +38 -0
  212. package/icons/Gallery.d.ts +5 -0
  213. package/icons/Gallery.js +24 -0
  214. package/icons/Gift.d.ts +5 -0
  215. package/icons/Gift.js +24 -0
  216. package/icons/GiftOutline.d.ts +5 -0
  217. package/icons/GiftOutline.js +21 -0
  218. package/icons/Heart.d.ts +5 -0
  219. package/icons/Heart.js +23 -0
  220. package/icons/HeartOutline.d.ts +5 -0
  221. package/icons/HeartOutline.js +23 -0
  222. package/icons/HideAd.d.ts +5 -0
  223. package/icons/HideAd.js +22 -0
  224. package/icons/Hot.d.ts +5 -0
  225. package/icons/Hot.js +21 -0
  226. package/icons/House.d.ts +5 -0
  227. package/icons/House.js +21 -0
  228. package/icons/HouseOutline.d.ts +5 -0
  229. package/icons/HouseOutline.js +21 -0
  230. package/icons/Impression.d.ts +5 -0
  231. package/icons/Impression.js +56 -0
  232. package/icons/Info.d.ts +5 -0
  233. package/icons/Info.js +21 -0
  234. package/icons/InsertAd.d.ts +5 -0
  235. package/icons/InsertAd.js +21 -0
  236. package/icons/InternationalPayment.d.ts +5 -0
  237. package/icons/InternationalPayment.js +43 -0
  238. package/icons/Label.d.ts +5 -0
  239. package/icons/Label.js +24 -0
  240. package/icons/Loan.d.ts +5 -0
  241. package/icons/Loan.js +48 -0
  242. package/icons/Location.d.ts +5 -0
  243. package/icons/Location.js +25 -0
  244. package/icons/LocationOutline.d.ts +5 -0
  245. package/icons/LocationOutline.js +27 -0
  246. package/icons/MailOutline.d.ts +5 -0
  247. package/icons/MailOutline.js +32 -0
  248. package/icons/Medal.d.ts +5 -0
  249. package/icons/Medal.js +21 -0
  250. package/icons/Msg.d.ts +5 -0
  251. package/icons/Msg.js +42 -0
  252. package/icons/PageIndicator.d.ts +5 -0
  253. package/icons/PageIndicator.js +25 -0
  254. package/icons/PaymentInfo.d.ts +5 -0
  255. package/icons/PaymentInfo.js +42 -0
  256. package/icons/PercentMsg.d.ts +5 -0
  257. package/icons/PercentMsg.js +51 -0
  258. package/icons/PhoneOutline.d.ts +5 -0
  259. package/icons/PhoneOutline.js +21 -0
  260. package/icons/Profile.d.ts +5 -0
  261. package/icons/Profile.js +29 -0
  262. package/icons/Search.d.ts +5 -0
  263. package/icons/Search.js +21 -0
  264. package/icons/Selected.d.ts +5 -0
  265. package/icons/Selected.js +34 -0
  266. package/icons/SellFaster.d.ts +5 -0
  267. package/icons/SellFaster.js +32 -0
  268. package/icons/Shop.d.ts +5 -0
  269. package/icons/Shop.js +22 -0
  270. package/icons/ShopFree.d.ts +5 -0
  271. package/icons/ShopFree.js +49 -0
  272. package/icons/ShopOutline.d.ts +5 -0
  273. package/icons/ShopOutline.js +24 -0
  274. package/icons/SpeechBubbles.d.ts +5 -0
  275. package/icons/SpeechBubbles.js +25 -0
  276. package/icons/SpeechBubblesOutline.d.ts +5 -0
  277. package/icons/SpeechBubblesOutline.js +21 -0
  278. package/icons/Star.d.ts +5 -0
  279. package/icons/Star.js +22 -0
  280. package/icons/StarOutline.d.ts +5 -0
  281. package/icons/StarOutline.js +23 -0
  282. package/icons/Stats.d.ts +5 -0
  283. package/icons/Stats.js +25 -0
  284. package/icons/Sticky.d.ts +5 -0
  285. package/icons/Sticky.js +29 -0
  286. package/icons/Suitcase.d.ts +5 -0
  287. package/icons/Suitcase.js +25 -0
  288. package/icons/Tot.d.ts +5 -0
  289. package/icons/Tot.js +21 -0
  290. package/icons/UnhideOutline.d.ts +5 -0
  291. package/icons/UnhideOutline.js +25 -0
  292. package/icons/User.d.ts +5 -0
  293. package/icons/User.js +138 -0
  294. package/icons/UserOutline.d.ts +5 -0
  295. package/icons/UserOutline.js +22 -0
  296. package/icons/Users.d.ts +5 -0
  297. package/icons/Users.js +44 -0
  298. package/icons/Verification.d.ts +5 -0
  299. package/icons/Verification.js +22 -0
  300. package/icons/VerifiedHouse.d.ts +5 -0
  301. package/icons/VerifiedHouse.js +30 -0
  302. package/icons/ViewMore.d.ts +5 -0
  303. package/icons/ViewMore.js +25 -0
  304. package/icons/Wallet.d.ts +5 -0
  305. package/icons/Wallet.js +35 -0
  306. package/icons/Warning.d.ts +5 -0
  307. package/icons/Warning.js +33 -0
  308. package/icons/index.d.ts +88 -0
  309. package/icons/index.js +88 -0
  310. package/index.d.ts +25 -0
  311. package/index.js +25 -0
  312. package/index.spec.js +50 -0
  313. package/package.json +178 -0
  314. package/patterns/Dialog/Dialog.d.ts +32 -0
  315. package/patterns/Dialog/Dialog.js +130 -0
  316. package/patterns/Dialog/Dialog.stories.js +388 -0
  317. package/patterns/Dialog/Dialog.styles.d.ts +14 -0
  318. package/patterns/Dialog/Dialog.styles.js +194 -0
  319. package/patterns/InputGroup/InputGroup.d.ts +18 -0
  320. package/patterns/InputGroup/InputGroup.js +52 -0
  321. package/patterns/InputGroup/InputGroup.spec.js +58 -0
  322. package/patterns/InputGroup/InputGroup.stories.js +203 -0
  323. package/patterns/InputGroup/InputGroup.styles.d.ts +6 -0
  324. package/patterns/InputGroup/InputGroup.styles.js +83 -0
  325. package/patterns/Popup/Popup.d.ts +41 -0
  326. package/patterns/Popup/Popup.js +175 -0
  327. package/patterns/Popup/Popup.spec.js +74 -0
  328. package/patterns/Popup/Popup.stories.js +548 -0
  329. package/patterns/Popup/Popup.styles.d.ts +20 -0
  330. package/patterns/Popup/Popup.styles.js +230 -0
  331. package/patterns/SearchInput/SearchInput.d.ts +66 -0
  332. package/patterns/SearchInput/SearchInput.js +355 -0
  333. package/patterns/SearchInput/SearchInput.stories.js +505 -0
  334. package/patterns/SearchInput/SearchInput.styles.d.ts +2 -0
  335. package/patterns/SearchInput/SearchInput.styles.js +49 -0
  336. package/patterns/TagCloud/TagCloud.d.ts +37 -0
  337. package/patterns/TagCloud/TagCloud.js +120 -0
  338. package/patterns/TagCloud/TagCloud.spec.js +163 -0
  339. package/patterns/TagCloud/TagCloud.stories.js +364 -0
  340. package/patterns/TagCloud/TagCloud.styles.d.ts +10 -0
  341. package/patterns/TagCloud/TagCloud.styles.js +39 -0
  342. package/patterns/TagCloud/TagCloudMultiActive.d.ts +42 -0
  343. package/patterns/TagCloud/TagCloudMultiActive.js +116 -0
  344. package/patterns/TagCloud/TagCloudSingleActive.d.ts +29 -0
  345. package/patterns/TagCloud/TagCloudSingleActive.js +64 -0
  346. package/patterns/index.d.ts +5 -0
  347. package/patterns/index.js +5 -0
  348. package/patterns/patterns-index.spec.js +25 -0
  349. package/scripts/create-badge-svg.d.ts +2 -0
  350. package/scripts/template-icons-index.d.ts +2 -0
  351. package/scripts/template-svg-icon.d.ts +16 -0
  352. package/shared/global.d.ts +12 -0
  353. package/shared/global.js +17 -0
  354. package/storybook/components/Bar.d.ts +10 -0
  355. package/storybook/components/BorderRadius.d.ts +12 -0
  356. package/storybook/components/BorderWidth.d.ts +10 -0
  357. package/storybook/components/Gradient.d.ts +16 -0
  358. package/storybook/components/GuideImage.d.ts +22 -0
  359. package/storybook/components/Icons.d.ts +2 -0
  360. package/storybook/components/Member.d.ts +26 -0
  361. package/storybook/components/Shadow.d.ts +10 -0
  362. package/storybook/components/Square.d.ts +10 -0
  363. package/storybook/components/Swatch.d.ts +10 -0
  364. package/storybook/components/Transition.d.ts +10 -0
  365. package/storybook/components/Type.d.ts +42 -0
  366. package/storybook/main.d.ts +3 -0
  367. package/storybook/manager.d.ts +1 -0
  368. package/storybook/preview.d.ts +76 -0
  369. package/storybook/theme-clad.d.ts +2 -0
  370. package/storybook/utils/jsonStringify.d.ts +8 -0
  371. package/storybook/utils/loadFontsForStorybook.d.ts +1 -0
  372. package/theme/__snapshots__/chotot.spec.js.snap +262 -0
  373. package/theme/__snapshots__/mudah.spec.js.snap +161 -0
  374. package/theme/chotot.d.ts +555 -0
  375. package/theme/chotot.js +937 -0
  376. package/theme/chotot.spec.js +72 -0
  377. package/theme/index.d.ts +2 -0
  378. package/theme/index.js +7 -0
  379. package/theme/mudah.d.ts +214 -0
  380. package/theme/mudah.js +333 -0
  381. package/theme/mudah.spec.js +9 -0
  382. package/types.d.ts +14 -0
  383. package/utils/_normalizeArrowKey.d.ts +9 -0
  384. package/utils/_normalizeArrowKey.js +17 -0
  385. package/utils/_simulateChangeEvent.d.ts +9 -0
  386. package/utils/_simulateChangeEvent.js +34 -0
  387. package/utils/_simulateChangeEvent.spec.js +54 -0
  388. package/utils/cleanHtml.d.ts +8 -0
  389. package/utils/cleanHtml.js +14 -0
  390. package/utils/cleanHtml.spec.js +45 -0
  391. package/utils/createUniversalPortal.d.ts +10 -0
  392. package/utils/createUniversalPortal.js +22 -0
  393. package/utils/createUniversalPortal.server.spec.js +13 -0
  394. package/utils/createUniversalPortal.spec.js +13 -0
  395. package/utils/getBreakpointsValues.d.ts +10 -0
  396. package/utils/getBreakpointsValues.js +24 -0
  397. package/utils/getBreakpointsValues.test.js +89 -0
  398. package/utils/index.d.ts +5 -0
  399. package/utils/index.js +5 -0
  400. package/utils/noop.d.ts +8 -0
  401. package/utils/noop.js +9 -0
  402. package/utils/noop.spec.js +12 -0
  403. package/utils/sx.d.ts +3770 -0
  404. package/utils/sx.js +95 -0
  405. package/utils/sx.spec.js +53 -0
@@ -0,0 +1,193 @@
1
+ import { Meta } from '@storybook/addon-docs/blocks';
2
+
3
+ <Meta title="Overview/Theming" parameters={{ previewTabs: { canvas: { hidden: true } } }} />
4
+
5
+ # Building new screens with Clad UI
6
+
7
+ Clad UI uses the so-called [System UI Theme Specification](https://system-ui.com/theme/) as the standard format for design tokens. It is simple, well documented and has a [JS function helper](https://styled-system.com/css) to generate Linaria's consumable style object for `styled` and `css` tagged template functions.
8
+
9
+ ## Configuring the theme
10
+
11
+ Since we use **Linaria** and final product is static CSS, theming is done during compile time. To do this, we'll make use of [Babel's module aliases](https://github.com/tleunen/babel-plugin-module-resolver).
12
+
13
+ ```bash
14
+ # install this babel plugin as devDependencies
15
+ yarn add --dev babel-plugin-module-resolver
16
+ ```
17
+
18
+ In `babel.config.js`:
19
+
20
+ ```js
21
+ {
22
+ /* ... */
23
+ plugins: [
24
+ [
25
+ 'module-resolver',
26
+ {
27
+ root: ['.'],
28
+ alias: {
29
+ // point this special module name to your theme entry
30
+ '@clad-ui/theme': ['./src/theme/index.js'],
31
+ // If you only want to use the theme directly, configure it like so
32
+ '@clad-ui/theme': ['clad-ui/theme'], // default to 'chotot'
33
+ },
34
+ },
35
+ ],
36
+ ]
37
+ };
38
+ ```
39
+
40
+ Use everything from base theme in `src/theme/index.js`
41
+
42
+ ```js
43
+ // forward default export
44
+ export { default } from 'clad-ui/theme/chotot';
45
+ ```
46
+
47
+ ## Overriding the theme
48
+
49
+ In your `src/theme/index.js`, extends from the base theme like so:
50
+
51
+ ```js
52
+ import theme from 'clad-ui/theme/chotot';
53
+
54
+ // clone and override
55
+ const appTheme = {
56
+ ...theme,
57
+ // override spacing
58
+ space: [0, 4, 8, 16, 32, 64, 128, 256],
59
+ // override some colors
60
+ colors: {
61
+ ...theme.colors,
62
+ primary: '#D0021B',
63
+ critical: theme.colors.red3,
64
+ }
65
+ }
66
+
67
+ export default appTheme;
68
+ ```
69
+
70
+ ## Use the theme tokens
71
+
72
+ In your `Component.js`, use the theme tokens like so:
73
+
74
+ ```js
75
+ import { css } from 'linaria';
76
+ import theme from '@clad-ui/theme';
77
+
78
+ // get the theme object's values in template string placeholders
79
+ const componentClass = css`
80
+ margin: ${theme.space.md};
81
+ padding: ${theme.space.xs};
82
+ background-color: ${theme.colors.accent};
83
+ display: flex;
84
+ align-items: center;
85
+ `;
86
+ ```
87
+
88
+ ## The `sx` theme helper
89
+
90
+ Clad UI provides a theme-aware helper `sx` function that is based on [@styled-system/css](https://styled-system.com/css/). With this, styles can be done with JS objects where keys can be **regular camel-cased CSS properties** or **theming key aliases** where their values are direct reference from theme object.
91
+
92
+
93
+ ```js
94
+ import { css } from 'linaria';
95
+ // internally sx also import theme from @clad-ui/theme
96
+ import { sx } from 'clad-ui/utils';
97
+
98
+ // use the sx theme helper
99
+ const componentClass = css`
100
+ ${sx({
101
+ m: 5,
102
+ p: 3,
103
+ bg: 'accent',
104
+ })}
105
+ display: flex;
106
+ align-items: center;
107
+ `;
108
+ ```
109
+
110
+ ### Theme Keys
111
+
112
+ The following are object-based CSS properties and aliases with their equivalent keys from theme object:
113
+
114
+ Property | Theme Key
115
+ ---|---
116
+ `fontFamily` | `fonts`
117
+ `fontSize` | `fontSizes`
118
+ `fontWeight` | `fontWeights`
119
+ `lineHeight` | `lineHeights`
120
+ `letterSpacing` | `letterSpacings`
121
+ `color` | `colors`
122
+ `backgroundColor`, `bg` | `colors`
123
+ `margin`, `m` | `space`
124
+ `marginTop`, `mt` | `space`
125
+ `marginRight`, `mr` | `space`
126
+ `marginBottom`, `mb` | `space`
127
+ `marginLeft`, `ml` | `space`
128
+ `marginX`, `mx` | `space`
129
+ `marginY`, `my` | `space`
130
+ `padding`, `p` | `space`
131
+ `paddingTop`, `pt` | `space`
132
+ `paddingRight`, `pr` | `space`
133
+ `paddingBottom`, `pb` | `space`
134
+ `paddingLeft`, `pl` | `space`
135
+ `paddingX`, `px` | `space`
136
+ `paddingY`, `py` | `space`
137
+ `top` | `space`
138
+ `bottom` | `space`
139
+ `left` | `space`
140
+ `right` | `space`
141
+ `border` | `borders`
142
+ `borderTop` | `borders`
143
+ `borderRight` | `borders`
144
+ `borderBottom` | `borders`
145
+ `borderLeft` | `borders`
146
+ `borderColor` | `colors`
147
+ `borderWidth` | `borderWidths`
148
+ `borderStyle` | `borderStyles`
149
+ `borderRadius` | `radii`
150
+ `boxShadow` | `shadows`
151
+ `textShadow` | `shadows`
152
+ `zIndex` | `zIndices`
153
+ `width` | `sizes`
154
+ `minWidth` | `sizes`
155
+ `maxWidth` | `sizes`
156
+ `height` | `sizes`
157
+ `minHeight` | `sizes`
158
+ `maxHeight` | `sizes`
159
+ `size` (`width` & `height`) | `sizes`
160
+
161
+ > From: https://styled-system.com/css/#theme-keys
162
+
163
+ ## Babel module-resolver plugin and ESLint import plugin
164
+
165
+ We're using [ESLint import plugin](https://github.com/benmosher/eslint-plugin-import) to help early check invalid imports. It will send false errors for module imports that are remapped with babel-plugin-module-resolver. To make ESLint correctly validate module aliases, we need to install this additional npm package `eslint-import-resolver-babel-module` and configure `.eslintrc` like so:
166
+
167
+ ```js
168
+ {
169
+ "root": true,
170
+ // eslint-plugin-import is configured in eslint-preset-chotot
171
+ "extends": ["chotot"],
172
+ "settings": {
173
+ // module resolver settings for eslint-plugin-import
174
+ "import/resolver": {
175
+ // letting the import plugin use eslint-import-resolver-babel-module
176
+ // and automatically read the module remapping from babel config
177
+ "babel-module": {}
178
+ }
179
+ }
180
+ }
181
+ ```
182
+
183
+ If we use TypeScript or `tsc` for type checking (there is a `jsconfig.json` or `tsconfig.json` in project's root folder), an additional module mapping should be added to `[jt]sconfig.json` file at `compilerOptions.paths`:
184
+
185
+ ```json
186
+ {
187
+ "compilerOptions": {
188
+ /* ... */
189
+ "paths": {
190
+ "@clad-ui/theme": ["./src/theme/index.js"]
191
+ }
192
+ }
193
+ ```
@@ -0,0 +1,448 @@
1
+ import { Meta } from '@storybook/addon-docs/blocks';
2
+
3
+ <Meta
4
+ title="Overview/In-depth Guide"
5
+ parameters={{ previewTabs: { canvas: { hidden: true } } }}
6
+ />
7
+
8
+ # In-depth Styling with Clad UI and Linaria
9
+
10
+ > From: https://github.com/callstack/linaria/blob/master/docs/BASICS.md
11
+
12
+ ### The `css` tag
13
+
14
+ The `css` tag allows you to create simple class names:
15
+
16
+ ```js
17
+ import { css } from 'linaria';
18
+
19
+ // Create a class name
20
+ const title = css`
21
+ font-size: 24px;
22
+ font-weight: bold;
23
+ `;
24
+
25
+ function Heading() {
26
+ // Pass it to a component
27
+ return <h1 className={title}>This is a title</h1>;
28
+ }
29
+ ```
30
+
31
+ Here the value of the `title` variable will be a unique class name which you can pass in the `className` prop. This code is equivalent to the following CSS and JavaScript.
32
+
33
+ CSS:
34
+
35
+ ```css
36
+ .title {
37
+ font-size: 24px;
38
+ font-weight: bold;
39
+ }
40
+ ```
41
+
42
+ JavaScript:
43
+
44
+ ```js
45
+ function Heading() {
46
+ return <h1 className="title">This is a title</h1>;
47
+ }
48
+ ```
49
+
50
+ ### The `styled` tag
51
+
52
+ The `styled` tag allows you to create a React component with some styles already applied.
53
+
54
+ You write `styled` followed by the name of the HTML tag you want to use, e.g. `styled.div`, `styled.a`, `styled.button`, `styled.h3` etc.
55
+
56
+ ```js
57
+ import { styled } from 'linaria/react';
58
+
59
+ // Create a styled component
60
+ const Title = styled.h1`
61
+ font-size: 24px;
62
+ font-weight: bold;
63
+ `;
64
+
65
+ function Heading() {
66
+ // Use the styled component
67
+ return <Title>This is a title</Title>;
68
+ }
69
+ ```
70
+
71
+ This reduces quite a bit of boilerplate code you had to write when you manually created the class name and applied it to a tag. This code is equivalent to the following CSS and JavaScript.
72
+
73
+ CSS:
74
+
75
+ ```css
76
+ .title {
77
+ font-size: 24px;
78
+ font-weight: bold;
79
+ }
80
+ ```
81
+
82
+ JavaScript:
83
+
84
+ ```js
85
+ function Title(props) {
86
+ return <h1 {...props} className="title" />;
87
+ }
88
+
89
+ function Heading() {
90
+ return <Title>This is a title</Title>;
91
+ }
92
+ ```
93
+
94
+ Apart from the reduced boilerplate code, this also makes it easier to do prop based styling which you'll cover later in the guide.
95
+
96
+ ### Nesting, pseudo-elements and pseudo-selectors
97
+
98
+ You can nest selectors, pseudo-elements and pseudo-selectors similar to Sass, thanks to [stylis](https://github.com/thysultan/stylis.js).
99
+
100
+ For example, to change the color of a button on hover, you'll write something like this:
101
+
102
+ ```js
103
+ const Button = styled.button`
104
+ color: black;
105
+
106
+ &:hover {
107
+ color: blue;
108
+ }
109
+ `;
110
+ ```
111
+
112
+ The value of `&` refers to the class name. This code is equivalent to the following CSS:
113
+
114
+ ```css
115
+ .button {
116
+ color: black;
117
+ }
118
+
119
+ .button:hover {
120
+ color: blue;
121
+ }
122
+ ```
123
+
124
+ You can nest pseudo-elements as well as other selectors:
125
+
126
+ ```js
127
+ const Thing = styled.div`
128
+ color: black;
129
+
130
+ &::after {
131
+ /* .thing::after */
132
+ content: '🌟';
133
+ }
134
+
135
+ h3 {
136
+ /* .thing h3 */
137
+ color: tomato;
138
+ }
139
+
140
+ .code {
141
+ /* .thing .code */
142
+ color: #555;
143
+ }
144
+
145
+ & + & {
146
+ /* .thing + .thing */
147
+ background: yellow;
148
+ }
149
+
150
+ &.bordered {
151
+ /* .thing.bordered */
152
+ border: 1px solid black;
153
+ }
154
+
155
+ .parent & {
156
+ /* .parent .thing */
157
+ color: blue;
158
+ }
159
+ `;
160
+ ```
161
+
162
+ You can also nest media queries:
163
+
164
+ ```js
165
+ const Thing = styled.div`
166
+ color: black;
167
+
168
+ @media (min-width: 200px) {
169
+ color: blue;
170
+ }
171
+ `;
172
+ ```
173
+
174
+ This is equivalent to the following CSS:
175
+
176
+ ```css
177
+ .thing {
178
+ color: black;
179
+ }
180
+
181
+ @media (min-width: 200px) {
182
+ .thing {
183
+ color: blue;
184
+ }
185
+ }
186
+ ```
187
+
188
+ ### Keyframe animations
189
+
190
+ You can write keyframe declarations right inside the template literal:
191
+
192
+ ```js
193
+ const Box = styled.div`
194
+ height: 200px;
195
+ width: 200px;
196
+ background-color: tomato;
197
+ animation: spin 2s linear infinite;
198
+
199
+ @keyframes spin {
200
+ from {
201
+ transform: rotate(0deg);
202
+ }
203
+
204
+ to {
205
+ transform: rotate(360deg);
206
+ }
207
+ }
208
+ `;
209
+ ```
210
+
211
+ Here `spin` will be replaced with a unique string to scope the animation to the class name.
212
+
213
+ ## Interpolations
214
+
215
+ Like normal template literals, you can interpolate other expressions inside a template literal tagged with `css` or `styled`.
216
+
217
+ If you try to interpolate an invalid value, you'll get an error at build-time.
218
+
219
+ ### Basic interpolations
220
+
221
+ You can interpolate variables declared in the same file as well as imported variables:
222
+
223
+ ```js
224
+ const fontSize = 16;
225
+
226
+ const Title = styled.h1`
227
+ font-size: ${fontSize}px;
228
+ `;
229
+ ```
230
+
231
+ Here, the `fontSize` variable will be evaluated at build time and inserted into the generated CSS.
232
+
233
+ You can also call functions while interpolating:
234
+
235
+ ```js
236
+ const Button = styled.button`
237
+ background-color: ${colors.primary};
238
+
239
+ &:hover {
240
+ background-color: ${darken(0.2, colors.primary)};
241
+ }
242
+ `;
243
+ ```
244
+
245
+ ### Object interpolations
246
+
247
+ You can also interpolate object styles. It's converted to a CSS string before inserting to the stylesheet:
248
+
249
+ ```js
250
+ const cover = {
251
+ position: 'absolute',
252
+ top: 0,
253
+ right: 0,
254
+ bottom: 0,
255
+ left: 0,
256
+ opacity: 1,
257
+ minHeight: 360,
258
+
259
+ '@media (min-width: 200px)': {
260
+ minHeight: 480,
261
+ },
262
+ };
263
+
264
+ const Title = styled.h1`
265
+ font-size: 24px;
266
+
267
+ ${cover};
268
+ `;
269
+ ```
270
+
271
+ This is equivalent to the following CSS:
272
+
273
+ ```js
274
+ const Title = styled.h1`
275
+ font-size: 24px;
276
+
277
+ position: absolute;
278
+ top: 0;
279
+ right: 0;
280
+ bottom: 0;
281
+ left: 0;
282
+ opacity: 1;
283
+ min-height: 360px;
284
+
285
+ '@media (min-width: 200px)': {
286
+ minheight: 480px;
287
+ }
288
+ `;
289
+ ```
290
+
291
+ The interpolated object can have nested selectors, media queries, pseudo-selectors and pseudo-elements. Numeric values which require a unit (e.g. `minHeight` in the above example) will be appended with `px` unless specified.
292
+
293
+ ### Prop based styles
294
+
295
+ When writing React components using the `styled` syntax, you can write styles based on the component's props. These values will use [CSS variables](https://developer.mozilla.org/en-US/docs/Web/CSS/Using_CSS_variables) under the hood and can change dynamically in runtime.
296
+
297
+ For dynamic prop based styles, pass a function to the interpolation:
298
+
299
+ ```js
300
+ const Title = styled.h1`
301
+ color: ${props => (props.primary ? 'tomato' : 'black')};
302
+ `;
303
+ ```
304
+
305
+ The function will be called with the component's props as an argument when it is rendered. Here, the color of the title will be automatically updated whenever the value of the `primary` prop changes.
306
+
307
+ ### Referring to another component or class name
308
+
309
+ You can interpolate a styled component or a class name to refer to it. For example:
310
+
311
+ ```js
312
+ const title = css`
313
+ font-size: 24px;
314
+ color: black;
315
+ `;
316
+
317
+ const Paragraph = styled.p`
318
+ font-size: 16px;
319
+ color: #555;
320
+ `;
321
+
322
+ const Article = styled.article`
323
+ /* when referring to class names, prepend a dot (.) */
324
+ .${title} {
325
+ font-size: 36px;
326
+ }
327
+
328
+ /* when referring to a component, interpolate it as a selector */
329
+ ${Paragraph} {
330
+ font-size: 14px;
331
+ margin: 16px;
332
+ }
333
+ `;
334
+ ```
335
+
336
+ ## Overriding styles
337
+
338
+ If you want to override few styles on a styled component you defined earlier, you can do so by wrapping it in the `styled(..)` tag:
339
+
340
+ ```js
341
+ const Button = styled.button`
342
+ font-size: 14px;
343
+ background-color: tomato;
344
+ padding: 8px;
345
+ box-shadow: 0 0.5px 0.3px rgba(0, 0, 0, 0.1);
346
+ `;
347
+
348
+ const LargeButton = styled(Button)`
349
+ font-size: 18px;
350
+ padding: 16px;
351
+ `;
352
+ ```
353
+
354
+ Here, when you use `LargeButton`, it'll have all the same styles as `Button` except the `font-size` and `padding` which we overrode.
355
+
356
+ ## Styling custom components
357
+
358
+ You can use the `styled(..)` tag to style any component as long as they accept a `className` and a `style` prop:
359
+
360
+ ```js
361
+ function CoolComponent({ className, style, ...rest }) {
362
+ return (
363
+ <div className={className} style={style}>
364
+ {...}
365
+ </div>
366
+ );
367
+ }
368
+
369
+ const StyledCoolComponent = styled(CoolComponent)`
370
+ background-color: tomato;
371
+ `;
372
+ ```
373
+
374
+ The `style` prop is necessary to apply CSS variables. If you're using a component library that doesn't support passing a `style` prop, you can wrap it in a `div` (or any other tag that makes sense) to apply it:
375
+
376
+ ```js
377
+ import { Card } from 'some-library';
378
+
379
+ function CustomCard({ className, style, ...rest }) {
380
+ return (
381
+ <div style={style}>
382
+ <Card className={className} {...rest} />
383
+ </div>
384
+ );
385
+ }
386
+
387
+ const StyledCustomCard = styled(CustomCard)`
388
+ margin: 16px;
389
+ height: ${props => props.height}px;
390
+ `;
391
+ ```
392
+
393
+ If you want to use linaria classname, which is generated for component, you can get it as last item from `className` prop:
394
+
395
+ ```js
396
+ function CoolComponent({ className, style, variant, ...rest }) {
397
+ const allClasses = className.split(' ');
398
+ const linariaClassName = allClasses[allClasses.length - 1];
399
+
400
+ const classes = cx(
401
+ className,
402
+ variant === 'primary' && `${linariaClassName}--primary`
403
+ );
404
+
405
+ return (
406
+ <div className={classes} style={style}>
407
+ {...}
408
+ </div>
409
+ );
410
+ }
411
+
412
+ const StyledCoolComponent = styled(CoolComponent)`
413
+ background-color: tomato;
414
+
415
+ &--primary {
416
+ background-color: yellow;
417
+ }
418
+ `;
419
+ ```
420
+
421
+ ## Adding global styles
422
+
423
+ Normally, the styles are scoped to specific components. But sometimes you may need to write some global styles, for example, to normalize browser inconsistencies, define a font-family etc.
424
+
425
+ You can do the following to generate unscoped global styles:
426
+
427
+ ```js
428
+ export const globals = css`
429
+ :global() {
430
+ html {
431
+ box-sizing: border-box;
432
+ }
433
+
434
+ *,
435
+ *:before,
436
+ *:after {
437
+ box-sizing: inherit;
438
+ }
439
+
440
+ @font-face {
441
+ font-family: 'MaterialIcons';
442
+ src: url(../assets/fonts/MaterialIcons.ttf) format('truetype');
443
+ }
444
+ }
445
+ `;
446
+ ```
447
+
448
+ It's not possible to use dynamic prop based styles inside global styles.
@@ -0,0 +1,19 @@
1
+ import { Meta } from '@storybook/addon-docs/blocks';
2
+
3
+ <Meta
4
+ title="Overview/Contributor Guide"
5
+ parameters={{ previewTabs: { canvas: { hidden: true } } }}
6
+ />
7
+
8
+ # Clad UI Development Guide
9
+
10
+ ## Building new components quick start
11
+
12
+ TODO:
13
+
14
+ - Use `cx` instead of `classnames`
15
+ - Use `polished` for computed styles
16
+ - Write up sample component structure
17
+ + When to use static class-based styles
18
+ + When to use dynamic prop-based styles
19
+ - Write up component story file guide