@neo4j-ndl/react
Version:
React implementation of Neo4j Design System
50 lines (49 loc) • 3.77 kB
TypeScript
/**
*
* Copyright (c) "Neo4j"
* Neo4j Sweden AB [http://neo4j.com]
*
* This file is part of Neo4j.
*
* Neo4j is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
import type React from 'react';
import { type CommonProps, type PolymorphicCommonProps } from '../_common/types';
import type { CategoryItemProps, MenuGroupProps, MenuItemProps, MenuItemsProps, MenuProps, RadioItemProps } from './menu-types';
declare const MenuComponent: <T extends React.ElementType = "div">({ children, isOpen: controlledOpen, onClose, isRoot, anchorRef, as, className, placement, minWidth, title, isDisabled, description, icon, isPortaled, portalTarget, htmlAttributes, strategy, ref: forwardedRef, style, }: PolymorphicCommonProps<T, MenuProps>) => import("react/jsx-runtime").JSX.Element;
/**
* @remarks
* `isRoot` is determined internally by checking for a parent context menu. If no parent exists, the component renders as the root menu; otherwise, a nested menu item trigger is rendered. When `isRoot` is `false`, the `title`, `description`, `icon`, and `isDisabled` props are forwarded to the nested menu item trigger component.
*
* @remarks
* The `placement` prop defaults to `bottom-start` when it is the root menu and `right-start` when it is a nested menu item trigger.
*
* @remarks
* The `strategy` prop is set to `fixed` when the context menu is inside a `Dialog` otherwise it is set to `absolute`.
*/
declare const Menu: ((props: React.ComponentProps<typeof MenuComponent>) => import("react/jsx-runtime").JSX.Element) & {
CategoryItem: <T extends React.ElementType = "button">({ children, className, style, as, htmlAttributes, ref, ...restProps }: PolymorphicCommonProps<T, CategoryItemProps>) => import("react/jsx-runtime").JSX.Element;
Divider: <T extends React.ElementType = "div">({ orientation, as, style, className, htmlAttributes, ref, ...restProps }: PolymorphicCommonProps<T, {
orientation?: "horizontal" | "vertical";
}>) => import("react/jsx-runtime").JSX.Element;
Group: ({ children, className, htmlAttributes, style, ref, ...restProps }: CommonProps<"div", MenuGroupProps>) => import("react/jsx-runtime").JSX.Element;
Item: <T extends React.ElementType = "button">({ title, className, style, leadingVisual, trailingContent, description, isDisabled, as, onClick, onFocus, htmlAttributes, id, ref, ...restProps }: PolymorphicCommonProps<T, MenuItemProps>) => import("react/jsx-runtime").JSX.Element;
/**
* @deprecated Use Menu.Group instead if you want to group items together. If not, you can just omit this component in your implementation.
*/
Items: <T extends React.ElementType = "div">({ as, children, className, htmlAttributes, style, ref, ...restProps }: PolymorphicCommonProps<T, MenuItemsProps>) => import("react/jsx-runtime").JSX.Element;
RadioItem: <T extends React.ElementType = "button">({ title, leadingVisual, trailingContent, description, isDisabled, isChecked, onClick, onFocus, className, style, as, id, htmlAttributes, ref, ...restProps }: PolymorphicCommonProps<T, RadioItemProps>) => import("react/jsx-runtime").JSX.Element;
};
export { Menu };
//# sourceMappingURL=Menu.d.ts.map