카카오스토리 플러그인들과 관련된 함수들이 포함되어 있습니다.
Methods
-
<static> cleanup()
-
카카오스토리 공유 버튼과 관련된 리소스를 해제합니다.
-
<static> createFollowButton(settings)
-
지정한 Element를 클릭할 때 카카오스토리 채널로부터 소식을 받도록 합니다.
Parameters:
Name Type Description settings
Object 카카오스토리 소식받기 버튼과 관련된 설정을 key/value로 전달합니다.
Properties
Name Type Argument Default Description container
String | HTMLElement DOM Element 또는 Element의 ID Selector를 넘기면, 해당 Element를 클릭할 때 지정한 채널을 구독합니다.
id
String 소식을 받을 카카오스토리 채널 ID. ex) kakao
showFollowerCount
Boolean <optional>
true 구독자 수를 노출합니다.
type
String <optional>
"horizontal" 구독자 수를 노출할 형태를 정합니다.
- See:
-
<static> createShareButton(settings)
-
지정한 Element를 클릭할 때 카카오스토리 공유 창이 열리도록 합니다.
Parameters:
Name Type Description settings
Object 카카오스토리 공유 버튼과 관련된 설정을 key/value로 전달합니다.
Properties
Name Type Argument Default Description container
String | HTMLElement DOM Element 또는 Element의 ID Selector를 넘기면, 해당 Element를 클릭할 때 카카오스토리 공유 창이 열립니다.
url
String <optional>
${current page's URL} 카카오스토리로 공유할 웹 페이지의 URL.
text
String <optional>
"" 공유 창에 표시할 텍스트
- See:
-
<static> open(settings)
-
모바일 환경에서 카카오스토리 앱 공유 화면을 엽니다.
Parameters:
Name Type Description settings
Object 카카오스토리 공유 버튼과 관련된 설정을 key/value로 전달합니다.
Properties
Name Type Argument Default Description install
Boolean <optional>
false 카카오스토리 앱이 설치되어 있지 않은 경우 마켓의 카카오스토리 설치 페이지로 이동합니다.
url
String <optional>
${current page's URL} 카카오스토리로 공유할 웹 페이지의 URL
text
String <optional>
"" 공유 창에 표시할 텍스트
urlInfo
Obejct <optional>
위에 입력한 url에 대한 추가적인 정보 (입력하지 않을 경우 스크랩 서버가 자동으로 생성)
Properties
Name Type Argument Description title
String 스크랩 영역에 표시할 제목
desc
String <optional>
스크랩 영역에 표시할 설명
name
String <optional>
스크랩 영역에 표시할 사이트 이름
images
Array.<String> <optional>
스크랩 영역에 표시할 대표 이미지 URL
- See:
Examples
// 1. 필수 옵션만 사용. 메타 정보는 스크랩 서버가 자동으로 생성 Kakao.Story.open({ url: 'http://my.share.url.com', text: 'Text to share' });
// 2. 스크랩된 url의 메타 정보를 바꾸고 싶을때 Kakao.Story.open({ url: 'http://my.share.url.com', text: 'Text to share', urlInfo: { title: 'The title of a shared site', desc: 'A description of a website', name: 'The name at the bottom', images: ['http://my.image.url'] } });
-
<static> share(settings)
-
카카오스토리 웹 공유 창을 엽니다.
Parameters:
Name Type Description settings
Object 카카오스토리 공유 버튼과 관련된 설정을 key/value로 전달합니다.
Properties
Name Type Argument Default Description url
String <optional>
${current page's URL} 카카오스토리로 공유할 웹페이지의 URL
text
String <optional>
"" 공유 창에 표시할 텍스트
- See: