json-joy
Version:
Collection of libraries for building collaborative editing apps.
150 lines (149 loc) • 6.14 kB
TypeScript
import { SliceStacking } from '../slice/constants';
import type { PeritextMlElement } from '../block/types';
import type { NodeBuilder } from '../../../json-crdt-patch';
import type { FromHtmlConverter, ToHtmlConverter } from './types';
import type { JsonNodeView } from '../../../json-crdt/nodes';
import type { SchemaToJsonNode } from '../../../json-crdt/schema/types';
import type { Printable } from 'tree-dump';
import type { TypeTag } from '../slice';
export declare class SliceBehavior<Stacking extends SliceStacking = SliceStacking, Tag extends TypeTag = TypeTag, Schema extends NodeBuilder = NodeBuilder, Data extends Record<string, unknown> = Record<string, unknown>> implements Printable {
/**
* Specifies whether the slice is an inline or block element. And if it is
* an inline element, whether multiple instances of the same tag are allowed
* to be applied to a range of tex - "Many", or only one instance - "One".
*/
readonly stacking: Stacking;
/**
* The tag name of this slice. The tag is one step in the type path of the
* slice. For example, below is a type path composed of three steps:
*
* ```js
* ['ul', 'li', 'p']
* ```
*
* Tag types are normally numbers of type {@link SliceTypeCon}, however,
* they can also be any arbitrary strings or numbers.
*/
readonly tag: Tag;
/**
* User friendly display name. Also used for translation purposes.
*/
readonly name: string;
/**
* Default expected schema of the slice data.
*/
readonly schema: Schema | undefined;
/**
* This property is relevant only for block split markers. It specifies
* whether the block split marker is a container for other block elements.
*
* For example, a `blockquote` is a container for `paragraph` elements,
* however, a `paragraph` is not a container (it can only contain inline
* elements).
*
* If the marker slice is of the container sort, they tag can appear in the
* path steps of the type:
*
* ```
*
* ```
*/
readonly container: boolean;
/**
* Converts a node of this type to HTML representation: returns the HTML tag
* and attributes. The method receives {@link PeritextMlElement} as an
* argument, which is a tuple of internal HTML-like representation of the
* node.
*/
readonly toHtml: ToHtmlConverter<PeritextMlElement<Tag, JsonNodeView<SchemaToJsonNode<Schema>>, Stacking extends SliceStacking.Marker ? false : true>> | undefined;
/**
* Specifies a mapping of converters from HTML {@link JsonMlElement} to
* {@link PeritextMlElement}. This way a slice type can specify multiple
* HTML tags that are converted to the same slice type.
*
* For example, both, `<b>` and `<strong>` tags can be converted to the
* {@link SliceTypeCon.b} slice type.
*/
readonly fromHtml?: {
[htmlTag: string]: FromHtmlConverter<PeritextMlElement<Tag, JsonNodeView<SchemaToJsonNode<Schema>>, Stacking extends SliceStacking.Marker ? false : true>>;
} | undefined;
isInline(): boolean;
/**
* An opaque object which can be mutated in-place by the rendering layer
* to store custom rendering-specific data. This is useful for storing, for
* example, React component references, which is specific to the rendering
* layer.
*
* Usage:
*
* ```ts
* registry.get(SliceTypeCon.a)?.data().ReactConfig = ReactConfigCompForLink;
* ```
*
* @returns The custom data of the slice.
*/
data(): Data;
constructor(
/**
* Specifies whether the slice is an inline or block element. And if it is
* an inline element, whether multiple instances of the same tag are allowed
* to be applied to a range of tex - "Many", or only one instance - "One".
*/
stacking: Stacking,
/**
* The tag name of this slice. The tag is one step in the type path of the
* slice. For example, below is a type path composed of three steps:
*
* ```js
* ['ul', 'li', 'p']
* ```
*
* Tag types are normally numbers of type {@link SliceTypeCon}, however,
* they can also be any arbitrary strings or numbers.
*/
tag: Tag,
/**
* User friendly display name. Also used for translation purposes.
*/
name: string,
/**
* Default expected schema of the slice data.
*/
schema?: Schema | undefined,
/**
* This property is relevant only for block split markers. It specifies
* whether the block split marker is a container for other block elements.
*
* For example, a `blockquote` is a container for `paragraph` elements,
* however, a `paragraph` is not a container (it can only contain inline
* elements).
*
* If the marker slice is of the container sort, they tag can appear in the
* path steps of the type:
*
* ```
*
* ```
*/
container?: boolean,
/**
* Converts a node of this type to HTML representation: returns the HTML tag
* and attributes. The method receives {@link PeritextMlElement} as an
* argument, which is a tuple of internal HTML-like representation of the
* node.
*/
toHtml?: ToHtmlConverter<PeritextMlElement<Tag, JsonNodeView<SchemaToJsonNode<Schema>>, Stacking extends SliceStacking.Marker ? false : true>> | undefined,
/**
* Specifies a mapping of converters from HTML {@link JsonMlElement} to
* {@link PeritextMlElement}. This way a slice type can specify multiple
* HTML tags that are converted to the same slice type.
*
* For example, both, `<b>` and `<strong>` tags can be converted to the
* {@link SliceTypeCon.b} slice type.
*/
fromHtml?: {
[htmlTag: string]: FromHtmlConverter<PeritextMlElement<Tag, JsonNodeView<SchemaToJsonNode<Schema>>, Stacking extends SliceStacking.Marker ? false : true>>;
} | undefined);
/** ----------------------------------------------------- {@link Printable} */
toString(tab?: string): string;
}