Shared `slotsTokenizer` for directive blocks

Đang mở
#1,301 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

@makhnatkin đang làm issue này rồi.

Từ ngày 1/10/2026.

  • #1303 của @makhnatkin — đang mở

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
20/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
markdown, typescript
Lĩnh vực
frontend

Hướng nghiên cứu

Start from the existing cut extension and container directive registration that call builder.configureMd; trace how each parses its body into Markdown-it tokens and where schema expressions are declared. Implement the shared router behind blockContentSlots and slotsTokenizer, then compare both token streams shown in the issue. Done when cut routes paragraphs/images and header routes actions/content, with preview and WYSIWYG specs accepting the same routed stream.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

Edited by AI
"Generated" means mostly the model, "Edited" means mostly the author.

Problem

Different blocks split their Markdown body into several parts. Each part limits which content it accepts and how many items it holds. Implemented in each block's own contentTokenizer, this selection and routing logic is duplicated.

Solution

A shared slotsTokenizer function takes rules for named parts (slots) and returns a tokenizer for the existing contentTokenizer field of container directives.

The block declares its slots and their limits. The shared function parses the body, selects content and emits slot wrappers.

Contract

The field in ContainerDirectiveConfig from @diplodoc/directive:

contentTokenizer?: (
    state: StateBlock,
    content: BlockContent,
    params: ContainerDirectiveParams,
) => void;

The directive handler calls it between the block's opening and closing tokens. The function adds the body tokens to state.tokens.

slotsTokenizer returns a function with this signature:

type SlotMatch = (group: readonly Token[]) => boolean;

type SlotRule = {
    slot: string;
    match: SlotMatch;
    limit?: number;
    className?: string;
};

declare function slotsTokenizer(
    name: string,
    rules: readonly SlotRule[],
): NonNullable<ContainerDirectiveConfig['contentTokenizer']>;

declare function byType(...types: string[]): SlotMatch;
  • name — directive name. The body is parsed with parentType <name>-directive, as by the default tokenizer.
  • slot — unique slot name. The wrapper is a <slot>_open / <slot>_close pair with the div tag.
  • match — condition for content the slot accepts.
  • limit — maximum number of groups in the slot per block instance: a positive integer, unlimited by default.
  • className — optional CSS class of the wrapper.
  • byType — matches the type of the group's first token.

A group is a standalone top-level token, or an opening token with everything up to its matching closing token. A group is moved as a whole.

Processing rules

  1. Groups are processed in source order.
  2. A group goes to the first slot whose match returns true and whose limit is not reached.
  3. A group no slot accepts is dropped. A last slot with match: () => true keeps the remaining content.
  4. Slots are emitted in rule order, and groups keep source order within a slot. Empty slots emit their wrappers too.
  5. Moved tokens get level + 1. A wrapper's map spans its groups.
  6. match receives the whole group with inline.children filled, so it can check nested markup. Markdown-it fills children in the core inline rule after block parsing, so slotsTokenizer fills them itself without duplicates after that rule runs.
  7. Preview and WYSIWYG use the same token stream. Editor slot nodes accept the content their rules accept, including an empty slot.

Usage

registerContainerDirective(md, {
    name: 'block',
    match: () => true,
    container: {tag: 'div', token: 'block'},
    contentTokenizer: slotsTokenizer('block', [
        {slot: 'block-a', match: byType('paragraph_open'), limit: 1},
        {slot: 'block-b', match: byType('paragraph_open', 'bullet_list_open')},
    ]),
});

The first paragraph goes to block-a. Later paragraphs and bullet lists go to block-b. Everything else is dropped.

Ngôn ngữ chính
TypeScript
Star
428
Fork
48
Merge trung bình
5 ngày 15 giờ
Pull request đã merge (30 ngày)
47

Chuẩn bị môi trường

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của gravity-ui/markdown-editor

Tất cả issue của gravity-ui/markdown-editor

Issue tương tự

Thêm issue về TypeScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.