Skip to main content
Skip table of contents

Web - BoxItem (Added in 2.2)

Added in 2.2

Definition

정의

BoxItem

최적화 대상

Desktop

Mobile

기획 배포

진행 중

디자인 가이드 배포

진행 중

개발 코드 배포

진행 중

Principle

박스 형태의 아이템입니다.

  • 리스트 내 아이템으로 추가되거나 독립적으로 쓰일 수 있는 항목

  • 데이터 선택 모달, 세그먼트 등에서 폭넓게 사용될 예정

  • 이 아이템 항목은 내부 내용에 따라서 높이가 변동되는 것이 자연스러움

참고)

image-20250617-024239.png
image-20250617-024246.png
image-20250617-024255.png
image-20250617-024301.png
image-20250617-024306.png

구성

image-20250619-061249.png

기획 가이드

공통

전체 클릭 사용 여부

Do

  • 좌측 구성(selection, image or icon 영역)은 함께 존재할 수 있습니다.

  • 우측 구성은 IconButton이 3개까지 올 수 있습니다.

    • 수정, 삭제, 상세와 같은 표현 가능

  • 면적은 선택 상태가 존재합니다.

    • 정해진 border가 표현됩니다.

  • displayType의 해당 value일 때 전체 클릭을 사용할 수 있습니다.

    • none

    • ibtn_amount1

    • checkbox

    • radio → 현재 제공 x

  • 전환(상세)이 일어나는 경우는 필히 ibtn_amount1을 사용해야 합니다.

    • 해당 value에서 사용되는 아이콘은 ic_arrow_right (우측 화살표)입니다.

Don’t

  • 좌측 구성(selection, image or icon 영역)은 서로 순서를 바꿀 수 없습니다.

    • badge가 selection 앞으로 이동 불가

  • displayType의 value가 ibtn_amount2, ibtn_amount3일 때는 전체 클릭을 사용해서는 안됩니다.

    • 해당 컴포넌트가 클릭 액션을 담당하게 됩니다.


Spec

Guide

image-20250619-091217.png

Size, Property

(color와 관련한 사항은 하단에 기술)

구성

내용

base

Web - ContentSheet Panel 참고

  • height : 내부 내용에 따라서 높이 변동

  • width : 외부 값에 따라 변동 (기획에 따라)

  • shapeType : round

  • radius : 16

image

Web - ImageView 참고

  • image imageRatio prop으로 제공

text

Web - TextLabel 참고

  • titleText

    • styleTheme : subTitleBold, leadParaBold

      • Property 내 titleFontSize

    • lineLimit : 2 (기본값)

    • ellipsisMode : use

  • descText

    • styleTheme : caption1Regular

    • lineLimit : 2 (기본값)

    • ellipsisMode : use

iBtn

Web - IconButton 참고

  • fillType : fill

  • baseSize : medium

  • baseColorKey : ui_cpnt_button_fill_base_transparent

  • iconSize : 20

  • iconColor는 prop 참고

  • shapeType : rectangle

indicator

Web - Icon 참고

  • iconName : ic_arrow_right

  • fillType : line

  • size : 20

  • colorKey : ui_cpnt_icon_sys_grey_01

checkbox

  • Unselected

    • iconSize : 20

    • iconFillType : line

    • iconName : ic_checkbox_off

    • iconColorKey : ui_cpnt_selcontrols_icon_default

  • Selected

    • iconSize : 20

    • iconFillType : fill

    • iconName : ic_checkbox_on

    • iconColorKey : ui_cpnt_selcontrols_icon_primary

  • Indeterminate

    • iconSize : 20

    • iconFillType : fill

    • iconName : ic_checkbox_indeterminate

    • iconColorKey : ui_cpnt_selcontrols_icon_primary

chip

Web - Chip 참고

Color 구성

(업데이트 예정)

Color Key

구성

내용

base

ContentSheet Panel

  • selectionMode : use일 때, borderColor

    • borderColorTheme : blue (기본값)

    • borderWidth : 2px

  • backgroundColor prop으로 제공

text

TextLabel

  • titleText

    • colorTheme prop 제공

  • descText

    • colorTheme prop 제공

icon color

  • iconColorKey prop 제공

IconButton

