jobiqo-cl
Version:
[](https://circleci.com/gh/jobiqo/jobiqo-cl)
34 lines (33 loc) • 904 B
TypeScript
/**
* @file index.tsx
*
* @fileoverview Flag component. Renders a flag component.
*/
import * as React from 'react';
export interface FlagProps {
/**
* The contents on the flag message.
*/
children: React.ReactNode | string;
/**
* The theme props is passed automatically to the component via styled components.
*
* @default null
*/
theme?: any;
/**
* The style for the flag. The color of the flag element will be changed accordingly.
*
* @default "default"
*/
flagStyle?: 'default' | 'secondary' | 'success' | 'warning' | 'danger';
/**
* Event to call when closing the message.
*/
onClose?: () => void;
}
/**
* The flag is a label style element that can be used to show information.
*/
export declare const Flag: ({ flagStyle, children, onClose, ...props }: FlagProps) => JSX.Element;
export default Flag;