@carbon/ibm-products/lib/components/EditFullPage/EditFullPage.js

Carbon for IBM Products

/**
 * Copyright IBM Corp. 2020, 2025
 *
 * This source code is licensed under the Apache-2.0 license found in the
 * LICENSE file in the root directory of this source tree.
 */

'use strict';

var _rollupPluginBabelHelpers = require('../../_virtual/_rollupPluginBabelHelpers.js');
var React = require('react');
var index = require('../../_virtual/index.js');
var cx = require('classnames');
var devtools = require('../../global/js/utils/devtools.js');
var settings = require('../../settings.js');

// Carbon and package components we use.
/* TODO: @import(s) of carbon components and other package components. */

// The block part of our conventional BEM class names (blockClass__E--M).
const blockClass = `${settings.pkg.prefix}--edit-full-page`;
const componentName = 'EditFullPage';

// NOTE: the component SCSS is not imported here: it is rolled up separately.

// Default values can be included here and then assigned to the prop params,
// e.g. prop = defaults.prop,
// This gathers default values together neatly and ensures non-primitive
// values are initialized early to avoid react making unnecessary re-renders.
// Note that default values are not required for props that are 'required',
// nor for props where the component can apply undefined values reasonably.
// Default values should be provided when the component needs to make a choice
// or assumption when a prop is not supplied.

// Default values for props
// const defaults = {
//   /* TODO: add defaults for relevant props if needed */
// };

/**
 * **This component is deprecated.** <br>
 * Use when settings on a page need to always be shown in edit mode, or when the context of the page is needed to make several changes.
 * See usage guidance for further details.
 * @deprecated
 */
exports.EditFullPage = /*#__PURE__*/React.forwardRef((_ref, ref) => {
  let {
    // The component props, in alphabetical order (for consistency).

    className,
    children /* TODO: remove if not needed. */,

    /* TODO: add other props for EditFullPage, with default values if needed */

    // Collect any other property values passed in.
    ...rest
  } = _ref;
  return /*#__PURE__*/React.createElement("div", _rollupPluginBabelHelpers.extends({}, rest, {
    className: cx(blockClass,
    // Apply the block class to the main HTML element
    className,
    // Apply any supplied class names to the main HTML element.
    // example: `${blockClass}__template-string-class-${kind}-n-${size}`,
    {
      // switched classes dependant on props or state
      // example: [`${blockClass}__here-if-small`]: size === 'sm',
    }),
    ref: ref,
    role: "main"
  }, devtools.getDevtoolsProps(componentName)), children);
});

/**@ts-ignore*/
exports.EditFullPage.deprecated = {
  level: 'warn',
  details: `This component is deprecated and will be removed in the next major version.`
};

// Return a placeholder if not released and not enabled by feature flag
exports.EditFullPage = settings.pkg.checkComponentEnabled(exports.EditFullPage, componentName);

// The display name of the component, used by React. Note that displayName
// is used in preference to relying on function.name.
exports.EditFullPage.displayName = componentName;

// The types and DocGen commentary for the component props,
// in alphabetical order (for consistency).
// See https://www.npmjs.com/package/prop-types#usage.
exports.EditFullPage.propTypes = {
  /**
   * Provide the contents of the EditFullPage.
   */
  children: index.default.node.isRequired,
  /**
   * Provide an optional class to be applied to the containing node.
   */
  className: index.default.string

  /* TODO: add types and DocGen for all props. */
};