@difizen/libro-core v0.1.33

libro-core

Token/API

LibroService

LibroService 管理 libro 实例，libro view 创建、活跃 libro view 的监听等能力。

// 组件内引入
const service = useInject(LibroService);

// 属性引入
@inject(LibroService) service:LibroService;

// 事件监听
service.getOrCreateView(options);
service.onActiveChanged(callback);
service.onFocusChanged(callback);
service.onNotebookViewCreated(callback);

扩展点

单元格扩展

使用单元格扩展可以增加自定义的单元格类型，内置的单元格类型也均基于该扩展定义实现。

单元格定义分为 model 和 view 两部分，model 定义单元格的数据结构，view 定义单元格的渲染方式和提供交互能力。每种单元格都需要对创建时接收到的参数返回优先级，按照最高优先级的单元格类型创建单元格。

export interface CellModelContribution {
  cellMeta: CellMeta;
  canHandle: (options: CellOptions, libroType?: string) => number;
  createModel: (options: CellOptions) => MaybePromise<CellModel>;
  getDefaultCellOption?: () => CellOptions;
}
export interface CellViewContribution {
  canHandle: (options: CellOptions) => number;
  view: Newable<CellView>;
}

输出扩展

使用输出扩展可以增加自定义的输出类型，内置的输出类型也均基于该扩展定义实现。在 jupyter 场景下，用户一般不需要增加输出类型的扩展，而仅需要增加 mime 渲染器，mime 渲染器扩展由 output 实现。

export interface OutputContribution {
  canHandle: (output: IOutput) => number;
  factory: OutputModelFactory;
}

内容加载扩展

用户有时候从自定义存储中读取 notebook 数据，可以通过内容加载扩展来实现，这里要求用户的返回数据符合 notebook 的数据结构。

export interface ContentContribution {
  canHandle: (options: Record<string, any>, model: any) => number;
  loadContent: (options: Record<string, any>, model: any) => Promise<INotebookContent>;
}

视图插槽

如果希望在编辑器内部增加一些自定义的渲染像，除了可以覆盖内置的渲染器外，还可以通过视图插槽的方式来实现。

内置插槽位置如下：

• container
• content
• list
• right

export interface LibroExtensionSlotContribution {
  factory: LibroExtensionSlotFactory;
  slot: LibroSlot;
  viewOpenOption?: {
    order?: string;
    reveal?: boolean;
  };
}

命令 & 快捷键

文档命令

kernel 命令

notebook 命令

配置 & 主题

libro 内置了一些配置项和主题设置，用户可以是用 mana 的配置模块和主题模块来消费或变更。