Skip to content

Commit aaa86ec

Browse files
scarf005jungpaeng
andauthored
docs: mention missing OverlayProvider requirement (#196)
* docs: mention missing `OverlayProvider` requirement * docs: Update README-ko_kr.md --------- Co-authored-by: Yongbeen Im <[email protected]>
1 parent 62e2304 commit aaa86ec

File tree

2 files changed

+26
-0
lines changed

2 files changed

+26
-0
lines changed

README-ko_kr.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,19 @@ npm install overlay-kit
1414

1515
## 예제
1616

17+
먼저, `OverlayProvider`를 추가해주세요:
18+
19+
```
20+
import { OverlayProvider } from 'overlay-kit';
21+
22+
const app = createRoot(document.getElementById('root')!);
23+
app.render(
24+
<OverlayProvider>
25+
<App />
26+
</OverlayProvider>
27+
);
28+
```
29+
1730
### 간단한 오버레이 열기
1831

1932
`overlay.open`을 사용하면 오버레이를 간단하게 열고 닫을 수 있어요.

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,19 @@ npm install overlay-kit
1414

1515
## Example
1616

17+
First, add provider:
18+
19+
```tsx
20+
import { OverlayProvider } from 'overlay-kit';
21+
22+
const app = createRoot(document.getElementById('root')!);
23+
app.render(
24+
<OverlayProvider>
25+
<App />
26+
</OverlayProvider>
27+
);
28+
```
29+
1730
### Opening Simple Overlays
1831

1932
You can easily open and close overlays using `overlay.open`.

0 commit comments

Comments
 (0)