@aiquants/resize-panels 1.8.0 → 1.9.0

package/src/types.ts

@@ -17,6 +17,42 @@ export const PANEL_SNAP_THRESHOLD = 12
  */
 export const PANEL_HANDLE_THICKNESS = 8
 
+/**
+ * Default thickness in pixels for the visual indicator wrapper.
+ * 視覚インジケーター外枠のデフォルト厚み (px)。
+ */
+export const PANEL_INDICATOR_THICKNESS = 6
+
+/**
+ * Default length in pixels for the visual indicator wrapper in horizontal layout.
+ * 水平レイアウトにおける視覚インジケーター外枠のデフォルト長さ (px)。
+ */
+export const PANEL_INDICATOR_LENGTH_HORIZONTAL = 48
+
+/**
+ * Default length in pixels for the visual indicator wrapper in vertical layout.
+ * 垂直レイアウトにおける視覚インジケーター外枠のデフォルト長さ (px)。
+ */
+export const PANEL_INDICATOR_LENGTH_VERTICAL = 80
+
+/**
+ * Default thickness in pixels for the inner bar inside the visual indicator.
+ * 視覚インジケーター内部バーのデフォルト厚み (px)。
+ */
+export const PANEL_INDICATOR_BAR_THICKNESS = 2
+
+/**
+ * Default length in pixels for the inner bar inside the visual indicator in horizontal layout.
+ * 水平レイアウトにおける視覚インジケーター内部バーのデフォルト長さ (px)。
+ */
+export const PANEL_INDICATOR_BAR_LENGTH_HORIZONTAL = 32
+
+/**
+ * Default length in pixels for the inner bar inside the visual indicator in vertical layout.
+ * 垂直レイアウトにおける視覚インジケーター内部バーのデフォルト長さ (px)。
+ */
+export const PANEL_INDICATOR_BAR_LENGTH_VERTICAL = 64
+
 /**
  * Spacing in pixels between visual indicator dots in the handle.
  * ハンドル内の視覚インジケーター点同士のピクセル間隔。
@@ -149,11 +185,15 @@ export type ContainerAxisMeasurement = {
 }
 
 /**
- * Snapshot describing when panel constraints conflict with the container size.
- * パネル制約とコンテナサイズが矛盾する際のスナップショット。
+ * Reason code for layout constraint violations.
+ * レイアウト制約違反の理由コード。
  */
 export type LayoutConstraintViolationReason = "minimum-exceeded" | "maximum-insufficient"
 
+/**
+ * Snapshot describing when panel constraints conflict with the container size.
+ * パネル制約とコンテナサイズが矛盾した際のスナップショット。
+ */
 export type LayoutConstraintViolation = {
     reason: LayoutConstraintViolationReason
     totalMinimumSize: number | null
@@ -256,6 +296,55 @@ export interface PanelGroupContextValue {
     layoutConstraintViolation: LayoutConstraintViolation | null
 }
 
+/**
+ * Visual indicator configuration options for PanelResizeHandle.
+ * PanelResizeHandle の視覚インジケーターに関する設定オプション。
+ */
+export interface PanelResizeHandleIndicatorConfig {
+    /**
+     * Primary axis thickness of the indicator pill in pixels.
+     * (Horizontal: width, Vertical: height)
+     * インジケーター外枠の主軸方向の厚み (px)。(水平: 幅, 垂直: 高さ)
+     * @default 6
+     */
+    thickness?: number
+    /**
+     * Cross axis length of the indicator pill in pixels.
+     * (Horizontal: height, Vertical: width)
+     * インジケーター外枠の交差軸方向の長さ (px)。(水平: 高さ, 垂直: 幅)
+     * @default horizontal ? 48 : 80
+     */
+    length?: number
+    /**
+     * Primary axis thickness of the inner bar in pixels.
+     * インジケーター内部バーの主軸方向の厚み (px)。
+     * @default 2
+     */
+    barThickness?: number
+    /**
+     * Cross axis length of the inner bar in pixels.
+     * インジケーター内部バーの交差軸方向の長さ (px)。
+     * @default horizontal ? 32 : 64
+     */
+    barLength?: number
+    /**
+     * Whether the indicator is visible.
+     * インジケーターを表示するかどうかの指定。
+     * @default true
+     */
+    visible?: boolean
+    /**
+     * Additional CSS class name for the indicator wrapper.
+     * インジケーター外枠に付与する追加 CSS クラス名。
+     */
+    className?: string
+    /**
+     * Additional CSS class name for the inner bar.
+     * インジケーター内部バーに付与する追加 CSS クラス名。
+     */
+    barClassName?: string
+}
+
 /**
  * Props for the PanelResizeHandle component
  * PanelResizeHandle コンポーネントのプロパティ
@@ -267,8 +356,50 @@ export interface PanelResizeHandleProps {
     className?: string
     style?: React.CSSProperties
     children?: ReactNode
+    /**
+     * Primary axis thickness of the handle's interactive area in pixels.
+     * (Horizontal: width, Vertical: height)
+     * リサイズハンドルの操作領域 (ヒットエリア) の厚み (px)。(水平: 幅, 垂直: 高さ)
+     * @default PANEL_HANDLE_THICKNESS (8)
+     */
+    thickness?: number
+    /**
+     * Configuration for the visual indicator, or boolean to toggle visibility.
+     * 視覚インジケーターの設定オブジェクト、または表示/非表示の真偽値。
+     * @default true
+     */
+    indicator?: boolean | PanelResizeHandleIndicatorConfig
+    /**
+     * Shorthand for indicator wrapper thickness in pixels.
+     * インジケーター外枠厚み (px) のショートハンド。
+     */
+    indicatorThickness?: number
+    /**
+     * Shorthand for indicator wrapper length in pixels.
+     * インジケーター外枠長さ (px) のショートハンド。
+     */
+    indicatorLength?: number
+    /**
+     * Shorthand for indicator inner bar thickness in pixels.
+     * インジケーター内部バー厚み (px) のショートハンド。
+     */
+    indicatorBarThickness?: number
+    /**
+     * Shorthand for indicator inner bar length in pixels.
+     * インジケーター内部バー長さ (px) のショートハンド。
+     */
+    indicatorBarLength?: number
+    /**
+     * Custom tooltip text for the handle element.
+     * ハンドル要素のカスタムツールチップテキスト。
+     */
+    title?: string
 }
 
+/**
+ * Observed pixel and percentage measurements for a registered panel.
+ * 登録済みパネルの実測ピクセル寸法およびパーセンテージ寸法。
+ */
 export interface PanelMeasurement {
     pixelSize: number
     percentageSize: number