@elastic/eui 110.0.0 → 111.0.0

package/es/components/collapsible_nav/collapsible_nav.js

@@ -94,6 +94,7 @@ export var EuiCollapsibleNav = function EuiCollapsibleNav(_ref) {
   });
   var flyout = ___EmotionJSX(EuiFlyout, _extends({
     id: flyoutID,
+    session: "never",
     css: cssStyles,
     className: classes
     // Flyout props we set different defaults for
@@ -115,113 +116,28 @@ export var EuiCollapsibleNav = function EuiCollapsibleNav(_ref) {
   return ___EmotionJSX(React.Fragment, null, trigger, (isOpen || navIsDocked) && flyout);
 };
 EuiCollapsibleNav.propTypes = {
-  className: PropTypes.string,
-  "aria-label": PropTypes.string,
-  "data-test-subj": PropTypes.string,
-  css: PropTypes.any,
   /**
-     * Sets the HTML element for `EuiFlyout`
-     */
-  as: PropTypes.any,
-  onClose: PropTypes.func.isRequired,
-  /**
-     * Defines the width of the panel.
-     * Pass a predefined size of `s | m | l`, or pass any number/string compatible with the CSS `width` attribute
-     * @default m
-     */
-  size: PropTypes.oneOfType([PropTypes.any.isRequired, PropTypes.any.isRequired]),
-  /**
-     * Sets the max-width of the panel,
-     * set to `true` to use the default size,
-     * set to `false` to not restrict the width,
-     * set to a number for a custom width in px,
-     * set to a string for a custom width in custom measurement.
-     * @default false
-     */
-  maxWidth: PropTypes.oneOfType([PropTypes.bool.isRequired, PropTypes.number.isRequired, PropTypes.string.isRequired]),
-  /**
-     * Customize the padding around the content of the flyout header, body and footer
-     * @default l
-     */
-  paddingSize: PropTypes.any,
-  /**
-     * Adds an EuiOverlayMask and wraps in an EuiPortal
-     * @default true
-     */
-  ownFocus: PropTypes.bool,
-  /**
-     * Hides the default close button. You must provide another close button somewhere within the flyout.
-     * @default false
-     */
-  hideCloseButton: PropTypes.bool,
-  /**
-     * Extends EuiButtonIconProps onto the close button
-     */
-  closeButtonProps: PropTypes.any,
-  /**
-     * Position of close button.
-     * `inside`: Floating to just inside the flyout, always top right;
-     * `outside`: Floating just outside the flyout near the top (side dependent on `side`). Helpful when the close button may cover other interactable content.
-     * @default inside
-     */
-  closeButtonPosition: PropTypes.oneOf(["inside", "outside"]),
-  /**
-     * Adjustments to the EuiOverlayMask that is added when `ownFocus = true`
-     */
-  maskProps: PropTypes.shape({
-    /**
-       * ReactNode to render as this component's content
-       */
-    children: PropTypes.node,
-    /**
-       * Should the mask visually sit above or below the EuiHeader (controlled by z-index)
-       */
-    headerZindexLocation: PropTypes.oneOf(["above", "below"]),
-    /**
-       * React ref to be passed to the wrapping container
-       */
-    maskRef: PropTypes.oneOfType([PropTypes.any.isRequired, PropTypes.any.isRequired])
-  }),
-  /**
-     * Forces this interaction on the mask overlay or body content.
-     * Defaults depend on `ownFocus` and `type` values
-     */
-  outsideClickCloses: PropTypes.bool,
-  /**
-     * Which side of the window to attach to.
-     * The `left` option should only be used for navigation.
-     * @default right
-     */
-  side: PropTypes.any,
-  /**
-     * Named breakpoint (`xs` through `xl`) for customizing the minimum window width to enable docking
-     */
-  pushMinBreakpoint: PropTypes.any,
-  /**
-     * Enables a slide in animation on push flyouts
-     * @default false
-     */
-  pushAnimation: PropTypes.bool,
-  style: PropTypes.any,
-  /**
-     * Object of props passed to EuiFocusTrap.
-     * `shards` specifies an array of elements that will be considered part of the flyout, preventing the flyout from being closed when clicked.
-     * `closeOnMouseup` will delay the close callback, allowing time for external toggle buttons to handle close behavior.
-     * `returnFocus` defines the return focus behavior and provides the possibility to check the available target element or opt out of the behavior in favor of manually returning focus
+     * Controls the way the session is managed for this flyout.
+     * - `start`: Creates a new flyout session. Use this for the main flyout.
+     * - `inherit`: Inherits an existing session if one is active, otherwise functions as a standard flyout.
+     * - `never`: Disregards session management and always functions as a standard flyout.
+     *
+     * When the `session` prop is undefined (not set), the flyout will automatically inherit from
+     * a parent flyout if it's nested inside one. Otherwise, it defaults to `never`.
+     *
+     * Check out [EuiFlyout session management](https://eui.elastic.co/docs/components/containers/flyout/session-management)
+     * documentation to learn more.
+     * @default undefined (auto-inherit when nested, otherwise 'never')
      */
-  focusTrapProps: PropTypes.any,
+  session: PropTypes.oneOfType([PropTypes.any.isRequired, PropTypes.any.isRequired, PropTypes.any.isRequired]),
   /**
-     * By default, EuiFlyout will consider any fixed `EuiHeader`s that sit alongside or above the EuiFlyout
-     * as part of the flyout's focus trap. This prevents focus fighting with interactive elements
-     * within fixed headers.
-     *
-     * Set this to `false` if you need to disable this behavior for a specific reason.
+     * Callback fired when the flyout becomes active/visible, which may happen programmatically from history navigation.
      */
-  includeFixedHeadersInFocusTrap: PropTypes.bool,
+  onActive: PropTypes.func,
   /**
-     * Specify additional css selectors to include in the focus trap.
+     * The HTML element to render as the flyout container.
      */
-  includeSelectorInFocusTrap: PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.string.isRequired).isRequired, PropTypes.string.isRequired]),
+  as: PropTypes.any,
   /**
      * ReactNode to render as this component's content
      */
@@ -234,6 +150,9 @@ EuiCollapsibleNav.propTypes = {
      * Keeps navigation flyout visible and push `<body>` content via padding
      */
   isDocked: PropTypes.bool,
+  /**
+     * Named breakpoint (`xs` through `xl`) for customizing the minimum window width to enable docking
+     */
   dockedBreakpoint: PropTypes.any,
   /**
      * Button for controlling visible state of the nav

package/es/components/collapsible_nav_beta/collapsible_nav_beta.js

@@ -157,6 +157,7 @@ var _EuiCollapsibleNavBeta = function _EuiCollapsibleNavBeta(_ref) {
   }, rest, {
     // EuiCollapsibleNav is significantly less permissive than EuiFlyout
     id: flyoutID,
+    session: "never",
     css: cssStyles,
     className: classes,
     size: width,

package/es/components/flyout/_flyout_overlay.js

@@ -0,0 +1,52 @@
+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); }
+/*
+ * 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 { css, cx } from '@emotion/css';
+import { EuiOverlayMask } from '../overlay_mask';
+import { EuiPortal } from '../portal';
+import { jsx as ___EmotionJSX } from "@emotion/react";
+var getEuiFlyoutOverlayStyles = function getEuiFlyoutOverlayStyles(zIndex) {
+  /*
+  This needs to have !important to override the default EuiOverlayMask
+  z-index based on the headerZindexLocation prop. Using the style attribute
+  doesn't work since EuiOverlayMask requires a string style prop that
+  causes React errors in the test environment.
+  */
+  return /*#__PURE__*/css("z-index:", zIndex, "!important;;label:getEuiFlyoutOverlayStyles;");
+};
+
+/**
+ * Light wrapper for conditionally rendering portals or overlay masks:
+ *  - If ownFocus is set, wrap with an overlay and allow the user to click it to close it.
+ *  - Otherwise still wrap within an EuiPortal so it appends to the bottom of the window.
+ * Push flyouts have no overlay OR portal behavior.
+ *
+ * @internal
+ */
+export var EuiFlyoutOverlay = function EuiFlyoutOverlay(_ref) {
+  var children = _ref.children,
+    isPushed = _ref.isPushed,
+    maskProps = _ref.maskProps,
+    hasOverlayMask = _ref.hasOverlayMask,
+    maskZIndex = _ref.maskZIndex;
+  var styles = useMemo(function () {
+    return getEuiFlyoutOverlayStyles(maskZIndex);
+  }, [maskZIndex]);
+  var content = children;
+  if (!isPushed || hasOverlayMask) {
+    content = ___EmotionJSX(EuiPortal, null, content);
+  }
+  var classes = cx(maskProps === null || maskProps === void 0 ? void 0 : maskProps.className, styles);
+  return ___EmotionJSX(React.Fragment, null, hasOverlayMask && ___EmotionJSX(EuiOverlayMask, _extends({
+    headerZindexLocation: "below"
+  }, maskProps, {
+    className: classes
+  })), content);
+};

package/es/components/flyout/_flyout_resize_button.js

@@ -0,0 +1,32 @@
+var _excluded = ["type", "side", "ownFocus", "isPushed"];
+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 from 'react';
+import { useEuiMemoizedStyles } from '../../services';
+import { EuiResizableButton } from '../resizable_container';
+import { euiFlyoutResizeButtonStyles } from './_flyout_resize_button.styles';
+import { jsx as ___EmotionJSX } from "@emotion/react";
+export var EuiFlyoutResizeButton = function EuiFlyoutResizeButton(_ref) {
+  var type = _ref.type,
+    side = _ref.side,
+    ownFocus = _ref.ownFocus,
+    isPushed = _ref.isPushed,
+    resizableButtonProps = _objectWithoutProperties(_ref, _excluded);
+  var hasOverlay = ownFocus && type === 'overlay';
+  var styles = useEuiMemoizedStyles(euiFlyoutResizeButtonStyles);
+  var cssStyles = [styles.root, styles[type][side], !hasOverlay && styles.noOverlay.root, !hasOverlay && styles.noOverlay[side]];
+  return ___EmotionJSX(EuiResizableButton, _extends({
+    isHorizontal: true,
+    indicator: "border",
+    css: cssStyles
+  }, resizableButtonProps));
+};

package/es/components/flyout/{flyout_resizable.styles.js → _flyout_resize_button.styles.js}

@@ -26,25 +26,25 @@ var _ref2 = process.env.NODE_ENV === "production" ? {
   toString: _EMOTION_STRINGIFIED_CSS_ERROR__
 };
 var _ref3 = process.env.NODE_ENV === "production" ? {
-  name: "1cw850z-noOverlay",
-  styles: "margin-inline:0;label:noOverlay;"
+  name: "10l1ho9-root",
+  styles: "margin-inline:0;label:root;"
 } : {
-  name: "1cw850z-noOverlay",
-  styles: "margin-inline:0;label:noOverlay;",
+  name: "10l1ho9-root",
+  styles: "margin-inline:0;label:root;",
   toString: _EMOTION_STRINGIFIED_CSS_ERROR__
 };
 var _ref4 = process.env.NODE_ENV === "production" ? {
-  name: "1gfwqnd-euiFlyoutResizableButton",
-  styles: "position:absolute;label:euiFlyoutResizableButton;"
+  name: "1yicr0l-root",
+  styles: "position:absolute;label:root;"
 } : {
-  name: "1gfwqnd-euiFlyoutResizableButton",
-  styles: "position:absolute;label:euiFlyoutResizableButton;",
+  name: "1yicr0l-root",
+  styles: "position:absolute;label:root;",
   toString: _EMOTION_STRINGIFIED_CSS_ERROR__
 };
-export var euiFlyoutResizableButtonStyles = function euiFlyoutResizableButtonStyles(_ref5) {
+export var euiFlyoutResizeButtonStyles = function euiFlyoutResizeButtonStyles(_ref5) {
   var euiTheme = _ref5.euiTheme;
   return {
-    euiFlyoutResizableButton: _ref4,
+    root: _ref4,
     overlay: {
       left: /*#__PURE__*/css(logicalCSS('right', 0), ";;label:left;"),
       right: /*#__PURE__*/css(logicalCSS('left', 0), ";;label:right;")
@@ -54,7 +54,7 @@ export var euiFlyoutResizableButtonStyles = function euiFlyoutResizableButtonSty
       right: /*#__PURE__*/css(logicalCSS('left', "-".concat(euiTheme.border.width.thick)), ";;label:right;")
     },
     noOverlay: {
-      noOverlay: _ref3,
+      root: _ref3,
       left: _ref2,
       right: _ref
     }

package/es/components/flyout/const.js

@@ -0,0 +1,42 @@
+/*
+ * 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.
+ */
+
+/** Allowed flyout render types. */
+export var FLYOUT_TYPES = ['push', 'overlay'];
+/** Type representing a supported flyout render type. */
+
+/** Allowed flyout attachment sides. */
+export var FLYOUT_SIDES = ['left', 'right'];
+/** Type representing a supported flyout side. */
+
+/** Allowed named flyout sizes used by the manager. */
+export var FLYOUT_SIZES = ['s', 'm', 'l', 'fill'];
+/** Type representing a supported named flyout size. */
+
+/** Allowed padding sizes for flyout content. */
+export var FLYOUT_PADDING_SIZES = ['none', 's', 'm', 'l'];
+/** Type representing a supported flyout padding size. */
+
+/** Default minimum breakpoint at which push-type flyouts begin to push content. */
+export var DEFAULT_PUSH_MIN_BREAKPOINT = 'l';
+/** Default flyout type when none is provided. */
+export var DEFAULT_TYPE = 'overlay';
+/** Default side where flyouts anchor when none is provided. */
+export var DEFAULT_SIDE = 'right';
+/** Default named flyout size. */
+export var DEFAULT_SIZE = 'm';
+/** Default padding size inside flyouts. */
+export var DEFAULT_PADDING_SIZE = 'l';
+
+/**
+ * Custom type checker for named flyout sizes since the prop
+ * `size` can also be CSSProperties['width'] (string | number)
+ */
+export function isEuiFlyoutSizeNamed(value) {
+  return FLYOUT_SIZES.includes(value);
+}