Skip to content

Commit e3debc6

Browse files
authored
docs(TimelineChart): add deprecation notice for component (#8124)
1 parent 66fb186 commit e3debc6

5 files changed

Lines changed: 9 additions & 5 deletions

File tree

packages/charts/src/components/TimelineChart/Placeholder.tsx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
import { ThemingParameters } from '@ui5/webcomponents-react-base';
22
import ContentLoader from 'react-content-loader';
33

4+
/**
5+
* @deprecated The component will be removed without replacement in version 3.0 of `@ui5/webcomponents-react-charts`.
6+
*/
47
export const TimelineChartPlaceholder = () => {
58
return (
69
// @ts-expect-error: TypeScript is going crazy

packages/charts/src/components/TimelineChart/TimeLineChart.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import { TimelineChartAnnotation } from './TimelineChartAnnotation';
66

77
<Meta of={ComponentStories} />
88

9-
<DocsHeader of={ComponentStories} isChart since="1.10.0" experimental />
9+
<DocsHeader of={ComponentStories} isChart since="1.10.0" experimental deprecationText={`The component will be removed without replacement in version 3.0 of \`@ui5/webcomponents-react-charts\`.`} />
1010

1111
<Canvas of={ComponentStories.Default} />
1212

packages/charts/src/components/TimelineChart/TimeLineChart.stories.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import { TimelineChart } from './index.js';
88
const meta = {
99
title: 'TimelineChart',
1010
component: TimelineChart,
11-
tags: ['package:@ui5/webcomponents-react-charts', 'experimental'],
11+
tags: ['package:@ui5/webcomponents-react-charts', 'experimental', 'deprecated'],
1212
argTypes: {
1313
dataset: {
1414
control: { disable: true },

packages/charts/src/components/TimelineChart/TimelineChartAnnotation.tsx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,8 @@ interface TimelineChartAnnotationProps extends CommonProps {
4646
/**
4747
* This is designed to be used for creating custom annotations, markers
4848
* or illustrations on the timeline of the chart.
49+
*
50+
* @deprecated The component will be removed without replacement in version 3.0 of `@ui5/webcomponents-react-charts`.
4951
*/
5052
const TimelineChartAnnotation = forwardRef<HTMLDivElement, TimelineChartAnnotationProps>((props, ref) => {
5153
const { width = 'auto', height, rowIndex = 0, rowHeight = DEFAULT_ROW_HEIGHT, figure, ...rest } = props;

packages/charts/src/components/TimelineChart/index.tsx

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -109,9 +109,6 @@ export interface TimelineChartProps extends CommonProps {
109109

110110
/**
111111
* > __Experimental Component!__ <br />
112-
* > This component is experimental and not subject to semantic versioning.
113-
* > Therefore, you could face breaking changes when updating versions.
114-
* > Please use with caution!
115112
*
116113
* A `TimelineChart` is a data visualization chart that can be used to represent
117114
* Gantt charts or any other timeline-based visualizations. The component has a
@@ -125,6 +122,8 @@ export interface TimelineChartProps extends CommonProps {
125122
* connections.
126123
*
127124
* __Note:__ Charts are custom-built __without__ defined design specifications! They use the Fiori color palette, but functionality and especially accessibility may not meet standard app requirements.
125+
*
126+
* @deprecated The component will be removed without replacement in version 3.0 of `@ui5/webcomponents-react-charts`.
128127
*/
129128
const TimelineChart = forwardRef<HTMLDivElement, TimelineChartProps>(
130129
(

0 commit comments

Comments
 (0)