ink/build/components/Text.d.ts

React for CLI

import React, { type ReactNode } from 'react';
import { type ForegroundColorName } from 'chalk';
import { type LiteralUnion } from 'type-fest';
import { type Styles } from '../styles.js';
export type Props = {
    /**
    A label for the element for screen readers.
    */
    readonly 'aria-label'?: string;
    /**
    Hide the element from screen readers.
    */
    readonly 'aria-hidden'?: boolean;
    /**
    Change text color. Ink uses Chalk under the hood, so all its functionality is supported.
    */
    readonly color?: LiteralUnion<ForegroundColorName, string>;
    /**
    Same as `color`, but for the background.
    */
    readonly backgroundColor?: LiteralUnion<ForegroundColorName, string>;
    /**
    Dim the color (make it less bright).
    */
    readonly dimColor?: boolean;
    /**
    Make the text bold.
    */
    readonly bold?: boolean;
    /**
    Make the text italic.
    */
    readonly italic?: boolean;
    /**
    Make the text underlined.
    */
    readonly underline?: boolean;
    /**
    Make the text crossed out with a line.
    */
    readonly strikethrough?: boolean;
    /**
    Inverse background and foreground colors.
    */
    readonly inverse?: boolean;
    /**
    This property tells Ink to wrap or truncate text if its width is larger than the container. If `wrap` is passed (the default), Ink will wrap text and split it into multiple lines. If `truncate-*` is passed, Ink will truncate text instead, resulting in one line of text with the rest cut off.
    */
    readonly wrap?: Styles['textWrap'];
    readonly children?: ReactNode;
};
/**
This component can display text and change its style to make it bold, underlined, italic, or strikethrough.
*/
export default function Text({ color, backgroundColor, dimColor, bold, italic, underline, strikethrough, inverse, wrap, children, 'aria-label': ariaLabel, 'aria-hidden': ariaHidden, }: Props): React.JSX.Element | null;