Links

Example

Links allow you to attach hyperlinks to the branch sidebar. This can be useful for attaching figma files, docs, or other relevant links.

How it works

Use the annotate function to attach a link to the branch sidebar.

import { annotate } from 'pierre';

export default async () => {
  annotate({
    icon: Icons.Linear,
    color: 'fg',
    label: 'Linear Issue',
    href: 'https://linear.app/pierre/issue/team-123/test-issue',
  });
};

export interface Annotation {
  // visual icon
  icon?: Icons;

  // title for an annotation
  label?: string;

  // description of the annotaiton
  description?: string;

  // link to external asset
  href?: string;
}