jobiqo-cl
Version:
[](https://circleci.com/gh/jobiqo/jobiqo-cl)
42 lines (41 loc) • 1.42 kB
TypeScript
/**
* @file index.tsx
*
* @fileoverview Renders a badge using the styles provided in the theme.
*/
/// <reference types="react" />
export declare const StyledSpanBadge: import("styled-components").StyledComponent<"span", any, any, never>;
export interface BadgeProps {
/**
* The content to be displayed inside the badge.
*
* @default "null"
*/
children: string;
/**
* The style for the badge. The color of the badge element will be changed accordingly.
*
* @default "default"
*/
badgeStyle?: 'primary' | 'primaryLight' | 'primaryVeryLight' | 'secondary' | 'secondaryLight' | 'secondaryVeryLight' | 'default' | 'success' | 'successLight' | 'successVeryLight' | 'danger' | 'dangerLight' | 'dangerVeryLight' | 'warning' | 'warningLight' | 'warningVeryLight';
/**
* The theme props is passed automatically to the component via styled components.
*
* @default null
*/
theme?: any;
}
/**
* Badges contain numeric values, like the number of unread messages.
* Use badges to label page items with a small amount of information that help.
* Badges are normally placed before or after the label of the thing they're quantifying
* and contain on.
*/
export declare const Badge: {
({ children, badgeStyle }: BadgeProps): JSX.Element;
defaultProps: {
badgeStyle: string;
theme: any;
};
};
export default Badge;