Link Attachments

Example

Links allow you to attach hrefs 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 {
  // Themeable color
  color?: Color;

  // visual icon
  icon?: Icons;

  // title for an annotation
  label?: string;

  // description of the annotaiton
  description?: string;

  // optional filename if attaching to a file
  filename?: string;

  //  optional line number if attaching to a file
  line?: number;

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

Icon and colors come from the Pierre design system. While not open sourced, you can use any color or icon from the system by name.