jobiqo-cl/lib/components/02-atoms/11-well/index.d.ts

[](https://circleci.com/gh/jobiqo/jobiqo-cl)

/**
 * @file index.tsx
 *
 * @fileoverview Well component.
 */
/// <reference types="react" />
import { ColorProps, SpaceProps } from 'styled-system';
declare type WellMainProps = SpaceProps & ColorProps;
export interface WellProps extends WellMainProps {
    /**
     * The content that goes inside the well component.
     */
    children: string;
    /**
     * The style for the well. The color of the well element will be changed accordingly.
     *
     * @default "default"
     */
    wellStyle?: 'default' | 'warningLight' | 'warning' | 'primary' | 'primaryLight' | 'secondary' | 'secondaryLight';
    /**
     * The theme props is passed automatically to the component via styled components.
     *
     * @default null
     */
    theme?: any;
}
/**
 * This component renders a well with some content inside. It has specific styling. It can be used in a
 * variety of situations but always should be used agains the background so that it contrasts with the background color.
 */
export declare const Well: ({ children, wellStyle, ...props }: WellProps) => JSX.Element;
export default Well;