@metamask/snaps-sdk
Version:
A library containing the core functionality for building MetaMask Snaps
39 lines • 1.44 kB
text/typescript
import type { Infer } from "@metamask/superstruct";
import { NodeType } from "../nodes.mjs";
export declare const HeadingStruct: import("@metamask/superstruct").Struct<{
value: string;
type: NodeType.Heading;
}, {
type: import("@metamask/superstruct").Struct<NodeType.Heading, null>;
value: import("@metamask/superstruct").Struct<string, null>;
}>;
/**
* A heading node, that renders the text as a heading. The level of the heading
* is determined by the depth of the heading in the document.
*
* @property type - The type of the node, must be the string 'text'.
* @property value - The text content of the node, either as plain text, or as a
* markdown string.
*/
export type Heading = Infer<typeof HeadingStruct>;
/**
* Create a {@link Heading} node.
*
* @param args - The node arguments. This can either be a string, or an object
* with the `value` property.
* @param args.value - The heading text.
* @returns The heading node as object.
* @deprecated Snaps component functions are deprecated, in favor of the new JSX
* components. This function will be removed in a future release.
* @example
* const node = heading({ value: 'Hello, world!' });
* const node = heading('Hello, world!');
*/
export declare const heading: (...args: string[] | [Omit<{
value: string;
type: NodeType.Heading;
}, "type">]) => {
value: string;
type: NodeType.Heading;
};
//# sourceMappingURL=heading.d.mts.map