@workday/canvas-kit-react
Version:
The parent module that contains all Workday Canvas Kit React components
62 lines • 2.16 kB
TypeScript
import { Property } from 'csstype';
import { StyleFnConfig } from './buildStyleFns';
/** style props to for CSS position properties */
export type PositionStyleProps = {
/**
* - sets [CSS position property](https://developer.mozilla.org/en-US/docs/Web/CSS/position)
* */
position?: Property.Position;
/**
* - sets [CSS z-index property](https://developer.mozilla.org/en-US/docs/Web/CSS/z-index)
* */
zIndex?: Property.ZIndex;
/**
* - sets [CSS top property](https://developer.mozilla.org/en-US/docs/Web/CSS/top)
* */
top?: number | string;
/**
* - sets [CSS right property](https://developer.mozilla.org/en-US/docs/Web/CSS/right)
* - no bidirectional support
* */
right?: number | string;
/**
* - sets [CSS bottom property](https://developer.mozilla.org/en-US/docs/Web/CSS/bottom)
* */
bottom?: number | string;
/**
* - sets [CSS left property](https://developer.mozilla.org/en-US/docs/Web/CSS/left)
* - no bidirectional support
* */
left?: number | string;
/**
* - sets [CSS inset property](https://developer.mozilla.org/en-US/docs/Web/CSS/inset)
*/
inset?: number | string;
/**
* - sets [CSS inset-inline-start property](https://developer.mozilla.org/en-US/docs/Web/CSS/inset-inline-start)
* - bidirectional support
* */
insetInlineStart?: number | string;
/**
* - sets [CSS inset-inline-end property](https://developer.mozilla.org/en-US/docs/Web/CSS/inset-inline-end)
* - bidirectional support
* */
insetInlineEnd?: number | string;
};
export declare const positionStyleFnConfigs: StyleFnConfig[];
export declare const positionStyleFns: import("./buildStyleFns").StyleFns;
/**
* A style prop function that takes component props and returns position styles.
* If no `PositionProps` are found, it returns an empty object.
*
* @example
* ```
* const BoxExample = () => (
* <Box position="absolute" top="50%">
* Hello, positions!
* </Box>
* );
* ```
*/
export declare const position: (props: PositionStyleProps) => {};
//# sourceMappingURL=position.d.ts.map