@airplane/views
Version:
A React library for building Airplane views. Views components are optimized in style and functionality to produce internal apps that are easy to build and maintain.
43 lines (42 loc) • 1.31 kB
TypeScript
import React from "react";
import { CommonLayoutProps } from "../../components/layout/layout.types";
import { CommonStylingProps } from "../../components/styling.types";
import { Color } from "../../components/theme/colors";
import { FontWeight } from "../../components/theme/typography";
type HeadingLevel = 1 | 2 | 3 | 4 | 5 | 6;
export type HeadingProps = {
/**
* Heading content.
*/
children: React.ReactNode;
/**
* The size and style of the Heading with 1 being the largest and 6 being the smallest.
*
* @default 1
*/
level?: HeadingLevel;
/**
* Heading color.
*/
color?: Color;
/** Controls the font weight. */
weight?: FontWeight;
/**
* Adds italic style.
*/
italic?: boolean;
/**
* Adds underline style.
*/
underline?: boolean;
/**
* Adds strikethrough style.
*/
strikethrough?: boolean;
} & CommonLayoutProps & CommonStylingProps;
export declare const HeadingComponent: ({ children, className, style, level, color, weight, italic, underline, strikethrough, width, height, grow, }: HeadingProps) => import("react/jsx-runtime").JSX.Element;
export declare const Heading: {
(props: HeadingProps): import("react/jsx-runtime").JSX.Element;
displayName: string;
};
export {};