@craftercms/studio-ui/components/PathNavigatorTree/PathNavigatorTree.d.ts

Services, components, models & utils to build CrafterCMS authoring extensions.

/*
 * Copyright (C) 2007-2022 Crafter Software Corporation. All Rights Reserved.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3 as published by
 * the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

import React from 'react';
import { PathNavigatorTreeUIProps } from './PathNavigatorTreeUI';
import { StateStylingProps } from '../../models/UiConfig';
import LookupTable from '../../models/LookupTable';
import { SystemIconDescriptor } from '../SystemIcon';
import { ApiResponse, GetChildrenOptions } from '../../models';
import SystemType from '../../models/SystemType';
import { PathNavigatorTreeItemProps } from './PathNavigatorTreeItem';
import SimpleAjaxError from '../../models/SimpleAjaxError';
export interface PathNavigatorTreeProps
  extends Pick<
    PathNavigatorTreeItemProps,
    'showNavigableAsLinks' | 'showPublishingTarget' | 'showWorkflowState' | 'showItemMenu'
  > {
  id: string;
  label: string;
  rootPath: string;
  sortStrategy?: GetChildrenOptions['sortStrategy'];
  order?: GetChildrenOptions['order'];
  excludes?: string[];
  limit?: number;
  icon?: SystemIconDescriptor;
  expandedIcon?: SystemIconDescriptor;
  collapsedIcon?: SystemIconDescriptor;
  container?: Partial<StateStylingProps>;
  initialCollapsed?: boolean;
  collapsible?: boolean;
  initialSystemTypes?: SystemType[];
  initialExpanded?: string[];
  onNodeClick?: PathNavigatorTreeUIProps['onLabelClick'];
  active?: PathNavigatorTreeItemProps['active'];
  classes?: Partial<Record<'header', string>>;
}
export interface PathNavigatorTreeStateProps {
  id: string;
  rootPath: string;
  collapsed: boolean;
  limit: number;
  expanded: string[];
  childrenByParentPath: LookupTable<string[]>;
  errorByPath: Record<string, SimpleAjaxError>;
  keywordByPath: LookupTable<string>;
  totalByPath: LookupTable<number>;
  offsetByPath: LookupTable<number>;
  excludes: string[];
  systemTypes: SystemType[];
  error: ApiResponse;
  isRootPathMissing: boolean;
  sortStrategy: GetChildrenOptions['sortStrategy'];
  order: GetChildrenOptions['order'];
}
export declare function PathNavigatorTree(props: PathNavigatorTreeProps): React.JSX.Element;
export default PathNavigatorTree;