@ui5/webcomponents-react
Version:
React Wrapper for UI5 Web Components and additional components
39 lines (38 loc) • 1.99 kB
TypeScript
import '@ui5/webcomponents-fiori/dist/Timeline.js';
import type TimelineLayout from '@ui5/webcomponents-fiori/dist/types/TimelineLayout.js';
import type { ReactNode } from 'react';
import type { CommonProps, Ui5DomRef } from '../../types/index.js';
interface TimelineAttributes {
/**
* Defines the accessible ARIA name of the component.
*
* **Note:** Available since [v1.2.0](https://github.com/SAP/ui5-webcomponents/releases/tag/v1.2.0) of **@ui5/webcomponents-fiori**.
* @default undefined
*/
accessibleName?: string | undefined;
/**
* Defines the items orientation.
* @default "Vertical"
*/
layout?: TimelineLayout | keyof typeof TimelineLayout;
}
interface TimelineDomRef extends Required<TimelineAttributes>, Ui5DomRef {
}
interface TimelinePropTypes extends TimelineAttributes, Omit<CommonProps, keyof TimelineAttributes | 'children'> {
/**
* Determines the content of the `Timeline`.
*/
children?: ReactNode | ReactNode[];
}
/**
* The `Timeline` component shows entries (such as objects, events, or posts) in chronological order.
* A common use case is to provide information about changes to an object, or events related to an object.
* These entries can be generated by the system (for example, value XY changed from A to B), or added manually.
* There are two distinct variants of the timeline: basic and social. The basic timeline is read-only,
* while the social timeline offers a high level of interaction and collaboration, and is integrated within SAP Jam.
*
* __Note__: This is a UI5 Web Component! [Repository](https://github.com/SAP/ui5-webcomponents) | [Documentation](https://sap.github.io/ui5-webcomponents/)
*/
declare const Timeline: import("react").ForwardRefExoticComponent<TimelinePropTypes & import("../../internal/withWebComponent.js").WithWebComponentPropTypes & import("react").RefAttributes<TimelineDomRef>>;
export { Timeline };
export type { TimelineDomRef, TimelinePropTypes };