Description Block
Description Block(디스크립션 블록)은 두 개의 Text Block이 조합된 레이아웃 블록으로, 말풍선 안에서 짧은 단어와 그에 대한 상세 정보를 설명할 때 사용합니다.
표Description Block블록 유형 | 블록명 | 엘리먼트 | 레이아웃 블록 | 조합된 엘리먼트 |
---|---|---|---|---|
말풍선 | Description Block | X |
O |
Text Block |
기능 소개
Description Block은 일반적으로 메시지에 아이템을 리스트 형태로 표현하고 싶을 때 활용하며, 구성 요소는 다음과 같습니다.
그림Description Block 구성과 블록 조합 예시
표Description Block 구성기능 | 설명 |
---|---|
Term(라벨) | Text(내용)에 대한 요약 문구 - 왼쪽 상단에 위치가 고정됨 - 최대 10자까지 입력 가능 - accent 속성으로 Bold 처리 가능ex) 일시, 장소 |
Text(내용) | Term(라벨)에 대한 상세 내용 - 길이가 두 줄 이상일 경우, Term의 고정 폭을 제외한 영역에 표시 ex) 19.12.20(금) 17:00~19:00 |
블록 속성
표Description 블록 속성카카오워크 1.7 버전 이후부터 Description Block의 표준 포맷이 다음과 같이 변경되었습니다.
- inlines 속성을 추가하여 텍스트에 추가 서식 적용 가능
속성 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
type | String | 필수 |
타입 고정값 - description 으로 고정 |
Object | 필수 |
텍스트를 표현하는 속성 블럭 - Text Block을 참고하여 작성 |
|
type | String | 필수 |
타입 고정값 - text 로 고정 |
text | String | 필수 |
관련 내용 |
inlines | Array | 선택 |
텍스트에 스타일을 적용 - Text Block의 inlines 참고 |
term | String | 필수 |
Text(내용)에 대한 요약 문구(라벨) |
accent | Boolean | 선택 |
Term(라벨)의 강조 여부 |
true : Term 텍스트에 Bold 적용 |
|||
false (기본값): Term 텍스트에 기본 디자인 적용 |
코드예제Description Block Sample Code
{
"type": "description",
"content": {
"type": "text",
"text": "2020년 2월 22일 오후 2시",
"inlines": [
{
"type": "styled",
"text": "2020년 2월 22일 오후 2시",
"bold": true
}
]
},
"term": "일시",
"accent": true
}