Skip to content

Commit 66dd432

Browse files
NormalticNormaltic
committed
docs: update 'daum' keyword to 'kakao'
1 parent 003172d commit 66dd432

1 file changed

Lines changed: 22 additions & 22 deletions

File tree

‎README.md‎

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# react-daum-postcode
22

3-
Daum 우편번호 검색 서비스를 React 환경에서 간편하게 이용할 수 있습니다.
3+
Kakao(구 Daum) 우편번호 검색 서비스를 React 환경에서 간편하게 이용할 수 있습니다.
44

55
## Install
66

@@ -17,11 +17,11 @@ yarn add react
1717

1818
## Embed
1919

20-
`DaumPostcodeEmbed` 컴포넌트를 사용하여, 우편번호 검색 서비스를 임베드 방식으로 사용할 수 있습니다.
20+
`KakaoPostcodeEmbed` 컴포넌트를 사용하여, 우편번호 검색 서비스를 임베드 방식으로 사용할 수 있습니다.
2121

2222
```javascript
2323
import React from 'react';
24-
import DaumPostcodeEmbed from 'react-daum-postcode';
24+
import KakaoPostcodeEmbed from 'react-daum-postcode';
2525

2626
const Postcode = () => {
2727
const handleComplete = (data) => {
@@ -41,37 +41,37 @@ const Postcode = () => {
4141
console.log(fullAddress); // e.g. '서울 성동구 왕십리로2길 20 (성수동1가)'
4242
};
4343

44-
return <DaumPostcodeEmbed onComplete={handleComplete} {...props} />;
44+
return <KakaoPostcodeEmbed onComplete={handleComplete} {...props} />;
4545
};
4646
```
4747

48-
`DaumPostcodeEmbed` 컴포넌트에 다음 우편번호 서비스의 생성자 및 임베드 설정값 등을 `props`로 전달할 수 있습니다. 전달하지 않은 설정값은 다음 우편번호 서비스의 기본 설정을 따라갑니다.
48+
`KakaoPostcodeEmbed` 컴포넌트에 카카오 우편번호 서비스의 생성자 및 임베드 설정값 등을 `props`로 전달할 수 있습니다. 전달하지 않은 설정값은 카카오 우편번호 서비스의 기본 설정을 따라갑니다.
4949