iconColorKey prop 제공

baseColorKey : ui_cpnt_button_fill_base_transparent


Properties

selectionMode

박스 자체가 선택되는 상황을 의미합니다. 체크된 것과 다릅니다.

기획 지시사항

  • 기획서 상 작성 방법 : Enum Values 중 하나를 사용함

Type

enum

Default

'none'

Enum Values Description

'none'

박스 면적의 선택 기능이 동작하지 않습니다.

'use'

박스 면적의 선택 기능이 동작합니다.

overrideBorderColorKey

선택 기능 동작 시, 기본적으로 제공된 컬러값이 아닌 컬러 부여가 필요할 때 컬러키를 사용하여 override하여 라인 컬러를 결정할 수 있습니다. (ui_로 정의된 컬러값 사용)

기획 지시사항

  • 기획서 상 작성 방법 : Enum Values 중 하나를 사용함

Type

enum

Default

ui_cpnt_sheet_border_02

Enum Values Description

정해져 있는 컬러 값 중 하나를 부여합니다. (ui_xxx의 형식입니다.)

state

상태를 결정합니다.

기획 지시사항

  • 기획서 상 작성 방법 : Enum Values 중 하나를 사용함

Type

enum

Default

'normal'

Enum Values Description

'normal'

기본값

'disabled'

비활성화

checkboxMode*

체크 박스 사용 유무를 결정합니다.

기획 지시사항

  • 기획서 상 작성 방법 : Enum Values 중 하나를 사용함

Type

enum

Default

'none'

Enum Values Description

'none'

사용 안함

'check'

선택

'indeterminate'

부분 선택

  

checkBoxState*

체크 박스의 상태를 결정합니다.

기획 지시사항

  • 기획서 상 작성 방법 : Enum Values 중 하나를 사용함

Type

enum

Default

'unselected'

Enum Values Description

'unchecked'

선택 안 됨

'checked'

선택됨

  • 하위 항목이 있을 경우, 모든 하위 항목이 선택된 상태

'indeterminate'

일부 선택됨

  • 하위 항목이 있을 경우, 하위 항목 일부가 선택된 상태

titleText*

주요 텍스트 값입니다.

기획 지시사항

  • 기획서 상 작성 방법 : 텍스트만 기술

Type

number | string | object | Array<string | object> | undefined | null

Default

-

 

titleTextColorKey

타이틀 텍스트의 컬러키를 설정합니다.

기획 지시사항

  • 기획서 상 작성 방법 : Enum Values 중 하나를 사용함

Type

enum

Default

ui_cpnt_textlabel_sys_primary

Enum Values Description

정해져 있는 컬러 값 중 하나를 부여합니다. (ui_xxx의 형식입니다.)

 

titleFontSize

타이틀 텍스트의 사이즈를 설정합니다.

기획 지시사항

  • 기획서 상 작성 방법 : Enum Values 중 하나를 사용함

Type

enum

Default

subTitleBold

Enum Values Description

'body2Bold'

body2Bold (16px)

'subTitleBold'

subTitleBold (18px)

'leadParaBold'

leadParaBold (20px)

'headingBold'

headingBold (24px)

titleTextLineLimit

타이틀 텍스트의 줄 수를 설정합니다.

기획 지시사항

  • 기획서 상 작성 방법 : Enum Values 중 하나를 사용함

Type

number

Default

2

Enum Values Description

숫자를 작성합니다. / 제약을 주고 싶지 않다면 큰 수 (ex. 99)를 입력합니다.

descText

상세 문구의 텍스트 값을 입력합니다.

기획 지시사항

  • 기획서 상 작성 방법 : 텍스트만 기술

Type

number | string | object | Array<string | object> | undefined | null

Default

-

 

descTextColorKey

상세문구의 컬러키를 설정합니다.

기획 지시사항

  • 기획서 상 작성 방법 : Enum Values 중 하나를 사용함

Type

enum

Default

ui_cpnt_textlabel_sys_secondary

Enum Values Description

정해져 있는 컬러 값 중 하나를 부여합니다. (ui_xxx의 형식입니다.)

descTextLineLimit

상세 텍스트의 줄 수를 설정합니다.

기획 지시사항

  • 기획서 상 작성 방법 : Enum Values 중 하나를 사용함

