ink-divider/dist/index.d.ts

Divider component for Ink

import { TextProps, BoxProps } from 'ink';

/**
 * Props for the Divider component.
 */
interface DividerProps {
    /**
     * Title shown in the middle of the divider.
     *
     * @example
     * ```tsx
     * <Divider title="Title" />
     *
     * // ─────────── Title ───────────
     * ```
     *
     * @default null
     */
    title?: string;
    /**
     * Width of the divider.
     *
     * @example
     * ```tsx
     * <Divider width={50} />
     *
     * // ──────────────────────────────────────────────────
     * ```
     * @default 'auto'
     */
    width?: 'auto' | number;
    /**
     * Padding at the start and the end of the divider.
     *
     * @example
     * ```tsx
     * <Divider padding={2} />
     *
     * // ··─────────────────────────────··
     * ```
     * @default 0
     */
    padding?: number;
    /**
     * Padding besides the title in the middle.
     *
     * @example
     * ```tsx
     * <Divider title="My title" titlePadding={3} />
     *
     * // ─────────   Title   ─────────
     * ```
     *
     * @default 1
     */
    titlePadding?: number;
    /**
     * Color of the title.
     *
     * @example
     * ```tsx
     * <Divider title="My title" titleColor="green" />
     * ```
     *
     * @default 'white'
     */
    titleColor?: TextProps['color'];
    /**
     * Char used as a divider.
     *
     * @example
     * ```tsx
     * <Divider dividerChar="=" />
     *
     * // =============================
     * ```
     *
     * @default '─'
     */
    dividerChar?: string;
    /**
     * Color of the divider's border. Matches the type of `borderColor` in the Ink `Box` component.
     * Accepts standard Ink color names or hex codes.
     *
     * @example
     * ```tsx
     * <Divider dividerColor="red" />
     * ```
     *
     * @default 'gray'
     */
    dividerColor?: BoxProps['borderColor'];
    /**
     * Additional props to be passed to the underlying Ink `Box` component.
     *
     *  @example
     * ```tsx
     * <Divider boxProps={{ marginTop: 2 }} />
     *
     *
     * //
     * //
     * //  ─────────────────────────────
     * ```
     */
    boxProps?: BoxProps;
}
/**
 * A horizontal divider component styled as a single border line.
 *
 * @example
 * ```tsx
 * import { render } from 'ink'
 * import Divider from 'ink-divider'
 *
 * render(<Divider title='Title' />)
 *
 * // ─────────── Title ───────────
 * ```
 *
 * @returns A styled divider.
 */
declare const Divider: React.FC<DividerProps>;

export { Divider as default };