@atlaskit/adf-schema
Version:
Shared package that contains the ADF-schema (json) and ProseMirror node/mark specs
56 lines (55 loc) • 2.6 kB
TypeScript
import type { ExtensionAttributes } from './types/extensions';
import type { BodiedExtensionDefinition as BodiedExtension } from './bodied-extension';
import type { PanelDefinition as Panel } from './panel';
import type { ParagraphDefinition as Paragraph } from './paragraph';
import type { BlockQuoteDefinition as Blockquote } from './blockquote';
import type { OrderedListDefinition as OrderedList, BulletListDefinition as BulletList } from './types/list';
import type { RuleDefinition as Rule } from './rule';
import type { HeadingDefinition as Heading } from './heading';
import type { CodeBlockDefinition as CodeBlock } from './code-block';
import type { MediaGroupDefinition as MediaGroup } from './media-group';
import type { MediaSingleDefinition as MediaSingle } from './media-single';
import type { DecisionListDefinition as DecisionList } from './decision-list';
import type { TaskListDefinition as TaskList } from './task-list';
import type { TableDefinition as Table } from './tableNodes';
import type { ExtensionDefinition as Extension } from './extension';
import type { BlockCardDefinition as BlockCard } from './block-card';
import type { EmbedCardDefinition as EmbedCard } from './embed-card';
import type { DataConsumerDefinition, FragmentDefinition } from '../marks';
import type { NodeSpec } from '@atlaskit/editor-prosemirror/model';
/**
// eslint-disable-next-line eslint-plugin-jsdoc/check-tag-names
* @stage 0
* @name extensionFrame_node
* @description Wraps the block content
*/
export interface ExtensionFrameDefinition {
/**
// eslint-disable-next-line eslint-plugin-jsdoc/check-tag-names
* @minItems 1
*/
content: Array<BodiedExtension | Panel | Paragraph | Blockquote | OrderedList | BulletList | Rule | Heading | CodeBlock | MediaGroup | MediaSingle | DecisionList | TaskList | Table | Extension | BlockCard | EmbedCard>;
marks?: Array<DataConsumerDefinition | FragmentDefinition>;
type: 'extensionFrame';
}
/**
* @returns NodeSpec for ExtensionFrameDefinition
*/
export declare const extensionFrame: NodeSpec;
/**
// eslint-disable-next-line eslint-plugin-jsdoc/check-tag-names
* @stage 0
* @name multiBodiedExtension_node
* @description Wraps multiple extensionFrame objects.
*/
export interface MultiBodiedExtensionDefinition {
attrs: ExtensionAttributes;
/**
// eslint-disable-next-line eslint-plugin-jsdoc/check-tag-names
* @minLength 1
*/
content: Array<ExtensionFrameDefinition>;
marks?: Array<any>;
type: 'multiBodiedExtension';
}
export declare const multiBodiedExtension: NodeSpec;