UNPKG

@atlaskit/adf-schema

Version:

Shared package that contains the ADF-schema (json) and ProseMirror node/mark specs

65 lines (64 loc) 1.87 kB
import { NodeSpec, Node as PMNode } from '@atlaskit/editor-prosemirror/model'; import { MediaDefinition as Media } from './media'; import { LinkDefinition } from '../marks/link'; import { ExtendedMediaAttributes } from './types/rich-media-common'; import { CaptionDefinition as Caption } from './caption'; export type MediaSingleDefinition = MediaSingleFullDefinition | MediaSingleWithCaptionDefinition; /** * @name mediaSingle_node * @additionalProperties true */ export interface MediaSingleBaseDefinition { type: 'mediaSingle'; attrs?: ExtendedMediaAttributes; marks?: Array<LinkDefinition>; } /** * @additionalProperties true */ export interface MediaCaptionContent { /** * @minItems 1 * @maxItems 2 * @allowUnsupportedBlock true */ content: [Media, Caption?]; } /** * @name mediaSingle_caption_node */ export type MediaSingleWithCaptionDefinition = MediaSingleBaseDefinition & MediaCaptionContent; /** * @additionalProperties true */ export interface MediaSingleFullContent { /** * @minItems 1 * @maxItems 1 * @allowUnsupportedBlock true */ content: Array<Media>; } /** * @name mediaSingle_full_node */ export type MediaSingleFullDefinition = MediaSingleBaseDefinition & MediaSingleFullContent; export declare const defaultAttrs: { width: { default: null; }; layout: { default: string; }; }; export declare const mediaSingleSpec: ({ withCaption, withExtendedWidthTypes, }: { withCaption?: boolean | undefined; withExtendedWidthTypes?: boolean | undefined; }) => NodeSpec; export declare const mediaSingle: NodeSpec; export declare const mediaSingleWithCaption: NodeSpec; export declare const mediaSingleWithWidthType: NodeSpec; export declare const mediaSingleFull: NodeSpec; export declare const toJSON: (node: PMNode) => { attrs: any; };