본문으로 건너뛰기

리스트 템플릿으로 메세지 공유하기

리스트 템플릿

공식 문서

한 개 이상의 콘텐츠를 세로로 된 목록 형태로 보여주는 메시지 형식입니다. 각 목록은 이미지와 글로 구성할 수 있습니다.

활용 예시: 메시지 하나로 여러 개의 소식이나 상품을 안내하는 데 적합합니다.

템플릿 타입 정의

/**
* 여러 개의 컨텐츠를 리스트 형태로 보여줄 수 있는 메시지 템플릿 클래스.
*
* @property headerTitle 리스트 상단에 노출되는 헤더 타이틀 (최대 200자)
* @property headerLink 헤더 타이틀 내용에 해당하는 링크 정보
* @property contents 리스트에 노출되는 컨텐츠 목록 (최소 2개, 최대 3개)
* @property buttons 버튼 목록. 버튼 타이틀과 링크를 변경하고 싶을때, 버튼 두개를 사용하고 싶을때 사용. (최대 2개)
* @property buttonTitle 기본 버튼 타이틀(자세히 보기)을 변경하고 싶을 때 설정. 이 값을 사용하면 클릭 시 이동할 링크는 content 에 입력된 값이 사용됨.
*/
export interface KakaoListTemplate {
headerTitle: string;
headerLink: KakaoTemplateLink;
contents: KakaoTemplateContent[];
buttons?: KakaoTemplateButton[];
buttonTitle?: string;
}

Usage

shareListTemplate 로 템플릿 메세지를 공유할 수 있습니다.

export function shareListTemplate(params: {
template: KakaoListTemplate;
useWebBrowserIfKakaoTalkNotAvailable?: boolean;
serverCallbackArgs?: Record<string, string>;
})
  • template: 템플릿 객체입니다.
  • useWebBrowserIfKakaoTalkNotAvailable: 카카오톡이 사용 가능하지 않을 때 웹 브라우저를 이용해 공유를 할 것인지 여부입니다. 기본값은 true입니다.
  • serverCallbackArgs: 서버 콜백 인자들입니다. 모두 문자열만 값으로 전달되어야 합니다.
정보

자세한 컴포넌트들의 타입은 컴포넌트 타입들을 참고해주세요.

사용에 문제가 생긴다면 Troubleshooting을 참고해주세요