# vue-kakao-sdk

> Kakao SDK Plugin for Vue.js

Latest version **0.2.5** (published 2021-11-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install vue-kakao-sdk
pnpm add vue-kakao-sdk
yarn add vue-kakao-sdk
bun add vue-kakao-sdk
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.5 |
| Published | 2021-11-19 |
| First published | 2021-02-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 7.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | eggplantiny |
| Maintainers | eggplantiny |
| Keywords | vue, vue-kakao, vue-kakao-plugin, kakao |

## Links

- npm: https://www.npmjs.com/package/vue-kakao-sdk
- Repository: https://github.com/eggplantiny/vue-kakao-sdk
- Issues: https://github.com/eggplantiny/vue-kakao-sdk/issues
- npm.io page: https://npm.io/package/vue-kakao-sdk

## Dependencies (1)

- [@types/kakao-js-sdk](https://npm.io/package/@types/kakao-js-sdk.md) latest

## Recent versions

- 0.2.5 (latest) — 2021-11-19
- 0.2.4 — 2021-11-09
- 0.2.3 — 2021-11-09
- 0.2.2 — 2021-11-09
- 0.2.1 — 2021-11-09
- 0.1.7 — 2021-11-09
- 0.2.0 — 2021-08-06
- 0.1.9 — 2021-08-06
- 0.1.6 — 2021-08-06
- 0.1.5 — 2021-08-06
- 0.1.4 — 2021-08-06
- 0.1.3 — 2021-08-06
- 0.1.2 — 2021-08-06
- 0.1.1 — 2021-08-06
- 0.1.0 — 2021-08-06
- … 2 more at https://npm.io/package/vue-kakao-sdk/versions

## README

# vue-kakao-sdk

[Kakao SDK](https://developers.kakao.com/tool) plugin wrapped with Vue.js

Now you can easily use Kakao SDK with Vue.js

Just intialize plugin and type 

```js
this.$kakao

// or

window.Kakao
```

## Intall

### Yarn or NPM
```
# yarn
yarn add vue-kakao-sdk

# npm
npm install vue-kakao-sdk
```

### CDN
```html
<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/vue"></script>
<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/vue-kakao-sdk@0.1.6/dist/js/vue-kakao-sdk.min.js"></script>
<script type="text/javascript">
    const apiKey = 'Your Kakao API Javascript Key'
    Vue.use(window.VueKakaoSdk,{ apiKey: apiKey })
</script>
```

## How to use this plugin? 🧐

You can play an example on [codepan](https://codepen.io/sigran0/pen/WNopPZw)

### Vue2.x
```js
//  main.js
import Vue from 'vue'
import VueKakaoSdk from 'vue-kakao-sdk'

const apiKey = 'Your Kakao API Javascript Key'

// You have to pass your "Kakao SDK Javascript apiKey"
Vue.use(VueKakaoSdk, { apiKey })
```

```js
//  App.vue

// then you can call kakao sdk with
// this.$kakao or window.Kakao
// in Vue Component
export default {
  ...
  methods: {
    sendKakaoLink ({ objectType, content, buttons } = {}) {
      objectType = objectType || this.Link.objectType
      content = content || this.Link.content
      buttons = buttons || this.Link.buttons

      this.$kakao.Link.sendDefault({
        objectType,
        content,
        buttons
      })
    },
    loginWithKakao () {
      this.$kakao.Auth.login({
        success: function(authObj) {
          alert(JSON.stringify(authObj))
        },
        fail: function(err) {
          alert(JSON.stringify(err))
        },
      })
    },
    shareStoryWeb () {
      this.$kakao.Story.share({
        url: 'https://github.com/eggplantiny/vue-kakao-sdk',
        text: 'Test story share with vue-kakao-sdk'
      })
    }
  }
}
```

## If you wanna use this plugin on Vue3
Please use [Vue3-kakao-sdk](https://www.npmjs.com/package/vue3-kakao-sdk)

## Options

|Key|Description|Type|Default|
|------|---|---|---|
|* apiKey|Your Kakao SDK Javascript Key|String|* required|
|scriptUrl|Link of kakao SDK|String|https://developers.kakao.com/sdk/js/kakao.min.js|
|scriptId|Script ID of kakao SDK|String|kakao_script|
|callback|Callback function of script loaded|Function|null|

## Support Typescript
### If you wanna use Typescript
Add `vue-kakao-sdk/types` to the `compilerOptions.types` section of your project's `tsconfig.json` file:
```json
{
  "compilerOptions": {
    "types": [
      "@types/kakao-js-sdk"
    ]
  }
}
```

## Author

[eggplantiny](https://github.com/eggplantiny)

## License
MIT

---
_Source: https://npm.io/package/vue-kakao-sdk · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._