Type

number

Default

2

Enum Values Description

숫자를 작성합니다. / 제약을 주고 싶지 않다면 큰 수 (ex. 99)를 입력합니다.

imageMode

썸네일 이미지의 사용 여부를 결정합니다.

기획 지시사항

  • 기획서 상 작성 방법 : Enum Values 중 하나를 사용함

Type

enum

Default

'none'

Enum Values Description

'none'

아무것도 표시하지 않습니다.

'use'

썸네일 이미지를 표시합니다. 

 

imageShapeType

이미지의 형태를 결정합니다.

기획 지시사항

  • 기획서 상 작성 방법 : Enum Values 중 하나를 사용함

Type

enum

Default

'round'

Enum Values Description

'round'

 둥근 직사각형 형태의 shapeType

'circular'

 원형 형태의 shapeType

'rectangle'

 직사각형 형태의 shapeType

 

imageSrc

이미지 사용 시 이미지의 주소 값입니다.

기획 지시사항

  • 기획서 상 작성 방법 : 텍스트만 기술

Type

string

Default

-

imageWidth

너비를 결정합니다.

반응형으로 부여 할 때는 'responsive' 를 사용하고, 정해진 값을 부여할때는 숫자만 기술합니다. (단위는 px로 고정되어있습니다.)

기획 지시사항

  • 기획서 상 작성 방법 : Enum Values 중 하나를 사용함 / 숫자만 기술

Type

enum | number

Default

-

imageRatio

*width에 의한 height 값을 구하기 위한 비율입니다.

기획 지시사항

  • 기획서 상 작성 방법 : Enum Values 중 하나를 사용함

Type

enum

Default

'1_1'

Enum Values Description

'16_9'

16:9 (영상 비율에 주로 쓰입니다.)

'4_3'

4:3

'1_1'

1:1

imageScaleType

이미지를 채우는 방법을 결정합니다.

(사진이 영역을 꽉 채우지 못할때는 회색 배경이 채워집니다.)

기획 지시사항

  • 기획서 상 작성 방법 : Enum Values 중 하나를 사용함

Type

enum

Default

'cover'

Enum Values Description

'none'

원본 그대로 표시하며, 아무런 조치도 취하지 않음

'fill'

object-fit의 fill (fitXY)

'contain'

object-fit의 contain (center)

'cover'

object-fit의 cover (centerCrop)

chipMode

chip의 사용 여부를 결정합니다.

기획 지시사항

  • 기획서 상 작성 방법 : Enum Values 중 하나를 사용함

Type

enum

Default

'none'

Enum Values Description

'none'

아무것도 표시하지 않습니다.

'use'

chip을 표시합니다. 

chipText

chip의 텍스트 값을 입력합니다.

기획 지시사항

  • 기획서 상 작성 방법 : 텍스트만 기술

Type

number | string | object | Array<string | object> | undefined | null

Default

-

displayType

우측 영역의 표시 방법을 결정합니다.

기획 지시사항

  • 기획서 상 작성 방법 : Enum Values 중 하나를 사용함

Type

enum

Default

'none'

Enum Values Description

'none'

아무것도 표시하지 않습니다.

'ibtn_amount1'

우측 버튼 1개를 표시합니다.

'ibtn_amount2'

우측 버튼 2개를 표시합니다.

'ibtn_amount3'

우측 버튼 3개를 표시합니다.

 

iBtn1IconName

가장 우측 영역 아이콘 버튼의 아이콘 이름을 결정합니다.

기획 지시사항

  • 기획서 상 작성 방법 : Enum Values 중 하나를 사용함

Type

enum

Default

-

Enum Values Description

Icon 컴포넌트의 iconName 값 중 하나를 부여합니다. (ic_xxx의 형식입니다.)

 

iBtn1IconFillType

가장 우측 영역 아이콘 버튼의 아이콘 유형을 결정합니다.

기획 지시사항

  • 기획서 상 작성 방법 : Enum Values 중 하나를 사용함

Type

enum

Default

'line'

Enum Values Description

'line'

 

'fill'

 

iBtn1IconColorKey

가장 우측 영역 아이콘 버튼의 컬러키를 설정합니다.

