semantic-ui-react/src/elements/Header/Header.d.ts

The official Semantic-UI-React integration.

import * as React from 'react';

import {
  SemanticCOLORS,
  SemanticFLOATS,
  SemanticTEXTALIGNMENTS
} from '../..';
import { default as HeaderContent } from './HeaderContent';
import { default as HeaderSubHeader } from './HeaderSubheader';

export interface HeaderProps {
  [key: string]: any;

  /** An element type to render as (string or function). */
  as?: any;

  /** Attach header  to other content, like a segment. */
  attached?: boolean | 'top' | 'bottom';

  /** Format header to appear inside a content block. */
  block?: boolean;

  /** Primary content. */
  children?: React.ReactNode;

  /** Additional classes. */
  className?: string;

  /** Color of the header. */
  color?: SemanticCOLORS;

  /** Shorthand for primary content. */
  content?: React.ReactNode;

  /** Show that the header is inactive. */
  disabled?: boolean;

  /** Divide header from the content below it. */
  dividing?: boolean;

  /** Header can sit to the left or right of other content. */
  floated?: SemanticFLOATS;

  /** Add an icon by icon name or pass an Icon. */
  icon?: any;

  /** Add an image by img src or pass an Image. */
  image?: any;

  /** Inverts the color of the header for dark backgrounds. */
  inverted?: boolean;

  /** Content headings are sized with em and are based on the font-size of their container. */
  size?: 'tiny' | 'small' | 'medium' | 'large' | 'huge';

  /** Headers may be formatted to label smaller or de-emphasized content. */
  sub?: boolean;

  /** Shorthand for Header.Subheader. */
  subheader?: any;

  /** Align header content. */
  textAlign?: SemanticTEXTALIGNMENTS;
}

interface HeaderComponent extends React.StatelessComponent<HeaderProps> {
  Content: typeof HeaderContent;
  Subheader: typeof HeaderSubHeader;
}

declare const Header: HeaderComponent;

export default Header;