@elastic/eui/es/components/flyout/manager/actions.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 { LEVEL_MAIN } from './const';
var PREFIX = 'eui/flyoutManager';
/** Dispatched when a flyout registers itself with the manager. */
export var ACTION_ADD = "".concat(PREFIX, "/add");
/** Dispatched to remove a flyout from the manager (usually on close/unmount). */
export var ACTION_CLOSE = "".concat(PREFIX, "/close");
/** Dispatched to remove all flyouts from the manager. */
export var ACTION_CLOSE_ALL = "".concat(PREFIX, "/closeAll");
/** Dispatched to set which flyout is currently active within the session. */
export var ACTION_SET_ACTIVE = "".concat(PREFIX, "/setActive");
/** Dispatched when an active flyout's pixel width changes (for responsive layout). */
export var ACTION_SET_WIDTH = "".concat(PREFIX, "/setWidth");
/** Dispatched to set a flyout's menu pagination. */
export var ACTION_SET_PAGINATION = "".concat(PREFIX, "/setPagination");
/** Dispatched to switch layout mode between `side-by-side` and `stacked`. */
export var ACTION_SET_LAYOUT_MODE = "".concat(PREFIX, "/setLayoutMode");
/** Dispatched to update a flyout's activity stage (e.g., opening -> active). */
export var ACTION_SET_ACTIVITY_STAGE = "".concat(PREFIX, "/setActivityStage");
/** Dispatched to go back one session (remove current session). */
export var ACTION_GO_BACK = "".concat(PREFIX, "/goBack");
/** Dispatched to navigate to a specific flyout (remove all sessions after it). */
export var ACTION_GO_TO_FLYOUT = "".concat(PREFIX, "/goToFlyout");
/** Dispatched to set push padding offset for a side. */
export var ACTION_SET_PUSH_PADDING = "".concat(PREFIX, "/setPushPadding");
/** Dispatched to set the container element for container-relative flyouts. */
export var ACTION_SET_CONTAINER_ELEMENT = "".concat(PREFIX, "/setContainerElement");
/** Dispatched to set the reference width used for layout and resize clamping. */
export var ACTION_SET_REFERENCE_WIDTH = "".concat(PREFIX, "/setReferenceWidth");
export var ACTION_ADD_UNMANAGED_FLYOUT = "".concat(PREFIX, "/addUnmanagedFlyout");
export var ACTION_CLOSE_UNMANAGED_FLYOUT = "".concat(PREFIX, "/closeUnmanagedFlyout");

/**
 * Add a flyout to manager state. The manager will create or update
 * the current session depending on the `level` provided.
 */

/** Remove a flyout from manager state. Also updates the active session. */

/** Remove all flyouts from manager state. */

/** Set the active flyout within the current session (or clear with `null`). */

/** Update a flyout's measured width in pixels. */

/** Set the manager pagination value for a flyout. */

/** Change how flyouts are arranged: `side-by-side` or `stacked`. */

/** Set a specific flyout's activity stage. */

/** Go back one session (remove current session from stack). */

/** Navigate to a specific flyout (remove all sessions after it, or pop to child in history). */

/** Set push padding offset for a specific side. */

/** Set the container element for container-relative positioning. */

/** Set the reference width for layout and resize clamping. */

/** Union of all flyout manager actions. */

/**
 * Register a flyout with the manager.
 * - `title` is used for the flyout menu.
 * - `level` determines whether the flyout is `main` or `child`.
 * - Optional `size` is the named EUI size (e.g. `s`, `m`, `l`).
 * - Optional `historyKey` (Symbol) scopes history; only flyouts with the same reference share Back/history. Omit for a unique group per session.
 * - Optional `iconType` is shown next to the session title in the history menu.
 */
