Add API report

Signed-off-by: Charles de Dreuille <charles.dedreuille@gmail.com>
2024-11-26 09:06:08 +00:00
parent d4c4cebea8
commit 090828ce43
1 changed files with 110 additions and 0 deletions
@@ -0,0 +1,110 @@
+## API Report File for "@backstage/canon"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+/// <reference types="react" />
+
+import { CSSProperties } from 'react';
+import { JSXElementConstructor } from 'react';
+import { default as React_2 } from 'react';
+import { ReactElement } from 'react';
+import { ReactNode } from 'react';
+import { ResponsiveArray } from '@vanilla-extract/sprinkles';
+
+// Warning: (ae-missing-release-tag) "Box" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export const Box: ({
+  as,
+  className,
+  style,
+  ...props
+}: BoxProps) => ReactElement<
+  {
+    className: string;
+    style: CSSProperties | undefined;
+  },
+  string | JSXElementConstructor<any>
+>;
+
+// Warning: (ae-forgotten-export) The symbol "Sprinkles" needs to be exported by the entry point index.d.ts
+// Warning: (ae-forgotten-export) The symbol "HTMLProperties" needs to be exported by the entry point index.d.ts
+// Warning: (ae-missing-release-tag) "BoxProps" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export type BoxProps = Sprinkles &
+  HTMLProperties & {
+    as?: keyof JSX.IntrinsicElements;
+  };
+
+// Warning: (ae-missing-release-tag) "Button" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export const Button: ({
+  size,
+  variant,
+  children,
+  disabled,
+  iconStart,
+  iconEnd,
+  ...props
+}: ButtonProps) => React_2.JSX.Element;
+
+// Warning: (ae-missing-release-tag) "ButtonProps" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface ButtonProps {
+  // (undocumented)
+  children: React_2.ReactNode;
+  // (undocumented)
+  disabled?: boolean;
+  // (undocumented)
+  iconEnd?: IconNames;
+  // (undocumented)
+  iconStart?: IconNames;
+  // (undocumented)
+  size?: 'small' | 'medium';
+  // (undocumented)
+  variant?: 'primary' | 'secondary';
+}
+
+// Warning: (ae-missing-release-tag) "Icon" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export const Icon: ({ name }: { name: IconNames }) => React_2.JSX.Element;
+
+// Warning: (ae-missing-release-tag) "IconNames" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export type IconNames =
+  | 'ArrowDown'
+  | 'ArrowLeft'
+  | 'ArrowRight'
+  | 'ArrowUp'
+  | 'Cloud'
+  | 'CustomIcon';
+
+// Warning: (ae-missing-release-tag) "IconProvider" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export const IconProvider: ({
+  children,
+  overrides,
+}: {
+  children: ReactNode;
+  overrides: IconMap;
+}) => React_2.JSX.Element;
+
+// Warning: (ae-forgotten-export) The symbol "IconContextProps" needs to be exported by the entry point index.d.ts
+// Warning: (ae-missing-release-tag) "useIcons" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export const useIcons: () => IconContextProps;
+
+// Warnings were encountered during analysis:
+//
+// src/components/icon/context.d.ts:9:5 - (ae-forgotten-export) The symbol "IconMap" needs to be exported by the entry point index.d.ts
+
+// (No @packageDocumentation comment for this package)
+```