@gechiui/components
Version:
UI components for GeChiUI.
56 lines • 1.55 kB
TypeScript
/**
* External dependencies
*/
import type { CSSProperties } from 'react';
export declare type Props = {
/**
* Size of the shadow value when active (see the `value` and `isInteractive` props).
*/
active?: number;
/**
* Renders the border-radius of the shadow.
*
* @default 'inherit'
*/
borderRadius?: CSSProperties['borderRadius'];
/**
* Size of the shadow value when focused (see the `value` and `isInteractive` props).
*/
focus?: number;
/**
* Size of the shadow value when hovered (see the `value` and `isInteractive` props).
*/
hover?: number;
/**
* Determines if hover, active, and focus shadow values should be automatically calculated and rendered.
*
* @default false
*/
isInteractive?: boolean;
/**
* Dimensional offsets (margin) for the shadow.
*
* @default 0
*/
offset?: number;
/**
* Size of the shadow, based on the Style system's elevation system. The `value` determines the strength of the shadow, which sense of depth.
* In the example below, `isInteractive` is activated to give a better sense of depth.
*
* @example
* ```jsx
* import { __experimentalElevation as Elevation } from '@gechiui/components';
* * function Example() {
* return (
* <div>
* <Elevation isInteractive value={ 200 } />
* </div>
* );
* }
* ```
*
* @default 0
*/
value?: number;
};
//# sourceMappingURL=types.d.ts.map