@atlaskit/adf-schema
Version:
Shared package that contains the ADF-schema (json) and ProseMirror node/mark specs
40 lines (39 loc) • 1.15 kB
TypeScript
import type { NodeSpec } from '@atlaskit/editor-prosemirror/model';
import type { BreakoutMarkDefinition } from '../marks';
import type { MarksObject } from './types/mark';
export type RuleStyle = 'solid' | 'dashed' | 'dotted' | 'sketch' | 'fade';
export interface RuleAttributes {
color?: string;
localId?: string;
style?: RuleStyle;
weight?: number;
}
/**
* @name rule_node
*/
export interface RuleDefinition {
attrs?: {
localId?: string;
};
type: 'rule';
}
/**
* @name rule_root_only_node
*/
export type RuleRootOnlyDefinition = RuleDefinition & MarksObject<BreakoutMarkDefinition>;
/**
* @name rule_with_attrs_node
*/
export interface RuleWithAttrsDefinition {
attrs?: RuleAttributes;
type: 'rule';
}
/**
* @name rule_with_attrs_root_only_node
*/
export type RuleWithAttrsRootOnlyDefinition = RuleWithAttrsDefinition & MarksObject<BreakoutMarkDefinition>;
export declare const rule: NodeSpec;
export declare const ruleWithLocalId: NodeSpec;
export declare const ruleWithAttrs: NodeSpec;
export declare const ruleRootOnlyStage0: NodeSpec;
export declare const ruleWithAttrsRootOnlyStage0: NodeSpec;