Skip to content

sunwjy/daum-postcode-webview

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

18 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

daum-postcode-webview

Daum Postcode 기능을 더욱 빠르고 효율적으로 앱에 통합해보세요. 🎯

daum-postcode-webview는 앱 개발 시 Daum Postcode를 간편하게 테스트하기 위해 만들어졌어요. 쿼리를 통해 옵션을 전달하면, 자동으로 구성이 완료된 HTML을 생성해 제공합니다. 제공된 HTML을 웹뷰에 올리고 이제 앱 로직에만 신경쓰세요.

examples에서 앱 통합 예시 코드를 확인할 수 있습니다.

데모
데모 버전은 Cloudflare Workers(Wrangler)로 배포되어 있으며, 일일 10만 회 요청 제한이 있습니다.

사용가능한 파라미터

onComplete

두개 중 택 1. 둘다 전달될 경우 scheme을 따릅니다.

  • library: 사용할 라이브러리

기본값은 'console_log' 로, 결과를 콘솔에 표시하며 지원하는 라이브러리 목록은 아래 참조

  • scheme: 리다이렉트 할 custom URL Scheme

유효하지 않은 경우 무시됨


Daum Postcode 옵션

Daum Postcode 공식문서

  • minWidth: 최소 너비
  • width: 고정 너비

기본값은 500이지만 웹뷰에 적합한 UI를 위해 이 프로젝트에선 '100%' 로 설정되어 있음

  • height: 고정 높이

기본값은 500이지만 웹뷰에 적합한 UI를 위해 이 프로젝트에선 '100%' 로 설정되어 있음

  • animation: 애니메이션 효과
  • focusInput: 찾기 후 검색어 입력박스에 focus(PC only)
  • autoMappingRoad, autoMappingJibun: 매핑된 주소가 여러개일 경우 '선택 안함' 선택 가능
  • shorthand: '시', '도' 부분을 축약 표시(한글만)
  • pleaseReadGuide: 검색결과가 많을 시 검색바 아래의 가이드 영역을 강조
  • pleaseReadGuideTimer: 가이드 영역 강조 시간. pleaseReadGuide 옵션과 같이 사용되는 옵션
  • maxSuggestItems: 검색바 아래에 뜨는 추천의 최대 갯수
  • showMoreHName: 행정동 정보를 좀 더 많이 보여주는 옵션
  • hideMapBtn: 검색 결과의 '지도' 버튼 가리기

다른 링크로 이동하기에 웹뷰에서 사용 시 주의 필요

  • hideEngBtn: 검색 결과의 '영문보기' 버튼 가리기
  • alwaysShowEngAddr: 검색 결과의 한글과 영문 주소를 동시에 볼 수 있게 해주는 기능
  • submitMode: history 제어가 어려울 경우에 사용
  • useBannerLink: 하단 배너에 '가이드페이지'로 이동하는 링크 표시 옵션

다른 링크로 이동하기에 웹뷰에서 사용 시 주의 필요


theme - hex code만 지원합니다(# 생략가능, url encoding 주의)

예시) '%23FFFFFF', 'FFFFFF', '%23ffffff', 'FFF' ...

  • bgColor: 바탕 배경색
  • searchBgColor: 검색창 배경색
  • contentBgColor: 본문 배경색(검색결과,결과없음,첫화면,검색서제스트)
  • pageBgColor: 페이지 배경색
  • textColor: 기본 글자색
  • queryTextColor: 검색창 글자색
  • postcodeTextColor: 우편번호 글자색
  • emphTextColor: 강조 글자색
  • outlineColor: 테두리

기본 옵션과 제약 등은 공식문서에서 확인하길 권장합니다. - Daum Postcode 공식문서

예시) https://daum-postcode-webview.sun-jaeyun98.workers.dev/?library=flutter_inappwebview&animation=true&shorthand=false&pleaseReadGuide=true&maxSuggestItems=5&hideMapBtn=true&bgColor=333333&textColor=%23FF8000

지원 예정 라이브러리

  • react-native-webview

배포 옵션

wrangler 또는 serverless(지원 예정)을 선택해 선호하는 플랫폼에 직접 배포할 수 있어요.
프로덕션 배포 시에는 테스트 완료한 HTML을 직접 다운로드해 CDN을 통해 제공하는 걸 추천해요.

TODO

  • 예제 추가(WKWebView, WebView(Android))
  • 테스트 작성
  • serverless 프레임워크 지원
  • Contribution Guide
  • 플랫폼별 배포 가이드

About

Daum Postcode 기능을 더욱 빠르고 효율적으로 앱에 통합해보세요. 🎯

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors