Skip to content

Commit

Permalink
docs: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mym0404 committed Apr 27, 2024
1 parent 442d498 commit ab37b0e
Show file tree
Hide file tree
Showing 4 changed files with 86 additions and 1 deletion.
2 changes: 1 addition & 1 deletion docs/docs/navi/_category_.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"label": "Package - Navi",
"position": 10,
"position": 11,
"link": {
"type": "generated-index",
"description": "Navi 패키지 사용법"
Expand Down
8 changes: 8 additions & 0 deletions docs/docs/social/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"label": "Package - Social",
"position": 10,
"link": {
"type": "generated-index",
"description": "Social 패키지 사용법"
}
}
42 changes: 42 additions & 0 deletions docs/docs/social/intro.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
sidebar_position: 1
---


import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';


# 시작하기

## 시작하기 전에

[`Core`패키지에 대한 의존성을 설치](/docs/install-core)하고 관련된 [플랫폼별 설정](/docs/install-android)이 완료되어야 합니다.

## 시작하기

`social` 패키지는 카카오톡 프로필을 불러오거나 친구 목록을 가져올 수 있는 패키지입니다.

내부적으로 카카오 SDK의 `friend``talk` SDK를 사용합니다.

[공식 문서](https://developers.kakao.com/docs/latest/ko/kakaotalk-social/common)를 참고해주시기 바랍니다.

## 설치하기

<Tabs>
<TabItem value="npm" label="NPM" default>
```shell
npm install --save @react-native-kakao/user @react-native-kakao/social
```
</TabItem>
<TabItem value="yarn" label="Yarn">
```shell
yarn add @react-native-kakao/{user, social}
```
</TabItem>
<TabItem value="expo" label="Expo">
```shell
npx expo install @react-native-kakao/user @react-native-kakao/social
```
</TabItem>
</Tabs>
35 changes: 35 additions & 0 deletions docs/docs/social/navigate-destination.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
sidebar_position: 5
---

# 내 카카오톡 프로필 가져오기
## 내 카카오톡 프로필 가져오기

[공식 문서](https://developers.kakao.com/docs/latest/ko/kakaotalk-social/android#get-profile)

:::info
카카오 로그인 활성화 및 동의 항목에 프로필 정보, 닉네임, 프로필 사진이 동의되어 있어야 API및 관련 응답이 모두 채워져서 반환됩니다.
:::

## Usage

`navigateTo()` 함수를 이용해 카카오내비 앱을 실행시켜 경로안내를 시작할 수 있습니다.

이 함수는 다음과 같이 정의됩니다.

```tsx
export function navigateTo(params: {
destination: KakaoNaviLocation;
option?: KakaoNaviOption;
viaList?: KakaoNaviLocation[];
openWebInstallUrlIfNaviAppNotAvailable?: boolean;
})
```

- `destination`: 목적지 정보입니다. 필수값입니다.
- `option`: 옵션입니다.
- `viaList`: 경유지 리스트입니다.
- `openWebInstallUrlIfNaviAppNotAvailable`: 카카오내비 앱을 실행할 수 없다면 자동으로 설치 화면으로 보낼지 여부입니다.
기본값은 `true`입니다.

옵션에 대한 자세한 설명은 [공식 문서](https://developers.kakao.com/docs/latest/ko/kakaonavi/android#set-parameter)를 참고해주세요.

0 comments on commit ab37b0e

Please sign in to comment.