1.1.10 • Published 2 years ago
simple-react-ui-library
這是一個簡單方便的ui library 解決常常重複刻畫的UI或方便的component 例如: Modal, Flexbox , themeProvider , sidebar等等... 目前版本暫時只有modal 與 flexbox
這個 Modal 組件是一個自定義的彈出視窗,可以根據您的需求進行樣式調整。以下是教學:
npm 先下載:
npm i simple-react-ui-library
引入Modal:
import {Modal} from 'simple-react-ui-library';
使用Modal:
<Modal
isOpen={isOpen}
width="400px"
height="400px"
borderRadius="5px"
closeButtonFuc={handleCloseModal}
customStyle={{borderRadius: '30px'}}
>
<div>您的 Modal 內容</div>
</Modal>
以下是您可以自定義的 props:
| Prop | Type | Required | Default | Description |
|---|
| isOpen | Boolean | No | false | 控制Modal 是否顯示 |
| customStyle | Object | No | {} | 自定義需要的style,例如:boxShadow |
| width 或 w | String | No | "600px" | 設定Modal 的寬度 |
| height 或 h | String | No | "600px" | 設定Modal 的高度 |
| padding 或 p | String | No | "10px" | 設定Modal 的內邊距 |
| borderRadius | String | No | "10px" | 設定Modal 的邊框圓角 |
| disableOverlayClose | Boolean | No | false | 設定Modal的背景遮罩是否可以關閉modal true為不可以 |
| overlayBgColor | String | No | "rgba(0, 0, 0, 0.5)" | 設定Modal 背景遮罩的顏色 |
| backgroundColor | String | No | "white" | 設定Modal 的背景顏色 |
| textColor | String | No | "black" | 設定Modal 內容的文字顏色 |
| showCloseButton | Boolean | No | true | 控制是否顯示右上角的關閉按鈕 |
| closeButtonFuc | Function | No | () => {} | 點擊關閉按鈕時觸發的函數 |
| children | ReactNode | No | null | Modal 中的內容 |
| animationType | Enum | No | "none" | 控制 Modal 動畫類型,可選值:fadeIn、scale、none |
引入FlexBox:
import {FlexBox} from 'simple-react-ui-library';
使用:
<FlexBox
width="400px"
height="400px"
>
<div>您的 Modal 內容</div>
</FlexBox>
以下是您可以自定義的 props:
| Prop | Type | Required | Default | Description |
|---|
| width 或 w | String | No | "100px" | 設定Modal 的寬度 |
| height 或 h | String | No | "50px" | 設定Modal 的高度 |
| customStyle | Object | No | {} | 自定義需要的style,例如:boxShadow |
| padding 或 p | String | No | "10px" | 設定Modal 的內邊距 |
| margin 或 m | String | No | "10px" | 設定Modal 的margin |
| justifyContent | String | No | "flex-start" | 設定設定justifyContent |
| alignItems | String | No | "flex-start" | 設定alignItems |
| fDirec | String | No | "unset" | 設定flex-direction |
| fBasis | String | No | "unset" | 設定flex-basis |
| fGrow | String | No | "unset" | 設定flex-grow |
| fWrap | String | No | "unset" | 設定flex-wrap |
| children | ReactNode | No | null | Modal 中的內容 |