@gechiui/components
Version:
UI components for GeChiUI.
62 lines (51 loc) • 1.57 kB
JavaScript
;
var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
Object.defineProperty(exports, "__esModule", {
value: true
});
exports.default = void 0;
var _element = require("@gechiui/element");
var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
var _context = require("../ui/context");
var _view = require("../view");
var _hook = require("./hook");
/**
* Internal dependencies
*/
/**
* @param {import('../ui/context').GeChiUIComponentProps<import('./types').Props, 'div'>} props
* @param {import('react').Ref<any>} forwardedRef
*/
function Elevation(props, forwardedRef) {
const elevationProps = (0, _hook.useElevation)(props);
return (0, _element.createElement)(_view.View, (0, _extends2.default)({}, elevationProps, {
ref: forwardedRef
}));
}
/**
* `Elevation` is a core component that renders shadow, using the library's shadow system.
*
* The shadow effect is generated using the `value` prop.
*
* @example
* ```jsx
* import {
* __experimentalElevation as Elevation,
* __experimentalSurface as Surface,
* __experimentalText as Text,
* } from '@gechiui/components';
*
* function Example() {
* return (
* <Surface>
* <Text>Code is Poetry</Text>
* <Elevation value={ 5 } />
* </Surface>
* );
* }
* ```
*/
const ConnectedElevation = (0, _context.contextConnect)(Elevation, 'Elevation');
var _default = ConnectedElevation;
exports.default = _default;
//# sourceMappingURL=component.js.map