@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.
55 lines (54 loc) • 1.54 kB
TypeScript
import { CSSObject } from "@mantine/core";
import React from "react";
import { CommonLayoutProps } from "../../components/layout/layout.types";
import { CommonStylingProps } from "../../components/styling.types";
import { Color } from "../../components/theme/colors";
type TitleOrder = 1 | 2 | 3 | 4 | 5 | 6;
export type TitleProps = {
/**
* Title content
*/
children: React.ReactNode;
/**
* The size and style of the title with 1 being the largest and 6 being the smallest.
*
* @default 1
*/
order?: TitleOrder;
/**
* Title color
*/
color?: Color;
/** Sets font-weight css property */
weight?: React.CSSProperties["fontWeight"];
/** Sets text-transform css property */
transform?: React.CSSProperties["textTransform"];
/** Sets text-align css property */
align?: React.CSSProperties["textAlign"];
/**
* Adds font-style: italic
*/
italic?: boolean;
/**
* Underline the title
*/
underline?: boolean;
/**
* Add strikethrough style
*/
strikethrough?: boolean;
/**
* CSS style overrides
* @deprecated
*/
sx?: CSSObject;
} & CommonLayoutProps & CommonStylingProps;
export declare const TitleComponent: ({ className, style, order, color, ...props }: TitleProps) => import("react/jsx-runtime").JSX.Element;
/**
* @deprecated - Use Heading instead
*/
export declare const Title: {
(props: TitleProps): import("react/jsx-runtime").JSX.Element;
displayName: string;
};
export {};