Docs

docs/system/components/message-composer.md

Message Composer

packages/ui/src/message-composer.tsx

대화 화면 맨 아래에서 메시지를 적어 보내는 한 줄이다. 입력 자리와 첨부·보내기 button 을 한 덩어리로 소유하고 값은 갖지 않는다.

역할과 경계

  • MessageComposer 는 한 대화의 입력 줄이다. 대화 목록, 날짜 구분선과 메시지 하나의 표시는 message-bubble.md가 소유한다.
  • 값을 갖지 않는다. 지금 적은 글은 대화 화면이 value 로 쥐고 onValueChange 로 받는다. 보낸 뒤에 무엇을 할지(목록에 더하기, 비우기, 읽음 처리)도 대화 화면이 정한다.
  • 첨부·보내기 button 은 공용 Button 이고 입력 자리는 공용 Textarea 다. 자기 button 이나 자기 입력 자리를 따로 만들지 않는다.
  • 파일을 고르는 길은 갖지 않는다. 첨부 button 은 onAttach 를 부르기만 하고, 고른 파일을 메시지에 붙여 보이는 것은 message-attachment.md가 소유한다.
  • 화면에 보이는 문구와 접근 가능한 이름은 모두 Property 로 받는다. 컴포넌트는 언어를 갖지 않으므로 어느 locale 에서나 같은 코드로 쓴다.
  • Label, 도움말과 오류 문구를 두지 않으므로 field.md와 함께 쓰지 않는다. 입력 자리의 이름은 placeholder 가 담당한다.
  • 모서리는 interaction.md의 「공통 Control Radius」를 따르지 않는다. 컨트롤과 나란히 놓이는 요소가 아니므로 Field 는 자기 값 14px 을 쓴다.

Anatomy

  1. Container: 대화 목록 아래에 붙는 한 줄이다. 위쪽 선과 줄의 바깥 여백을 소유한다
  2. Field: 입력 자리와 Action row 를 함께 두르는 면이다. 경계와 Focus 표시를 이 하나가 소유한다
  3. Input: 메시지를 적는 여러 줄 입력이다. 공용 Textarea 다
  4. Action row: Field 안쪽 아래의 한 줄이다. 두 button 이 양 끝에 앉는다
  5. Attach button: 왼쪽의 첨부 button 이다. 공용 Button 의 Ghost · Neutral 이다
  6. Send button: 오른쪽의 보내기 button 이다. 공용 Button 의 기본 Style 이다
Message Composer
└─ Field
   ├─ Input
   └─ Action row
      ├─ Attach button
      └─ Send button

Properties

  • value: 필수 문자열이다. 입력 자리에 그려지는 지금 값이다
  • onValueChange: 값이 바뀔 때 새 값을 넘겨 부른다. 필수다
  • onSubmit: 필수다. native form 의 submit event 를 그대로 받는다. 화면이 옮겨 가지 않게 쓰는 쪽이 preventDefault() 를 부른다
  • placeholder: 필수다. 입력 자리의 안내 문구이자 접근 가능한 이름이다
  • attachLabel: 필수다. 첨부 button 의 문구이자 접근 가능한 이름이다
  • sendLabel: 필수다. 보내기 button 의 문구이자 접근 가능한 이름이다
  • onAttach: 첨부 button 을 눌렀을 때다. 파일을 고르는 길은 대화 화면이 갖는다

색

  • Container 위쪽 선: oe-border-secondary
  • Field: 배경 oe-background-primary, 경계 oe-border-secondary
  • Field 의 Focus: 경계 oe-focus-ring, 그 바깥의 겹은 oe-focus-ring 의 20% 알파
  • Input 의 글자와 caret: oe-foreground-primary. 안내 문구는 oe-foreground-tertiary
  • Attach button: Ghost · Neutral 이다. 색은 button.md가 소유한다
  • Send button: 기본 Style 이다. 꺼진 button 의 배경 oe-background-disabled 와 글자 oe-foreground-disabled 도 button.md가 소유한다

경계와 Focus

  • 경계와 Focus 표시는 Field 하나가 소유한다. 안쪽 Textarea 는 Container 의 경계·면·Focus 를 지우고 들어간다. 둘이 모두 그리면 입력 자리에 테두리가 두 줄로 선다.
  • Textarea 의 Container 를 가리키는 class 는 containerClassName, 안쪽 field 를 가리키는 class 는 className 이다(textarea.md의 「Layout」). 위의 지우기는 그 두 자리에서 일어난다.
  • Focus 는 입력 자리든 첨부 button 이든 안쪽 어디에 들어와도 Field 에 걸린다. 입력 줄 전체가 지금 쓰이고 있다는 것을 한 겹으로 알린다. 꺼진 보내기 button 은 Focus 를 받지 않으므로 그 자리만 건너뛴다.

