Skip to content

Lane

A board lane with title, live count, its own empty state, and its own "Load more". Compose inside <Board>.

Prop Type Notes
title (required) React.ReactNode
count number | null Live count shown beside the title (tabular).
state WorkflowState Colours the header mark with the workflow hue; queued renders hollow.
empty React.ReactNode Lane-level empty message; shown when there are no children.
onLoadMore () => void Renders a quiet per-lane "Load more".
moreLabel string
className string
children React.ReactNode

Other props pass through to the root element (React.HTMLAttributes<HTMLElement>).

Preview

Declarations

TypeScript
export interface LaneProps extends Omit<React.HTMLAttributes<HTMLElement>, 'title'> {
  title: React.ReactNode;
  /** Live count shown beside the title (tabular). */
  count?: number | null;
  /** Colours the header mark with the workflow hue; queued renders hollow. */
  state?: WorkflowState;
  /** Lane-level empty message; shown when there are no children. */
  empty?: React.ReactNode;
  /** Renders a quiet per-lane "Load more". */
  onLoadMore?: () => void;
  moreLabel?: string;
  className?: string;
  children?: React.ReactNode;
}

/**
 * A board lane with title, live count, its own empty state, and its own
 * "Load more". Compose inside <Board>.
 */
export function Lane(props: LaneProps): React.JSX.Element;