tuil
ReferenceComponentsLogs, JSON, and diffs

DiffViewerProps

DiffViewerProps component contract.

View rawEdit

Type

export interface DiffViewerProps
  extends CommonComponentProps,
    SlottedComponentProps<
      DiffViewerSlots,
      { readonly focused: boolean; readonly activeLine: number }
    > {
  readonly before: string;
  readonly after: string;
  readonly height?: number;
  readonly width?: number;
  readonly context?: number;
  readonly staticLimit?: number;
  readonly autoFocus?: boolean;
}

Members

MemberTypeRequiredDescriptionRelated types
beforestringYesThe before member uses the string contract.
afterstringYesThe after member uses the string contract.
heightnumber | undefinedNoThe height member uses the number | undefined contract.
widthnumber | undefinedNoThe width member uses the number | undefined contract.
contextnumber | undefinedNoThe context member uses the number | undefined contract.
staticLimitnumber | undefinedNoThe staticLimit member uses the number | undefined contract.
autoFocusboolean | undefinedNoThe autoFocus member uses the boolean | undefined contract.
variantstring | undefinedNoThe variant member uses the string | undefined contract.
size"sm" | "md" | "lg" | undefinedNoThe size member uses the "sm" | "md" | "lg" | undefined contract.
unstyledboolean | undefinedNoThe unstyled member uses the boolean | undefined contract.
classNamestring | undefinedNoThe className member uses the string | undefined contract.
layoutPartial<Omit<LayoutNodeInput, "children" | "id" | "semantics">> | undefinedNoThe layout member uses the Partial<Omit<LayoutNodeInput, "children" | "id" | "semantics">> | undefined contract.
idstring | undefinedNoThe id member uses the string | undefined contract.
testIdstring | undefinedNoThe testId member uses the string | undefined contract.
roleSemanticRole | undefinedNoThe role member uses the SemanticRole | undefined contract.SemanticRole
labelstring | undefinedNoThe label member uses the string | undefined contract.
descriptionstring | undefinedNoThe description member uses the string | undefined contract.
disabledboolean | undefinedNoThe disabled member uses the boolean | undefined contract.
readOnlyboolean | undefinedNoThe readOnly member uses the boolean | undefined contract.
selectedboolean | undefinedNoThe selected member uses the boolean | undefined contract.
checkedboolean | undefinedNoThe checked member uses the boolean | undefined contract.
expandedboolean | undefinedNoThe expanded member uses the boolean | undefined contract.
valueTextstring | undefinedNoThe valueText member uses the string | undefined contract.
slotsPartial<SlotComponents<&#123; root: import("ink").BoxProps; viewport: import("ink").BoxProps; line: import("ink").TextProps; status: import("ink").TextProps; &#125;>> | undefinedNoThe slots member uses the Partial<SlotComponents<&#123; root: import("ink").BoxProps; viewport: import("ink").BoxProps; line: import("ink").TextProps; status: import("ink").TextProps; &#125;>> | undefined contract.BoxProps, SlotComponents, TextProps
slotPropsPartial<SlotProps<&#123; root: import("ink").BoxProps; viewport: import("ink").BoxProps; line: import("ink").TextProps; status: import("ink").TextProps; &#125;, &#123; readonly focused: boolean; readonly activeLine: number; &#125;>> | undefinedNoThe slotProps member uses the Partial<SlotProps<&#123; root: import("ink").BoxProps; viewport: import("ink").BoxProps; line: import("ink").TextProps; status: import("ink").TextProps; &#125;, &#123; readonly focused: boolean; readonly activeLine: number; &#125;>> | undefined contract.BoxProps, SlotProps, TextProps

Source

View the secondary source reference

On this page