@elastic/eui/es/components/flyout/manager/selectors.js

Elastic UI Component Library

/*
 * 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 { useFlyoutManager } from './provider';
import { useRef } from 'react';
export var useSession = function useSession(flyoutId) {
  var context = useFlyoutManager();
  if (!context) {
    return null;
  }
  return context.state.sessions.find(function (s) {
    return s.mainFlyoutId === flyoutId || s.childFlyoutId === flyoutId;
  }) || null;
};

/** True when any managed flyout session is currently active. */
export var useHasActiveSession = function useHasActiveSession() {
  return !!useCurrentSession();
};

/** True if the given `flyoutId` is the main or child flyout in the latest session. */
export var useIsFlyoutActive = function useIsFlyoutActive(flyoutId) {
  var currentSession = useCurrentSession();
  return (currentSession === null || currentSession === void 0 ? void 0 : currentSession.mainFlyoutId) === flyoutId || (currentSession === null || currentSession === void 0 ? void 0 : currentSession.childFlyoutId) === flyoutId;
};
export var useFlyout = function useFlyout(flyoutId) {
  var context = useFlyoutManager();
  if (!context || !flyoutId) {
    return null;
  }
  return context.state.flyouts.find(function (f) {
    return f.flyoutId === flyoutId;
  }) || null;
};
export var useIsFlyoutRegistered = function useIsFlyoutRegistered(flyoutId) {
  var context = useFlyoutManager();
  if (!context || !flyoutId) {
    return false;
  }
  return context.state.flyouts.some(function (f) {
    return f.flyoutId === flyoutId;
  });
};

/** The most recent flyout session or `null` if none. */
export var useCurrentSession = function useCurrentSession() {
  var context = useFlyoutManager();
  if (!context) return null;
  return context.state.sessions[context.state.sessions.length - 1] || null;
};

/** The registered state of the current session's main flyout, if present. */
export var useCurrentMainFlyout = function useCurrentMainFlyout() {
  var currentSession = useCurrentSession();
  var mainFlyoutId = currentSession === null || currentSession === void 0 ? void 0 : currentSession.mainFlyoutId;
  return useFlyout(mainFlyoutId);
};

/** The registered state of the current session's child flyout, if present. */
export var useCurrentChildFlyout = function useCurrentChildFlyout() {
  var currentSession = useCurrentSession();
  var childFlyoutId = currentSession === null || currentSession === void 0 ? void 0 : currentSession.childFlyoutId;
  return useFlyout(childFlyoutId);
};

/** The measured width (px) of the specified flyout, or `null` if unknown. */
export var useFlyoutWidth = function useFlyoutWidth(flyoutId) {
  var _useFlyout;
  return (_useFlyout = useFlyout(flyoutId)) === null || _useFlyout === void 0 ? void 0 : _useFlyout.width;
};

/** Returns the store pagination override for a flyout, if set. */
export var useFlyoutPagination = function useFlyoutPagination(flyoutId) {
  var _useFlyout2;
  return (_useFlyout2 = useFlyout(flyoutId)) === null || _useFlyout2 === void 0 ? void 0 : _useFlyout2.pagination;
};

/** The configured minWidth (px) of the specified flyout, or `undefined` if not set. */
export var useFlyoutMinWidth = function useFlyoutMinWidth(flyoutId) {
  var _useFlyout3;
  return (_useFlyout3 = useFlyout(flyoutId)) === null || _useFlyout3 === void 0 ? void 0 : _useFlyout3.minWidth;
};

/** The configured size of the parent (main) flyout for a given child flyout ID. */
export var useParentFlyoutSize = function useParentFlyoutSize(childFlyoutId) {
  var session = useSession(childFlyoutId);
  var parentFlyout = useFlyout(session === null || session === void 0 ? void 0 : session.mainFlyoutId);
  return parentFlyout === null || parentFlyout === void 0 ? void 0 : parentFlyout.size;
};

/** True if the provided `flyoutId` is the main flyout and it currently has a child. */
export var useHasChildFlyout = function useHasChildFlyout(flyoutId) {
  var session = useSession(flyoutId);
  return !!(session !== null && session !== void 0 && session.childFlyoutId);
};

/** Get the current push padding offsets from manager state. */
export var usePushPaddingOffsets = function usePushPaddingOffsets() {
  var _context$state$pushPa;
  var context = useFlyoutManager();
  if (!context) {
    return {
      left: 0,
      right: 0
    };
  }
  return (_context$state$pushPa = context.state.pushPadding) !== null && _context$state$pushPa !== void 0 ? _context$state$pushPa : {
    left: 0,
    right: 0
  };
};

/** True if there's any active push padding (left or right side). */
export var useHasPushPadding = function useHasPushPadding() {
  var pushPadding = usePushPaddingOffsets();
  return pushPadding.left > 0 || pushPadding.right > 0;
};

/** Get the ref for the current flyout z-index to be used */
export var useCurrentFlyoutZIndexRef = function useCurrentFlyoutZIndexRef() {
  var context = useFlyoutManager();
  return useRef((context === null || context === void 0 ? void 0 : context.state.currentZIndex) || 0);
};