Skip to content

GitCommitList

API reference and demos for GitCommitList.

Source

import { GitCommitList } from "@flanksource/clicky-ui/data";
Commits · Open in Storybook
Selectable With Badges And Custom Body · Open in Storybook
Selectable With Blocked Commit · Open in Storybook

The props table documents the component-specific surface. Standard DOM attributes inherited from React, such as className, event handlers, and accessibility attributes, may also be accepted when the component’s prop type extends a native element.

Prop Type Default Description
className string — —
commits* T[] — —
diffMaxHeightClassName string — —
emptyLabel string — —
groupByDate boolean — —
loadDiff GitDiffLoader<T> — —
onOpen (…) => void — —
onToggleSelect (…) => void — Renders a leading checkbox per commit; called with the commit whose box was toggled.
renderBadges (…) => ReactNode — Inline badges rendered after the commit title.
renderExpanded (…) => ReactNode — —
renderSubtitle (…) => ReactNode — An extra line rendered between the title and the author/time line.
renderTime (…) => ReactNode — —
selectBlockReason (…) => string | null — Why a commit cannot be selected; its checkbox is then disabled with the reason as its tooltip.
selectedShas string[] — SHAs whose leading checkbox is checked. Only read when `onToggleSelect` is set.
selectLabel (…) => string — Accessible name of a commit's checkbox. Defaults to `Select commit <short sha>`.