@dotcms/react
Version:
Official React Components library to render a dotCMS page.
38 lines (37 loc) • 1.22 kB
TypeScript
import { DotPageAssetLayoutColumn } from '@dotcms/types';
/**
* @internal
*
* Props for the Column component, which represents a single column in the grid layout system.
*
* @export
* @interface ColumnProps
* @property {DotPageAssetLayoutColumn} column - Column configuration from dotCMS Page API including
* width, leftOffset, styleClass, and containers
*/
export interface ColumnProps {
readonly column: DotPageAssetLayoutColumn;
}
/**
* @internal
*
* Renders a Column component that represents a single column in a 12-column grid system.
* The column's position and width are determined by the leftOffset and width properties
* from the dotCMS Page API. Uses CSS Grid classes for positioning.
*
* @example
* ```tsx
* <Column column={{
* leftOffset: 0,
* width: 6,
* styleClass: "custom-class",
* containers: []
* }} />
* ```
*
* @see {@link https://www.dotcms.com/docs/latest/page-rest-api-layout-as-a-service-laas}
* @export
* @param {ColumnProps} { column } - Column configuration object
* @return {JSX.Element} Rendered column with its containers positioned in the grid
*/
export declare function Column({ column }: ColumnProps): import("react/jsx-runtime").JSX.Element;