@neo4j-ndl/react
Version:
React implementation of Neo4j Design System
92 lines • 6 kB
JavaScript
var __rest = (this && this.__rest) || function (s, e) {
var t = {};
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
t[p] = s[p];
if (s != null && typeof Object.getOwnPropertySymbols === "function")
for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
t[p[i]] = s[p[i]];
}
return t;
};
import { jsx as _jsx, Fragment as _Fragment, jsxs as _jsxs } from "react/jsx-runtime";
/**
*
* 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 classNames from 'classnames';
import React, { useId } from 'react';
import { ButtonSpinner } from '../_common/ButtonSpinner';
import { needleWarningMessage } from '../_common/utils';
import { Kbd } from '../kbd';
import { Tooltip } from '../tooltip';
export const IconButtonBase = (_a) => {
var _b;
var { children, as, iconButtonVariant = 'default', isLoading = false, isDisabled = false, size = 'medium', isFloating = false,
// Does not have a default value to avoid setting aria-pressed to true if not explicitly set
isActive = undefined, description, descriptionKbdProps, tooltipProps, className, style, variant = 'neutral', htmlAttributes, onClick, ref,
// TODO v5: maybe update default message to 'Loading'. This value is for backward compatibility with loading spinners old aria-label
loadingMessage = 'Loading content' } = _a, restProps = __rest(_a, ["children", "as", "iconButtonVariant", "isLoading", "isDisabled", "size", "isFloating", "isActive", "description", "descriptionKbdProps", "tooltipProps", "className", "style", "variant", "htmlAttributes", "onClick", "ref", "loadingMessage"]);
const Component = as !== null && as !== void 0 ? as : 'button';
const loadingId = useId();
const isInteractable = !isDisabled && !isLoading;
const isClean = iconButtonVariant === 'clean';
const isDanger = variant === 'danger';
const classes = classNames('ndl-icon-btn', className, {
'ndl-active': Boolean(isActive),
'ndl-clean': isClean,
'ndl-danger': isDanger,
'ndl-disabled': isDisabled,
'ndl-floating': isFloating,
'ndl-large': size === 'large',
'ndl-loading': isLoading,
'ndl-medium': size === 'medium',
'ndl-small': size === 'small',
});
if (isClean && isFloating) {
throw new Error('BaseIconButton: Cannot use isFloating and iconButtonVariant="clean" at the same time.');
}
if (!description && !(htmlAttributes === null || htmlAttributes === void 0 ? void 0 : htmlAttributes['aria-label'])) {
needleWarningMessage('Icon buttons do not have text, be sure to include a description or an aria-label for screen readers link: https://dequeuniversity.com/rules/axe/4.4/button-name?application=axeAPI');
}
const handleClick = (e) => {
if (!isInteractable) {
// By default, a <button /> element with disabled set to true will not get its
// on click handler called. To support the same behavior on <a /> tags we
// swallow the event here when disabled, since the <a /> tag with disabled set to
// true will have its onClick handler called
e.preventDefault();
e.stopPropagation();
return;
}
if (onClick) {
onClick(e);
}
};
const tooltipContent = React.useMemo(() => {
var _a;
const descriptionContent = description !== null && description !== void 0 ? description : (_a = tooltipProps === null || tooltipProps === void 0 ? void 0 : tooltipProps.content) === null || _a === void 0 ? void 0 : _a.children;
return (_jsxs(_Fragment, { children: [descriptionContent, descriptionKbdProps && _jsx(Kbd, Object.assign({}, descriptionKbdProps))] }));
}, [description, descriptionKbdProps, (_b = tooltipProps === null || tooltipProps === void 0 ? void 0 : tooltipProps.content) === null || _b === void 0 ? void 0 : _b.children]);
return (_jsxs(Tooltip, Object.assign({ hoverDelay: {
close: 0,
open: 500,
}, isDisabled: description === null || isDisabled, type: "simple" }, tooltipProps === null || tooltipProps === void 0 ? void 0 : tooltipProps.root, { children: [_jsx(Tooltip.Trigger, Object.assign({}, tooltipProps === null || tooltipProps === void 0 ? void 0 : tooltipProps.trigger, { hasButtonWrapper: true, children: _jsx(Component, Object.assign({ type: "button", onClick: handleClick, disabled: isDisabled, "aria-disabled": !isInteractable, "aria-label": description, "aria-pressed": isActive, className: classes, style: style, ref: ref, "aria-describedby": isLoading ? loadingId : undefined }, restProps, htmlAttributes, { children: _jsx("div", { className: "ndl-icon-btn-inner", children: isLoading ? (_jsx(ButtonSpinner, { loadingMessage: loadingMessage, size: "small", htmlAttributes: { id: loadingId } })) : (_jsx("div", { className: "ndl-icon", children: children })) }) })) })), _jsx(Tooltip.Content, Object.assign({}, tooltipProps === null || tooltipProps === void 0 ? void 0 : tooltipProps.content, { children: tooltipContent }))] })));
};
//# sourceMappingURL=IconButtonBase.js.map