@withjoy/joykit
Version:
UI Component Library for Joy web
32 lines (31 loc) • 1.13 kB
TypeScript
import React from 'react';
import { ResponsiveWidthProps, ResponsiveBackgroundColorProps, ResponsiveFlexProps, ResponsiveOrderProps, ResponsiveAlignSelfProps, ResponsiveSpaceProps, ResponsiveHeightProps, ResponsiveColorsProps } from '../../common/styledSystem/types';
export interface BoxProps extends ResponsiveAlignSelfProps, ResponsiveBackgroundColorProps, ResponsiveColorsProps, ResponsiveFlexProps, ResponsiveHeightProps, ResponsiveWidthProps, ResponsiveOrderProps, ResponsiveSpaceProps {
component?: keyof JSX.IntrinsicElements | React.ComponentType<any>;
transitionProperties?: string[];
className?: string;
}
/**
* A simple component that supports most system properties.
*
* @example
*
* ```
* <Box
* marginBottom={{
* xs: 'xxxs'
* }}
* >
* I'm inside a box
* </Box>
*
* // To enhance a box beyond it's API,
* // use styled as a method and wrap the Box component - as such:
*
* styled(Box)'
* ...
* ';
* ```
*
*/
export declare const Box: React.ForwardRefExoticComponent<BoxProps & React.HTMLAttributes<any> & React.RefAttributes<HTMLElement>>;