Options
All
  • Public
  • Public/Protected
  • All
Menu

@ftyyy/ytext

Index

References

Namespaces

Classes

Interfaces

Type Aliases

Variables

Functions

References

Re-exports AutoStack
Re-exports AutoStackButtons
Re-exports AutoStackedPopper
Re-exports AutoStackedPopper_Props
Re-exports AutoTooltip
Re-exports Direction
Re-exports DirectionValues
Re-exports ForceContain
Re-exports PrinterBackgroundPaper
Re-exports PrinterDisplayText
Re-exports PrinterDivider
Re-exports PrinterNewLevelBox
Re-exports PrinterOldLevelBox
Re-exports PrinterParagraphBox
Re-exports PrinterPartBox
Re-exports PrinterStructureBoxText
Re-exports PrinterWeakenText
Re-exports SimpleAutoStack
Re-exports ThemeOptions
Re-exports default_theme
Re-exports num2rem
Re-exports rem2num
Re-exports remtimes

Type Aliases

ActivatePositionFunction: ((position_list: string[], cur_position: string) => string)

Type declaration

    • (position_list: string[], cur_position: string): string
    • 确定聚焦时位置的函数。

      Parameters

      • position_list: string[]
      • cur_position: string

      Returns string

AllConceptTypes: "group" | "inline" | "structure" | "support" | "abstract"

所有可能的概念类型。

AllNodeTypes: "group" | "inline" | "structure" | "support" | "abstract" | "paragraph" | "text"

所有可能的节点类型。

ButtonDescription<OtherPropsType>: { component: ComponentClass<EditorButtonInformation & OtherPropsType> | FunctionComponent<EditorButtonInformation & OtherPropsType>; other_props?: OtherPropsType; skip_mouseless?: boolean } | ComponentClass<EditorButtonInformation & OtherPropsType> | FunctionComponent<EditorButtonInformation & OtherPropsType>

描述一个按钮。

Type Parameters

  • OtherPropsType = {}

所有概念节点。

Context: {}

渲染器所需要维护的节点的上下文。

Type declaration

  • [key: string | number]: any
DirectionKey: "ArrowLeft" | "ArrowRight" | "ArrowDown" | "ArrowUp"

所有方向按键。

EditorPlugin: ((editor: EditorComponent, slate: <internal>.ReactEditor) => <internal>.ReactEditor)
EditorRenderer<NodeType>: ((props: EditorRendererProps<NodeType>) => ReactElement)

Type Parameters

Type declaration

Env: {}

渲染器所需要维护的环境。

Type declaration

  • [key: string | number]: any
FirstClassConceptDict: ConceptDict<FirstClassConcept>

用来保存一级概念的字典。

FixedParameterValue: ParameterValue | { type: "function"; val: string }

固定参数项的可行类型。

MouselessActivateOperation: (() => void)

Type declaration

    • (): void
    • 无鼠标元素激活操作。

      Returns void

MouselessRegisterFunction: ((space: string, position: string, on_activate: MouselessActivateOperation, on_unactivate: MouselessUnActivateOperation, run: MouselessRun) => void)

Type declaration

MouselessRun: ((e?: KeyboardEvent<HTMLDivElement>) => void)

Type declaration

    • 无鼠标元素响应操作。

      Parameters

      Returns void

MouselessUnActivateOperation: ((new_position?: string) => void)

Type declaration

    • (new_position?: string): void
    • 无鼠标元素取消激活操作。

      Parameters

      • Optional new_position: string

      Returns void

MouselessUnRegisterFunction: ((space: string, position: string) => void)

Type declaration

    • (space: string, position: string): void
    • 无鼠标元素取消注册函数。

      Parameters

      • space: string
      • position: string

      Returns void

所有可能的节点。

NonLeafConceptNode: InlineNode | GroupNode | StructNode | SupportNode

所有概念节点,除了抽象节点。

所有树上非叶子的节点。

OnKeyDownFunction: ((e: KeyboardEvent<HTMLDivElement>) => boolean)

Type declaration

OnKeyUpFunction: ((e: KeyboardEvent<HTMLDivElement>) => boolean)

Type declaration

ParameterValue: { type: "string"; val: string } | { type: "number"; val: number } | { type: "boolean"; val: boolean }

所有参数项的可行类型。

