@yosgo/swap-ui
v1.0.141
Published
SWAP UI Framework. www.swap.work
Downloads
77
Readme
關於 SWAP-UI
基於 @material-ui/core 的前端框架來開發 SWAP 專屬的介面框架,這個框架的特性如下:
- 標準化元件。封裝 SWAP 服務內常見的介面場景,減少開發時重新定義相同的佈局、函式...並讓介面保持一致
- 易於使用。儘量不需要再寫額外的輔助函式或是過於多層的元件包裝就能使用,避免 Material-ui 多層包裝的缺點
想要參考 swap-ui 可以透過以下方式:
- 直接訪問 swap 的網站 www.swap.work
- 瀏覽 Storybook
即將新增
- SWAPModal: 增加支援多步驟的 Modal 視窗
- SWAPBanner: 顯示於頁面上的警示訊息
- SWAPCopyField:可複製文字至剪貼簿的輸入框
- SWAPIncomeAndExpenseTypeField:依據工作內容提供所得類型的建議
- SWAPPage: 讓用戶在完整的頁面中完成某件事情
- SWAPAnnotatedLayout: 用於帳戶設定頁面中,解釋各類型設定
安裝
# peerDependencies
$ yarn add react react-dom styled-components @material-ui/core @material-ui/icons
# install swap-ui
$ yarn add @yosgo/swap-ui
開發
# 產生一個元件範本
$ yarn generate NewComponentName
# 使用本機的 storybook 來瀏覽元件
$ yarn storybook
發佈
# 發佈套件到 NPM 上
$ npm publish
# 更新 gh-page 上的 Storybook
$ yarn deploy-storybook
# 確認發佈狀態
$ npm show @yosgo/swap-ui