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

Merge branch 'canon-props-restructure' into canon-flex

Browse Source
This commit is contained in:
Charles de Dreuille
2025-01-27 22:03:53 +00:00
parent 0c1128ba88 8c137662a2
commit b9c1348823
3 changed files with 189 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/canon/report.api.md
+184 -29
View File
@@ -283,34 +283,9 @@ export const Field: {
}) => React_2.JSX.Element;
};
// @public (undocumented)
export const Flex: ForwardRefExoticComponent<
FlexProps & RefAttributes<HTMLDivElement>
>;
// @public (undocumented)
export type FlexDirection = 'row' | 'column';
// @public (undocumented)
export interface FlexProps extends SpaceProps {
// Warning: (ae-forgotten-export) The symbol "FlexOwnProps" needs to be exported by the entry point index.d.ts
//
// (undocumented)
align?: FlexOwnProps['align'];
// (undocumented)
children: React.ReactNode;
// (undocumented)
className?: string;
// (undocumented)
direction?: FlexOwnProps['direction'];
// (undocumented)
gap?: GapProps['gap'];
// (undocumented)
justify?: FlexOwnProps['justify'];
// (undocumented)
style?: React.CSSProperties;
}
// @public (undocumented)
export type FlexWrap = 'wrap' | 'nowrap' | 'wrap-reverse';
@@ -366,6 +341,97 @@ export const Grid: ForwardRefExoticComponent<
>;
};
// @public (undocumented)
export type GridItemOwnProps = GetPropDefTypes<typeof gridItemPropDefs>;
// @public (undocumented)
export const gridItemPropDefs: {
colSpan: {
type: 'enum | string';
className: string;
customProperties: '--col-span'[];
values: readonly [
'1',
'2',
'3',
'4',
'5',
'6',
'7',
'8',
'9',
'10',
'11',
'12',
'auto',
];
responsive: true;
};
colEnd: {
type: 'enum | string';
className: string;
customProperties: '--col-end'[];
values: readonly [
'1',
'2',
'3',
'4',
'5',
'6',
'7',
'8',
'9',
'10',
'11',
'12',
'auto',
];
responsive: true;
};
colStart: {
type: 'enum | string';
className: string;
customProperties: '--col-start'[];
values: readonly [
'1',
'2',
'3',
'4',
'5',
'6',
'7',
'8',
'9',
'10',
'11',
'12',
'auto',
];
responsive: true;
};
rowSpan: {
type: 'enum | string';
className: string;
customProperties: '--row-span'[];
values: readonly [
'1',
'2',
'3',
'4',
'5',
'6',
'7',
'8',
'9',
'10',
'11',
'12',
'auto',
];
responsive: true;
};
};
// @public (undocumented)
export interface GridItemProps {
// (undocumented)
@@ -374,8 +440,6 @@ export interface GridItemProps {
className?: string;
// (undocumented)
colEnd?: GridItemOwnProps['colEnd'];
// Warning: (ae-forgotten-export) The symbol "GridItemOwnProps" needs to be exported by the entry point index.d.ts
//
// (undocumented)
colSpan?: GridItemOwnProps['colSpan'];
// (undocumented)
@@ -386,14 +450,41 @@ export interface GridItemProps {
style?: React.CSSProperties;
}
// @public (undocumented)
export type GridOwnProps = GetPropDefTypes<typeof gridPropDefs>;
// @public (undocumented)
export const gridPropDefs: {
columns: {
type: 'enum | string';
className: string;
customProperties: '--columns'[];
values: readonly [
'1',
'2',
'3',
'4',
'5',
'6',
'7',
'8',
'9',
'10',
'11',
'12',
'auto',
];
responsive: true;
default: string;
};
};
// @public (undocumented)
export interface GridProps extends SpaceProps {
// (undocumented)
children?: React.ReactNode;
// (undocumented)
className?: string;
// Warning: (ae-forgotten-export) The symbol "GridOwnProps" needs to be exported by the entry point index.d.ts
//
// (undocumented)
columns?: GridOwnProps['columns'];
// (undocumented)
@@ -498,6 +589,37 @@ export type IconProps = {
// @public (undocumented)
export const icons: IconMap;
// @public (undocumented)
export const Inline: ForwardRefExoticComponent<
InlineProps & RefAttributes<HTMLElement>
>;
// @public (undocumented)
export interface InlineProps extends SpaceProps {
// (undocumented)
align?:
| 'left'
| 'center'
| 'right'
| Partial<Record<Breakpoint, 'left' | 'center' | 'right'>>;
// (undocumented)
alignY?:
| 'top'
| 'center'
| 'bottom'
| Partial<Record<Breakpoint, 'top' | 'center' | 'bottom'>>;
// (undocumented)
as?: AsProps;
// (undocumented)
children: React.ReactNode;
// (undocumented)
className?: string;
// (undocumented)
gap?: UtilityProps['gap'];
// (undocumented)
style?: React.CSSProperties;
}
// @public (undocumented)
export const Input: React_2.ForwardRefExoticComponent<
InputProps & React_2.RefAttributes<HTMLInputElement>
@@ -731,6 +853,39 @@ export interface SpaceProps {
py?: Responsive<Space>;
}
// @public (undocumented)
export const Stack: ForwardRefExoticComponent<
StackProps & RefAttributes<HTMLDivElement>
>;
// @public (undocumented)
export type StackOwnProps = GetPropDefTypes<typeof stackPropDefs>;
// @public (undocumented)
export const stackPropDefs: {
align: {
type: 'enum';
className: string;
values: readonly ['start', 'center', 'end', 'baseline', 'stretch'];
responsive: true;
default: 'stretch';
};
};
// @public (undocumented)
export interface StackProps extends SpaceProps {
// (undocumented)
align?: StackOwnProps['align'];
// (undocumented)
children: React.ReactNode;
// (undocumented)
className?: string;
// (undocumented)
gap?: GapProps['gap'];
// (undocumented)
style?: React.CSSProperties;
}
// @public (undocumented)
export type StringPropDef = {
type: 'string';
packages/canon/src/components/Flex/styles.css
+4 -4
View File
@@ -13,7 +13,7 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
.canon-Flex {
display: flex;
}
export { Stack } from './Stack';
export { stackPropDefs } from './Stack.props';
export type { StackProps } from './types';
export type { StackOwnProps } from './Stack.props';
packages/canon/src/components/Grid/index.ts
+1
View File
@@ -14,5 +14,6 @@
* limitations under the License.
*/
export { Grid } from './Grid';
export { gridPropDefs, gridItemPropDefs } from './Grid.props';
export type { GridProps, GridItemProps } from './types';
export type { GridOwnProps, GridItemOwnProps } from './Grid.props';