Skip to content

docs(TimelineChart): add deprecation notice for component #8124

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Lukas742 wants to merge 1 commit into
base: main
Choose a base branch
from
+9 −5
Open

docs(TimelineChart): add deprecation notice for component #8124

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions packages/charts/src/components/TimelineChart/Placeholder.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
import { ThemingParameters } from '@ui5/webcomponents-react-base';
import ContentLoader from 'react-content-loader';

/**
* @deprecated The component will be removed without replacement in version 3.0 of `@ui5/webcomponents-react-charts`.
*/
export const TimelineChartPlaceholder = () => {
return (
// @ts-expect-error: TypeScript is going crazy
Expand Down
2 changes: 1 addition & 1 deletion packages/charts/src/components/TimelineChart/TimeLineChart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import { TimelineChartAnnotation } from './TimelineChartAnnotation';

<Meta of={ComponentStories} />

<DocsHeader of={ComponentStories} isChart since="1.10.0" experimental />
<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\`.`} />

<Canvas of={ComponentStories.Default} />

Expand Down
2 changes: 1 addition & 1 deletion packages/charts/src/components/TimelineChart/TimeLineChart.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import { TimelineChart } from './index.js';
const meta = {
title: 'TimelineChart',
component: TimelineChart,
tags: ['package:@ui5/webcomponents-react-charts', 'experimental'],
tags: ['package:@ui5/webcomponents-react-charts', 'experimental', 'deprecated'],
argTypes: {
dataset: {
control: { disable: true },
Expand Down
2 changes: 2 additions & 0 deletions packages/charts/src/components/TimelineChart/TimelineChartAnnotation.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,8 @@ interface TimelineChartAnnotationProps extends CommonProps {
/**
* This is designed to be used for creating custom annotations, markers
* or illustrations on the timeline of the chart.
*
* @deprecated The component will be removed without replacement in version 3.0 of `@ui5/webcomponents-react-charts`.
*/
const TimelineChartAnnotation = forwardRef<HTMLDivElement, TimelineChartAnnotationProps>((props, ref) => {
const { width = 'auto', height, rowIndex = 0, rowHeight = DEFAULT_ROW_HEIGHT, figure, ...rest } = props;
Expand Down
5 changes: 2 additions & 3 deletions packages/charts/src/components/TimelineChart/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,9 +109,6 @@ export interface TimelineChartProps extends CommonProps {

/**
* > __Experimental Component!__ <br />
* > This component is experimental and not subject to semantic versioning.
* > Therefore, you could face breaking changes when updating versions.
* > Please use with caution!
*
* A `TimelineChart` is a data visualization chart that can be used to represent
* Gantt charts or any other timeline-based visualizations. The component has a
Expand All @@ -125,6 +122,8 @@ export interface TimelineChartProps extends CommonProps {
* connections.
*
* __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.
*
* @deprecated The component will be removed without replacement in version 3.0 of `@ui5/webcomponents-react-charts`.
*/
const TimelineChart = forwardRef<HTMLDivElement, TimelineChartProps>(
(
Expand Down
Loading