@carbon/ibm-products
Version:
Carbon for IBM Products
34 lines (33 loc) • 998 B
TypeScript
/**
* Copyright IBM Corp. 2023, 2023
*
* 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, { ReactNode } from 'react';
type Theme = 'light' | 'dark';
export interface NonLinearReadingProps {
/**
* The keyword of the component appears as a pill.
*/
children: ReactNode;
/**
* Provide an optional class to be applied to the containing node.
*/
className?: string;
/**
* The content that appears when the keyword is toggled open.
*/
definition: ReactNode;
/**
* Determines the theme of the component.
*/
theme?: Theme;
}
/**
* Use non-linear reading when space is limited to share a
* brief, at-a-glance, summary of a concept that may require
* more explanation for some users.
*/
export declare let NonLinearReading: React.ForwardRefExoticComponent<NonLinearReadingProps & React.RefAttributes<HTMLSpanElement>>;
export {};