Skip to content

Latest commit

 

History

History
67 lines (56 loc) · 1.55 KB

File metadata and controls

67 lines (56 loc) · 1.55 KB

API Report File for "@backstage/plugin-github-issues"

Do not edit this file. It is a report generated by API Extractor.

/// <reference types="react" />

import { BackstagePlugin } from '@backstage/core-plugin-api';
import { RouteRef } from '@backstage/core-plugin-api';

// @public (undocumented)
export interface GithubIssuesByRepoOptions {
  // (undocumented)
  filterBy?: GithubIssuesFilters;
  // (undocumented)
  orderBy?: GithubIssuesOrdering;
}

// @public (undocumented)
export const GithubIssuesCard: (props: GithubIssuesProps) => JSX.Element;

// @public (undocumented)
export interface GithubIssuesFilters {
  // (undocumented)
  assignee?: string;
  // (undocumented)
  createdBy?: string;
  // (undocumented)
  labels?: string[];
  // (undocumented)
  mentioned?: string;
  // (undocumented)
  milestone?: string;
  // (undocumented)
  states?: ('OPEN' | 'CLOSED')[];
}

// @public (undocumented)
export interface GithubIssuesOrdering {
  // (undocumented)
  direction?: 'ASC' | 'DESC';
  // (undocumented)
  field: 'CREATED_AT' | 'UPDATED_AT' | 'COMMENTS';
}

// @public (undocumented)
export const GithubIssuesPage: (props: GithubIssuesProps) => JSX.Element;

// @public (undocumented)
export const githubIssuesPlugin: BackstagePlugin<
  {
    root: RouteRef<undefined>;
  },
  {},
  {}
>;

// @public (undocumented)
export type GithubIssuesProps = {
  itemsPerPage?: number;
  itemsPerRepo?: number;
  filterBy?: GithubIssuesFilters;
  orderBy?: GithubIssuesOrdering;
};

// (No @packageDocumentation comment for this package)