@postenbring/hedwig-react
Version:
React components for [Hedwig Design System](https://github.com/bring/hedwig-design-system).
62 lines • 2.16 kB
TypeScript
import * as React from "react";
import { type ResponsiveSpacingSizes, type SpacingSizes } from "../spacing";
import { type ResponsiveProp } from "../responsive";
export interface StackProps extends React.HTMLAttributes<HTMLDivElement> {
children: React.ReactNode;
/**
* Space between items. Both horizontal and vertical.
*
* Use the responsive shorthand `12-16` to jump a level at the `large` breakpoint.
*
* Or use the responsive object `{ initial: 40, large: 64 }` to set different values at different breakpoints.
*
* Use `gapX` and `gapY` to set different values for horizontal and vertical spacing.
*/
gap?: ResponsiveProp<SpacingSizes> | ResponsiveSpacingSizes;
/**
* Space between items horizontally
*/
gapX?: ResponsiveProp<SpacingSizes> | ResponsiveSpacingSizes;
/**
* Space between items vertically
*/
gapY?: ResponsiveProp<SpacingSizes> | ResponsiveSpacingSizes;
direction?: ResponsiveProp<React.CSSProperties["flexDirection"]>;
wrap?: ResponsiveProp<boolean>;
align?: ResponsiveProp<React.CSSProperties["alignItems"]>;
justify?: ResponsiveProp<React.CSSProperties["justifyContent"]>;
/**
* Change the default rendered element for the one passed as a child, merging their props and behavior.
*
* @default false
*/
asChild?: boolean;
}
/**
* 🚨 WORK IN PROGRESS 🚨
*
* TODO
* - [ ] Add more examples
* - [ ] Document usage
* - [ ] Document props
*/
export declare const Stack: React.ForwardRefExoticComponent<StackProps & React.RefAttributes<HTMLDivElement>>;
/**
* 🚨 WORK IN PROGRESS 🚨
*
* TODO
* - [ ] Add more examples
* - [ ] Document usage
* - [ ] Document props
*/
export declare const HStack: React.ForwardRefExoticComponent<Omit<StackProps, "direction"> & React.RefAttributes<HTMLDivElement>>;
/**
* 🚨 WORK IN PROGRESS 🚨
*
* TODO
* - [ ] Add more examples
* - [ ] Document usage
* - [ ] Document props
*/
export declare const VStack: React.ForwardRefExoticComponent<Omit<StackProps, "direction"> & React.RefAttributes<HTMLDivElement>>;
//# sourceMappingURL=stack.d.ts.map