jobiqo-cl
Version:
[](https://circleci.com/gh/jobiqo/jobiqo-cl)
39 lines (38 loc) • 970 B
TypeScript
/**
* @file index.tsx
*
* @fileoverview The HeroRow component.
*/
import React from 'react';
import { SpaceProps } from 'styled-system';
declare type BaseHeroRowProps = SpaceProps;
export interface HeroRowProps extends BaseHeroRowProps {
/**
* The image to render as background.
*/
image: {
url: string;
alt: string;
title: string;
portrait?: {
url: string;
};
};
/**
* The content to display on top of the image.
*/
children?: React.ReactNode;
/**
* Content to show inside a box on the bottom part of the banner.
*/
boxContent?: React.ReactNode;
/**
* The position for the box content.
*/
boxPosition?: 'left' | 'bottom';
}
/**
* This component provides a hero image and an overlaying text.
*/
export declare const HeroRow: ({ image, children, boxContent, boxPosition, ...props }: HeroRowProps) => JSX.Element;
export default HeroRow;