@awsui/components-react
Version:
On July 19th, 2022, we launched [Cloudscape Design System](https://cloudscape.design). Cloudscape is an evolution of AWS-UI. It consists of user interface guidelines, front-end components, design resources, and development tools for building intuitive, en
46 lines • 1.74 kB
TypeScript
import React from 'react';
import { BaseComponentProps } from '../internal/base-component';
export interface HeaderProps extends BaseComponentProps {
/**
* The heading text. Plain text is recommended. The component renders the
* HTML heading tag based on the specified `variant` or `headingTagOverride`.
* @displayname title
*/
children?: React.ReactNode;
/**
* Specifies the variant of the header:
* * `h1` - Use this for page level headers.
* * `h2` - Use this for container level headers.
* * `h3` - Use this for section level headers.
* * `awsui-h1-sticky` - Use this for sticky headers in cards and tables.
* @visualrefresh `awsui-h1-sticky` variant
*/
variant?: HeaderProps.Variant;
/**
* Overrides the default [HTML heading tag](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/Heading_Elements)
* provided by the variant. Using this property does not change the visual appearance of the component.
*/
headingTagOverride?: HeaderProps.HeadingTag;
/**
* Supplementary text below the heading.
*/
description?: React.ReactNode;
/**
* Actions for the container.
*/
actions?: React.ReactNode;
/**
* Specifies secondary text that's displayed to the right of the heading title. This is commonly used
* to display resource counters in table and cards components.
*/
counter?: string;
/**
* Area next to the heading to display an Info link.
*/
info?: React.ReactNode;
}
export declare namespace HeaderProps {
type Variant = 'h1' | 'h2' | 'h3' | 'awsui-h1-sticky';
type HeadingTag = 'h1' | 'h2' | 'h3' | 'h4' | 'h5';
}
//# sourceMappingURL=interfaces.d.ts.map