npf2html/build/src/text-block.d.ts

Converts Tumblr's Neue Post Format to plain HTML

import { InlineFormat } from './inline-format';
import { Renderer } from './renderer';
/**
 * An NPF text type content block.
 *
 * @see https://www.tumblr.com/docs/npf#content-block-type-text
 *
 * @category Content
 */
export type TextBlock = TextBlockNoIndent | TextBlockIndented;
/**
 * The base interface for all types of text blocks.
 *
 * @category Content
 */
interface TextBlockBase {
    type: 'text';
    /** The text to use inside this block. */
    text: string;
    /**
     * The subtype of text block.
     *
     * @see https://www.tumblr.com/docs/npf#text-block-subtypes
     */
    subtype?: 'heading1' | 'heading2' | 'quirky' | 'quote' | 'indented' | 'chat' | 'ordered-list-item' | 'unordered-list-item';
    /**
     * Inline formatting for this text.
     *
     * @see https://www.tumblr.com/docs/npf#inline-formatting-within-a-text-block
     */
    formatting?: InlineFormat[];
}
/**
 * A text block of a type that doesn't allow indentation.
 *
 * @category Content
 */
export interface TextBlockNoIndent extends TextBlockBase {
    subtype?: 'heading1' | 'heading2' | 'quirky' | 'quote' | 'chat';
}
/**
 * A text block of a type that allows indentation.
 *
 * @category Content
 */
export interface TextBlockIndented extends TextBlockBase {
    /**
     * The subtype of text block.
     *
     * @see https://www.tumblr.com/docs/npf#text-block-subtypes
     */
    subtype: 'indented' | 'ordered-list-item' | 'unordered-list-item';
    /** @see https://www.tumblr.com/docs/npf#text-block-subtype-list-item */
    indent_level?: number;
}
/**
 * Converts {@link block} to HTML.
 *
 * @category Content
 */
export declare function renderTextNoIndent(renderer: Renderer, block: TextBlockNoIndent): string;
/**
 * Converts {@link blocksAndNested} to HTML.
 *
 * The first element of {@link blocksAndNested} determines the subtype of the
 * entire thing; any other blocks are guaranteed to have the same subtype. The
 * string elements of {@link blocksAndNested} ar {@link TextBlockIndented}
 * objects which are more deeply nested and have already been converted to HTML.
 *
 * @category Content
 */
export declare function renderTextIndented(renderer: Renderer, blocksAndNested: [TextBlockIndented, ...Array<TextBlockIndented | string>]): string;
export {};