@valyrianjs/terminal 0.2.0 → 0.2.1

package/src/types.ts

@@ -28,6 +28,10 @@ export type TerminalCommandId =
   | "button.press"
   | "list.prev"
   | "list.next"
+  | "list.pageUp"
+  | "list.pageDown"
+  | "list.home"
+  | "list.end"
   | "list.press"
   | "scroll.up"
   | "scroll.down"
@@ -126,7 +130,11 @@ export interface TerminalHitbox {
   textStartX?: number;
   textLength?: number;
   itemOffset?: number;
+  itemIndexes?: number[];
+  contentY?: number;
   pointerLayer?: number;
+  __listItemIndex?: number;
+  __pressHandler?: (event: TerminalButtonPressEventPayload) => void;
 }
 
 export interface CursorPosition {
@@ -290,14 +298,29 @@ export interface TerminalButtonPressEventPayload extends TerminalEventPayloadBas
   type: "press" | "doublepress" | "contextpress";
 }
 
-export interface TerminalListChangeEventPayload<T = any> extends TerminalValueEventPayloadBase<T> {
+export interface TerminalListStateEventPayload {
+  activeIndex: number;
+  selectedIndex: number | null;
+  viewportOffset: number;
+  viewportRows: number;
+}
+
+export interface TerminalListChangeEventPayload<T = any> extends TerminalValueEventPayloadBase<T>, TerminalListStateEventPayload {
   type: "change";
   index: number;
+  key?: string;
+}
+
+export interface TerminalListViewportChangeEventPayload extends TerminalEventPayloadBase, TerminalListStateEventPayload {
+  type: "viewportchange";
+  offset: number;
+  rows: number;
 }
 
-export interface TerminalListPressEventPayload<T = any> extends TerminalValueEventPayloadBase<T> {
+export interface TerminalListPressEventPayload<T = any> extends TerminalValueEventPayloadBase<T>, TerminalListStateEventPayload {
   type: "press" | "doublepress" | "contextpress";
   index: number;
+  key?: string;
 }
 
 export type TerminalChangeEventPayload =
@@ -334,6 +357,7 @@ export interface TerminalRowPointerEventPayloadBase extends TerminalPointerCoord
 export interface TerminalListPointerEventPayload<T = any> extends TerminalRowPointerEventPayloadBase {
   type: TerminalMouseEventType;
   index: number;
+  key?: string;
   value: T;
 }
 
@@ -377,13 +401,31 @@ export interface TerminalButtonProps extends TerminalFocusableProps, TerminalSty
   oncontextpress?(event: TerminalButtonPressEventPayload): void;
 }
 
+export interface TerminalListRenderContext<T = any> {
+  index: number;
+  key: string;
+  active: boolean;
+  selected: boolean;
+  viewportIndex: number;
+  item: T;
+}
+
+export type TerminalListItemKey<T = any> = (item: T, index: number) => string | number;
+export type TerminalListItemRenderer<T = any> = (item: T, ctx: TerminalListRenderContext<T>) => any;
+
 export interface TerminalListProps<T = any> extends TerminalFocusableProps, TerminalPointerCaptureProps, TerminalStyleProps {
   items?: readonly T[];
   virtualized?: boolean;
+  height?: number;
   itemHeight?: 1;
   overscan?: number;
-  renderItem?(item: T, index: number): string;
+  wrap?: boolean;
+  itemKey?: TerminalListItemKey<T>;
+  showActive?: boolean;
+  renderItem?(item: T, index: number): any;
+  children?: TerminalListItemRenderer<T>;
   onchange?(event: TerminalListChangeEventPayload<T>): void;
+  onviewportchange?(event: TerminalListViewportChangeEventPayload): void;
   onpress?(event: TerminalListPressEventPayload<T>): void;
   ondoublepress?(event: TerminalListPressEventPayload<T>): void;
   oncontextpress?(event: TerminalListPressEventPayload<T>): void;