@reopt-ai/opt-ui 1.12.4 → 1.13.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +236 -0
- package/COMPONENT_CATALOG.md +290 -111
- package/dist/core/index.cjs +13 -13
- package/dist/core/index.d.cts +2 -2
- package/dist/core/index.d.ts +2 -2
- package/dist/core/index.js +2 -2
- package/dist/docs/02-components/01-core.md +49 -49
- package/dist/docs/02-components/02-visuals.md +1 -1
- package/dist/docs/02-components/03-shells.md +260 -63
- package/dist/docs/02-components/04-surfaces.md +1 -1
- package/dist/docs/02-components/index.md +4 -4
- package/dist/{field-sidebar-C8bDzGPs.js → field-sidebar-CRdToHRO.js} +3975 -235
- package/dist/{field-sidebar-DX5wP0qn.cjs → field-sidebar-CxxSK4JO.cjs} +4338 -244
- package/dist/{field-sidebar-Ct8c9L4V.d.cts → field-sidebar-D-rwuN_w.d.cts} +824 -2
- package/dist/{field-sidebar-YaWHfLLW.d.ts → field-sidebar-Dz7J4ett.d.ts} +824 -2
- package/dist/id-registry.cjs +72 -0
- package/dist/id-registry.js +72 -0
- package/dist/id-registry.json +153 -0
- package/dist/index.cjs +334 -1419
- package/dist/index.d.cts +51 -86
- package/dist/index.d.ts +51 -86
- package/dist/index.js +248 -1356
- package/dist/{key-pad-menu-1YN221Oi.cjs → key-pad-menu-0KWOnELe.cjs} +53 -483
- package/dist/{key-pad-menu-CwcY_Vps.d.cts → key-pad-menu-BOVu97bj.d.cts} +4 -55
- package/dist/{key-pad-menu-CUiQ-vKw.js → key-pad-menu-DMmbQ1jF.js} +54 -418
- package/dist/{key-pad-menu-WBJShCJn.d.ts → key-pad-menu-NlZ9zNF8.d.ts} +4 -55
- package/dist/meta.cjs +896 -7
- package/dist/meta.js +896 -7
- package/dist/shells/index.cjs +20 -1
- package/dist/shells/index.d.cts +2 -2
- package/dist/shells/index.d.ts +2 -2
- package/dist/shells/index.js +2 -2
- package/dist/{text-truncate-BFWd2cE_.js → text-truncate-Bd-0WkSP.js} +463 -99
- package/dist/{text-truncate-DsG5UAOY.cjs → text-truncate-BeYW6XZu.cjs} +525 -101
- package/dist/{text-truncate-CQyfUZvq.d.cts → text-truncate-eMzvU_7k.d.cts} +52 -1
- package/dist/{text-truncate-CQyfUZvq.d.ts → text-truncate-eMzvU_7k.d.ts} +52 -1
- package/dist/theme/server.cjs +2 -2
- package/dist/theme/server.js +2 -2
- package/package.json +6 -2
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: "Shell Components"
|
|
3
|
-
description: "
|
|
4
|
-
version: "1.
|
|
3
|
+
description: "95 Shell layer components — props, examples, keyboard shortcuts."
|
|
4
|
+
version: "1.13.0"
|
|
5
5
|
generated: true
|
|
6
6
|
---
|
|
7
7
|
|
|
8
|
-
# Shell Components (
|
|
8
|
+
# Shell Components (95)
|
|
9
9
|
|
|
10
10
|
## Navigation & Layout
|
|
11
11
|
|
|
@@ -299,19 +299,19 @@ import { AppShell } from "@reopt-ai/opt-ui";
|
|
|
299
299
|
|
|
300
300
|
## Data Display
|
|
301
301
|
|
|
302
|
-
| Component | Description
|
|
303
|
-
| ------------------- |
|
|
304
|
-
| DataTable | 제네릭 데이터 테이블. 제목은 opt-in이고 ariaLabel로 grid를 이름 붙이며, 동적 컬럼·안전 정렬·키보드 리사이즈·Composite 탐색을 지원합니다.
|
|
305
|
-
| InlineEditTable | 인라인 편집 테이블. 더블클릭으로 셀 편집, Enter 확정, Escape 취소.
|
|
306
|
-
| TreeTable | 계층형 트리 테이블. 재귀 행 렌더링 + 펼침/접기 셰브론.
|
|
307
|
-
| DomainTable | 도메인 테이블. Composite 기반 그리드로 키보드 탐색 지원.
|
|
308
|
-
| QueryResultsTable | 쿼리 결과 테이블.
|
|
309
|
-
| DashboardGrid | Composite 기반 통계 카드 그리드. 유효한 1–4열 레이아웃과 화살표 키 2D 탐색을 지원합니다.
|
|
310
|
-
| SummaryRow | 통계 요약 행. StatCard 그리드 레이아웃을 표준화합니다. loading 시 SkeletonCard 표시.
|
|
311
|
-
| CodeSnippetViewer | 코드 스니펫 뷰어. 줄 번호, 복사 버튼, 포커스 가능한 스크롤 영역, syntaxTheme 톤을 지원합니다.
|
|
312
|
-
| CodeDiffViewer | 코드 비교 뷰어. LCS 알고리즘 기반 unified/split 모드 diff와 포커스 가능한 스크롤 영역을 제공합니다.
|
|
313
|
-
| ConnectionIndicator | 연결 상태 표시기. connected, connecting, disconnected, error 상태를 지원합니다.
|
|
314
|
-
| EventIcon | 이벤트 아이콘. semantic key 또는 ReactNode 아이콘과 배경색을 표시합니다.
|
|
302
|
+
| Component | Description | Key Exports |
|
|
303
|
+
| ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------- |
|
|
304
|
+
| DataTable | 제네릭 데이터 테이블. 제목은 opt-in이고 ariaLabel로 grid를 이름 붙이며, 동적 컬럼·안전 정렬·키보드 리사이즈·Composite 탐색을 지원합니다. | `DataTable` |
|
|
305
|
+
| InlineEditTable | 인라인 편집 테이블. 더블클릭으로 셀 편집, Enter 확정, Escape 취소. | `InlineEditTable` |
|
|
306
|
+
| TreeTable | 계층형 트리 테이블. 재귀 행 렌더링 + 펼침/접기 셰브론. | `TreeTable` |
|
|
307
|
+
| DomainTable | 도메인 테이블. Composite 기반 그리드로 키보드 탐색 지원. | `DomainTable` |
|
|
308
|
+
| QueryResultsTable | 쿼리 결과 테이블. 타입이 표시되는 헤더, 로컬 정렬, 컬럼 리사이즈, 행 상세 패널을 갖추고 행을 윈도잉해 만 행도 스크롤로 다룹니다. NULL·불리언·객체를 빈칸 대신 글자로 씁니다. | `QueryResultsTable` |
|
|
309
|
+
| DashboardGrid | Composite 기반 통계 카드 그리드. 유효한 1–4열 레이아웃과 화살표 키 2D 탐색을 지원합니다. | `DashboardGrid` |
|
|
310
|
+
| SummaryRow | 통계 요약 행. StatCard 그리드 레이아웃을 표준화합니다. loading 시 SkeletonCard 표시. | `SummaryRow` |
|
|
311
|
+
| CodeSnippetViewer | 코드 스니펫 뷰어. 줄 번호, 복사 버튼, 포커스 가능한 스크롤 영역, syntaxTheme 톤을 지원합니다. | `CodeSnippetViewer` |
|
|
312
|
+
| CodeDiffViewer | 코드 비교 뷰어. LCS 알고리즘 기반 unified/split 모드 diff와 포커스 가능한 스크롤 영역을 제공합니다. | `CodeDiffViewer` |
|
|
313
|
+
| ConnectionIndicator | 연결 상태 표시기. connected, connecting, disconnected, error 상태를 지원합니다. | `ConnectionIndicator` |
|
|
314
|
+
| EventIcon | 이벤트 아이콘. semantic key 또는 ReactNode 아이콘과 배경색을 표시합니다. | `EventIcon`, `POPULAR_ICONS`, `COLOR_PRESETS` |
|
|
315
315
|
|
|
316
316
|
### DataTable
|
|
317
317
|
|
|
@@ -440,17 +440,25 @@ import { DataTable } from "@reopt-ai/opt-ui";
|
|
|
440
440
|
|
|
441
441
|
### QueryResultsTable
|
|
442
442
|
|
|
443
|
-
> 쿼리 결과 테이블.
|
|
443
|
+
> 쿼리 결과 테이블. 타입이 표시되는 헤더, 로컬 정렬, 컬럼 리사이즈, 행 상세 패널을 갖추고 행을 윈도잉해 만 행도 스크롤로 다룹니다. NULL·불리언·객체를 빈칸 대신 글자로 씁니다.
|
|
444
444
|
|
|
445
445
|
**Import:** `import { QueryResultsTable } from "@reopt-ai/opt-ui"`
|
|
446
|
-
|
|
447
|
-
|
|
448
|
-
|
|
|
449
|
-
|
|
|
450
|
-
| `
|
|
451
|
-
| `
|
|
452
|
-
| `
|
|
453
|
-
| `
|
|
446
|
+
**Dependencies:** field-token (core), flyout (shell), description-list (core)
|
|
447
|
+
|
|
448
|
+
| Prop | Type | Required | Default | Description |
|
|
449
|
+
| -------------- | ----------------------------------------- | -------- | ------- | -------------------------------------------------- |
|
|
450
|
+
| `columns` | `Array<string \| QueryResultColumn>` | Yes | | 컬럼 이름, 또는 타입을 포함한 컬럼 정의 |
|
|
451
|
+
| `rows` | `Array<Record<string, unknown>>` | Yes | | 결과 행 |
|
|
452
|
+
| `maxHeight` | `number \| "fill"` | | 400 | 스크롤 높이(px). fill이면 부모 높이를 채움 |
|
|
453
|
+
| `loading` | `boolean` | | | polite 로딩 상태 |
|
|
454
|
+
| `error` | `string` | | | assertive 오류 상태 |
|
|
455
|
+
| `sortable` | `boolean` | | true | 헤더 클릭 정렬 |
|
|
456
|
+
| `sort` | `QueryResultSort \| null` | | | 제어형 정렬 상태 |
|
|
457
|
+
| `onSortChange` | `(sort: QueryResultSort \| null) => void` | | | 정렬 변경 |
|
|
458
|
+
| `rowHeight` | `number` | | 32 | 행 높이(px). 윈도잉의 기준 |
|
|
459
|
+
| `rowDetails` | `boolean` | | true | 행을 상세 패널로 열기 |
|
|
460
|
+
| `footer` | `ReactNode` | | | 행 수 뒤에 붙는 푸터 내용 — 경과 시간, 읽은 바이트 |
|
|
461
|
+
| `labels` | `QueryResultsTableLabels` | | | 로딩/빈 상태/행 수/정렬/상세 문구 |
|
|
454
462
|
|
|
455
463
|
### DashboardGrid
|
|
456
464
|
|
|
@@ -1154,24 +1162,26 @@ const fields = [
|
|
|
1154
1162
|
**Import:** `import { SqlEditor } from "@reopt-ai/opt-ui"`
|
|
1155
1163
|
**Dependencies:** button (core)
|
|
1156
1164
|
|
|
1157
|
-
| Prop | Type
|
|
1158
|
-
| ------------------- |
|
|
1159
|
-
| `value` | `string`
|
|
1160
|
-
| `onChange` | `(sql: string) => void`
|
|
1161
|
-
| `onRun` | `(sql: string) => void`
|
|
1162
|
-
| `onRunAndAdvance` | `(sql: string) => void`
|
|
1163
|
-
| `schema` | `SqlEditorSchema`
|
|
1164
|
-
| `completionSources` | `SqlEditorCompletionSource[]`
|
|
1165
|
-
| `keymap` | `SqlEditorKeyBinding[]`
|
|
1166
|
-
| `extensions` | `SqlEditorExtension[]`
|
|
1167
|
-
| `height` | `number \| "fill"`
|
|
1168
|
-
| `placeholder` | `string`
|
|
1169
|
-
| `readOnly` | `boolean`
|
|
1170
|
-
| `ariaLabel` | `string`
|
|
1171
|
-
| `autoFocus` | `boolean`
|
|
1172
|
-
| `showFooter` | `boolean`
|
|
1173
|
-
| `
|
|
1174
|
-
| `
|
|
1165
|
+
| Prop | Type | Required | Default | Description |
|
|
1166
|
+
| ------------------- | ----------------------------------------------------- | -------- | ------- | -------------------------------------------------------------------------------- |
|
|
1167
|
+
| `value` | `string` | Yes | | 편집 중인 SQL |
|
|
1168
|
+
| `onChange` | `(sql: string) => void` | Yes | | 본문 변경 핸들러 |
|
|
1169
|
+
| `onRun` | `(sql: string, context: SqlEditorRunContext) => void` | | | Mod+Enter 실행 핸들러. 두 번째 인자로 선택 영역과 커서 위치 |
|
|
1170
|
+
| `onRunAndAdvance` | `(sql: string, context: SqlEditorRunContext) => void` | | | Shift+Enter — 실행 후 다음 셀/탭으로 이동 |
|
|
1171
|
+
| `schema` | `SqlEditorSchema` | | | 테이블/컬럼 자동완성 스키마. 변경 시 에디터를 다시 만들지 않고 자동완성만 재구성 |
|
|
1172
|
+
| `completionSources` | `SqlEditorCompletionSource[]` | | | 스키마 자동완성에 더할 완성 소스 (함수 시그니처, 스니펫) |
|
|
1173
|
+
| `keymap` | `SqlEditorKeyBinding[]` | | | 추가 키 바인딩. 내장 실행 바인딩보다 먼저 평가 |
|
|
1174
|
+
| `extensions` | `SqlEditorExtension[]` | | | 임의의 CodeMirror 확장. 내장 확장 뒤에 붙어 우선권을 가짐 |
|
|
1175
|
+
| `height` | `number \| "fill"` | | | px 고정 높이. fill이면 부모가 정한 높이를 채움 |
|
|
1176
|
+
| `placeholder` | `string` | | | 빈 편집기 안내 문구 |
|
|
1177
|
+
| `readOnly` | `boolean` | | | 편집 잠금 |
|
|
1178
|
+
| `ariaLabel` | `string` | | | 편집 영역 접근성 레이블 |
|
|
1179
|
+
| `autoFocus` | `boolean` | | | 마운트 시 포커스 |
|
|
1180
|
+
| `showFooter` | `boolean` | | | 실행 힌트/버튼 표시. 기본값은 onRun이 있을 때 표시 |
|
|
1181
|
+
| `lineNumbers` | `boolean` | | true | 줄 번호 거터 |
|
|
1182
|
+
| `theme` | `SqlEditorTheme` | | "auto" | 편집기 색상. auto는 OptThemeProvider의 resolved mode를 따름 |
|
|
1183
|
+
| `labels` | `SqlEditorLabels` | | | 문구 오버라이드 |
|
|
1184
|
+
| `className` | `string` | | | 기본 스타일 오버라이드 |
|
|
1175
1185
|
|
|
1176
1186
|
### EventMetaEditor
|
|
1177
1187
|
|
|
@@ -1413,26 +1423,35 @@ const fields = [
|
|
|
1413
1423
|
|
|
1414
1424
|
## Other
|
|
1415
1425
|
|
|
1416
|
-
| Component
|
|
1417
|
-
|
|
|
1418
|
-
| PageAside
|
|
1419
|
-
| FailureList
|
|
1420
|
-
| KeyValueEditor
|
|
1421
|
-
| EventTimeline
|
|
1422
|
-
| ScoreBreakdown
|
|
1423
|
-
| Flyout
|
|
1424
|
-
| AuditTimeline
|
|
1425
|
-
| ChatSidebar
|
|
1426
|
-
| ChatInput
|
|
1427
|
-
| ChatMessageList
|
|
1428
|
-
| TimeRangeControl
|
|
1429
|
-
| TimeSeriesPanel
|
|
1430
|
-
| LogTable
|
|
1431
|
-
| QueryBar
|
|
1432
|
-
| FieldSidebar
|
|
1433
|
-
| InspectorLayout
|
|
1434
|
-
| QueryFilterBar
|
|
1435
|
-
| CatalogFrame
|
|
1426
|
+
| Component | Description | Key Exports |
|
|
1427
|
+
| ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------- |
|
|
1428
|
+
| PageAside | Sticky 페이지 사이드 aside chrome. 고정 너비 + header/body/footer 3-slot. | `PageAside` |
|
|
1429
|
+
| FailureList | 실패 목록 패널. severity별 색상 강조, 그룹핑, 액션 슬롯을 지원합니다. | `FailureList` |
|
|
1430
|
+
| KeyValueEditor | 키-값 쌍 편집기. 동적 행 추가/삭제, 비밀값 토글, 유효성 검사를 지원합니다. | `KeyValueEditor` |
|
|
1431
|
+
| EventTimeline | 이벤트를 순서로 읽히게 하는 타임라인. 인접 이벤트 사이의 경과 시간을 라벨링하고, 속성 페이로드를 제자리에서 펼치며, 세션 단위 그룹핑을 지원한다. | `EventTimeline` |
|
|
1432
|
+
| ScoreBreakdown | 합성 점수를 축별로 분해해 보여준다. 총점과 함께 각 축의 값·가중치·의미를 노출해 '43'을 판정이 아니라 발견으로 만든다. | `ScoreBreakdown` |
|
|
1433
|
+
| Flyout | 목록을 화면에 둔 채 레코드를 옆에서 보여주는 상세 패널. 모달이 아니다 — 포커스 트랩·aria-modal·inert 없이 Escape로 닫고 포커스를 되돌린다. | `Flyout` |
|
|
1434
|
+
| AuditTimeline | 변경 이력 타임라인. 액션별 색상 코딩 + 확장 가능한 diff 뷰. | `AuditTimeline` |
|
|
1435
|
+
| ChatSidebar | AI 채팅 사이드바. 대화 목록, 검색, 새 대화 버튼. | `ChatSidebar` |
|
|
1436
|
+
| ChatInput | 채팅 입력 컴포넌트. 자동 리사이즈 textarea, 파일 첨부, 모델/스타일 Select. | `ChatInput` |
|
|
1437
|
+
| ChatMessageList | 채팅 메시지 목록. 역할별 말풍선, 타이핑 인디케이터, 자동 스크롤. | `ChatMessageList` |
|
|
1438
|
+
| TimeRangeControl | date math(now-7d, now/d) 기반 시간 범위 컨트롤. quick select, 프리셋/최근 사용, 명시적 Update, 자동 갱신, 창 이동·확대/축소 버튼을 제공합니다. | `TimeRangeControl`, `DEFAULT_TIME_PRESETS` |
|
|
1439
|
+
| TimeSeriesPanel | 시간 범위 컨트롤과 시계열 차트를 한 단위로 묶은 패널. 드래그 줌과 줌 히스토리(되돌리기), 범례 토글을 포함합니다. | `TimeSeriesPanel` |
|
|
1440
|
+
| LogTable | 계속 도착하는 로그용 윈도잉 테이블. 컬럼 정의 기반, 상단 삽입 시 스크롤 위치 보존, follow 상태 보고, 셀 값 즉시 필터, 밀도·정렬을 지원합니다. | `LogTable` |
|
|
1441
|
+
| QueryBar | 검색과 필터를 한 입력으로 합친 쿼리 바. field:value, -부정, (a or b), 비교 연산, 필드·값 자동완성, 절(clause) 칩을 지원합니다. | `QueryBar` |
|
|
1442
|
+
| FieldSidebar | 데이터에 어떤 필드가 있고 각 필드가 무슨 값을 갖는지 보여주는 사이드바. 값 분포 막대, 컬럼으로 승격, 값 기준 포함/제외 필터를 제공합니다. | `FieldSidebar` |
|
|
1443
|
+
| InspectorLayout | 목록과 인스펙터의 2-pane 레이아웃. 넓으면 밀어내고(push) 좁으면 덮으며(overlay), 닫을 때 포커스를 열었던 자리로 되돌립니다. | `InspectorLayout` |
|
|
1444
|
+
| QueryFilterBar | QueryBar와 필터 버튼이 하나의 Query를 공유합니다. 버튼은 상태를 갖지 않고 Query를 읽어 활성 여부를 계산합니다. | `QueryFilterBar`, `hasActiveQuery` |
|
|
1445
|
+
| CatalogFrame | 카탈로그 목록의 공통 뼈대. 헤더·통계·고지·필터·인스펙터·페이지네이션·일괄 작업과 빈/에러 상태를 담고, 필터나 페이지가 바뀌면 선택을 비웁니다. | `CatalogFrame`, `CatalogRowActions`, `CatalogCellControls` |
|
|
1446
|
+
| SchemaTree | 쿼리할 수 있는 테이블과 컬럼을 타입 글리프와 함께 보여주는 트리. 테이블·컬럼을 함께 검색하고, 이름을 커서에 삽입하거나 테이블을 미리보기합니다. | `SchemaTree` |
|
|
1447
|
+
| QueryToolbar | 실행 버튼 하나가 상태를 말하는 쿼리 툴바. 변경됨/현재/실행 중을 색과 문구로 구분하고, 실행 중이면 취소로 바뀌며, 선택 영역·전체 실행은 분할 버튼 뒤에 둡니다. | `QueryToolbar` |
|
|
1448
|
+
| QueryOutputPane | 쿼리 결과가 놓이는 출력 패널. 대기·실행 중·오류·취소·완료 상태를 그리고, 완료는 표·차트·좌우 분할로 전환하며, 상태바에 행 수·경과·읽은 바이트·절단 여부를 남깁니다. | `QueryOutputPane` |
|
|
1449
|
+
| QueryResultChart | 결과 행을 차트로 그리는 빌더. 첫 문자·날짜 컬럼을 축으로, 숫자 컬럼을 값으로 고르고, 한 행 한 숫자면 큰 숫자로 보여줍니다. 설정은 호출자가 들고 있어 저장 쿼리와 함께 보관됩니다. | `QueryResultChart` |
|
|
1450
|
+
| QueryFiltersMenu | 기간과 속성 조건을 데이터로 들고 {filters} 플레이스홀더로 SQL에 전달하는 메뉴. 플레이스홀더가 없으면 조건이 적용되지 않는다고 경고하고 삽입 버튼을 제공합니다. | `QueryFiltersMenu` |
|
|
1451
|
+
| QueryVariablesMenu | 실행마다 바뀌는 값을 이름 붙여 두는 변수 메뉴. SQL은 {variables.name}으로 참조하고 치환은 호출자가 합니다. | `QueryVariablesMenu` |
|
|
1452
|
+
| QueryHistoryList | 실행 이력 목록. 각 실행의 성공/실패, 시각, 행 수, 경과를 보여주고 편집기로 되돌리거나 다시 실행합니다. | `QueryHistoryList` |
|
|
1453
|
+
| SaveQueryDialog | 쿼리에 이름·설명·공개 여부를 붙여 저장하는 다이얼로그. 편집기에 문장이 여럿이면 어느 문장을 저장할지 넘겨 보며 고릅니다. | `SaveQueryDialog` |
|
|
1454
|
+
| QueryWorkspace | 스키마·편집기·출력의 3-pane 쿼리 워크스페이스. 패널은 리사이즈되고 사이드바는 접히며, storageKey로 레이아웃을 기억합니다. 툴바·편집기·출력은 슬롯입니다. | `QueryWorkspace` |
|
|
1436
1455
|
|
|
1437
1456
|
### PageAside
|
|
1438
1457
|
|
|
@@ -1861,3 +1880,181 @@ const messages = [
|
|
|
1861
1880
|
| Prop | Type | Required | Default | Description |
|
|
1862
1881
|
| ---------- | ----------- | -------- | ------- | ---------------------------------- |
|
|
1863
1882
|
| `children` | `ReactNode` | Yes | | 행 클릭으로 새면 안 되는 셀 컨트롤 |
|
|
1883
|
+
|
|
1884
|
+
### SchemaTree
|
|
1885
|
+
|
|
1886
|
+
> 쿼리할 수 있는 테이블과 컬럼을 타입 글리프와 함께 보여주는 트리. 테이블·컬럼을 함께 검색하고, 이름을 커서에 삽입하거나 테이블을 미리보기합니다.
|
|
1887
|
+
|
|
1888
|
+
**Import:** `import { SchemaTree } from "@reopt-ai/opt-ui"`
|
|
1889
|
+
**Dependencies:** field-token (core), highlight (core)
|
|
1890
|
+
|
|
1891
|
+
| Prop | Type | Required | Default | Description |
|
|
1892
|
+
| ----------------- | ------------------------------------------------------------------ | -------- | ------- | ----------------------------------------- |
|
|
1893
|
+
| `tables` | `SchemaTreeTable[]` | Yes | | 테이블과 컬럼 |
|
|
1894
|
+
| `loading` | `boolean` | | | 스키마 조회 중 |
|
|
1895
|
+
| `defaultExpanded` | `string[]` | | | 처음에 펼칠 테이블. 생략 시 첫 테이블 |
|
|
1896
|
+
| `onInsert` | `(name: string, kind: "table" \| "column", table: string) => void` | | | 이름을 편집기 커서에 삽입 |
|
|
1897
|
+
| `onPreview` | `(table: string) => void` | | | 테이블 미리보기 실행. SQL은 호출자가 작성 |
|
|
1898
|
+
| `header` | `ReactNode` | | | 검색창 위 내용 |
|
|
1899
|
+
| `labels` | `SchemaTreeLabels` | | | 문구 오버라이드 |
|
|
1900
|
+
|
|
1901
|
+
### QueryToolbar
|
|
1902
|
+
|
|
1903
|
+
> 실행 버튼 하나가 상태를 말하는 쿼리 툴바. 변경됨/현재/실행 중을 색과 문구로 구분하고, 실행 중이면 취소로 바뀌며, 선택 영역·전체 실행은 분할 버튼 뒤에 둡니다.
|
|
1904
|
+
|
|
1905
|
+
**Import:** `import { QueryToolbar } from "@reopt-ai/opt-ui"`
|
|
1906
|
+
**Dependencies:** button (core), kbd (core), dropdown-menu (core)
|
|
1907
|
+
|
|
1908
|
+
| Prop | Type | Required | Default | Description |
|
|
1909
|
+
| ------------------- | -------------------- | -------- | ------- | ----------------------------------------------- |
|
|
1910
|
+
| `onRun` | `() => void` | Yes | | 커서 위치의 문장 실행 |
|
|
1911
|
+
| `onCancel` | `() => void` | | | 실행 중 취소. 있으면 버튼이 Cancel로 전환 |
|
|
1912
|
+
| `running` | `boolean` | | | 실행 중 |
|
|
1913
|
+
| `runState` | `QueryRunState` | | "idle" | 마지막 실행 대비 변경 여부 |
|
|
1914
|
+
| `runDisabledReason` | `string` | | | 실행 불가 사유. 툴팁으로 표시 |
|
|
1915
|
+
| `onRunSelection` | `() => void` | | | 선택 영역만 실행 |
|
|
1916
|
+
| `hasSelection` | `boolean` | | | 선택 영역이 있는지. 없으면 항목 비활성 |
|
|
1917
|
+
| `onRunAll` | `() => void` | | | 전체 문장 실행 |
|
|
1918
|
+
| `multiStatement` | `boolean` | | | 문장이 둘 이상인지. 아니면 전체 실행을 숨김 |
|
|
1919
|
+
| `onSave` | `() => void` | | | 저장 다이얼로그 열기 |
|
|
1920
|
+
| `saveDisabled` | `boolean` | | | 저장 비활성 |
|
|
1921
|
+
| `children` | `ReactNode` | | | 실행 그룹 뒤의 컨트롤 — 필터, 변수 |
|
|
1922
|
+
| `trailing` | `ReactNode` | | | 끝쪽 컨트롤 |
|
|
1923
|
+
| `modifierKey` | `string` | | | 단축키 힌트의 수정자 글리프. 기본은 플랫폼 감지 |
|
|
1924
|
+
| `labels` | `QueryToolbarLabels` | | | 문구 오버라이드 |
|
|
1925
|
+
|
|
1926
|
+
### QueryOutputPane
|
|
1927
|
+
|
|
1928
|
+
> 쿼리 결과가 놓이는 출력 패널. 대기·실행 중·오류·취소·완료 상태를 그리고, 완료는 표·차트·좌우 분할로 전환하며, 상태바에 행 수·경과·읽은 바이트·절단 여부를 남깁니다.
|
|
1929
|
+
|
|
1930
|
+
**Import:** `import { QueryOutputPane } from "@reopt-ai/opt-ui"`
|
|
1931
|
+
**Dependencies:** segmented-control (core), empty-state (core), resizable (core)
|
|
1932
|
+
|
|
1933
|
+
| Prop | Type | Required | Default | Description |
|
|
1934
|
+
| ---------------- | ------------------------------------------------------------ | -------- | ------- | ----------------------------------- |
|
|
1935
|
+
| `view` | `QueryOutputView` | Yes | | 표 / 차트 / 분할 |
|
|
1936
|
+
| `onViewChange` | `(view: QueryOutputView) => void` | Yes | | 뷰 전환 |
|
|
1937
|
+
| `results` | `ReactNode` | Yes | | 결과 테이블 |
|
|
1938
|
+
| `chart` | `ReactNode` | | | 차트 빌더. 없으면 차트 뷰를 숨김 |
|
|
1939
|
+
| `status` | `"idle" \| "running" \| "success" \| "error" \| "cancelled"` | Yes | | 실행 수명주기 |
|
|
1940
|
+
| `error` | `string` | | | 백엔드 오류 원문 |
|
|
1941
|
+
| `runningSeconds` | `number` | | | 실행 경과 초. 로딩 상태에 표시 |
|
|
1942
|
+
| `onCancel` | `() => void` | | | 실행 취소 |
|
|
1943
|
+
| `stats` | `QueryRunStats` | | | 행 수, 경과, 읽은 바이트, 절단 여부 |
|
|
1944
|
+
| `actions` | `ReactNode` | | | 뷰 전환 오른쪽 컨트롤 |
|
|
1945
|
+
| `statusExtra` | `ReactNode` | | | 상태바 추가 내용 |
|
|
1946
|
+
| `banner` | `ReactNode` | | | 출력 위 알림 |
|
|
1947
|
+
| `onRetry` | `() => void` | | | 오류 상태 닫기 |
|
|
1948
|
+
| `labels` | `QueryOutputPaneLabels` | | | 문구 오버라이드 |
|
|
1949
|
+
|
|
1950
|
+
### QueryResultChart
|
|
1951
|
+
|
|
1952
|
+
> 결과 행을 차트로 그리는 빌더. 첫 문자·날짜 컬럼을 축으로, 숫자 컬럼을 값으로 고르고, 한 행 한 숫자면 큰 숫자로 보여줍니다. 설정은 호출자가 들고 있어 저장 쿼리와 함께 보관됩니다.
|
|
1953
|
+
|
|
1954
|
+
**Import:** `import { QueryResultChart } from "@reopt-ai/opt-ui"`
|
|
1955
|
+
**Dependencies:** line-chart (visuals), bar-chart (visuals), area-chart (visuals), pie-chart (visuals), segmented-control (core), select (core)
|
|
1956
|
+
|
|
1957
|
+
| Prop | Type | Required | Default | Description |
|
|
1958
|
+
| ---------------- | ------------------------------------ | -------- | ------- | --------------------------------- |
|
|
1959
|
+
| `columns` | `QueryResultColumn[]` | Yes | | 결과 컬럼 |
|
|
1960
|
+
| `rows` | `Array<Record<string, unknown>>` | Yes | | 결과 행 |
|
|
1961
|
+
| `config` | `QueryChartConfig` | Yes | | 차트 종류, 축, 값 컬럼 |
|
|
1962
|
+
| `onConfigChange` | `(config: QueryChartConfig) => void` | Yes | | 설정 변경 |
|
|
1963
|
+
| `showControls` | `boolean` | | true | 컨트롤 표시. 임베드 카드에서는 끔 |
|
|
1964
|
+
| `height` | `number` | | | 차트 높이(px). 기본은 부모 채움 |
|
|
1965
|
+
| `maxPoints` | `number` | | 1000 | 차트에 그릴 최대 행 수 |
|
|
1966
|
+
| `labels` | `QueryResultChartLabels` | | | 문구 오버라이드 |
|
|
1967
|
+
|
|
1968
|
+
### QueryFiltersMenu
|
|
1969
|
+
|
|
1970
|
+
> 기간과 속성 조건을 데이터로 들고 {filters} 플레이스홀더로 SQL에 전달하는 메뉴. 플레이스홀더가 없으면 조건이 적용되지 않는다고 경고하고 삽입 버튼을 제공합니다.
|
|
1971
|
+
|
|
1972
|
+
**Import:** `import { QueryFiltersMenu } from "@reopt-ai/opt-ui"`
|
|
1973
|
+
**Dependencies:** popover (core), date-range-picker (core), select (core), combobox (core), callout (core)
|
|
1974
|
+
|
|
1975
|
+
| Prop | Type | Required | Default | Description |
|
|
1976
|
+
| --------------------- | -------------------------------------- | -------- | ------- | -------------------------------------------------------------- |
|
|
1977
|
+
| `value` | `QueryFilters` | Yes | | 기간과 속성 필터 |
|
|
1978
|
+
| `onChange` | `(filters: QueryFilters) => void` | Yes | | 필터 변경 |
|
|
1979
|
+
| `fields` | `QueryFilterField[]` | Yes | | 필드 선택지 |
|
|
1980
|
+
| `placeholderPresent` | `boolean` | | | SQL에 {filters}가 있는지 |
|
|
1981
|
+
| `onInsertPlaceholder` | `() => void` | | | {filters}를 커서에 삽입 |
|
|
1982
|
+
| `onLoadValues` | `(field: string) => Promise<string[]>` | | | 필드의 알려진 값. 값 입력란의 제안으로 쓰이며 자유 입력도 허용 |
|
|
1983
|
+
| `presets` | `DateRangePreset[]` | | | 기간 프리셋 |
|
|
1984
|
+
| `disabled` | `boolean` | | | 비활성 |
|
|
1985
|
+
| `labels` | `QueryFiltersMenuLabels` | | | 문구 오버라이드 |
|
|
1986
|
+
|
|
1987
|
+
### QueryVariablesMenu
|
|
1988
|
+
|
|
1989
|
+
> 실행마다 바뀌는 값을 이름 붙여 두는 변수 메뉴. SQL은 {variables.name}으로 참조하고 치환은 호출자가 합니다.
|
|
1990
|
+
|
|
1991
|
+
**Import:** `import { QueryVariablesMenu } from "@reopt-ai/opt-ui"`
|
|
1992
|
+
**Dependencies:** popover (core), input (core)
|
|
1993
|
+
|
|
1994
|
+
| Prop | Type | Required | Default | Description |
|
|
1995
|
+
| ---------------- | -------------------------------------- | -------- | ------- | ------------------------------ |
|
|
1996
|
+
| `value` | `QueryVariable[]` | Yes | | 변수 목록 |
|
|
1997
|
+
| `onChange` | `(variables: QueryVariable[]) => void` | Yes | | 변수 변경 |
|
|
1998
|
+
| `onInsert` | `(name: string) => void` | | | {variables.name}을 커서에 삽입 |
|
|
1999
|
+
| `disabled` | `boolean` | | | 비활성 |
|
|
2000
|
+
| `disabledReason` | `string` | | | 비활성 사유. 툴팁으로 표시 |
|
|
2001
|
+
| `labels` | `QueryVariablesMenuLabels` | | | 문구 오버라이드 |
|
|
2002
|
+
|
|
2003
|
+
### QueryHistoryList
|
|
2004
|
+
|
|
2005
|
+
> 실행 이력 목록. 각 실행의 성공/실패, 시각, 행 수, 경과를 보여주고 편집기로 되돌리거나 다시 실행합니다.
|
|
2006
|
+
|
|
2007
|
+
**Import:** `import { QueryHistoryList } from "@reopt-ai/opt-ui"`
|
|
2008
|
+
**Dependencies:** button (core)
|
|
2009
|
+
|
|
2010
|
+
| Prop | Type | Required | Default | Description |
|
|
2011
|
+
| --------- | ---------------------------------- | -------- | ------- | ---------------- |
|
|
2012
|
+
| `items` | `QueryHistoryItem[]` | Yes | | 최근 실행부터 |
|
|
2013
|
+
| `loading` | `boolean` | | | 이력 조회 중 |
|
|
2014
|
+
| `onLoad` | `(item: QueryHistoryItem) => void` | | | 쿼리를 편집기로 |
|
|
2015
|
+
| `onRerun` | `(item: QueryHistoryItem) => void` | | | 그대로 다시 실행 |
|
|
2016
|
+
| `onClear` | `() => void` | | | 이력 비우기 |
|
|
2017
|
+
| `header` | `ReactNode` | | | 목록 위 내용 |
|
|
2018
|
+
| `labels` | `QueryHistoryListLabels` | | | 문구 오버라이드 |
|
|
2019
|
+
|
|
2020
|
+
### SaveQueryDialog
|
|
2021
|
+
|
|
2022
|
+
> 쿼리에 이름·설명·공개 여부를 붙여 저장하는 다이얼로그. 편집기에 문장이 여럿이면 어느 문장을 저장할지 넘겨 보며 고릅니다.
|
|
2023
|
+
|
|
2024
|
+
**Import:** `import { SaveQueryDialog } from "@reopt-ai/opt-ui"`
|
|
2025
|
+
**Dependencies:** dialog (core), input (core), textarea (core), switch (core)
|
|
2026
|
+
|
|
2027
|
+
| Prop | Type | Required | Default | Description |
|
|
2028
|
+
| ---------------------- | ---------------------------------------------------- | -------- | -------- | ---------------------------------------- |
|
|
2029
|
+
| `open` | `boolean` | Yes | | 열림 |
|
|
2030
|
+
| `onOpenChange` | `(open: boolean) => void` | Yes | | 열림 상태 변경 |
|
|
2031
|
+
| `onSubmit` | `(values: SaveQueryValues) => void \| Promise<void>` | Yes | | 저장 |
|
|
2032
|
+
| `candidates` | `string[]` | Yes | | 저장할 SQL 후보. 문장이 여럿이면 여러 개 |
|
|
2033
|
+
| `initialCandidate` | `number` | | 0 | 처음 보여줄 후보 |
|
|
2034
|
+
| `candidateIsSelection` | `boolean` | | | 후보가 선택 영역인지 |
|
|
2035
|
+
| `initialValues` | `Partial<Omit<SaveQueryValues, "sql">>` | | | 기존 저장 쿼리를 수정할 때의 초기값 |
|
|
2036
|
+
| `mode` | `"create" \| "update"` | | "create" | 새로 저장 / 수정 |
|
|
2037
|
+
| `saving` | `boolean` | | | 저장 중 |
|
|
2038
|
+
| `error` | `string` | | | 저장 실패 메시지 |
|
|
2039
|
+
| `labels` | `SaveQueryDialogLabels` | | | 문구 오버라이드 |
|
|
2040
|
+
|
|
2041
|
+
### QueryWorkspace
|
|
2042
|
+
|
|
2043
|
+
> 스키마·편집기·출력의 3-pane 쿼리 워크스페이스. 패널은 리사이즈되고 사이드바는 접히며, storageKey로 레이아웃을 기억합니다. 툴바·편집기·출력은 슬롯입니다.
|
|
2044
|
+
|
|
2045
|
+
**Import:** `import { QueryWorkspace } from "@reopt-ai/opt-ui"`
|
|
2046
|
+
**Dependencies:** resizable (core), button (core)
|
|
2047
|
+
|
|
2048
|
+
| Prop | Type | Required | Default | Description |
|
|
2049
|
+
| --------------------- | ------------------------- | -------- | ------- | ------------------------------------ |
|
|
2050
|
+
| `sidebar` | `ReactNode` | | | 왼쪽 패널 내용 |
|
|
2051
|
+
| `sidebarOpen` | `boolean` | | | 제어형 사이드바 열림 |
|
|
2052
|
+
| `onSidebarOpenChange` | `(open: boolean) => void` | | | 사이드바 열림 변경 |
|
|
2053
|
+
| `header` | `ReactNode` | | | 툴바 위 — 탭이나 페이지 헤더 |
|
|
2054
|
+
| `toolbar` | `ReactNode` | | | 툴바 |
|
|
2055
|
+
| `editor` | `ReactNode` | Yes | | 편집기 |
|
|
2056
|
+
| `output` | `ReactNode` | Yes | | 출력 |
|
|
2057
|
+
| `storageKey` | `string` | | | 패널 크기를 localStorage에 기억할 키 |
|
|
2058
|
+
| `defaultSidebarSize` | `number` | | 22 | 사이드바 폭(%) |
|
|
2059
|
+
| `defaultEditorSize` | `number` | | 40 | 편집기 높이(%) |
|
|
2060
|
+
| `labels` | `QueryWorkspaceLabels` | | | 문구 오버라이드 |
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: "Component Reference"
|
|
3
|
-
description: "Complete reference for
|
|
4
|
-
version: "1.
|
|
3
|
+
description: "Complete reference for 169 @reopt-ai/opt-ui components across 4 layers."
|
|
4
|
+
version: "1.13.0"
|
|
5
5
|
generated: true
|
|
6
6
|
---
|
|
7
7
|
|
|
@@ -13,9 +13,9 @@ generated: true
|
|
|
13
13
|
| --------- | ------- |
|
|
14
14
|
| Core | 74 |
|
|
15
15
|
| Visuals | 0 |
|
|
16
|
-
| Shells |
|
|
16
|
+
| Shells | 95 |
|
|
17
17
|
| Surfaces | 0 |
|
|
18
|
-
| **Total** | **
|
|
18
|
+
| **Total** | **169** |
|
|
19
19
|
|
|
20
20
|
## Component Selection Guide
|
|
21
21
|
|