/* * SPDX-License-Identifier: Apache-2.0 * * The OpenSearch Contributors require contributions made to * this file be licensed under the Apache-2.0 license or a * compatible open source license. * * Modifications Copyright OpenSearch Contributors. See * GitHub history for details. */ /* * Licensed to Elasticsearch B.V. under one or more contributor * license agreements. See the NOTICE file distributed with * this work for additional information regarding copyright * ownership. Elasticsearch B.V. licenses this file to you under * the Apache License, Version 2.0 (the "License"); you may * not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. */ import React, { FunctionComponent, HTMLAttributes } from 'react'; import classNames from 'classnames'; import { CommonProps, keysOf } from '../../common'; import { OuiPageHeaderContent, OuiPageHeaderContentProps, } from './page_header_content'; import { _OuiPageRestrictWidth, setPropsForRestrictedPageWidth, } from '../_restrict_width'; const paddingSizeToClassNameMap = { none: null, s: 'ouiPageHeader--paddingSmall', m: 'ouiPageHeader--paddingMedium', l: 'ouiPageHeader--paddingLarge', }; export const PADDING_SIZES = keysOf(paddingSizeToClassNameMap); export type OuiPageHeaderProps = CommonProps & HTMLAttributes & OuiPageHeaderContentProps & _OuiPageRestrictWidth & { /** * Adjust the padding. * When using this setting it's best to be consistent throughout all similar usages */ paddingSize?: typeof PADDING_SIZES[number]; /** * Adds a bottom border to separate it from the content after */ bottomBorder?: boolean; }; export const OuiPageHeader: FunctionComponent = ({ className, restrictWidth = false, paddingSize = 'none', bottomBorder, style, // Page header content shared props: alignItems, responsive = true, children, // Page header content only props: pageTitle, tabs, tabsProps, description, rightSideItems, rightSideGroupProps, ...rest }) => { const { widthClassName, newStyle } = setPropsForRestrictedPageWidth( restrictWidth, style ); const classes = classNames( 'ouiPageHeader', paddingSizeToClassNameMap[paddingSize], { 'ouiPageHeader--bottomBorder': bottomBorder, 'ouiPageHeader--responsive': responsive === true, 'ouiPageHeader--responsiveReverse': responsive === 'reverse', 'ouiPageHeader--tabsAtBottom': pageTitle && tabs, [`ouiPage--${widthClassName}`]: widthClassName, }, `ouiPageHeader--${alignItems ?? 'center'}`, className ); if (!pageTitle && !tabs && !description && !rightSideItems) { return (
{children}
); } return (
{children}
); };