PreprocessFunction<NodeType, ReturnType>: ((info: PreprocessInformation<NodeType>) => ReturnType)

Type Parameters

  • NodeType = Node

  • ReturnType = any

Type declaration

PrinterCache: {}

印刷器的临时缓存。

Type declaration

PrinterCacheItem: {}

印刷器的临时缓存的项目。

Type declaration

  • [key: string]: any
PrinterEnterFunction<NodeType>: ((node: Readonly<NodeType>, parameters: Readonly<ProcessedParameterList>, env_draft: Env, context_draft: Context) => void)

Type Parameters

Type declaration

PrinterExitFunction<NodeType>: ((node: Readonly<NodeType>, parameters: Readonly<ProcessedParameterList>, env_draft: Env, context_draft: Context) => [cache_result: PrinterCacheItem, finished: boolean])

Type Parameters

Type declaration

PrinterRenderFunction<NodeType>: ((props: PrinterRenderFunctionProps<NodeType>) => ReactElement<PrinterRenderFunctionProps<NodeType>>)

Type Parameters

Type declaration

ProcessedParameterList: {}

经过处理的参数列表。

Type declaration

  • [key: string]: any

用来保存各个一级概念的渲染器的字典。

RunKey: "Enter"

enter键。

SecondClassConceptDict: ConceptDict<SecondClassConcept>

用来保存二级概念的字典。

SwitchPositionFunction: ((position_list: string[], cur_position: string, direction: DirectionKey, all_keys: {}) => string)

Type declaration

    • (position_list: string[], cur_position: string, direction: DirectionKey, all_keys: {}): string
    • 确定按下方向键时的聚焦切换的函数。

      Parameters

      • position_list: string[]
      • cur_position: string
      • direction: DirectionKey
      • all_keys: {}
        • [key: string]: boolean

      Returns string

Variables

GlobalInfo: <internal>.Context<{}> = ...
KeyDownUpFunctionProxy: <internal>.Context<[OnKeyDownFunction, OnKeyUpFunction]> = ...

按键管理器向子节点提供按键按下操作和抬起操作的上下文。

提供无鼠标元素注册函数的上下文。

SPACE: "e" = "e"
default_editor_theme: theme.ThemeOptions = ...
tree_op_mixin: { add_nodes: any; add_nodes_after: any; add_nodes_before: any; add_nodes_here: any; auto_set_parameter: any; delete_concept_node: any; delete_node_by_path: any; delete_nodes_by_paths: any; move_concept_node: any; move_node_by_path: any; replace_nodes: any; set_node: any; set_node_by_path: any; unwrap_node: any; wrap_nodes: any; wrap_selected_nodes: any } = ...

这个混入对象提供所有跟节点树操作有关的函数。 基本上就是slateTransforms的代理。

Type declaration

useless_renderer_block: PrinterRenderer<Node> = ...

这个renderer总之提供一个默认的毫无功能的块级节点渲染实现。

useless_renderer_inline: PrinterRenderer<Node> = ...

这个renderer总之提供一个默认的毫无功能的行内节点渲染实现。

useless_renderer_text: PrinterRenderer<Node> = ...

这个renderer总之提供一个默认的毫无功能的文本节点渲染实现。 毕竟文本节点要什么功能....

