264 lines
16 KiB
Markdown
264 lines
16 KiB
Markdown
# [맥락노트] 버튼 아이콘화 - 화면 디자이너 버튼 표시 모드 확장
|
|
|
|
> 관련 문서: [계획서](./BIC[계획]-버튼-아이콘화.md) | [체크리스트](./BIC[체크]-버튼-아이콘화.md)
|
|
|
|
---
|
|
|
|
## 왜 이 작업을 하는가
|
|
|
|
- 현재 모든 버튼은 텍스트로만 표시 → 버튼 영역이 넓어야 하고, 모바일/태블릿에서 공간 효율이 낮음
|
|
- "저장", "삭제", "추가" 같은 자주 쓰는 버튼은 아이콘만으로 충분히 인식 가능
|
|
- 관리자가 화면 레이아웃을 더 컴팩트하게 구성할 수 있도록 선택권 제공
|
|
- 단, "출하 계획" 같이 아이콘화가 어려운 특수 버튼이 존재하므로 텍스트 모드도 반드시 유지
|
|
|
|
---
|
|
|
|
## 핵심 결정 사항과 근거
|
|
|
|
### 1. 표시 모드는 3종 라디오 그룹(토글 형태)으로 구현
|
|
|
|
- **결정**: `ToggleGroup` 형태의 세 개 옵션 (텍스트 / 아이콘 / 아이콘+텍스트)
|
|
- **근거**: 세 모드는 상호 배타적. 아이콘+텍스트 병합 모드가 있어야 `[ + 추가 ]`, `[ 💾 저장 ]` 같은 실무 패턴을 지원. 아이콘만으로 의미 전달이 부족한 경우 텍스트를 병기하면 사용자 인식 속도가 빨라짐
|
|
- **대안 검토**: Switch(토글) → 기각 ("무엇이 켜지는지" 직관적이지 않음, 3종 불가)
|
|
|
|
### 2. 기본값은 텍스트 모드
|
|
|
|
- **결정**: `displayMode` 기본값 = `"text"`
|
|
- **근거**: 기존 모든 버튼은 텍스트로 동작 중. 아이콘 모드는 명시적으로 선택해야만 적용되어야 하위 호환성이 보장됨
|
|
- **중요**: `displayMode`가 `undefined`이거나 `"text"`이면 현행 동작 그대로 유지
|
|
|
|
### 3. 아이콘은 버튼 액션(action.type)에 연동
|
|
|
|
- **결정**: 버튼 액션을 변경하면 해당 액션에 맞는 추천 아이콘 목록이 자동으로 갱신됨
|
|
- **근거**: 관리자가 "저장" 아이콘을 고른 뒤 액션을 "삭제"로 바꾸면 혼란 발생. 액션별로 적절한 아이콘 후보를 보여주는 것이 자연스러움
|
|
- **주의**: 액션 변경 시 이전에 선택한 아이콘이 새 액션의 추천 목록에 없으면 선택 초기화
|
|
|
|
### 4. 액션별 아이콘은 6개씩 제공, 적절한 아이콘이 없으면 안내 문구
|
|
|
|
- **결정**: 활성 액션 14개 각각에 6개의 lucide-react 아이콘 후보 제공
|
|
- **근거**: 너무 적으면 선택지 부족, 너무 많으면 선택 피로. 6개가 2행 그리드로 깔끔하게 표시됨
|
|
- **deprecated/숨김 액션**: UI에서 숨김 처리된 액션은 추천 아이콘 없이 안내 문구만 표시
|
|
|
|
### 5. 커스텀 아이콘 추가는 2가지 방법 제공
|
|
|
|
- **결정**: (1) lucide 아이콘 검색 + (2) 외부 SVG 붙여넣기 두 가지 경로 제공
|
|
- **근거**: lucide 내장 아이콘만으로는 부족한 경우 존재 (회사 로고, 업종별 특수 아이콘 등). 외부에서 가져온 SVG를 직접 붙여넣기로 등록할 수 있어야 실무 유연성 확보
|
|
- **lucide 추가**: "lucide 검색" 버튼 → 팝오버에서 검색 → 선택 → `customIcons` 배열에 이름 추가
|
|
- **SVG 추가**: "SVG 붙여넣기" 버튼 → textarea에 SVG 코드 붙여넣기 → 미리보기 확인 → 이름 입력 → `customSvgIcons` 배열에 `{ name, svg }` 저장
|
|
- **SVG 유효성**: `<svg` 태그 포함 여부로 기본 검증, XSS 방지를 위해 DOMPurify로 정화 후 저장
|
|
- **범위**: 모든 커스텀 아이콘은 **해당 버튼 컴포넌트에 저장** (lucide: `customIcons`, SVG: `customSvgIcons`)
|
|
- **노출**: 커스텀 아이콘(lucide/SVG 모두)은 어떤 버튼 액션에서도 추천 아이콘 아래에 함께 노출됨
|
|
- **삭제**: 커스텀 아이콘 위에 X 버튼으로 개별 삭제 가능
|
|
|
|
### 5-1. 외부 SVG 붙여넣기의 보안 고려
|
|
|
|
- **결정**: SVG 문자열을 DOMPurify로 정화(sanitize)한 뒤 저장
|
|
- **근거**: SVG에 `<script>`, `onload` 같은 악성 코드가 포함될 수 있으므로 XSS 방지 필수
|
|
- **렌더링**: 정화된 SVG를 `dangerouslySetInnerHTML`로 렌더링 (정화 후이므로 안전)
|
|
- **대안 검토**: SVG를 이미지 파일로 업로드 → 기각 (관리자 입장에서 복사-붙여넣기가 훨씬 간편)
|
|
|
|
### 6. 아이콘 색상은 별도 설정, 기본값은 textColor 상속
|
|
|
|
- **결정**: `icon.color` 옵션 추가. 미설정 시 `textColor`를 상속, 설정하면 아이콘만 해당 색상 적용
|
|
- **근거**: 아이콘+텍스트 모드에서 `[ 초록✓ 검정저장 ]` 같이 아이콘과 텍스트 색을 분리하고 싶은 경우 존재. 삭제 버튼에 빨간 아이콘 + 흰 텍스트 같은 세밀한 디자인도 가능
|
|
- **기본값**: 미설정 (= `textColor` 상속) → 설정하지 않으면 기존 동작과 100% 동일
|
|
- **외부 SVG**: `fill`이 하드코딩된 SVG는 이 설정 무시 (SVG 원본 색상 유지가 의도). `currentColor`를 사용하는 SVG만 영향받음
|
|
- **구현**: 아이콘을 `<span style={{ color: icon.color }}>`으로 감싸서 아이콘만 색상 분리
|
|
- **초기화**: "텍스트 색상과 동일" 버튼으로 별도 색상 해제 → `icon.color` 삭제
|
|
|
|
### 7. 아이콘 크기는 버튼 높이 대비 비율(%) 프리셋 4단계
|
|
|
|
- **결정**: 작게(40%) / 보통(55%) / 크게(70%) / 매우 크게(85%) — 버튼 높이 대비 비율
|
|
- **근거**: 절대 px 값은 버튼 크기가 바뀌면 비율이 깨짐. 비율 기반이면 버튼 크기를 조정해도 아이콘이 자동으로 비례하여 일관된 시각적 균형 유지
|
|
- **기본값**: `"보통"` (55%) — 대부분의 버튼 크기에 적합
|
|
- **px 직접 입력 제거**: 관리자에게 과도한 선택지를 주면 오히려 일관성이 깨짐. 4단계 프리셋만으로 충분
|
|
- **구현**: CSS `height: N%` + `aspect-ratio: 1/1`로 정사각형 유지, lucide 아이콘은 래핑 span으로 크기 제어
|
|
- **레거시 호환**: 기존 `"sm"`, `"md"` 등 레거시 값은 55%(보통)로 자동 폴백
|
|
|
|
### 8. 아이콘 동적 렌더링은 매핑 객체 방식
|
|
|
|
- **결정**: lucide-react 아이콘 이름(string) → 실제 컴포넌트 매핑 객체를 별도 파일로 관리
|
|
- **근거**: `import * from 'lucide-react'`는 번들 크기에 영향. 사용하는 아이콘만 명시적으로 매핑
|
|
- **파일**: `frontend/lib/button-icon-map.ts`
|
|
- **구현**: `Record<string, React.ComponentType>` 형태의 매핑 + `renderIcon(name, size)` 유틸 함수
|
|
|
|
### 9. 아이콘 모드에서도 text 값은 유지
|
|
|
|
- **결정**: `displayMode === "icon"`이어도 `text` 필드는 삭제하지 않음
|
|
- **근거**: 접근성(`aria-label`), 검색/필터링 등에 텍스트가 필요할 수 있음
|
|
- **렌더링**: 아이콘 모드에서는 `text`를 `aria-label` 용도로만 보존
|
|
- **아이콘+텍스트 모드**: `text`가 아이콘 오른쪽에 함께 렌더링됨
|
|
|
|
### 10. 아이콘-텍스트 간격 설정 추가
|
|
|
|
- **결정**: 아이콘+텍스트 모드에서 아이콘과 텍스트 사이 간격을 관리자가 조절 가능 (`iconGap`)
|
|
- **근거**: 고정 `gap-1.5`(6px)로는 다양한 버튼 크기/디자인에 대응 불가. 간격이 좁으면 답답하고, 넓으면 분리되어 보이는 경우가 있어 관리자에게 조절 권한 제공
|
|
- **기본값**: 6px (기존 `gap-1.5`와 동일)
|
|
- **UI**: 슬라이더(0~32px) + 숫자 직접 입력(최댓값 제한 없음)
|
|
- **저장**: `componentConfig.iconGap` (숫자)
|
|
|
|
### 11. 키보드 단축키 입력 필드 충돌 해결
|
|
|
|
- **결정**: `ScreenDesigner`의 글로벌 키보드 핸들러에서 입력 필드 포커스 시 앱 단축키를 무시하도록 수정
|
|
- **근거**: SVG 붙여넣기 textarea에서 Ctrl+V/A/C/Z가 작동하지 않는 치명적 UX 문제 발견. 글로벌 `keydown` 핸들러가 `{ capture: true }`로 모든 키보드 이벤트를 가로채고 있었음
|
|
- **수정**: `browserShortcuts` 일괄 차단과 앱 전용 단축키 처리 앞에 `e.target`/`document.activeElement` 기반 입력 필드 감지 가드 추가
|
|
- **영향**: input, textarea, select, contentEditable 요소에서 텍스트 편집 단축키가 정상 동작
|
|
|
|
### 12. noIconAction에서 커스텀 아이콘 추가 허용
|
|
|
|
- **결정**: 추천 아이콘이 없는 deprecated 액션에서도 커스텀 아이콘(lucide 검색, SVG 붙여넣기) 추가 가능
|
|
- **근거**: "적절한 아이콘이 없습니다" 문구만 표시하고 아이콘 추가를 완전 차단하면 관리자가 필요한 아이콘을 직접 등록할 방법이 없음. 추천은 없지만 직접 추가는 허용해야 유연성 확보
|
|
- **안내 문구**: "적절한 추천 아이콘이 없습니다. 텍스트 모드를 사용하거나 아래에서 아이콘을 직접 추가하세요."
|
|
|
|
### 13. 아이콘 모드 레이아웃 안내 문구
|
|
|
|
- **결정**: 아이콘 모드(`"icon"`) 선택 시 "버튼 영역의 가로 폭을 줄여 정사각형에 가깝게 만들면 더 깔끔합니다" 안내 표시
|
|
- **근거**: 아이콘 자체는 항상 정사각형(24x24 viewBox)이지만, 디자이너에서 버튼 컨테이너는 가로로 넓은 직사각형이 기본. 아이콘만 넣으면 좌우 여백이 과다해 보이므로 버튼 영역을 줄이라는 안내가 필요. 자동 크기 조정은 기존 레이아웃을 깨뜨릴 위험이 있어 도입하지 않되, 관리자에게 팁을 제공하면 스스로 최적화할 수 있음
|
|
- **표시 조건**: `displayMode === "icon"`일 때만 (아이콘+텍스트 모드는 가로 공간이 필요하므로 해당 안내 불필요)
|
|
- **대안 검토**: 자동 정사각형 조정 → 기각 (관리자 수동 레이아웃 파괴 위험)
|
|
|
|
### 14. 디폴트 아이콘 자동 부여
|
|
|
|
- **결정**: 아이콘/아이콘+텍스트 모드 전환 시 아이콘이 미선택이면 디폴트 아이콘을 자동으로 부여. 커스텀 아이콘 삭제 시에도 텍스트 모드로 빠지지 않고 디폴트 아이콘으로 복귀
|
|
- **근거**: 아이콘 모드로 전환했는데 아무것도 안 보이면 "기능이 작동하지 않는다"는 착각을 유발. 또한 커스텀 아이콘을 삭제했을 때 갑자기 텍스트로 빠지면 관리자가 의도치 않은 모드 변경을 경험하게 됨
|
|
- **디폴트 선택 기준**: 해당 액션의 첫 번째 추천 아이콘 (예: save → Check). 추천 아이콘이 없는 액션은 범용 폴백 `SquareMousePointer` 사용
|
|
- **구현**: `getDefaultIconForAction(actionType)` 유틸 함수로 중앙화 (`button-icon-map.tsx`)
|
|
- **폴백 아이콘**: `SquareMousePointer` — 마우스 포인터 + 사각형 형태로 "버튼 클릭 동작"을 범용적으로 표현
|
|
|
|
### 15. 아이콘+텍스트 모드에서 텍스트 위치 4방향 지원
|
|
|
|
- **결정**: 아이콘 대비 텍스트 위치를 왼쪽/오른쪽/위쪽/아래쪽 4방향으로 설정 가능
|
|
- **근거**: 기존에는 아이콘 오른쪽에 텍스트 고정이었으나, 세로 배치(위/아래)가 필요한 경우도 존재 (좁고 높은 버튼, 툴바 스타일). 4방향을 제공하면 관리자가 버튼 모양에 맞게 레이아웃 선택 가능
|
|
- **기본값**: `"right"` (아이콘 오른쪽에 텍스트) — 가장 자연스러운 좌→우 읽기 방향
|
|
- **구현**: `flexDirection` (row/column) + 요소 순서 (textFirst) 조합으로 4방향 구현
|
|
- **저장**: `componentConfig.iconTextPosition`
|
|
- **표시 조건**: 아이콘+텍스트 모드에서만 표시 (아이콘 모드, 텍스트 모드에서는 숨김)
|
|
|
|
### 16. 버튼 컴포넌트 테두리 이중 적용 문제 해결
|
|
|
|
- **결정**: `RealtimePreviewDynamic`의 position wrapper에서 버튼 컴포넌트의 border 속성을 분리(strip)
|
|
- **근거**: StyleEditor에서 설정한 border가 (1) position wrapper와 (2) 내부 버튼 요소 두 곳에 모두 적용되어 이중 테두리 발생. border는 내부 버튼(`buttonElementStyle`)에서만 렌더링해야 함
|
|
- **수정 파일**: `RealtimePreviewDynamic.tsx` — `isButtonComponent` 조건에 `v2-button-primary` 추가하여 border strip 대상에 포함
|
|
- **수정 파일**: `ButtonPrimaryComponent.tsx` — 외부 wrapper(`componentStyle`)에서 border 속성 destructure로 제거, `border: "none"` shorthand 대신 개별 longhand 속성으로 변경 (borderStyle 미설정 시 기본 `"solid"` 적용)
|
|
|
|
### 17. 커스텀 아이콘 검색은 lucide 전체 목록 기반
|
|
|
|
- **결정**: lucide-react에서 export되는 전체 아이콘 이름 목록을 검색 가능
|
|
- **근거**: 관리자가 "어떤 아이콘이 있는지" 모르므로 검색 기능이 필수
|
|
- **구현**: lucide 아이콘 이름 배열을 상수로 관리하고, CommandInput으로 필터링
|
|
- **주의**: 전체 아이콘 컴포넌트를 import하지 않고, 이름 배열만 관리 → 선택 시에만 해당 아이콘을 매핑에 추가
|
|
|
|
---
|
|
|
|
## 관련 파일 위치
|
|
|
|
| 구분 | 파일 경로 | 설명 |
|
|
|------|----------|------|
|
|
| 설정 패널 (수정) | `frontend/components/screen/config-panels/ButtonConfigPanel.tsx` | 버튼 텍스트/액션 설정 (784~854행에 모드 선택 추가) |
|
|
| 뷰어 렌더링 (수정) | `frontend/components/screen/InteractiveScreenViewerDynamic.tsx` | 버튼 렌더링 분기 (961~983행) |
|
|
| 뷰어 렌더링 (수정) | `frontend/components/screen/InteractiveScreenViewer.tsx` | 버튼 렌더링 분기 (2041~2059행) |
|
|
| 위젯 (수정) | `frontend/components/screen/widgets/types/ButtonWidget.tsx` | 위젯 기반 버튼 렌더링 (67~86행) |
|
|
| 최적화 버튼 (수정) | `frontend/components/screen/OptimizedButtonComponent.tsx` | 최적화된 버튼 렌더링 (643~674행) |
|
|
| 아이콘 매핑 (신규) | `frontend/lib/button-icon-map.ts` | 액션별 추천 아이콘 + 동적 렌더링 유틸 |
|
|
| 타입 정의 (참고) | `frontend/types/screen.ts` | ComponentData, componentConfig 타입 |
|
|
|
|
---
|
|
|
|
## 기술 참고
|
|
|
|
### lucide-react 아이콘 동적 렌더링
|
|
|
|
```typescript
|
|
// button-icon-map.ts
|
|
import { Check, Save, Trash2, Pencil, ... } from "lucide-react";
|
|
|
|
const iconMap: Record<string, React.ComponentType<{ className?: string }>> = {
|
|
Check, Save, Trash2, Pencil, ...
|
|
};
|
|
|
|
export function renderButtonIcon(name: string, size: string | number) {
|
|
const IconComponent = iconMap[name];
|
|
if (!IconComponent) return null;
|
|
return <IconComponent style={getIconSizeStyle(size)} />;
|
|
}
|
|
```
|
|
|
|
### 아이콘 크기 비율 매핑 (버튼 높이 대비 %)
|
|
|
|
```typescript
|
|
const iconSizePresets: Record<string, number> = {
|
|
"작게": 40,
|
|
"보통": 55,
|
|
"크게": 70,
|
|
"매우 크게": 85,
|
|
};
|
|
|
|
// 프리셋 문자열 → 비율(%) 반환. 레거시 값은 55(보통)로 폴백
|
|
export function getIconPercent(size: string | number): number {
|
|
if (typeof size === "number") return size;
|
|
return iconSizePresets[size] ?? 55;
|
|
}
|
|
|
|
// 버튼 높이 대비 비율 + 정사각형 유지
|
|
export function getIconSizeStyle(size: string | number): React.CSSProperties {
|
|
const pct = getIconPercent(size);
|
|
return { height: `${pct}%`, width: "auto", aspectRatio: "1 / 1" };
|
|
}
|
|
```
|
|
|
|
### 외부 SVG 아이콘 렌더링
|
|
|
|
```typescript
|
|
import DOMPurify from "dompurify";
|
|
|
|
export function renderSvgIcon(svgString: string, size: string | number) {
|
|
const clean = DOMPurify.sanitize(svgString, { USE_PROFILES: { svg: true } });
|
|
return (
|
|
<span
|
|
className="inline-flex items-center justify-center"
|
|
style={getIconSizeStyle(size)}
|
|
dangerouslySetInnerHTML={{ __html: clean }}
|
|
/>
|
|
);
|
|
}
|
|
```
|
|
|
|
### 버튼 액션별 추천 아이콘 구조
|
|
|
|
```typescript
|
|
const actionIconMap: Record<string, string[]> = {
|
|
save: ["Check", "Save", "CheckCircle", "CircleCheck", "FileCheck", "ShieldCheck"],
|
|
delete: ["Trash2", "Trash", "XCircle", "X", "Eraser", "CircleX"],
|
|
// ...
|
|
};
|
|
```
|
|
|
|
### 현재 버튼 액션 목록 (활성)
|
|
|
|
| 값 | 표시명 | 아이콘화 가능 |
|
|
|-----|--------|-------------|
|
|
| `save` | 저장 | O |
|
|
| `delete` | 삭제 | O |
|
|
| `edit` | 편집 | O |
|
|
| `navigate` | 페이지 이동 | O |
|
|
| `modal` | 모달 열기 | O |
|
|
| `transferData` | 데이터 전달 | O |
|
|
| `excel_download` | 엑셀 다운로드 | O |
|
|
| `excel_upload` | 엑셀 업로드 | O |
|
|
| `quickInsert` | 즉시 저장 | O |
|
|
| `control` | 제어 흐름 | O |
|
|
| `barcode_scan` | 바코드 스캔 | O |
|
|
| `operation_control` | 운행알림 및 종료 | O |
|
|
| `event` | 이벤트 발송 | O |
|
|
| `copy` | 복사 (품목코드 초기화) | O |
|
|
|
|
### 현재 버튼 액션 목록 (숨김/deprecated)
|
|
|
|
| 값 | 표시명 | 아이콘화 가능 |
|
|
|-----|--------|-------------|
|
|
| `openRelatedModal` | 연관 데이터 버튼 모달 열기 | X (적절한 아이콘 없음) |
|
|
| `openModalWithData` | (deprecated) 데이터 전달 + 모달 | X |
|
|
| `view_table_history` | 테이블 이력 보기 | X |
|
|
| `code_merge` | 코드 병합 | X |
|
|
| `empty_vehicle` | 공차등록 | X |
|