Text
텍스트(text)는 문자열을 표시하는 컴포넌트이다. 문자열의 색상, 크기, 두께를 지정할 수 있다.
텍스트 컴포넌트의 문자열은 다국어로 전송할 수 있으며, 다국어 메시지는 클라이언트의 단말기 언어 설정에 맞게 표시된다.
Request {#text-request-parameter}
| 파라미터 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
| type | string | Y | text 로 고정. |
| text | string | Y | 표시되는 문자열.text 또는 contents 속성 중 하나를 반드시 지정해야 한다.contents 속성을 지정하면 text 속성은 무시된다. |
| contents | array of objects | N | Span 컴포넌트 문자열 영역.text 또는 contents 속성 중 하나를 반드시 지정해야 한다.contents 속성을 지정하면 text 속성은 무시된다. |
| flex | number | N | 상위 컴포넌트 내 해당 컴포넌트의 너비 또는 높이의 비율. 자세한 내용은 컴포넌트의 너비 및 높이를 참고한다. |
| margin | string | N | 상위 컴포넌트 내 해당 컴포넌트와 이전 컴포넌트와의 최소 간격. 자세한 내용은 컴포넌트의 margin 속성을 참고한다. |
| position | string | N | offsetTop, offsetBottom, offsetStart, offsetEnd 속성의 기준. 아래 속성값 중 하나를 지정한다:• relative: 이전 박스를 기준점으로 잡는다.• absolute: 상위 컴포넌트의 왼쪽 상단을 기준점으로 잡는다.기본값은 relative 이다. 자세한 내용은 오프셋을 참고한다. |
| offsetTop | string | N | 상단 오프셋. 자세한 내용은 오프셋을 참고한다. |
| offsetBottom | string | N | 하단 오프셋. 자세한 내용은 오프셋을 참고한다. |
| offsetStart | string | N | 왼쪽 오프셋. 자세한 내용은 오프셋을 참고한다. |
| offsetEnd | string | N | 오른쪽 오프셋. 자세한 내용은 오프셋을 참고한다. |
| size | string | N | 문자열의 크기.xxs, xs, sm, md, lg, xl, xxl, 3xl, 4xl, 5xl 중 하나의 값을 지정한다.열거된 순으로 문자열의 크기가 커진다. 기본값은 md 이다. |
| align | string | N | 수평 정렬 방식. 자세한 내용은 수평 정렬을 참고한다. |
| gravity | string | N | 수직 정렬 방식. 자세한 내용은 수직 정렬을 참고한다. |
| wrap | boolean | N | true 로 설정하면 문자열을 줄 바꿈 처리한다. 기본값은 false 이다.true 로 설정하면, 개행 문자(\n)를 입력해 줄 바꿈을 할 수 있다.자세한 내용은 Flexible Template 구성의 텍스트 줄 바꿈을 참고한다. |
| maxLines | number | N | 문자열의 최대 행 개수. 최대 행 개수를 지정하려면 반드시 wrap 파라미터를 true 로 설정해야 한다.지정한 행에 표시할 수 없는 문자열은 말줄임(...) 처리된다 값을 0 으로 지정하면 모든 문자열이 표시된다.기본값은 0 이다. |
| weight | string | N | 문자열 두께. regular 또는 bold 중 하나의 값을 지정한다.bold 로 지정하면 텍스트가 굵게 처리된다.기본값은 regular 이다. |
| color | string | N | 문자열 색상. Hex 색상 코드로 지정한다. |
| action | object | N | 텍스트를 탭하면 실행되는 액션. Action object를 지정한다. |
| style | string | N | 문자열 스타일. 다음 속성값 중 하나를 지정한다. • normal: 스타일 없음• italic: 기울임꼴기본값은 normal 이다. |
| decoration | string | N | 텍스트 꾸미기. 다음 속성값 중 하나를 지정한다. • none: 꾸미기 없음• underline: 밑줄• line-through: 취소선기본값은 none 이다. |
Request Example {#text-request-example}
{ "type": "bubble", "body": { "type": "box", "layout": "vertical", "contents": [ { "type": "text", "text": "The work site begins to move.", "size": "sm", "align": "center", "color": "#ff0000" }, { "type": "text", "text": "The work site begins to move.", "size": "md", "align": "center", "color": "#00ff00" }, { "type": "text", "text": "The work site begins to move.", "size": "lg", "align": "center", "weight": "bold", "color": "#0000ff" } ] }}