BoxHelper
안내 사항이나 도움말을 bullet list 형태로 표시하는 헬퍼 박스 컴포넌트
개요
BoxHelper는 사용자에게 주의사항, 안내 문구 등을 bullet list로 전달하는 컴포넌트입니다. Foundation의 Item 컴포넌트를 베이스로 하며, 내부 텍스트의 타이포그래피를 지정할 수 있습니다.
주요 특징
- ✅ Bullet List: 안내 항목을 bullet list로 표시
- ✅ 타이포그래피 지정: Foundation 타이포 스타일 중 선택 가능
- ✅ Foundation Item 기반: outline variant의 Item 컴포넌트 활용
기본 사용법
Preview
- The preview and the actual sent email may differ. Please be sure to verify the final email through a test send.
- If the expiration period is not set in the password policy, it will be replaced with '00'. Please verify this substitution by conducting a test dispatch.
Typography Variants
typography prop으로 내부 텍스트의 스타일을 지정할 수 있습니다.
Preview
p (기본)
- 기본 본문 스타일의 안내 텍스트입니다.
- 두 번째 안내 항목입니다.
small
- 작은 텍스트 스타일의 안내입니다.
- 두 번째 안내 항목입니다.
muted
- 뮤트 스타일의 안내 텍스트입니다.
- 두 번째 안내 항목입니다.
large
- 큰 텍스트 스타일의 안내입니다.
- 두 번째 안내 항목입니다.
lead
- 리드 텍스트 스타일의 안내입니다.
- 두 번째 안내 항목입니다.
blockquote
- 인용 스타일의 안내 텍스트입니다.
- 두 번째 안내 항목입니다.
inline-code
- 인라인 코드 스타일의 안내입니다.
- 두 번째 안내 항목입니다.
Typography 설명
| Typography | 설명 | 사용 사례 |
|---|---|---|
| p | 기본 본문 텍스트 (기본값) | 일반 안내 문구 |
| small | 작은 텍스트 | 부가 정보 |
| muted | 뮤트 텍스트 | 보조 안내 |
| large | 큰 텍스트 | 강조 안내 |
| lead | 리드 텍스트 | 주요 안내 |
| blockquote | 인용 스타일 | 인용/참고 안내 |
| inline-code | 인라인 코드 | 기술적 안내 |
| list | 기본 리스트 | 기본 리스트 스타일 |
사용 예시
예시 1: 기본 상태 - 입력 필드 하단 배치
입력 필드 하단에 보조 설명 텍스트를 표시하는 기본 사용 패턴입니다.
Preview
- 입력 필드 하단에 보조 설명 텍스트를 표시합니다.
- 비밀번호는 8자 이상이어야 합니다.
- 영문, 숫자, 특수문자를 포함해야 합니다.
예시 2: 이메일 발송 안내
Preview
- 미리보기와 실제 발송되는 이메일은 다를 수 있습니다. 테스트 발송을 통해 최종 이메일을 확인해 주세요.
- 비밀번호 정책에 만료 기간이 설정되지 않은 경우 '00'으로 대체됩니다. 테스트 발송을 통해 확인해 주세요.
예시 2: 폼 작성 안내 (muted)
Preview
- 입력한 정보는 저장 후 수정할 수 없습니다.
- 필수 항목을 모두 입력해야 제출이 가능합니다.
- 첨부파일은 최대 10MB까지 지원합니다.
예시 3: 기술 안내 (small)
Preview
- API 호출 시 인증 토큰이 필요합니다.
- 요청 제한: 분당 100회
- 응답 시간: 평균 200ms 이내
API Reference
Props
| Prop | Type | Default | Description |
|---|---|---|---|
items | string[] | - | 안내 항목 배열 (필수) |
typography | "p" | "blockquote" | "list" | "inline-code" | "lead" | "large" | "small" | "muted" | "p" | 내부 텍스트 타이포그래피 |
className | string | - | 추가 CSS 클래스 |
기본 사용법
import { BoxHelper } from "@vortex/ui-icignal"
<BoxHelper items={["안내 항목 1", "안내 항목 2"]} />
<BoxHelper typography="muted" items={["뮤트 스타일 안내"]} />
<BoxHelper typography="small" items={["작은 텍스트 안내"]} />관련 컴포넌트
Last updated on