Function li

  • li(first, ...rest): ListItemBlock

  • One list item. Its first child is a paragraph, so the first argument is inline content or a paragraph block; further children follow it, including nested lists.

    Parameters

    • first: {
          content: ({
              bold?: boolean;
              code?: boolean;
              italic?: boolean;
              link?: string;
              strike?: boolean;
              sub?: boolean;
              sup?: boolean;
              text: string;
              underline?: boolean;
          } | {
              mention: {
                  documentId?: string;
                  name?: string;
                  resourceId: string;
                  text?: string;
              };
          } | {
              break: true;
          })[];
          id?: string;
          kind: "paragraph";
      } | TextInput
    • Rest...rest: BlockInput[]

    Returns ListItemBlock

    Example

    const item = li('Candy Kingdom', ul('Candy Castle', 'Candy Village'))

Settings

Member Visibility