보내기와 첨부

  • 보내기 button 은 value 의 앞뒤 공백을 떼고 남은 것이 없으면 꺼진다. 빈 메시지와 공백만인 메시지를 보내지 않는다.
  • 첨부는 type="button", 보내기는 type="submit" 이다. 첨부를 누른 것이 메시지를 보내지 않는다.
  • Enter 는 줄바꿈이다. 보내기는 보내기 button 으로만 한다.
  • 입력 자리는 크기를 손으로 바꿀 수 없다. 입력 줄의 높이는 대화 화면의 배치가 정한다.

Behavior

  • 입력 자리의 접근 가능한 이름은 placeholder 다. Field 없이 홀로 서는 자리라 Label 이 없다.
  • 두 button 의 icon 은 aria-hidden 이고 뜻은 attachLabel 과 sendLabel 이 담당한다.
  • 꺼진 보내기 button 은 native disabled 다. interaction.md의 「Disabled」를 따른다.
  • 뿌리는 <form> 이고 data-slot="message-composer" 를 갖는다. Field 와 Action row 는 message-composer-field 와 message-composer-actions 다.
  • className 은 Container 에 붙는다. 위쪽 선과 바깥 여백을 지우지 않고 덧붙으며, 같은 축의 값만 덮는다.

Guidelines

대화 목록 바로 아래에 두기

  • 입력 줄은 대화 목록과 같은 상자 안에서 목록 바로 아래에 둔다. 위쪽 선이 둘을 가르므로 상자에 선을 또 긋지 않는다.
  • 입력 줄을 화면 바닥에 붙이는 것은 대화 화면이 정한다. 컴포넌트는 sticky 를 갖지 않는다.

첨부를 받는 화면에만 쓰기

  • 첨부 button 은 언제나 선다. onAttach 를 넘기지 않으면 누를 수 있지만 아무 일도 하지 않으므로, 파일을 받는 대화 화면만 이 컴포넌트를 쓴다.
  • 보낸 파일을 메시지로 보이는 것은 MessageFileAttachment 가 맡는다. 입력 줄 안에 고른 파일을 미리 보이지 않는다.

값과 보낸 뒤를 대화 화면이 쥐기

  • value 를 컴포넌트에 맡기지 않는다. 보낸 뒤에 입력 자리를 비우는 것도 대화 화면이 onValueChange 로 한다.
  • onSubmit 에서 preventDefault() 를 부른다. 부르지 않으면 form 이 화면을 옮긴다.

Specification

자리 값
Container 바깥 여백 12px, sm 이상 16px
Container 위쪽 선 1px
Field 모서리 14px
Field 경계 1px
Field 의 Focus 겹 3px
입력 자리 높이 80px, 최소 64px
입력 자리 안쪽 여백 좌우 12px, 위아래 8px
입력 자리 글자 14px, line-height 20px
입력 자리 줄 수 2줄
Action row 여백 좌우 10px, 아래 8px
두 button 공통 Control Height 의 Small 32px

현재 정의하지 않은 항목

  • 여러 파일을 한 번에 붙이는 길을 두지 않았다. 첨부 button 은 onAttach 하나를 부르고, 고른 파일의 개수와 목록은 대화 화면이 갖는다.
  • 올리는 중의 진행률을 두지 않았다. 보내기 button 과 입력 줄에 「올리는 중」 상태가 없다.
  • 미리보기 썸네일을 두지 않았다. 고른 파일은 보내기 전에 입력 줄 안에 보이지 않는다.
  • 글자 수 상한을 두지 않았다. 글자 수 표시는 field.md가 소유하고 이 컴포넌트는 Field 와 함께 쓰지 않는다.
  • Enter 로 보내는 길을 두지 않았다. 줄바꿈과 보내기 가운데 무엇을 Enter 에 걸지 정하지 않았다.
  • 첨부 자리를 끄는 길을 두지 않았다. attachLabel 은 필수이고 button 은 언제나 선다.
  • Disabled 와 Read-only 를 두지 않았다. 대화가 닫혀 글을 적을 수 없는 상태는 대화 화면이 입력 줄을 그리지 않는 것으로 알린다.
  • 자동 높이를 두지 않았다. 입력 자리는 두 줄 높이로 고정이며 긴 글은 그 안에서 스크롤된다.