From 090828ce43f1198b630a340137c022494356830c Mon Sep 17 00:00:00 2001 From: Charles de Dreuille Date: Tue, 26 Nov 2024 09:06:08 +0000 Subject: [PATCH] Add API report Signed-off-by: Charles de Dreuille --- packages/canon/report.api.md | 110 +++++++++++++++++++++++++++++++++++ 1 file changed, 110 insertions(+) create mode 100644 packages/canon/report.api.md diff --git a/packages/canon/report.api.md b/packages/canon/report.api.md new file mode 100644 index 0000000000..818a6e4e61 --- /dev/null +++ b/packages/canon/report.api.md @@ -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 +/// + +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 +>; + +// 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) +```