export var addFlyout = function addFlyout(flyoutId, title) {
  var level = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : LEVEL_MAIN;
  var size = arguments.length > 3 ? arguments[3] : undefined;
  var historyKey = arguments.length > 4 ? arguments[4] : undefined;
  var iconType = arguments.length > 5 ? arguments[5] : undefined;
  var minWidth = arguments.length > 6 ? arguments[6] : undefined;
  return {
    type: ACTION_ADD,
    flyoutId: flyoutId,
    title: title,
    level: level,
    size: size,
    historyKey: historyKey,
    iconType: iconType,
    minWidth: minWidth
  };
};

/** Unregister a flyout and update the session accordingly. */
export var closeFlyout = function closeFlyout(flyoutId) {
  return {
    type: ACTION_CLOSE,
    flyoutId: flyoutId
  };
};

/** Unregister all flyouts. */
export var closeAllFlyouts = function closeAllFlyouts() {
  return {
    type: ACTION_CLOSE_ALL
  };
};

/** Set or clear the active flyout for the current session. */
export var setActiveFlyout = function setActiveFlyout(flyoutId) {
  return {
    type: ACTION_SET_ACTIVE,
    flyoutId: flyoutId
  };
};

/** Record a flyout's current width in pixels. */
export var setFlyoutWidth = function setFlyoutWidth(flyoutId, width) {
  return {
    type: ACTION_SET_WIDTH,
    flyoutId: flyoutId,
    width: width
  };
};

/**
 * Set (or clear) the menu pagination config for a flyout. When set, this
 * overrides any pagination passed via `flyoutMenuProps.pagination` on the
 * flyout itself, allowing reactive updates from a different React root.
 *
 * Only works for managed flyouts. Unmanaged flyouts (session={false}) must use
 * the `flyoutMenuProps.pagination` prop instead.
 */
export var setPagination = function setPagination(flyoutId, pagination) {
  return {
    type: ACTION_SET_PAGINATION,
    flyoutId: flyoutId,
    pagination: pagination
  };
};

/** Switch layout mode between `side-by-side` and `stacked`. */
export var setLayoutMode = function setLayoutMode(layoutMode) {
  return {
    type: ACTION_SET_LAYOUT_MODE,
    layoutMode: layoutMode
  };
};

/** Update a flyout's activity stage. */
export var setActivityStage = function setActivityStage(flyoutId, activityStage) {
  return {
    type: ACTION_SET_ACTIVITY_STAGE,
    flyoutId: flyoutId,
    activityStage: activityStage
  };
};

/** Go back one session (remove current session from stack). */
export var goBack = function goBack() {
  return {
    type: ACTION_GO_BACK
  };
};

/** Navigate to a specific flyout (remove all sessions after it, or pop to child in history when level === 'child'). */
export var goToFlyout = function goToFlyout(flyoutId, level) {
  return {
    type: ACTION_GO_TO_FLYOUT,
    flyoutId: flyoutId,
    level: level
  };
};

/** Set push padding offset for a specific side. */
export var setPushPadding = function setPushPadding(side, width) {
  return {
    type: ACTION_SET_PUSH_PADDING,
    side: side,
    width: width
  };
};

/** Register an unmanaged flyout for z-index positioning purposes */
export var addUnmanagedFlyout = function addUnmanagedFlyout(flyoutId) {
  return {
    type: ACTION_ADD_UNMANAGED_FLYOUT,
    flyoutId: flyoutId
  };
};

/** Unregister an unmanaged flyout */
export var closeUnmanagedFlyout = function closeUnmanagedFlyout(flyoutId) {
  return {
    type: ACTION_CLOSE_UNMANAGED_FLYOUT,
    flyoutId: flyoutId
  };
};

/** Set the container element for container-relative flyout positioning. */
export var setContainerElement = function setContainerElement(element) {
  return {
    type: ACTION_SET_CONTAINER_ELEMENT,
    element: element
  };
};

/** Set the reference width for layout and resize clamping. */
export var setReferenceWidth = function setReferenceWidth(width) {
  return {
    type: ACTION_SET_REFERENCE_WIDTH,
    width: width
  };
};