aws-northstar
Version:
NorthStar Design System
41 lines (37 loc) • 2.1 kB
TypeScript
/** *******************************************************************************************************************
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
Licensed under the Apache License, Version 2.0 (the "License").
You may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License. *
******************************************************************************************************************** */
import { FunctionComponent, ChangeEvent } from 'react';
export interface TreeItemNode {
id: string;
label: string;
url?: string;
classes?: {};
children?: TreeItemNode[];
}
export interface TreeViewProps {
/** The root node of the tree */
root: TreeItemNode;
/** Ids of items to be expanded by default */
defaultExpanded?: string[];
/** Selected node ids. (Uncontrolled) When multiSelect is true this takes an array of strings; when false (default) a string. */
defaultSelected?: string[] | [];
/** Fired when the user clicks any node in the tree. The event detail contains the current value */
onNodeSelect?: (event: ChangeEvent<{}>, nodeIds: string[]) => void;
/** Fired when the user expands any node in the tree. The event detail contains the current value */
onNodeToggle?: (event: ChangeEvent<{}>, nodeIds: string[]) => void;
/** If true ctrl and shift will trigger multiselect. */
multiSelect?: boolean;
}
/** A tree view is useful for displaying hierarchical or grouped structures such as a file system. */
declare const TreeView: FunctionComponent<TreeViewProps>;
export default TreeView;