UNPKG

@atlaskit/adf-schema

Version:

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

76 lines (75 loc) 3.13 kB
import type { BreakoutMarkDefinition } from '../marks'; import type { BlockCardDefinition as BlockCard } from './block-card'; import type { CodeBlockDefinition as CodeBlock } from './code-block'; import type { DecisionListDefinition as DecisionList } from './decision-list'; import type { HeadingDefinition as Heading } from './heading'; import type { MediaGroupDefinition as MediaGroup } from './media-group'; import type { MediaSingleDefinition as MediaSingle } from './media-single'; import type { ParagraphDefinition as Paragraph } from './paragraph'; import type { RuleDefinition as Rule } from './rule'; import type { BodiedRuleDefinition as BodiedRule } from './bodied-rule'; import type { TableDefinition as Table } from './tableNodes'; import type { TaskListDefinition as TaskList } from './task-list'; import type { OrderedListDefinition as OrderedList, BulletListDefinition as BulletList } from './types/list'; import type { MarksObject } from './types/mark'; export declare enum PanelType { INFO = "info", NOTE = "note", TIP = "tip", WARNING = "warning", ERROR = "error", SUCCESS = "success", CUSTOM = "custom" } export interface PanelAttributes { localId?: string; panelColor?: string; panelIcon?: string; panelIconId?: string; panelIconText?: string; panelType: PanelType; } /** * @name panel_node */ export interface PanelDefinition { attrs: PanelAttributes; /** // eslint-disable-next-line eslint-plugin-jsdoc/check-tag-names * @minItems 1 // eslint-disable-next-line eslint-plugin-jsdoc/check-tag-names * @allowUnsupportedBlock true */ content: Array<Paragraph | Heading | OrderedList | BulletList | BlockCard | CodeBlock | MediaGroup | MediaSingle | DecisionList | TaskList | Rule | BodiedRule>; type: 'panel'; } /** * @name panel_c1_node */ export interface PanelC1Definition { attrs: PanelAttributes; /** // eslint-disable-next-line eslint-plugin-jsdoc/check-tag-names * @minItems 1 // eslint-disable-next-line eslint-plugin-jsdoc/check-tag-names * @allowUnsupportedBlock true */ content: Array<Paragraph | Heading | OrderedList | BulletList | BlockCard | CodeBlock | MediaGroup | MediaSingle | DecisionList | TaskList | Rule | BodiedRule | Table>; type: 'panel'; } /** * @name panel_root_only_node */ export type PanelRootOnlyDefinition = PanelDefinition & MarksObject<BreakoutMarkDefinition>; export interface DOMAttributes { [propName: string]: string; } export { extendedPanel } from './extended-panel'; export { extendedPanelWithLocalId } from './extended-panel-with-local-id'; export { extendedPanelC1 } from './extended-panel-c1'; export { extendedPanelC1WithLocalId } from './extended-panel-c1-with-local-id'; export { extendedPanelRootOnlyStage0 } from './extended-panel-root-only-stage0'; export { extendedPanelC1RootOnlyStage0 } from './extended-panel-c1-root-only-stage0'; export { createPanelNodeSpecOptions } from './create-panel-node-spec-options'; export { getDomAttrs } from './get-dom-attrs'; export { getParseDOMAttrs } from './get-parse-dom-attrs';