Function default

  • change the determine node check status to true

    Example

    import { checkNode } from "tree-handle-lib";
    const node = [
       {
           key: "1",
           checked: false,
           halfChecked: false,
           children: [
             {
               key: "1-1",
               checked: false,
               halfChecked: false,
               children: [
                 {
                   key: "1-1-1",
                   checked: false,
                   halfChecked: false,
                   children: [
                     {
                       key: "1-1-1-1",
                       checked: false,
                       halfChecked: false,
                     },
                   ],
                 },
               ],
             },
             {
               key: "1-2",
               checked: false,
               halfChecked: false,
               children: [{ key: "1-2-1", checked: false, halfChecked: false }],
             },
           ],
         }
    ];
    const _node = checkNode(node, "1-1-1");
    // [
    //   {
    //     key: "1",
    //     checked: false,
    //     halfChecked: true,
    //     children: [
    //       {
    //         key: "1-1",
    //         checked: true,
    //         halfChecked: false,
    //         children: [
    //           {
    //             key: "1-1-1",
    //             checked: true,
    //             halfChecked: false,
    //             children: [{ key: "1-1-1-1", checked: true, halfChecked: false }],
    //           },
    //         ],
    //       },
    //       {
    //         key: "1-2",
    //         checked: false,
    //         halfChecked: false,
    //         children: [{ key: "1-2-1", checked: false, halfChecked: false }],
    //       },
    //     ],
    //   },
    // ];

    Parameters

    • node: TNode

      the root node of the tree, can be a single node or an array of nodes

    • key: string

      the key of the node to check

    • checkedName: string = CHECKED_NAME

      the checked name of the node in the tree structure, default value is CHECKED_NAME='checked'

    • halfCheckedName: string = HALF_CHECKED_NAME

      the halfChecked name of the node in the tree structure, default value is HALF_CHECKED_NAME='halfChecked'

    • keyName: string = KEY_NAME

      the key name of the node in the tree structure, default value is KEY_NAME='key'

    • childrenName: string = CHILDREN_NAME

      the child key name of the child node in the tree structure, default value is CHILDREN_NAME='children'

    Returns TNode

    node | null

Settings

Member Visibility

Theme

Generated using TypeDoc