@mui/x-data-grid-premium
Version:
The Premium plan edition of the MUI X Data Grid Components.
102 lines • 3.97 kB
JavaScript
import _extends from "@babel/runtime/helpers/esm/extends";
import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWithoutPropertiesLoose";
const _excluded = ["render", "className", "onClick", "onPointerUp"];
import * as React from 'react';
import PropTypes from 'prop-types';
import useId from '@mui/utils/useId';
import { forwardRef } from '@mui/x-internals/forwardRef';
import { useComponentRenderer } from '@mui/x-internals/useComponentRenderer';
import { useGridPanelContext } from '@mui/x-data-grid-pro/internals';
import { gridPreferencePanelStateSelector, GridPreferencePanelsValue, useGridSelector } from '@mui/x-data-grid-pro';
import { useForkRef } from '@mui/material/utils';
import { useGridApiContext } from "../../hooks/utils/useGridApiContext.mjs";
import { useGridRootProps } from "../../hooks/utils/useGridRootProps.mjs";
import { jsx as _jsx } from "react/jsx-runtime";
/**
* A button that opens and closes the assistant panel.
* It renders the `baseButton` slot.
*
* Demos:
*
* - [AI Assistant Panel](https://mui.com/x/react-data-grid/components/ai-assistant-panel/)
*
* API:
*
* - [AiAssistantPanelTrigger API](https://mui.com/x/api/data-grid/ai-assistant-panel-trigger/)
*/
const AiAssistantPanelTrigger = forwardRef(function AiAssistantPanelTrigger(props, ref) {
const {
render,
className,
onClick,
onPointerUp
} = props,
other = _objectWithoutPropertiesLoose(props, _excluded);
const rootProps = useGridRootProps();
const buttonId = useId();
const panelId = useId();
const apiRef = useGridApiContext();
const panelState = useGridSelector(apiRef, gridPreferencePanelStateSelector);
const open = panelState.open && panelState.openedPanelValue === GridPreferencePanelsValue.aiAssistant;
const state = {
open
};
const resolvedClassName = typeof className === 'function' ? className(state) : className;
const {
aiAssistantPanelTriggerRef
} = useGridPanelContext();
const handleRef = useForkRef(ref, aiAssistantPanelTriggerRef);
const handleClick = event => {
if (open) {
apiRef.current.hidePreferences();
} else {
apiRef.current.showPreferences(GridPreferencePanelsValue.aiAssistant, panelId, buttonId);
}
onClick?.(event);
};
const handlePointerUp = event => {
if (open) {
event.stopPropagation();
}
onPointerUp?.(event);
};
const element = useComponentRenderer(rootProps.slots.baseButton, render, _extends({}, rootProps.slotProps?.baseButton, {
id: buttonId,
'aria-haspopup': 'true',
'aria-expanded': open ? 'true' : undefined,
'aria-controls': open ? panelId : undefined,
className: resolvedClassName
}, other, {
onClick: handleClick,
onPointerUp: handlePointerUp,
ref: handleRef
}), state);
return /*#__PURE__*/_jsx(React.Fragment, {
children: element
});
});
if (process.env.NODE_ENV !== "production") AiAssistantPanelTrigger.displayName = "AiAssistantPanelTrigger";
process.env.NODE_ENV !== "production" ? AiAssistantPanelTrigger.propTypes = {
// ----------------------------- Warning --------------------------------
// | These PropTypes are generated from the TypeScript type definitions |
// | To update them edit the TypeScript types and run "pnpm proptypes" |
// ----------------------------------------------------------------------
/**
* A function to customize rendering of the component.
*/
className: PropTypes.oneOfType([PropTypes.func, PropTypes.string]),
disabled: PropTypes.bool,
id: PropTypes.string,
/**
* A function to customize rendering of the component.
*/
render: PropTypes.oneOfType([PropTypes.element, PropTypes.func]),
role: PropTypes.string,
size: PropTypes.oneOf(['large', 'medium', 'small']),
startIcon: PropTypes.node,
style: PropTypes.object,
tabIndex: PropTypes.number,
title: PropTypes.string,
touchRippleRef: PropTypes.any
} : void 0;
export { AiAssistantPanelTrigger };