@craftercms/studio-ui/components/PathNavigator/PathNavigator.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 { DetailedItem } from '../../models/Item';
import { StateStylingProps } from '../../models/UiConfig';
import { SystemIconDescriptor } from '../SystemIcon';
import { GetChildrenOptions } from '../../models';
export interface PathNavigatorProps {
  id: string;
  label: string;
  rootPath: string;
  sortStrategy?: GetChildrenOptions['sortStrategy'];
  order?: GetChildrenOptions['order'];
  excludes?: string[];
  locale?: string;
  limit?: number;
  initialCollapsed?: boolean;
  icon?: SystemIconDescriptor;
  expandedIcon?: SystemIconDescriptor;
  collapsedIcon?: SystemIconDescriptor;
  container?: Partial<StateStylingProps>;
  classes?: Partial<Record<'root' | 'body' | 'searchRoot', string>>;
  onItemClicked?(item: DetailedItem, event?: React.MouseEvent): void;
  computeActiveItems?: (items: DetailedItem[]) => string[];
  createItemClickedHandler?: (
    defaultHandler: (item: DetailedItem, event?: React.MouseEvent) => void
  ) => (item: DetailedItem) => void;
}
export interface PathNavigatorStateProps {
  id: string;
  rootPath: string;
  currentPath: string;
  localeCode: string;
  keyword: string;
  isSelectMode: boolean;
  hasClipboard: boolean;
  levelDescriptor: string;
  itemsInPath: string[];
  breadcrumb: string[];
  selectedItems: string[];
  total: number;
  limit: number;
  offset: number;
  collapsed?: boolean;
  excludes?: string[];
  isFetching: boolean;
  error: any;
  isRootPathMissing: boolean;
  sortStrategy: GetChildrenOptions['sortStrategy'];
  order: GetChildrenOptions['order'];
}
export declare function PathNavigator(props: PathNavigatorProps): React.JSX.Element;
export default PathNavigator;