# @lasbe/react-modal

> 누구나 쉽게 사용할 수 있는 리액트 모달 라이브러리입니다.

Latest version **1.0.1** (published 2024-05-06) · 0 weekly downloads

## Install

```sh
npm install @lasbe/react-modal
pnpm add @lasbe/react-modal
yarn add @lasbe/react-modal
bun add @lasbe/react-modal
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2024-05-06 |
| First published | 2023-09-06 |
| Weekly downloads | 0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 14.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | LasBe |
| Maintainers | lasbe |
| Keywords | react, modal, useModal, animation |

## Links

- npm: https://www.npmjs.com/package/@lasbe/react-modal
- npm.io page: https://npm.io/package/@lasbe/react-modal

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 1.0.1 (latest) — 2024-05-06
- 1.0.0 — 2024-05-06
- 0.1.2 — 2023-09-06
- 0.1.1 — 2023-09-06
- 0.1.0 — 2023-09-06

## README

# @lasbe/react-modal

[NPM](https://www.npmjs.com/package/@lasbe/react-modal)  
[Github](https://github.com/LasBe-code/react-modal)  
[Blog](https://lasbe.tistory.com/)  
선언적으로 모달을 사용할 수 있는 패키지입니다.  
구성과 디자인을 최대한 자유롭게 변경할 수 있습니다.  
기본적으로 모달의 배경인 dimmer와 스크롤 방지 기능이 포함 되어 있습니다.

### install

```bash
$ npm i @lasbe/react-modal
```

### example

1. `ModalProvider`를 상위 컴포넌트에 감아줍니다.

```tsx
root.render(
  <ModalProvider>
    <App />
  </ModalProvider>,
);
```

2. `useModal()` 훅을 이용해 모달을 여닫는 함수를 이용합니다.  
   `ModalStyle`을 import 하여 기본 스타일을 사용할 수 있습니다.

```tsx
import React from 'react';
import { useModal, ModalStyle } from '@lasbe/react-modal';

function App() {
  const { openModal, closeModal } = useModal();
  return (
    <button
      onClick={() =>
        openModal({
          content: (
            <>
              <ModalStyle.Header>
                <ModalStyle.Title>Header</ModalStyle.Title>
              </ModalStyle.Header>
              <ModalStyle.Body>Body</ModalStyle.Body>
              <ModalStyle.Footer>
                <ModalStyle.Button color="gray" onClick={closeModal}>
                  Close
                </ModalStyle.Button>
                <ModalStyle.Button onClick={closeModal}>Submit</ModalStyle.Button>
              </ModalStyle.Footer>
            </>
          ),
        })
      }
    >
      OPEN MODAL
    </button>
  );
}

export default App;
```

### props

1. `<ModalProvider />`

```ts
type ModalProvidertype = {
  children: React.ReactElement;
  options?: {
    // 모달 배경 스타일 지정
    dimmer?: React.CSSProperties;
    // 모달 body 스타일 지정
    body?: React.CSSProperties;
    // 모달 여닫을 때 애니메이션 적용 여부
    useAnimation?: boolean;
  };
};
```

2. `openModal()`

```ts
type OpenModalType = {
  // Modal에 띄울 요소
  content: React.ReactNode;
  options?: {
    // 모달 배경 스타일 지정
    dimmer?: React.CSSProperties;
    // 모달 body 스타일 지정
    body?: React.CSSProperties;
    // 모달 여닫을 때 애니메이션 적용 여부
    useAnimation?: boolean;
  };
};
```

---
_Source: https://npm.io/package/@lasbe/react-modal · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._