@elastic/eui
Version:
Elastic UI Component Library
369 lines (364 loc) • 16.1 kB
JavaScript
var _excluded = ["breadcrumbs", "className", "responsive", "truncate", "max", "type", "lastBreadcrumbIsCurrentPage"];
function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
function _extends() { return _extends = Object.assign ? Object.assign.bind() : function (n) { for (var e = 1; e < arguments.length; e++) { var t = arguments[e]; for (var r in t) ({}).hasOwnProperty.call(t, r) && (n[r] = t[r]); } return n; }, _extends.apply(null, arguments); }
function _objectWithoutProperties(e, t) { if (null == e) return {}; var o, r, i = _objectWithoutPropertiesLoose(e, t); if (Object.getOwnPropertySymbols) { var n = Object.getOwnPropertySymbols(e); for (r = 0; r < n.length; r++) o = n[r], t.indexOf(o) >= 0 || {}.propertyIsEnumerable.call(e, o) && (i[o] = e[o]); } return i; }
function _objectWithoutPropertiesLoose(r, e) { if (null == r) return {}; var t = {}; for (var n in r) if ({}.hasOwnProperty.call(r, n)) { if (e.indexOf(n) >= 0) continue; t[n] = r[n]; } return t; }
/*
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
* or more contributor license agreements. Licensed under the Elastic License
* 2.0 and the Server Side Public License, v 1; you may not use this file except
* in compliance with, at your election, the Elastic License 2.0 or the Server
* Side Public License, v 1.
*/
import React, { useMemo } from 'react';
import PropTypes from "prop-types";
import classNames from 'classnames';
import { useEuiI18n } from '../i18n';
import { useEuiMemoizedStyles, useCurrentEuiBreakpoint } from '../../services';
import { EuiBreadcrumb, EuiBreadcrumbCollapsed } from './breadcrumb';
import { EuiBreadcrumbContent } from './_breadcrumb_content';
import { euiBreadcrumbsListStyles } from './breadcrumbs.styles';
import { jsx as ___EmotionJSX } from "@emotion/react";
var responsiveDefault = {
xs: 1,
s: 2,
m: 4
};
export var EuiBreadcrumbs = function EuiBreadcrumbs(_ref) {
var breadcrumbs = _ref.breadcrumbs,
className = _ref.className,
_ref$responsive = _ref.responsive,
responsive = _ref$responsive === void 0 ? responsiveDefault : _ref$responsive,
_ref$truncate = _ref.truncate,
truncate = _ref$truncate === void 0 ? true : _ref$truncate,
_ref$max = _ref.max,
max = _ref$max === void 0 ? 5 : _ref$max,
_ref$type = _ref.type,
type = _ref$type === void 0 ? 'page' : _ref$type,
_ref$lastBreadcrumbIs = _ref.lastBreadcrumbIsCurrentPage,
lastBreadcrumbIsCurrentPage = _ref$lastBreadcrumbIs === void 0 ? true : _ref$lastBreadcrumbIs,
rest = _objectWithoutProperties(_ref, _excluded);
var ariaLabel = useEuiI18n('euiBreadcrumbs.nav.ariaLabel', 'Breadcrumbs');
var breadcrumbsListStyles = useEuiMemoizedStyles(euiBreadcrumbsListStyles);
var cssBreadcrumbsListStyles = [breadcrumbsListStyles.euiBreadcrumbs__list, truncate && breadcrumbsListStyles.isTruncated];
var responsiveMax = useResponsiveMax(responsive, max);
var visibleBreadcrumbs = useMemo(function () {
var shouldCollapseBreadcrumbs = responsiveMax && breadcrumbs.length > responsiveMax;
return shouldCollapseBreadcrumbs ? limitBreadcrumbs(breadcrumbs, responsiveMax) : breadcrumbs;
}, [breadcrumbs, responsiveMax]);
var breadcrumbChildren = useMemo(function () {
return visibleBreadcrumbs.map(function (breadcrumb, index) {
var _breadcrumb$truncate;
var isFirstBreadcrumb = index === 0;
var isLastBreadcrumb = index === visibleBreadcrumbs.length - 1;
var isOnlyBreadcrumb = visibleBreadcrumbs.length === 1;
var sharedProps = {
type: type,
truncate: (_breadcrumb$truncate = breadcrumb.truncate) !== null && _breadcrumb$truncate !== void 0 ? _breadcrumb$truncate : truncate
};
return breadcrumb.isCollapsedButton ? ___EmotionJSX(EuiBreadcrumbCollapsed, _extends({
key: "collapsed"
}, sharedProps, {
isFirstBreadcrumb: isFirstBreadcrumb
}), ___EmotionJSX(EuiBreadcrumbs, {
breadcrumbs: breadcrumb.overflowBreadcrumbs,
lastBreadcrumbIsCurrentPage: false,
responsive: false,
truncate: false,
max: 0
})) : ___EmotionJSX(EuiBreadcrumb, _extends({
key: index
}, sharedProps), ___EmotionJSX(EuiBreadcrumbContent, _extends({}, breadcrumb, sharedProps, {
isFirstBreadcrumb: isFirstBreadcrumb,
isLastBreadcrumb: isLastBreadcrumb,
isOnlyBreadcrumb: isOnlyBreadcrumb,
highlightLastBreadcrumb: isLastBreadcrumb && lastBreadcrumbIsCurrentPage,
truncateLastBreadcrumb: isLastBreadcrumb && truncate && breadcrumb.truncate == null
})));
});
}, [visibleBreadcrumbs, truncate, type, lastBreadcrumbIsCurrentPage]);
return ___EmotionJSX("nav", _extends({
"aria-label": ariaLabel,
className: classNames('euiBreadcrumbs', className)
}, rest), ___EmotionJSX("ol", {
className: "euiBreadcrumbs__list",
css: cssBreadcrumbsListStyles
}, breadcrumbChildren));
};
EuiBreadcrumbs.propTypes = {
className: PropTypes.string,
"aria-label": PropTypes.string,
"data-test-subj": PropTypes.string,
css: PropTypes.any,
/**
* Hides extra (above the max) breadcrumbs under a collapsed item as the window gets smaller.
* Pass a custom #EuiBreadcrumbResponsiveMaxCount object to change the number of breadcrumbs to show at the particular breakpoints.
*
* Pass `false` to turn this behavior off.
*
* Default: `{ xs: 1, s: 2, m: 4 }`
*/
responsive: PropTypes.oneOfType([PropTypes.bool.isRequired, PropTypes.any.isRequired]),
/**
* Forces all breadcrumbs to single line and
* truncates each breadcrumb to a particular width,
* except for the last item
*/
truncate: PropTypes.bool,
/**
* Collapses the inner items past the maximum set here
* into a single ellipses item.
* Omitting or passing a `0` value will show all breadcrumbs.
*/
max: PropTypes.oneOfType([PropTypes.number.isRequired, PropTypes.oneOf([null])]),
/**
* The array of individual #EuiBreadcrumb items
*/
breadcrumbs: PropTypes.arrayOf(PropTypes.shape({
className: PropTypes.string,
"aria-label": PropTypes.string,
"data-test-subj": PropTypes.string,
css: PropTypes.any,
href: PropTypes.string,
rel: PropTypes.string,
onClick: PropTypes.func,
/**
* Visible label of the breadcrumb
*/
text: PropTypes.node.isRequired,
/**
* Force a max-width on the breadcrumb text
*/
truncate: PropTypes.bool,
/**
* @deprecated - if a custom color is wanted, use the `css` prop to pass custom css
*/
color: PropTypes.any,
/**
* Override the existing `aria-current` which defaults to `page` for the last breadcrumb
*/
"aria-current": PropTypes.any,
/**
* Creates a breadcrumb that toggles a popover dialog. Takes any rendered node(s),
* or a render function that will pass callback allowing you to close the
* breadcrumb popover from within your popover content.
*
* If passed, both `href` and `onClick` will be ignored - the breadcrumb's
* click behavior should only trigger a popover.
*/
popoverContent: PropTypes.oneOfType([PropTypes.node.isRequired, PropTypes.func.isRequired]),
/**
* Allows customizing the popover if necessary. Accepts any props that
* [EuiPopover](/#/layout/popover) accepts, except for props that control state.
*/
popoverProps: PropTypes.shape({
/**
* Alignment of the popover and arrow relative to the button
*/
anchorPosition: PropTypes.any,
/**
* Style and position alteration for arrow-less attachment.
* Intended for use with inputs as anchors, e.g. EuiInputPopover
*/
attachToAnchor: PropTypes.bool,
/**
* Restrict the popover's position within this element
*/
container: PropTypes.any,
/**
* CSS display type for both the popover and anchor
*/
display: PropTypes.any,
/**
* Object of props passed to EuiFocusTrap
*/
focusTrapProps: PropTypes.any,
/**
* Show arrow indicating to originating button
*/
hasArrow: PropTypes.bool,
/**
* Specifies what element should initially have focus; Can be a DOM
* node, or a selector string (which will be passed to
* document.querySelector() to find the DOM node), or a function that
* returns a DOM node.
*
* If not passed, initial focus defaults to the popover panel.
*/
initialFocus: PropTypes.any,
/**
* Passed directly to EuiPortal for DOM positioning. Both properties are
* required if prop is specified
*/
insert: PropTypes.shape({
sibling: PropTypes.any.isRequired,
position: PropTypes.oneOf(["before", "after"]).isRequired
}),
/**
* Traps tab focus within the popover contents
*/
ownFocus: PropTypes.bool,
/**
* Custom class added to the EuiPanel containing the popover contents
*/
panelClassName: PropTypes.string,
/**
* EuiPanel padding on all sides
*/
panelPaddingSize: PropTypes.any,
/**
* Standard DOM `style` attribute. Passed to the EuiPanel
*/
panelStyle: PropTypes.any,
/**
* Object of props passed to EuiPanel. See #EuiPopoverPanelProps
*/
panelProps: PropTypes.shape({
element: PropTypes.oneOf(["div"]),
/**
* Padding for all four sides
*/
paddingSize: PropTypes.any,
/**
* Corner border radius
*/
borderRadius: PropTypes.any,
/**
* When true the panel will grow in height to match `EuiFlexItem`
*/
grow: PropTypes.bool,
panelRef: PropTypes.any,
className: PropTypes.string,
"aria-label": PropTypes.string,
"data-test-subj": PropTypes.string,
css: PropTypes.any
}),
panelRef: PropTypes.any,
/**
* Optional screen reader instructions to announce upon popover open,
* in addition to EUI's default popover instructions for Escape on close.
* Useful for popovers that may have additional keyboard capabilities such as
* arrow navigation.
*/
popoverScreenReaderText: PropTypes.oneOfType([PropTypes.string.isRequired, PropTypes.node.isRequired]),
popoverRef: PropTypes.any,
/**
* When `true`, the popover's position is re-calculated when the user
* scrolls, this supports having fixed-position popover anchors. When nesting
* an `EuiPopover` in a scrollable container, `repositionOnScroll` should be `true`
*/
repositionOnScroll: PropTypes.bool,
/**
* By default, popovers will attempt to position themselves along the initial
* axis specified. If there is not enough room either vertically or horizontally
* however, the popover will attempt to reposition itself along the secondary
* cross axis if there is room there instead.
*
* If you do not not want this repositioning to occur (and it is acceptable for
* the popover to appear offscreen), set this to false to disable this behavior.
*
* @default true
*/
repositionToCrossAxis: PropTypes.bool,
/**
* Must be set to true if using `EuiDragDropContext` within a popover,
* otherwise your nested drag & drop will have incorrect positioning
*
* @deprecated - use `usePortal` prop on children `EuiDraggable` components instead.
*/
hasDragDrop: PropTypes.bool,
/**
* By default, popover content inherits the z-index of the anchor
* component; pass `zIndex` to override
*/
zIndex: PropTypes.number,
/**
* Distance away from the anchor that the popover will render
*/
offset: PropTypes.number,
/**
* Minimum distance between the popover and the bounding container;
* Pass an array of 4 values to adjust each side differently: `[top, right, bottom, left]`
* @default 16
*/
buffer: PropTypes.oneOfType([PropTypes.number.isRequired, PropTypes.any.isRequired]),
/**
* Element to pass as the child element of the arrow;
* Use case is typically limited to an accompanying `EuiBeacon`
*/
arrowChildren: PropTypes.node,
/**
* Provide a name to the popover panel
*/
"aria-label": PropTypes.string,
/**
* Alternative option to `aria-label` that takes an `id`.
* Usually takes the `id` of the popover title
*/
"aria-labelledby": PropTypes.string,
/**
* Function callback for when the popover positon changes
*/
onPositionChange: PropTypes.func,
className: PropTypes.string,
"data-test-subj": PropTypes.string,
css: PropTypes.any
})
}).isRequired).isRequired,
/**
* Determines breadcrumbs appearance, with `page` being the default styling.
* Application breadcrumbs should only be once per page, in (e.g.) EuiHeader
*/
type: PropTypes.oneOf(["page", "application"]),
/**
* Whether the last breadcrumb should be semantically highlighted as the
* current page. (improves accessibility for screen readers users)
* Defaults to true.
*/
lastBreadcrumbIsCurrentPage: PropTypes.bool
};
export var useResponsiveMax = function useResponsiveMax(responsive, max) {
// Use the default object if they simply passed `true` for responsive
var responsiveObject = _typeof(responsive) === 'object' ? responsive : responsiveDefault;
// The max property collapses any breadcrumbs past the max quantity.
// This is the same behavior we want for responsiveness.
// So calculate the max value based on the combination of `max` and `responsive`
var responsiveMax = max;
// Set the calculated max to the number associated with the currentBreakpoint key if it exists
var currentBreakpoint = useCurrentEuiBreakpoint();
if (responsive && currentBreakpoint && responsiveObject[currentBreakpoint]) {
responsiveMax = responsiveObject[currentBreakpoint];
}
// Final check is to make sure max is used over a larger breakpoint value
if (max && responsiveMax) {
responsiveMax = max < responsiveMax ? max : responsiveMax;
}
return responsiveMax;
};
export var limitBreadcrumbs = function limitBreadcrumbs(breadcrumbs, max) {
var breadcrumbsAtStart = [];
var breadcrumbsAtEnd = [];
var limit = Math.min(max, breadcrumbs.length);
var start = Math.floor(limit / 2);
var overflowBreadcrumbs = breadcrumbs.slice(start, start + breadcrumbs.length - limit);
for (var i = 0; i < limit; i++) {
// We'll alternate with displaying breadcrumbs at the end and at the start, but be biased
// towards breadcrumbs the end so that if max is an odd number, we'll have one more
// breadcrumb visible at the end than at the beginning.
var isEven = i % 2 === 0;
// We're picking breadcrumbs from the front AND the back, so we treat each iteration as a
// half-iteration.
var normalizedIndex = Math.floor(i * 0.5);
var indexOfBreadcrumb = isEven ? breadcrumbs.length - 1 - normalizedIndex : normalizedIndex;
var breadcrumb = breadcrumbs[indexOfBreadcrumb];
if (isEven) {
breadcrumbsAtEnd.unshift(breadcrumb);
} else {
breadcrumbsAtStart.push(breadcrumb);
}
}
return [].concat(breadcrumbsAtStart, [{
isCollapsedButton: true,
overflowBreadcrumbs: overflowBreadcrumbs
}], breadcrumbsAtEnd);
};