import { ChildrenLike, VirtualDOM } from '@youwol/rx-vdom'; import { MdParsingOptions } from '../markdown'; import { Router } from '../router'; /** * Note level in {@link NoteView}. */ export type NoteLevel = 'info' | 'warning' | 'hint'; /** * Represents a note on the page. * * This view is registered in {@link GlobalMarkdownViews}: it can be instantiated from Markdown using the tag * `note`. See constructor's documentation for details regarding its parameters. */ export declare class NoteView implements VirtualDOM<'div'> { readonly tag = "div"; readonly class: string; readonly children: ChildrenLike; readonly level: NoteLevel; readonly label: string; readonly content: string; readonly parsingArgs: { router: Router; } & MdParsingOptions; /** * @param params * @param params.level Either 'info', 'warning', 'success'. When instantiated from Markdown, this parameter is * retrieved from the attribute 'level'. * @param params.label Label to display. When instantiated from Markdown, this parameter is * retrieved from the attribute 'label'. If none is provided, it is by default `Note`, `Warning` & `Hint` for * levels 'info', 'warning', 'success' respectively. If an empty string is provided, no label will appear. * @param params.content Text content. When instantiated from Markdown, this parameter is * retrieved from the text content of the DOM element. */ constructor(params: { level: NoteLevel; label?: string; content: string; parsingArgs: { router?: Router; } & MdParsingOptions; }); }