기획 지시사항

  • 기획서 상 작성 방법 : Enum Values 중 하나를 사용함

Type

enum

Default

-

Enum Values Description

정해져 있는 컬러 값 중 하나를 부여합니다. (ui_xxx의 형식입니다.)

 

iBtn2IconName

우측에서 2번째 영역 아이콘 버튼의 아이콘 이름을 결정합니다.

기획 지시사항

  • 기획서 상 작성 방법 : Enum Values 중 하나를 사용함

Type

enum

Default

-

Enum Values Description

Icon 컴포넌트의 iconName 값 중 하나를 부여합니다. (ic_xxx의 형식입니다.)

 

iBtn2IconFillType

우측에서 2번째 영역 아이콘 버튼의 아이콘 유형을 결정합니다.

기획 지시사항

  • 기획서 상 작성 방법 : Enum Values 중 하나를 사용함

Type

enum

Default

'line'

Enum Values Description

'line'

 

'fill'

 

 

iBtn2IconColorKey

가장 우측 영역 아이콘 버튼의 컬러키를 설정합니다.

기획 지시사항

  • 기획서 상 작성 방법 : Enum Values 중 하나를 사용함

Type

enum

Default

-

Enum Values Description

정해져 있는 컬러 값 중 하나를 부여합니다. (ui_xxx의 형식입니다.)

iBtn3IconName

우측에서 3번째 영역 아이콘 버튼의 아이콘 이름을 결정합니다.

기획 지시사항

  • 기획서 상 작성 방법 : Enum Values 중 하나를 사용함

Type

enum

Default

-

Enum Values Description

Icon 컴포넌트의 iconName 값 중 하나를 부여합니다. (ic_xxx의 형식입니다.)

 

iBtn3IconFillType

우측에서 3번째 영역 아이콘 버튼의 아이콘 유형을 결정합니다.

기획 지시사항

  • 기획서 상 작성 방법 : Enum Values 중 하나를 사용함

Type

enum

Default

'line'

Enum Values Description

'line'

 

'fill'

 

 

iBtn3IconColorKey

가장 우측 영역 아이콘 버튼의 컬러키를 설정합니다.

기획 지시사항

  • 기획서 상 작성 방법 : Enum Values 중 하나를 사용함

Type

enum

Default

-

Enum Values Description

정해져 있는 컬러 값 중 하나를 부여합니다. (ui_xxx의 형식입니다.)

indicatorMode

인디케이터의 사용 유무를 결정합니다.

기획 지시사항

  • 기획서 상 작성 방법 : Enum Values 중 하나를 사용함

Type

enum

Default

'none'

Enum Values Description

'none'

사용하지 않음

'use'

사용함

paddingTop

상단의 padding 간격 값을 결정합니다.

기획 지시사항

  • 기획서 상 작성 방법 : Enum Values 중 하나를 사용함

Type

enum

Default

'spacing_d'

Enum Values Description

'none'

 

'spacing_a'

 

'spacing_b'

 

'spacing_c'

 

'spacing_d'

 

'spacing_e'

 

'spacing_f'

 

'spacing_g'

 

'spacing_h'

 

'spacing_i'

 

'spacing_j'

 

'spacing_k'

 

'spacing_l'

 

'spacing_m'

 

'spacing_n'

 

 

paddingRight

우측의 padding 간격 값을 결정합니다.

기획 지시사항

  • 기획서 상 작성 방법 : Enum Values 중 하나를 사용함

Type

enum

Default

'spacing_d'

Enum Values Description

'none'

 

'spacing_a'

 

'spacing_b'

 

'spacing_c'

 

'spacing_d'

 

'spacing_e'

 

'spacing_f'

 

'spacing_g'

 

'spacing_h'

 

'spacing_i'

 

'spacing_j'

 

'spacing_k'

 

'spacing_l'

 

'spacing_m'

 

'spacing_n'

 

 

paddingBottom

하단의 padding 간격 값을 결정합니다.

기획 지시사항

  • 기획서 상 작성 방법 : Enum Values 중 하나를 사용함

Type

enum

Default

'spacing_d'

Enum Values Description

'none'

 

'spacing_a'

 

'spacing_b'

 

'spacing_c'

 

