@carbon/ibm-products
Version:
Carbon for IBM Products
48 lines • 1.51 kB
TypeScript
/**
* Copyright IBM Corp. 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.
*/
import React from 'react';
import { PopoverAlignment } from '@carbon/react';
export interface TruncatedTextProps {
/**
* Specify how the tooltip should align with the content in tooltip variant. Refer to Carbon tooltip docs for additional information.
*/
align?: PopoverAlignment;
/**
* Specify whether a auto align functionality should be applied in tooltip variant. Refer to Carbon tooltip docs for additional information.
*/
autoAlign?: boolean;
/**
* Optional class.
*/
className?: string;
/**
* The label on the collapse button.
*/
collapseLabel?: string;
/**
* The label on expand button.
*/
expandLabel?: string;
/**
* Unique identifier for the element.
*/
id: string;
/**
* The maximum number of lines to display before truncation.
*/
lines?: number;
/**
* The method to display the full text when truncated. Options are "tooltip" or "expand". if not passed, the text would just be truncated with ellipsis.
*/
type?: 'tooltip' | 'expand';
/**
* The string value to be truncated.
*/
value?: string;
}
export declare const TruncatedText: React.ForwardRefExoticComponent<TruncatedTextProps & React.RefAttributes<HTMLDivElement>>;
//# sourceMappingURL=TruncatedText.d.ts.map