5050
| name | type | default | description
5151
|:----:|:----:|:-------:|:-----------|
52-
| scriptUrl | `string` | [CURRENT_URL](https://t1.kakaocdn.net/mapjsapi/bundle/postcode/prod/postcode.v2.js) | Daum 우편번호 서비스의 스크립트 주소입니다.|
53-
| onComplete | `function` | `undefined` | 우편번호 검색이 끝났을 때 사용자가 선택한 정보를 받아올 콜백함수입니다. 주소 데이터의 구성은 [Daum 가이드](http://postcode.map.daum.net/guide)를 참고해주세요. |
54-
| onSearch | `function` | `undefined` | 주소를 검색할 경우 실행되는 콜백함수입니다. 검색 결과 정보의 구성은 [Daum 가이드](http://postcode.map.daum.net/guide)를 참고해주세요. |
52+
| scriptUrl | `string` | [CURRENT_URL](https://t1.kakaocdn.net/mapjsapi/bundle/postcode/prod/postcode.v2.js) | Kakao 우편번호 서비스의 스크립트 주소입니다.|
53+
| onComplete | `function` | `undefined` | 우편번호 검색이 끝났을 때 사용자가 선택한 정보를 받아올 콜백함수입니다. 주소 데이터의 구성은 [Kakao 가이드](http://postcode.map.daum.net/guide)를 참고해주세요. |
54+
| onSearch | `function` | `undefined` | 주소를 검색할 경우 실행되는 콜백함수입니다. 검색 결과 정보의 구성은 [Kakao 가이드](http://postcode.map.daum.net/guide)를 참고해주세요. |
5555
| onClose | `function` | `undefined` | 검색 결과를 선택하여, 서비스가 닫힐 때 실행되는 콜백함수입니다. |
56-
| onResize | `function` | `undefined` | 검색 결과로 인해, 우편번호 서비스의 화면 크기가 변경될 때 호출되는 콜백함수입니다. 변경된 화면 정보의 구성은 [Daum 가이드](http://postcode.map.daum.net/guide)를 참고해주세요. |
56+
| onResize | `function` | `undefined` | 검색 결과로 인해, 우편번호 서비스의 화면 크기가 변경될 때 호출되는 콜백함수입니다. 변경된 화면 정보의 구성은 [Kakao 가이드](http://postcode.map.daum.net/guide)를 참고해주세요. |
5757
| className | `string` | `undefined` | 우편번호 검색창을 감싸는 최상위 엘리먼트에 적용할 클래스 이름입니다. |
5858
| style | `object` | `{ width:"100%", height:400 }` | 우편번호 검색창을 감싸는 최상위 엘리먼트에 적용할 스타일입니다. |
5959
| defaultQuery | `string` | `undefined` | 우편번호 검색창에 기본으로 입력할 검색어입니다.
6060
| autoClose | `boolean` | `true` | 우편번호 검색 완료시 자동 닫힘 여부입니다. 주소를 선택하면, 최상위 엘리먼트를 돔에서 제거합니다. |
61-
| errorMessage | `ReactNode` | `<p>현재 Daum 우편번호 서비스를 이용할 수 없습니다. 잠시 후 다시 시도해주세요.</p>` | 우편번호 서비스 스크립트 로드에 실패했을 때 나타낼 에러 메세지 입니다. |
61+
| errorMessage | `ReactNode` | `<p>현재 Kakao 우편번호 서비스를 이용할 수 없습니다. 잠시 후 다시 시도해주세요.</p>` | 우편번호 서비스 스크립트 로드에 실패했을 때 나타낼 에러 메세지 입니다. |
6262

63-
기타 Daum 우편번호 생성자 속성들을 동일한 이름으로 props를 전달할 수 있습니다. 속성값에 대해서는 [Daum 우편번호 서비스 가이드](http://postcode.map.daum.net/guide#attributes)를 참고해주세요.
63+
기타 Kakao 우편번호 생성자 속성들을 동일한 이름으로 props를 전달할 수 있습니다. 속성값에 대해서는 [Kakao 우편번호 서비스 가이드](http://postcode.map.daum.net/guide#attributes)를 참고해주세요.
6464

6565
## Popup
6666

67-
`useDaumPostcodePopup` hook 을 사용하여, 반환받은 함수를 통해 우편번호 검색 서비스를 팝업 방식으로 이용할 수 있습니다.
67+
`useKakaoPostcodePopup` hook 을 사용하여, 반환받은 함수를 통해 우편번호 검색 서비스를 팝업 방식으로 이용할 수 있습니다.
6868

6969
```javascript
7070
import React from 'react';
71-
import { useDaumPostcodePopup } from 'react-daum-postcode';
71+
import { useKakaoPostcodePopup } from 'react-daum-postcode';
7272

7373
const Postcode = () => {
74-
const open = useDaumPostcodePopup(scriptUrl);
74+
const open = useKakaoPostcodePopup(scriptUrl);
7575

7676
const handleComplete = (data) => {
7777
let fullAddress = data.address;
@@ -102,27 +102,27 @@ const Postcode = () => {
102102
};
103103
```
104104

105-
`useDaumPostcodePopup` 실행 시 우편번호 서비스의 스크립트 주소를 전달할 수 있습니다. 반환한 함수를 실행할 때 다음 우편번호 서비스의 생성자 및 팝업 설정값을 전달할 수 있습니다. 전달하지 않은 설정값은 다음 우편번호 서비스의 기본 설정을 따라갑니다.
105+
`useKakaoPostcodePopup` 실행 시 우편번호 서비스의 스크립트 주소를 전달할 수 있습니다. 반환한 함수를 실행할 때 카카오 우편번호 서비스의 생성자 및 팝업 설정값을 전달할 수 있습니다. 전달하지 않은 설정값은 카카오 우편번호 서비스의 기본 설정을 따라갑니다.
106106

107107
| name | type | default | description
108108
|:----:|:----:|:-------:|:-----------|
109-
| scriptUrl | `string` | [CURRENT_URL](https://t1.kakaocdn.net/mapjsapi/bundle/postcode/prod/postcode.v2.js) | Daum 우편번호 서비스의 스크립트 주소입니다.|
110-
| onComplete | `function` | `undefined` | 우편번호 검색이 끝났을 때 사용자가 선택한 정보를 받아올 콜백함수입니다. 주소 데이터의 구성은 [Daum 가이드](http://postcode.map.daum.net/guide)를 참고해주세요. |
111-
| onSearch | `function` | `undefined` | 주소를 검색할 경우 실행되는 콜백함수입니다. 검색 결과 정보의 구성은 [Daum 가이드](http://postcode.map.daum.net/guide)를 참고해주세요. |
109+
| scriptUrl | `string` | [CURRENT_URL](https://t1.kakaocdn.net/mapjsapi/bundle/postcode/prod/postcode.v2.js) | Kakao 우편번호 서비스의 스크립트 주소입니다.|
110+
| onComplete | `function` | `undefined` | 우편번호 검색이 끝났을 때 사용자가 선택한 정보를 받아올 콜백함수입니다. 주소 데이터의 구성은 [Kakao 가이드](http://postcode.map.daum.net/guide)를 참고해주세요. |
111+
| onSearch | `function` | `undefined` | 주소를 검색할 경우 실행되는 콜백함수입니다. 검색 결과 정보의 구성은 [Kakao 가이드](http://postcode.map.daum.net/guide)를 참고해주세요. |
112112
| onClose | `function` | `undefined` | 검색 결과를 선택하여, 서비스가 닫힐 때 실행되는 콜백함수입니다. |
113-
| onResize | `function` | `undefined` | 검색 결과로 인해, 우편번호 서비스의 화면 크기가 변경될 때 호출되는 콜백함수입니다. 변경된 화면 정보의 구성은 [Daum 가이드](http://postcode.map.daum.net/guide)를 참고해주세요. |
113+
| onResize | `function` | `undefined` | 검색 결과로 인해, 우편번호 서비스의 화면 크기가 변경될 때 호출되는 콜백함수입니다. 변경된 화면 정보의 구성은 [Kakao 가이드](http://postcode.map.daum.net/guide)를 참고해주세요. |
114114
| width | `string\|number` | `undefined` | 우편번호 검색창의 가로 너비입니다. |
115115
| height | `string\|number` | `undefined` | 우편번호 검색창의 세로 높이입니다. |
116116
| defaultQuery | `string` | `undefined` | 우편번호 검색창에 기본으로 입력할 검색어입니다. |
117117
| top | `string\|number` | `undefined` | 팝업의 Y 위치를 나타내는 값입니다. |
118118
| left | `string\|number` | `undefined` | 팝업의 X 위치를 나타내는 값입니다. |
119-
| popupTitle | `string` | `undefined` | 팝업창의 상태표시줄에 나오는 Title 값을 지정할 수 있습니다. 전달하지 않을 경우, 다음 우편번호의 기본 설정 문구가 출력됩니다. |
119+
| popupTitle | `string` | `undefined` | 팝업창의 상태표시줄에 나오는 Title 값을 지정할 수 있습니다. 전달하지 않을 경우, 카카오 우편번호의 기본 설정 문구가 출력됩니다. |
120120
| popupKey | `string` | `undefined` | 팝업창의 key 입니다. 전달하지 않을 경우 매번 새창이 열리게 됩니다. |
121121
| autoClose | `boolean` | `true` | 우편번호 검색 완료시 자동 닫힘 여부입니다. 주소를 선택하면 팝업창이 닫힙니다.
122122

123-
기타 Daum 우편번호 생성자 속성들을 동일한 이름으로 props를 전달할 수 있습니다. 속성값에 대해서는 [Daum 우편번호 서비스 가이드](http://postcode.map.daum.net/guide#attributes)를 참고해주세요.
123+
기타 Kakao 우편번호 생성자 속성들을 동일한 이름으로 props를 전달할 수 있습니다. 속성값에 대해서는 [Kakao 우편번호 서비스 가이드](http://postcode.map.daum.net/guide#attributes)를 참고해주세요.
124124

125125

126126
## 안내
127127

128-
`react-daum-postcode`는 Daum 우편번호 서비스와 독립적으로 제작된 패키지입니다. React환경에서 발생하는 `react-daum-postcode`의 버그는 패키지 레포지터리의 [이슈트래커](https://github.com/kimminsik-bernard/react-daum-postcode/issues)에 말씀해주세요. 만약 Daum 우편번호 서비스 자체의 문제라고 생각하신다면, 다음 우편번호 서비스의 [FAQ](https://github.com/daumPostcode/QnA/blob/master/README.md)와 [이슈트래커](https://github.com/daumPostcode/QnA/issues)를 참조해주세요.
128+
`react-daum-postcode`는 Kakao 우편번호 서비스와 독립적으로 제작된 패키지입니다. React환경에서 발생하는 `react-daum-postcode`의 버그는 패키지 레포지터리의 [이슈트래커](https://github.com/kimminsik-bernard/react-daum-postcode/issues)에 말씀해주세요. 만약 Kakao 우편번호 서비스 자체의 문제라고 생각하신다면, 카카오 우편번호 서비스의 [FAQ](https://github.com/daumPostcode/QnA/blob/master/README.md)와 [이슈트래커](https://github.com/daumPostcode/QnA/issues)를 참조해주세요.

0 commit comments

Comments
 (0)