/* * 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, { ReactElement } from 'react'; import { isString } from '../../services/predicate'; import { OuiButtonEmpty, OuiButtonIcon, OuiButtonEmptyColor, OuiButtonIconColor, } from '../button'; import { OuiToolTip } from '../tool_tip'; import { DefaultItemAction as Action } from './action_types'; import { htmlIdGenerator } from '../../services/accessibility'; import { OuiScreenReaderOnly } from '../accessibility'; export interface DefaultItemActionProps { action: Action; enabled: boolean; item: T; className?: string; } // In order to use generics with an arrow function inside a .tsx file, it's necessary to use // this `extends` hack and declare the types as shown, instead of declaring the const as a // FunctionComponent export const DefaultItemAction = ({ action, enabled, item, className, }: DefaultItemActionProps): ReactElement => { if (!action.onClick && !action.href) { throw new Error(`Cannot render item action [${action.name}]. Missing required 'onClick' callback or 'href' string. If you want to provide a custom action control, make sure to define the 'render' callback`); } const onClick = action.onClick ? () => action.onClick!(item) : undefined; const buttonColor = action.color; let color: OuiButtonIconColor = 'primary'; if (buttonColor) { color = isString(buttonColor) ? buttonColor : buttonColor(item); } const buttonIcon = action.icon; let icon; if (buttonIcon) { icon = isString(buttonIcon) ? buttonIcon : buttonIcon(item); } let button; const actionContent = typeof action.name === 'function' ? action.name(item) : action.name; if (action.type === 'icon') { if (!icon) { throw new Error(`Cannot render item action [${action.name}]. It is configured to render as an icon but no icon is provided. Make sure to set the 'icon' property of the action`); } const ariaLabelId = htmlIdGenerator()(); button = ( <> {/* actionContent (action.name) is a ReactNode and must be rendered to an element and referenced by ID for screen readers */} {actionContent} ); } else { button = ( {actionContent} ); } return enabled && action.description ? ( {button} ) : ( button ); };