'spacing_d'

 

'spacing_e'

 

'spacing_f'

 

'spacing_g'

 

'spacing_h'

 

'spacing_i'

 

'spacing_j'

 

'spacing_k'

 

'spacing_l'

 

'spacing_m'

 

'spacing_n'

 

 

paddingLeft

하단의 padding 간격 값을 결정합니다.

기획 지시사항

  • 기획서 상 작성 방법 : Enum Values 중 하나를 사용함

Type

enum

Default

'spacing_d'

Enum Values Description

'none'

 

'spacing_a'

 

'spacing_b'

 

'spacing_c'

 

'spacing_d'

 

'spacing_e'

 

'spacing_f'

 

'spacing_g'

 

'spacing_h'

 

'spacing_i'

 

'spacing_j'

 

'spacing_k'

 

'spacing_l'

 

'spacing_m'

 

'spacing_n'

 

 

id

체크박스에 사용되는 id입니다.

기획 지시사항

  • 기획서 상 작성 방법 : 기획자가 직접 prop을 기술하지 않음

Type

string | number

Default

-

onClick

하나의 Item이 클릭 된 시점에 이벤트를 부여합니다.

기획 지시사항

  • 기획서 상 작성 방법 : 기획자가 직접 prop을 기술하지 않음

Type

() => void

Default

-

onClickIBtn1

IBtn1이 클릭 된 시점에 이벤트를 부여합니다.

기획 지시사항

  • 기획서 상 작성 방법 : 기획자가 직접 prop을 기술하지 않음

Type

() => void

Default

-

onClickIBtn2

IBtn2이 클릭 된 시점에 이벤트를 부여합니다.

기획 지시사항

  • 기획서 상 작성 방법 : 기획자가 직접 prop을 기술하지 않음

Type

() => void

Default

-

onClickIBtn3

IBtn2이 클릭 된 시점에 이벤트를 부여합니다.

기획 지시사항

  • 기획서 상 작성 방법 : 기획자가 직접 prop을 기술하지 않음

Type

() => void

Default

-

titleTextWordBreak

줄바꿈 형식을 결정합니다.

기획 지시사항

  • 기획서 상 작성 방법 : Enum Values 중 하나를 사용함

Type

enum

Default

'keep_all'

Enum Values Description

'normal'

기본 줄 바꿈 규칙을 사용합니다.

'break_all'

오버플로를 방지하기 위해서는 어떠한 두 문자 사이에서도 줄 바꿈이 발생할 수 있습니다. (한중일 텍스트 제외)

'keep_all'

한중일(CJK) 텍스트에서는 줄을 바꿀 때 단어를 끊지 않습니다. 비 CJK 텍스트에서는 normal과 동일합니다.

'break_word'

실제 overflow-wrap 속성에 상관하지 않고, word-break: normaloverflow-wrap: anywhere를 설정한 것과 같은 효과를 냅니다. (사용을 지양하길 권장합니다.)

descTextWordBreak

줄바꿈 형식을 결정합니다.

기획 지시사항

  • 기획서 상 작성 방법 : Enum Values 중 하나를 사용함

Type

enum

Default

'keep_all'

Enum Values Description

'normal'

기본 줄 바꿈 규칙을 사용합니다.

'break_all'

오버플로를 방지하기 위해서는 어떠한 두 문자 사이에서도 줄 바꿈이 발생할 수 있습니다. (한중일 텍스트 제외)

'keep_all'

한중일(CJK) 텍스트에서는 줄을 바꿀 때 단어를 끊지 않습니다. 비 CJK 텍스트에서는 normal과 동일합니다.

'break_word'

실제 overflow-wrap 속성에 상관하지 않고, word-break: normaloverflow-wrap: anywhere를 설정한 것과 같은 효과를 냅니다. (사용을 지양하길 권장합니다.)


문서 작성 정보

소유자 / 관리자

김혜진

변경 이력

  • 2025/07/28 : checkBoxState 추가 - 곽은선

  • 2025/07/01 : borderColorKey Prop 추가 - 김혜진

  • 2025/06/25 : wordBreak property 추가 및 섹션 표시 비율 수정 - 곽은선

  • 2025/06/17 : 문서 최초 작성 - 김혜진

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.