npm

Need private packages and team management tools?Check out npm Orgs. »

vue-daum-postcode

0.7.0 • Public • Published

Vue Daum Postcode

VueJS Downloads Version License

Daum 우편번호 서비스를 기반으로 작업된 Vue Component 입니다.

Installation

npm install vue-daum-postcode --save

Demo

Usage

vue-daum-postcode는 umd로 빌드되어있어서 원하시는 방식으로 사용가능합니다.

ES6

ES6 환경에서는 다음과 같이 사용할 수 있습니다.

import Vue from "vue"
import VueDaumPostcode from "vue-daum-postcode"
 
Vue.use(VueDaumPostcode)

기본 태그는 vue-daum-postcode이고, 다음과 같이 사용가능합니다.

<template>
  <vue-daum-postcode />
</template>

만약에 기본 태그를 다른 이름으로 변경하려면 다음과 같이 설정하시면 됩니다.

import Vue from "vue"
import VueDaumPostcode from "vue-daum-postcode"
 
Vue.use(VueDaumPostcode, {
  name: "vue-something-daum-postcode"
})

Globals

Webpack과 같은 번들러를 사용하지 않는 경우 다음과 같이 사용할 수 있습니다. 전역으로 설정할 경우 Vue.use(...)는 필요없습니다. 또한 window.VueDaumPostcode를 통해 라이브러리에 직접 접근할 수 있습니다.

<html>
<head>
  ...
</head>
<body>
  <div id="app">
    <vue-daum-postcode />
  </div>
  <script src="//cdn.jsdelivr.net/npm/vue/dist/vue.j"></script> 
  <script src="//cdn.jsdelivr.net/gh/wan2land/vue-daum-postcode/dist/index.js"></script> 
  <script>
    new Vue({
      el: '#app'
    })
  </script> 
</body>
</html>

Nuxt Framework

Nuxt 프레임워크를 사용한다면, 설정파일(nuxt.config.js)의 modules 항목에 다음 내용을 추가합니다.

{
  modules: [
    'vue-daum-postcode/nuxt'
  ],
}

마찬가지로, 기본 태그는 vue-daum-postcode입니다. 이를 변경하려면 다음과 같이 설정하시면 됩니다.

{
  modules: [
    ['vue-daum-postcode/nuxt', { name: "vue-something-daum-postcode" }],
  ],
}

Components 만 사용

특정 화면에서 컴퍼넌트로 이용하고 싶다면 다음과 같이 작성하시면 됩니다.

import { VueDaumPostcode } from "vue-daum-postcode"
// const { VueDaumPostcode } = require("vue-daum-postcode")
 
export default {
  components: {
    VueDaumPostcode,
  },
}

Props

이름 타입 설명 기본값
q String 검색어 ""
animation Boolean Daum 우편번호, 생성자속성에서 animation. false
no-autoMapping Boolean Daum 우편번호, 생성자속성에서 autoMapping, 기본값을 true에서 false로 조정. false
no-shorthand Boolean Daum 우편번호, 생성자속성에서 shorthand, 기본값을 true에서 false로 조정. false
please-read-guide Number Daum 우편번호, 생성자속성에서 pleaseReadGuide. 0
please-read-guide-timer Number Daum 우편번호, 생성자속성에서 pleaseReadGuideTimer. 1.5
max-suggest-items Number Daum 우편번호, 생성자속성에서 maxSuggestItems. 10
show-more-h-name Boolean Daum 우편번호, 생성자속성에서 showMoreHName. false
hide-map-btn Boolean Daum 우편번호, 생성자속성에서 hideMapBtn. false
hide-eng-btn Boolean Daum 우편번호, 생성자속성에서 hideEngBtn. false
always-show-eng-addr Boolean Daum 우편번호, 생성자속성에서 alwaysShowEngAddr. false
zonecode-only Boolean Daum 우편번호, 생성자속성에서 zonecodeOnly. false
theme object Daum 우편번호, 생성자속성에서 theme. {}

Events

이름 설명
complete Daum 우편번호, 속성에서 oncomplete.

License

Vue 소스코드 자체의 라이센스는 MIT입니다. 기반 우편번호는 Daum 우편번호 서비스를 이용하고 있습니다.

install

npm i vue-daum-postcode

Downloadsweekly downloads

294

version

0.7.0

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability