paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 49 Packages Projects Releases Wiki Activity

Fix report API

Browse Source 
Signed-off-by: Charles de Dreuille <charles.dedreuille@gmail.com>
This commit is contained in:
Charles de Dreuille
2024-12-18 18:29:45 +00:00
parent dbe1718dc9
commit 91643897ef
2 changed files with 47 additions and 133 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/canon/report.api.md
+30 -90
View File
@@ -43,7 +43,18 @@ export type Background =
>;
// @public (undocumented)
export type BorderRadius = 'none' | 'small' | 'medium' | 'full';
export type Border = 'none' | 'base' | 'error' | 'warning' | 'selected';
// @public (undocumented)
export type BorderRadius =
| 'none'
| '2xs'
| 'xs'
| 'sm'
| 'md'
| 'lg'
| 'xl'
| '2xl';
// @public (undocumented)
export const Box: ForwardRefExoticComponent<
@@ -62,35 +73,9 @@ export interface BoxProps extends UtilityProps {
style?: React.CSSProperties;
}
// @public (undocumented)
export type BoxShadow = 'small' | 'medium' | 'large';
// @public (undocumented)
export type Breakpoint = 'xs' | 'sm' | 'md' | 'lg' | 'xl' | '2xl';
// @public (undocumented)
export type BreakpointLocal = keyof typeof breakpoints;
// @public (undocumented)
export const breakpoints: {
xs: {};
sm: {
'@media': string;
};
md: {
'@media': string;
};
lg: {
'@media': string;
};
xl: {
'@media': string;
};
'2xl': {
'@media': string;
};
};
// @public (undocumented)
export const Button: React_2.ForwardRefExoticComponent<
ButtonProps & React_2.RefAttributes<HTMLButtonElement>
@@ -200,7 +185,7 @@ export type FlexDirection = 'row' | 'column';
export type FlexWrap = 'wrap' | 'nowrap' | 'wrap-reverse';
// @public (undocumented)
export type Gap = SpaceLocal | Partial<Record<BreakpointLocal, SpaceLocal>>;
export type Gap = Space | Partial<Record<Breakpoint, Space>>;
// @public (undocumented)
export const Grid: ForwardRefExoticComponent<
@@ -312,85 +297,50 @@ export type JustifyContent =
| 'between';
// @public (undocumented)
export type Margin = SpaceLocal | Partial<Record<BreakpointLocal, SpaceLocal>>;
export type Margin = Space | Partial<Record<Breakpoint, Space>>;
// @public (undocumented)
export type MarginBottom =
| SpaceLocal
| Partial<Record<BreakpointLocal, SpaceLocal>>;
export type MarginBottom = Space | Partial<Record<Breakpoint, Space>>;
// @public (undocumented)
export type MarginLeft =
| SpaceLocal
| Partial<Record<BreakpointLocal, SpaceLocal>>;
export type MarginLeft = Space | Partial<Record<Breakpoint, Space>>;
// @public (undocumented)
export type MarginRight =
| SpaceLocal
| Partial<Record<BreakpointLocal, SpaceLocal>>;
export type MarginRight = Space | Partial<Record<Breakpoint, Space>>;
// @public (undocumented)
export type MarginTop =
| SpaceLocal
| Partial<Record<BreakpointLocal, SpaceLocal>>;
export type MarginTop = Space | Partial<Record<Breakpoint, Space>>;
// @public (undocumented)
export type MarginX = SpaceLocal | Partial<Record<BreakpointLocal, SpaceLocal>>;
export type MarginX = Space | Partial<Record<Breakpoint, Space>>;
// @public (undocumented)
export type MarginY = SpaceLocal | Partial<Record<BreakpointLocal, SpaceLocal>>;
export type MarginY = Space | Partial<Record<Breakpoint, Space>>;
// @public (undocumented)
export type Padding = SpaceLocal | Partial<Record<BreakpointLocal, SpaceLocal>>;
export type Padding = Space | Partial<Record<Breakpoint, Space>>;
// @public (undocumented)
export type PaddingBottom =
| SpaceLocal
| Partial<Record<BreakpointLocal, SpaceLocal>>;
export type PaddingBottom = Space | Partial<Record<Breakpoint, Space>>;
// @public (undocumented)
export type PaddingLeft =
| SpaceLocal
| Partial<Record<BreakpointLocal, SpaceLocal>>;
export type PaddingLeft = Space | Partial<Record<Breakpoint, Space>>;
// @public (undocumented)
export type PaddingRight =
| SpaceLocal
| Partial<Record<BreakpointLocal, SpaceLocal>>;
export type PaddingRight = Space | Partial<Record<Breakpoint, Space>>;
// @public (undocumented)
export type PaddingTop =
| SpaceLocal
| Partial<Record<BreakpointLocal, SpaceLocal>>;
export type PaddingTop = Space | Partial<Record<Breakpoint, Space>>;
// @public (undocumented)
export type PaddingX =
| SpaceLocal
| Partial<Record<BreakpointLocal, SpaceLocal>>;
export type PaddingX = Space | Partial<Record<Breakpoint, Space>>;
// @public (undocumented)
export type PaddingY =
| SpaceLocal
| Partial<Record<BreakpointLocal, SpaceLocal>>;
export type PaddingY = Space | Partial<Record<Breakpoint, Space>>;
// @public (undocumented)
export type Space = 'none' | '2xs' | 'xs' | 'sm' | 'md' | 'lg' | 'xl' | '2xl';
// @public (undocumented)
export const space: {
none: number;
'2xs': string;
xs: string;
sm: string;
md: string;
lg: string;
xl: string;
'2xl': string;
};
// @public (undocumented)
export type SpaceLocal = keyof typeof space;
// @public (undocumented)
export interface SpaceProps {
// (undocumented)
@@ -491,26 +441,16 @@ export const TableRow: React_3.ForwardRefExoticComponent<
>;
// @public (undocumented)
export type Theme = keyof typeof themes;
// @public (undocumented)
export const themes: {
light: {
selector: string;
};
dark: {
selector: string;
};
};
export type Theme = 'light' | 'dark';
// @public (undocumented)
export interface UtilityProps {
// (undocumented)
alignItems?: AlignItems | Partial<Record<Breakpoint, AlignItems>>;
// (undocumented)
borderRadius?: BorderRadius | Partial<Record<Breakpoint, BorderRadius>>;
border?: Border | Partial<Record<Breakpoint, Border>>;
// (undocumented)
boxShadow?: BoxShadow | Partial<Record<Breakpoint, BoxShadow>>;
borderRadius?: BorderRadius | Partial<Record<Breakpoint, BorderRadius>>;
// (undocumented)
display?: Display | Partial<Record<Breakpoint, Display>>;
// (undocumented)
packages/canon/src/layout/types.ts
+17 -43
View File
@@ -14,81 +14,55 @@
* limitations under the License.
*/
import { breakpoints, space, themes } from './properties';
import type { Breakpoint, Space } from '../types';
/** @public */
export type BreakpointLocal = keyof typeof breakpoints;
export type Theme = 'light' | 'dark';
/** @public */
export type SpaceLocal = keyof typeof space;
export type Gap = Space | Partial<Record<Breakpoint, Space>>;
/** @public */
export type Theme = keyof typeof themes;
export type PaddingLeft = Space | Partial<Record<Breakpoint, Space>>;
/** @public */
export type Gap = SpaceLocal | Partial<Record<BreakpointLocal, SpaceLocal>>;
export type PaddingRight = Space | Partial<Record<Breakpoint, Space>>;
/** @public */
export type PaddingLeft =
| SpaceLocal
| Partial<Record<BreakpointLocal, SpaceLocal>>;
export type PaddingTop = Space | Partial<Record<Breakpoint, Space>>;
/** @public */
export type PaddingRight =
| SpaceLocal
| Partial<Record<BreakpointLocal, SpaceLocal>>;
export type PaddingBottom = Space | Partial<Record<Breakpoint, Space>>;
/** @public */
export type PaddingTop =
| SpaceLocal
| Partial<Record<BreakpointLocal, SpaceLocal>>;
export type Padding = Space | Partial<Record<Breakpoint, Space>>;
/** @public */
export type PaddingBottom =
| SpaceLocal
| Partial<Record<BreakpointLocal, SpaceLocal>>;
export type PaddingX = Space | Partial<Record<Breakpoint, Space>>;
/** @public */
export type Padding = SpaceLocal | Partial<Record<BreakpointLocal, SpaceLocal>>;
export type PaddingY = Space | Partial<Record<Breakpoint, Space>>;
/** @public */
export type PaddingX =
| SpaceLocal
| Partial<Record<BreakpointLocal, SpaceLocal>>;
export type MarginLeft = Space | Partial<Record<Breakpoint, Space>>;
/** @public */
export type PaddingY =
| SpaceLocal
| Partial<Record<BreakpointLocal, SpaceLocal>>;
export type MarginRight = Space | Partial<Record<Breakpoint, Space>>;
/** @public */
export type MarginLeft =
| SpaceLocal
| Partial<Record<BreakpointLocal, SpaceLocal>>;
export type MarginTop = Space | Partial<Record<Breakpoint, Space>>;
/** @public */
export type MarginRight =
| SpaceLocal
| Partial<Record<BreakpointLocal, SpaceLocal>>;
export type MarginBottom = Space | Partial<Record<Breakpoint, Space>>;
/** @public */
export type MarginTop =
| SpaceLocal
| Partial<Record<BreakpointLocal, SpaceLocal>>;
export type Margin = Space | Partial<Record<Breakpoint, Space>>;
/** @public */
export type MarginBottom =
| SpaceLocal
| Partial<Record<BreakpointLocal, SpaceLocal>>;
export type MarginX = Space | Partial<Record<Breakpoint, Space>>;
/** @public */
export type Margin = SpaceLocal | Partial<Record<BreakpointLocal, SpaceLocal>>;
/** @public */
export type MarginX = SpaceLocal | Partial<Record<BreakpointLocal, SpaceLocal>>;
/** @public */
export type MarginY = SpaceLocal | Partial<Record<BreakpointLocal, SpaceLocal>>;
export type MarginY = Space | Partial<Record<Breakpoint, Space>>;
/** @public */
export interface SpaceProps {