/* * 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, { ButtonHTMLAttributes, FunctionComponent, HTMLAttributes, Ref, } from 'react'; import classNames from 'classnames'; import { CommonProps, keysOf, ExclusiveUnion } from '../common'; export const panelPaddingValues = { none: 0, s: 8, m: 16, l: 24, }; const paddingSizeToClassNameMap = { none: null, s: 'ouiPanel--paddingSmall', m: 'ouiPanel--paddingMedium', l: 'ouiPanel--paddingLarge', }; export const SIZES = keysOf(paddingSizeToClassNameMap); const borderRadiusToClassNameMap = { none: 'ouiPanel--borderRadiusNone', m: 'ouiPanel--borderRadiusMedium', }; export const BORDER_RADII = keysOf(borderRadiusToClassNameMap); export const COLORS = [ 'transparent', 'plain', 'subdued', 'accent', 'primary', 'success', 'warning', 'danger', ] as const; export type PanelColor = typeof COLORS[number]; export type PanelPaddingSize = typeof SIZES[number]; export type PanelBorderRadius = typeof BORDER_RADII[number]; export interface _OuiPanelProps extends CommonProps { /** * Adds a medium shadow to the panel; * Only works when `color="plain"` */ hasShadow?: boolean; /** * Adds a slight 1px border on all edges. * Only works when `color="plain | transparent"` * Default is `undefined` and will default to that theme's panel style */ hasBorder?: boolean; /** * Padding for all four sides */ paddingSize?: PanelPaddingSize; /** * Corner border radius */ borderRadius?: PanelBorderRadius; /** * When true the panel will grow in height to match `OuiFlexItem` */ grow?: boolean; panelRef?: Ref; /** * Background color of the panel; * Usually a lightened form of the brand colors */ color?: PanelColor; } export interface _OuiPanelDivlike extends _OuiPanelProps, Omit, 'color'> { element?: 'div'; } export interface _OuiPanelButtonlike extends _OuiPanelProps, Omit, 'color'> { element?: 'button'; } export type OuiPanelProps = ExclusiveUnion< _OuiPanelButtonlike, _OuiPanelDivlike >; export const OuiPanel: FunctionComponent = ({ children, className, paddingSize = 'm', borderRadius = 'm', color = 'plain', hasShadow = true, hasBorder, grow = true, panelRef, element, ...rest }) => { // Shadows are only allowed when there's a white background (plain) const canHaveShadow = color === 'plain'; const canHaveBorder = color === 'plain' || color === 'transparent'; const classes = classNames( 'ouiPanel', paddingSizeToClassNameMap[paddingSize], borderRadiusToClassNameMap[borderRadius], `ouiPanel--${color}`, { /* ToDo: Remove unnecessary logic: the old beta theme has * evolved and the statement below about the `Next` theme * is not valid. */ // The `no` classes turn off the option for default theme // While the `has` classes turn it on for Next 'ouiPanel--hasShadow': canHaveShadow && hasShadow === true, 'ouiPanel--noShadow': !canHaveShadow || hasShadow === false, 'ouiPanel--hasBorder': canHaveBorder && hasBorder === true, 'ouiPanel--noBorder': !canHaveBorder || hasBorder === false, 'ouiPanel--flexGrowZero': !grow, 'ouiPanel--isClickable': rest.onClick, }, className ); if (rest.onClick && element !== 'div') { return ( ); } return (
} className={classes} {...(rest as HTMLAttributes)}> {children}
); };