@valyrianjs/terminal 0.1.2 → 0.2.1

package/src/theme.ts

@@ -101,6 +101,9 @@ export const defaultTerminalTheme: TerminalTheme = {
     "list.current": {
       plainPrefix: "> "
     },
+    "list.selected": {
+      plainPrefix: "* "
+    },
     focus: {
       background: "#1f2328"
     },

package/src/tree.ts

@@ -54,12 +54,27 @@ export function resolveToTerminalNodes(input: any): TerminalNode[] {
       return resolveToTerminalNodes(resolveComponent(input.tag, input.props || {}, input.children || []));
     }
 
+    const tag = input.tag as TerminalPrimitiveTag;
+    const props = { ...(input.props || {}) } as Record<string, any>;
+    const vnodeChildren = input.children || [];
+    if (tag === "terminal-list" && vnodeChildren.length === 1 && typeof vnodeChildren[0] === "function") {
+      props.__childrenRenderer = vnodeChildren[0];
+      return [
+        {
+          type: "element",
+          tag,
+          props,
+          children: []
+        }
+      ];
+    }
+
     return [
       {
         type: "element",
-        tag: input.tag as TerminalPrimitiveTag,
-        props: (input.props || {}) as Record<string, any>,
-        children: normalizeChildren(input.children || [])
+        tag,
+        props,
+        children: normalizeChildren(vnodeChildren)
       }
     ];
   }
@@ -106,7 +121,7 @@ export function collectDirectOverlayFocusableNodes(nodes: TerminalNode[], out: T
 
     const overlayChildren = node.children.filter((child) => child.type === "element" && child.tag === "terminal-overlay" && child.props.trapFocus !== false);
     if (overlayChildren.length) {
-      collectFocusableNodes(overlayChildren, out);
+      collectFocusableNodes(overlayChildren.slice().reverse(), out);
       continue;
     }
 

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 {
@@ -287,17 +295,32 @@ export interface TerminalEditorCancelEventPayload extends TerminalValueEventPayl
 }
 
 export interface TerminalButtonPressEventPayload extends TerminalEventPayloadBase {
-  type: "press" | "click";
+  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> {
-  type: "press";
+export interface TerminalListPressEventPayload<T = any> extends TerminalValueEventPayloadBase<T>, TerminalListStateEventPayload {
+  type: "press" | "doublepress" | "contextpress";
   index: number;
+  key?: string;
 }
 
 export type TerminalChangeEventPayload =
@@ -307,6 +330,16 @@ export type TerminalChangeEventPayload =
 
 export type TerminalPressEventPayload = TerminalButtonPressEventPayload | TerminalListPressEventPayload<any>;
 
+export interface TerminalInputContextPressEventPayload extends TerminalValueEventPayloadBase<string>, TerminalPointerCoordinates {
+  type: "contextpress";
+  cursor: number;
+}
+
+export interface TerminalScrollContextPressEventPayload extends TerminalRowPointerEventPayloadBase {
+  type: "contextpress";
+  value: string;
+}
+
 export type TerminalMouseEventType = "hover" | "rowenter" | "rowleave";
 
 export type TerminalPointerSource = "press" | "drag" | "release";
@@ -324,6 +357,7 @@ export interface TerminalRowPointerEventPayloadBase extends TerminalPointerCoord
 export interface TerminalListPointerEventPayload<T = any> extends TerminalRowPointerEventPayloadBase {
   type: TerminalMouseEventType;
   index: number;
+  key?: string;
   value: T;
 }
 
@@ -347,6 +381,7 @@ export interface TerminalInputProps extends TerminalFocusableProps, TerminalStyl
   onchange?(event: TerminalInputChangeEventPayload): void;
   oninput?(event: TerminalInputChangeEventPayload): void;
   onsubmit?(event: TerminalInputSubmitEventPayload): void;
+  oncontextpress?(event: TerminalInputContextPressEventPayload): void;
 }
 
 export interface TerminalEditorProps extends TerminalFocusableProps, TerminalStyleProps {
@@ -362,18 +397,38 @@ export interface TerminalEditorProps extends TerminalFocusableProps, TerminalSty
 export interface TerminalButtonProps extends TerminalFocusableProps, TerminalStyleProps {
   label?: string;
   onpress?(event: TerminalButtonPressEventPayload): void;
-  onclick?(event: TerminalButtonPressEventPayload): void;
-  action?(event: TerminalButtonPressEventPayload): void;
+  ondoublepress?(event: TerminalButtonPressEventPayload): void;
+  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?: T[];
+  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;
   onhover?(event: TerminalListPointerEventPayload<T>): void;
   onrowenter?(event: TerminalListPointerEventPayload<T>): void;
   onrowleave?(event: TerminalListPointerEventPayload<T>): void;
@@ -386,6 +441,7 @@ export interface TerminalScrollViewProps extends TerminalLayoutProps, TerminalPo
   onhover?(event: TerminalScrollPointerEventPayload): void;
   onrowenter?(event: TerminalScrollPointerEventPayload): void;
   onrowleave?(event: TerminalScrollPointerEventPayload): void;
+  oncontextpress?(event: TerminalScrollContextPressEventPayload): void;
   oncapturestart?(event: TerminalCaptureEventPayload): void;
   oncaptureend?(event: TerminalCaptureEventPayload): void;
 }
@@ -438,11 +494,15 @@ export interface TerminalFixedProps {
   size: number;
 }
 
+export type TerminalOverlayMarginValue = number | `${number}%`;
+
+export interface TerminalOverlayMarginAxes {
+  x: TerminalOverlayMarginValue;
+  y: TerminalOverlayMarginValue;
+}
+
 export interface TerminalOverlayProps extends TerminalFocusableProps, TerminalStyleProps {
-  x: number;
-  y: number;
-  width: number;
-  height: number;
+  margin: TerminalOverlayMarginValue | TerminalOverlayMarginAxes;
   trapFocus?: boolean;
 }