Functions

  • AutoIconButton(props: { component?: "button" | "span"; icon?: any; onClick?: MouseEventHandler<HTMLButtonElement>; size?: "small" | "medium" | "large"; title?: string }): <internal>.Element
  • 这个函数是一个语法糖,用于自动创建带tooltip的按钮。

    Parameters

    • props: { component?: "button" | "span"; icon?: any; onClick?: MouseEventHandler<HTMLButtonElement>; size?: "small" | "medium" | "large"; title?: string }
      • Optional component?: "button" | "span"
      • Optional icon?: any
      • Optional onClick?: MouseEventHandler<HTMLButtonElement>
      • Optional size?: "small" | "medium" | "large"
      • Optional title?: string

    Returns <internal>.Element

  • 这个组件提供一个按钮,让一个概念节点新建一个抽象概念。

    Parameters

    • props: { anchor_element: any; node: ConceptNode; open: boolean; onClose?: any }
      • anchor_element: any
      • node: ConceptNode
      • open: boolean
      • onClose?:function
        • onClose(e: any): void
        • Parameters

          • e: any

          Returns void

    Returns <internal>.Element

  • 这个组件向具体的编辑器和具体的节点提供 DefaultParameterContainer ,并包含一个抽屉来打开关闭编辑界面。抽屉关闭时会调用 editor.apply_all() 来应用所有更新。

    Parameters

    Returns <internal>.Element

  • 包裹整个编辑器的纸张。

    Parameters

    Returns <internal>.Element

  • 对于一个不用纸张作为最外层元素的节点,这个组件用来提供其边框。

    Parameters

    Returns <internal>.Element

  • 这个组件定义默认的段落渲染方式。

    Parameters

    Returns <internal>.Element

  • 这个组件定义一个不可被选中的区域。用于 slate 的各种不希望被修改的辅助部分。

    Parameters

    Returns <internal>.Element

  • 这个组件用来代替GlobalInfo.Provider,其会自动合并提供的信息。

    Parameters

    • props: { children: any; value: {} }
      • children: any
      • value: {}
        • [key: string]: any

    Returns <internal>.Element

  • Parameters

    Returns { activate_position: ((position_list: string[], cur_position: string) => string); key: string; switch_position: SwitchPositionFunction }

    • activate_position: ((position_list: string[], cur_position: string) => string)
        • (position_list: string[], cur_position: string): string
        • Parameters

          • position_list: string[]
          • cur_position: string

          Returns string

    • key: string
    • switch_position: SwitchPositionFunction
  • 获得一个节点的类型的字符串。

    Parameters

    Returns AllNodeTypes

  • get_normalize_status(key: "initializing" | "pasting"): boolean
  • Parameters

    • key: "initializing" | "pasting"

    Returns boolean

  • 判断一个节点是不是抽象节点。

    Parameters

    Returns node is AbstractNode

  • 判断一个节点是不是概念节点。(包括组、行内、支撑、结构和抽象)

    Parameters

    Returns node is ConceptNode

  • 判断一个按键是不是方向键。

    Parameters

    • key: string

    Returns key is DirectionKey

  • is_enter(key: string): key is "Enter"
  • 判断一个按键是不是enter。

    Parameters

    • key: string

    Returns key is "Enter"

  • 判断一个节点是不是组节点。

    Parameters

    Returns node is GroupNode

  • 判断一个节点是不是行内节点。

    Parameters

    Returns node is InlineNode

  • 判断一个节点是不是段落节点。

    Parameters

    Returns node is ParagraphNode

  • 判断一个节点是不是组节点。

    Parameters

    Returns node is AbstractNode

  • 判断一个节点是不是支撑节点。

    Parameters

    Returns node is SupportNode

  • 判断一个节点是不是文本节点。

    Parameters

    Returns node is TextNode

  • merge_object(obj_1: any, obj_2: any): any
  • Parameters

    • obj_1: any
    • obj_2: any

    Returns any

  • object_foreach(obj: any, func: ((o: any) => any)): {}
  • 对对象的每个值进行操作,返回一个新的对象。

    Parameters

    • obj: any
    • func: ((o: any) => any)
        • (o: any): any
        • Parameters

          • o: any

          Returns any

    Returns {}

    • set_normalize_status(val: Partial<{ initializing: boolean; pasting: boolean }>): void
    • Parameters

      • val: Partial<{ initializing: boolean; pasting: boolean }>

      Returns void

    • 判断两个节点是否为同一个节点。这个函数会直接比较创建节点时分配的节点 idx 。

      Parameters

      Returns boolean

    • validate(tree: any, path?: number[]): [boolean, string]
    • 验证一棵树是不是合法的中间表示树。

      Parameters

      • tree: any

        要验证的树。

      • path: number[] = []

      Returns [boolean, string]

      第一个返回值说明这棵树是否合法,第二个返回值说明其为何不合法(如果不合法的话)。

    • validate_parameters(parameters: any, gene_msg: ((s: string) => string)): [boolean, string]
    • 这个函数验证一棵树的参数列表是否合法。

      Parameters

      • parameters: any

        要验证的参数列表。

      • gene_msg: ((s: string) => string)

        如果不合法,如何生成错误信息。

          • (s: string): string
          • Parameters

            • s: string

            Returns string

      Returns [boolean, string]

    Generated using TypeDoc