跳到內容
開始使用

開始使用

慈濟 CIS UIKit 是一套給所有慈濟網站共用的設計規則和元件。 顏色、文字大小、按鈕、卡片、整頁的排法都只做一次,每個網站拿來用就好;每個網站再選用一個「主題」(一組有名字的外觀設定,例如 Default、Green Natural),就有那個主題的顏色。

這套 UIKit 解決什麼問題

章節連結:這套 UIKit 解決什麼問題

慈濟有很多網站,以前每個網站各自設計按鈕、卡片和顏色,同一件事常常有好幾種做法,改一次也要每個網站各改一次。

UIKit 把這些共通的部分收在一起:

  • 一套規則:顏色、文字、間距都有名字和固定的值,大家講同一套話。
  • 一套元件:按鈕、搜尋列、文章卡片、頁尾…每一個都只有一份,所有網站一起用。
  • 每個網站選用一個主題:主題只換顏色等外觀數值,元件和版面都不用重做。
你是…先看這裡
美編(設計)基礎 Foundations和主題:顏色與字體的規則
網站的編輯、致遠(廠商)元件和範本:有哪些現成的東西可以用
想提出修改的人如何參與修改:誰核可什麼、一次修改的五個步驟
工程下方的「給工程師」

看不懂的詞可以查用詞。

頁首有五個地方,任何一頁都可以直接切換:

  • 搜尋(放大鏡):搜尋整本手冊,也可以按 Ctrl+K(Mac 是 ⌘+K)。
  • 色彩模式(月亮或太陽):在淺色和深色之間切換。淺色時是月亮,按下去換成深色;深色時是太陽,按下去換成淺色。還沒按過之前,手冊跟著你裝置的設定。
  • 主題(調色盤):打開選單選一個主題(例如 Default、Green Natural),手冊裡所有元件和範本的顏色就換成那個主題的樣子。按鈕右下角的小圓點是目前主題的主色。
  • GitHub:這套 UIKit 在 GitHub 上的 repository,會在新分頁打開。

每個主題都有淺色和深色,主題和色彩模式可以自由搭配。主題只會換掉元件和範本的顏色,手冊本身(頁首、側欄、文字)不會變成那個主題的顏色;色彩模式則是整本手冊一起換成淺色或深色。你的選擇會被記住,下次打開還是同一個。手機上,主題也可以在選單(右上角的三條線)最下方選。

元件頁目前介紹的是舊的 tc-* 元件(已凍結,不再修改)。每個元件頁最後的「給工程師」一段有安裝方式、程式範例和 API 表。

HeroUI 的元件(套用 HeroUI 的慈濟主題 tzuchi,顏色和手冊的 Default 主題相同;淺色和深色)在 Storybook(工程師用來逐一檢查元件狀態的工具網站)。Storybook 目前只收錄 HeroUI 的元件,還沒有 tc-* 元件的頁面。在本機用 pnpm run heroui:storybook 開啟。

開啟 Storybook

手冊和 Storybook 是兩個分開的網站,要部署到哪裡還沒有決定。在本機預覽手冊時,頁首和這裡的 Storybook 連結會找不到頁面,請另外開 Storybook。