Skip to content

Commit 2090bcb

Browse files
zeakdclaude
andauthored
docs: 패키지 README 추가 + CHANGELOG 병합 + oxfmt 범위 수정 (#148)
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent ef50634 commit 2090bcb

3 files changed

Lines changed: 98 additions & 1 deletion

File tree

.husky/pre-commit

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
pnpm exec oxlint --ignore-path .gitignore --ignore-pattern 'website/public/0.1.0/**' --ignore-pattern 'website/public/0.0.13/**'
2-
pnpm exec oxfmt --check --ignore-path .gitignore packages/ website/src/
2+
pnpm exec oxfmt --check --ignore-path .gitignore packages/react-naver-maps/src/ packages/astro-component-docs/src/ website/src/
33
pnpm exec tsc -b

packages/react-naver-maps/CHANGELOG.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,40 @@
1313
- useKVO, useControlledKVO: KVO 속성 감시 및 동기화
1414
- Suspense 지원: React 19 use()와 스크립트 로딩 통합
1515
- 성능 개선: KVO 구독 제거, 렌더 시점 dirty diff
16+
17+
## 0.1.5
18+
19+
### Patch Changes
20+
21+
- 228aa73: Fix promise caching and error handling in loadNavermapsScript, replace deprecated lodash packages with lodash-es
22+
23+
## 0.1.4
24+
25+
### Patch Changes
26+
27+
- b8ae0a7: 신규 client key 이름 ncpKeyId를 사용가능하도록 업데이트
28+
29+
## 0.1.3
30+
31+
### Patch Changes
32+
33+
- 00ff206: update naver host openapi -> oapi
34+
35+
## 0.1.2
36+
37+
### Patch Changes
38+
39+
- update package.json
40+
41+
## 0.1.1
42+
43+
### Patch Changes
44+
45+
- deprecated alert을 위한 RenderAfterNavermapsLoaded 추가
46+
47+
## 0.1.0
48+
49+
### Major Changes
50+
51+
- 50c7d39: release v0.1.0
52+
- 894ccb1: change react support version, use jsx-runtime
Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# react-naver-maps
2+
3+
[Naver Maps JavaScript API v3](https://navermaps.github.io/maps.js.ncp/)의 Non-Official React 컴포넌트 라이브러리입니다.
4+
5+
네이버맵의 기본 기능을 최대한 유지하면서, React에서 다루기 쉬운 인터페이스를 제공합니다.
6+
7+
- React 19 전용, 런타임 의존성 없음 (peerDeps: react, react-dom)
8+
- TypeScript 지원 (`@types/navermaps` 기반)
9+
- Suspense 기반 스크립트 로딩
10+
11+
## 설치
12+
13+
```bash
14+
npm install react-naver-maps
15+
```
16+
17+
React 19 이상이 필요합니다.
18+
19+
## 사용법
20+
21+
```tsx
22+
import {
23+
NavermapsProvider,
24+
Container,
25+
NaverMap,
26+
Marker,
27+
} from 'react-naver-maps';
28+
29+
function App() {
30+
return (
31+
<NavermapsProvider ncpKeyId="YOUR_NCP_KEY_ID">
32+
<Container style={{ width: '100%', height: '400px' }}>
33+
<NaverMap
34+
defaultCenter={{ lat: 37.5666, lng: 126.9784 }}
35+
defaultZoom={16}
36+
>
37+
<Marker defaultPosition={{ lat: 37.5666, lng: 126.9784 }} />
38+
</NaverMap>
39+
</Container>
40+
</NavermapsProvider>
41+
);
42+
}
43+
```
44+
45+
## 0.2의 새 기능
46+
47+
- **오버레이 컴포넌트 11종**: NaverMap, Marker, InfoWindow, GroundOverlay, CustomOverlay, Circle, Rectangle, Ellipse, Polygon, Polyline, Container
48+
- **Layer 컴포넌트 3종**: CadastralLayer, StreetLayer, TrafficLayer
49+
- **useOverlay**: 바닐라 OverlayView 상속 객체를 React 생명주기에 연결. 네이버맵 공식 [CustomOverlay 패턴](https://navermaps.github.io/maps.js.ncp/docs/tutorial-6-CustomOverlay.html)을 그대로 사용 가능
50+
- **useListener**: 네이버맵 네이티브 이벤트 escape hatch. 인라인 함수를 전달해도 리스너 재구독 없음
51+
- **Suspense 지원**: 스크립트 로딩을 React 19 `use()`와 통합
52+
- **성능 개선**: KVO 구독 제거, 렌더 시점 dirty diff로 드래그 중 불필요한 리렌더 방지
53+
54+
## 문서
55+
56+
[zeakd.github.io/react-naver-maps](https://zeakd.github.io/react-naver-maps)
57+
58+
## 라이선스
59+
60+
MIT

0 commit comments

Comments
 (0)