@massds/mayflower-react/dist/CompHeading/index.d.ts

React versions of Mayflower design system UI components

/**
 * CompHeading module.
 * @module @massds/mayflower-react/CompHeading
 * @requires module:@massds/mayflower-assets/scss/01-atoms/comp-heading
 */
import React from 'react';
export interface CompHeadingProps {
    /** The heading text displayed. */
    title?: string;
    /** Hidden context of title element for accessibility. */
    titleContext?: string;
    /** The heading level e.g. H1, H2, etc. */
    level?: number;
    /** Being deprecated, use level instead. */
    sub?: boolean;
    /** The color of the heading underline. */
    color?: string;
    /** The heading id. */
    id?: string;
    /** Whether you want the heading to be centered or left on the page. */
    centered?: boolean;
    /** Whether you want the heading to be a sidebar or not. */
    sidebar?: boolean;
    children?: React.ReactNode;
}
declare const CompHeading: {
    (props: CompHeadingProps): any;
    defaultProps: {
        titleContext: string;
        level: number;
        sub: boolean;
        color: string;
        id: string;
        centered: boolean;
        sidebar: boolean;
    };
};
export default CompHeading;