sellmate-design-system-react 2.2.0 → 3.1.0

package/dist/components/STooltip/README.md

@@ -0,0 +1,57 @@
+# STooltip
+
+> 자동 생성 문서 — `npm run docs:gen`. 소스: 각 컴포넌트의 Props/Handle 인터페이스 + import 의존성.
+
+### STooltip
+
+#### Props
+
+| Prop | Type | Default | Description |
+|------|------|---------|-------------|
+| `content?` | `ReactNode` | — | 툴팁 본문 (ReactNode). message 보다 우선 |
+| `message?` | `string[]` | `[]` | 툴팁 본문 줄 목록 (각 항목이 한 줄, HTML 문자열 허용 — innerHTML 렌더링) |
+| `trigger?` | `STooltipTrigger` | `'hover'` | 트리거 방식 |
+| `placement?` | `STooltipPlacement` | `'top'` | 표시 방향 |
+| `tooltipType?` | `STooltipType` | `'default'` | 배경/텍스트 색상 타입 |
+| `useClose?` | `boolean` | `false` | 우측 상단 닫기 버튼. 켜면 자동 닫힘이 비활성화되고 X(또는 hide())로만 닫힘 (hover·click 공통) |
+| `disabled?` | `boolean` | `false` | 비활성 — 트리거만 렌더하고 툴팁을 열지 않음 |
+| `children?` | `ReactNode` | — | 커스텀 트리거. 없으면 아이콘 트리거를 렌더 |
+| `icon?` | `SIconName` | `'helpOutline'` | 기본(아이콘) 트리거 설정 |
+| `iconSize?` | `number` | `12` |  |
+| `color?` | `SColor` | `'#01BB4B'` | 트리거 아이콘 색상. 팔레트 키(`grey_65`, `red_95` …) 또는 임의 CSS 색상 |
+| `ariaLabel?` | `string` | — | 접근성 레이블 |
+| `className?` | `string` | — |  |
+| `triggerClassName?` | `string` | — |  |
+| `style?` | `CSSProperties` | — |  |
+
+#### Methods (ref)
+
+| Method | Type | Description |
+|--------|------|-------------|
+| `show` | `() => void` | 툴팁을 표시합니다. |
+| `hide` | `() => void` | 툴팁을 숨깁니다. |
+
+## Dependencies
+
+### Used by
+
+ - [SField](../SField)
+ - [SKeyValueTable](../SKeyValueTable)
+ - [SList](../SList)
+
+### Depends on
+
+- [SGhostButton](../SGhostButton)
+- [SIcon](../SIcon)
+
+### Graph
+
+```mermaid
+graph TD;
+  STooltip --> SGhostButton
+  STooltip --> SIcon
+  SField --> STooltip
+  SKeyValueTable --> STooltip
+  SList --> STooltip
+  style STooltip fill:#f9f,stroke:#333,stroke-width:4px
+```