2.0.4 • Published 1 year ago
@corasan/modal-sheet v2.0.4
Installation
npm install @corasan/modal-sheet
yarn add @corasan/modal-sheet
bun add @corasan/modal-sheetUsage
First, wrap your application with the ModalSheetProvider component.
import { ModalSheetProvider } from '@corasan/modal-sheet';
function App() {
return (
<ModalSheetProvider>
<YourApp />
</ModalSheetProvider>
);
}Use refs to expand and minimize the modal sheet.
import { ModalSheetStackRef, ModalSheetStack } from '@corasan/modal-sheet';
function YourComponent() {
const modalRef = useRef<ModalSheetStackRef>()
return (
<View style={{ flex: 1, justifyContent: 'center', alignItems: 'center' }}>
<Butto title="Open Modal" onClick={() => modalRef.current.open())} />
<ModalSheetStack ref={modalRef} name="modal-drawer">
<View style={{ flex: 1 }}>
<View style={{ flexDirection: "row", justifyContent: "center" }}>
<Text style={{ fontWeight: "500", fontSize: 18 }}>Title</Text>
</View>
<View
style={{
paddingVertical: 40,
alignItems: "center",
justifyContent: "center",
}}
>
<Button
title="Close Modal"
onPress={() => {
modalRef.current.dismiss();
}}
/>
</View>
</View>
</ModalSheetStack>
</View>
);
}Components
ModalSheetStack
The ModalSheetStack component is a modal sheet that can be opened and dismissed. It creates a modal sheet effect similar to the iOS modal sheet.
Props
| Name | Type | Default | Description | Required | |
|---|---|---|---|---|---|
| ref | React.RefObject\ | - | Ref for the modal sheet | Yes | |
| name | string | - | The name of the modal sheet | Yes | |
| children | ReactNode | - | The children components | Kinda yeah | |
| containerStyle | string | - | Styles for the modal sheet container | No | |
| noHandle | boolean | false | Hide the handle | No | |
| onDismiss | () => void | - | Callback when the modal sheet is dismissed | No | |
| enableDragToDismiss | boolean | true | Enable dragging to dismiss the modal sheet | No | |
| <!-- | backdropColor | string | "black" | The color of the backdrop | No |
| backdropOpacity | number | 0.4 | The opacity of the backdrop | No | --> |
Methods
| Name | Type | Description |
|---|---|---|
| open | () => void | Open the modal sheet |
| dismiss | () => void | Dismiss the modal sheet |
2.0.3
1 year ago
2.0.2
1 year ago
2.0.4
1 year ago
2.0.0-rc.17
1 year ago
2.0.0-rc.18
1 year ago
2.0.0-rc.16
1 year ago
2.0.1
1 year ago
2.0.0
1 year ago
2.0.0-rc.15
1 year ago
2.0.0-rc.14
1 year ago
2.0.0-rc.13
2 years ago
2.0.0-rc.11
2 years ago
2.0.0-rc.12
2 years ago
2.0.0-rc.10
2 years ago
2.0.0-rc.9
2 years ago
2.0.0-rc.8
2 years ago
2.0.0-rc.5
2 years ago
2.0.0-rc.6
2 years ago
2.0.0-rc.7
2 years ago
2.0.0-rc.3
2 years ago
2.0.0-rc.4
2 years ago
2.0.0-rc.2
2 years ago
2.0.0-rc.0
2 years ago
2.0.0-rc.1
2 years ago
1.4.2
2 years ago
1.4.1
2 years ago
1.4.0
2 years ago
1.3.0
2 years ago
1.2.0
2 years ago
1.1.0
2 years ago
1.0.1
2 years ago
1.0.0
2 years ago