react-checkbox-tree/src/index.d.ts

A simple and elegant checkbox tree for React.

import * as React from 'react';

declare module "react-checkbox-tree" {
    interface Node {
        label: React.ReactNode;
        value: string;
        children?: Array<Node>;
        className?: string;
        disabled?: boolean;
        icon?: React.ReactNode;
        showCheckbox?: boolean;
        title?: string;
    }

    interface OnCheckNode extends Node {
        checked: boolean;
    }

    interface OnExpandNode extends Node {
        expanded: boolean;
    }

    interface Icons {
        check?: React.ReactNode;
        uncheck?: React.ReactNode;
        halfCheck?: React.ReactNode;
        expandOpen?: React.ReactNode;
        expandClose?: React.ReactNode;
        expandAll?: React.ReactNode;
        collapseAll?: React.ReactNode;
        parentClose?: React.ReactNode;
        parentOpen?: React.ReactNode;
        leaf?: React.ReactNode;
    }

    interface Language {
        collapseAll: string;
        collapseNode: string;
        expandAll: string;
        expandNode: string;
    }

    interface CheckboxProps {
        nodes: Array<Node>;

        checkModel?: 'leaf' | 'all';
        checked?: Array<string>;
        direction?: 'ltr' | 'rtl';
        disabled?: boolean;
        expandDisabled?: boolean;
        expandOnClick?: boolean;
        expanded?: Array<string>;
        icons?: Icons;
        iconsClass?: string;
        id?: string;
        lang?: Language;
        name?: string;
        nameAsArray?: boolean;
        nativeCheckboxes?: boolean;
        noCascade?: boolean;
        onlyLeafCheckboxes?: boolean;
        optimisticToggle?: boolean;
        showExpandAll?: boolean;
        showNodeIcon?: boolean;
        showNodeTitle?: boolean;
        onCheck?: (checked: Array<string>, node: OnCheckNode) => void;
        onClick?: (node: OnCheckNode) => void;
        onExpand?: (expanded: Array<string>, node: OnExpandNode) => void;
    }

    export default class CheckboxTree extends React.Component<CheckboxProps> {}
    function expandNodesToLevel (nodes: Array<Node>, targetLevel: number): Array<string>
}